Markdown Stylize Config

The following options adds new stylize feature, and can be set under markdown property in theme options.

Options

markdown.hintboolean

Defaulttrue

Whether to enable hint containers, including important, info, note, tip, warning, caution and details.

See also: Markdown → Hint box and @vuepress/plugin-markdown-hint → hint.

markdown.alertboolean

Whether to enable GFM alerts.

See also: Markdown → GFM alert and @vuepress/plugin-markdown-hint → alert.

markdown.alignboolean

Whether to enable custom align.

See also: Markdown → Align and @vuepress/plugin-markdown-stylize → align.

markdown.attrsMarkdownItAttrsOptions | boolean

Whether to enable attribute customize support.

See also: Markdown → Attrs and @vuepress/plugin-markdown-stylize → attrs.

markdown.attrs.leftstring

Default'{'

Left delimiter.

markdown.attrs.rightstring

Default'}'

Right delimiter.

markdown.attrs.allowed(string | RegExp)[]

Default[]

Allowed attributes. An empty list means allowing all attributes.

markdown.attrs.rule"all" | boolean | MarkdownItAttrRuleName[]

Default"all"

Rules to enable, where MarkdownItAttrRuleName is one of "fence", "inline", "table", "list", "hr", "softbreak" and "block".

markdown.layoutboolean

Whether to enable layout support.

See also: Markdown → Layout and @vuepress/plugin-markdown-stylize → layout.

markdown.markboolean

Whether to enable mark support.

See also: Markdown → Mark and @vuepress/plugin-markdown-stylize → mark.

markdown.supboolean

Whether to enable the superscript support.

See also: Markdown → Superscript and @vuepress/plugin-markdown-stylize → sup.

markdown.subboolean

Whether to enable subscript support.

See also: Markdown → Subscript and @vuepress/plugin-markdown-stylize → sub.

markdown.spoilerboolean

Whether to enable spoiler support.

See also: Markdown → Spoiler and @vuepress/plugin-markdown-stylize → spoiler.

markdown.stepsboolean

Whether to enable steps support.

See also: Markdown → Steps and @vuepress/plugin-markdown-stylize → steps.

markdown.stylizeMarkdownItStylizeConfig[] | false

Stylize inline tokens to create snippet you want.

See also: Markdown → Stylize and @vuepress/plugin-markdown-stylize → custom.

markdown.stylize[*].matcherstring | RegExp

Inline token matcher.

markdown.stylize[*].replacer(options: { tag: string; content: string; attrs: Record<string, string>; env?: any }) => MarkdownItStylizeResult | null | undefined | void

Content replacer. MarkdownItStylizeResult is:

interface MarkdownItStylizeResult {
  /**
   * Tag name
   */
  tag: string;
  /**
   * Attributes settings
   */
  attrs: Record<string, string>;
  /**
   * Tag content
   */
  content: string;
}