From 123c383eaed40662e0815f4bf8564e2ca3bf2e9a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E4=B8=96=E7=95=8C?= Date: Sat, 18 Feb 2023 19:27:22 +0800 Subject: [PATCH] Fix documentation --- .github/workflows/mkdocs.yml | 6 ++++-- docs/configuration/inbound/shadowtls.md | 5 +++-- docs/configuration/inbound/shadowtls.zh.md | 5 +++-- docs/examples/shadowtls.md | 4 ++-- 4 files changed, 12 insertions(+), 8 deletions(-) diff --git a/.github/workflows/mkdocs.yml b/.github/workflows/mkdocs.yml index 5c676099..7c9addac 100644 --- a/.github/workflows/mkdocs.yml +++ b/.github/workflows/mkdocs.yml @@ -14,5 +14,7 @@ jobs: - uses: actions/setup-python@v4 with: python-version: 3.x - - run: pip install mkdocs-material mkdocs-static-i18n - - run: mkdocs gh-deploy -m "{sha}" --force --ignore-version --no-history \ No newline at end of file + - run: | + pip install mkdocs-material=="9.*" mkdocs-static-i18n=="0.53" + - run: | + mkdocs gh-deploy -m "{sha}" --force --ignore-version --no-history \ No newline at end of file diff --git a/docs/configuration/inbound/shadowtls.md b/docs/configuration/inbound/shadowtls.md index 372272d9..f989d319 100644 --- a/docs/configuration/inbound/shadowtls.md +++ b/docs/configuration/inbound/shadowtls.md @@ -7,7 +7,7 @@ ... // Listen Fields - "version": 2, + "version": 3, "password": "fuck me till the daylight", "handshake": { "server": "google.com", @@ -32,12 +32,13 @@ ShadowTLS protocol version. |---------------|-----------------------------------------------------------------------------------------| | `1` (default) | [ShadowTLS v1](https://github.com/ihciah/shadow-tls/blob/master/docs/protocol-en.md#v1) | | `2` | [ShadowTLS v2](https://github.com/ihciah/shadow-tls/blob/master/docs/protocol-en.md#v2) | +| `3` | [ShadowTLS v3](https://github.com/ihciah/shadow-tls/blob/master/docs/protocol-v3-en.md) | #### password Set password. -Only available in the ShadowTLS v2 protocol. +Only available in the ShadowTLS v2/v3 protocol. #### handshake diff --git a/docs/configuration/inbound/shadowtls.zh.md b/docs/configuration/inbound/shadowtls.zh.md index 0d549916..356d0a1f 100644 --- a/docs/configuration/inbound/shadowtls.zh.md +++ b/docs/configuration/inbound/shadowtls.zh.md @@ -7,7 +7,7 @@ ... // 监听字段 - "version": 2, + "version": 3, "password": "fuck me till the daylight", "handshake": { "server": "google.com", @@ -32,12 +32,13 @@ ShadowTLS 协议版本。 |---------------|-----------------------------------------------------------------------------------------| | `1` (default) | [ShadowTLS v1](https://github.com/ihciah/shadow-tls/blob/master/docs/protocol-en.md#v1) | | `2` | [ShadowTLS v2](https://github.com/ihciah/shadow-tls/blob/master/docs/protocol-en.md#v2) | +| `3` | [ShadowTLS v3](https://github.com/ihciah/shadow-tls/blob/master/docs/protocol-v3-en.md) | #### password 设置密码。 -仅在 ShadowTLS v2 协议中可用。 +仅在 ShadowTLS v2/v3 协议中可用。 #### handshake diff --git a/docs/examples/shadowtls.md b/docs/examples/shadowtls.md index af4b1da3..3236ac8b 100644 --- a/docs/examples/shadowtls.md +++ b/docs/examples/shadowtls.md @@ -7,7 +7,7 @@ "type": "shadowtls", "listen": "::", "listen_port": 4443, - "version": 2, + "version": 3, "password": "fuck me till the daylight", "handshake": { "server": "google.com", @@ -47,7 +47,7 @@ "tag": "shadowtls-out", "server": "127.0.0.1", "server_port": 4443, - "version": 2, + "version": 3, "password": "fuck me till the daylight", "tls": { "enabled": true,