mirror of
https://github.com/Rain-kl/OpenFlare.git
synced 2026-09-28 05:46:36 +08:00
[优化] 文档优化
This commit is contained in:
+19
-7
@@ -10,6 +10,7 @@ export default defineAdditionalConfig({
|
||||
sidebar: {
|
||||
'/guide/': { base: '/guide/', items: sidebarGuide() },
|
||||
'/reference/': { base: '/reference/', items: sidebarReference() },
|
||||
'/deployment/': { base: '/deployment/', items: sidebarDeployment() },
|
||||
'/design/': { base: '/design/', items: sidebarDesign() },
|
||||
'/changelog/': { base: '/changelog/', items: [] }
|
||||
},
|
||||
@@ -57,6 +58,7 @@ export default defineAdditionalConfig({
|
||||
function nav(): DefaultTheme.NavItem[] {
|
||||
return [
|
||||
{ text: '指南', link: '/guide/', activeMatch: '/guide/' },
|
||||
{ text: '部署', link: '/deployment/', activeMatch: '/deployment/' },
|
||||
{ text: '参考', link: '/reference/', activeMatch: '/reference/' },
|
||||
{ text: '设计', link: '/design/', activeMatch: '/design/' },
|
||||
{ text: '更新日志', link: '/changelog/', activeMatch: '/changelog/' }
|
||||
@@ -91,13 +93,6 @@ function sidebarReference(): DefaultTheme.SidebarItem[] {
|
||||
text: '参考',
|
||||
items: [
|
||||
{ text: '概览', link: '' },
|
||||
{ text: '系统架构', link: '../design/architecture' },
|
||||
{ text: '启动 Server', link: '../deployment/server' },
|
||||
{ text: '接入 Agent', link: '../deployment/agent' },
|
||||
{ text: '部署说明', link: '../deployment/deployment' },
|
||||
{ text: '部署 Relay (Tunnel)', link: '../deployment/relay' },
|
||||
{ text: '部署 OpenFlared', link: '../deployment/openflared' },
|
||||
{ text: '升级与维护', link: '../deployment/upgrade' },
|
||||
{ text: '配置项', link: 'configuration' },
|
||||
{ text: '命令与脚本', link: 'cli' },
|
||||
{ text: 'API 约定', link: 'api' }
|
||||
@@ -106,6 +101,23 @@ function sidebarReference(): DefaultTheme.SidebarItem[] {
|
||||
]
|
||||
}
|
||||
|
||||
function sidebarDeployment(): DefaultTheme.SidebarItem[] {
|
||||
return [
|
||||
{
|
||||
text: '部署',
|
||||
items: [
|
||||
{ text: '概览', link: '' },
|
||||
{ text: '部署说明', link: 'deployment' },
|
||||
{ text: '启动 Server', link: 'server' },
|
||||
{ text: '接入 Agent', link: 'agent' },
|
||||
{ text: '部署 Relay (Tunnel)', link: 'relay' },
|
||||
{ text: '部署 OpenFlared', link: 'openflared' },
|
||||
{ text: '升级与维护', link: 'upgrade' }
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
function sidebarDesign(): DefaultTheme.SidebarItem[] {
|
||||
return [
|
||||
{
|
||||
|
||||
@@ -9,4 +9,3 @@
|
||||
| [配置项](./configuration.md) | Server 环境变量、命令行参数、运行时 Option 与 Agent 配置字段 |
|
||||
| [命令与脚本](./cli.md) | 常用启动、构建、测试、安装和卸载命令 |
|
||||
| [仓库结构](../design/index.md#仓库结构) | `openflare_server`、`openflare_agent`、`openflare_relay`、`openflared` 模块的职责与分层目录说明 |
|
||||
| [部署与升级](../deployment/) | Server 与 Agent 的部署、配置与升级指南(见专属分区) |
|
||||
|
||||
Reference in New Issue
Block a user