同步语雀文档

.github/workflows/deploy-docs.yml.bak → .github/workflows/build.yml

@@ -1,47 +1,44 @@
-
-name: 部署文档
+name: Build
 
 on:
-  push:
-    branches:
-      # 确保这是你正在使用的分支名称
-      - main
-
-permissions:
-  contents: write
+  workflow_call:
 
 jobs:
-  deploy-gh-pages:
+  build:
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout
-        uses: actions/checkout@v3
+      - name: 签出仓库
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
           # 如果你文档需要 Git 子模块，取消注释下一行
           # submodules: true
 
-
+      - name: 设置 pnpm
+        uses: pnpm/action-setup@v2
 
       - name: 设置 Node.js
         uses: actions/setup-node@v3
         with:
           node-version: 18
-          cache: npm
+          cache: pnpm
 
       - name: 安装依赖
-        run: npm ci
+        run: pnpm install
 
       - name: 构建文档
         env:
           NODE_OPTIONS: --max_old_space_size=8192
         run: |-
-          npm run docs:build
+          pnpm run docs:build
           > src/.vuepress/dist/.nojekyll
 
-      - name: 部署文档
-        uses: JamesIves/github-pages-deploy-action@v4
+      - name: 压缩构建文件
+        run: tar -cvf dist.tar src/.vuepress/dist
+
+      - name: 上传构建结果
+        uses: actions/upload-artifact@v3
         with:
-          # 这是文档部署到的分支名称
-          branch: gh-pages
-          folder: src/.vuepress/dist
+          name: build-result
+          path: |
+            dist.tar

.github/workflows/calibreapp-image-actions.yml

@@ -0,0 +1,28 @@
+name: Compress Images
+on:
+  workflow_call:
+  pull_request:
+    # Run Image Actions when JPG, JPEG, PNG or WebP files are added or changed.
+    # See https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#onpushpull_requestpaths for reference.
+    paths:
+      - "**/**.jpg"
+      - "**/**.jpeg"
+      - "**/**.png"
+      - "**/**.webp"
+
+jobs:
+  build:
+    # Only run on Pull Requests within the same repository, and not from forks.
+    if: github.event.pull_request.head.repo.full_name == github.repository
+    name: calibreapp/image-actions
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repo
+        uses: actions/checkout@v4
+
+      - name: Compress Images
+        uses: calibreapp/image-actions@main
+        with:
+          # The `GITHUB_TOKEN` is automatically generated by GitHub and scoped only to the repository that is currently running the action. By default, the action can’t update Pull Requests initiated from forked repositories.
+          # See https://docs.github.com/en/actions/reference/authentication-in-a-workflow and https://help.github.com/en/articles/virtual-environments-for-github-actions#token-permissions
+          githubToken: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/deploy-gh-pages.yml

@@ -0,0 +1,38 @@
+name: Deploy GitHub Pages
+
+on:
+  workflow_call:
+    secrets:
+      ACCESS_TOKEN:
+        required: true
+
+permissions:
+  contents: write
+
+jobs:
+  deploy-gh-pages:
+    runs-on: ubuntu-latest
+    steps:
+      - name: 签出仓库
+        uses: actions/checkout@v4
+
+      - name: 下载构建内容
+        uses: actions/download-artifact@v3
+        with:
+          name: build-result
+          # path: dist.tar
+
+      - name: 解压构建文件
+        run: tar -xvf dist.tar src/.vuepress/dist
+
+      - name: 列出构建内容目录结构
+        run: ls -R -a
+
+      - name: 部署到 GitHub
+        uses: JamesIves/github-pages-deploy-action@v4
+        with:
+          repository-name: zotero-chinese/zotero-chinese.github.io
+          branch: gh-pages
+          folder: src/.vuepress/dist
+          single-commit: true
+          token: ${{ secrets.ACCESS_TOKEN }}

.github/workflows/lint.yml

