Merge pull request #4 from Mister-Hope/main

docs: update docs
ZLMediaKit · Dec 5, 2023 · c4ffda3 · c4ffda3
2 parents a27e221 + 6e1a0cc
commit c4ffda3
Show file tree

Hide file tree

Showing 120 changed files with 11,494 additions and 15,724 deletions.
diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml
@@ -1,10 +1,8 @@
-
 name: 部署文档
 
 on:
   push:
     branches:
-      # 确保这是你正在使用的分支名称
       - main
 
 permissions:
@@ -15,33 +13,30 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
-          # 如果你文档需要 Git 子模块，取消注释下一行
-          # submodules: true
-
 
+      - name: 安装 pnpm
+        uses: pnpm/action-setup@v2
+        with:
+          run_install: true
 
       - name: 设置 Node.js
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
-          node-version: 18
-          cache: npm
-
-      - name: 安装依赖
-        run: npm ci
+          node-version: 20
+          cache: pnpm
 
       - name: 构建文档
         env:
           NODE_OPTIONS: --max_old_space_size=8192
         run: |-
-          npm run docs:build
+          pnpm 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/README.md b/README.md
@@ -1,2 +1,3 @@
-# docs
+# ZLMediaKit Docs
+
 Official documentation for ZLMediaKit