quarkdown-core/com.quarkdown.core.ast.base.block/Heading/Companion

Companion

object Companion

Properties

Link copied to clipboard
const val MAX_DEPTH: Int = 6

The maximum allowed heading depth (H6).

Link copied to clipboard
const val MIN_DEPTH: Int = 1

The minimum allowed heading depth (H1). This does not take 0-depth headings into account. See isMarker for marker headings.

Functions

Link copied to clipboard
fun Heading.Companion.createSectionHeading(title: InlineContent?, localizationKey: String, context: Context, depth: Int = 1, customId: String? = null, canBreakPage: Boolean = true, canTrackLocation: Boolean = false, includeInTableOfContents: Boolean = false): Heading?

Creates an auto-generated Heading for a structural section of the document (e.g. table of contents, bibliography).

Link copied to clipboard
fun Heading.Companion.marker(name: InlineContent): Heading

Creates an invisible Heading that acts as a marker that can be referenced by other elements in the document. A useful use case would be, for example, in combination with a com.quarkdown.core.context.toc.TableOfContents. Depth 0 cannot be achieved with plain Markdown, but it can be supplied by the Quarkdown function .marker.