Provides the implementation for the standard directives included in Laika.
These include:
'''Navigation'''
navigationTree: Generates a navigation tree either automatically from specified root nodes
of the input tree or by specifying entries manually (or a combination of both).
breadcrumb: Builds a navigation list from the root node of the input tree to the current document.
api: Convenience directive that allows to reference an api documentation entry (e.g. scaladoc, javadoc)
source: Convenience directive that allows to reference a hosted source (e.g. on GitHub)
'''Inclusions'''
include: Includes one template or markup document inside another, with the options to pass attributes
that can be referenced in the included document.
embed: All the features of include, but also allows to pass a parsed directive body that can be
referenced in the included document.
'''Applying Styles'''
style: Adds one or more style properties to the body element (markup block or span).
'''Markup Blocks'''
image: Alternative to native markup syntax for including images that supports additional attributes,
like intrinsicWidth and intrinsicHeight to avoid layout shift, as well as alt and title.
callout: A decorated block element that stands out from the surrounding paragraphs;
the default Helium theme renders the content with background color and icon.
select: Allows to create alternative versions of the same documentation,
for example one with Scala code examples and one with Java.
fragment: Marks a block in a markup document as being separate from the main content,
so that it can be placed independently in templates, e.g. in headers, footers or sidebars.
format: Process the body element only when the output format matches the format
specified in the directive (e.g. pdf or html).
'''HTML Templates'''
linkCSS: Adds link elements to HTML/EPUB output for all or selected CSS files found in the document tree
linkJS: Adds link elements to HTML/EPUB output for all or selected JavaScript files found in the document tree
target: Translates a link target.
External targets will be rendered verbatim, internal targets (absolute or relative paths) will be resolved
from the perspective of a template to a path relative to the document the template had been applied to.
path: Deprecated, use the newer target directive instead which is a superset of its functionality
date: renders a date with a specified formatting pattern
attribute: renders an HTML attribute if the specified config value is defined
'''Conditionals and Loops'''
for: Accesses a value from the context and sets it as the reference context for its body elements,
executing the body if the referenced value is non-empty and executing it multiple times when it is a collection.
if: Accesses a value from the context and processes the body element only when it is a value recognized as true.
'''PDF Output'''
pageBreak: Inserts a page break element into the tree (will only be rendered by page-based output,
like XSL-FO or PDF.
'''Comments'''
todo: simple directive that accepts a string argument that will be ignored by renderers,
overcoming the limitation that Markdown does not have a native comment syntax.
Specifies the function to use for determining the document type
of the input based on its path.
Specifies the function to use for determining the document type
of the input based on its path.
Any path for which this function is not defined will be processed by the remaining
defined bundles. The documents for paths for which none of the extensions provides
a DocumentType will be treated as static files to be copied over to the target
directory in transformations by default.
Extends the built-in path translator with additional functionality.
Extends the built-in path translator with additional functionality.
The internal path translator deals with aspects like applying the suffix for the output format
or modifying the path for versioned documents and more.
The PathTranslatorExtensionContext provides access to this internal path translator, to the output
format it is going to be used for and the complete user configuration.
In most cases, extensions can simply be created by using either PathTranslator.preTranslate
or PathTranslator.postTranslate to apply additional translation steps either before or after
applying the internal translator.
Alternatively a completely custom implementation of the PathTranslator trait can be provided,
but this will usually not be necessary.
PathTranslator implementations usually do not deal with the fragment part of the path.
Use the slugBuilder extension point for this purpose.
Provides a version of this bundle that can be used in strict mode or None if the entire bundle
should be removed in strict mode.
Provides a version of this bundle that can be used in strict mode or None if the entire bundle
should be removed in strict mode.
When strict mode does not affect a bundle it can return Some(this).
Any bundle to be used in strict mode should be free from any parser extensions that
adds features to markup syntax beyond their respective specifications.
Internal API usually only called by other extension bundles.
Internal API usually only called by other extension bundles.
In some cases a bundle might be an extension of another bundle and needs the opportunity
to process and modify that bundle without requiring a direct reference to it. An example
is a registry for directives which needs to pass all its registered directives to the
bundle which deals with finally creating all the directive parsers.
The partial function should match only on the types of bundles it intends to process
and is then allowed to return a new, modified instance of that bundle.
Provides a version of this bundle that can be used in the default run mode where raw content in markup
documents (such as embedded HTML) is disabled.
Provides a version of this bundle that can be used in the default run mode where raw content in markup
documents (such as embedded HTML) is disabled.
When a bundle does not add parsers for raw content it can return Some(this).
Any bundle to be used in the default run mode should be free from any parser extensions that
allow raw content in markup.
When the user switches the acceptRawContent flag to true then this method will not be invoked
and the initial instance of the bundle is used.
The overrides for renderers defined by this bundle.
The overrides for renderers defined by this bundle.
An override is always specific to a particular output format like HTML or PDF.
A bundle can contain multiple overrides for the same output format which will be merged before use.
Specifies rewrite rules to be applied to the document tree model between the
parse and render operations.
Specifies rewrite rules to be applied to the document tree model between the
parse and render operations.
The specified functions will be invoked for each document, allowing to capture
information from the entire document tree before returning the actual rule,
which is a partial function from Element to Option[Element] that allows
to remove or replace elements from the tree.
Function that receives the text of a headline, the name of a document
or directory or a manually assigned identifier, and builds a slug from it
that becomes part of the final URL or identifier (depending on output format).
Function that receives the text of a headline, the name of a document
or directory or a manually assigned identifier, and builds a slug from it
that becomes part of the final URL or identifier (depending on output format).
Implementation of the callout directive for block elements in markup documents.
The body of such a directive will get two styles assigned: callout and the argument
passed to the directive (e.g. @:callout(info)).
Implementation of the callout directive for block elements in markup documents.
The body of such a directive will get two styles assigned: callout and the argument
passed to the directive (e.g. @:callout(info)).
Implementation of the format directive for block elements in markup documents.
The content of such a block will only be rendered for the corresponding
output format (e.g. pdf or html).
Implementation of the format directive for block elements in markup documents.
The content of such a block will only be rendered for the corresponding
output format (e.g. pdf or html).
Indicates whether the bundle is a built-in default provided by the library,
a collection of extensions installed by a markup format or user-defined.
Indicates whether the bundle is a built-in default provided by the library,
a collection of extensions installed by a markup format or user-defined.
This is relevant for determining the precedence of installed bundles when merging
them, as user-supplied functionality always overrides library defaults.