Break: Rework documents, migrate to VuePress.

Signed-off-by: 秋雨落 <[email protected]>
SinoCraftProject · Dec 7, 2024 · b5a5f09 · b5a5f09
1 parent b175d5c
commit b5a5f09
Show file tree

Hide file tree

Showing 51 changed files with 4,521 additions and 178 deletions.
diff --git a/.github/workflows/build-documents.yml b/.github/workflows/build-documents.yml
diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml
@@ -0,0 +1,50 @@
+
+name: 部署文档
+
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: write
+
+jobs:
+  deploy-gh-pages:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          # 如果你文档需要 Git 子模块，取消注释下一行
+          # submodules: true
+
+      - name: 设置 pnpm
+        uses: pnpm/action-setup@v4
+
+
+      - name: 设置 Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          cache: pnpm
+
+      - name: 安装依赖
+        run: |
+          corepack enable
+          pnpm install --frozen-lockfile
+
+      - name: 构建文档
+        env:
+          NODE_OPTIONS: --max_old_space_size=8192
+        run: |-
+          pnpm run docs:build
+          > src/.vuepress/dist/.nojekyll
+
+      - name: 部署文档
+        uses: JamesIves/github-pages-deploy-action@v4
+        with:
+          # 部署文档
+          branch: gh-pages
+          folder: src/.vuepress/dist
diff --git a/.gitignore b/.gitignore
@@ -1 +1,5 @@
 .idea/
+node_modules/
+src/.vuepress/.cache/
+src/.vuepress/.temp/
+src/.vuepress/dist/
diff --git a/Documents/c.list b/Documents/c.list
diff --git a/Documents/documents.tree b/Documents/documents.tree
diff --git a/Documents/images/.gitkeep b/Documents/images/.gitkeep
diff --git a/Documents/redirection-rules.xml b/Documents/redirection-rules.xml
diff --git a/Documents/topics/dev-sc.md b/Documents/topics/dev-sc.md
diff --git a/Documents/topics/playing.md b/Documents/topics/playing.md
diff --git a/Documents/topics/starter.md b/Documents/topics/starter.md
diff --git a/Documents/v.list b/Documents/v.list
diff --git a/Documents/writerside.cfg b/Documents/writerside.cfg
diff --git a/package.json b/package.json
@@ -0,0 +1,20 @@
+{
+  "name": "sinocraft-docs",
+  "description": "The official document of SinoCraft Project",
+  "version": "1.0.0",
+  "license": "ARR",
+  "type": "module",
+  "scripts": {
+    "docs:build": "vuepress-vite build src",
+    "docs:clean-dev": "vuepress-vite dev src --clean-cache",
+    "docs:dev": "vuepress-vite dev src",
+    "docs:update-package": "pnpm dlx vp-update"
+  },
+  "devDependencies": {
+    "@vuepress/bundler-vite": "2.0.0-rc.18",
+    "sass-embedded": "^1.82.0",
+    "vue": "^3.5.13",
+    "vuepress": "2.0.0-rc.18",
+    "vuepress-theme-hope": "2.0.0-rc.61"
+  }
+}