Optional boldThe character which will be used to signify bolded text.
Optional italicIndicator determining what character is used to denote italics.
Optional onA hook for injecting or manipulating document content after footnotes are added to the end of the document. Expects the caller to return the document with any changes applied to it.
Optional onA hook for injecting or manipulating document content before footnotes are added to the end of the document. Expects the caller to return the document with any changes applied to it.
Optional prefixAn arbitrary prefix which will be prepended to every line of text generated within the context of these options. Typically used by the main markdown generator when recursively rendering lines of markdown.
Optional renderersThe renderers which will be used when processing markdown entries.
Optional unorderedAn indicator specifying which character to use when denoting an unordered list item. Default: '-'
Optional useIndicates whether or not to use codeblock fencing rather than standard indentation for codeblocks.
Supplying true tells the renderer to always use code fencing with the default character.
Otherwise, supplying a character tells the renderer to always use code fencing with the specified character.
Omitting this options results in indented codeblocks.
Optional useOption to render description lists as HTML. Default: false
Optional useOption which will use '=' underlining for denoting an h1 rather than a '#' prefix.
Optional useOption which will use '-' underlining for denoting an h2 rather than a '##' prefix.
Optional useOption to render subscript indicators as HTML. Default: false
Optional useOption to render superscript indicators as HTML. Default: false
Generated using TypeDoc
Document-level options which can affect broad aspects of the rendering process. Whenever these options have entry-level equivalent options, the entry-level options take precedence.