From 5203129b9c26d0d2e840c3d9a66a18dad94d0609 Mon Sep 17 00:00:00 2001 From: ReleTor <191429954+ReleTor@users.noreply.github.com> Date: Mon, 10 Feb 2025 14:33:41 +0800 Subject: [PATCH] documentation: Fixes --- docs/configuration/dns/server/fakeip.md | 14 +++++++----- docs/configuration/dns/server/http3.md | 30 +++++++++++++------------ docs/configuration/dns/server/https.md | 30 +++++++++++++------------ docs/configuration/dns/server/quic.md | 24 +++++++++++--------- docs/configuration/dns/server/tcp.md | 20 +++++++++-------- docs/configuration/dns/server/tls.md | 24 +++++++++++--------- docs/configuration/dns/server/udp.md | 20 +++++++++-------- docs/configuration/index.zh.md | 2 ++ docs/configuration/outbound/block.md | 2 +- docs/configuration/rule-set/index.md | 2 +- docs/configuration/rule-set/index.zh.md | 2 +- 11 files changed, 93 insertions(+), 77 deletions(-) diff --git a/docs/configuration/dns/server/fakeip.md b/docs/configuration/dns/server/fakeip.md index 7023fd21..6d2bba43 100644 --- a/docs/configuration/dns/server/fakeip.md +++ b/docs/configuration/dns/server/fakeip.md @@ -11,13 +11,15 @@ icon: material/new-box ```json { "dns": { - "servers": { - "type": "fakeip", - "tag": "", + "servers": [ + { + "type": "fakeip", + "tag": "", - "inet4_range": "198.18.0.0/15", - "inet6_range": "fc00::/18" - } + "inet4_range": "198.18.0.0/15", + "inet6_range": "fc00::/18" + } + ] } } ``` diff --git a/docs/configuration/dns/server/http3.md b/docs/configuration/dns/server/http3.md index 843b0c9f..89f000e8 100644 --- a/docs/configuration/dns/server/http3.md +++ b/docs/configuration/dns/server/http3.md @@ -11,20 +11,22 @@ icon: material/new-box ```json { "dns": { - "servers": { - "type": "h3", - "tag": "", - - "server": "", - "server_port": 443, - - "path": "", - "headers": {}, - - "tls": {}, - - // Dial Fields - } + "servers": [ + { + "type": "h3", + "tag": "", + + "server": "", + "server_port": 443, + + "path": "", + "headers": {}, + + "tls": {}, + + // Dial Fields + } + ] } } ``` diff --git a/docs/configuration/dns/server/https.md b/docs/configuration/dns/server/https.md index 8375146b..93dc71a4 100644 --- a/docs/configuration/dns/server/https.md +++ b/docs/configuration/dns/server/https.md @@ -11,20 +11,22 @@ icon: material/new-box ```json { "dns": { - "servers": { - "type": "https", - "tag": "", - - "server": "", - "server_port": 443, - - "path": "", - "headers": {}, - - "tls": {}, - - // Dial Fields - } + "servers": [ + { + "type": "https", + "tag": "", + + "server": "", + "server_port": 443, + + "path": "", + "headers": {}, + + "tls": {}, + + // Dial Fields + } + ] } } ``` diff --git a/docs/configuration/dns/server/quic.md b/docs/configuration/dns/server/quic.md index ad1daed6..096264fe 100644 --- a/docs/configuration/dns/server/quic.md +++ b/docs/configuration/dns/server/quic.md @@ -11,17 +11,19 @@ icon: material/new-box ```json { "dns": { - "servers": { - "type": "quic", - "tag": "", - - "server": "", - "server_port": 853, - - "tls": {}, - - // Dial Fields - } + "servers": [ + { + "type": "quic", + "tag": "", + + "server": "", + "server_port": 853, + + "tls": {}, + + // Dial Fields + } + ] } } ``` diff --git a/docs/configuration/dns/server/tcp.md b/docs/configuration/dns/server/tcp.md index 4e2f0366..c0a4ceaf 100644 --- a/docs/configuration/dns/server/tcp.md +++ b/docs/configuration/dns/server/tcp.md @@ -11,15 +11,17 @@ icon: material/new-box ```json { "dns": { - "servers": { - "type": "tcp", - "tag": "", - - "server": "", - "server_port": 53, - - // Dial Fields - } + "servers": [ + { + "type": "tcp", + "tag": "", + + "server": "", + "server_port": 53, + + // Dial Fields + } + ] } } ``` diff --git a/docs/configuration/dns/server/tls.md b/docs/configuration/dns/server/tls.md index f18bd1b0..0e3be226 100644 --- a/docs/configuration/dns/server/tls.md +++ b/docs/configuration/dns/server/tls.md @@ -11,17 +11,19 @@ icon: material/new-box ```json { "dns": { - "servers": { - "type": "tls", - "tag": "", - - "server": "", - "server_port": 853, - - "tls": {}, - - // Dial Fields - } + "servers": [ + { + "type": "tls", + "tag": "", + + "server": "", + "server_port": 853, + + "tls": {}, + + // Dial Fields + } + ] } } ``` diff --git a/docs/configuration/dns/server/udp.md b/docs/configuration/dns/server/udp.md index 30f6be70..4ffbf4d8 100644 --- a/docs/configuration/dns/server/udp.md +++ b/docs/configuration/dns/server/udp.md @@ -11,15 +11,17 @@ icon: material/new-box ```json { "dns": { - "servers": { - "type": "udp", - "tag": "", - - "server": "", - "server_port": 53, - - // Dial Fields - } + "servers": [ + { + "type": "udp", + "tag": "", + + "server": "", + "server_port": 53, + + // Dial Fields + } + ] } } ``` diff --git a/docs/configuration/index.zh.md b/docs/configuration/index.zh.md index 6aeb4857..b639c72a 100644 --- a/docs/configuration/index.zh.md +++ b/docs/configuration/index.zh.md @@ -8,6 +8,7 @@ sing-box 使用 JSON 作为配置文件格式。 { "log": {}, "dns": {}, + "ntp": {}, "endpoints": [], "inbounds": [], "outbounds": [], @@ -22,6 +23,7 @@ sing-box 使用 JSON 作为配置文件格式。 |----------------|------------------------| | `log` | [日志](./log/) | | `dns` | [DNS](./dns/) | +| `ntp` | [NTP](./ntp/) | | `endpoints` | [端点](./endpoint/) | | `inbounds` | [入站](./inbound/) | | `outbounds` | [出站](./outbound/) | diff --git a/docs/configuration/outbound/block.md b/docs/configuration/outbound/block.md index f29120cc..1be04dd5 100644 --- a/docs/configuration/outbound/block.md +++ b/docs/configuration/outbound/block.md @@ -8,7 +8,7 @@ icon: material/delete-clock ### Structure -```json F +```json { "type": "block", "tag": "block" diff --git a/docs/configuration/rule-set/index.md b/docs/configuration/rule-set/index.md index 527134f9..944ea838 100644 --- a/docs/configuration/rule-set/index.md +++ b/docs/configuration/rule-set/index.md @@ -70,7 +70,7 @@ Tag of rule-set. ==Required== -List of [Headless Rule](../headless-rule/). +List of [Headless Rule](./headless-rule/). ### Local or Remote Fields diff --git a/docs/configuration/rule-set/index.zh.md b/docs/configuration/rule-set/index.zh.md index 54948b61..c38a57b5 100644 --- a/docs/configuration/rule-set/index.zh.md +++ b/docs/configuration/rule-set/index.zh.md @@ -70,7 +70,7 @@ ==必填== -一组 [无头规则](../headless-rule/). +一组 [无头规则](./headless-rule/). ### 本地或远程字段