Code Reader

欢迎使用 Code Reader，这是一个帮助您快速理解代码库架构和流程的工具。

快速开始

1. 安装依赖

cd app
npm install

2. 配置环境变量

复制环境变量示例文件：

cp .env.example .env

编辑 .env 文件配置您的环境：

# 文档目录配置
# 可以是相对路径（相对于 app 目录）或绝对路径
# 默认值为 docs
DOCS_DIR=docs

支持的环境变量

多路径配置示例

可以配置多个文档目录，所有目录的项目会合并显示：

# 多个绝对路径
DOCS_DIR=/home/user/documents/work; /home/user/documents/personal

# 混合配置（相对路径 + 绝对路径）
DOCS_DIR=docs; /home/user/external-docs; ../shared-projects

注意：

• 多个路径用分号 ; 分隔，分隔符前后可以有空格
• 如果不同路径中有同名项目，后配置的路径会覆盖先配置的
• 所有项目的 URL 都统一以第一个路径的目录名作为前缀

3. 启动开发服务器

npm run dev

开发服务器启动后，访问 http://localhost:8080 查看文档站点。

4. 构建生产版本

npm run build

构建完成后，静态文件将生成在 dist/ 目录中。

5. 上传到 Cloudflare R2

npm run upload

上传前需要先登录 Wrangler：

wrangler login

环境变量配置

设置以下环境变量来配置 R2 上传：

# R2 bucket 名称
R2_BUCKET_NAME=code-reader

# R2 账户 ID
R2_ACCOUNT_ID=your_account_id

# R2 访问密钥 ID
R2_ACCESS_KEY_ID=your_access_key_id

# R2 访问密钥
R2_SECRET_ACCESS_KEY=your_secret_access_key

或在命令行中设置：

export R2_BUCKET_NAME=code-reader

6. 一键部署

npm run deploy

该命令会自动执行构建和上传，将站点部署到 R2。

可访问的项目文档

以下是当前可访问的工程文档列表：

如何添加新项目

项目自动发现机制：系统会自动扫描 docs/ 目录（可通过 DOCS_DIR 环境变量配置），将包含 index.md 的子目录识别为项目。

手动添加

1. 在配置的文档目录下创建新项目文件夹（默认是 docs/）
2. 在项目文件夹中创建 index.md 作为项目入口文档
3. 重新构建或刷新页面即可看到新项目

使用分析脚本

运行分析脚本自动生成项目文档：

node ../scripts/analyze.js /path/to/your/project

这将分析指定项目并在 app/projects/{project-name}/ 目录生成文档。

常用链接

• 查看设计文档
• 浏览项目文档