DocumentTreeBuilder

laika.ast.DocumentTreeBuilder

API for a safe and concise way of constructing a DocumentTree.

The hierarchy of the tree will be constructed based on the provided Path instances while also ensuring that document configuration is wired up correctly (inheriting the configuration from directories).

Attributes

Source
DocumentTreeBuilder.scala
Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Value members

Concrete methods

Add the specified tree configuration to the builder.

Add the specified tree configuration to the builder. The path it will be assigned to will be taken from the origin property of the Config instance. Existing instances with identical paths will be overridden.

For assigning a configuration to a specific document and not an entire tree or subtree, set the config property of a Document instance directly before adding it to the builder.

Attributes

Source
DocumentTreeBuilder.scala

Add the specified document to the builder.

Add the specified document to the builder. Existing instances with identical paths will be overridden.

Attributes

Source
DocumentTreeBuilder.scala

Add the specified documents to the builder.

Add the specified documents to the builder. Existing instances with identical paths will be overridden.

Attributes

Source
DocumentTreeBuilder.scala

Add the specified template to the builder.

Add the specified template to the builder. Existing instances with identical paths will be overridden.

Attributes

Source
DocumentTreeBuilder.scala

Add the specified templates to the builder.

Add the specified templates to the builder. Existing instances with identical paths will be overridden.

Attributes

Source
DocumentTreeBuilder.scala

Builds a DocumentTree from the provided instances and wires the configuration of documents to that of parent trees for proper inheritance.

Builds a DocumentTree from the provided instances and wires the configuration of documents to that of parent trees for proper inheritance.

Attributes

Source
DocumentTreeBuilder.scala
def build(baseConfig: Config): DocumentTree

Builds a DocumentTree from the provided instances, using the specified Config instance as a base for the configuration of all trees and documents.

Builds a DocumentTree from the provided instances, using the specified Config instance as a base for the configuration of all trees and documents. Also wires configuration of documents to that of parent trees for proper inheritance.

Attributes

Source
DocumentTreeBuilder.scala

Builds a DocumentTreeRoot from the provided instances and wires the configuration of documents to that of parent trees for proper inheritance.

Builds a DocumentTreeRoot from the provided instances and wires the configuration of documents to that of parent trees for proper inheritance.

Attributes

Source
DocumentTreeBuilder.scala
def buildRoot(baseConfig: Config): DocumentTreeRoot

Builds a DocumentTreeRoot from the provided instances, using the specified Config instance as a base for the configuration of all trees and documents.

Builds a DocumentTreeRoot from the provided instances, using the specified Config instance as a base for the configuration of all trees and documents. Also wires configuration of documents to that of parent trees for proper inheritance.

Attributes

Source
DocumentTreeBuilder.scala