VuePress TemplateVuePress Template
指南
参考
GitHub
GitHub
指南
参考
GitHub
GitHub
  • 指南

    • 指南
    • 快速开始
    • 配置说明
    • Markdown 语法示例

配置说明

本项目的全部配置位于 .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/。

在 GitHub 上编辑此页
最后更新于: 2026/7/18 15:46
文档贡献者: chenzw, WorkBuddy
Prev
快速开始
Next
Markdown 语法示例

该应用可以安装在你的 PC 或移动设备上。这将使该 Web 应用程序外观和行为与其他应用程序相同。它将在出现在应用程序列表中,并可以固定到主屏幕,开始菜单或任务栏。此 Web 应用程序还将能够与其他应用程序和你的操作系统安全地进行交互。

详情