Skip to content

快速开始 ​

创建你的第一个页面 ​

VitePress 导航站的核心就是 Markdown 文件。每个 .md 文件自动变成一个页面。

1. 新建 Markdown 文件 ​

在 docs/guide/ 目录下新建一个文件,例如 my-page.md:

markdown
# 我的页面

这是页面内容。

2. 添加到侧边栏 ​

打开 docs/.vitepress/config.mts,在 sidebar 的对应分组中添加一行:

ts
{ text: '我的页面', link: '/guide/my-page' }

⚠️ 注意:link 不带 .md 后缀,路径以 / 开头。

3. 查看效果 ​

开发服务器会自动热更新,刷新浏览器即可看到新页面。

目录结构 ​

docs/
├── index.md              ← 首页
├── .vitepress/
│   └── config.mts        ← 站点配置
├── guide/
│   ├── getting-started.md
│   ├── configuration.md
│   └── deployment.md
└── reference/
    ├── markdown.md
    └── api.md

启动命令 ​

命令作用
npm run docs:dev启动开发服务器(热更新)
npm run docs:build构建静态站点到 docs/.vitepress/dist
npm run docs:preview本地预览构建产物

下一步 ​

基于 VitePress 构建