Bläddra i källkod

Initial zh-CN document translation

世界 3 år sedan
förälder
incheckning
2008fb552a
5 ändrade filer med 105 tillägg och 5 borttagningar
  1. 1 1
      .github/workflows/mkdocs.yml
  2. 3 3
      docs/index.md
  3. 55 0
      docs/index.zh.md
  4. 8 0
      docs/support.zh.md
  5. 38 1
      mkdocs.yml

+ 1 - 1
.github/workflows/mkdocs.yml

@@ -14,5 +14,5 @@ jobs:
       - uses: actions/setup-python@v2
         with:
           python-version: 3.x
-      - run: pip install mkdocs-material
+      - run: pip install mkdocs-material mkdocs-static-i18n
       - run: mkdocs gh-deploy -m "{sha}" --force --ignore-version --no-history

+ 3 - 3
docs/index.md

@@ -24,10 +24,10 @@ go install -v -tags with_clash_api github.com/sagernet/sing-box/cmd/sing-box@lat
 | `with_grpc`                        | Build with gRPC support, see [V2Ray Transport#gRPC](/configuration/shared/v2ray-transport#grpc).                                                                                                                                                           |
 | `with_wireguard`                   | Build with WireGuard support, see [WireGuard outbound](./configuration/outbound/wireguard).                                                                                                                                                                |
 | `with_acme`                        | Build with ACME TLS certificate issuer support, see [TLS](./configuration/shared/tls).                                                                                                                                                                     |
-| `with_clash_api`                   | Build with Clash api support, see [Experimental](./configuration/experimental#clash-api-fields).                                                                                                                                                           |
-| `no_gvisor`                        | Build without gVisor tun stack support, see [Tun inbound](./configuration/inbound/tun#stack).                                                                                                                                                              |
+| `with_clash_api`                   | Build with Clash API support, see [Experimental](./configuration/experimental#clash-api-fields).                                                                                                                                                           |
+| `no_gvisor`                        | Build without gVisor Tun stack support, see [Tun inbound](./configuration/inbound/tun#stack).                                                                                                                                                              |
 | `with_embedded_tor` (CGO required) | Build with embedded Tor support, see [Tor outbound](./configuration/outbound/tor).                                                                                                                                                                         |
-| `with_lwip` (CGO required)         | Build with LWIP tun stack support, see [Tun inbound](./configuration/inbound/tun#stack).                                                                                                                                                                   |
+| `with_lwip` (CGO required)         | Build with LWIP Tun stack support, see [Tun inbound](./configuration/inbound/tun#stack).                                                                                                                                                                   |
 
 The binary is built under $GOPATH/bin
 

+ 55 - 0
docs/index.zh.md

@@ -0,0 +1,55 @@
+# 开始
+
+欢迎来到该 sing-box 项目的文档页。
+
+通用代理平台。
+
+## 安装
+
+sing-box 需要 Golang **1.18.5** 或更高版本.
+
+```bash
+go install -v github.com/sagernet/sing-box/cmd/sing-box@latest
+```
+
+自定义安装:
+
+```bash
+go install -v -tags with_clash_api github.com/sagernet/sing-box/cmd/sing-box@latest
+```
+
+| 构建标志                         | 描述                                                                                                                                                                                                                |
+|------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `with_quic`                  | 启用 QUIC 支持, 查看 [QUIC 和 HTTP3 DNS 传输层](./configuration/dns/server), [Naive 入站](./configuration/inbound/naive), [Hysteria 入站](./configuration/inbound/hysteria) 和 [Hysteria 出站](./configuration/outbound/hysteria). |
+| `with_grpc`                  | 启用 gRPC 之后, 查看 [V2Ray 传输层#gRPC](/configuration/shared/v2ray-transport#grpc).                                                                                                                                      |
+| `with_wireguard`             | 启用 WireGuard 支持, 查看 [WireGuard 出站](./configuration/outbound/wireguard).                                                                                                                                           |
+| `with_acme`                  | 启用 ACME TLS 证书签发支持, 查看 [TLS](./configuration/shared/tls).                                                                                                                                                         |
+| `with_clash_api`             | 启用 Clash api 支持, 查看 [实验性](./configuration/experimental#clash-api-fields).                                                                                                                                         |
+| `no_gvisor`                  | 禁用 gVisor Tun 栈支持, 查看 [Tun 入站](./configuration/inbound/tun#stack).                                                                                                                                                |
+| `with_embedded_tor` (需要 CGO) | 启用 嵌入式 Tor 支持, 查看 [Tor 出站](./configuration/outbound/tor).                                                                                                                                                         |
+| `with_lwip` (需要 CGO)         | 启用 LWIP Tun 栈支持, 查看 [Tun 入站](./configuration/inbound/tun#stack).                                                                                                                                                  |
+
+二进制文件将被构建在 `$GOPATH/bin` 下
+
+```bash
+sing-box version
+```
+
+同时推荐使用 Systemd 来管理 sing-box 服务器实例.
+查看 [Linux 服务器安装示例](./examples/linux-server-installation).
+
+## 贡献者
+
+[![](https://opencollective.com/sagernet/contributors.svg?width=740&button=false)](https://github.com/sagernet/sing-box/graphs/contributors)
+
+## 授权
+
+```
+版权所有 (C) 2022 by nekohasekai <[email protected]>
+
+该程序是免费软件:您可以重新分发和 / 或修改根据 GNU 通用公共许可证的条款,由自由软件基金会,许可证的第 3 版,或(由您选择)任何更高版本。
+
+分发这个程序是希望它有用,但没有任何保证; 甚至没有暗示的保证适销性或特定用途的适用性。 见 GNU 通用公共许可证以获取更多详细信息。
+
+您应该已经收到一份 GNU 通用公共许可证的副本连同这个程序。 如果没有,请参阅 <http://www.gnu.org/licenses/>。
+```

+ 8 - 0
docs/support.zh.md

@@ -0,0 +1,8 @@
+#### Github
+
+工单: [Issues · SagerNet/sing-box](https://github.com/SagerNet/sing-box/issues)
+
+#### Telegram
+
+通知频道: [@yapnc](https://t.me/yapnc)  
+用户组: [@yapug](https://t.me/yapug)

+ 38 - 1
mkdocs.yml

@@ -22,7 +22,7 @@ theme:
         icon: material/brightness-4
         name: Switch to light mode
   features:
-    - navigation.instant
+    #    - navigation.instant
     - navigation.tracking
     - navigation.tabs
     - navigation.indexes
@@ -118,3 +118,40 @@ extra:
     - icon: fontawesome/brands/github
       link: https://github.com/SagerNet/sing-box
   generator: false
+plugins:
+  - i18n:
+      default_language: en
+      languages:
+        en:
+          name: English
+          build: false
+        zh:
+          name: 简体中文
+      material_alternate: true
+      nav_translations:
+        zh:
+          Getting Started: 开始
+          Features: 特性
+          Support: 支持
+          Change Log: 更新日志
+          Configuration: 配置
+          Log: 日志
+          DNS Server: DNS 服务器
+          DNS Rule: DNS 规则
+          Inbound: 入站
+          Outbound: 出站
+          Route: 路由
+          Route Rule: 路由规则
+          Protocol Sniff: 协议探测
+          Experimental: 实验性功能
+          Shared: 通用
+          Multiple: 多路复用
+          V2Ray Transport: V2Ray 传输层
+          FAQ: 常见问题
+          Known Issues: 已知问题
+          Examples: 示例
+          Linux Server Installation: Linux 服务器安装
+          Shadowsocks Server: Shadowsocks 服务器
+          Shadowsocks Client: Shadowsocks 客户端
+          Shadowsocks Tun: Shadowsocks Tun
+          DNS Hijack: DNS 劫持