Package-level declarations

Types

Link copied to clipboard
sealed interface Subdocument

A subdocument in a Quarkdown document is an independent unit that can be rendered separately, can be linked from other documents, and can link to other subdocuments in order to create a graph of subdocuments, available via com.quarkdown.core.context.Context.subdocumentGraph.

Functions

Link copied to clipboard

Returns the output file name for the subdocument, based on the context's options. If the pipeline enforces minimal subdocument collisions (com.quarkdown.core.pipeline.PipelineOptions.minimizeSubdocumentCollisions), Subdocument.uniqueName is returned, otherwise just Subdocument.name, which is more human-readable but prone to collisions.