好訊息!GitHub 已原生支援基於 JavaScript 的 Mermaid 圖表工具

六一發表於2022-02-21

從即日起 GitHub 將原生支援基於 JavaScript 的 Mermaid 圖表繪製工具。

Mermaid 通過解析類似於 Markdown 的文字語法來實現圖表的建立和動態修改,讓文件的更新能夠及時跟上開發進度。可用於建立流程圖、時序圖、甘特圖、類圖、狀態圖、餅圖等。

對於 GitHub 使用者來說,這意味著他們能夠通過豐富的視覺化格式來共享資訊,以提供更好的專案管理和質量,改進工作流程。

那麼如何將 Mermaid 新增到 GitHub 文件中呢?

即將程式碼塊標記為 mermaidiframe,它會生成原始 Mermaid 語法。在傳遞給 Mermaid.js 之後,瀏覽器又會將該程式碼轉換為圖表來呈現。


文件提升工作效率 - Work


文件提升工作效率 - Open source


指導文件的比例


自述文件比例

相關文章