Skip to content

Commit

Permalink
documentation: Fix link format
Browse files Browse the repository at this point in the history
  • Loading branch information
nekohasekai committed Dec 16, 2023
1 parent 282a974 commit 080bdf4
Show file tree
Hide file tree
Showing 73 changed files with 282 additions and 282 deletions.
140 changes: 70 additions & 70 deletions docs/changelog.md

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/clients/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ Maintained by Project S to provide a unified experience and platform-specific fu

| Platform | Client |
|---------------------------------------|-----------------------------------------|
| :material-android: Android | [sing-box for Android](./android) |
| :material-apple: iOS/macOS/Apple tvOS | [sing-box for Apple platforms](./apple) |
| :material-android: Android | [sing-box for Android](./android/) |
| :material-apple: iOS/macOS/Apple tvOS | [sing-box for Apple platforms](./apple/) |
| :material-laptop: Desktop | Working in progress |

Some third-party projects that claim to use sing-box or use sing-box as a selling point are not listed here. The core
Expand Down
4 changes: 2 additions & 2 deletions docs/clients/index.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@

| 平台 | 客户端 |
|---------------------------------------|-----------------------------------------|
| :material-android: Android | [sing-box for Android](./android) |
| :material-apple: iOS/macOS/Apple tvOS | [sing-box for Apple platforms](./apple) |
| :material-android: Android | [sing-box for Android](./android/) |
| :material-apple: iOS/macOS/Apple tvOS | [sing-box for Apple platforms](./apple/) |
| :material-laptop: Desktop | 施工中 |

此处没有列出一些声称使用或以 sing-box 为卖点的第三方项目。此类项目维护者的动机是获得更多用户,即使它们提供友好的商业
Expand Down
8 changes: 4 additions & 4 deletions docs/configuration/dns/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@

| Key | Format |
|----------|--------------------------------|
| `server` | List of [DNS Server](./server) |
| `rules` | List of [DNS Rule](./rule) |
| `fakeip` | [FakeIP](./fakeip) |
| `server` | List of [DNS Server](./server/) |
| `rules` | List of [DNS Rule](./rule/) |
| `fakeip` | [FakeIP](./fakeip/) |

#### final

Expand Down Expand Up @@ -62,4 +62,4 @@ problematic in environments such as macOS, where DNS is proxied and cached by th

#### fakeip

[FakeIP](./fakeip) settings.
[FakeIP](./fakeip/) settings.
6 changes: 3 additions & 3 deletions docs/configuration/dns/index.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@

|| 格式 |
|----------|------------------------|
| `server` | 一组 [DNS 服务器](./server) |
| `rules` | 一组 [DNS 规则](./rule) |
| `server` | 一组 [DNS 服务器](./server/) |
| `rules` | 一组 [DNS 规则](./rule/) |

#### final

Expand Down Expand Up @@ -60,4 +60,4 @@

#### fakeip

[FakeIP](./fakeip) 设置。
[FakeIP](./fakeip/) 设置。
2 changes: 1 addition & 1 deletion docs/configuration/dns/rule.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ icon: material/alert-decagram

#### inbound

Tags of [Inbound](/configuration/inbound).
Tags of [Inbound](/configuration/inbound/).

#### ip_version

Expand Down
2 changes: 1 addition & 1 deletion docs/configuration/dns/rule.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ icon: material/alert-decagram

#### inbound

[入站](/zh/configuration/inbound) 标签.
[入站](/zh/configuration/inbound/) 标签.

#### ip_version

Expand Down
2 changes: 1 addition & 1 deletion docs/configuration/dns/server.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ The address of the dns server.
| `HTTP3` | `h3://8.8.8.8/dns-query` |
| `RCode` | `rcode://refused` |
| `DHCP` | `dhcp://auto` or `dhcp://en0` |
| [FakeIP](/configuration/dns/fakeip) | `fakeip` |
| [FakeIP](/configuration/dns/fakeip/) | `fakeip` |

!!! warning ""

Expand Down
2 changes: 1 addition & 1 deletion docs/configuration/dns/server.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ DNS 服务器的地址。
| `HTTP3` | `h3://8.8.8.8/dns-query` |
| `RCode` | `rcode://refused` |
| `DHCP` | `dhcp://auto``dhcp://en0` |
| [FakeIP](/configuration/dns/fakeip) | `fakeip` |
| [FakeIP](/configuration/dns/fakeip/) | `fakeip` |

