diff --git a/docs/config/experimental.en.md b/docs/config/experimental.en.md index 4b8d06b9b..a1a0e4752 100644 --- a/docs/config/experimental.en.md +++ b/docs/config/experimental.en.md @@ -1,3 +1,5 @@ +# Experimental configuration + ```{.yaml linenums="1"} experimental: quic-go-disable-gso: false diff --git a/docs/config/experimental.md b/docs/config/experimental.md index f3cd651c7..f8ba7a5a7 100644 --- a/docs/config/experimental.md +++ b/docs/config/experimental.md @@ -1,3 +1,5 @@ +# 实验性配置 + ```{.yaml linenums="1"} experimental: quic-go-disable-gso: false diff --git a/docs/config/proxies/hysteria2.md b/docs/config/proxies/hysteria2.md index 4db75f727..d53091956 100644 --- a/docs/config/proxies/hysteria2.md +++ b/docs/config/proxies/hysteria2.md @@ -8,6 +8,7 @@ proxies: type: hysteria2 server: server.com port: 443 + # ports: 10000-20000/443 # up和down均不写或为0则使用BBR流控 # up: "30 Mbps" # 若不写单位，默认为 Mbps # down: "200 Mbps" # 若不写单位，默认为 Mbps diff --git a/docs/config/proxies/sing-mux.md b/docs/config/proxies/sing-mux.md index 640210bb1..4a044bf09 100644 --- a/docs/config/proxies/sing-mux.md +++ b/docs/config/proxies/sing-mux.md @@ -1,4 +1,4 @@ -# SING-MUX +# sing-mux ```{.yaml linenums="1"} smux: @@ -24,8 +24,8 @@ smux: 多路复用协议，支持如下协议，默认使用 `h2mux` -| 协议 | 描述 | -|---------|------------------------------------| +| 协议 | 描述 | +|---------|--------------------------------------| | `smux` | | | `yamux` | | | `h2mux` | | diff --git a/docs/config/proxy-groups/built-in.en.md b/docs/config/proxy-groups/built-in.en.md index f59e2e2c8..3c23c7441 100644 --- a/docs/config/proxy-groups/built-in.en.md +++ b/docs/config/proxy-groups/built-in.en.md @@ -1,3 +1,5 @@ +# Preset outbound + ## DIRECT Direct, data exits directly. diff --git a/docs/config/proxy-groups/built-in.md b/docs/config/proxy-groups/built-in.md index 262b08f45..7c638ad37 100644 --- a/docs/config/proxy-groups/built-in.md +++ b/docs/config/proxy-groups/built-in.md @@ -1,3 +1,5 @@ +# 预置出站 + ## DIRECT 直连,数据直接出站 diff --git a/docs/config/proxy-groups/fallback.en.md b/docs/config/proxy-groups/fallback.en.md index 86fab6f4c..e782c2a59 100644 --- a/docs/config/proxy-groups/fallback.en.md +++ b/docs/config/proxy-groups/fallback.en.md @@ -1,3 +1,5 @@ +# Fallback + ```{.yaml linenums="1"} proxy-groups: - name: "fallback" diff --git a/docs/config/proxy-groups/fallback.md b/docs/config/proxy-groups/fallback.md index c676df943..9f4db7b0d 100644 --- a/docs/config/proxy-groups/fallback.md +++ b/docs/config/proxy-groups/fallback.md @@ -1,3 +1,5 @@ +# Fallback + ```{.yaml linenums="1"} proxy-groups: - name: "fallback" diff --git a/docs/config/proxy-groups/index.en.md b/docs/config/proxy-groups/index.en.md index 8c96ff222..1c859e39e 100644 --- a/docs/config/proxy-groups/index.en.md +++ b/docs/config/proxy-groups/index.en.md @@ -1,3 +1,5 @@ +# Common fields + ```{.yaml linenums="1"} proxy-groups: - name: "proxy" @@ -86,8 +88,6 @@ Include all [proxies](../proxies/index.md) and [proxy-providers](../proxy-provid !!! info "" Excludes proxy-groups, you can include other proxy-groups in [`proxies`](./index.md#proxies). - Will make [`include-all-proxies`](./index.md#include-all-proxies) and [`include-all-providers`](./index.md#include-all-providers) ineffective. - ## include-all-proxies Include all [proxies](../proxies/index.md) diff --git a/docs/config/proxy-groups/index.md b/docs/config/proxy-groups/index.md index ca58df407..bf7e79cfd 100644 --- a/docs/config/proxy-groups/index.md +++ b/docs/config/proxy-groups/index.md @@ -1,3 +1,5 @@ +# 通用字段 + ```{.yaml linenums="1"} proxy-groups: - name: "proxy" @@ -85,8 +87,6 @@ proxy-groups: !!! info "" 引入不包含策略组,可在[proxies](./index.md#proxies)引入其他策略组 - 会使[`include-all-proxies`](./index.md#include-all-proxies)和[`include-all-providers`](./index.md#include-all-providers)失效 - ## include-all-proxies 引入所有[出站代理](../proxies/index.md) diff --git a/docs/config/proxy-groups/load-balance.en.md b/docs/config/proxy-groups/load-balance.en.md index 2fed763e2..ade186f90 100644 --- a/docs/config/proxy-groups/load-balance.en.md +++ b/docs/config/proxy-groups/load-balance.en.md @@ -1,3 +1,5 @@ +# Load-balance + ```{.yaml linenums="1"} proxy-groups: - name: "load-balance" diff --git a/docs/config/proxy-groups/load-balance.md b/docs/config/proxy-groups/load-balance.md index acb879efe..700ecbf57 100644 --- a/docs/config/proxy-groups/load-balance.md +++ b/docs/config/proxy-groups/load-balance.md @@ -1,3 +1,5 @@ +# Load-balance + ```{.yaml linenums="1"} proxy-groups: - name: "load-balance" diff --git a/docs/config/proxy-groups/relay.en.md b/docs/config/proxy-groups/relay.en.md index 29cb3031c..4464600c5 100644 --- a/docs/config/proxy-groups/relay.en.md +++ b/docs/config/proxy-groups/relay.en.md @@ -1,3 +1,5 @@ +# Relay + ```{.yaml linenums="1"} Proxy Groups: # Traffic: Clash <-> http <-> vmess <-> ss1 <-> ss2 <-> Internet @@ -12,7 +14,7 @@ Proxy Groups: The traffic flow is `Clash` <-> `http` <-> `vmess` <-> `ss1` <-> `ss2` <-> `Internet`. -### Regarding UDP +## Regarding UDP Relay supports UDP transmission, provided that both the head and tail nodes of the proxy chain support UDP over TCP. Currently, the protocols that support UDP include `vmess`, `vless`, `trojan`, `ss`, `ssr`, and `tuic`. diff --git a/docs/config/proxy-groups/relay.md b/docs/config/proxy-groups/relay.md index d6d170ead..3c9d852ac 100644 --- a/docs/config/proxy-groups/relay.md +++ b/docs/config/proxy-groups/relay.md @@ -1,3 +1,5 @@ +# Relay + ```{.yaml linenums="1"} Proxy Groups: # Traffic: Clash <-> http <-> vmess <-> ss1 <-> ss2 <-> Internet @@ -14,6 +16,6 @@ Proxy Groups: > wireguard目前不支持在relay中使用。如果需要，请使用 proxy 中的 dialer-proxy 配置项 -### 关于UDP +## 关于UDP relay支持传输UDP，前提是代理链的头尾节点都要支持 UDP over TCP。目前支持 udp 的协议有 `vmess`/`vless`/`trojan`/`ss`/`ssr`/`tuic` diff --git a/docs/config/proxy-groups/select.en.md b/docs/config/proxy-groups/select.en.md index 897de4b5b..3e9d1c48f 100644 --- a/docs/config/proxy-groups/select.en.md +++ b/docs/config/proxy-groups/select.en.md @@ -1,3 +1,5 @@ +# Select + ```{.yaml linenums="1"} proxy-groups: - name: Proxy diff --git a/docs/config/proxy-groups/select.md b/docs/config/proxy-groups/select.md index 98815c455..6c91c6832 100644 --- a/docs/config/proxy-groups/select.md +++ b/docs/config/proxy-groups/select.md @@ -1,3 +1,5 @@ +# Select + ```{.yaml linenums="1"} proxy-groups: - name: Proxy diff --git a/docs/config/proxy-groups/url-test.en.md b/docs/config/proxy-groups/url-test.en.md index ca8be7585..af65d6ef3 100644 --- a/docs/config/proxy-groups/url-test.en.md +++ b/docs/config/proxy-groups/url-test.en.md @@ -1,3 +1,5 @@ +# Url-test + ```{.yaml linenums="1"} proxy-groups: - name: "自动选择" diff --git a/docs/config/proxy-groups/url-test.md b/docs/config/proxy-groups/url-test.md index 6f4f0c06d..f56552ffc 100644 --- a/docs/config/proxy-groups/url-test.md +++ b/docs/config/proxy-groups/url-test.md @@ -1,3 +1,5 @@ +# Url-test + ```{.yaml linenums="1"} proxy-groups: - name: "自动选择" diff --git a/docs/config/proxy-providers/content.md b/docs/config/proxy-providers/content.md index 007541c64..1a8a0cb35 100644 --- a/docs/config/proxy-providers/content.md +++ b/docs/config/proxy-providers/content.md @@ -1,3 +1,5 @@ +# proxy-providers 文件内容 + === "yaml" ```{.yaml linenums="1"} proxies: diff --git a/docs/config/rule-providers/content.md b/docs/config/rule-providers/content.md index 271aca32d..188fd7670 100644 --- a/docs/config/rule-providers/content.md +++ b/docs/config/rule-providers/content.md @@ -1,4 +1,6 @@ -### classical +# rule-providers 文件内容 + +## classical === "yaml" ```{.yaml linenums="1"} @@ -25,7 +27,7 @@ SRC-PORT,7777 ``` -### domain +## domain `domain`类规则集合内容通配应遵守[clash通配符](../index.md#_7) @@ -37,7 +39,6 @@ - 'books.itunes.apple.com' ``` - === "text" ```text .blogger.com @@ -45,8 +46,7 @@ books.itunes.apple.com ``` -### ipcidr - +## ipcidr === "yaml" ```{.yaml linenums="1"} @@ -60,4 +60,3 @@ 192.168.1.0/24 10.0.0.0.1/32 ``` - diff --git a/docs/config/rule-providers/index.md b/docs/config/rule-providers/index.md index 5d7b048bc..a5b6d35ae 100644 --- a/docs/config/rule-providers/index.md +++ b/docs/config/rule-providers/index.md @@ -1,3 +1,5 @@ +# rule-provider + ```{.yaml linenums="1"} rule-providers: google: diff --git a/docs/config/syntax.en.md b/docs/config/syntax.en.md index f72e7a599..e82d997a8 100644 --- a/docs/config/syntax.en.md +++ b/docs/config/syntax.en.md @@ -1,4 +1,6 @@ -Clash uses `yaml` as the configuration file format. +# Syntax + +mihomo uses `yaml` as the configuration file format. `yaml` is case-sensitive and uses indentation to represent hierarchical relationships. Tabs are not allowed for indentation; only spaces are permitted. The number of spaces for indentation is not critical, as long as elements at the same level are left-aligned. @@ -62,7 +64,7 @@ tun: { enable: true, stack: system, auto-route: true, auto-detect-interface: tru Lines starting with - form an array and are used for multiple values within an object. -### Multiline +### Multiline Arrays ```{.yaml linenums="1"} a: @@ -71,7 +73,7 @@ a: - d ``` -### Single-line JSON Extension +### Single-line JSON Arrays ```{.yaml linenums="1"} a: [b, c, d] diff --git a/docs/config/syntax.md b/docs/config/syntax.md index 8568bea0f..a8d9af73b 100644 --- a/docs/config/syntax.md +++ b/docs/config/syntax.md @@ -1,4 +1,6 @@ -Clash 使用 `yaml` 作为配置文件格式 +# 语法 + +mihomo 使用 `yaml` 作为配置文件格式 `yaml` 大小写敏感,使用缩进表示层级关系,缩进不允许使用 tab, 只允许空格,缩进的空格数不重要,只要相同层级的元素左对齐即可 @@ -18,7 +20,7 @@ socks-port: 7891 因`yaml`格式为`json`的超集,所以可以直接使用`json`的写法 -#### 多行 +### 多行 ```{.yaml linenums="1"} tun: @@ -28,7 +30,7 @@ tun: auto-detect-interface: true ``` -#### 多行json扩展 +### 多行json ```{.yaml linenums="1"} tun: { @@ -39,12 +41,14 @@ tun: { } ``` -#### 单行json扩展 +### 单行json ```{.yaml linenums="1"} tun: { enable: true, stack: system, auto-route: true, auto-detect-interface: true} ``` -#### 全json(不推荐) + +### 全json + ```{.json linenums="1"} { "tun": { @@ -60,7 +64,7 @@ tun: { enable: true, stack: system, auto-route: true, auto-detect-interface: tru 以`-`开头的行表示构成一个数组,用于一个对象内的多个值 -#### 多行 +### 多行数组 ```{.yaml linenums="1"} a: @@ -69,7 +73,7 @@ a: - d ``` -#### 单行json扩展 +### 单行json数组 ```{.yaml linenums="1"} a: [b, c, d]