Skip to content

快速开始

从安装依赖到写下第一页,只需要几分钟。

环境准备

请先安装 Node.js 22 或更高版本,然后在项目根目录安装依赖:

bash
npm install

启动开发服务器

bash
npm run docs:dev

终端会显示本地访问地址。开发服务器支持热更新,修改 Markdown 后无需手动刷新。

新建页面

docs/ 下创建 Markdown 文件,文件路径会自动成为访问路径。例如:

text
docs/
├─ index.md
└─ guide/
   └─ getting-started.md

docs/guide/getting-started.md 对应 /guide/getting-started

构建站点

准备发布前运行:

bash
npm run docs:build

构建结果会生成在 docs/.vitepress/dist/

下一步

前往站点配置,把名称、导航和主题色换成你的内容。

用清晰的文字,连接想法与行动。