Add documentation for ECH (Encrypted Client Hello) support

.github/workflows/publish.yml

@@ -0,0 +1,43 @@
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      deployments: write
+    name: Publish to Cloudflare Pages
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - uses: actions/setup-python@v4
+        with:
+          python-version: 3.x
+
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
+
+      - uses: actions/cache@v3
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+
+      - run: |
+          pip install -r requirements.txt
+
+      - run: mkdocs build --verbose --clean --strict
+
+      - name: Publish to Cloudflare Pages
+        uses: cloudflare/pages-action@v1
+        with:
+          apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+          accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
+          projectName: hy2doc
+          directory: site
+          gitHubToken: ${{ secrets.GITHUB_TOKEN }}
+          branch: main

.gitignore

@@ -25,7 +25,6 @@
 # Icon must end with two \r
 Icon
 
-
 # Thumbnails
 ._*
 
@@ -94,4 +93,9 @@ $RECYCLE.BIN/
 # Windows shortcuts
 *.lnk
 
-# End of https://www.toptal.com/developers/gitignore/api/windows,linux,macos,visualstudiocode
+# End of https://www.toptal.com/developers/gitignore/api/windows,linux,macos,visualstudiocode
+
+site/
+assistant/
+
+.venv/

LICENSE.md

@@ -0,0 +1,7 @@
+Copyright 2023 Toby
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,13 @@
+# Hysteria 2 documentation website
+
+This is the source code repository for the [Hysteria 2 documentation website](https://v2.hysteria.network/).
+
+It's built with [MkDocs Material](https://squidfunk.github.io/mkdocs-material/). To get started:
+
+```bash
+pip install mkdocs-material
+pip install mkdocs-static-i18n
+pip install mkdocs-glightbox
+
+mkdocs serve
+```

assistant.py

@@ -0,0 +1,52 @@
+"""
+This is a script to create knowledge files for OpenAI GPT assistants.
+They currently have a pretty strict file count limit, so we need to merge all files in each section into one file.
+"""
+
+import os
+import shutil
+
+DOCS_PATH = "docs"
+GENERATED_PATH = "assistant"
+
+
+def generate(root_path):
+    os.makedirs(GENERATED_PATH, exist_ok=True)
+
+    for root, dirs, files in os.walk(root_path):
+        if root == root_path:
+            # Root directory is a special case, handled below
+            continue
+
+        content_lang_map = {}
+
+        for file in files:
+            if file.endswith(".md"):
+                # Determine the language variant
+                parts = file.split(".")
+                language = parts[-2] if len(parts) > 2 else "en"
+
+                with open(os.path.join(root, file), "r", encoding="utf-8") as f:
+                    content = f.read()
+
+                if language not in content_lang_map:
+                    content_lang_map[language] = []
+                content_lang_map[language].append(f"== {file} ==\n\n{content}")
+
+        # Write the combined content to new files
+        for language, contents in content_lang_map.items():
+            combined_filename = f"{os.path.basename(root)}.{language}.md"
+            with open(
+                os.path.join(GENERATED_PATH, combined_filename), "w", encoding="utf-8"
+            ) as f:
+                f.write("\n\n".join(contents))
+
+    # Handle files in the root directory
+    for file in os.listdir(root_path):
+        file_path = os.path.join(root_path, file)
+        if os.path.isfile(file_path) and file.endswith(".md"):
+            shutil.copy(file_path, GENERATED_PATH)
+
+
+if __name__ == "__main__":
+    generate(DOCS_PATH)

docs/docs/Artworks.md

@@ -0,0 +1,37 @@
+---
+title: Artworks
+hide:
+  - navigation
+  - toc
+---
+
+## ✨ Meet Ayaha Hideri, the official anime mascot of Hysteria ⚡️
+
+<div class="spcard">
+    <img class="skip-lightbox" src="/assets/artworks/stickerpack.png" alt="Sticker pack">
+    <div class="spcard-content">
+        <p class="spcard-title">Our official sticker pack just dropped!</p>
+        <p class="spcard-text">Ayaha Hideri is not only here to help you bypass firewalls, but also to bring some major cute vibes to your chat.</p>
+        <div class="spbutton-container">
+            <a class="spbutton" href="https://t.me/addstickers/Hideri1CN">Telegram CN</a>
+            <a class="spbutton" href="https://t.me/addstickers/Hideri1NT">Telegram No Text</a>
+            <a class="spbutton" href="https://signal.art/addstickers/#pack_id=78143270530d3bef35ea1f52869ddc12&pack_key=f1c16e15139224306d19cf1db5c0b2a4867c802984bde12500434b0680db4c6f">Signal CN</a>
+            <a class="spbutton" href="https://signal.art/addstickers/#pack_id=47002595b4e5b320f52cdb166c18d324&pack_key=4db2065027244eebe81f1e8d437d6c9fa9813c1d6b27ce3a16b5c30c450a7377">Signal No Text</a>
+            <a class="spbutton" href="https://github.com/apernet/hysteria-hideri-stickers">Source</a>
+        </div>
+    </div>
+</div>
+
+### Official artworks
+
+<div class="artworks-gal">
+    <img src="/assets/artworks/hc_name.png">
+    <img src="/assets/artworks/hc_q.png">
+    <img src="/assets/artworks/ebiblue.png">
+</div>
+
+### Fan artworks
+
+<div class="artworks-gal">
+    <img src="/assets/artworks/tonyzhang.png">
+</div>

docs/docs/Artworks.zh.md

@@ -0,0 +1,37 @@
+---
+title: 艺术创作
+hide:
+  - navigation
+  - toc
+---
+
+## ✨ 彩羽ひでり - Hysteria 官方形象 ⚡️
+
+<div class="spcard">
+    <img class="skip-lightbox" src="/assets/artworks/stickerpack.png" alt="Sticker pack">
+    <div class="spcard-content">
+        <p class="spcard-title">表情包第一弹来袭！</p>
+        <p class="spcard-text">彩羽ひでり能带你飞越长城，也能为聊天增添可爱。</p>
+        <div class="spbutton-container">
+            <a class="spbutton" href="https://t.me/addstickers/Hideri1CN">Telegram 中文版</a>
+            <a class="spbutton" href="https://t.me/addstickers/Hideri1NT">Telegram 无字版</a>
+            <a class="spbutton" href="https://signal.art/addstickers/#pack_id=78143270530d3bef35ea1f52869ddc12&pack_key=f1c16e15139224306d19cf1db5c0b2a4867c802984bde12500434b0680db4c6f">Signal 中文版</a>
+            <a class="spbutton" href="https://signal.art/addstickers/#pack_id=47002595b4e5b320f52cdb166c18d324&pack_key=4db2065027244eebe81f1e8d437d6c9fa9813c1d6b27ce3a16b5c30c450a7377">Signal 无字版</a>
+            <a class="spbutton" href="https://github.com/apernet/hysteria-hideri-stickers">图片文件</a>
+        </div>
+    </div>
+</div>
+
+### 官方作品
+
+<div class="artworks-gal">
+    <img src="/assets/artworks/hc_name.png">
+    <img src="/assets/artworks/hc_q.png">
+    <img src="/assets/artworks/ebiblue.png">
+</div>
+
+### 同人作品
+
+<div class="artworks-gal">
+    <img src="/assets/artworks/tonyzhang.png">
+</div>