ConfigProvider

Responsible for providing the parsers for configuration files and configuration headers in markup documents as part of an ExtensionBundle.

Laika has a built-in implementation of this API that parses configuration as HOCON, but these can be overridden by adding an instance of this trait to a ParserBundle within an ExtensionBundle.

Companion:
object
class Object
trait Matchable
class Any

Value members

Abstract methods

def configDocument(input: String): ConfigParser

The parser for configuration files recognized in input directories.

The parser for configuration files recognized in input directories.

The returned ConfigParser will be resolved lazily with a fallback Config provided by the runtime. This deferred resolution is necessary as substitution references in configuration headers can refer to values defined in configuration files or programmatically.

The parser for configuration headers in markup documents.

The parser for configuration headers in markup documents.

The parser is expected to fail if it does not recognize the fence before and after the configuration header. Otherwise it is expected to succeed, without parsing the actual string input from the configuration header. This will happen lazily when the ConfigParser will be resolved with a fallback Config provided by the runtime. This deferred resolution is necessary as substitution references in configuration headers can refer to values defined in configuration files or programmatically.

The parser for configuration headers in template documents.

The parser for configuration headers in template documents.

The parser is expected to fail if it does not recognize the fence before and after the configuration header. Otherwise it is expected to succeed, without parsing the actual string input from the configuration header. This will happen lazily when the ConfigParser will be resolved with a fallback Config provided by the runtime. This deferred resolution is necessary as substitution references in configuration headers can refer to values defined in configuration files or programmatically.

Concrete methods

Returns a new config provider for strict mode that disables all extensions for text markup documents which should run only features of the original markup spec. Templates and configuration files remain unaffected.

Returns a new config provider for strict mode that disables all extensions for text markup documents which should run only features of the original markup spec. Templates and configuration files remain unaffected.