ahmedkhaleel2004/gitdiagram

Free, simple, fast interactive diagrams for any GitHub repository

解决的问题

GitDiagram 将复杂的 GitHub 仓库转换为交互式架构图。无需手动绘制代码库或逐个浏览文件夹,开发者可以快速可视化项目内的系统级结构和关系。

工作原理

该工具通过 GitHub API 获取仓库的默认分支、文件树和 README。然后使用两阶段 AI 处理:首先生成对架构的通俗英文解释,其次生成包含节点、边和路径的结构化图 AST(抽象语法树)。该 AST 会与实际仓库文件进行验证,然后编译为 Mermaid 图表,并在浏览器中渲染。

适用人群

需要快速理解公开或私有 GitHub 仓库的高层设计,而无需手动阅读每个文件的开发者和架构师。

主要亮点

  • 以架构为中心:映射系统级图谱,而非简单的文件夹结构。
  • 交互式:图表中的组件可直接链接到 GitHub 上对应的文件或目录。
  • 支持私有仓库:用户可在浏览器中本地提供 GitHub 令牌,以可视化私有代码库。
  • 流式生成:在规划图谱的同时,实时显示 AI 生成的解释内容。
  • 导出选项:支持将图表导出为 PNG 或复制 Mermaid 源代码。

相关

  • 项目
  • 项目
  • 项目
  • 项目