Module org.commonmark.ext.front.matter

Package org.commonmark.ext.front.matter

Class YamlFrontMatterExtension

java.lang.Object

org.commonmark.ext.front.matter.YamlFrontMatterExtension

All Implemented Interfaces:

Extension, Parser.ParserExtension, MarkdownRenderer.MarkdownRendererExtension

public class YamlFrontMatterExtension
extends Object
implements Parser.ParserExtension, MarkdownRenderer.MarkdownRendererExtension

Extension for YAML-like metadata.

Create it with create() and then configure it on the builders (Parser.Builder.extensions(Iterable), HtmlRenderer.Builder.extensions(Iterable)).

By default, the extension parses the subset of YAML with a built-int YamlSubsetParser. The parsed metadata is turned into YamlFrontMatterNode. You can access the metadata using YamlFrontMatterVisitor.readData(Node).

Alternatively, you can create the extension with RawContentParser.Factory. It turns the YAML front matter into YamlFrontMatterRawContent node, which stores the entire front matter as a string. You can access the content with YamlFrontMatterVisitor.readRawContent(Node) to process it with other tools.

Implement FrontMatterParser interface and the corresponding factory to parse the front matter with a custom parser.

Field Summary

Fields

Modifier and Type	Field	Description
private final FrontMatterParser.Factory	frontMatterParserFactory

Constructor Summary

Constructors

Modifier	Constructor	Description
private	YamlFrontMatterExtension(FrontMatterParser.Factory frontMatterParserFactory)

Method Summary

Modifier and Type	Method	Description
static Extension	create()
static Extension	create(FrontMatterParser.Factory parser)
void	extend(Parser.Builder parserBuilder)
void	extend(MarkdownRenderer.Builder rendererBuilder)	Extend Markdown rendering, usually by registering custom node renderers using MarkdownRenderer.Builder.nodeRendererFactory(org.commonmark.renderer.markdown.MarkdownNodeRendererFactory).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

frontMatterParserFactory

private final FrontMatterParser.Factory frontMatterParserFactory

Constructor Details

YamlFrontMatterExtension

private YamlFrontMatterExtension(FrontMatterParser.Factory frontMatterParserFactory)

Method Details

extend

public void extend(Parser.Builder parserBuilder)

Specified by:

extend in interface Parser.ParserExtension

create

public static Extension create()

create

public static Extension create(FrontMatterParser.Factory parser)

extend

public void extend(MarkdownRenderer.Builder rendererBuilder)

Description copied from interface: MarkdownRenderer.MarkdownRendererExtension

Extend Markdown rendering, usually by registering custom node renderers using MarkdownRenderer.Builder.nodeRendererFactory(org.commonmark.renderer.markdown.MarkdownNodeRendererFactory).

Specified by:

extend in interface MarkdownRenderer.MarkdownRendererExtension

Parameters:

rendererBuilder - the renderer builder to extend