quarkdown-core/com.quarkdown.core.ast.quarkdown.block.toc

Package-level declarations

Types

Link copied to clipboard
class TableOfContentsView(val title: InlineContent?, val maxDepth: Int, val includeUnnumbered: Boolean = false, focusedItem: InlineContent? = null) : Node

When this node is rendered, the current table of contents, retrieved from the auto-generated AstAttributes.tableOfContents, is displayed.

Functions

Link copied to clipboard
fun convertTableOfContentsToListNode(view: TableOfContentsView, renderer: NodeVisitor<CharSequence>, items: List<TableOfContents.Item>, loose: Boolean = true, wrapLinksInParagraphs: Boolean = false, linkUrlMapper: (TableOfContents.Item) -> String): OrderedList

Converts a table of contents to a renderable OrderedList.

Link copied to clipboard
fun createTableOfContentsHeading(view: TableOfContentsView, context: Context): Node?

Creates the heading for the Table of Contents, depending on: