Markdown Stylize Config

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

markdown.align

• Type: boolean
• Default: false
• Details:
  • Markdown → Align
  • @vuepress/plugin-markdown-stylize → align

Whether to enable custom align.

markdown.attrs

• Type: MarkdownItAttrsOptions | boolean

  type MarkdownItAttrRuleName =
    | "fence"
    | "inline"
    | "table"
    | "list"
    | "hr"
    | "softbreak"
    | "block";
  
  interface MarkdownItAttrsOptions {
    /**
     * left delimiter
     *
     * @default '{'
     */
    left?: string;
  
    /**
     * right delimiter
     *
     * @default '}'
     */
    right?: string;
  
    /**
     * allowed attributes
     *
     * @description An empty list means allowing all attribute
     *
     * @default []
     */
    allowed?: (string | RegExp)[];
    /**
     * Rules to enable
     *
     * @default "all"
     */
    rule?: "all" | boolean | MarkdownItAttrRuleName[];
  }

• Default: false

• Details:

  • Markdown → Attrs
  • @vuepress/plugin-markdown-stylize → attrs

Whether to enable attribute customize support.

markdown.mark

• Type: boolean
• Default: false
• Details:
  • Markdown → Mark
  • @vuepress/plugin-markdown-stylize → mark

Whether to enable mark support.

markdown.sup

• Type: boolean
• Default: false
• Details:
  • Markdown → Superscript
  • @vuepress/plugin-markdown-stylize → sup

Whether to enable the superscript support.

markdown.sub

• Type: boolean
• Default: false
• Details:
  • Markdown → Subscript
  • @vuepress/plugin-markdown-stylize → sub

Whether to enable subscript support.

markdown.spoiler

• Type: boolean
• Default: false
• Details:
  • Markdown → Spoiler
  • @vuepress/plugin-markdown-stylize → spoiler

Whether to enable spoiler support.

markdown.stylize

• Type: MarkdownItStylizeConfig[] | false

  interface MarkdownItStylizeResult {
    /**
     * Tag name
     */
    tag: string;
    /**
     * Attributes settings
     */
    attrs: Record<string, string>;
    /**
     * Tag content
     */
    content: string;
  }
  
  interface MarkdownItStylizeConfig {
    /**
     * Inline token matcher
     */
    matcher: string | RegExp;
    /**
     * Content Replacer
     */
    replacer: (options: {
      tag: string;
      content: string;
      attrs: Record<string, string>;
      env?: any;
    }) => MarkdownItStylizeResult | null | undefined | void;
  }

• Default: false

• Details:

  • Markdown → Stylize
  • @vuepress/plugin-markdown-stylize → custom

Stylize inline tokens to create snippet you want.