Files

T

rosercode 923d6db5c0 docs: 同步汇账最新功能，新增智能查数、账单关系等文档

对照 ledgerly 自文档上次更新以来的全部改动，补充新功能文档、修正品牌与版本残留，并新增下载与安装页；配图已重新截取并上传 OSS，本地截图目录不纳入版本管理。

变更内容：
- 新增「智能查数」「账单关系」两个使用文档页，并登记侧边栏与总览
- 设置页扩充为八个面板（账号安全、数据库实时进度、外观、导航等）并改为即时保存
- 收支记录补充关系列、批量操作、AI 搜索浮窗、可配置分页与「账单详情」弹窗
- 统计面板补充饼图/渠道图下钻与筛选双向联动；规则管理补充批量删除
- AI 能力补充智能查数与关系命名；新增下载与安装页
- 开发文档同步：AI 13 类调用、数据模型 24 张表、API、前端偏好、构建部署
- 统一「汇账 Ledgerly」品牌与「设置/日志」菜单文案，版本号对齐 0.1
- 截图脚本新增账单详情等场景并更新登记

说明：
- download.md 的 OSS 下载链接保持待发布产物回填，暂不调整
- 已通过 npm run docs:build 与 npm run typecheck:scripts

2026-09-26 21:57:38 +08:00

4.0 KiB

Raw Blame History

汇账 · 文档站

本目录是「汇账」（同级目录 ../ledgerly）的使用文档与开发文档站点，基于 VitePress 构建，并附带一套 Node/TypeScript 维护脚本（截图、演示数据、资料抓取）。

在线体验：https://finance.rosercode.cn/（演示账号 demo / demo123456，使用独立的 SQLite 演示库与虚构数据）

快速开始

# 安装依赖（走本地 verdaccio 私服，见 .npmrc）
npm install

# 本地开发（默认 http://localhost:5175）
npm run docs:dev

# 构建静态站点到 .vitepress/dist
npm run docs:build

# 预览构建产物
npm run docs:preview

对外访问（局域网/远程）：

./node_modules/.bin/vitepress dev --host 0.0.0.0

文档结构

站点分为两大板块：

使用文档（guide/）：面向使用者，讲「怎么用」。
- 开始使用、记账与整理、智能与自动化、系统
- guide/bills/：各类账单的获取与字段说明
- guide/faq.md：常见问题
开发文档（dev/）：面向开发者，讲「怎么跑、怎么设计、怎么改」。
- 整体架构、数据模型、账单解析、规则引擎、AI 集成、定时通知、动态数据源
- 项目结构、构建与部署、开发环境与规范、账单字段说明、API 文档

首页 index.md 提供两个板块的入口。

目录结构

doc-site/
├── index.md                # 首页
├── guide/                  # 使用文档（含 bills/）
├── dev/                    # 开发文档
├── public/                 # 静态资源
│   ├── logo.svg
│   └── screenshots/        # 文档配图（整页 + elements/ 关键元素）
├── .vitepress/
│   ├── config.mts          # 站点配置（导航、侧边栏、搜索、端口 5175）
│   └── theme/              # 自定义主题（图片全屏查看、图片样式）
├── scripts/
│   ├── ts/                 # 维护脚本（TypeScript，含截图、演示数据、OSS 上传）
│   └── samples/            # 虚构样例账单
├── refs/                   # 联网检索到的资料原文（不参与构建）
├── jar-home/               # jar 一体化实例运行目录（测试库副本）
├── .env.local              # 截图 OSS 上传等本地配置（不入库）
├── package.json
└── tsconfig.json

维护脚本

脚本位于 scripts/ts/，用 tsx 直接运行 TypeScript，浏览器自动化基于 playwright-core（Chromium），HTTP 基于 axios。

npm run capture          # 一键重新截图（整页 + 元素 + 卡片 + 编辑/设置面板 + 解析预览，慎用）
npm run capture:pages    # 仅整页截图
npm run capture:elements # 仅元素截图
npm run make:bills       # 生成虚构样例账单
npm run seed             # 导入样例账单（演示数据）
npm run seed:rules       # 补充标签与规则
npm run refs:search      # 检索资料到 refs/
npm run refs:fetch       # 抓取指定 URL 到 refs/
npm run oss:upload       # 上传截图到 OSS（读取 .env.local）
npm run test:browser     # 验证浏览器链路
npm run typecheck:scripts # 类型检查

运行截图前请确保：

应用实例已启动（默认访问 jar-home/ 下的 jar 实例 localhost:18082）；
测试库中已配置 AI（用于截取启用 AI 后的界面）。

可通过环境变量覆盖：LEDGERLY_WEB、LEDGERLY_API、LEDGERLY_USER、LEDGERLY_PASSWORD。

环境安全：截图与演示数据只操作测试环境，禁止访问真实环境（5173 / 8080 / MySQL 真实库）。

环境要求

Node.js（建议 20+，本项目使用 v24）
npm 依赖走本地 verdaccio 私服（.npmrc 已配置 registry=http://localhost:4873/）
浏览器：复用 Playwright 缓存的 Chromium，无需系统安装 Chrome/Firefox

约定

维护本目录时请遵守 AGENTS.md（文档归类、截图规范、构建校验等）。

4.0 KiB Raw Blame History Unescape Escape