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 源碼。

相關

  • 專案
  • 專案
  • 專案
  • 專案