mkdocs.yml 6.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202
  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. - scheme: default
  15. primary: white
  16. toggle:
  17. icon: material/brightness-7
  18. name: Switch to dark mode
  19. - scheme: slate
  20. primary: black
  21. toggle:
  22. icon: material/brightness-4
  23. name: Switch to light mode
  24. features:
  25. # - navigation.instant
  26. - navigation.tracking
  27. - navigation.tabs
  28. - navigation.indexes
  29. - navigation.expand
  30. - navigation.sections
  31. - header.autohide
  32. nav:
  33. - Getting Started:
  34. - index.md
  35. - Features: features.md
  36. - Support: support.md
  37. - Change Log: changelog.md
  38. - Installation:
  39. - From source: installation/from-source.md
  40. - Package Manager:
  41. - macOS: installation/package-manager/macOS.md
  42. - Windows: installation/package-manager/windows.md
  43. - Android: installation/package-manager/android.md
  44. - Clients:
  45. - Specification: installation/clients/specification.md
  46. - iOS: installation/clients/sfi.md
  47. - macOS: installation/clients/sfm.md
  48. - Apple tvOS: installation/clients/sft.md
  49. - Android: installation/clients/sfa.md
  50. - Configuration:
  51. - configuration/index.md
  52. - Log:
  53. - configuration/log/index.md
  54. - DNS:
  55. - configuration/dns/index.md
  56. - DNS Server: configuration/dns/server.md
  57. - DNS Rule: configuration/dns/rule.md
  58. - FakeIP: configuration/dns/fakeip.md
  59. - NTP:
  60. - configuration/ntp/index.md
  61. - Route:
  62. - configuration/route/index.md
  63. - GeoIP: configuration/route/geoip.md
  64. - Geosite: configuration/route/geosite.md
  65. - Route Rule: configuration/route/rule.md
  66. - Protocol Sniff: configuration/route/sniff.md
  67. - Experimental:
  68. - configuration/experimental/index.md
  69. - Shared:
  70. - Listen Fields: configuration/shared/listen.md
  71. - Dial Fields: configuration/shared/dial.md
  72. - TLS: configuration/shared/tls.md
  73. - Multiplex: configuration/shared/multiplex.md
  74. - V2Ray Transport: configuration/shared/v2ray-transport.md
  75. - UDP over TCP: configuration/shared/udp-over-tcp.md
  76. - Inbound:
  77. - configuration/inbound/index.md
  78. - Direct: configuration/inbound/direct.md
  79. - Mixed: configuration/inbound/mixed.md
  80. - SOCKS: configuration/inbound/socks.md
  81. - HTTP: configuration/inbound/http.md
  82. - Shadowsocks: configuration/inbound/shadowsocks.md
  83. - VMess: configuration/inbound/vmess.md
  84. - Trojan: configuration/inbound/trojan.md
  85. - Naive: configuration/inbound/naive.md
  86. - Hysteria: configuration/inbound/hysteria.md
  87. - ShadowTLS: configuration/inbound/shadowtls.md
  88. - VLESS: configuration/inbound/vless.md
  89. - Tun: configuration/inbound/tun.md
  90. - Redirect: configuration/inbound/redirect.md
  91. - TProxy: configuration/inbound/tproxy.md
  92. - Outbound:
  93. - configuration/outbound/index.md
  94. - Direct: configuration/outbound/direct.md
  95. - Block: configuration/outbound/block.md
  96. - SOCKS: configuration/outbound/socks.md
  97. - HTTP: configuration/outbound/http.md
  98. - Shadowsocks: configuration/outbound/shadowsocks.md
  99. - VMess: configuration/outbound/vmess.md
  100. - Trojan: configuration/outbound/trojan.md
  101. - WireGuard: configuration/outbound/wireguard.md
  102. - Hysteria: configuration/outbound/hysteria.md
  103. - ShadowTLS: configuration/outbound/shadowtls.md
  104. - ShadowsocksR: configuration/outbound/shadowsocksr.md
  105. - VLESS: configuration/outbound/vless.md
  106. - Tor: configuration/outbound/tor.md
  107. - SSH: configuration/outbound/ssh.md
  108. - DNS: configuration/outbound/dns.md
  109. - Selector: configuration/outbound/selector.md
  110. - URLTest: configuration/outbound/urltest.md
  111. - FAQ:
  112. - faq/index.md
  113. - FakeIP: faq/fakeip.md
  114. - Known Issues: faq/known-issues.md
  115. - Examples:
  116. - examples/index.md
  117. - Linux Server Installation: examples/linux-server-installation.md
  118. - Tun: examples/tun.md
  119. - DNS Hijack: examples/dns-hijack.md
  120. - Shadowsocks: examples/shadowsocks.md
  121. - ShadowTLS: examples/shadowtls.md
  122. - Clash API: examples/clash-api.md
  123. - WireGuard Direct: examples/wireguard-direct.md
  124. - FakeIP: examples/fakeip.md
  125. - Contributing:
  126. - contributing/index.md
  127. - Developing:
  128. - Environment: contributing/environment.md
  129. - Sub projects: contributing/sub-projects.md
  130. markdown_extensions:
  131. - pymdownx.inlinehilite
  132. - pymdownx.snippets
  133. - pymdownx.superfences
  134. - pymdownx.details
  135. - pymdownx.critic
  136. - pymdownx.caret
  137. - pymdownx.keys
  138. - pymdownx.mark
  139. - pymdownx.tilde
  140. - admonition
  141. - attr_list
  142. - md_in_html
  143. - footnotes
  144. - def_list
  145. - pymdownx.highlight:
  146. anchor_linenums: true
  147. - pymdownx.tabbed:
  148. alternate_style: true
  149. - pymdownx.tasklist:
  150. custom_checkbox: true
  151. extra:
  152. social:
  153. - icon: fontawesome/brands/github
  154. link: https://github.com/SagerNet/sing-box
  155. generator: false
  156. plugins:
  157. - search
  158. - i18n:
  159. default_language: en
  160. languages:
  161. en:
  162. name: English
  163. build: false
  164. zh:
  165. name: 简体中文
  166. material_alternate: true
  167. nav_translations:
  168. zh:
  169. Getting Started: 开始
  170. Features: 特性
  171. Support: 支持
  172. Change Log: 更新日志
  173. Installation: 安装
  174. From source: 从源代码
  175. Clients: 客户端
  176. Configuration: 配置
  177. Log: 日志
  178. DNS Server: DNS 服务器
  179. DNS Rule: DNS 规则
  180. Route: 路由
  181. Route Rule: 路由规则
  182. Protocol Sniff: 协议探测
  183. Experimental: 实验性
  184. Shared: 通用
  185. Listen Fields: 监听字段
  186. Dial Fields: 拨号字段
  187. Multiplex: 多路复用
  188. V2Ray Transport: V2Ray 传输层
  189. Inbound: 入站
  190. Outbound: 出站
  191. FAQ: 常见问题
  192. Known Issues: 已知问题
  193. Examples: 示例
  194. Linux Server Installation: Linux 服务器安装
  195. DNS Hijack: DNS 劫持