有報告指出，當文檔足夠詳實、並以不同的格式提供時，開發效率有望迎來 50% 的矚目提升。然而想要在 GitHub 上的 Markdown 文件中包含圖片 / 圖表，此前必須通過嵌入圖像來實現。好消息是，即日起，開發人員已能夠通過 GitHub 體驗到一項原生功能 —— 支持基於 JavaScript 的 Mermaid 圖表和流程圖生成工具。
文檔提升工作效率 – Work（來自：GitHub）
對於 GitHub 用戶來說，這意味着他們能夠通過豐富的可視化格式來共享信息，以提供更好的項目管理、質量和工作流程改進。
文檔提升工作效率 – Open source
GitHub 開發者關係總監 Martin Woodward 解釋稱：Mermaid 支持軟件項目中一系列不同的常見圖表類型，涵蓋流程圖、UML、Git 圖、用戶體驗流程圖，甚至可怕的甘特圖。
指導文檔的比例
想要將 Mermaid 添加到 GitHub 文檔中的操作非常簡單：當你將代碼塊標記為 mermaidiframe，它會生成原始 Mermaid 語法。
自述文檔比例
在傳遞給 Mermaid.js 之後，瀏覽器又會將該代碼轉換為圖表來呈現。