Markdown 扩展语法
VitePress 在标准 Markdown 语法基础上提供了丰富的扩展功能。
内置扩展
VitePress 内置了以下 Markdown 扩展：
- GitHub 风格表格
- Emoji 支持
- 目录生成
- 自定义容器
- 代码块增强
- 数学公式
表格
基础表格
| 属性 | 类型 | 默认值 | 说明 |
|---|---|---|---|
title | string | - | 网站标题 |
description | string | - | 网站描述 |
lang | string | en-US | 语言代码 |
markdown
| 属性 | 类型 | 默认值 | 说明 |
|------|------|--------|------|
| `title` | `string` | - | 网站标题 |
| `description` | `string` | - | 网站描述 |对齐方式
| 左对齐 | 居中对齐 | 右对齐 |
|---|---|---|
| 内容 | 内容 | 内容 |
markdown
| 左对齐 | 居中对齐 | 右对齐 |
|:-------|:--------:|-------:|
| 内容 | 内容 | 内容 |Emoji 表情
VitePress 支持 Emoji 表情符号：
输出： 🎉 🚀 💡 ✨ 🔥 💪
markdown
:tada: :rocket: :bulb: :sparkles: :fire: :muscle:常用 Emoji
| 代码 | 输出 | 用途 |
|---|---|---|
:tada: | 🎉 | 庆祝 |
:rocket: | 🚀 | 发布 |
:bug: | 🐛 | Bug |
:sparkles: | ✨ | 新功能 |
:memo: | 📝 | 文档 |
:warning: | ⚠️ | 警告 |
目录
使用 [[toc]] 自动生成当前页面的目录：
markdown
## 章节一
### 子章节 1.1
### 子章节 1.2
## 章节二
[[toc]]配置选项
可在配置中设置目录的标题级别：
ts
export default defineConfig({
themeConfig: {
outline: {
level: [2, 3] // 只显示 h2 和 h3
}
}
})自定义容器
默认容器
TIP
这是一个提示容器。
INFO
这是一个信息容器。
WARNING
这是一个警告容器。
DANGER
这是一个危险容器。
自定义标题
自定义标题
你可以为容器设置自定义标题。
markdown
::: tip 自定义标题
你可以为容器设置自定义标题。
:::详情容器
点击展开
这是隐藏的详细内容，点击后才会显示。
可以包含多行内容和代码：
javascript
console.log('Hello!')代码块
基础语法高亮
javascript
function hello(name) {
return `Hello, ${name}!`
}
// 调用函数
console.log(hello('World'))指定语言
typescript
interface User {
id: number
name: string
}
function getUser(id: number): User {
// ...
}行高亮
typescript
interface Config {
title: string // 高亮
description: string
lang: string // 高亮
theme: 'dark' | 'light' // 高亮
}markdown
\`\`\`typescript{2,4-5}
interface Config {
title: string
description: string
lang: string
theme: 'dark' | 'light'
}
\`\`\`行号
默认显示行号，可通过配置关闭：
ts
export default defineConfig({
markdown: {
lineNumbers: false
}
})代码组
bash
npm install vitepressbash
yarn add vitepressbash
pnpm add vitepress导入代码片段
从文件导入代码：
markdown
<<< @/snippets/snippet.js导入特定行：
markdown
<<< @/snippets/snippet.js{2-4}数学公式
VitePress 支持 LaTeX 数学公式（需要配置）：
行内公式
欧拉恒等式：$e^{i\pi} + 1 = 0$
块级公式
$$ \frac{\partial f}{\partial x} = \lim_{\Delta x \to 0} \frac{f(x + \Delta x) - f(x)}{\Delta x} $$
脚注
VitePress 支持脚注语法：
markdown
这是一个脚注示例[^note]。
[^note]: 这是脚注的内容。下一步
本章检查清单
0 / 12 已完成0%