!!! warning ""

Expand Down
6 changes: 3 additions & 3 deletions docs/configuration/experimental/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,6 @@ icon: material/alert-decagram

| Key | Format |
|--------------|----------------------------|
| `cache_file` | [Cache File](./cache-file) |
| `clash_api` | [Clash API](./clash-api) |
| `v2ray_api` | [V2Ray API](./v2ray-api) |
| `cache_file` | [Cache File](./cache-file/) |
| `clash_api` | [Clash API](./clash-api/) |
| `v2ray_api` | [V2Ray API](./v2ray-api/) |
6 changes: 3 additions & 3 deletions docs/configuration/experimental/index.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,6 @@ icon: material/alert-decagram

|| 格式 |
|--------------|--------------------------|
| `cache_file` | [缓存文件](./cache-file) |
| `clash_api` | [Clash API](./clash-api) |
| `v2ray_api` | [V2Ray API](./v2ray-api) |
| `cache_file` | [缓存文件](./cache-file/) |
| `clash_api` | [Clash API](./clash-api/) |
| `v2ray_api` | [V2Ray API](./v2ray-api/) |
2 changes: 1 addition & 1 deletion docs/configuration/inbound/direct.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

### Listen Fields

See [Listen Fields](/configuration/shared/listen) for details.
See [Listen Fields](/configuration/shared/listen/) for details.

### Fields

Expand Down
2 changes: 1 addition & 1 deletion docs/configuration/inbound/http.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@

### Listen Fields

See [Listen Fields](/configuration/shared/listen) for details.
See [Listen Fields](/configuration/shared/listen/) for details.

### Fields

Expand Down
2 changes: 1 addition & 1 deletion docs/configuration/inbound/hysteria.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@

### Listen Fields

See [Listen Fields](/configuration/shared/listen) for details.
See [Listen Fields](/configuration/shared/listen/) for details.

### Fields

Expand Down
2 changes: 1 addition & 1 deletion docs/configuration/inbound/hysteria2.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@

### Listen Fields

See [Listen Fields](/configuration/shared/listen) for details.
See [Listen Fields](/configuration/shared/listen/) for details.

### Fields

Expand Down
32 changes: 16 additions & 16 deletions docs/configuration/inbound/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,22 +17,22 @@

| Type | Format | Injectable |
|---------------|------------------------------|------------|
| `direct` | [Direct](./direct) | X |
| `mixed` | [Mixed](./mixed) | TCP |
| `socks` | [SOCKS](./socks) | TCP |
| `http` | [HTTP](./http) | TCP |
| `shadowsocks` | [Shadowsocks](./shadowsocks) | TCP |
| `vmess` | [VMess](./vmess) | TCP |
| `trojan` | [Trojan](./trojan) | TCP |
| `naive` | [Naive](./naive) | X |
| `hysteria` | [Hysteria](./hysteria) | X |
| `shadowtls` | [ShadowTLS](./shadowtls) | TCP |
| `tuic` | [TUIC](./tuic) | X |
| `hysteria2` | [Hysteria2](./hysteria2) | X |
| `vless` | [VLESS](./vless) | TCP |
| `tun` | [Tun](./tun) | X |
| `redirect` | [Redirect](./redirect) | X |
| `tproxy` | [TProxy](./tproxy) | X |
| `direct` | [Direct](./direct/) | X |
| `mixed` | [Mixed](./mixed/) | TCP |
| `socks` | [SOCKS](./socks/) | TCP |
| `http` | [HTTP](./http/) | TCP |
| `shadowsocks` | [Shadowsocks](./shadowsocks/) | TCP |
| `vmess` | [VMess](./vmess/) | TCP |
| `trojan` | [Trojan](./trojan/) | TCP |
| `naive` | [Naive](./naive/) | X |
| `hysteria` | [Hysteria](./hysteria/) | X |
| `shadowtls` | [ShadowTLS](./shadowtls/) | TCP |
| `tuic` | [TUIC](./tuic/) | X |
| `hysteria2` | [Hysteria2](./hysteria2/) | X |
| `vless` | [VLESS](./vless/) | TCP |
| `tun` | [Tun](./tun/) | X |
| `redirect` | [Redirect](./redirect/) | X |
| `tproxy` | [TProxy](./tproxy/) | X |

