Config

About 4 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 GFM.

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.

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.

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.

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 Markmap support.

mermaid

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

Whether to enable Mermaid support.

plantuml

Type: MarkdownItPlantumlOptions[] | boolean
Default: false
Details:
- Plantuml

Whether to enable plantuml support.

spoiler

Type: boolean
Default: false
Details:
- Spoiler

Whether to enable spoiler 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

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 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 UnoPresetPlaygroundOptions {
  /**
   * external playground service url
   *
   * @default "https://unocss.dev/play"
   */
  service?: string;
}

type BuiltInPlaygroundPreset = "ts" | "vue" | "unocss";

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

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

External JS libraries for CodePen, JsFiddle only.

demo.cssLib

Type: string[]
Required: No

External JS libraries for CodePen, JsFiddle only.

Warning

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

demo.jsfiddle

Type: boolean
Default: true

Whether to display the JSFiddle button

demo.codepen

Type: boolean
Default: true

Whether to display the CodePen button

demo.codepenLayout

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

CodePen editor layout

demo.codepenEditors

Type: string
Default: "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"

sandpack

Type: boolean
Default: false

Whether to enable sandpack playground support.

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

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.

Client Config

defineEChartsConfig

interface EChartsConfig {
  /**
   * ECharts global options
   */
  option?: EChartsOption;

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

const defineEChartsConfig: (config: EChartsConfig) => void;

Define global options and setup for ECharts.

defineMermaidConfig

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

Define config which you want to pass to mermaid.

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;
}

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

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

defineSandpackConfig

 interface SandpackConfig {
  /**
   * specify the template
   */
  template?: SandpackPredefinedTemplate;

  /**
   * Options to configure the sandpack
   */
  options?: SandpackOptions;

  /**
   * Options to configure the customSetup
   */
  customSetup?: SandpackSetup;
}

const defineSandpackConfig = (config: SandpackConfig)=> void

Define config which you want to pass to sandpack-vue3.

defineVuePlaygroundConfig

export interface VuePlaygroundOptions
  extends Omit<ReplProps, "store" | "editor"> {
  /**
   * Specify the version of vue
   */
  vueVersion?: string;

  /**
   * Specify default URL to import Vue dev runtime from in the sandbox
   *
   * @default "https://unpkg.com/@vue/runtime-dom@${version}/dist/runtime-dom.esm-browser.js"
   */
  vueRuntimeDevUrl?: string | (() => string);

  /**
   * Specify default URL to import Vue prod runtime from in the sandbox
   *
   * @default "https://unpkg.com/@vue/runtime-dom@${version}/dist/runtime-dom.esm-browser.prod.js"
   */
  vueRuntimeProdUrl?: string | (() => 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"
   */
  vueServerRendererUrl?: string | (() => string);
}

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

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