Enriching Documentation with Mermaid Diagrams
Notebooks gained popularity for their ability to intermix interactive code and rich documentation. The ability to add diagrams to notebooks further extends this capability.
In this chapter, we’ll cover embedding Mermaid diagrams into your notebooks in order to provide simple, easy-to-maintain, minimal diagrams that support the rest of your notebook.
While there are many different types of Mermaid diagrams, this chapter focuses on those most relevant to software engineers and data scientists by covering the following topics:
- Introducing Mermaid diagrams
- Communicating logic with flowcharts
- Communicating structure with class diagrams
- Communicating data with Entity Relationship Diagrams
- Communicating behavior with state diagrams
- Communicating flow with sequence diagrams
- Communicating workflow with Git graphs
