forked from SagerNet/sing-box
/
mkdocs.yml
237 lines (228 loc) · 7.88 KB
/
mkdocs.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
site_name: sing-box
site_author: nekohasekai
repo_url: https://github.com/SagerNet/sing-box
repo_name: SagerNet/sing-box
copyright: Copyright © 2022 nekohasekai
site_description: The universal proxy platform.
remote_branch: docs
edit_uri: ""
theme:
name: material
logo: assets/icon.svg
favicon: assets/icon.svg
palette:
- scheme: default
primary: white
toggle:
icon: material/brightness-7
name: Switch to dark mode
- scheme: slate
primary: black
toggle:
icon: material/brightness-4
name: Switch to light mode
features:
# - navigation.instant
- navigation.tracking
- navigation.tabs
- navigation.indexes
- navigation.expand
- navigation.sections
- header.autohide
- content.code.copy
- content.code.select
- content.code.annotate
icon:
admonition:
question: material/new-box
nav:
- Home:
- index.md
- Change Log: changelog.md
- Migration: migration.md
- Deprecated: deprecated.md
- Support: support.md
- Installation:
- Package Manager: installation/package-manager.md
- Docker: installation/docker.md
- Build from source: installation/build-from-source.md
- Graphical Clients:
- clients/index.md
- Android:
- clients/android/index.md
- Features: clients/android/features.md
- Apple platforms:
- clients/apple/index.md
- Features: clients/apple/features.md
- General: clients/general.md
- Privacy policy: clients/privacy.md
- Manual:
- Proxy:
- Server: manual/proxy/server.md
- Client: manual/proxy/client.md
# - TUN: manual/proxy/tun.md
- Proxy Protocol:
- Shadowsocks: manual/proxy-protocol/shadowsocks.md
- Trojan: manual/proxy-protocol/trojan.md
- TUIC: manual/proxy-protocol/tuic.md
- Hysteria 2: manual/proxy-protocol/hysteria2.md
- Configuration:
- configuration/index.md
- Log:
- configuration/log/index.md
- DNS:
- configuration/dns/index.md
- DNS Server: configuration/dns/server.md
- DNS Rule: configuration/dns/rule.md
- FakeIP: configuration/dns/fakeip.md
- NTP:
- configuration/ntp/index.md
- Route:
- configuration/route/index.md
- GeoIP: configuration/route/geoip.md
- Geosite: configuration/route/geosite.md
- Route Rule: configuration/route/rule.md
- Protocol Sniff: configuration/route/sniff.md
- Rule Set:
- configuration/rule-set/index.md
- Source Format: configuration/rule-set/source-format.md
- Headless Rule: configuration/rule-set/headless-rule.md
- Experimental:
- configuration/experimental/index.md
- Cache File: configuration/experimental/cache-file.md
- Clash API: configuration/experimental/clash-api.md
- V2Ray API: configuration/experimental/v2ray-api.md
- Shared:
- Listen Fields: configuration/shared/listen.md
- Dial Fields: configuration/shared/dial.md
- TLS: configuration/shared/tls.md
- DNS01 Challenge Fields: configuration/shared/dns01_challenge.md
- Multiplex: configuration/shared/multiplex.md
- V2Ray Transport: configuration/shared/v2ray-transport.md
- UDP over TCP: configuration/shared/udp-over-tcp.md
- TCP Brutal: configuration/shared/tcp-brutal.md
- Inbound:
- configuration/inbound/index.md
- Direct: configuration/inbound/direct.md
- Mixed: configuration/inbound/mixed.md
- SOCKS: configuration/inbound/socks.md
- HTTP: configuration/inbound/http.md
- Shadowsocks: configuration/inbound/shadowsocks.md
- VMess: configuration/inbound/vmess.md
- Trojan: configuration/inbound/trojan.md
- Naive: configuration/inbound/naive.md
- Hysteria: configuration/inbound/hysteria.md
- ShadowTLS: configuration/inbound/shadowtls.md
- VLESS: configuration/inbound/vless.md
- TUIC: configuration/inbound/tuic.md
- Hysteria2: configuration/inbound/hysteria2.md
- Tun: configuration/inbound/tun.md
- Redirect: configuration/inbound/redirect.md
- TProxy: configuration/inbound/tproxy.md
- Outbound:
- configuration/outbound/index.md
- Direct: configuration/outbound/direct.md
- Block: configuration/outbound/block.md
- SOCKS: configuration/outbound/socks.md
- HTTP: configuration/outbound/http.md
- Shadowsocks: configuration/outbound/shadowsocks.md
- VMess: configuration/outbound/vmess.md
- Trojan: configuration/outbound/trojan.md
- WireGuard: configuration/outbound/wireguard.md
- Hysteria: configuration/outbound/hysteria.md
- ShadowTLS: configuration/outbound/shadowtls.md
- ShadowsocksR: configuration/outbound/shadowsocksr.md
- VLESS: configuration/outbound/vless.md
- TUIC: configuration/outbound/tuic.md
- Hysteria2: configuration/outbound/hysteria2.md
- Tor: configuration/outbound/tor.md
- SSH: configuration/outbound/ssh.md
- DNS: configuration/outbound/dns.md
- Selector: configuration/outbound/selector.md
- URLTest: configuration/outbound/urltest.md
markdown_extensions:
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
- pymdownx.details
- pymdownx.critic
- pymdownx.caret
- pymdownx.keys
- pymdownx.mark
- pymdownx.tilde
- pymdownx.magiclink
- admonition
- attr_list
- md_in_html
- footnotes
- def_list
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.tabbed:
alternate_style: true
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/SagerNet/sing-box
generator: false
plugins:
- search
- i18n:
docs_structure: suffix
fallback_to_default: true
languages:
- build: true
default: true
locale: en
name: English
- build: true
default: false
locale: zh
name: 简体中文
nav_translations:
Home: 开始
Change Log: 更新日志
Migration: 迁移指南
Deprecated: 废弃功能列表
Support: 支持
Installation: 安装
Package Manager: 包管理器
Build from source: 从源代码构建
Graphical Clients: 图形界面客户端
Features: 特性
Apple platforms: Apple 平台
General: 通用
Privacy policy: 隐私政策
Configuration: 配置
Log: 日志
DNS Server: DNS 服务器
DNS Rule: DNS 规则
Route: 路由
Route Rule: 路由规则
Protocol Sniff: 协议探测
Rule Set: 规则集
Source Format: 源文件格式
Headless Rule: 无头规则
Experimental: 实验性
Cache File: 缓存文件
Shared: 通用
Listen Fields: 监听字段
Dial Fields: 拨号字段
DNS01 Challenge Fields: DNS01 验证字段
Multiplex: 多路复用
V2Ray Transport: V2Ray 传输层
Inbound: 入站
Outbound: 出站
Manual: 手册
reconfigure_material: true
reconfigure_search: true