kotmark-ext-toc/io.heapy.kotmark.ext.toc

Package-level declarations

Types

class TableOfContents(val marker: String = "[TOC]") : CustomBlock

A TOC insertion point. Markdown rendering preserves marker; generated entries are not AST children.

class TocExtension : Parser.ParserExtension, HtmlRenderer.HtmlRendererExtension, MarkdownRenderer.MarkdownRendererExtension, TextContentRenderer.TextContentRendererExtension

Opt-in TOC markers, HTML heading IDs and outlines. See the module README for rendering contracts.

TocPlacement

enum TocPlacement : Enum<TocPlacement>

Where to insert a TOC when the source has no explicit marker.

Functions

toc

fun ExtensionsBuilder.toc(configure: TocExtension.Configuration.() -> Unit = {})

Creates and appends TocExtension.

tocExtension

fun tocExtension(configure: TocExtension.Configuration.() -> Unit = {}): TocExtension

Creates TocExtension, snapshotting its configuration.