chore: 初始化文档站仓库

2026-09-21 13:38:20 +08:00
commit a4ae7ac979
58 changed files with 4622 additions and 0 deletions
@@ -0,0 +1,137 @@
+import { defineConfig } from 'vitepress'
+
+export default defineConfig({
+  lang: 'zh-CN',
+  title: '收支管理系统',
+  description: '个人收支管理系统使用与开发文档',
+  head: [['link', { rel: 'icon', href: '/favicon.svg', type: 'image/svg+xml' }]],
+  lastUpdated: true,
+  cleanUrls: true,
+  ignoreDeadLinks: true,
+  // 维护类文档不参与站点构建
+  srcExclude: ['AGENTS.md'],
+  // 文档站默认端口从 5173 调整为 5175，把 5173 让给 finance-app 前端
+  vite: {
+    server: {
+      host: '0.0.0.0',
+      port: 5175,
+    },
+  },
+  themeConfig: {
+    logo: '/logo.svg',
+    nav: [
+      { text: '使用文档', link: '/guide/introduction', activeMatch: '/guide/' },
+      { text: '开发文档', link: '/dev/architecture', activeMatch: '/dev/' },
+    ],
+    sidebar: {
+      '/guide/': [
+        {
+          text: '开始使用',
+          items: [
+            { text: '项目简介', link: '/guide/introduction' },
+            { text: '快速开始', link: '/guide/getting-started' },
+            { text: '统计面板', link: '/guide/dashboard' },
+            { text: '页面总览', link: '/guide/pages' },
+          ],
+        },
+        {
+          text: '记账与整理',
+          items: [
+            { text: '收支记录', link: '/guide/transactions' },
+            { text: '分类与标签', link: '/guide/categories-tags' },
+            { text: '规则管理', link: '/guide/rules' },
+            { text: '邮箱账单', link: '/guide/email-bills' },
+          ],
+        },
+        {
+          text: '智能与自动化',
+          items: [
+            { text: 'AI 能力', link: '/guide/ai' },
+            { text: '定时提醒与通知', link: '/guide/notifications' },
+          ],
+        },
+        {
+          text: '系统',
+          items: [
+            { text: '系统设置', link: '/guide/settings' },
+            { text: '系统日志', link: '/guide/logs' },
+          ],
+        },
+        {
+          text: '账单获取',
+          items: [
+            { text: '账单类型总览', link: '/guide/bills/overview' },
+            { text: '支付宝账单', link: '/guide/bills/alipay' },
+            { text: '微信支付账单', link: '/guide/bills/wechat' },
+            { text: '美团账单', link: '/guide/bills/meituan' },
+            { text: '淘宝账单', link: '/guide/bills/taobao' },
+            { text: '京东账单', link: '/guide/bills/jd' },
+            { text: '招商银行账单', link: '/guide/bills/cmb' },
+            { text: '交通银行账单', link: '/guide/bills/bocom' },
+          ],
+        },
+        {
+          text: '其他',
+          items: [{ text: '常见问题', link: '/guide/faq' }],
+        },
+      ],
+      '/dev/': [
+        {
+          text: '开发文档',
+          items: [
+            { text: '总览', link: '/dev/' },
+            { text: '整体架构', link: '/dev/architecture' },
+            { text: '数据模型', link: '/dev/data-model' },
+            { text: '账单解析', link: '/dev/bill-parsing' },
+            { text: '规则引擎', link: '/dev/rule-engine' },
+            { text: 'AI 集成', link: '/dev/ai' },
+            { text: '定时通知', link: '/dev/notifications' },
+            { text: '动态数据源', link: '/dev/database' },
+          ],
+        },
+        {
+          text: '工程与规范',
+          items: [
+            { text: '项目结构', link: '/dev/project-structure' },
+            { text: '构建与部署', link: '/dev/build-deploy' },
+            { text: '开发环境与规范', link: '/dev/development' },
+            { text: '账单字段说明', link: '/dev/bill-fields' },
+            { text: 'API 文档', link: '/dev/api' },
+          ],
+        },
+      ],
+    },
+    socialLinks: [],
+    footer: {
+      message: '基于 Spring Boot 3 + Vue 3 的个人收支管理系统',
+    },
+    docFooter: {
+      prev: '上一页',
+      next: '下一页',
+    },
+    outline: {
+      label: '本页目录',
+      level: [2, 3],
+    },
+    search: {
+      provider: 'local',
+      options: {
+        translations: {
+          button: {
+            buttonText: '搜索文档',
+            buttonAriaLabel: '搜索文档',
+          },
+          modal: {
+            noResultsText: '无法找到相关结果',
+            resetButtonTitle: '清除查询条件',
+            footer: {
+              selectText: '选择',
+              navigateText: '切换',
+              closeText: '关闭',
+            },
+          },
+        },
+      },
+    },
+  },
+})