Documenter.jl
Documenter.jl copied to clipboard
Headings not always rendered
I have some situations where a ### Heading
is consistenly not rendered (locally and on github pages), although all markdown rules seem to be followed
I consequently get these Warning
s but no other hint what's going wrong
┌ Warning: invalid local link: unresolved path in dynamical_core.md
│ link.text =
│ 1-element Vector{Any}:
│ "Zonal derivative"
│ link.url = "@ref"
└ @ Documenter.Writers.HTMLWriter ~/.julia/packages/Documenter/HmHje/src/Writers/HTMLWriter.jl:2077
Any idea what's going on?
Can you create a minimal example markdown file?
Haha, I even get this
with
# Title
## Heading 1
### Heading 2
Text
### Heading 3
Also text
What?? 😆
Okay now it gets spooky 👻
I've deleted the ### Heading 2
, written by hand another ### Heading 4
underneath and copied the working ### Heading 3
below that. Is it possible that VS Code somehow encodes them differently without displaying the difference?
Yeah, current working around is: I take a ### HeadingX
that renders fine, copy it into the place where the non-working heading is and change HeadingX
to HeadingY
, how weird??
My only guess is that it has something to do with line endings then, but never seen this problem before.
It also looks like a parsing issue (so a problem in the Markdown stdlib), rather than a Documenter problem. What does Markdown.parse_file
output when parsing these files?