Markdown Grammar Config

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

Options

markdown.componentboolean

Whether to enable component support.

See also: Component → Grammar and @vuepress/plugin-markdown-ext → component.

markdown.footnotegfm: Yesboolean

Whether to enable footnote format support.

See also: Markdown → Footnote and @vuepress/plugin-markdown-ext → footnote.

markdown.imgMarkboolean

Whether to enable image mark.

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

markdown.imgSizeboolean

Whether to enable image size.

See also: Markdown → Image Size and @vuepress/plugin-markdown-image → size.

markdown.obsidianImgSizeboolean

Whether to enable Obsidian image size.

See also: Markdown → Image Size and @vuepress/plugin-markdown-image → obsidianSize.

markdown.legacyImgSizeDeprecatedboolean

Whether to enable legacy image size.

See also: Markdown → Image Size and @vuepress/plugin-markdown-image → legacySize.

markdown.includeMarkdownIncludePluginOptions | boolean

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

See also: Markdown → Include and @vuepress/plugin-markdown-include.

markdown.include.resolvePath(path: string, cwd: string) => string

Default(path) => path

Handle the path of the included file.

markdown.include.deepboolean

Whether to deep include files in included Markdown files.

markdown.fieldsboolean

Whether to enable fields support.

See also: Markdown → Fields and @vuepress/plugin-markdown-field → fields.

markdown.tabsboolean

Whether to enable tabs support.

See also: Markdown → Tabs and @vuepress/plugin-markdown-tab → tabs.

markdown.tasklistgfm: YesMarkdownItTaskListOptions | boolean

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

See also: Markdown → Tasklist and @vuepress/plugin-markdown-ext.

markdown.tasklist.disabledboolean

Defaulttrue

Whether to disable checkbox.

markdown.tasklist.labelboolean

Defaulttrue

Whether to use <label> to wrap text.

markdown.mathMarkdownMathPluginOptions | boolean

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

See also: Markdown → Math and @vuepress/plugin-markdown-math.

Its type is:

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;

markdown.revealjsRevealJsPluginOptions | boolean

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

See also: Markdown → Presentation and @vuepress/plugin-revealjs.

markdown.revealjs.pluginsRevealJsPlugin[]

Default[]

Built-in reveal.js plugins to enable.

Available values: highlight, math, notes, search, zoom.

markdown.revealjs.themesRevealJsTheme[]

Default["auto"]

Themes to enable.

Available values: auto, beige, black, blood, league, moon, night, serif, simple, sky, solarized, white.