Top Description Fields Constructors Methods
com.vladsch.flexmark.ext.gitlab

public Class GitLabExtension

extends Object
implements ParserExtension, HtmlRendererExtension, FormatterExtension
Class Inheritance
All Implemented Interfaces
com.vladsch.flexmark.formatter.Formatter.FormatterExtension, com.vladsch.flexmark.util.misc.Extension, com.vladsch.flexmark.html.HtmlRenderer.HtmlRendererExtension, com.vladsch.flexmark.parser.Parser.ParserExtension
Imports
com.vladsch.flexmark.ext.gitlab.internal.*, com.vladsch.flexmark.formatter.Formatter, com.vladsch.flexmark.html.HtmlRenderer, com.vladsch.flexmark.parser.Parser, com.vladsch.flexmark.util.data.DataKey, .MutableDataHolder, org.jetbrains.annotations.NotNull
Extension for git_labs

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

The parsed GitLab Flavoured Markdown

Field Summary

Modifier and TypeField and Description
public static final DataKey<String>
BLOCK_INFO_DELIMITERS

Deprecated use HtmlRenderer#FENCED_CODE_LANGUAGE_DELIMITERS instead
public static final DataKey<String>
BLOCK_MATH_CLASS

public static final DataKey<String>
BLOCK_MERMAID_CLASS

public static final DataKey<Boolean>
BLOCK_QUOTE_PARSER

private static final String[]
DEFAULT_MATH_LANGUAGES

private static final String[]
DEFAULT_MERMAID_LANGUAGES

public static final DataKey<Boolean>
DEL_PARSER

public static final DataKey<String>
INLINE_MATH_CLASS

public static final DataKey<Boolean>
INLINE_MATH_PARSER

public static final DataKey<Boolean>
INS_PARSER

public static final DataKey<String[]>
MATH_LANGUAGES

public static final DataKey<String[]>
MERMAID_LANGUAGES

public static final DataKey<Boolean>
NESTED_BLOCK_QUOTES

public static final DataKey<Boolean>
RENDER_BLOCK_MATH

public static final DataKey<Boolean>
RENDER_BLOCK_MERMAID

public static final DataKey<Boolean>
RENDER_VIDEO_IMAGES

public static final DataKey<Boolean>
RENDER_VIDEO_LINK

public static final DataKey<String>
VIDEO_IMAGE_CLASS

public static final DataKey<String>
VIDEO_IMAGE_EXTENSIONS

public static final DataKey<String>
VIDEO_IMAGE_LINK_TEXT_FORMAT

Constructor Summary

AccessConstructor and Description
private
GitLabExtension()

Method Summary

Modifier and TypeMethod and Description
public static GitLabExtension
create()

public void
extend(Formatter.Builder formatterBuilder)

Implements com.vladsch.flexmark.formatter.Formatter.FormatterExtension.extend.

public void
extend(Parser.Builder
parser builder with which to register extensions
parserBuilder)

Implements com.vladsch.flexmark.parser.Parser.ParserExtension.extend.

This method is called on all extensions so that they can register their custom processors

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

public void
parserOptions(MutableDataHolder
option set that will be used for the builder
options)

Implements com.vladsch.flexmark.parser.Parser.ParserExtension.parserOptions.

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

public void
rendererOptions(@NotNull MutableDataHolder
option set that will be used for the builder
options)

Implements com.vladsch.flexmark.formatter.Formatter.FormatterExtension.rendererOptions.

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

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

BLOCK_INFO_DELIMITERSback to summary
public static final DataKey<String> BLOCK_INFO_DELIMITERS

Deprecated

use HtmlRenderer#FENCED_CODE_LANGUAGE_DELIMITERS instead

Annotations
@Deprecated
BLOCK_MATH_CLASSback to summary
public static final DataKey<String> BLOCK_MATH_CLASS
BLOCK_MERMAID_CLASSback to summary
public static final DataKey<String> BLOCK_MERMAID_CLASS
BLOCK_QUOTE_PARSERback to summary
public static final DataKey<Boolean> BLOCK_QUOTE_PARSER
DEFAULT_MATH_LANGUAGESback to summary
private static final String[] DEFAULT_MATH_LANGUAGES
DEFAULT_MERMAID_LANGUAGESback to summary
private static final String[] DEFAULT_MERMAID_LANGUAGES
DEL_PARSERback to summary
public static final DataKey<Boolean> DEL_PARSER
INLINE_MATH_CLASSback to summary
public static final DataKey<String> INLINE_MATH_CLASS
INLINE_MATH_PARSERback to summary
public static final DataKey<Boolean> INLINE_MATH_PARSER
INS_PARSERback to summary
public static final DataKey<Boolean> INS_PARSER
MATH_LANGUAGESback to summary
public static final DataKey<String[]> MATH_LANGUAGES
MERMAID_LANGUAGESback to summary
public static final DataKey<String[]> MERMAID_LANGUAGES
NESTED_BLOCK_QUOTESback to summary
public static final DataKey<Boolean> NESTED_BLOCK_QUOTES
RENDER_BLOCK_MATHback to summary
public static final DataKey<Boolean> RENDER_BLOCK_MATH
RENDER_BLOCK_MERMAIDback to summary
public static final DataKey<Boolean> RENDER_BLOCK_MERMAID
RENDER_VIDEO_IMAGESback to summary
public static final DataKey<Boolean> RENDER_VIDEO_IMAGES
VIDEO_IMAGE_CLASSback to summary
public static final DataKey<String> VIDEO_IMAGE_CLASS
VIDEO_IMAGE_EXTENSIONSback to summary
public static final DataKey<String> VIDEO_IMAGE_EXTENSIONS
VIDEO_IMAGE_LINK_TEXT_FORMATback to summary
public static final DataKey<String> VIDEO_IMAGE_LINK_TEXT_FORMAT

Constructor Detail

GitLabExtensionback to summary
private GitLabExtension()

Method Detail

createback to summary
public static GitLabExtension create()
extendback to summary
public void extend(Formatter.Builder formatterBuilder)

Implements com.vladsch.flexmark.formatter.Formatter.FormatterExtension.extend.

Annotations
@Override
extendback to summary
public void extend(Parser.Builder parserBuilder)

Implements com.vladsch.flexmark.parser.Parser.ParserExtension.extend.

Doc from com.vladsch.flexmark.parser.Parser.ParserExtension.extend.

This method is called on all extensions so that they can register their custom processors

Parameters
parserBuilder:Parser.Builder

parser builder with which to register extensions

Annotations
@Override
extendback to summary
public void extend(HtmlRenderer.Builder htmlRendererBuilder, @NotNull String rendererType)
Annotations
@Override
parserOptionsback to summary
public void parserOptions(MutableDataHolder options)

Implements com.vladsch.flexmark.parser.Parser.ParserExtension.parserOptions.

Doc from com.vladsch.flexmark.parser.Parser.ParserExtension.parserOptions.

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

Parameters
options:MutableDataHolder

option set that will be used for the builder

Annotations
@Override
rendererOptionsback to summary
public void rendererOptions(@NotNull MutableDataHolder options)

Implements com.vladsch.flexmark.formatter.Formatter.FormatterExtension.rendererOptions.

Doc from com.vladsch.flexmark.formatter.Formatter.FormatterExtension.rendererOptions.

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

Parameters
options:@NotNull MutableDataHolder

option set that will be used for the builder

Annotations
@Override