Config

About 6 min

Plugin Options

You can pass these options to the plugin:

gfm

Type: boolean
Default: false
Details:
- GFM

Whether to support full GFM syntax.

Note

For full GFM syntax, see GFMopen in new window.

Honestly, we do not 100% implement GFM, we only supply its common syntax.

Some of the behavior might be different, for example to support Vue syntax, we are not disallowing <script> tags. But in most situation, the behavior should be same.

hint

Type: boolean
Default: false
Details:
- Hint box

Whether to enable hint box including

important
info
note
tip
warning
caution
details

Warning

The last 4 items conflict with default theme and will override its style.

checkLinks

Type: LinksCheckOptions

type LinksCheckStatus = "always" | "dev" | "build" | "never";

interface LinksCheckOptions {
  /**
   * Whether check dead links in markdown
   *
   * @default "dev"
   */
  status?: LinksCheckStatus;

  /**
   * Dead links to ignore
   */
  ignore?: (string | RegExp)[] | ((link: string, isDev: boolean) => boolean);
}

Default: { status: "dev" }
Details:
- Link Check

Whether to enable links check.

vPre

Type: boolean
Default: false
Details:
- v-pre wrapper

Whether to enable v-pre wrapper.

breaks

Type: boolean
Default: false
Enabled in GFM: Yes

Whether convert \n in paragraphs into <br>s

linkify

Type: boolean
Default: false
Enabled in GFM: Yes

Whether convert URL-like text into links

alert

Type: boolean
Default: false
Enabled in GFM: Yes
Details:
- GFM Alerts

Whether to enable gfm alerts.

tabs

Type: boolean
Default: false
Details:
- Tabs

Whether to enable tabs.

codetabs

Type: boolean
Default: false
Details:
- Code Tabs

Whether to enable codetabs.

align

Type: boolean
Default: false
Details:
- Align

Whether to enable custom align.

attrs

Type: AttrsOptions | boolean

interface AttrsOptions {
  /**
   * left delimiter
   *
   * @default '{'
   */
  left?: string;

  /**
   * right delimiter
   *
   * @default '}'
   */
  right?: string;

  /**
   * allowed attributes
   *
   * @description An empty list means allowing all attribute
   *
   * @default []
   */
  allowed?: (string | RegExp)[];
}

Default: false
Details:
- Attrs

Whether to enable attribute customize support.

sup

Type: boolean
Default: false
Details:
- Superscript

Whether to enable the upper format support.

sub

Type: boolean
Default: false
Details:
- Subscript

Whether to enable the lower corner format support.

footnote

Type: boolean
Default: false
Enabled in GFM: Yes
Details:
- Footnote

Whether to enable footnote format support.

mark

Type: boolean
Default: false
Details:
- Mark

Whether to enable mark support.

figure

Type: boolean
Default: false
Details:
- Figure

Whether enable figure support.

imgLazyload

Type: boolean
Default: false
Details:
- Image Lazyload

Whether to lazy load every image in page in native way.

imgMark

Type: ImageMarkOptions | boolean

interface ImageMarkOptions {
  /** lightmode only IDs */
  light?: string[];
  /** darkmode only IDs */
  dark?: string[];
}

Default: false
Enabled in GFM: Yes
Details:
- Image Mark

Whether enable image mark support.

imgSize

Type: boolean
Default: false
Details:
- Image Size

Whether enable image size support.

obsidianImgSize

Type: boolean
Default: false
Details:
- Image Size

Whether enable obsidian image size support.

tasklist

Type: TaskListOptions | boolean

interface TaskListOptions {
  /**
   * Whether disable checkbox
   *
   * @default true
   */
  disabled?: boolean;

  /**
   * Whether use `<label>` to wrap text
   *
   * @default true
   */
  label?: boolean;
}

Default: false
Enabled in GFM: Yes
Details:
- Tasklist

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

include

Type: IncludeOptions | boolean

