Package com.vladsch.flexmark.ext.gitlab

Class GitLabExtension

java.lang.Object

com.vladsch.flexmark.ext.gitlab.GitLabExtension

All Implemented Interfaces:

Formatter.FormatterExtension, HtmlRenderer.HtmlRendererExtension, Parser.ParserExtension, Extension

public class GitLabExtension
extends java.lang.Object
implements Parser.ParserExtension, HtmlRenderer.HtmlRendererExtension, Formatter.FormatterExtension

Extension for git_labs

Create it with create() and then configure it on the builders

The parsed GitLab Flavoured Markdown

Field Summary

Fields

Modifier and Type	Field	Description
static DataKey<java.lang.String>	BLOCK_INFO_DELIMITERS	Deprecated. use HtmlRenderer.FENCED_CODE_LANGUAGE_DELIMITERS instead
static DataKey<java.lang.String>	BLOCK_MATH_CLASS
static DataKey<java.lang.String>	BLOCK_MERMAID_CLASS
static DataKey<java.lang.Boolean>	BLOCK_QUOTE_PARSER
private static java.lang.String[]	DEFAULT_MATH_LANGUAGES
private static java.lang.String[]	DEFAULT_MERMAID_LANGUAGES
static DataKey<java.lang.Boolean>	DEL_PARSER
static DataKey<java.lang.String>	INLINE_MATH_CLASS
static DataKey<java.lang.Boolean>	INLINE_MATH_PARSER
static DataKey<java.lang.Boolean>	INS_PARSER
static DataKey<java.lang.String[]>	MATH_LANGUAGES
static DataKey<java.lang.String[]>	MERMAID_LANGUAGES
static DataKey<java.lang.Boolean>	NESTED_BLOCK_QUOTES
static DataKey<java.lang.Boolean>	RENDER_BLOCK_MATH
static DataKey<java.lang.Boolean>	RENDER_BLOCK_MERMAID
static DataKey<java.lang.Boolean>	RENDER_VIDEO_IMAGES
static DataKey<java.lang.Boolean>	RENDER_VIDEO_LINK
static DataKey<java.lang.String>	VIDEO_IMAGE_CLASS
static DataKey<java.lang.String>	VIDEO_IMAGE_EXTENSIONS
static DataKey<java.lang.String>	VIDEO_IMAGE_LINK_TEXT_FORMAT

Fields inherited from interface com.vladsch.flexmark.util.misc.Extension

EMPTY_LIST

Constructor Summary

Constructors

Modifier	Constructor	Description
private	GitLabExtension()

Method Summary

Modifier and Type	Method	Description
static GitLabExtension	create()
void	extend(Formatter.Builder formatterBuilder)
void	extend(HtmlRenderer.Builder htmlRendererBuilder, @NotNull java.lang.String rendererType)	Called to give each extension to register extension points that it contains
void	extend(Parser.Builder parserBuilder)	This method is called on all extensions so that they can register their custom processors
void	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(@NotNull MutableDataHolder options)	This method is called first on all extensions so that they can adjust the options that must be common to all extensions.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MATH_LANGUAGES

private static final java.lang.String[] DEFAULT_MATH_LANGUAGES

DEFAULT_MERMAID_LANGUAGES

private static final java.lang.String[] DEFAULT_MERMAID_LANGUAGES

INS_PARSER

public static final DataKey<java.lang.Boolean> INS_PARSER

DEL_PARSER

public static final DataKey<java.lang.Boolean> DEL_PARSER

BLOCK_QUOTE_PARSER

public static final DataKey<java.lang.Boolean> BLOCK_QUOTE_PARSER

NESTED_BLOCK_QUOTES

public static final DataKey<java.lang.Boolean> NESTED_BLOCK_QUOTES

INLINE_MATH_PARSER

public static final DataKey<java.lang.Boolean> INLINE_MATH_PARSER

RENDER_BLOCK_MATH

public static final DataKey<java.lang.Boolean> RENDER_BLOCK_MATH

RENDER_BLOCK_MERMAID

public static final DataKey<java.lang.Boolean> RENDER_BLOCK_MERMAID

RENDER_VIDEO_IMAGES

public static final DataKey<java.lang.Boolean> RENDER_VIDEO_IMAGES

RENDER_VIDEO_LINK

public static final DataKey<java.lang.Boolean> RENDER_VIDEO_LINK

MATH_LANGUAGES

public static final DataKey<java.lang.String[]> MATH_LANGUAGES

MERMAID_LANGUAGES

public static final DataKey<java.lang.String[]> MERMAID_LANGUAGES

INLINE_MATH_CLASS

public static final DataKey<java.lang.String> INLINE_MATH_CLASS

BLOCK_MATH_CLASS

public static final DataKey<java.lang.String> BLOCK_MATH_CLASS

BLOCK_MERMAID_CLASS

public static final DataKey<java.lang.String> BLOCK_MERMAID_CLASS

VIDEO_IMAGE_CLASS

public static final DataKey<java.lang.String> VIDEO_IMAGE_CLASS

VIDEO_IMAGE_LINK_TEXT_FORMAT

public static final DataKey<java.lang.String> VIDEO_IMAGE_LINK_TEXT_FORMAT

BLOCK_INFO_DELIMITERS

@Deprecated
public static final DataKey<java.lang.String> BLOCK_INFO_DELIMITERS

Deprecated.

use HtmlRenderer.FENCED_CODE_LANGUAGE_DELIMITERS instead

VIDEO_IMAGE_EXTENSIONS

public static final DataKey<java.lang.String> VIDEO_IMAGE_EXTENSIONS

Constructor Detail

GitLabExtension

private GitLabExtension()

Method Detail

create

public static GitLabExtension create()

rendererOptions

public void rendererOptions(@NotNull
                            @NotNull MutableDataHolder options)

Description copied from interface: HtmlRenderer.HtmlRendererExtension

This method is called first on all extensions so that they can adjust the options that must be common to all extensions.

Specified by:

rendererOptions in interface Formatter.FormatterExtension

Specified by:

rendererOptions in interface HtmlRenderer.HtmlRendererExtension

Parameters:

options - option set that will be used for the builder

parserOptions

public void parserOptions(MutableDataHolder options)

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 interface Parser.ParserExtension

Parameters:

options - option set that will be used for the builder

extend

public void extend(Formatter.Builder formatterBuilder)

Specified by:

extend in interface Formatter.FormatterExtension

extend

public void extend(Parser.Builder parserBuilder)

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 interface Parser.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)

extend

public void extend(@NotNull
                   HtmlRenderer.Builder htmlRendererBuilder,
                   @NotNull
                   @NotNull java.lang.String rendererType)

Description copied from interface: HtmlRenderer.HtmlRendererExtension

Called to give each extension to register extension points that it contains

Specified by:

extend in interface HtmlRenderer.HtmlRendererExtension

Parameters:

htmlRendererBuilder - builder to call back for extension point registration

rendererType - type of rendering being performed. For now "HTML", "JIRA" or "YOUTRACK"

See Also:

HtmlRenderer.Builder.attributeProviderFactory(AttributeProviderFactory), HtmlRenderer.Builder.nodeRendererFactory(NodeRendererFactory), HtmlRenderer.Builder.linkResolverFactory(LinkResolverFactory), HtmlRenderer.Builder.htmlIdGeneratorFactory(HeaderIdGeneratorFactory)