OpenFlare/docs/config.ts

import {type DefaultTheme, defineAdditionalConfig} from 'vitepress'

export default defineAdditionalConfig({
  description:
    'OpenFlare 是轻量、自托管的 OpenResty 控制面，用于管理反向代理、配置发布、节点同步、TLS 证书与基础观测。',

  themeConfig: {
    nav: nav(),

    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: [] }
    },

    editLink: {
      pattern: 'https://github.com/Rain-kl/OpenFlare/edit/main/docs/:path',
      text: '在 GitHub 上编辑此页面'
    },

    footer: {
      message: '基于 Apache License 2.0 发布',
      copyright: 'Copyright © OpenFlare contributors'
    },

    docFooter: {
      prev: '上一页',
      next: '下一页'
    },

    outline: {
      label: '页面导航'
    },

    lastUpdated: {
      text: '最后更新于'
    },

    notFound: {
      title: '页面未找到',
      quote: '这份文档还没有对应页面。',
      linkLabel: '前往首页',
      linkText: '回到 OpenFlare 文档'
    },

    langMenuLabel: '语言',
    returnToTopLabel: '回到顶部',
    sidebarMenuLabel: '菜单',
    darkModeSwitchLabel: '主题',
    lightModeSwitchTitle: '切换到浅色模式',
    darkModeSwitchTitle: '切换到深色模式',
    skipToContentLabel: '跳转到内容'
  }
})

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/' }
  ]
}

function sidebarGuide(): DefaultTheme.SidebarItem[] {
  return [
    {
      text: '指南',
      items: [
        { text: '概览', link: '' },
        { text: '快速开始', link: 'quick-start' },
        { text: 'TLS 证书与自动续期', link: 'certificates' },
        { text: 'Zone 域名迁移', link: 'zone-domain-migration' },
        { text: '新建反代配置', link: 'proxy-config' },
        { text: 'Pages 静态托管使用', link: 'pages-usage' },
        { text: '内网穿透与隧道使用', link: 'tunnel-usage' },
        { text: 'WAF 安全防护使用', link: 'waf-usage' },
        { text: 'WAF 自动 IP 组语法', link: 'waf-ip-group-expr' },
        { text: 'Uptime Kuma 监控同步', link: 'uptime-kuma' },
        { text: 'SSO 登录配置', link: 'sso' },
        { text: '发布第一份配置', link: 'first-site' },
        { text: '故障排查', link: 'troubleshooting' },
        { text: '引用与致谢', link: 'credits' }
      ]
    }
  ]
}

function sidebarReference(): DefaultTheme.SidebarItem[] {
  return [
    {
      text: '参考',
      items: [
        { text: '概览', link: '' },
        { text: '配置项', link: 'configuration' },
        { text: '命令与脚本', link: 'cli' }
      ]
    }
  ]
}

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 [
    {
      text: '设计',
      items: [
        { text: '产品边界', link: '' },
        { text: '系统架构', link: 'architecture' },
        { text: 'Zone 与域名资源设计', link: 'zone-design' },
        { text: 'Agent 与发布模型', link: 'agent-design' },
        { text: '内网穿透隧道设计', link: 'tunnel-design' },
        { text: 'WAF 设计', link: 'waf-design' },
        { text: 'WAF 可编排规则设计', link: 'waf-orchestration-design' },
        { text: 'Pages 静态托管设计', link: 'pages-design' },
        { text: '边缘缓存策略设计', link: 'edge-cache-design' },
        { text: '边缘可观测与业务流量统计', link: 'observability-design' },
        { text: '观测数据传输模型', link: 'observability-transport-model' },
        { text: '观测上报协议与表结构', link: 'observability-data-model' },
        { text: 'Uptime Kuma 监控同步设计', link: 'kuma-design' },
        { text: '登录验证码设计', link: 'login-captcha' }
      ]
    }
  ]
}