docs/org.intellij.markdown.flavours.gfm/GFMFlavourDescriptor

GFMFlavourDescriptor

open class GFMFlavourDescriptor(useSafeLinks: Boolean = true, absolutizeAnchorLinks: Boolean = false, makeHttpsAutoLinks: Boolean = false, useTagFilter: Boolean = false) : CommonMarkFlavourDescriptor

GitHub Markdown spec based flavour, to be used as a base for other flavours.

Parameters

useSafeLinks

true if all rendered links should be checked for XSS and false otherwise. See makeXssSafeDestination

absolutizeAnchorLinks

true if anchor links (e.g. #foo) should be resolved against baseURI and false otherwise

makeHttpsAutoLinks

enables use of HTTPS schema for auto links.

useTagFilter

true if the GFM tagfilter extension should be applied when rendering raw HTML and false otherwise. When enabled, the leading < of the disallowed raw HTML tags (title, textarea, style, xmp, iframe, noembed, noframes, script, plaintext) is replaced with <. See Disallowed Raw HTML (extension)

Inheritors

SFMFlavourDescriptor

Constructors

GFMFlavourDescriptor

constructor(useSafeLinks: Boolean = true, absolutizeAnchorLinks: Boolean = false, makeHttpsAutoLinks: Boolean = false)

For ABI compatibility.

constructor(useSafeLinks: Boolean = true, absolutizeAnchorLinks: Boolean = false, makeHttpsAutoLinks: Boolean = false, useTagFilter: Boolean = false)

Properties

markerProcessorFactory

open override val markerProcessorFactory: MarkerProcessorFactory

sequentialParserManager

open override val sequentialParserManager: SequentialParserManager

Functions

createHtmlGeneratingProviders

open override fun createHtmlGeneratingProviders(linkMap: LinkMap, baseURI: URI?): Map<IElementType, GeneratingProvider>

createInlinesLexer

open override fun createInlinesLexer(): MarkdownLexer