Skip to content

快速开始 ​

这是你站点的第一篇中文文档。所有内容都写在 docs/ 目录下的 Markdown 文件中。

目录约定 ​

text
/www/wwwroot/vitepress-docs
├── docs                 # 文档源文件
│   ├── .vitepress       # 站点配置与主题
│   ├── guide            # 指南分组
│   └── index.md         # 首页
├── node_modules
└── package.json

新增页面 ​

在 docs/ 下新建 .md 文件即可,例如 docs/guide/faq.md 对应访问路径 /guide/faq。

markdown
# 常见问题

正文内容……

页面间跳转 ​

使用相对链接引用其他文档:

markdown
[安装部署](./getting-started)

修改导航与侧边栏 ​

编辑 docs/.vitepress/config.mts 中的 themeConfig.nav 与 themeConfig.sidebar。

提示:改动 config.mts 或新增页面后,需要重新构建站点才会在线上生效。

基于 VitePress 构建