com.vladsch.flexmark.ext.yaml.front.matter

Class YamlFrontMatterExtension

java.lang.Object

com.vladsch.flexmark.ext.yaml.front.matter.YamlFrontMatterExtension

All Implemented Interfaces:

Extension, Formatter.FormatterExtension, Parser.ParserExtension

public class YamlFrontMatterExtension
extends Object
implements Parser.ParserExtension, Formatter.FormatterExtension

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 AbstractYamlFrontMatterVisitor.

Field Summary

Fields inherited from interface com.vladsch.flexmark.Extension

EMPTY_LIST, EMPTY_SET

Method Summary

Modifier and Type	Method and Description
static Extension	create()
void	extend(Formatter.Builder builder)
void	extend(Parser.Builder parserBuilder)
void	parserOptions(MutableDataHolder options)
void	rendererOptions(MutableDataHolder options)

Methods inherited from class java.lang.Object

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

Method Detail

rendererOptions

public void rendererOptions(MutableDataHolder options)

Specified by:

rendererOptions in interface Formatter.FormatterExtension

extend

public void extend(Formatter.Builder builder)

Specified by:

extend in interface Formatter.FormatterExtension

extend

public void extend(Parser.Builder parserBuilder)

Specified by:

extend in interface Parser.ParserExtension

parserOptions

public void parserOptions(MutableDataHolder options)

Specified by:

parserOptions in interface Parser.ParserExtension

create

public static Extension create()