RstExtensionRegistry

Registers the specified block directives.

Example:

case class Note (title: String, content: Seq[Block]) extends Block with BlockContainer[Note]

object MyDirectives extends RstExtensionRegistry {
  val blockDirectives = Seq(
    BlockDirective("note") {
      (argument() ~ blockContent)(Note)
    }
  )
  val spanDirectives = Seq()
  val textRoles = Seq()
}

Transform.from(ReStructuredText).to(HTML)
  .using(MyDirectives)
  .fromFile("hello.rst").toFile("hello.html")

For more details on implementing directives see laika.rst.ext.Directives.

Registers the specified span directives. These span directives can then be referred to by substitution references.

Example:

object MyDirectives extends RstExtensionRegistry {
  val spanDirectives = Seq(
    SpanDirective("replace") {
      spanContent map SpanSequence
    }
  )
  val blockDirectives = Seq()
  val textRoles = Seq()
}

Transform.from(ReStructuredText).to(HTML)
  .using(MyDirectives)
  .fromFile("hello.rst").toFile("hello.html")

For more details on implementing directives see laika.rst.ext.Directives.

Registers the specified text roles. These text roles may then be used in interpreted text spans.

Example:

val textRole = TextRole("link", "http://www.company.com/main/")(field("base-url")) {
  (base, text) => Link(List(Text(text)), base + text)
}

object MyDirectives extends RstExtensionRegistry {
  val textRoles = Seq(textRole)
  val spanDirectives = Seq()
  val blockDirectives = Seq()
}

Transform from ReStructuredText to HTML using
  MyDirectives fromFile "hello.rst" toFile "hello.html"

For more details on implementing directives see laika.rst.ext.TextRoles.

Indicates that this bundle deals with raw content embedded in text markup, like HTML.

These kind of bundles are disabled by default as Laika is designed to render to multiple output formats from a single input document. With raw content embedded the markup document is tied to a specific output format.

Bundles which have this flag set to true need to be enabled explicitly by the user by calling withRawContent on the Parse or Transform API:

Transform.from(Markdown).to(HTML).withRawContent
  .fromFile("hello.md").toFile("hello.html")

Base configuration that serves as a fallback for configuration files in the source directories and/or config headers in markup and template documents.

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.

Specifies extensions and/or replacements for parsers that deal with text markup, templates, CSS or configuration headers.

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.

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.

The themes defined by this bundle, which are a collection of templates, styles and custom render functions.

A theme is always specific to a particular output format like HTML or PDF. A bundle can contain multiple themes for the same output format which will be merged before use.

Indicates that this bundle should still be used if the user runs a transformation in strict mode.

This setting is appropriate if a bundle contains features which are native elements of a text markup language as defined in its specification, but implemented as an extension for technical reasons.

Returns a new extension bundle by merging the content of this bundle with the content of the base bundle.

The other bundle is treated as the base of this bundle, which means that:

- in case of optional features a feature defined in this bundle will overwrite a feature defined in the base

- in case of features applied in sequence, the features in this bundle will be applied before the features in the base bundle

- in case of feature collections, the features of this bundle will be merged with those of the base bundle