#### tag

Expand Down
32 changes: 16 additions & 16 deletions docs/configuration/inbound/index.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,22 +17,22 @@

| 类型 | 格式 | 注入支持 |
|---------------|------------------------------|------|
| `direct` | [Direct](./direct) | X |
| `mixed` | [Mixed](./mixed) | TCP |
| `socks` | [SOCKS](./socks) | TCP |
| `http` | [HTTP](./http) | TCP |
| `shadowsocks` | [Shadowsocks](./shadowsocks) | TCP |
| `vmess` | [VMess](./vmess) | TCP |
| `trojan` | [Trojan](./trojan) | TCP |
| `naive` | [Naive](./naive) | X |
| `hysteria` | [Hysteria](./hysteria) | X |
| `shadowtls` | [ShadowTLS](./shadowtls) | TCP |
| `tuic` | [TUIC](./tuic) | X |
| `hysteria2` | [Hysteria2](./hysteria2) | X |
| `vless` | [VLESS](./vless) | TCP |
| `tun` | [Tun](./tun) | X |
| `redirect` | [Redirect](./redirect) | X |
| `tproxy` | [TProxy](./tproxy) | X |
| `direct` | [Direct](./direct/) | X |
| `mixed` | [Mixed](./mixed/) | TCP |
| `socks` | [SOCKS](./socks/) | TCP |
| `http` | [HTTP](./http/) | TCP |
| `shadowsocks` | [Shadowsocks](./shadowsocks/) | TCP |
| `vmess` | [VMess](./vmess/) | TCP |
| `trojan` | [Trojan](./trojan/) | TCP |
| `naive` | [Naive](./naive/) | X |
| `hysteria` | [Hysteria](./hysteria/) | X |
| `shadowtls` | [ShadowTLS](./shadowtls/) | TCP |
| `tuic` | [TUIC](./tuic/) | X |
| `hysteria2` | [Hysteria2](./hysteria2/) | X |
| `vless` | [VLESS](./vless/) | TCP |
| `tun` | [Tun](./tun/) | X |
| `redirect` | [Redirect](./redirect/) | X |
| `tproxy` | [TProxy](./tproxy/) | X |

#### tag

Expand Down
2 changes: 1 addition & 1 deletion docs/configuration/inbound/mixed.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@

### Listen Fields

See [Listen Fields](/configuration/shared/listen) for details.
See [Listen Fields](/configuration/shared/listen/) for details.

### Fields

Expand Down
2 changes: 1 addition & 1 deletion docs/configuration/inbound/naive.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@

### Listen Fields

See [Listen Fields](/configuration/shared/listen) for details.
See [Listen Fields](/configuration/shared/listen/) for details.

### Fields

Expand Down
2 changes: 1 addition & 1 deletion docs/configuration/inbound/redirect.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,4 @@

### Listen Fields

See [Listen Fields](/configuration/shared/listen) for details.
See [Listen Fields](/configuration/shared/listen/) for details.
2 changes: 1 addition & 1 deletion docs/configuration/inbound/shadowsocks.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@

### Listen Fields

See [Listen Fields](/configuration/shared/listen) for details.
See [Listen Fields](/configuration/shared/listen/) for details.

### Fields

Expand Down
2 changes: 1 addition & 1 deletion docs/configuration/inbound/shadowsocks.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@

### Listen Fields

See [Listen Fields](/configuration/shared/listen) for details.
See [Listen Fields](/configuration/shared/listen/) for details.

### 字段

Expand Down
6 changes: 3 additions & 3 deletions docs/configuration/inbound/shadowtls.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@

### Listen Fields

See [Listen Fields](/configuration/shared/listen) for details.
See [Listen Fields](/configuration/shared/listen/) for details.

### Fields

Expand Down Expand Up @@ -66,11 +66,11 @@ Only available in the ShadowTLS protocol 3.

==Required==

Handshake server address and [Dial options](/configuration/shared/dial).
Handshake server address and [Dial options](/configuration/shared/dial/).

#### handshake_for_server_name

Handshake server address and [Dial options](/configuration/shared/dial) for specific server name.
Handshake server address and [Dial options](/configuration/shared/dial/) for specific server name.

Only available in the ShadowTLS protocol 2/3.

