Initial commit

Itsusinn · Itsusinn · commit 7f032523f6c7 · 2025-02-25T19:49:10.000+08:00
diff --git a/.github/email-blacklist.txt b/.github/email-blacklist.txt
@@ -0,0 +1,9 @@
+*@qq.com
+*@foxmail.com
+*@126.com
+*@163.com
+*@sina.com
+MX-RECORD,mxbiz1.qq.com
+MX-RECORD,mx1.qiye.aliyun.com
+MX-RECORD,mx.ym.163.com
+MX-RECORD,mx.huaweicloud.com
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
@@ -23,15 +23,17 @@ jobs:
     - run: |
         pip install -r requirements.txt
         mkdocs build
+        mkdir sites
+        mv site sites/clash
       env:
         GOOGLE_ANALYTICS_KEY: ${{ secrets.GOOGLE_ANALYTICS_KEY }}
 
     - name: Deploy
       uses: peaceiris/actions-gh-pages@v3
       with:
         github_token: ${{ secrets.GITHUB_TOKEN }}
-        publish_dir: site
-        # cname: clash.watfaq.com
+        publish_dir: sites
+        cname: docs.watfaq.com
         force_orphan: true
         user_name: github-actions[bot]
         user_email: github-actions[bot]@users.noreply.github.com
diff --git a/.github/workflows/email-check.yml b/.github/workflows/email-check.yml
@@ -0,0 +1,89 @@
+name: Commit Email Check
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened]
+
+jobs:
+  validate:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      pull-requests: write
+      issues: write
+    steps:
+      - name: Checkout PR branch
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Extract commit emails
+        run: |
+          BASE_SHA=${{ github.event.pull_request.base.sha }}
+          HEAD_SHA=${{ github.event.pull_request.head.sha }}
+          git log --format='%ae' $BASE_SHA..$HEAD_SHA | sort -u > commit-emails.txt
+
+      - uses: taiki-e/install-action@v2
+        with:
+          tool: check-commits-email
+
+      - name: Run validation
+        id: check
+        run: |
+          check-commits-email \
+            --rules .github/email-blacklist.txt \
+            --emails commit-emails.txt \
+            --output github >> $GITHUB_OUTPUT
+
+      - name: Find Comment
+        uses: peter-evans/find-comment@v3
+        id: find-comment
+        with:
+          issue-number: ${{ github.event.pull_request.number }}
+          comment-author: 'github-actions[bot]'
+          body-includes: Violation of email address detected
+
+      - name: Post comment
+        if: steps.check.outputs.violations != ''
+        uses: peter-evans/create-or-update-comment@v4
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          issue-number: ${{ github.event.pull_request.number }}
+          comment-id: ${{ steps.find-comment.outputs.comment-id }}
+          edit-mode: replace
+          body: |
+            ### ⚠️ Violation of email address detected
+            The following email(s) match the blacklist rule:
+
+            ${{ steps.check.outputs.violations }}
+
+            <details>
+            
+            <summary>Correction steps</summary>
+            
+            1. Modifying author information using interactive rebase
+            ```bash
+            git rebase -i HEAD~${{ github.event.pull_request.commits }}
+            # Mark the commit that needs to be modified as edit
+            ```
+
+            2. For each marked commit, execute:
+            ```bash
+            git commit --amend --author="username <other-email.com>"
+            git rebase --continue
+            ```
+
+            3. Force push update branch
+            ```bash
+            git push --force-with-lease
+            ```
+            
+            </details>
+
+      - name: Delete comment
+        if: ${{ steps.find-comment.outputs.comment-id != '' && steps.check.outputs.violations == '' }}
+        uses: detomarco/delete-comment@main
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          comment-id: ${{ steps.find-comment.outputs.comment-id }}
+
diff --git a/docs/index.md b/docs/index.md
@@ -1,7 +1,7 @@
 ---
 hide:
-  - navigation
   - toc
+  - navigation
 ---
 # 👋Welcome to ClashRS User Manual
 
@@ -21,18 +21,3 @@ ClashRS is a network proxy software that you can use to control how you want to
 - ⚙️ Shadowsocks/Trojan/Vmess outbound support with different underlying trasports.
 - 🌍 Dynamic remote rule/proxy loader.
 - 🎵 Tracing with Jaeger
-
-
-
-##  Links
-
-- Repository - https://github.com/Watfaq/clash-rs
-- Download - https://github.com/Watfaq/clash-rs/releases
-
-## Get Started
-
-We've put together some helpful guides for you to get setup with our product quickly and easily.
-
-[⌨️Getting set up](quick-start/index.md)
-
-[🔨Configuration](config/index.md)
diff --git a/docs/index.zh.md b/docs/index.zh.md
@@ -1,8 +1,9 @@
 ---
 hide:
-  - navigation
   - toc
+  - navigation
 ---
+
 # 👋Welcome to ClashRS User Manual
 
 
@@ -33,6 +34,6 @@ ClashRS is a network proxy software that you can use to control how you want to
 
 We've put together some helpful guides for you to get setup with our product quickly and easily.
 
-[⌨️Getting set up](quick-start/index.md)
+[⌨️Getting set up](./quick-start/index.md)
 
-[🔨Configuration](config/index.md)
+[🔨Configuration](../config/index.md)
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -1,16 +1,16 @@
 site_name: ClashRS User Mannual
 docs_dir: docs
-site_url: https://clash.watfaq.com
+site_url: https://docs.watfaq.com/clash/
 repo_url: https://github.com/Watfaq/clash-rs
-edit_uri: "https://github.com/Watfaq/docs/blob/master/docs/"
+edit_uri: https://github.com/Watfaq/docs/blob/master/docs/
 repo_name: clash-rs
 
 theme:
   name: material
   features:
     - search.highlight
     - navigation.tracking
-    - navigation.instant
+    # - navigation.instant
     # - navigation.expand
     - navigation.path
     - navigation.indexes
@@ -21,7 +21,25 @@ theme:
     - content.action.edit
     - content.code.copy
     - content.code.select
-
+  palette:
+    - media: "(prefers-color-scheme)"
+      toggle:
+        icon: material/link
+        name: Switch to light mode
+    - media: "(prefers-color-scheme: light)"
+      scheme: default
+      primary: indigo
+      accent: indigo
+      toggle:
+        icon: material/toggle-switch
+        name: Switch to dark mode
+    - media: "(prefers-color-scheme: dark)"
+      scheme: slate
+      primary: black
+      accent: indigo
+      toggle:
+        icon: material/toggle-switch-off
+        name: Switch to system preference
 # https://facelessuser.github.io/pymdown-extensions/
 markdown_extensions:
   - pymdownx.superfences
@@ -37,8 +55,7 @@ markdown_extensions:
   - pymdownx.snippets
 
 nav:
-    - Welcome:
-      - index.md
+    - Welcome: index.md
     - Quick start: 
       - quick-start/index.md
       - CLI: quick-start/cli.md
@@ -48,10 +65,8 @@ nav:
       - Full Example: config/full.md
 
 plugins:
-  - search
+  # - search
   # - awesome-pages
-  - minify:
-      minify_html: true
   - i18n:
       docs_structure: suffix
       fallback_to_default: true
@@ -62,6 +77,7 @@ plugins:
           default: true
           locale: en
           name: English
+          site_name: "ClashRS User Mannual"
         - build: true
           default: false
           locale: zh
