I’d like to have a table of contents in the README file for my project. I have a README file in the root directory of the project and PlDoc reads it and renders it fine.
My code is hosted on Github so I added a ToC using Github conventions. The Github markdown parser automatically adds anchor tags to all headers in a README. So it’s possible to make a ToC using labelled markdown links, as follows:
That can then be used to jump to the Introduction header because, on Github, the Introduction header html gets an anchor tag like:
But of course, this does not work with PlDoc. So I tried to create local links using PlDoc markdown. I can’t figure out how to do it. I tried the following
[Introduction](#intro) Introduction [name=intro]
But PlDoc just laughed at me.
Is there some way to do what I want?