mkdocs.yml 5.9 KB

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