Context
Container of information about the current state of the pipeline, shared across the whole pipeline itself.
Inheritors
Properties
The pipeline this context is attached to, if it exists. A context can have up to 1 attached pipeline.
Information about the node tree that is being processed by the attachedPipeline.
Mutable information about the final document that is being created.
The file system relative to this context which can be used to access files starting from a certain working directory.
The Markdown flavor in use.
External libraries that can be loaded by the user into libraries. These libraries are, for instance, fetched from the library directory (--libs
option) and can be loaded via the .include {name}
function.
Tables that store key-value localization pairs for each supported locale. Each table is identified by a unique name.
Media storage that contains all the media files that are referenced within the document. For example, if an image node references a local image file "image.png", the local file needs to be exported to the output directory in order for a browser to look it up. This storage is used to keep track of all the media files that may need to be exported.
Global properties that affect several behaviors and that can be altered through function calls.
The subdocument that is being processed by this context. A subdocument can be the root one or another referenced by a link.
Directed graph of the subdocuments that are part of the document complex. Each subdocument is a separate document file that can be rendered independently, and is referenced by a link from the main document or another subdocument.
Functions
Looks up a function by name.
Localizes a key from the stdlib table. If the key is not found in the context's locale, it falls back to the default locale (English).
Generates a new UUID via ContextOptions.uuidSupplier.
Tries to resolve a reference link to an actual link. If the resolution succeeds, ReferenceLink.onResolve callbacks are executed.