GFMFlavourDescriptor

open class GFMFlavourDescriptor(useSafeLinks: Boolean, absolutizeAnchorLinks: Boolean, makeHttpsAutoLinks: Boolean) : CommonMarkFlavourDescriptor
Content copied to clipboard

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.

Constructors

GFMFlavourDescriptor
Link copied to clipboard
common
fun GFMFlavourDescriptor(useSafeLinks: Boolean = true, absolutizeAnchorLinks: Boolean = false, makeHttpsAutoLinks: Boolean = false)
Content copied to clipboard
true if all rendered links should be checked for XSS and false otherwise.

Functions

createHtmlGeneratingProviders
Link copied to clipboard
common
open override fun createHtmlGeneratingProviders(linkMap: LinkMap, baseURI: URI?): Map<IElementType, GeneratingProvider>
Content copied to clipboard
createInlinesLexer
Link copied to clipboard
common
open override fun createInlinesLexer(): MarkdownLexer
Content copied to clipboard

Properties

markerProcessorFactory
Link copied to clipboard
common
open override val markerProcessorFactory: MarkerProcessorFactory
Content copied to clipboard
sequentialParserManager
Link copied to clipboard
common
open override val sequentialParserManager: SequentialParserManager
Content copied to clipboard

Inheritors

SFMFlavourDescriptor
Link copied to clipboard