org.commonmark.ext.front.matter

Class YamlFrontMatterExtension

java.lang.Object

org.commonmark.ext.front.matter.YamlFrontMatterExtension

All Implemented Interfaces:

Extension, Parser.ParserExtension

public class YamlFrontMatterExtension
extends Object
implements Parser.ParserExtension

Extension for YAML-like metadata.

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

The parsed metadata is turned into YamlFrontMatterNode. You can access the metadata using YamlFrontMatterVisitor.

Method Summary

Modifier and Type	Method and Description
static Extension	create()
void	extend(Parser.Builder parserBuilder)

Methods inherited from class java.lang.Object

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

Method Detail

extend

public void extend(Parser.Builder parserBuilder)

Specified by:

extend in interface Parser.ParserExtension

create

public static Extension create()