Table of contents generation from HTML

[deberlhe-jb]

The table of contents is generated using the markdown syntax.

When using HTML in markdown to define h1-6 titles, those are ignored.

Is this an intended behavior ?
How should I do if I want to add an h title inside an HTML block with classes for styling ?

Given the right direction I may open a pull request.

[lunar-me]

This is the current behaviour, and it follows directly from how the renderer is built. TOC entries are created in exactly one place: HTMLRenderer.visitHeading, which appends a TOCEntry every time the markdown AST hands it a Heading node. Headings written as raw HTML inside a block are emitted by a different code path - visitHTMLBlock, which simply appends the raw HTML to the output and never parses it.
So no Heading node is ever produced and nothing is added to the TOC. The same rule applies to the page title: firstHeading is taken from the collected headings, so an h1 in an HTML block is invisible there too. There is currently NO option to change this;

IMHO, the restriction is structural rather than a deliberate filtering rule, because swift-markdown treats an HTML block as an opaque node rather than re-parsing its contents as markdown. If you want a heading to appear in the TOC it has to be written in markdown syntax, so the practical approach is: use a markdown heading for anything that should be navigable, and attach styling by targeting the generated anchor id, which is derived from the heading text by the slugger and emitted as the heading's id attribute.

Good luck!

[deberlhe-jb]

Thanks, I'll look into it and replicate the visitHeading() behavior.

[deberlhe-jb]

Here's a pull request to implement this behavior : #41