这个项目能做什么

GitDiagram 可将公共或私有 GitHub 仓库转换为交互式架构图。用户可以在任意 GitHub URL 中将“hub”替换为“diagram”以生成可视化,或使用 gitdiagram.com 的网页界面。 主要功能包括: - AI 生成的图表,并流式提供仓库架构说明 - 可点击的组件,直接链接到仓库中对应的文件或目录 - 通过“Private Repos”头部选项使用 GitHub token 认证,支持私有仓库 - 导出选项包括下载 PNG 图像和复制 Mermaid 源代码 该项目使用 Next.js、React、TypeScript、Tailwind CSS 和 Mermaid 构建。本地部署需要 Bun、Cloudflare R2、Upstash Redis 以及 OpenAI 或 OpenRouter API 密钥。该项目部署在 Vercel 上,并在部署恢复指南中记录了 Railway/Docker 备用方案。 文档包括涵盖生成流水线、存储和 API 的架构概览,以及开发设置指南。该工具的灵感来自 Romain Courtois 的 Gitingest 项目,并采用 MIT 许可证。