Markdown Grammar Config

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

markdown.component

• Type: boolean
• Default: false
• Details:
  • Component → Grammar
  • @vuepress/plugin-markdown-ext → component

Whether to enable component support.

markdown.footnote

• Type: boolean
• Default: false
• Enabled in GFM: Yes
• Details:
  • Markdown → Footnote
  • @vuepress/plugin-markdown-ext → footnote

Whether to enable footnote format support.

markdown.imgMark

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

Whether to enable image mark.

markdown.imgSize

• Type: boolean
• Default: false
• Details:
  • Markdown → Image Size
  • @vuepress/plugin-markdown-image → size

Whether to enable image size.

markdown.obsidianImgSize

• Type: boolean
• Default: false
• Details:
  • Markdown → Image Size
  • @vuepress/plugin-markdown-image → obsidianSize

Whether to enable obsidian image size.

markdown.include

• Type: MarkdownIncludePluginOptions | boolean

  interface MarkdownIncludePluginOptions {
    /**
     * handle include filePath
     *
     * @default (path) => path
     */
    resolvePath?: (path: string, cwd: string) => string;
  
    /**
     * Whether deep include files in included Markdown files
     *
     * @default false
     */
    deep?: boolean;
  }

• Default: false

• Details:

  • Markdown → Include
  • @vuepress/plugin-markdown-include

Whether to enable Markdown import support. You can pass in a object to customize behavior.

markdown.tabs

• Type: boolean
• Default: false
• Details:
  • Markdown → Tabs
  • @vuepress/plugin-markdown-tab → tabs

Whether to enable tabs support.

markdown.tasklist

• Type: MarkdownItTaskListOptions | boolean

  interface MarkdownItTaskListOptions {
    /**
     * Whether disable checkbox
     *
     * @default true
     */
    disabled?: boolean;
  
    /**
     * Whether use `<label>` to wrap text
     *
     * @default true
     */
    label?: boolean;
  }

• Default: false

• Enabled in GFM: Yes

• Details:

  • Markdown → Tasklist
  • @vuepress/plugin-markdown-ext

Whether to enable tasklist format support. You can pass an object to config task list.

markdown.math

• Type: MarkdownMathPluginOptions | boolean

  interface MarkdownKatexPluginOptions extends KatexOptions {
    type?: "katex";
  
    /**
     * Whether to allow inline math with spaces on ends
     *
     * @description NOT recommended to set this to true, because it will likely break the default usage of $
     *
     * @default false
     */
    allowInlineWithSpace?: boolean;
  
    /**
     * Whether enable copy plugin
     *
     * @default false
     */
    copy?: boolean;
  
    /**
     * Whether enable mhchem plugin
     *
     * @default false
     */
    mhchem?: boolean;
  }
  
  interface MarkdownMathjaxPluginOptions
    extends Omit<MarkdownItMathjaxOptions, "transformer"> {
    type?: "mathjax";
  
    /**
     * Whether to allow inline math with spaces on ends
     *
     * @description NOT recommended to set this to true, because it will likely break the default usage of $
     *
     * @default false
     */
    allowInlineWithSpace?: boolean;
  
    /**
     * Output syntax
     *
     * @default 'svg'
     */
    output?: "chtml" | "svg";
  
    /**
     * Enable A11y
     *
     * @default true
     */
    a11y?: boolean;
  
    /**
     * TeX input options
     */
    tex?: MathJaxTexInputOptions;
  
    /**
     * Common HTML output options
     */
    chtml?: MathjaxCommonHTMLOutputOptions;
  
    /**
     * SVG output options
     */
    svg?: MathjaxSVGOutputOptions;
  }
  
  type MarkdownMathPluginOptions =
    | MarkdownKatexPluginOptions
    | MarkdownMathjaxPluginOptions;

• Default: false

• Details:

  • Markdown → Math
  • @vuepress/plugin-markdown-math

Whether to enable math formula support. You can set true to auto detect the installed one of katex/mathjax, or provide plugin options.

markdown.revealjs

• Type: RevealJsPluginOptions | boolean

  type RevealJsPlugin = "highlight" | "math" | "notes" | "search" | "zoom";
  
  type RevealJsTheme =
    | "auto"
    | "beige"
    | "black"
    | "blood"
    | "league"
    | "moon"
    | "night"
    | "serif"
    | "simple"
    | "sky"
    | "solarized"
    | "white";
  
  interface RevealJsPluginOptions {
    /**
     * Reveal.js plugins
     *
     * @default []
     */
    plugins?: RevealJsPlugin[];
    /**
     * Reveal.js themes
     *
     * @default ["auto"]
     */
    themes?: RevealJsTheme[];
  }

• Default: false

• Details:

  • Markdown → Presentation
  • @vuepress/plugin-revealjs

Controls @vuepress/plugin-revealjs which provides presentation support. You can set true to directly enable it, or provide plugin options.