MarkupFormat

laika.factory.MarkupFormat
trait MarkupFormat extends Format

Responsible for creating parser instances for a specific markup format. A parser is simply a function of type Input => Document.

Attributes

Graph
Supertypes
trait Format
class Object
trait Matchable
class Any
Known subtypes
object Markdown.type
object ReStructuredText.type

Members list

Value members

Abstract methods

All block parsers for the markup language this parser processes.

All block parsers for the markup language this parser processes.

Attributes

The parser-specific extensions that need to be installed for each transformation that involves this parser.

The parser-specific extensions that need to be installed for each transformation that involves this parser.

One scenario where a parser needs to provide a bundle is when it produces tree elements that are unknown to the built-in rewrite rules and renderers.

Attributes

def fileSuffixes: Set[String]

The file suffixes recognized by this parser. When transforming entire directories only files with names ending in one of the specified suffixes will be considered.

The file suffixes recognized by this parser. When transforming entire directories only files with names ending in one of the specified suffixes will be considered.

It is recommended not to support txt or similarly common suffixes as this might interfere with other installed formats.

Attributes

All span parsers for the markup language this parser processes.

All span parsers for the markup language this parser processes.

Attributes

Concrete methods

Creates the parser for a sequence of blocks based on the parser for a single block.

Creates the parser for a sequence of blocks based on the parser for a single block.

The parser for a single block is already the result of merging all block parsers defined within this instance with all extension parsers defined by the user.

The default implementation simply applies this parser repeatedly while skipping blank lines between the parsed blocks. This method can get overridden for special requirements, for example when the previous result has an influence on which parser to pick for the subsequent block.

Attributes

def escapedChar: Parser[String]

Parses the character after the one that started the escape sequence (usually a backslash).

Parses the character after the one that started the escape sequence (usually a backslash).

The default implementation parses any character as is, this can be overridden in case the host language has more specific rules for escape sequences.

Attributes

Inherited methods

def description: String

Short string describing the markup or output format for tooling and logging.

Short string describing the markup or output format for tooling and logging.

Attributes

Inherited from:
Format