Skip to content

Commit

Permalink
.vuepress: config: add missing hysteria2 pages and sync page list
Browse files Browse the repository at this point in the history
Add the missing Hysteria2 pages to the English documentation. Synchronise
the page list with the Chinese documentation. Add gRPC to
en_US/v5/config/stream.md and make other small improvements.

Signed-off-by: Arınç ÜNAL <[email protected]>
  • Loading branch information
arinc9 authored and xiaokangwang committed Oct 1, 2024
1 parent a7b5aa1 commit 0c95f43
Show file tree
Hide file tree
Showing 8 changed files with 32 additions and 11 deletions.
17 changes: 10 additions & 7 deletions docs/.vuepress/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -308,11 +308,11 @@ export default defineUserConfig({
'/en_US/config/protocols/trojan',
'/en_US/config/protocols/vless',
'/en_US/config/protocols/loopback',
'/en_US/config/protocols/hy2',
],
},
{
text: 'Transport',

children: [
'/en_US/config/transport/tcp',
'/en_US/config/transport/mkcp',
Expand All @@ -321,6 +321,7 @@ export default defineUserConfig({
'/en_US/config/transport/quic',
'/en_US/config/transport/domainsocket',
'/en_US/config/transport/grpc',
'/en_US/config/transport/hy2',
],
},
{
Expand Down Expand Up @@ -374,19 +375,20 @@ export default defineUserConfig({
{
text: 'Proxy Protocol',
children: [
'/en_US/v5/config/proxy/blackhole',
'/en_US/v5/config/proxy/dns',
'/en_US/v5/config/proxy/dokodemo',
'/en_US/v5/config/proxy/freedom',
'/en_US/v5/config/proxy/http',
'/en_US/v5/config/proxy/socks',
'/en_US/v5/config/proxy/vmess',
'/en_US/v5/config/proxy/vlite',
'/en_US/v5/config/proxy/shadowsocks',
'/en_US/v5/config/proxy/shadowsocks2022',
'/en_US/v5/config/proxy/http',
'/en_US/v5/config/proxy/dokodemo',
'/en_US/v5/config/proxy/freedom',
'/en_US/v5/config/proxy/loopback',
'/en_US/v5/config/proxy/blackhole',
'/en_US/v5/config/proxy/dns',
'/en_US/v5/config/proxy/trojan',
'/en_US/v5/config/proxy/hy2',
'/en_US/v5/config/proxy/vless',
'/en_US/v5/config/proxy/loopback',
],
},
{
Expand All @@ -399,6 +401,7 @@ export default defineUserConfig({
'/en_US/v5/config/stream/quic',
'/en_US/v5/config/stream/meek',
'/en_US/v5/config/stream/httpupgrade',
'/en_US/v5/config/stream/hy2',
],
},
{
Expand Down
3 changes: 3 additions & 0 deletions docs/en_US/config/protocols/hy2.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Hysteria2

The documentation for this page is missing. Please submit a [pull request](https://github.com/v2fly/v2fly-github-io/pulls) or refer to the Chinese documentation.
3 changes: 3 additions & 0 deletions docs/en_US/config/transport/hy2.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Hysteria2

The documentation for this page is missing. Please submit a [pull request](https://github.com/v2fly/v2fly-github-io/pulls) or refer to the Chinese documentation.
2 changes: 2 additions & 0 deletions docs/en_US/config/transport/websocket.md
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
# WebSocket

The documentation for this page is missing. Please submit a [pull request](https://github.com/v2fly/v2fly-github-io/pulls) or refer to the Chinese documentation.
3 changes: 3 additions & 0 deletions docs/en_US/v5/config/proxy/hy2.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Hysteria2

The documentation for this page is missing. Please submit a [pull request](https://github.com/v2fly/v2fly-github-io/pulls) or refer to the Chinese documentation.
10 changes: 7 additions & 3 deletions docs/en_US/v5/config/stream.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,17 @@ It has to be one of supported Security Protocol.
> `socketSettings`: [SocketConfigObject](#socketconfigobject)
### Supported Streams
## Supported Streams

* [TCP](stream/tcp.md)
* [WebSocket](stream/websocket.md)
* [mKCP](stream/kcp.md)
* [tcp](stream/tcp.md)
* [gRPC](stream/grpc.md)
* [QUIC](stream/quic.md)
* [meek](stream/meek.md)
* [httpupgrade](stream/httpupgrade.md)
* [Hysteria2](stream/hy2.md)


## TLS
* Name: `tls`
Expand Down Expand Up @@ -59,7 +62,8 @@ This option allow TLS certificate verification to be turned off if the `pinnedPe

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

### CertificateObject

> `usage` : string
Expand Down
3 changes: 3 additions & 0 deletions docs/en_US/v5/config/stream/hy2.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Hysteria2

The documentation for this page is missing. Please submit a [pull request](https://github.com/v2fly/v2fly-github-io/pulls) or refer to the Chinese documentation.
2 changes: 1 addition & 1 deletion docs/v5/config/stream.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,9 @@
## 支持的传输流协议

* [mKCP](stream/kcp.md)
* [TCP](stream/tcp.md)
* [WebSocket](stream/websocket.md)
* [mKCP](stream/kcp.md)
* [gRPC](stream/grpc.md)
* [QUIC](stream/quic.md)
* [meek](stream/meek.md)
Expand Down

0 comments on commit 0c95f43

Please sign in to comment.