Class YamlFrontMatterExtension
java.lang.Object
com.vladsch.flexmark.ext.yaml.front.matter.YamlFrontMatterExtension
- All Implemented Interfaces:
Formatter.FormatterExtension
,Parser.ParserExtension
,Extension
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
The parsed metadata is turned into YamlFrontMatterNode
. You can access the metadata using AbstractYamlFrontMatterVisitor
.
-
Field Summary
Fields inherited from interface com.vladsch.flexmark.util.misc.Extension
EMPTY_LIST
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic YamlFrontMatterExtension
create()
void
extend
(Formatter.Builder formatterBuilder) void
extend
(Parser.Builder parserBuilder) This method is called on all extensions so that they can register their custom processorsvoid
parserOptions
(MutableDataHolder options) This method is called first on all extensions so that they can adjust the options that must be common to all extensions.void
rendererOptions
(MutableDataHolder options) This method is called first on all extensions so that they can adjust the options.
-
Constructor Details
-
YamlFrontMatterExtension
private YamlFrontMatterExtension()
-
-
Method Details
-
rendererOptions
Description copied from interface:Formatter.FormatterExtension
This method is called first on all extensions so that they can adjust the options.- Specified by:
rendererOptions
in interfaceFormatter.FormatterExtension
- Parameters:
options
- option set that will be used for the builder
-
extend
- Specified by:
extend
in interfaceFormatter.FormatterExtension
-
extend
Description copied from interface:Parser.ParserExtension
This method is called on all extensions so that they can register their custom processors- Specified by:
extend
in interfaceParser.ParserExtension
- Parameters:
parserBuilder
- parser builder with which to register extensions- See Also:
-
Parser.Builder.customBlockParserFactory(CustomBlockParserFactory)
Parser.Builder.customInlineParserExtensionFactory(InlineParserExtensionFactory)
Parser.Builder.customInlineParserFactory(InlineParserFactory)
Parser.Builder.customDelimiterProcessor(DelimiterProcessor)
Parser.Builder.postProcessorFactory(PostProcessorFactory)
Parser.Builder.paragraphPreProcessorFactory(ParagraphPreProcessorFactory)
Parser.Builder.blockPreProcessorFactory(BlockPreProcessorFactory)
Parser.Builder.linkRefProcessorFactory(LinkRefProcessorFactory)
Parser.Builder.specialLeadInHandler(SpecialLeadInHandler)
-
parserOptions
Description copied from interface:Parser.ParserExtension
This method is called first on all extensions so that they can adjust the options that must be common to all extensions.- Specified by:
parserOptions
in interfaceParser.ParserExtension
- Parameters:
options
- option set that will be used for the builder
-
create
-