Chapter 2: How to Use Mermaid

In the previous chapter, we learned about the importance of documentation, what Mermaid.js is, and how it came into being. In this chapter, we will focus on the various forms and tools we can use or incorporate Mermaid.js with. We will learn how to set up some custom documentation system powered by Mermaid.js for different use cases, to move ahead in the direction of efficient, fast, and easy-to-use documentation.

We will go into details of the following usages of Mermaid.js:

  • Adding Mermaid to a simple web page
  • Various Mermaid integrations (Editors, Wikis, CMS, others etc.)
  • Documentation with Markdown
  • Setting up a simple custom documentation system using Docsify with Mermaid
  • Setting up a custom documentation system ...

Get The Official Guide to Mermaid.js now with the O’Reilly learning platform.

O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.