Skip to content

Commit

Permalink
.vuepress: config: add all missing pages
Browse files Browse the repository at this point in the history
Add all the missing pages with the notice to either submit a pull request
for the missing documentation or refer to Chinese or English documentation.

Make small improvements on .vuepress/config.ts.

Signed-off-by: Arınç ÜNAL <[email protected]>
  • Loading branch information
arinc9 authored and xiaokangwang committed Sep 8, 2024
1 parent a989dce commit e5bc476
Show file tree
Hide file tree
Showing 27 changed files with 104 additions and 1 deletion.
29 changes: 28 additions & 1 deletion docs/.vuepress/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,8 @@ export default defineUserConfig({
'/developer/intro/compile',
'/developer/intro/design',
'/developer/intro/guide',
'/developer/intro/releasearchive',
'/developer/intro/releasesigning',
]
},
{
Expand Down Expand Up @@ -229,11 +231,12 @@ export default defineUserConfig({
},
},
'/en_US/': {
selectLanguageName: 'English',
selectLanguageText: '选择语言',
selectLanguageName: 'English',
selectLanguageAriaLabel: '选择语言',
editLinkText: 'Edit this page on GitHub',
lastUpdatedText: 'Last Updated',
contributorsText: 'Contributors',
navbar: [
{ text: 'Quick Start', link: '/en_US/guide/start', },
{ text: 'Config Reference', link: '/en_US/config/overview', },
Expand All @@ -255,12 +258,14 @@ export default defineUserConfig({
text: 'Concept',
children: [
'workflow',
'command',
],
},
{
text: 'More',
children: [
'faq',
'help',
],
},
],
Expand All @@ -269,12 +274,20 @@ export default defineUserConfig({
text: 'Config Reference',
children: [
'/en_US/config/overview',
'/en_US/config/env',
'/en_US/config/dns',
'/en_US/config/routing',
'/en_US/config/policy',
'/en_US/config/inbounds',
'/en_US/config/outbounds',
'/en_US/config/transport',
'/en_US/config/api',
'/en_US/config/stats',
'/en_US/config/reverse',
'/en_US/config/multiple_config',
'/en_US/config/fakedns',
'/en_US/config/browserforwarder',
'/en_US/config/observatory',
],
},
{
Expand All @@ -285,12 +298,25 @@ export default defineUserConfig({
'/en_US/config/protocols/dokodemo',
'/en_US/config/protocols/freedom',
'/en_US/config/protocols/http',
'/en_US/config/protocols/socks',
'/en_US/config/protocols/vmess',
'/en_US/config/protocols/shadowsocks',
'/en_US/config/protocols/trojan',
'/en_US/config/protocols/vless',
'/en_US/config/protocols/loopback',
],
},
{
text: 'Transport',

children: [
'/en_US/config/transport/tcp',
'/en_US/config/transport/mkcp',
'/en_US/config/transport/websocket',
'/en_US/config/transport/h2',
'/en_US/config/transport/quic',
'/en_US/config/transport/domainsocket',
'/en_US/config/transport/grpc',
],
},
{
Expand Down Expand Up @@ -322,6 +348,7 @@ export default defineUserConfig({
children: [
'/en_US/developer/protocols/vmess',
'/en_US/developer/protocols/mkcp',
'/en_US/developer/protocols/muxcool',
]
}
],
Expand Down
3 changes: 3 additions & 0 deletions docs/developer/intro/releasearchive.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Release Archive

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

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

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/env.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Environment variables

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/multiple_config.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Multiple config

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/observatory.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Observatory

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/policy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Policy

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/protocols/loopback.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Loopback

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/protocols/shadowsocks.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Shadowsocks

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/protocols/socks.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Socks

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/protocols/trojan.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Trojan

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/protocols/vless.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# VLESS

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/protocols/vmess.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# VMess

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/reverse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Reverse

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/routing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Routing

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/stats.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Stats

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/domainsocket.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# DomainSocket

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/grpc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# gRPC

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/h2.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# HTTP/2

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/mkcp.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# mKCP

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/quic.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# QUIC

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/tcp.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# TCP

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.
1 change: 1 addition & 0 deletions docs/en_US/config/transport/websocket.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
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/developer/protocols/muxcool.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Mux.Cool

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/guide/command.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Command line parameters

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/guide/help.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Ask for help

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.

0 comments on commit e5bc476

Please sign in to comment.