How do I ensure that whitespace is preserved in Markdown?
Currently, I have this line in a Markdown file detailing command output:
1\. Work (00:10:00)
1\. Mail letter (00:05:00, Est. 00:03:00)
Send letter to Foo Bar
2\. Personal (00:02:00)
However, when I preview the Markdown file, all of the whitespace is disregarded.
1. Work (00:10:00)
1. Mail letter (00:05:00, Est. 00:03:00)
Send letter to Foo Bar
2. Personal (00:02:00)
How do I preserve this whitespace?
Markdown is used primarily to generate HTML, and HTML collapses white spaces by default. Use
instead of space characters.
Use non-breaking spaces
To preserve spaces in a markdown document use a non-breaking space:
"a space character that prevents consecutive whitespace characters from collapsing into a single space, and also prevents an automatic line break at its position".
Example
See an online and editable example here.
This line uses non-breaking spaces in many places; they are not collapsed.
There is no need to use code blocks.
This line uses many consecutive spaces in many places; they are all collapsed.
Note:
Copy and paste the previous example could not work because sometimes the non-breaking spaces are changed to normal spaces in a copy-paste operation :‑(.
Or tray a table
However, if you intend to use non-breaking spaces to align text, prefer to use tables.
Example code:
| Country | Capital |
| -------- | --------|
| Portugal | Lisbon |
| Spain | Madrid |
| Cuba | Havana |
But not all Markdown implementations recognize the previous syntax.
How to introduce a non-breaking space?
- In macOS, you need to press ⌥ Opt+Space
- In Windows, sometimes work Alt+0+1+6+0 or Alt+2+5+5
- In many commercial software Ctrl+Space
- In Linux, Compose key enabled Compose Space Space
The beauty of this solution is that you don't need to use any code in your Markdown document. For example, in HTML you must use
.
PS:
Reader, please, let us know in the comments is this method does not work in your particular markdown editor. I have tested this method in two apps and several online editors.
One alternative is to use
<pre></pre>
like:
<pre>
1
/ \
2 2
/ \ / \
3 4 4 3
</pre>
the pyramid will be preserved.
Of cause, you can use
. I use them both, depending on needs.
I find
very cumbersome to use, ie. if you have large document, it may become ugly for edit, and you would need lot's of copy pasting of
, and in the end you will also need to adjust indentation.
instead use 3 accents (```) to denote code (well, you only care about indentation and whitespace here).
for example this is how text looks without any formatting:
Enabled = "True"
Profile = ("Domain", "Private")
Direction = "OutBound"
RemotePort = ("8080", "8081")
LocalPort = ("9080", "9081")
And this is how it looks with
doing quick copy paste
Enabled = "True"
Profile = ("Domain", "Private")
Direction = "OutBound"
RemotePort = ("8080", "8081")
LocalPort = ("9080", "9081")
And here is my sulution, very simple, quick and effective:
Profile = ("Domain", "Private")
Direction = "OutBound"
RemotePort = ("8080", "8081")
LocalPort = ("9080", "9081")```
**EDIT:**
This last example is surrounded by 3 accents at the beginning and at the end, ex:
(```)
your text here
(```)