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