mirror of
https://github.com/Rain-kl/OpenFlare.git
synced 2026-10-11 09:46:37 +08:00
[优化] 更新文档
This commit is contained in:
+55
-20
@@ -2,7 +2,7 @@ import { defineAdditionalConfig, type DefaultTheme } from 'vitepress'
|
||||
|
||||
export default defineAdditionalConfig({
|
||||
description:
|
||||
'OpenFlare is a lightweight, self-hosted OpenResty control plane for reverse proxy rules, releases, node sync, TLS certificates, and basic observability.',
|
||||
'OpenFlare is a lightweight, self-hosted OpenResty control plane for managing reverse proxy rules, configuration publishing, node synchronization, TLS certificates, and basic observability.',
|
||||
|
||||
themeConfig: {
|
||||
nav: nav(),
|
||||
@@ -19,9 +19,37 @@ export default defineAdditionalConfig({
|
||||
},
|
||||
|
||||
footer: {
|
||||
message: 'Released under the Apache License 2.0.',
|
||||
message: 'Released under the Apache License 2.0',
|
||||
copyright: 'Copyright © OpenFlare contributors'
|
||||
}
|
||||
},
|
||||
|
||||
docFooter: {
|
||||
prev: 'Previous Page',
|
||||
next: 'Next Page'
|
||||
},
|
||||
|
||||
outline: {
|
||||
label: 'On this page'
|
||||
},
|
||||
|
||||
lastUpdated: {
|
||||
text: 'Last updated at'
|
||||
},
|
||||
|
||||
notFound: {
|
||||
title: 'Page Not Found',
|
||||
quote: 'This document does not have a corresponding page yet.',
|
||||
linkLabel: 'Go to Home',
|
||||
linkText: 'Back to OpenFlare Docs'
|
||||
},
|
||||
|
||||
langMenuLabel: 'Language',
|
||||
returnToTopLabel: 'Back to top',
|
||||
sidebarMenuLabel: 'Menu',
|
||||
darkModeSwitchLabel: 'Theme',
|
||||
lightModeSwitchTitle: 'Switch to light theme',
|
||||
darkModeSwitchTitle: 'Switch to dark theme',
|
||||
skipToContentLabel: 'Skip to content'
|
||||
}
|
||||
})
|
||||
|
||||
@@ -40,15 +68,14 @@ function sidebarGuide(): DefaultTheme.SidebarItem[] {
|
||||
items: [
|
||||
{ text: 'Overview', link: '' },
|
||||
{ text: 'Quick Start', link: 'quick-start' },
|
||||
{ text: 'Usage', link: 'usage' },
|
||||
{ text: 'Deployment', link: 'deployment' },
|
||||
{ text: 'SSO Login', link: 'sso' },
|
||||
{ text: 'Run Server', link: 'server' },
|
||||
{ text: 'Connect Agent', link: 'agent' },
|
||||
{ text: 'Publish First Site', link: 'first-site' },
|
||||
{ text: 'Upgrade and Maintenance', link: 'upgrade' },
|
||||
{ text: 'Local Development', link: 'development' },
|
||||
{ text: 'Troubleshooting', link: 'troubleshooting' }
|
||||
{ text: 'Basic Usage', link: 'usage' },
|
||||
{ text: 'Tunnel & Intranet Penetration', link: 'tunnel-usage' },
|
||||
{ text: 'WAF Security Protection', link: 'waf-usage' },
|
||||
{ text: 'WAF Auto IP Group Expressions', link: 'waf-ip-group-expr' },
|
||||
{ text: 'SSO Login Configuration', link: 'sso' },
|
||||
{ text: 'Publish First Configuration', link: 'first-site' },
|
||||
{ text: 'Troubleshooting', link: 'troubleshooting' },
|
||||
{ text: 'Credits', link: 'credits' }
|
||||
]
|
||||
}
|
||||
]
|
||||
@@ -60,10 +87,16 @@ function sidebarReference(): DefaultTheme.SidebarItem[] {
|
||||
text: 'Reference',
|
||||
items: [
|
||||
{ text: 'Overview', link: '' },
|
||||
{ text: 'Configuration', link: 'configuration' },
|
||||
{ text: 'Commands and Scripts', link: 'cli' },
|
||||
{ text: 'API Conventions', link: 'api' },
|
||||
{ text: 'Repository Layout', link: 'repository' }
|
||||
{ text: 'System Architecture', link: '../design/architecture' },
|
||||
{ text: 'Launch Server', link: '../deployment/server' },
|
||||
{ text: 'Access Agent', link: '../deployment/agent' },
|
||||
{ text: 'Deployment Guide', link: '../deployment/deployment' },
|
||||
{ text: 'Deploy Relay (Tunnel)', link: '../deployment/relay' },
|
||||
{ text: 'Deploy OpenFlared', link: '../deployment/openflared' },
|
||||
{ text: 'Upgrade & Maintenance', link: '../deployment/upgrade' },
|
||||
{ text: 'Configuration Options', link: 'configuration' },
|
||||
{ text: 'CLI Commands', link: 'cli' },
|
||||
{ text: 'API Conventions', link: 'api' }
|
||||
]
|
||||
}
|
||||
]
|
||||
@@ -74,10 +107,12 @@ function sidebarDesign(): DefaultTheme.SidebarItem[] {
|
||||
{
|
||||
text: 'Design',
|
||||
items: [
|
||||
{ text: 'Product Boundary', link: '' },
|
||||
{ text: 'Architecture', link: 'architecture' },
|
||||
{ text: 'Release Model', link: 'release-model' },
|
||||
{ text: 'Development Constraints', link: 'development' }
|
||||
{ text: 'Product Boundaries', link: '' },
|
||||
{ text: 'System Architecture', link: 'architecture' },
|
||||
{ text: 'Agent & Publish Model', link: 'agent-design' },
|
||||
{ text: 'Tunnel & Intranet Penetration', link: 'tunnel-design' },
|
||||
{ text: 'WAF Design', link: 'waf-design' },
|
||||
{ text: 'Repository Structure', link: 'repository' }
|
||||
]
|
||||
}
|
||||
]
|
||||
|
||||
Reference in New Issue
Block a user