$3

#### defaultOptions

Type: {showdown: object, plantuml: object, mermaid: object, katex: object, kroki: object, vega: object, toc: object, tex: object, shiki: object, gnuplot: object }

Default options is described below:

defaultOptions = {
showdown: {
flavor: 'github',
mathEngine: 'mathjax',
},
toc: { chapterNumber: true, title: '', toc: '[\\[【]Table[ -]Of[ -]Contents[\\]】]|[\\[【]目录[\\]】]|[\\[【]TOC[\\]】]|\\{\\{TOC\\}\\}' },
plantuml: { imageFormat: 'svg' },
mermaid: { theme: 'default' },
katex: { mathDelimiters: [
{ left: '$$', right: '$$', display: true },
{ left: '\\[', right: '\\]', display: true },
{ left: "\\begin{equation}", right: "\\end{equation}", display: true },
{ left: "\\begin{align}", right: "\\end{align}", display: true },
{ left: "\\begin{alignat}", right: "\\end{alignat}", display: true },
{ left: "\\begin{gather}", right: "\\end{gather}", display: true },
{ left: "\\begin{CD}", right: "\\end{CD}", display: true },
{ left: '\\(', right: '\\)', display: false },
{ left: '@@', right: '@@', display: true, asciimath: true },
{ left: "\\$", right: "\\$", display: false, asciimath: true }
]},
kroki: { serverUrl: 'kroki.io', imageFormat: 'svg' },
vega: { theme: 'vox' },
tex: { serverUrl: 'tex.io', buildType: 'pdflatex' },
shiki: { theme: 'ayu-dark' },
gnuplot: {}
};

- showdown: showdown options object

flavor - Flavor of showdown, default is 'github'.

mathEngine - Math render engine for 'mathjax' or 'katex', default is 'mathjax'.

For more showdown options, refer to the following document:

Showdown Options

- toc: table of content options object

For more toc options:

{
chapterNumber: true,
title: '',
toc: '[\\[【]Table[ -]Of[ -]Contents[\\]】]|[\\[【]目录[\\]】]|[\\[【]TOC[\\]】]|\\{\\{TOC\\}\\}'
}

chapterNumber - Whether show chapter number such as '1.1.', default is true.
title - Custom defined text content of title, default is empty string indicates auto recognition based on the language(such as '目录' on chinese, 'Table Of Contents' on other language).
toc - Custom defined regex string of test for table of contents.

- plantuml: plantuml options object

For more plantuml options:

{
umlWebSite: "www.plantuml.com/plantuml",
imageFormat: "svg" | "png" | "jpg",
svgRender: (id:string, code:string, options: {
count?: number
}) => string
}

- mermaid: mermaid options object

For more mermaid options, refer to the following document:

Mermaid Options

- katex: katex options object

For more katex options, refer to the following document:

Katex AutoRender Options
Katex Render Options

In addition, mathDelimiters is another format:

{
mathDelimiters: {
texmath: {
display: [
{left: "$$", right: "$$"},
{left: '\\[', right: '\\]'}
],
inline: [
{left: '\\(', right: '\\)'}
]
},
asciimath: {
display: [ {left: "@@", right: "@@"}],
inline: [ {left: "\\$ ", right: "\\$"}]
}
}
}

- kroki: kroki options object

For more kroki options:

{
serverUrl: "kroki.io",
imageFormat: "svg",
svgRender: (id:string, code:string, options: {
diagramType: string,
imageFormat: string
}) => string
}

- vega: vega-embed options object

For more vega-embed options, refer to the following document:

Vega-embed Options

- shiki: shiki options object

For more shiki options:

{
theme: "ayu-dark"
}

The theme of shiki see ShiKi Style.

- tex: tex options object

For more tex options:

{
serverUrl: "tex.io",
buildType: "pdflatex",
svgRender: (id:string, code:string, options: {
build: string,
zoom?: number,
width?: string,
height?: string
}) => string
}

- gnuplot: gnuplot options object

For more gnuplot options:

{
svgRender: (id:string, code:string) => string
}

#### defaultExtensions

Type: Array of showdown extensions

Default extensions is described below:

defaultExtensions = {
'showdown-toc': showdownToc(options.toc),
'showdown-image': showdownImage(),
'showdown-align': showdownAlign(),
'showdown-footnotes': showdownFootnotes(),
'showdown-container': showdownContainer(),
'showdown-sequence': showdownSequence()
}

For more showdown extensions, refer to the following document:

Showdown Extensions

#### defaultAsyncExtensions

Type: Array of showdown async extensions

Default async extensions is described below:

defaultAsyncExtensions = {
'showdown-toc': getExtension('showdown-toc', showdownToc),
'showdown-image': showdownAsyncImage(),
'showdown-plantuml': showdownPlantuml(plantumlOptions),
'showdown-mermaid': showdownMermaid(mermaidOptions),
'showdown-mathjax': showdownMathJax(mathjaxOptions),
'showdown-tex': showdownTex(texOptions),
'showdown-katex': showdownKatex(katexOptions),
'showdown-kroki': showdownKroki(krokiOptions),
'showdown-flowchart': showdownFlowchart(),
'showdown-viz': showdownViz(),
'showdown-vega': showdownVega(vegaOptions),
'showdown-wavedrom': showdownWavedrom(),
'showdown-railroad': showdownRailroad(),
'showdown-abc': showdownAbc(),
'showdown-echarts': showdownEcharts(),
'showdown-gnuplot': showdownShiki(gnuplotOptions),
'showdown-antv': showdownAntV(),
'showdown-sequence': getExtension('showdown-sequence', showdownSequence),
'showdown-shiki': showdownShiki(shikiOptions),
'showdow-css': showdownCss(),
}