interface IncludeOptions {
  /**
   * 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:
- Include files

Whether to enable Markdown import support. You can pass in a function for path resolution.

katex

Type: KatexOptions & { copy?: boolean; mhchem?: boolean } | boolean
Default: false
Details:
- TeX

Whether to enable $T E X$ syntax support through KaTeX. You can pass an object to config KaTeX.

In particular, you can enable the copy and mhchem extensions with katex.copy: true and katex.mhchem: true.

Please see Katex Docsopen in new window for available options.

mathjax

Type: MathJaxOptions | boolean
Default: false
Enabled in GFM: Yes
Details:
- TeX

Whether to enable $T E X$ syntax support through Math Jax. You can pass an object to config Math Jax.

Please see source codeopen in new window for available options.

component

Type: boolean
Default: false
Details:
- Component

Whether to enable component support

chart

Type: boolean
Default: false
Details:
- Chart.js

Whether to enable chart support

echarts

Type: boolean
Default: false
Details:
- Echarts

Whether to enable ECharts support

flowchart

Type: boolean
Default: false
Details:
- Flowchart

Whether to enable flowchart support

markmap

Type: boolean
Default: false
Details:
- Markmap

Whether to enable Markmapopen in new window support.

mermaid

Type: boolean
Default: false
Enabled in GFM: Yes
Details:
- Mermaid

Whether to enable Mermaidopen in new window support.

stylize

Type: StylizeOptions | false

interface StylizeResult {
  /**
   * Tag name
   */
  tag: string;

  /**
   * Attributes settings
   */
  attrs: Record<string, string>;

  /**
   * Tag content
   */
  content: string;
}

interface StylizeItem {
  /**
   * Inline token matcher
   */
  matcher: string | RegExp;

  /**
   * Content Replacer
   */
  replacer: (options: {
    tag: string;
    content: string;
    attrs: Record<string, string>;
    env?: MarkdownEnv;
  }) => StylizeResult | void;
}

type StylizeOptions = StylizeItem[];

Default: false
Details:
- Stylize

Stylize inline tokens to create snippet you want.

playground

Type: PlaygroundGlobalOptions

import type { CompilerOptions } from "typescript";

interface PlaygroundCodeConfig {
  /**
   * Code block extension
   *
   * @description It's based on filename, not code fence language
   */
  ext: string;

  /**
   * Code block content
   */
  content: string;
}

interface PlaygroundData {
  /**
   * Title of Playground
   */
  title?: string;

  /**
   * Import map file name
   *
   * @default 'import-map.json'
   */
  importMap?: string;

  /**
   * Playground files info
   */
  files: Record<
    /** File name */
    string,
    /** File detail */
    PlaygroundCodeConfig
  >;

  /**
   * Playground settings
   *
   * @description It's parsed result of json content after setting directive
   */
  settings: Record<string, unknown>;

  /**
   * hash key based on playground content
   */
  key: string;
}

interface PlaygroundOptions {
  /**
   * Playground container name
   */
  name: string;

  /**
   * Playground component name
   *
   * @default 'Playground'
   */
  component?: string;

  /**
   * Props getter
   */
  propsGetter: (data: PlaygroundData) => Record<string, string>;
}

interface TSPresetPlaygroundOptions extends CompilerOptions {
  /**
   * external playground service url
   *
   * @default "https://www.typescriptlang.org/play"
   */
  service?: string;
}

interface UnoPresetPlaygroundOptions {
  /**
   * external playground service url
   *
   * 交互演示外部地址
   *
   * @default "https://unocss.dev/play"
   */
  service?: string;
}

interface VuePresetPlaygroundOptions {
  /**
   * external playground service url
   *
   * @default "https://sfc.vuejs.org/"
   */
  service?: string;

  /**
   * Whether to use dev version
   *
   * @default false
   */
  dev?: boolean;

  /**
   * Whether to enable SSR
   *
   * @default false
   */
  ssr?: boolean;
}