@@ -0,0 +1,17 @@
+name: Lint Markdown
+
+on:
+  workflow_call:
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: 签出仓库
+        uses: actions/checkout@v4
+      - name: 运行 MarkdownLint
+        uses: DavidAnson/markdownlint-cli2-action@v13
+        with:
+          globs: |
+            **/*.md
+            !test/*.md

.github/workflows/main.yml

@@ -0,0 +1,28 @@
+name: Main Action
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+permissions:
+  contents: write
+
+jobs:
+  lint:
+    uses: ./.github/workflows/lint.yml
+
+  build:
+    uses: ./.github/workflows/build.yml
+
+  deploy-gh-pages:
+    if: github.ref_name == 'main' && github.event_name == 'push' && github.repository == 'zotero-chinese/wiki'
+    needs:
+      - lint
+      - build
+    uses: ./.github/workflows/deploy-gh-pages.yml
+    secrets:
+      ACCESS_TOKEN: ${{ secrets.ACCESS_TOKEN }}

.gitignore

@@ -1,5 +1,9 @@
-
+.DS_Store
 node_modules/
-src/.vuepress/.cache/
-src/.vuepress/.temp/
-src/.vuepress/dist/
+package-lock.json
+# pnpm-lock.yaml
+
+**/.vuepress/.cache/
+**/.vuepress/.temp/
+**/.vuepress/dist/
+**/.obsidian

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npx lint-staged

.markdownlint.jsonc

@@ -0,0 +1,106 @@
+{
+  // 定义文档中涉及的专有名词
+  "MD044": {
+    "code_blocks": false,
+    "html_elements": false,
+    "names": [
+      "Zotero",
+      "JavaScript",
+      "GitHub",
+      "WebDAV",
+      "Android",
+      "iOS",
+      "macOS",
+      "WPS",
+      "Word",
+      "ZotFile",
+      "Zotero Chinese"
+    ]
+  },
+
+  // 兼容 Prettier
+  // @see https://github.com/DavidAnson/markdownlint/blob/main/doc/Prettier.md
+  "blanks-around-fences": false,
+  "blanks-around-headings": false,
+  "blanks-around-lists": false,
+  "code-fence-style": false,
+  "emphasis-style": false,
+  "heading-start-left": false,
+  "hr-style": false,
+  "line-length": false,
+  "list-indent": false,
+  "list-marker-space": false,
+  "no-blanks-blockquote": false,
+  "no-hard-tabs": false,
+  "no-missing-space-atx": false,
+  "no-missing-space-closed-atx": false,
+  "no-multiple-blanks": false,
+  "no-multiple-space-atx": false,
+  "no-multiple-space-blockquote": false,
+  "no-multiple-space-closed-atx": false,
+  "no-trailing-spaces": false,
+  "ol-prefix": false,
+  "strong-style": false,
+  "ul-indent": false,
+
+  // 其他规则配置
+  // @see https://github.com/vuepress-theme-hope/vuepress-theme-hope/blob/main/.markdownlint.json
+  "default": true,
+  "MD003": {
+    "style": "atx"
+  },
+  "MD004": {
+    "style": "dash"
+  },
+  "MD013": false,
+  "MD024": {
+    "allow_different_nesting": true
+  },
+  "MD025": {
+    "front_matter_title": ""
+  },
+  "MD033": {
+    "allowed_elements": [
+      "br",
+      "template",
+      "script",
+      "style",
+      "ArtPlayer",
+      "AudioPlayer",
+      "AutoCatalog",
+      "Badge",
+      "BiliBili",
+      "Catalog",
+      "CodePen",
+      "DemoProject",
+      "FontIcon",
+      "ProjectLink",
+      "PDF",
+      "Replit",
+      "Share",
+      "SiteInfo",
+      "StackBlitz",
+      "XiGua",
+      "VideoPlayer",
+      "YouTube",
+      "AppearanceSwitch",
+      "HopeIcon",
+      "FlowChartPlayground",
+      "IconDisplay",
+      "KatexPlayground",
+      "NetlifyBadge",
+      "PrintButton",
+      "ThemeColorPicker",
+      "ToggleFullScreenButton",
+      "ToggleRTLButton"
+    ]
+  },
+  // 兼容 Prettier 禁用
+  // "MD035": {
+  //   "style": "---"
+  // },
+  "MD036": false,
+  "MD040": false,
+  "MD046": false,
+  "MD049": false
+}

.prettierignore

@@ -0,0 +1,21 @@
+# Vuepress Cache
+**/.vuepress/.cache/**
+# Vuepress Temp
+**/.vuepress/.temp/**
+# Vuepress Output
+**/.vuepress/dist/**
+# Lib files
+**/.vuepress/public/assets/
+
+# Node modules
+node_modules/
+
+# Obsidian files
+**/.obsidian/**
+
+# NPM lock file
+pnpm-lock.yaml
+package-lock.json
+yarn.lock
+
+.husky/

.vscode/extensions.json

@@ -1,3 +1,7 @@
 {
-    "recommendations": ["davidanson.vscode-markdownlint"]
+  "recommendations": [
+    "esbenp.prettier-vscode",
+    "davidanson.vscode-markdownlint",
+    "yzhang.markdown-all-in-one"
+  ]
 }