DocuMentor
2025.04.18
0
TypeScript智能文档代码分析开发效率
DocuMentor 是一个基于 Cloudflare Worker 的应用程序，旨在提供智能文档和代码分析功能。它利用现代网络技术和人工智能工具来增强代码理解和文档生成过程。
View on GitHub
Overview
基本能力
产品定位
DocuMentor 是一个智能文档和代码分析工具，旨在帮助开发者更高效地生成和管理文档，同时提供代码分析功能。
核心功能
- Cloudflare Worker 架构，提供高性能和可扩展性
- 与 Firecrawl 集成，支持网页抓取和数据提取
- 基于 TypeScript 开发，确保类型安全和更好的可维护性
- 自动化文档生成
- 使用 Vitest 进行测试支持
- 智能部署能力，优化部署流程
适用场景
- 开发者需要自动化生成代码文档
- 团队需要高效的代码分析和理解工具
- 项目需要集成网页抓取和数据提取功能
工具列表
@mendable/firecrawl-js: 用于网页抓取和数据提取cheerio: 用于 HTML 解析mcp-remote: 用于远程配置管理workers-mcp: 用于 Cloudflare Workers 配置
常见问题解答
- 如何获取 Firecrawl API 密钥？ 需要访问 Firecrawl 服务并申请 API 密钥。
- 如何部署到 Cloudflare Workers？
使用
npm run deploy命令进行部署。
使用教程
使用依赖
- 安装 Node.js（推荐最新 LTS 版本）
- 安装 npm 或 yarn 包管理器
- 安装 Cloudflare Wrangler CLI
- 获取 Firecrawl API 密钥
安装教程
- 克隆仓库：
git clone https://github.com/yourusername/DocuMentor.git
cd DocuMentor
- 安装依赖：
npm install
- 配置环境变量：
在根目录创建
.dev.vars文件，并添加以下变量：
SHARED_SECRET=your_shared_secret
FIRECRAWL_KEY=your_firecrawl_key
BRAVE_KEY=your_brave_key
调试方式
- 启动开发服务器：
npm run dev
- 运行测试：
npm test
- 部署到 Cloudflare Workers：
npm run deploy