$3

#### showdown

Type: showdown

Default: showdown

Output showdown.js native object for global.

#### convertor

Type: showdown.convertor | null

Default: null

Output showdown.convertor native object in current showdowns Instance.

#### eventBus

Type: EventBus

Default: EventBus

A internal event bus object, its method is as follows:

- on(event: string, callback: (...args: any[]) => any) -- Register event method
- off(event: string, callback: (...args: any[]) => any) -- Close event method
- emit(event: string, ...data: ...any[]) => number -- Emit event method

$3

#### onEvent

Type: {event: string, callback: (...args: any[]) => any} => void

Register event to showdowns engine. Currently supporting the following events:

- 'resetImagePath': (id: string, src: string, callback: (imagePath: string) => void) -- Reset image path event for inline image

#### setFlavor

Type: {name: string} => void

A function to add or update flavor of showdown and showdown.convertor.

#### addOptions

Type: {options: object} => void

A function to add or update options of showdown and showdown.convertor.

#### addExtension

Type: \[name, extension] => void

A function to add or update extension of showdown and showdown.convertor.

#### removeExtension

Type: \[name] => void

A function to remove extension of showdown and showdown.convertor.

#### addAyncExtension

Type: \[name, extension] => void

A function to add or update aync extension of showdowns.

#### removeAyncExtension

Type: \[name] => void

A function to remove aync extension of showdowns.

#### setCDN

Type: (cdnname: string, defSheme: string, distScheme: string) => void

A function to set cdn source when dynamically load js lib files related to more showdown diagrams extension.

- Parameter cdnname can be selected 'local' or 'cdnjs' or 'jsdelivr' source.
- Parameter defSheme is default prefix scheme string of source url.
- Parameter distScheme is dist prefix scheme string of source url that has prefix string is '../dist/'.

#### setShowdownFlavor

Type: (name: string) => void

A function to set default flavor of showdown. When showdown.convertor instance be created, it can update flavor of the showdown and convertor.convertor.

See showdown options of defaultOptions.

- flavor field value: ['github', 'ghost', 'vanilla', 'original', 'allon'], default set to 'github' flavor.

#### setShowdownOptions

Type: (options: object) => object

A function to set default options of showdown. When showdown.convertor instance be created, it can update options of the showdown and convertor.convertor.

See showdown options of defaultOptions.

#### setLanuageTheme

Type: (theme: string) => object

A function to set default theme of ShiKi. When showdown.convertor instance be created, it can update options of the showdown and convertor.convertor.

See ShiKi Style.

#### setExtensionlOptions

Type: (name: string, options: object) => boolean

A function to set default options of extension. It can reset new options of extension.

- Parameter name is suffix name of extension name, such as showdown-[name].

See options of extension.

#### setPlantumlOptions

Type: (options: object) => object

A function to set default options of plantuml extension. When showdown.convertor instance be created, it can reset plantuml extension using the new default options.

See plantuml options of defaultOptions.

- imageFormat field value: "svg" | "png" | "jpg", default 'png'.

#### setMermaidOptions

Type: (options: object) => object

A function to set default options of mermaid extension. When showdown.convertor instance be created, it can reset mermaid extension using the new default options.

See mermaid options of defaultOptions.

- mermaid theme field value be selected in ['default', 'forest', 'dark', 'neutral']; When it be set empty, default set to 'default' theme.

#### setKatexOptions

Type: (options: object) => object

A function to set default options of katex extension. When showdown.convertor instance be created, it can reset katex extension using the new default options.

See katex options of defaultOptions.

#### setKrokiOptions

Type: (options: object) => object

A function to set default options of kroki extension. When showdown.convertor instance be created, it can reset kroki extension using the new default options.

See Kroki options of defaultOptions.

#### setVegaOptions

Type: (options: object) => object

A function to set default options of vega extension. When showdown.convertor instance be created, it can reset vega extension using the new default options.

See vega-embed options of defaultOptions.

- vega theme field value be selected in ['excel', 'ggplot2', 'quartz', 'vox', 'dark']; When it be set empty, default set to 'vox' theme.

#### init

Type: (reset?: boolean | {option: boolean, extension: boolean}) => showdonws

A function to init that be created showdown.convertor instance or update default showdown options of the showdown.convertor and reset the extensions using default extension options(as mermaid options, vega options, plantul options) for showdowns.

- Parameter reset: After showdown.convertor instance be created; If option of reset object is ture, you update default showdown options; If extension of reset object is ture, reset the extensions using default extension options(as mermaid options, vega options, plantul options); If reset is true, same as value is {option: true, extension: true}.

#### makeHtml

Type: interface script {
outer?:[{
name:string,
src:string,
module?:boolean|'import'|'link'
}],
id?:string,
code?:string,
module?:boolean,
host?:string | HTMLElement
inner?:[{
id:string,
code:string,
module?:boolean,
host?:string | HTMLElement
}]
}

Type: interface csslink {
id: string,
link: string
}

Type: ({type:'zip', content: string, output: 'dom'} | string) => Promise\<{html: string | HTMLElement[], scripts: script[], cssLinks: csslink[]}>

A async function to make markdown to html that showdown.convertor converte it in current showdowns instance.

#### completedHtml

Type: ( scripts?: script[] | string, scriptContainer?: HTMLElement | string) => Promise\

A async function to completed markdown to html that append scripts to dom.

#### zDecode

Type: (data: string) => string

A function to decode data that be encoded using zEncode.

#### zEncode

Type: (content: string) => string

A function to encode content with zlib.

License

MIT

Copyright (c) 2019-present, Jhuix (Hui Jin)