Skip to content

Commit

Permalink
treewide: lowercase anchor links
Browse files Browse the repository at this point in the history
Anchor links must be lowercase to match the fragment. Therefore, lowercase
all anchor links. The modification was made by running the command below.

find config v5 en_US -type f -exec sed -i 's/(#\([^)]*\))/\L(#\1)/g' {} +

Fix the incorrect anchor link on docs/en_US/config/api.md.

Signed-off-by: Arınç ÜNAL <[email protected]>
  • Loading branch information
arinc9 authored and xiaokangwang committed Sep 1, 2024
1 parent 47d27ac commit cd69da0
Show file tree
Hide file tree
Showing 22 changed files with 63 additions and 63 deletions.
2 changes: 1 addition & 1 deletion docs/en_US/config/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Outbound proxy ID.

> `services`: \[string\]
The list of available APIs, see [API list](#Supported-api-list) for details.
The list of available APIs, see [API list](#list-of-supported-apis) for details.

## List of supported APIs

Expand Down
6 changes: 3 additions & 3 deletions docs/en_US/v5/config/dns.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,11 @@ When a domain name list assigned by a DNS server matches the domain name current

![](/dns_flowchart_20210418.svg)

> `nameServer`: [ [NameServerObject](#NameServerObject) ]
> `nameServer`: [ [NameServerObject](#nameserverobject) ]
A list of name servers.

> `staticHosts`: [ [StaticHostsObject](#StaticHostsObject) ]
> `staticHosts`: [ [StaticHostsObject](#statichostsobject) ]
Host Mapping rules. This can be used to manually define DNS resolution results or transform DNS resolutions.

Expand Down Expand Up @@ -69,7 +69,7 @@ The client IP address indication send to the DNS Server. The server may return a
Prevent fallback to this DNS Server.

> `prioritizedDomain`: [ [PrioritizedDomainObject](#PrioritizedDomainObject) ]
> `prioritizedDomain`: [ [PrioritizedDomainObject](#prioritizeddomainobject) ]
The domains that should be send to this server. If the domain being queried match one of the specification, then the query will be send to this server first.

Expand Down
4 changes: 2 additions & 2 deletions docs/en_US/v5/config/geo.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## GeoIP

> `cidr` : [CIDRObject](#CIDRObject)
> `cidr` : [CIDRObject](#cidrobject)
> `inverseMatch` : true | false
Expand All @@ -19,7 +19,7 @@
## GeoDomain

> `domain` : [DomainObject](#DomainObject)
> `domain` : [DomainObject](#domainobject)
> `code`: string
Expand Down
2 changes: 1 addition & 1 deletion docs/en_US/v5/config/inbound.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ The listening IP address for the inbound.
The Tag of the inbound. This is used as an identifier for outbounds.

> `sniffing`: [SniffingObject](#SniffingObject)
> `sniffing`: [SniffingObject](#sniffingobject)
The sniffing settings for the inbound. It allows the connection to be routed based on its content and metadata.

Expand Down
4 changes: 2 additions & 2 deletions docs/en_US/v5/config/outbound.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,11 +35,11 @@ The Tag of the outbound. This is used as an identifier for outbounds.
The stream settings for the outbound. This determine how the protocol data is transferred.

> `proxySettings`: [ProxyObject](#ProxyObject)
> `proxySettings`: [ProxyObject](#proxyobject)
Forward Proxy(Proxy Chaining) settings.

> `mux`: [MuxObject](#MuxObject)
> `mux`: [MuxObject](#muxobject)
Connection multiplexor settings.

Expand Down
4 changes: 2 additions & 2 deletions docs/en_US/v5/config/proxy/shadowsocks.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

> `method` : string
Encryption method,one of [supported encryption methods](#Supported Encryption Methods) .
Encryption method,one of [supported encryption methods](#supported encryption methods) .

> `password`: string
Expand Down Expand Up @@ -48,7 +48,7 @@ The server port number.

> `method` : string
Encryption method,one of [supported encryption methods](#Supported Encryption Methods) .
Encryption method,one of [supported encryption methods](#supported encryption methods) .

> `password`: string
Expand Down
4 changes: 2 additions & 2 deletions docs/en_US/v5/config/router.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ service.router

> `domainStrategy`: `AsIs` | `UseIp` | `IpIfNonMatch` | `IpOnDemand`
> `rule`: [ [RuleObject](#RuleObject) ]
> `rule`: [ [RuleObject](#ruleobject) ]
> `balancingRule`: [ [BalancingRuleObject](#BalancingRuleObject) ]
> `balancingRule`: [ [BalancingRuleObject](#balancingruleobject) ]
## RuleObject

Expand Down
2 changes: 1 addition & 1 deletion docs/en_US/v5/config/service/burstObservatory.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
The selectors for outbound under observation

>`pingConfig`: [PingConfigObject](#PingConfigObject)
>`pingConfig`: [PingConfigObject](#pingconfigobject)

### PingConfigObject
Expand Down
20 changes: 10 additions & 10 deletions docs/en_US/v5/config/service/policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,17 @@

### Policy

> `system`: [SystemPolicyObject](#SystemPolicyObject)
> `system`: [SystemPolicyObject](#systempolicyobject)
The system level policies that determine the global level policies applied everywhere.

> `level`: map of [PolicyObject](#PolicyObject)
> `level`: map of [PolicyObject](#policyobject)
The level based policy.

### SystemPolicyObject

> `stats`: [StatsObject](#StatsObject)
> `stats`: [StatsObject](#statsobject)
The stats settings.

Expand All @@ -40,21 +40,21 @@ Whether the download data count from outbound should be recorded.

### PolicyObject

> `timeout`: [TimeoutPolicyObject](#TimeoutPolicyObject)
> `timeout`: [TimeoutPolicyObject](#timeoutpolicyobject)
> `stats`: [PolicyStatsObject](#PolicyStatsObject)
> `stats`: [PolicyStatsObject](#policystatsobject)
> `buffer`: [BufferPolicyObject](#BufferPolicyObject)
> `buffer`: [BufferPolicyObject](#bufferpolicyobject)
### TimeoutPolicyObject

> `handshake`: [SecondObject](#SecondObject)
> `handshake`: [SecondObject](#secondobject)
> `connectionIdle`: [SecondObject](#SecondObject)
> `connectionIdle`: [SecondObject](#secondobject)
> `uplinkOnly`: [SecondObject](#SecondObject)
> `uplinkOnly`: [SecondObject](#secondobject)
> `downlinkOnly`: [SecondObject](#SecondObject)
> `downlinkOnly`: [SecondObject](#secondobject)
### SecondObject

Expand Down
4 changes: 2 additions & 2 deletions docs/en_US/v5/config/service/tun.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,11 @@ The mtu of the tun interface. The recommanded value is 1500.
The inbound tag associated with tun generated traffic.

> `ips`: [ [IPObject](#IPObject) ]
> `ips`: [ [IPObject](#ipobject) ]
The ip address associated with tun. You will need to add them to tun on the operating system side as well.

> `routes`: [ [RouteObject](#RouteObject) ]
> `routes`: [ [RouteObject](#routeobject) ]
The routes associated with tun. You will need to add them to tun on the operating system side as well.

Expand Down
6 changes: 3 additions & 3 deletions docs/en_US/v5/config/stream.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ It has to be one of supported Security Protocol.

> `securitySettings`: settings of `<security>`
> `socketSettings`: [SocketConfigObject](#SocketConfigObject)
> `socketSettings`: [SocketConfigObject](#socketconfigobject)
### Supported Streams

Expand Down Expand Up @@ -51,7 +51,7 @@ Whether system level Certificate Authority Store should be trusted.
Pinned Peer Certificate Chain SHA256 Hash. Should be represented in base64 format.

> `certificate`: [[CertificateObject](#CertificateObject)]
> `certificate`: [[CertificateObject](#certificateobject)]

# CertificateObject
Expand Down Expand Up @@ -97,7 +97,7 @@ uTLS is supported in the following transports:

When you are using uTLS in some transport, the APLN will be overridden for its correct function. It may be a slightly different fingerprint than specified.

> `tlsConfig`: [TLSConfig](#TLS)
> `tlsConfig`: [TLSConfig](#tls)
The Embedded TLS Setting for uTLS connections. Only some of its field are effective.

Expand Down
2 changes: 1 addition & 1 deletion docs/en_US/v5/config/stream/websocket.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Whether to enable browser forwarder.
The header name for WebSocket Early Data. If not set, the early data will be send through path.

> 'header': [ [Header](#Header) ]
> 'header': [ [Header](#header) ]
The header to be sent in HTTP request.

Expand Down
20 changes: 10 additions & 10 deletions docs/v5/config/dns.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ DNS 处理流程示意图如下:
}
```

> `nameServer`: [ [NameServerObject](#NameServerObject) ]
> `nameServer`: [ [NameServerObject](#nameserverobject) ]
DNS 服务器列表。

Expand All @@ -144,15 +144,15 @@ DNS 服务器列表。
此功能需要 DNS 服务器支持 EDNS Client Subnet(RFC7871)。
:::

> `staticHosts`: [ [HostMappingObject](#HostMappingObject) ]
> `staticHosts`: [ [HostMappingObject](#hostmappingobject) ]
静态域名映射。

:::tip
当地址中同时设置了多个 IP 和域名,则只会返回第一个域名,其余 IP 和域名均被忽略。【TODO】
:::

> `fakeDns`: [FakeDnsObject](#FakeDnsObject)
> `fakeDns`: [FakeDnsObject](#fakednsobject)
FakeDNS 公共配置,当 `nameServer``address``fakedns` 且无 `fakeDNS` 配置时,使用此配置。(v5.2.0+)

Expand Down Expand Up @@ -246,7 +246,7 @@ DNS 回退(fallback)查询策略。默认为 `Enabled`,即启用 DNS 回
}
```

> `address`: [EndpointObject](#EndpointObject)
> `address`: [EndpointObject](#endpointobject)
DNS 服务器地址。

Expand All @@ -270,17 +270,17 @@ DNS 服务器地址。
如果 [DnsObject](#dnsobject) 中的 `disableFallback` 设置为 `true`,则本选项不会生效。
:::

> `prioritizedDomain`: \[ [PriorityDomainObject](#PriorityDomainObject) ]
> `prioritizedDomain`: \[ [PriorityDomainObject](#prioritydomainobject) ]
一个域名列表,此列表包含的域名,将优先使用此服务器进行查询。

> `expectIPs`:\[ [GeoIPObject](#GeoIPObject) ]
> `expectIPs`:\[ [GeoIPObject](#geoipobject) ]
一个 IP 范围列表。

当配置此项时,V2Ray DNS 会对返回的 IP 进行校验,只返回满足 expectIPs 列表的地址。如果未配置此项,会原样返回 IP 地址。

> `fakeDns`: [FakeDnsObject](#FakeDnsObject)
> `fakeDns`: [FakeDnsObject](#fakednsobject)
FakeDNS 配置,当该项配置时,FakeDNS 启用。当该项未被配置但 `address` 配置为 `fakedns` 时则使用上级公共配置。(v5.2.0+)

Expand Down Expand Up @@ -364,7 +364,7 @@ DNS 服务器端口,如 `53`。此项缺省时默认为 `53`。当使用 DOH
从文件中加载 IP 时,所指定的文件路径。默认值为 `geoip.dat`

> `cidr`: [ [CIDRObject](#CIDRObject) ]
> `cidr`: [ [CIDRObject](#cidrobject) ]
[CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing):形如 `10.0.0.0/8`

Expand Down Expand Up @@ -412,7 +412,7 @@ IP 地址前缀匹配的长度,单位为比特。

> `domain`: string
`type` 所对应的 domain 值。格式与 [PriorityDomainObject](#PriorityDomainObject) 相同。
`type` 所对应的 domain 值。格式与 [PriorityDomainObject](#prioritydomainobject) 相同。

> `ip`: [ string ]
Expand Down Expand Up @@ -443,7 +443,7 @@ IP 地址前缀匹配的长度,单位为比特。
}
```

> `pools`: [ [PoolObject](#PoolObject) ]
> `pools`: [ [PoolObject](#poolobject) ]
IP 地址池配置。

Expand Down
4 changes: 2 additions & 2 deletions docs/v5/config/geo.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## GeoIP

> `cidr` : \[[CIDRObject](#CIDRObject)\]
> `cidr` : \[[CIDRObject](#cidrobject)\]
一个数组,数组中每一项是一个 [CIDR](https://zh.wikipedia.org/zh-hans/%E6%97%A0%E7%B1%BB%E5%88%AB%E5%9F%9F%E9%97%B4%E8%B7%AF%E7%94%B1) 地址块

Expand Down Expand Up @@ -30,7 +30,7 @@ CIDR 地址前缀。

## GeoDomain

> `domain` : [DomainObject](#DomainObject)
> `domain` : [DomainObject](#domainobject)
> `code`: string
Expand Down
2 changes: 1 addition & 1 deletion docs/v5/config/inbound.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ v4.32.0+,支持填写 Unix domain socket,格式为绝对路径,形如 `"/d
此入站连接的标识,用于在其它的配置中定位此连接。当其不为空时,其值必须在所有 `tag` 中唯一。

> `sniffing`: [SniffingObject](#SniffingObject)
> `sniffing`: [SniffingObject](#sniffingobject)
入站连接的流量探测设置。流量探测允许路由根据连接的内容和元数据转发连接。

Expand Down
4 changes: 2 additions & 2 deletions docs/v5/config/outbound.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,11 +38,11 @@ outbound
底层传输配置。

> `proxySettings`: [ProxyObject](#ProxyObject)
> `proxySettings`: [ProxyObject](#proxyobject)
出站代理配置。当出站代理生效时。

> `mux`: [MuxObject](#MuxObject)
> `mux`: [MuxObject](#muxobject)
Mux 配置。

Expand Down
4 changes: 2 additions & 2 deletions docs/v5/config/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,11 +66,11 @@
}
```

> `access`: [LogSpecObject](#LogSpecObject)
> `access`: [LogSpecObject](#logspecobject)
访问日志设置。

> `error`: [LogSpecObject](#LogSpecObject)
> `error`: [LogSpecObject](#logspecobject)
错误日志设置。

Expand Down
6 changes: 3 additions & 3 deletions docs/v5/config/router.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,11 @@ V2Ray 内建了一个路由模块,可以将入站数据按需求由不同的
* 解析后的 IP 仅在路由选择时起作用,转发的数据包中依然使用原始域名。
* `IpOnDemand`:当匹配时碰到任何基于 IP 的规则,立即将域名解析为 IP 进行匹配。

> `rule`: [ [RuleObject](#RuleObject) ]
> `rule`: [ [RuleObject](#ruleobject) ]
对应一个数组,数组中每一项是一个规则。对于每一个连接,路由将根据这些规则依次进行判断,当一个规则生效时,即将这个连接转发至它所指定的 `outboundTag``balancingTag`。当没有匹配到任何规则时,流量默认被转发至第一个 `outbound`

> `balancingRule`: [ [BalancingRuleObject](#BalancingRuleObject) ]
> `balancingRule`: [ [BalancingRuleObject](#balancingruleobject) ]
一个数组,数组中每一项是一个负载均衡器的配置。当一个规则指向一个负载均衡器时,V2Ray 会通过此负载均衡器选出一个 `outbound`,然后由它转发流量。

Expand Down Expand Up @@ -119,7 +119,7 @@ V2Ray 内建了一个路由模块,可以将入站数据按需求由不同的

可以填入的类型包括 `random``leastping` 以及 `leastload`

> strategySettings: [StrategySettingsObject](#StrategySettingsObject)
> strategySettings: [StrategySettingsObject](#strategysettingsobject)
> fallbackTag: string
Expand Down
2 changes: 1 addition & 1 deletion docs/v5/config/service/burstObservatory.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
一个字符串数组,其中每一个字符串将用于和出站协议标识的前缀匹配。在以下几个出站协议标识中:`[ "a", "ab", "c", "ba" ]``"subjectSelector": ["a"]` 将匹配到 `[ "a", "ab" ]`

>`pingConfig`: [PingConfigObject](#PingConfigObject)
>`pingConfig`: [PingConfigObject](#pingconfigobject)
### PingConfigObject

Expand Down
Loading

0 comments on commit cd69da0

Please sign in to comment.