Namespace markdownit

Index

Interfaces

Options

Type aliases

Type aliases

PluginSimple

PluginSimple: (md: markdownit) => void

Type declaration

- (md: markdownit): void
- Parameters
  - md: markdownit
  Returns void

PluginWithOptions

PluginWithOptions<T>: (md: markdownit, options?: T) => void

Type parameters

T = any

Type declaration

- (md: markdownit, options?: T): void
- Parameters
  - md: markdownit
  - Optional options: T
  Returns void

PluginWithParams

PluginWithParams: (md: markdownit, ...params: any[]) => void

Type declaration

- (md: markdownit, ...params: any[]): void
- Parameters
  - md: markdownit
  - Rest ...params: any[]
  Returns void

PresetName

PresetName: "default" | "zero" | "commonmark"

MarkdownIt provides named presets as a convenience to quickly enable/disable active syntax rules and options for common use cases.

"commonmark" - configures parser to strict CommonMark mode.
default - similar to GFM, used when no preset name given. Enables all available rules, but still without html, typographer & autolinker.
"zero" - all rules disabled. Useful to quickly setup your config via .enable(). For example, when you need only bold and italic markup and nothing else.

Generated using TypeDoc