Often, one wants to add new lines in the plain text that are not rendered as new lines in html. Documenter seems to treat these differently than other markdown renderers. For example:
# Test Doc
- A bullet
- Long bullet text **not**
wrapped to new line
- Long bullet text
wrapped to new line
In the markdown formatters I'm familiar with, the 2nd and third bullets are rendered the same - the 4 spaces in the second bullet don't change anything. Eg, in Atom's markdown preview:
But julia treats them differently (noticed in Documenter):
MWE (thanks to @KristofferC - see here) :
julia> using Markdown
julia> md = Markdown.parse("""
- Long bullet text
wrapped to new line
""");
julia> md.content
2-element Array{Any,1}:
Markdown.List(Any[Any[Paragraph(Any["Long bullet text"])]], -1, false)
Markdown.Paragraph(Any["wrapped to new line"])
julia> md
• Long bullet text
wrapped to new line
I'll just add that what @kescobo proposes would get us closer to CommonMark too.
Adding a paragraph around each item is also a problem: https://discourse.julialang.org/t/parsing-markdown-lists-add-paragraph-to-items/36169
Julia Markdown parser:
qwe
rty
Other Markdown parsers:
Most helpful comment
I'll just add that what @kescobo proposes would get us closer to CommonMark too.