Expand Down
2 changes: 1 addition & 1 deletion docs/configuration/inbound/socks.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@

### Listen Fields

See [Listen Fields](/configuration/shared/listen) for details.
See [Listen Fields](/configuration/shared/listen/) for details.

### Fields

Expand Down
2 changes: 1 addition & 1 deletion docs/configuration/inbound/tproxy.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

### Listen Fields

See [Listen Fields](/configuration/shared/listen) for details.
See [Listen Fields](/configuration/shared/listen/) for details.

### Fields

Expand Down
4 changes: 2 additions & 2 deletions docs/configuration/inbound/trojan.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@

### Listen Fields

See [Listen Fields](/configuration/shared/listen) for details.
See [Listen Fields](/configuration/shared/listen/) for details.

### Fields

Expand Down Expand Up @@ -65,4 +65,4 @@ See [Multiplex](/configuration/shared/multiplex#inbound) for details.

#### transport

V2Ray Transport configuration, see [V2Ray Transport](/configuration/shared/v2ray-transport).
V2Ray Transport configuration, see [V2Ray Transport](/configuration/shared/v2ray-transport/).
2 changes: 1 addition & 1 deletion docs/configuration/inbound/trojan.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,4 +67,4 @@ TLS 配置, 参阅 [TLS](/zh/configuration/shared/tls/#inbound)。

#### transport

V2Ray 传输配置,参阅 [V2Ray 传输层](/zh/configuration/shared/v2ray-transport)
V2Ray 传输配置,参阅 [V2Ray 传输层](/zh/configuration/shared/v2ray-transport/)
2 changes: 1 addition & 1 deletion docs/configuration/inbound/tuic.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@

### Listen Fields

See [Listen Fields](/configuration/shared/listen) for details.
See [Listen Fields](/configuration/shared/listen/) for details.

### Fields

Expand Down
2 changes: 1 addition & 1 deletion docs/configuration/inbound/tun.md
Original file line number Diff line number Diff line change
Expand Up @@ -261,4 +261,4 @@ System HTTP proxy settings.

### Listen Fields

See [Listen Fields](/configuration/shared/listen) for details.
See [Listen Fields](/configuration/shared/listen/) for details.
4 changes: 2 additions & 2 deletions docs/configuration/inbound/vless.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@

### Listen Fields

See [Listen Fields](/configuration/shared/listen) for details.
See [Listen Fields](/configuration/shared/listen/) for details.

### Fields

Expand Down Expand Up @@ -56,4 +56,4 @@ See [Multiplex](/configuration/shared/multiplex#inbound) for details.

#### transport

V2Ray Transport configuration, see [V2Ray Transport](/configuration/shared/v2ray-transport).
V2Ray Transport configuration, see [V2Ray Transport](/configuration/shared/v2ray-transport/).
2 changes: 1 addition & 1 deletion docs/configuration/inbound/vless.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,4 +56,4 @@ TLS 配置, 参阅 [TLS](/zh/configuration/shared/tls/#inbound)。

#### transport

V2Ray 传输配置,参阅 [V2Ray 传输层](/zh/configuration/shared/v2ray-transport)
V2Ray 传输配置,参阅 [V2Ray 传输层](/zh/configuration/shared/v2ray-transport/)
4 changes: 2 additions & 2 deletions docs/configuration/inbound/vmess.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@

### Listen Fields

See [Listen Fields](/configuration/shared/listen) for details.
See [Listen Fields](/configuration/shared/listen/) for details.

### Fields

Expand Down Expand Up @@ -51,4 +51,4 @@ See [Multiplex](/configuration/shared/multiplex#inbound) for details.

#### transport

V2Ray Transport configuration, see [V2Ray Transport](/configuration/shared/v2ray-transport).
V2Ray Transport configuration, see [V2Ray Transport](/configuration/shared/v2ray-transport/).
2 changes: 1 addition & 1 deletion docs/configuration/inbound/vmess.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,4 +51,4 @@ TLS 配置, 参阅 [TLS](/zh/configuration/shared/tls/#inbound)。

#### transport

V2Ray 传输配置,参阅 [V2Ray 传输层](/zh/configuration/shared/v2ray-transport)
V2Ray 传输配置,参阅 [V2Ray 传输层](/zh/configuration/shared/v2ray-transport/)
Loading

0 comments on commit 080bdf4

Please sign in to comment.