@sugarat/create-theme 0.0.46 → 0.0.48

package/dist/template/.github/workflows/deploy.yml

@@ -0,0 +1,95 @@
+name: Deploy Pages
+
+# 触发条件，push到main分支或者pull request到main分支
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+  # 支持手动在工作流上触发
+  workflow_dispatch:
+
+# 设置时区
+env:
+  TZ: Asia/Shanghai
+
+# 权限设置
+permissions:
+  # 允许读取仓库内容的权限。
+  contents: read
+  # 允许写入 GitHub Pages 的权限。
+  pages: write
+  # 允许写入 id-token 的权限。
+  id-token: write
+
+# 并发控制配置
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+# 定义执行任务
+jobs:
+  # 构建任务
+  build:
+
+    runs-on: ubuntu-latest
+
+    # node v20 运行
+    strategy:
+      matrix:
+        node-version: [20]
+
+    steps:
+      # 拉取代码
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          # 保留 Git 信息
+          fetch-depth: 0
+
+      # 设置使用 Node.js 版本
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+
+      # 使用 PNPM V8
+      - uses: pnpm/action-setup@v2
+        name: Install pnpm
+        with:
+          version: 8
+          run_install: false
+
+        # 安装依赖
+      - name: Install dependencies
+        run: pnpm install --frozen-lockfile
+
+        # 构建项目
+      - name: Build blog project
+        run: |
+          echo ${{ github.workspace }}
+          pnpm build
+
+        # 资源拷贝
+      - name: Build with Jekyll
+        uses: actions/jekyll-build-pages@v1
+        with:
+          source: ./docs/.vitepress/dist
+          destination: ./_site
+
+        # 上传 _site 的资源，用于后续部署
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+
+  # 部署任务
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

package/dist/template/README.md

@@ -1,7 +1,15 @@
-# vitepress @sugarat/theme
-简约风的 [Vitepress 博客主题](https://theme.sugarat.top)
+<h1 align="center"> VitePress @sugarat/theme </h1>
+
+<p align="center">
+简约风的 <a href="https://theme.sugarat.top"  target="_blank"target="_blank">VitePress 博客主题</a> 示例运行项目。
+</p>
+
+<p align="center">
+    <a href="https://atqq.github.io/vitepress-blog-sugar-template/" target="_blank">GitHub Pages Demo</a>
+</p>
 
 ## Usage
+
 先安装 `pnpm`
 
 ```sh
@@ -9,21 +17,67 @@ npm i -g pnpm
 ```
 
 安装依赖
+
 ```sh
 pnpm install
 ```
 
 开发启动
+
 ```sh
 pnpm dev
 ```
 
 构建
+
 ```sh
 pnpm build
 ```
 
 预览产物
+
 ```sh
 pnpm serve
-```
+```
+
+## Github Pages 部署
+
+① Github Pages 开启 Git Actions 部署支持
+
+![](https://img.cdn.sugarat.top/mdImg/sugar/8a2454c628d0e2abcc7a0451ddd7d2dc)
+
+② 复制文件 `.github/workflows/deploy.yml` 到自己的项目相同目录下
+
+示例项目已包含，可以直接进行下一步
+
+③ 修改 `docs/.vitepress/config.mts` 里的构建配置
+
+`base` 改为 `"/仓库名/"` 即可
+
+```ts
+// 省略无关代码
+const base = '/vitepress-blog-sugar-template/'
+export default defineConfig({
+  base,
+})
+```
+
+④ 推送 `main` 分支即可
+
+需要进一步修改部署和构建配置，详见`deploy.yml` 文件。
+
+## Gitee Pages 部署
+
+① 按照 [SPA](https://help.gitee.com/services/gitee-pages/spa-support) 要求添加 `.spa` 文件在`docs/public` 目录下
+
+示例项目已包含，可以直接进行下一步
+
+② 参照 `Usage` 部分构建代码
+
+③ 推送构建后的页面资源到部署文档的分支
+
+例如`gh-pages`
+
+④ 参照[文档](https://help.gitee.com/services/gitee-pages/intro)选择分支和目录进行部署
+
+*Gitee Pages 需要实名才能使用，同时需要人工审核。*

package/dist/template/docs/.vitepress/blog-theme.ts

@@ -27,6 +27,7 @@ const blogTheme = getThemeConfig({
 
   // 页脚
   footer: {
+    // message 字段支持配置为HTML内容，配置多条可以配置为数组
     // message: '下面 的内容和图标都是可以修改的噢（当然本条内容也是可以隐藏的）',
     copyright: 'MIT License | 粥里有勺糖',
     // icpRecord: {

package/dist/template/docs/.vitepress/config.mts

@@ -3,11 +3,18 @@ import { defineConfig } from 'vitepress'
 // 导入主题的配置
 import { blogTheme } from './blog-theme'
 
+// 如果使用 GitHub/Gitee Pages 等公共平台部署
+// 通常需要修改 base 路径，通常为“/仓库名/”
+// const base = process.env.GITHUB_ACTIONS === 'true'
+//   ? '/vitepress-blog-sugar-template/'
+//   : '/'
+
 // Vitepress 默认配置
 // 详见文档：https://vitepress.dev/reference/site-config
 export default defineConfig({
   // 继承博客主题(@sugarat/theme)
   extends: blogTheme,
+  // base,
   lang: 'zh-cn',
   title: '@sugarat/theme',
   description: '粥里有勺糖的博客主题，基于 vitepress 实现',
@@ -15,6 +22,7 @@ export default defineConfig({
   // 详见：https://vitepress.dev/zh/reference/site-config#head
   head: [
     // 配置网站的图标（显示在浏览器的 tab 上）
+    // ['link', { rel: 'icon', href: `${base}favicon.ico` }], // 修改了 base 这里也需要同步修改
     ['link', { rel: 'icon', href: '/favicon.ico' }]
   ],
   themeConfig: {

package/dist/template/package.json

@@ -11,9 +11,9 @@
   },
   "dependencies": {
     "@element-plus/icons-vue": "^2.3.1",
-    "@sugarat/theme": "^0.2.24",
+    "@sugarat/theme": "^0.2.25",
     "element-plus": "^2.5.3",
-    "vue": "3.4.15"
+    "vue": "3.4.21"
   },
   "directories": {
     "doc": "docs"
@@ -21,6 +21,6 @@
   "devDependencies": {
     "sass": "^1.64.1",
     "typescript": "^5.1.6",
-    "vitepress": "1.0.0-rc.40"
+    "vitepress": "1.0.0-rc.45"
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sugarat/create-theme",
-  "version": "0.0.46",
+  "version": "0.0.48",
   "description": "简约风的 Vitepress 博客主题，sugarat vitepress blog theme",
   "author": "粥里有勺糖",
   "license": "MIT",