配置说明
本项目的全部配置位于 .vuepress/ 目录,采用模块化拆分:
.vuepress/
├── client.ts # 客户端增强(全局组件、路由钩子等)
├── config.ts # 主配置入口
├── configs/
│ ├── navbar.ts # 顶部导航
│ ├── sidebar.ts # 侧边栏
│ └── plugins.ts # 插件集合
├── components/ # 自动注册的全局组件
├── public/ # 静态资源(favicon、图片等)
└── styles/
├── palette.scss # 主题变量(品牌色等)
└── index.scss # 全局样式覆盖常用修改点
| 你想做的事 | 修改位置 |
|---|---|
| 改站点标题 / 描述 | .vuepress/config.ts 的 title / description |
| 改导航栏 | .vuepress/configs/navbar.ts |
| 改侧边栏 | .vuepress/configs/sidebar.ts |
| 增删插件 | .vuepress/configs/plugins.ts |
| 改品牌色 | .vuepress/styles/palette.scss |
| 部署到子路径 | config.ts 的 base |
启用编辑链接
在 config.ts 中填写仓库信息,并将 editLink 改为 true:
defaultTheme({
repo: 'your-name/your-repo',
docsRepo: 'your-name/your-repo',
docsDir: '.',
docsBranch: 'main',
editLink: true,
})部署
构建产物在 .vuepress/dist,可直接托管到任意静态服务器(Nginx、GitHub Pages、Vercel、对象存储等)。
部署到子路径时(如 https://example.com/docs/),请将 base 设为 /docs/。