配置

Mr.Hope ... 2020-10-13 大约 3 分钟

你可以传递以下选项来启用或禁用一些功能

# enableAll

  • 类型: boolean
  • 默认值: false

启用全部功能。

警告

请仅将此选项用于体验或测试。

随着时间的增长,vupress-plugin-md-enhance 变得越来越强大。它为 Markdown 解析器添加了更多语法,并输出了更多代码。

启用不需要的功能将增加开发和构建时间。 (markdown-it 必须检查额外的语法)

同样,幻灯片演示功能将在输出中添加 700KB 大小的代码 (主要是 reveal.js)。

因此,请使用下面的选项,仅启用需要的功能。

# lineNumbers

  • 类型: boolean
  • 默认值: true

是否在每个代码块的左侧显示行号。

# align

  • 类型: boolean
  • 默认值: false

是否启用自定义对齐格式支持。

# sup

  • 类型: boolean
  • 默认值: false

是否启用上角标格式支持。

# sub

  • 类型: boolean
  • 默认值: false

是否启用下角标格式支持。

# footnote

  • 类型: boolean
  • 默认值: false

是否启用脚注格式支持。

# mark

  • 类型: boolean
  • 默认值: false

是否启用标记格式支持。

# tasklist

  • 类型: TaskListOptions | boolean
  • 默认值: false

是否启用任务列表格式支持。你可以传入一个对象作为任务列表的配置选项。

interface TaskListOptions {
  /**
   * 是否使用 `<label>` 来包裹文字
   *
   * @default true
   */
  label?: boolean;
  /**
   * 是否将 `<label>` 放置在 `<input>` 后还是包裹住 `<input>`
   *
   * @default true
   */
  labelAfter?: boolean;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14

# tex

  • 类型: KatexOptions | boolean
  • 默认值: false

是否启用 TeX\TeX 语法支持。你可以传入一个对象作为 KaTeX\KaTeX 的配置选项。

# mermaid

  • 类型: boolean
  • 默认值: false

是否启用 Mermaid (opens new window) 支持。

# flowchart

  • 类型: boolean
  • 默认值: false

是否启用流程图支持。

# demo

  • 类型: CodeDemoGlobalOptions | boolean
  • 默认值: false

是否启用代码案例支持。

# demo.jsLib

  • 类型: string[]
  • 必填: 否

CodePen, JsFiddle 需要引入的外部 JS 库。

# demo.cssLib

  • 类型: string[]
  • 必填: 否

CodePen, JsFiddle 需要引入的外部 CSS 库。

注意

上述两个选项仅仅是给第三方代码演示使用的,你需要自行在 head 中导入这些库。

# demo.jsfiddle

  • 类型: boolean
  • 默认值: true

是否显示 JSFiddle 按钮,

# demo.codepen

  • 类型: boolean
  • 默认值: true

是否显示 CodePen 按钮,

# demo.codepenLayout

  • 类型: "top" | "left" | "right"
  • 默认值: "left"

CodePen 编辑器布局

# demo.editors

  • 类型: string
  • 默认值: "101"

CodePen 编辑器显示情况,第一位代表 HTML ,第二位代表 JS,第三位代表演示页面。

# 其他

以下是第三方代码演示使用的库地址,除非你的环境无法访问 jsdelivr 或访问缓慢,否则无需覆盖默认设置。

注意

请注意,如果你用到了它们,你仍需要利用 head 手动在你的网站中导入它们。

React 依赖于 Babel。

# demo.vue

默认值: "https://cdn.jsdelivr.net/npm/vue/dist/vue.min.js"

# demo.react

默认值: "https://cdn.jsdelivr.net/npm/react/umd/react.production.min.js"

# demo.reactDOM

默认值: "https://cdn.jsdelivr.net/npm/react-dom/umd/react-dom.production.min.js"

# presentation

  • 类型: PresentationOptions | boolean
  • 默认值: false

是否启用幻灯片支持。

你可以传入一个对象,这个对象将用于 reveal.js 配置。

# presentation.plugins

  • 类型: string[]
  • 必填: No

你想启用的 Reveal.js 插件

可接受的插件有:

  • "highlight"
  • "math"
  • "search"
  • "notes"
  • "zoom"

# presentation.revealConfig

  • 类型: Partial<RevealOptions>
  • 必填: No

你想要传递给 Reveal.js 的配置选项