Starting today, GitHub will natively support the JavaScript-based Mermaid charting tool.
Mermaid realizes the creation and dynamic modification of charts by parsing the text syntax similar to Markdown, so that the update of documents can keep up with the development progress in time. Can be used to create flowcharts, sequence diagrams, Gantt charts, class diagrams, state diagrams, pie charts, etc.
For GitHub users, this means they can share information through rich visual formats to provide better project management and quality, and improve workflow.
So how do you add Mermaid to the GitHub docs?
That is, mark the code block as mermaidiframe, which generates the original Mermaid syntax. After being passed to Mermaid.js, the browser will turn this code into a chart for rendering.
Documentation boosts productivity - Work
Documentation boosts productivity - Open source
Proportion of Guidance Documents
README Scale
**粗体** _斜体_ [链接](http://example.com) `代码` - 列表 > 引用。你还可以使用@来通知其他用户。