github.com/inazumav/sing-box@v0.0.0-20230926072359-ab51429a14f1/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      - 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            - TUIC: configuration/inbound/tuic.md
    90            - Hysteria2: configuration/inbound/hysteria2.md
    91            - Tun: configuration/inbound/tun.md
    92            - Redirect: configuration/inbound/redirect.md
    93            - TProxy: configuration/inbound/tproxy.md
    94        - Outbound:
    95            - configuration/outbound/index.md
    96            - Direct: configuration/outbound/direct.md
    97            - Block: configuration/outbound/block.md
    98            - SOCKS: configuration/outbound/socks.md
    99            - HTTP: configuration/outbound/http.md
   100            - Shadowsocks: configuration/outbound/shadowsocks.md
   101            - VMess: configuration/outbound/vmess.md
   102            - Trojan: configuration/outbound/trojan.md
   103            - WireGuard: configuration/outbound/wireguard.md
   104            - Hysteria: configuration/outbound/hysteria.md
   105            - ShadowTLS: configuration/outbound/shadowtls.md
   106            - ShadowsocksR: configuration/outbound/shadowsocksr.md
   107            - VLESS: configuration/outbound/vless.md
   108            - TUIC: configuration/outbound/tuic.md
   109            - Hysteria2: configuration/outbound/hysteria2.md
   110            - Tor: configuration/outbound/tor.md
   111            - SSH: configuration/outbound/ssh.md
   112            - DNS: configuration/outbound/dns.md
   113            - Selector: configuration/outbound/selector.md
   114            - URLTest: configuration/outbound/urltest.md
   115    - FAQ:
   116        - faq/index.md
   117        - FakeIP: faq/fakeip.md
   118        - Known Issues: faq/known-issues.md
   119    - Examples:
   120        - examples/index.md
   121        - Linux Server Installation: examples/linux-server-installation.md
   122        - Tun: examples/tun.md
   123        - DNS Hijack: examples/dns-hijack.md
   124        - Shadowsocks: examples/shadowsocks.md
   125        - ShadowTLS: examples/shadowtls.md
   126        - Clash API: examples/clash-api.md
   127        - FakeIP: examples/fakeip.md
   128    - Contributing:
   129        - contributing/index.md
   130        - Developing:
   131            - Environment: contributing/environment.md
   132            - Sub projects: contributing/sub-projects.md
   133  markdown_extensions:
   134    - pymdownx.inlinehilite
   135    - pymdownx.snippets
   136    - pymdownx.superfences
   137    - pymdownx.details
   138    - pymdownx.critic
   139    - pymdownx.caret
   140    - pymdownx.keys
   141    - pymdownx.mark
   142    - pymdownx.tilde
   143    - admonition
   144    - attr_list
   145    - md_in_html
   146    - footnotes
   147    - def_list
   148    - pymdownx.highlight:
   149        anchor_linenums: true
   150    - pymdownx.tabbed:
   151        alternate_style: true
   152    - pymdownx.tasklist:
   153        custom_checkbox: true
   154  extra:
   155    social:
   156      - icon: fontawesome/brands/github
   157        link: https://github.com/SagerNet/sing-box
   158    generator: false
   159  plugins:
   160    - search
   161    - i18n:
   162        default_language: en
   163        languages:
   164          en:
   165            name: English
   166            build: false
   167          zh:
   168            name: 简体中文
   169        material_alternate: true
   170        nav_translations:
   171          zh:
   172            Getting Started: 开始
   173            Features: 特性
   174            Support: 支持
   175            Change Log: 更新日志
   176  
   177            Installation: 安装
   178            From source: 从源代码
   179            Clients: 客户端
   180  
   181            Configuration: 配置
   182            Log: 日志
   183            DNS Server: DNS 服务器
   184            DNS Rule: DNS 规则
   185  
   186            Route: 路由
   187            Route Rule: 路由规则
   188            Protocol Sniff: 协议探测
   189  
   190            Experimental: 实验性
   191  
   192            Shared: 通用
   193            Listen Fields: 监听字段
   194            Dial Fields: 拨号字段
   195            Multiplex: 多路复用
   196            V2Ray Transport: V2Ray 传输层
   197  
   198            Inbound: 入站
   199            Outbound: 出站
   200  
   201            FAQ: 常见问题
   202            Known Issues: 已知问题
   203            Examples: 示例
   204            Linux Server Installation: Linux 服务器安装
   205            DNS Hijack: DNS 劫持