mirror of
https://github.com/XTLS/Xray-docs-next.git
synced 2026-10-11 00:38:18 +03:00
Development Guide: Reorganize navigation and section indexes
This commit is contained in:
Meow
@@ -61,8 +61,19 @@ export const nav: DefaultTheme.Config["nav"] = [
|
||||
},
|
||||
{
|
||||
text: "Developer Guide",
|
||||
link: "/en/development/",
|
||||
activeMatch: "^/en/development/"
|
||||
activeMatch: "^/en/development/",
|
||||
items: [
|
||||
{
|
||||
text: "Development Basics",
|
||||
link: "/en/development/intro/",
|
||||
activeMatch: "^/en/development/intro/"
|
||||
},
|
||||
{
|
||||
text: "Protocol Details",
|
||||
link: "/en/development/protocols/",
|
||||
activeMatch: "^/en/development/protocols/"
|
||||
}
|
||||
]
|
||||
},
|
||||
{ text: "Sponsor & Donation & NFTs", link: "/en/about/sponsor.md" }
|
||||
]
|
||||
|
||||
@@ -61,8 +61,19 @@ export const nav: DefaultTheme.Config["nav"] = [
|
||||
},
|
||||
{
|
||||
text: "开发指南",
|
||||
link: "/development/",
|
||||
activeMatch: "^/development/"
|
||||
activeMatch: "^/development/",
|
||||
items: [
|
||||
{
|
||||
text: "开发入门",
|
||||
link: "/development/intro/",
|
||||
activeMatch: "^/development/intro/"
|
||||
},
|
||||
{
|
||||
text: "协议详解",
|
||||
link: "/development/protocols/",
|
||||
activeMatch: "^/development/protocols/"
|
||||
}
|
||||
]
|
||||
},
|
||||
{ text: "赞助 & 捐款 & NFTs", link: "/about/sponsor.md" }
|
||||
]
|
||||
|
||||
@@ -61,8 +61,19 @@ export const nav: DefaultTheme.Config["nav"] = [
|
||||
},
|
||||
{
|
||||
text: "Руководство разработчика",
|
||||
link: "/ru/development/",
|
||||
activeMatch: "^/ru/development/"
|
||||
activeMatch: "^/ru/development/",
|
||||
items: [
|
||||
{
|
||||
text: "Основы разработки",
|
||||
link: "/ru/development/intro/",
|
||||
activeMatch: "^/ru/development/intro/"
|
||||
},
|
||||
{
|
||||
text: "Детали протоколов",
|
||||
link: "/ru/development/protocols/",
|
||||
activeMatch: "^/ru/development/protocols/"
|
||||
}
|
||||
]
|
||||
},
|
||||
{ text: "Sponsor & Donation & NFTs", link: "/ru/about/sponsor.md" }
|
||||
]
|
||||
|
||||
@@ -282,8 +282,8 @@ export const sidebar: DefaultTheme.Config["sidebar"] = {
|
||||
],
|
||||
"/en/development/": [
|
||||
{
|
||||
text: "Development Guide",
|
||||
link: "/en/development/",
|
||||
text: "Development Basics",
|
||||
link: "/en/development/intro/",
|
||||
collapsed: true,
|
||||
items: [
|
||||
{ text: "Compilation", link: "/en/development/intro/compile.md" },
|
||||
@@ -296,7 +296,8 @@ export const sidebar: DefaultTheme.Config["sidebar"] = {
|
||||
},
|
||||
{
|
||||
text: "Protocol Details",
|
||||
collapsed: false,
|
||||
link: "/en/development/protocols/",
|
||||
collapsed: true,
|
||||
items: [
|
||||
{
|
||||
text: "VLESS Protocol",
|
||||
|
||||
@@ -249,8 +249,8 @@ export const sidebar: DefaultTheme.Config["sidebar"] = {
|
||||
],
|
||||
"/development/": [
|
||||
{
|
||||
text: "开发指南",
|
||||
link: "/development/",
|
||||
text: "开发入门",
|
||||
link: "/development/intro/",
|
||||
collapsed: true,
|
||||
items: [
|
||||
{ text: "编译", link: "/development/intro/compile.md" },
|
||||
@@ -260,7 +260,8 @@ export const sidebar: DefaultTheme.Config["sidebar"] = {
|
||||
},
|
||||
{
|
||||
text: "协议详解",
|
||||
collapsed: false,
|
||||
link: "/development/protocols/",
|
||||
collapsed: true,
|
||||
items: [
|
||||
{ text: "VLESS 协议", link: "/development/protocols/vless.md" },
|
||||
{ text: "VMess 协议", link: "/development/protocols/vmess.md" },
|
||||
|
||||
@@ -309,8 +309,8 @@ export const sidebar: DefaultTheme.Config["sidebar"] = {
|
||||
],
|
||||
"/ru/development/": [
|
||||
{
|
||||
text: "Руководство разработчика",
|
||||
link: "/ru/development/",
|
||||
text: "Основы разработки",
|
||||
link: "/ru/development/intro/",
|
||||
collapsed: true,
|
||||
items: [
|
||||
{
|
||||
@@ -329,7 +329,8 @@ export const sidebar: DefaultTheme.Config["sidebar"] = {
|
||||
},
|
||||
{
|
||||
text: "Детали протоколов",
|
||||
collapsed: false,
|
||||
link: "/ru/development/protocols/",
|
||||
collapsed: true,
|
||||
items: [
|
||||
{
|
||||
text: "Протокол VLESS",
|
||||
|
||||
@@ -1,41 +0,0 @@
|
||||
# 开发指南
|
||||
|
||||
## 编译文档
|
||||
|
||||
Xray 支持各种平台, 您可以在多种平台上自行进行交叉编译。
|
||||
|
||||
请点击[编译文档](./intro/compile.md)以查看具体编译相关内容。
|
||||
|
||||
## 设计思路
|
||||
|
||||
Xray 内核提供了一个平台，在其之上可以进二次开发。
|
||||
|
||||
这个章节阐述了 Xray 的设计目标和架构。
|
||||
|
||||
请点击[设计思路](./intro/design.md)以了解 Xray 的设计目标和架构。
|
||||
|
||||
## 开发规范
|
||||
|
||||
这个章节阐述了获取代码,进行开发,提交 PR 的流程中需要遵循的准则, 以及相关的编码规范。
|
||||
|
||||
请点击[开发规范](./intro/guide.md)查看 Xray 开发中应遵循的准则。
|
||||
|
||||
## 协议详解
|
||||
|
||||
Xray 用到了很多种协议, 您可以通过各种途径获得协议的详细描述。
|
||||
|
||||
### [VLESS 协议](./protocols/vless.md)
|
||||
|
||||
VLESS 是一个无状态的轻量传输协议，可以作为 Xray 客户端和服务器之间的桥梁。
|
||||
|
||||
### [VMess 协议](./protocols/vmess.md)
|
||||
|
||||
VMess 是一个加密传输协议，可以作为 Xray 客户端和服务器之间的桥梁。
|
||||
|
||||
### [Mux.Cool 协议](./protocols/muxcool.md)
|
||||
|
||||
Mux.Cool 协议是一个多路复用传输协议，用于在一条已建立的数据流中传输多个各自独立的数据流。
|
||||
|
||||
### [mKCP 协议](./protocols/mkcp.md)
|
||||
|
||||
mKCP 是流式传输协议，由 [KCP 协议](https://github.com/skywind3000/kcp)修改而来，可以按顺序传输任意的数据流。
|
||||
@@ -0,0 +1,21 @@
|
||||
# 开发入门
|
||||
|
||||
## 编译文档
|
||||
|
||||
Xray 支持各种平台, 您可以在多种平台上自行进行交叉编译。
|
||||
|
||||
请点击[编译文档](./compile.md)以查看具体编译相关内容。
|
||||
|
||||
## 设计思路
|
||||
|
||||
Xray 内核提供了一个平台，在其之上可以进二次开发。
|
||||
|
||||
这个章节阐述了 Xray 的设计目标和架构。
|
||||
|
||||
请点击[设计思路](./design.md)以了解 Xray 的设计目标和架构。
|
||||
|
||||
## 开发规范
|
||||
|
||||
这个章节阐述了获取代码,进行开发,提交 PR 的流程中需要遵循的准则, 以及相关的编码规范。
|
||||
|
||||
请点击[开发规范](./guide.md)查看 Xray 开发中应遵循的准则。
|
||||
@@ -0,0 +1,19 @@
|
||||
# 协议详解
|
||||
|
||||
Xray 用到了很多种协议, 您可以通过各种途径获得协议的详细描述。
|
||||
|
||||
## [VLESS 协议](./vless.md)
|
||||
|
||||
VLESS 是一个无状态的轻量传输协议，可以作为 Xray 客户端和服务器之间的桥梁。
|
||||
|
||||
## [VMess 协议](./vmess.md)
|
||||
|
||||
VMess 是一个加密传输协议，可以作为 Xray 客户端和服务器之间的桥梁。
|
||||
|
||||
## [Mux.Cool 协议](./muxcool.md)
|
||||
|
||||
Mux.Cool 协议是一个多路复用传输协议，用于在一条已建立的数据流中传输多个各自独立的数据流。
|
||||
|
||||
## [mKCP 协议](./mkcp.md)
|
||||
|
||||
mKCP 是流式传输协议，由 [KCP 协议](https://github.com/skywind3000/kcp)修改而来，可以按顺序传输任意的数据流。
|
||||
@@ -1,41 +0,0 @@
|
||||
# Development Guide
|
||||
|
||||
## Compilation Documentation
|
||||
|
||||
Xray supports a wide range of platforms, allowing you to perform cross-compilation on various systems yourself.
|
||||
|
||||
Please click [Compilation Documentation](./intro/compile.md) to view specific compilation-related content.
|
||||
|
||||
## Design Philosophy
|
||||
|
||||
The Xray kernel provides a platform upon which secondary development can be conducted.
|
||||
|
||||
This chapter expounds on Xray's design goals and architecture.
|
||||
|
||||
Please click [Design Philosophy](./intro/design.md) to understand Xray's design goals and architecture.
|
||||
|
||||
## Development Guidelines
|
||||
|
||||
This chapter explains the guidelines to follow during the process of obtaining code, conducting development, and submitting PRs, as well as relevant coding conventions.
|
||||
|
||||
Please click [Development Guidelines](./intro/guide.md) to view the criteria to be followed in Xray development.
|
||||
|
||||
## Protocol Details
|
||||
|
||||
Xray utilizes many types of protocols. You can obtain detailed descriptions of these protocols through various channels.
|
||||
|
||||
### [VLESS Protocol](./protocols/vless.md)
|
||||
|
||||
VLESS is a stateless lightweight transport protocol that can serve as a bridge between Xray clients and servers.
|
||||
|
||||
### [VMess Protocol](./protocols/vmess.md)
|
||||
|
||||
VMess is an encrypted transport protocol that can serve as a bridge between Xray clients and servers.
|
||||
|
||||
### [Mux.Cool Protocol](./protocols/muxcool.md)
|
||||
|
||||
The Mux.Cool protocol is a multiplexing transport protocol used to transmit multiple independent data streams within a single established data stream.
|
||||
|
||||
### [mKCP Protocol](./protocols/mkcp.md)
|
||||
|
||||
mKCP is a stream transport protocol, modified from the [KCP Protocol](https://github.com/skywind3000/kcp), capable of transmitting arbitrary data streams in order.
|
||||
@@ -0,0 +1,21 @@
|
||||
# Development Basics
|
||||
|
||||
## Compilation Documentation
|
||||
|
||||
Xray supports a wide range of platforms, allowing you to perform cross-compilation on various systems yourself.
|
||||
|
||||
Please click [Compilation Documentation](./compile.md) to view specific compilation-related content.
|
||||
|
||||
## Design Philosophy
|
||||
|
||||
The Xray kernel provides a platform upon which secondary development can be conducted.
|
||||
|
||||
This chapter expounds on Xray's design goals and architecture.
|
||||
|
||||
Please click [Design Philosophy](./design.md) to understand Xray's design goals and architecture.
|
||||
|
||||
## Development Guidelines
|
||||
|
||||
This chapter explains the guidelines to follow during the process of obtaining code, conducting development, and submitting PRs, as well as relevant coding conventions.
|
||||
|
||||
Please click [Development Guidelines](./guide.md) to view the criteria to be followed in Xray development.
|
||||
@@ -0,0 +1,19 @@
|
||||
# Protocol Details
|
||||
|
||||
Xray utilizes many types of protocols. You can obtain detailed descriptions of these protocols through various channels.
|
||||
|
||||
## [VLESS Protocol](./vless.md)
|
||||
|
||||
VLESS is a stateless lightweight transport protocol that can serve as a bridge between Xray clients and servers.
|
||||
|
||||
## [VMess Protocol](./vmess.md)
|
||||
|
||||
VMess is an encrypted transport protocol that can serve as a bridge between Xray clients and servers.
|
||||
|
||||
## [Mux.Cool Protocol](./muxcool.md)
|
||||
|
||||
The Mux.Cool protocol is a multiplexing transport protocol used to transmit multiple independent data streams within a single established data stream.
|
||||
|
||||
## [mKCP Protocol](./mkcp.md)
|
||||
|
||||
mKCP is a stream transport protocol, modified from the [KCP Protocol](https://github.com/skywind3000/kcp), capable of transmitting arbitrary data streams in order.
|
||||
@@ -1,41 +0,0 @@
|
||||
# Руководство по разработке
|
||||
|
||||
## Сборка документации
|
||||
|
||||
Xray поддерживает различные платформы, и вы можете самостоятельно выполнить кросс-компиляцию на многих из них.
|
||||
|
||||
Перейдите в [документацию по сборке](./intro/compile.md), чтобы узнать больше о процессе сборки.
|
||||
|
||||
## Принципы проектирования
|
||||
|
||||
Ядро Xray предоставляет платформу, на основе которой можно выполнять дальнейшую разработку.
|
||||
|
||||
В этом разделе описываются цели проектирования и архитектура Xray.
|
||||
|
||||
Перейдите в раздел [Принципы проектирования](./intro/design.md), чтобы узнать больше о целях проектирования и архитектуре Xray.
|
||||
|
||||
## Правила разработки
|
||||
|
||||
В этом разделе описываются правила, которым необходимо следовать при получении кода, разработке и отправке запросов на включение изменений (pull request), а также соответствующие стандарты кодирования.
|
||||
|
||||
Перейдите в раздел [Правила разработки](./intro/guide.md), чтобы ознакомиться с правилами, которых следует придерживаться при разработке Xray.
|
||||
|
||||
## Подробное описание протоколов
|
||||
|
||||
Xray использует множество различных протоколов, и вы можете получить их подробное описание различными способами.
|
||||
|
||||
### [Протокол VLESS](./protocols/vless.md)
|
||||
|
||||
VLESS - это легковесный транспортный протокол без сохранения состояния, который может служить мостом между клиентом и сервером Xray.
|
||||
|
||||
### [Протокол VMess](./protocols/vmess.md)
|
||||
|
||||
VMess - это зашифрованный транспортный протокол, который может служить мостом между клиентом и сервером Xray.
|
||||
|
||||
### [Протокол Mux.Cool](./protocols/muxcool.md)
|
||||
|
||||
Протокол Mux.Cool - это транспортный протокол мультиплексирования, который используется для передачи нескольких независимых потоков данных по одному установленному потоку данных.
|
||||
|
||||
### [Протокол mKCP](./protocols/mkcp.md)
|
||||
|
||||
mKCP - это потоковый транспортный протокол, основанный на [протоколе KCP](https://github.com/skywind3000/kcp), который может передавать любые потоки данных по порядку.
|
||||
@@ -0,0 +1,21 @@
|
||||
# Основы разработки
|
||||
|
||||
## Сборка документации
|
||||
|
||||
Xray поддерживает различные платформы, и вы можете самостоятельно выполнить кросс-компиляцию на многих из них.
|
||||
|
||||
Перейдите в [документацию по сборке](./compile.md), чтобы узнать больше о процессе сборки.
|
||||
|
||||
## Принципы проектирования
|
||||
|
||||
Ядро Xray предоставляет платформу, на основе которой можно выполнять дальнейшую разработку.
|
||||
|
||||
В этом разделе описываются цели проектирования и архитектура Xray.
|
||||
|
||||
Перейдите в раздел [Принципы проектирования](./design.md), чтобы узнать больше о целях проектирования и архитектуре Xray.
|
||||
|
||||
## Правила разработки
|
||||
|
||||
В этом разделе описываются правила, которым необходимо следовать при получении кода, разработке и отправке запросов на включение изменений (pull request), а также соответствующие стандарты кодирования.
|
||||
|
||||
Перейдите в раздел [Правила разработки](./guide.md), чтобы ознакомиться с правилами, которых следует придерживаться при разработке Xray.
|
||||
@@ -0,0 +1,19 @@
|
||||
# Детали протоколов
|
||||
|
||||
Xray использует множество различных протоколов, и вы можете получить их подробное описание различными способами.
|
||||
|
||||
## [Протокол VLESS](./vless.md)
|
||||
|
||||
VLESS - это легковесный транспортный протокол без сохранения состояния, который может служить мостом между клиентом и сервером Xray.
|
||||
|
||||
## [Протокол VMess](./vmess.md)
|
||||
|
||||
VMess - это зашифрованный транспортный протокол, который может служить мостом между клиентом и сервером Xray.
|
||||
|
||||
## [Протокол Mux.Cool](./muxcool.md)
|
||||
|
||||
Протокол Mux.Cool - это транспортный протокол мультиплексирования, который используется для передачи нескольких независимых потоков данных по одному установленному потоку данных.
|
||||
|
||||
## [Протокол mKCP](./mkcp.md)
|
||||
|
||||
mKCP - это потоковый транспортный протокол, основанный на [протоколе KCP](https://github.com/skywind3000/kcp), который может передавать любые потоки данных по порядку.
|
||||
Reference in New Issue
Block a user