Skip to content

快速开始

本指南将帮助您快速开始使用本项目。

环境要求

  • Node.js 18 或更高版本
  • npm 或 pnpm

安装依赖

bash
npm install

启动开发服务器

bash
npm run docs:dev

访问 http://localhost:5173 查看文档站点。

构建生产版本

bash
npm run docs:build

构建产物将输出到 docs/.vitepress/dist 目录。

预览生产版本

bash
npm run docs:preview

添加新文档

  1. docs/ 目录下创建新的 .md 文件
  2. docs/.vitepress/config.js 中更新侧边栏配置

提示

VitePress 支持在 Markdown 中使用 Vue 组件,让您可以创建更丰富的交互式内容。

Released under the MIT License.