Markdown 扩展

VitePress 带有内置的 Markdown 扩展。

头部锚点

头部会自动获取锚点链接。可以通过 markdown.anchor 选项配置锚点的渲染。

链接

内部和外部链接都会特殊处理。

内部链接

内部链接转换为 SPA 导航的路由链接。此外，每个子目录中包含的每个 index.md 都会自动转换为 index.html，并带有相应的URL /。

举个例子，现在有以下目录结构：

.
├─ index.md
├─ foo
│  ├─ index.md
│  ├─ one.md
│  └─ two.md
└─ bar
   ├─ index.md
   ├─ three.md
   └─ four.md

在 foo/one.md中:

[Home](/) <!-- 点击跳转到 根目录的 index.md -->
[foo](/foo/) <!-- 点击跳转到 foo 目录的 index.html -->
[foo heading](./#heading) <!-- 锚点会定位到 foo 的 heading 标题 -->
[bar - three](../bar/three) <!-- 你可以不写后缀名 -->
[bar - three](../bar/three.md) <!-- 也可以加 .md -->
[bar - four](../bar/four.html) <!-- 或者加 .html -->

页面后缀

默认情况下，页面和内部链接会生成带有 .html 的后缀。

外部链接

外部的链接会自动识别并生成 target="_blank" rel="noreferrer" 的链接，如下：

Frontmatter

YAML frontmatter 通过外部支持:

yaml

---
title: Blogging Like a Hacker
lang: en-US
---

该数据可用于页面的其他部分，以及所有自定义和主题化组件。

了解跟多, 可以查看 Frontmatter.

GitHub样式的表格

输入

| Tables        | Are           | Cool  |
| ------------- |:-------------:| -----:|
| col 3 is      | right-aligned | $1600 |
| col 2 is      | centered      |   $12 |
| zebra stripes | are neat      |    $1 |

输出

Tables	Are	Cool
col 3 is	right-aligned	$1600
col 2 is	centered	$12
zebra stripes	are neat	$1

Emoji 🎉

输入

:tada: :100:

输出

🎉 💯

可用的emoji可以通过这里了解

表格内容

输入

[[toc]]

输出

可以使用 markdown.toc 选项配置 TOC 的渲染。

自定义容器

自定义容器可以通过其类型、标题和内容来定义。

默认标题

输入

::: info
This is an info box.
:::

::: tip
This is a tip.
:::

::: warning
This is a warning.
:::

::: danger
This is a dangerous warning.
:::

::: details
This is a details block.
:::

输出

INFO

This is an info box.

TIP

This is a tip.

WARNING

This is a dangerous warning.

DANGER

This is a dangerous warning.

Details

This is a details block.

自定义标题

你可以通过在容器的“类型”后面添加文本来设置自定义标题。

输入

::: danger STOP
Danger zone, do not proceed
:::

::: details Click me to view the code
```js
console.log('Hello, VitePress!')
```
:::

输出

STOP

Danger zone, do not proceed

Click me to view the code

console.log('Hello, VitePress!')

`raw`

这是一个特殊的容器，可以用来防止样式和路由与 VitePress 冲突。当作为组件库文档使用时，这尤其有用。

语法

::: raw
Wraps in a <div class="vp-raw">
:::

vp-raw 类也可以直接用于元素，样式隔离目前是可选择的。

具体细节

Install required deps with your preferred package manager:
sh
```
$ yarn add -D postcss postcss-prefix-selector
```

Create a file named docs/.postcssrc.cjs and add this to it:

module.exports = {
  plugins: {
    'postcss-prefix-selector': {
      prefix: ':not(:where(.vp-raw *))',
      includeFiles: [/vp-doc\.css/],
      transform(prefix, _selector) {
        const [selector, pseudo = ''] = _selector.split(/(:\S*)$/)
        return selector + prefix + pseudo
      }
    }
  }
}

在代码块中高亮语法

VitePress使用 Shiki 的彩色文本来突出Markdown代码块中的语言语法。Shiki 支持多种编程语言，只需要在代码块的开头 ``` 定义对应的语言。

输入

```js
export default {
  name: 'MyComponent',
  // ...
}
```

```html
<ul>
  <li v-for="todo in todos" :key="todo.id">
    {{ todo.text }}
  </li>
</ul>
```

输出

export default {
  name: 'MyComponent'
  // ...
}

html

<ul>
  <li v-for="todo in todos" :key="todo.id">
    {{ todo.text }}
  </li>
</ul>

在 Shiki 的仓库里有对应支持的语言列表。

你还可以在应用配置中自定义语法高亮主题。有关详细信息，请参阅 markdown 选项。

代码块中定义行高亮

输入

```js{4}
export default {
  data () {
    return {
      msg: 'Highlighted!'
    }
  }
}
```

输出

export default {
  data () {
    return {
      msg: 'Highlighted!'
    }
  }
}

除了单行之外，还可以指定多个单行、范围或者多个一起定义：

行范围: 例如 {5-8}, {3-10}, {10-17}
多个单行: 例如 {4,7,9}
行范围和多个单行: 例如 {4,7-13,16,23-27,40}

输入

```js{1,4,6-8}
export default { // Highlighted
  data () {
    return {
      msg: `Highlighted!
      This line isn't highlighted,
      but this and the next 2 are.`,
      motd: 'VitePress is awesome',
      lorem: 'ipsum'
    }
  }
}
```

输出

export default { // Highlighted
  data () {
    return {
      msg: `Highlighted!
      This line isn't highlighted,
      but this and the next 2 are.`,
      motd: 'VitePress is awesome',
      lorem: 'ipsum',
    }
  }
}

行数

可以通过配置为每个代码块启用行号

export default {
  markdown: {
    lineNumbers: true
  }
}

可以通过 markdown 选项了解更多.

导入代码片段

你可以通过以下语法从现有文件中导入代码片段：

<<< @/filepath

同时也支持行高亮:

<<< @/filepath{highlightLines}

输入

<<< @/snippets/snippet.js{2}

代码文件

export default function () {
  // ..
}

输出

export default function () {
  // ..
}

TIP

@ 相当于项目指定的源目录。默认情况下，它是 VitePress 项目根目录，当然也可以通过 srcDir 配置项配置。

你也可以使用 VS 代码区域来导入仅包含代码文件的相应部分。也可以在文件路径后的 # 后面提供自定义区域名称：

输入

<<< @/snippets/snippet-with-region.js#snippet{1}

代码文件

// #region snippet
function foo() {
  // ..
}
// #endregion snippet

export default foo

输出

function foo() {
  // ..
}

你还可以在大括号 ({}) 中指定语言：

<<< @/snippets/snippet.cs{c#}

<!-- 指定 行高亮: -->
<<< @/snippets/snippet.cs{1,2,4-6 c#}

这在无法从文件扩展名中推断出源语言会很有用。

包含其他 Markdown 文件

你可以通过下面的写法在 markdown 文件中引入另外的markdown文件

输入

# Docs

## Basics

<!--@include: ./parts/basics.md-->

部分文件 (parts/basics.md)

Some getting started stuff.

### Configuration

Can be created using `.foorc.json`.

等同于以下代码

# Docs

## Basics

Some getting started stuff.

### Configuration

Can be created using `.foorc.json`.

警告

注意，如果文件不存在，将不会引发错误。因此，在使用此特性时，请确保按预期呈现内容。

高级配置

VitePress使用 markdown-it 作为Markdown渲染器。上面的许多扩展是通过自定义插件实现的。您可以使用vitepress/config.js中的Markdown选项进一步自定义Markdown-It实例：

const anchor = require('markdown-it-anchor')

module.exports = {
  markdown: {
    // options for markdown-it-anchor
    // https://github.com/valeriangalliat/markdown-it-anchor#usage
    anchor: {
      permalink: anchor.permalink.headerLink()
    },

    // options for @mdit-vue/plugin-toc
    // https://github.com/mdit-vue/mdit-vue/tree/main/packages/plugin-toc#options
    toc: { level: [1, 2] },

    config: (md) => {
      // use more markdown-it plugins!
      md.use(require('markdown-it-xxx'))
    }
  }
}

通过 Configs: App Configs 查看可配置属性的完整列表

Markdown 扩展 #

头部锚点 #

链接 #

内部链接 #

页面后缀 #

外部链接 #

Frontmatter #

GitHub样式的表格 #

Emoji 🎉 #

表格内容 #

自定义容器 #

默认标题 #

自定义标题 #

raw #

在代码块中高亮语法 #

代码块中定义 行高亮 #

行数 #

导入代码片段 #

包含其他 Markdown 文件 #

高级配置 #