interface PlaygroundGlobalOptions {
  /** Playground presets */
  presets: ("ts" | "vue" | PlaygroundOptions)[];
  /** Playground config */
  config?: {
    ts?: TSPresetPlaygroundOptions;
    vue?: VuePresetPlaygroundOptions;
  };
}

Required: No
Details:
- Playground

Playground options.

kotlinPlayground

Type: boolean
Default: false
Details:
- Kotlin Playground

Whether to enable kotlin playground support.

vuePlayground

Type: boolean
Default: false
Details:
- Vue Playground

Whether to enable vue playground support.

demo

Type: CodeDemoGlobalOptions | boolean
Default: false
Details:
- Code Demo

Whether to enable code demo support.

demo.jsLib

Type: string[]
Required: No

CodePen, JsFiddle requires an external JS library for dating.

demo.cssLib

Type: string[]
Required: No

CodePen, JsFiddle need an external CSS library for dating.

Warning

The above two options are only used by third-party code demo service, you need to import these libraries in head.

demo.jsfiddle

Type: boolean
Default value: true

Whether to display the JSFiddle button

demo.codepen

Type: boolean
Default value: true

Whether to display the CodePen button

demo.codepenLayout

Type: "top" | "left" | "correct"
Default value: "left"

CodePen editor layout

demo.codepenEditors

Type: string
Default value: "101"

CodePen editor status

others

The following are the library links used by the third-party code demo service. Unless your environment cannot visit unpkg or the speed is slow, you probably don't need to override the default values.

demo.babel

Default value: "https://unpkg.com/@babel/standalone/babel.min.js"

demo.vue

Default value: "https://unpkg.com/vue/dist/vue.global.prod.js"

demo.react

Default value: "https://unpkg.com/react/umd/react.production.min.js"

demo.reactDOM

Default value: "https://unpkg.com/react-dom/umd/react-dom.production.min.js"

revealJs

Type: RevealJsOptions | boolean

type RevealJsPlugin = "highlight" | "math" | "search" | "notes" | "zoom";

type RevealJsTheme =
  | "auto"
  | "beige"
  | "black"
  | "blood"
  | "league"
  | "moon"
  | "night"
  | "serif"
  | "simple"
  | "sky"
  | "solarized"
  | "white";

/**
 * reveal.js options
 */
export interface RevealJsOptions {
  /**
   * reveal.js plugins
   *
   * @default []
   */
  plugins?: RevealJsPlugin[];

  /**
   * reveal.js themes
   *
   * @default ["auto"]
   */
  themes?: RevealJsTheme[];
}

Default: false
Details:
- Reveal.js

Whether to enable slides support. You can pass an option to control plugins and themes to import.

delay

Type: number
Default: 800

The delay of operating dom, in ms.

Tips

If the theme you are using has a switching animation, it is recommended to configure this option to Switch animation duration + 200.

locales

Type: MarkdownEnhanceLocaleConfig

interface MarkdownEnhanceLocaleData {
  /**
   * Default Title text for info block
   */
  info: string;

  /**
   * Default Title text for note block
   */
  note: string;

  /**
   * Default Title text for tip block
   */
  tip: string;

  /**
   * Default Title text for warning block
   */
  warning: string;

  /**
   * Default Title text for danger block
   */
  danger: string;

  /**
   * Default Title text for details block
   */
  details: string;
}

interface MarkdownEnhanceLocaleConfig {
  [localePath: string]: MarkdownEnhanceLocaleData;
}

Required: No

Locales config for Markdown Enhance Plugin.

Built-in Supported Languages

Simplified Chinese (zh-CN)
Traditional Chinese (zh-TW)
English (United States) (en-US)
German (de-DE)
German (Australia) (de-AT)
Russian (ru-RU)
Ukrainian (uk-UA)
Vietnamese (vi-VN)
Portuguese (Brazil) (pt-BR)
Polish (pl-PL)
French (fr-FR)
Spanish (es-ES)
Slovak (sk-SK)
Japanese (ja-JP)
Turkish (tr-TR)
Korean (ko-KR)
Finnish (fi-FI)
Indonesian (id-ID)
Dutch (nl-NL)

