Parse
Related Docs:
object Parse
| package api
The type of the result returned by all operations of this trait.
The type of the result returned by all operations of this trait.
The type of the result returned by all operations of this trait.
The type of the operation being configured by this instance
The type of the operation being configured by this instance
The configuration to use for all input operations.
The configuration to use for all input operations.
The file suffixes recognized by this parser.
The file suffixes recognized by this parser. When transforming entire directories only files with names ending in one of the specified suffixes will be consired.
Returns the result obtained by parsing files from the current working directory.
Returns the result obtained by parsing files from the current working directory.
the files to exclude from processing
the character encoding of the files, if not specified the platform default will be used.
Returns the result obtained by parsing files from the specified directories and its subdirectories, merging them into a tree with a single root.
Returns the result obtained by parsing files from the specified directories and its subdirectories, merging them into a tree with a single root.
the root directories to traverse
the files to exclude from processing
the character encoding of the files, if not specified the platform default will be used.
Returns the result obtained by parsing files from the specified directories and its subdirectories, merging them into a tree with a single root.
Returns the result obtained by parsing files from the specified directories and its subdirectories, merging them into a tree with a single root.
the root directories to traverse
the character encoding of the files, if not specified the platform default will be used.
Returns the result obtained by parsing files from the specified directory and its subdirectories.
Returns the result obtained by parsing files from the specified directory and its subdirectories.
the root directory to traverse
the files to exclude from processing
the character encoding of the files, if not specified the platform default will be used.
Returns the result obtained by parsing files from the specified directory and its subdirectories.
Returns the result obtained by parsing files from the specified directory and its subdirectories.
the root directory to traverse
the character encoding of the files, if not specified the platform default will be used.
Returns the result obtained by parsing files from the specified directory and its subdirectories.
Returns the result obtained by parsing files from the specified directory and its subdirectories.
the name of the directory to traverse
the files to exclude from processing
the character encoding of the files, if not specified the platform default will be used.
Returns the result obtained by parsing files from the specified directory and its subdirectories.
Returns the result obtained by parsing files from the specified directory and its subdirectories.
the name of the directory to traverse
the character encoding of the files, if not specified the platform default will be used.
Returns the result from parsing the specified file.
Returns the result from parsing the specified file. Any kind of character input is valid, including empty files.
the file to use as input
the character encoding of the file, if not specified the platform default will be used.
Returns the result from parsing the file with the specified name.
Returns the result from parsing the file with the specified name. Any kind of character input is valid, including empty files.
the name of the file to parse
the character encoding of the file, if not specified the platform default will be used.
Returns the result from parsing the specified input.
Returns the result from parsing the specified input.
This is a generic method based on Laika's IO abstraction layer that concrete methods delegate to. Usually not used directly in application code, but might come in handy for very special requirements.
the input for the parser
Returns the result obtained by parsing files from the specified input tree.
Returns the result obtained by parsing files from the specified input tree.
the input tree to process
Returns the result obtained by parsing files from the specified input tree builder.
Returns the result obtained by parsing files from the specified input tree builder.
a builder for the input tree to process
Returns the result from parsing the input from the specified reader.
Returns the result from parsing the input from the specified reader.
Returns the result from parsing the input from the specified stream.
Returns the result from parsing the input from the specified stream.
the stream to use as input for the parser
the character encoding of the stream, if not specified the platform default will be used.
Returns the result from parsing a the specified string.
Returns the result from parsing a the specified string. Any kind of input is valid, including an empty string.
Instructs the parser and/or renderer to process all inputs and outputs in parallel, with the specified level of parallelism.
Instructs the parser and/or renderer to process all inputs and outputs in parallel, with the specified level of parallelism.
The recursive structure of document trees will be flattened before parsing and rendering and then get reassembled afterwards, therefore the parallel processing includes all subtrees of the document tree.
The actual transformation is a three phase process, the first (parsing) and third (rendering) can run in parallel. The second phase in the middle cannot, as this is the document tree model rewrite step where things like cross references or table of contents get processed that need access to more than just the current document.
the number of batches to be executed in parallel, 1 means sequential execution
the minimum number of operations required for parallel execution
Instructs the parser and/or renderer to process all inputs and outputs in parallel, with the default level of parallelism which corresponds to the number of CPUs.
Instructs the parser and/or renderer to process all inputs and outputs in parallel, with the default level of parallelism which corresponds to the number of CPUs.
The recursive structure of document trees will be flattened before parsing and rendering and then get reassembled afterwards, therefore the parallel processing includes all subtrees of the document tree.
The actual transformation is a three phase process, the first (parsing) and third (rendering) can run in parallel. The second phase in the middle cannot, as this is the document tree model rewrite step where things like cross references or table of contents get processed that need access to more than just the current document.
Returns a new Parse instance adding the specified parser factory.
Returns a new Parse instance adding the specified parser factory. This factory is usually an object provided by the library or a plugin that is capable of parsing a specific markup format like Markdown or reStructuredText.
This method is useful if you want to combine different markup formats within a single document tree.
the parser factory to add to the previously specified parsers
Turns strict mode on for the target parser, switching off any features not part of the original markup syntax.
Turns strict mode on for the target parser, switching off any features not part of the original markup syntax. This includes the registration of directives (custom tags), custom templates with directives, as well as configuration sections at the start of the document.
Technically it removes all ExtensionBundle instances which do not have
the useInStrictMode flag set to true.
Returns a new instance with the specified extension bundles installed.
Returns a new instance with the specified extension bundles installed. Features in the new bundles may override features in already installed bundles.
Bundles are usually provided by libraries (by Laika itself or a 3rd-party extension library) or as re-usable building blocks by application code.
Returns a new instance with the specified configuration.
Returns a new instance with the specified configuration.
This method discards any previously specified options. It is usually meant to be used when copying over the configuration from a fully configured object to an unconfigured one.
Enables all extensions that process raw content embedded into the host markup language.
Enables all extensions that process raw content embedded into the host markup language. These 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.
Technically it activates all ExtensionBundle instances which have
the acceptRawContent flag set to true.
Returns a new Parse instance that produces raw document trees without applying the default rewrite rules.
Returns a new Parse instance that produces raw document trees without applying the default rewrite rules. These rules resolve link and image references and rearrange the tree into a hierarchy of sections based on the (flat) sequence of header instances found in the document.
API for performing a parse operation from various types of input to obtain a document tree without a subsequent render operation.
In cases where a render operation should follow immediately, it is more convenient to use the laika.api.Transform API instead which combines a parse and a render operation directly.
Example for parsing Markdown from a file:
Example for parsing from an entire directory:
Example for parsing a directory that contains markup documents in different formats: