Markdown 扩展

VitePress 在标准 Markdown 之上提供了很多增强能力。用好这些能力，可以让文档既清楚又有层次。

代码高亮

在代码块后写语言名称即可启用高亮：

export default {
  title: '拾光文档馆',
  description: '清爽的中文文档站'
}

高亮指定行

const steps = [
  '安装依赖',
  '启动预览',
  '开始写中文文档',
  '构建并发布'
]

提示容器

信息

补充背景和上下文。

建议

放置更顺手的做法。

注意

提醒容易忽略的边界条件。

风险

标出危险操作或生产环境影响。

折叠内容

查看备用部署思路

如果当前平台不方便部署，也可以先运行 npm run build，再把 dist 目录上传到任意静态文件托管服务。

代码分组

config.mts

import { defineConfig } from 'vitepress'

export default defineConfig({
  title: '拾光文档馆'
})

style.css

:root {
  --vp-c-brand-1: #0f766e;
}

表格

能力	用途	推荐场景
提示容器	强调重点	说明注意事项
代码分组	对比命令	多环境、多语言示例
折叠内容	收纳细节	长说明、备用方案
表格	快速比较	参数、能力、方案

写作建议

1. 先写读者要完成的目标。
2. 再写必要的命令和配置。
3. 最后补充原因、边界和排查办法。

好文档不是华丽辞藻，而是让人少走弯路。