[Feature request] Option to include ToC heading in the ToC itself

[OverSamu]

It would be nice to be able to decide whether to include the Table of Contents heading in the ToC itself, via a .tableofcontents parameter, to get the result below.

[OverSamu]

I'm not sure how this can be implemented, since the ToC heading is not in headings.

quarkdown/quarkdown-core/src/main/kotlin/com/quarkdown/core/context/hooks/TableOfContentsGeneratorHook.kt

Lines 18 to 23 in ae107ce

	val headings = iterator.collectAll<Heading>()
	// Generation.
	iterator.onFinished {
	context.attributes.tableOfContents = TableOfContents.generate(headings.asSequence())
	}

[iamgio]

The heading is currently created at rendering time. It may make perfect sense to generate it at function evaluation time though

[OverSamu]

Hi @iamgio, based on your previous comment, should the following tableOfContents function return both a Heading and a TableOfContentsView?

quarkdown/quarkdown-stdlib/src/main/kotlin/com/quarkdown/stdlib/Document.kt

Lines 1007 to 1019 in 5f6f0bf

	@Name("tableofcontents")
	fun tableOfContents(
	@LikelyNamed title: InlineMarkdownContent? = null,
	@Name("maxdepth") maxDepth: Int = 3,
	@Name("includeunnumbered") includeUnnumbered: Boolean = false,
	@Name("focus") focusedItem: InlineMarkdownContent? = null,
	): NodeValue =
	TableOfContentsView(
	title?.children,
	maxDepth,
	includeUnnumbered,
	focusedItem?.children,
	).wrappedAsValue()

[iamgio]

Yes, you can check in the QuarkdownHtmlNodeRenderer the conditions for the title to appear.

• if the conditions aren't met: return just the ToC as it is now
• if met: return an AstRoot(Heading, ToC) (an AstRoot is just a node that groups other nodes)