VitePress @sugarat/theme

简约风的 VitePress 博客主题 示例运行项目。

GitHub Pages Demo

Usage

先安装 pnpm

npm i -g pnpm

安装依赖

pnpm install

开发启动

pnpm dev

构建

pnpm build

预览产物

pnpm serve

Github Pages 部署

① Github Pages 开启 Git Actions 部署支持

② 复制文件 .github/workflows/deploy.yml 到自己的项目相同目录下

示例项目已包含，可以直接进行下一步

③ 修改 docs/.vitepress/config.mts 里的构建配置

base 改为 "/仓库名/" 即可

// 省略无关代码
const base = '/vitepress-blog-sugar-template/'
export default defineConfig({
  base,
})

④ 推送 main 分支即可

需要进一步修改部署和构建配置，详见deploy.yml 文件。

Gitee Pages 部署

① 按照 SPA 要求添加 .spa 文件在docs/public 目录下

示例项目已包含，可以直接进行下一步

② 参照 Usage 部分构建代码

③ 推送构建后的页面资源到部署文档的分支

例如gh-pages

④ 参照文档选择分支和目录进行部署

Gitee Pages 需要实名才能使用，同时需要人工审核。