mermaid-js/mermaid：README 來源編輯指南

mermaid-js/mermaid 的 README 將專案描述為「Generation of diagrams like flowcharts or sequence diagrams from text in a similar manner as markdown」。本文只整理倉庫可直接核對的內容，不把 star、Fork 或宣傳語當成品質證明。README 在「README」下寫到：Mermaid Generate diagrams from markdown-like text.。這說明的是專案邊界，不是已完成的生產驗證。

從 README 的「Features」與相關條目，可以先判斷它是否處理你的實際問題：Markdown-Inspired Syntax , Write diagrams as text, no drag-and-drop required。若需求不同，不應只因專案熱度就採用。本文保留原始專案名、命令與元件名，方便回到一手來源核對。 README 另外列出一項可核對的資訊：20+ Diagram Types , Flowchart, Sequence, Class, State, ER, Gantt, Pie, Git Graph, Mindmap, Timeline, Sankey, and more。這類原文條目可用來設計試跑步驟，但不能取代實際環境測試。

README 將運作方式分散在「README」等段落。可確認的線索包括：:trophy: Mermaid was nominated and won the JS Open Source Awards (2019) in the category "The most exciting use of technology"!!!。本文不把未寫出的架構、效能或安全邊界補成結論；真正的執行鏈仍要配合目錄、設定檔與版本標籤檢查。

第一次安裝應從 README 指出的入口開始。目前可核對的命令是： gantt title Git Issues - days since last update dateFormat X axisFormat %s section Issue19062 71 : 0, 71 section Issue19401 36 : 0, 36 section Issue193 34 : 0, 34 section Issue7441 9 : 0, 9 section Issue1300 5 : 0, 5 如果倉庫沒有命令，本文不會自行編造步驟，而是建議先閱讀「About」，確認系統依賴、預設埠與首次初始化。

日常使用取決於專案文件。README 的「README」段落提到：Thanks to all involved, people committing pull requests, people answering questions! 🙏。設定檔、環境變數、權限與資料目錄只在來源明確時才會記錄；沒有寫出的預設值，應在測試環境驗證並保留回滾副本。 同一部分也提到：No Design Tool Needed , Generate professional diagrams straight from code。

README 能確認的限制比宣傳頁更重要。現有來源沒有證明mermaid-js/mermaid具備固定相容矩陣、服務等級、效能基準或長期支援承諾。README 只明確寫到「Mermaid is a JavaScript-based diagramming and charting tool that uses Markdown-inspired text definitions and a renderer to create and modify complex diagrams. The main purpose of Mermaid is to help documentation catch up with development.」。這些未知項應列入選型紀錄，不要改成肯定句。