Package-level declarations
Types
Link copied to clipboard
open class BaseContext(val attributes: AstAttributes, val flavor: MarkdownFlavor, val libraries: Set<Library> = emptySet(), val subdocument: Subdocument = Subdocument.Root) : Context
An immutable Context implementation. This might be used in tests as a toy context, but in a concrete execution, its mutable subclass MutableContext is used.
Link copied to clipboard
Read-only properties that affect several behaviors of the document generation process, and that can be altered through function calls through its MutableContextOptions implementation.
Link copied to clipboard
open class MutableContext(val flavor: MarkdownFlavor, libraries: Set<Library> = emptySet(), loadableLibraries: Set<Library> = emptySet(), val subdocument: Subdocument = Subdocument.Root, val attributes: MutableAstAttributes = MutableAstAttributes(), val options: MutableContextOptions = MutableContextOptions()) : BaseContext
A mutable Context implementation, which allows registering new data to be looked up later.
Link copied to clipboard
data class MutableContextOptions(var autoPageBreakHeadingMaxDepth: Int = 1, var enableAutomaticIdentifiers: Boolean = true, var enableLocationAwareness: Boolean = true, var subdocumentUrlSuffixes: Set<String> = DEFAULT_SUBDOCUMENT_URL_SUFFIXES, var uuidSupplier: () -> String = {
java.util.UUID
.randomUUID()
.toString()
}, var enableRemoteMediaStorage: Boolean = false, var enableLocalMediaStorage: Boolean = false) : ContextOptions
Mutable ContextOptions implementation.
Link copied to clipboard
class ScopeContext(val parent: Context, val subdocument: Subdocument = parent.subdocument) : MutableContext
A context that is the result of a fork from an original parent Context. Several properties are inherited from it.