DevDocs by CyberAGI 🚀

DevDocs by CyberAGI 🚀

site icon
2025.04.15 1273
TypeScript智能文档爬取开发加速器开发效率
DevDocs 是一个智能文档爬取和处理工具,旨在帮助开发者快速理解和实现各种技术文档。通过智能爬取、内容提取和组织,DevDocs 能够将文档研究时间从数周缩短到数小时,显著提升开发效率。
View on GitHub

Overview

产品定位

DevDocs 是一个智能文档爬取和处理工具,旨在帮助开发者快速理解和实现各种技术文档。通过智能爬取、内容提取和组织,DevDocs 能够将文档研究时间从数周缩短到数小时,显著提升开发效率。

核心功能

  1. 智能爬取
  2. 智能深度控制(1-5级)
  3. 自动链接发现
  4. 选择性爬取
  5. 子URL检测

  6. 性能与速度

  7. 并行处理
  8. 智能缓存
  9. 懒加载支持
  10. 速率限制

  11. 内容处理

  12. 干净的内容提取
  13. 多格式导出(MD、JSON)
  14. 结构化输出
  15. MCP服务器集成

  16. 企业功能

  17. 错误恢复
  18. 完整日志记录
  19. API访问
  20. 团队管理

适用场景

  1. 企业软件开发:快速理解和实现技术文档,减少技术债务。
  2. 网页爬虫:智能爬取内部和外部网站文档。
  3. 开发团队:利用内部文档和MCP服务器进行智能数据查询。
  4. 独立开发者:快速构建产品,避免陷入文档困境。

工具列表

  1. 启动脚本start.shstart.batstart.ps1 - 启动所有服务。
  2. MCP服务器脚本check_mcp_health.shrestart_and_test_mcp.sh - 管理和测试MCP服务器。
  3. 爬虫脚本check_crawl4ai.shdebug_crawl4ai.sh - 管理和调试爬虫服务。
  4. 实用脚本view_result.shfind_empty_folders.sh - 查看结果和分析项目结构。

常见问题解答

  1. Windows权限问题:可能需要以管理员身份运行脚本或手动设置权限。
  2. docker-compose.yml问题:脚本会自动修复格式和编码问题。
  3. 日志查看:使用docker logs命令查看特定容器的日志。

使用教程

使用依赖

  • Docker:https://docs.docker.com/get-docker/
  • Git

安装教程

# 克隆仓库
git clone https://github.com/cyberagiinc/DevDocs.git

# 进入项目目录
cd DevDocs

# 启动所有服务(Mac/Linux)
./docker-start.sh

# 启动所有服务(Windows)
docker-start.bat

调试方式

# 查看特定容器的日志
docker logs devdocs-frontend
docker logs devdocs-backend
docker logs devdocs-mcp
docker logs devdocs-crawl4ai

# 实时查看日志
docker logs -f devdocs-backend

许可证

该项目遵循 Apache-2.0 开源许可条款,请参阅 Apache-2.0 了解完整条款。