快速开始

本章面向第一次使用 @ruan-cat/vitepress-preset-config 的 VitePress 项目。完成后，你会拥有带 Teek 主题、自动侧边栏和本地搜索的文档站。

阅读顺序

1. 安装与最小站点：安装依赖、创建目录并运行文档站。
2. 配置：根据仓库地址、导航和文档结构继续调整。
3. 功能：按需使用 Demo、Mermaid 或 Twoslash。

开始前确认

• 项目使用 vitepress@^1.6 与 vue@^3.5。
• 项目使用 pnpm，并允许在文档项目中安装开发依赖。
• 文档源目录以 docs/ 为例；如果使用其他目录，请同步调整 VitePress 命令和 documentRootPath。

贡献者

ruan-cat

页面历史

最后编辑于 12 天前

查看完整历史

5b206a9-📃 docs(vitepress): 重构包使用者文档路径