VuePress Template
一个开箱即用的 VuePress 2 文档模板
模块化配置
navbar / sidebar / plugins 拆分为独立文件，告别巨型 config，易于维护与复用。
官方插件全家桶
全文搜索、代码高亮、图片缩放、返回顶部、Git 信息等常用能力开箱即用。
PWA 离线可安装
自动生成 manifest 与 service worker，支持离线访问与「安装到桌面」。
GA4 流量统计
内置 Google Analytics 插件，配置 GA_ID 即启用，未配置不影响构建。
Algolia DocSearch
可选接入 Algolia 全文检索，配置 DOCSEARCH_* 即启用，与内置搜索智能二选一。
示例文档齐全
内置 Markdown 语法速查与「如何编写 VuePress 插件」范例，开箱即学。
最佳实践目录结构
清晰的目录约定与样式变量覆盖，复制本项目即可生成新的文档站。
快速上手
# 安装依赖（推荐使用 pnpm）
pnpm install
# 启动开发服务器
pnpm dev
# 构建静态站点
pnpm build提示
本模板基于 VuePress 2（Vue 3 技术栈），所有配置使用 TypeScript 编写。
部署到 Cloudflare Pages
仓库已内置 GitHub Actions 工作流 .github/workflows/deploy.yml：推送到 main 自动生产部署，PR 自动预览部署。
1. 在 Cloudflare 创建 Pages 项目
- 登录 Cloudflare 控制台 → Workers & Pages → 创建 Pages 项目，连接方式选「Direct Upload」（直接上传），项目名自定义（工作流中默认为
vuepress-template）。 - 进入项目设置，将 Production branch 设为
main。
2. 配置 GitHub Secrets
在仓库 Settings → Secrets and variables → Actions 中添加：
| Secret 名称 | 说明 |
|---|---|
CLOUDFLARE_API_TOKEN | 具备 Cloudflare Pages: Edit 权限的 API Token |
CLOUDFLARE_ACCOUNT_ID | Cloudflare 账户 ID（控制台右下角） |
3. 推送即部署
git push origin main # 生产部署
# 或发起 PR # 预览部署（PR 评论区会自动给出预览地址）若你的 Pages 项目名不是
vuepress-template，请修改工作流中的projectName。 如需 DocSearch / GA，请在「Settings → Secrets」中补充DOCSEARCH_*/GA_ID等变量，并在对应步骤注入到构建环境（参考.vuepress/configs/plugins.ts的读取逻辑）。