Client Config

defineEchartsConfig

export interface EchartsConfig {
  /**
   * Echarts global options
   */
  option?: EChartsOption;

  /**
   * Echarts setup function
   */
  setup?: () => Promise<void>;
}

export const defineEchartsConfig: (config: EchartsConfig) => void;

Define global options and setup for Echarts.

defineMermaidConfig

export const defineMermaidConfig: (options: MermaidConfig) => void;

Define config which you want to pass to mermaid.

defineRevealJsConfig

export const defineRevealJsConfig: (options: RevealOptions) => void;

Define config which you want to pass to reveal.js.

defineKotlinPlaygroundConfig

interface KotlinPlaygroundOptions {
  server?: string;
  version?: string;

  onChange?: (code: string) => void;
  onRun?: () => void;
  onError?: () => void;
  getJsCode?: (code: string) => void;
  onTestPassed?: () => void;
  onTestFailed?: () => void;
  onOpenConsole?: () => void;
  onCloseConsole?: () => void;
  callback?: (targetNode: HTMLElement, mountNode: HTMLElement) => void;
  getInstance?: (instance: KotlinPlaygroundInstance) => void;
}

export const defineKotlinPlaygroundConfig: (
  options: KotlinPlaygroundOptions,
) => void;

Define config which you want to pass to kotlin-playground.

defineVuePlaygroundConfig

interface VuePlaygroundOptions {
  /**
   * specify the version of vue
   */
  vueVersion?: string;

  /**
   * specify default URL to import Vue runtime from in the sandbox
   *
   * @default "https://unpkg.com/@vue/runtime-dom@${version}/dist/runtime-dom.esm-browser.js"
   */
  defaultVueRuntimeURL?: string;

  /**
   * Specify default URL to import Vue Server Renderer from in the sandbox
   *
   * @default "https://unpkg.com/@vue/server-renderer@${version}/dist/server-renderer.esm-browser.js"
   */
  defaultVueServerRendererURL?: string;

  /**
   * Whether to enable repl's editor resizable
   *
   * @default true
   */
  autoResize?: boolean;

  /**
   * Whether to show JS, CSS, SSR panel
   *
   * @default false
   */
  showCompileOutput?: boolean;

  /**
   * Whether to show import map
   *
   * @default true
   */
  showImportMap?: boolean;

  /**
   * Whether to clear console
   *
   * @default false
   */
  clearConsole?: boolean;

  /**
   * Layout
   *
   * @default 'horizontal'
   */
  layout?: "horizontal" | "vertical";

  /**
   * Options to configure the `vue/compiler-sfc`
   */
  sfcOptions?: SFCOptions;

  /**
   * Whether to enable SSR
   *
   * @default true
   */
  ssr?: boolean;
}

export const defineVuePlaygroundConfig: (options: VuePlaygroundOptions) => void;

Define config which you want to pass to @vue/repl.

Config

# Plugin Options

# gfm

# hint

# checkLinks

# vPre

# breaks

# linkify

# alert

# tabs

# codetabs

# align

# attrs

# sup

# sub

# footnote

# mark

# figure

# imgLazyload

# imgMark

# imgSize

# obsidianImgSize

# tasklist

# include

# katex

# mathjax

# component

# chart

# echarts

# flowchart

# markmap

# mermaid

# stylize

# playground

# kotlinPlayground

# vuePlayground

# demo

# demo.jsLib

# demo.cssLib

# demo.jsfiddle

# demo.codepen

# demo.codepenLayout

# demo.codepenEditors

# others

# demo.babel

# demo.vue

# demo.react

# demo.reactDOM

# revealJs

# delay

# locales

# Client Config

# defineEchartsConfig

# defineMermaidConfig

# defineRevealJsConfig

# defineKotlinPlaygroundConfig

# defineVuePlaygroundConfig