Book Image

The Official Guide to Mermaid.js

By : Knut Sveidqvist, Ashish Jain
Book Image

The Official Guide to Mermaid.js

By: Knut Sveidqvist, Ashish Jain

Overview of this book

Mermaid is a JavaScript-based charting and diagramming tool that lets you represent diagrams using text and code, which simplifies the maintenance of complex diagrams. This is a great option for developers as they’re more familiar with code, rather than using special tools for generating diagrams. Besides, diagrams in code simplify maintenance and ensure that the code is supported by version control systems. In some cases, Mermaid makes refactoring support for name changes possible while also enabling team collaboration for review distribution and updates. Developers working with any system will be able to put their knowledge to work with this practical guide to using Mermaid for documentation. The book is also a great reference for looking up the syntax for specific diagrams when authoring diagrams. You’ll start by learning the importance of accurate and visual documentation. Next, the book introduces Mermaid and establishes how to use it to create effective documentation. By using different tools, editors, or a custom documentation platform, you’ll also understand how to use Mermaid syntax for various diagrams. Later chapters cover advanced configuration settings and theme options to manipulate your diagram as per your needs. By the end of this book, you’ll be well-versed with Mermaid diagrams and how they can be used in your workflows.
Table of Contents (19 chapters)
1
Section 1: Getting Started with Mermaid
7
Section 2: The Most Popular Diagrams
12
Section 3: Powerful Diagrams for the Advanced User

Summary

Well, that brings this chapter to an end and you have now acquired knowledge of user journey diagram generation using Mermaid. You learned the basics of what a user journey diagram is and how it is represented. You know how to define the steps in a user's journey. You learned about the various levels of satisfaction scores that can be used and how to assign them to a step. You now know that to give more detail of who is involved in any specific step, you can use the concept of actors. You learned how to add one or more actors to a step. You also explored the concept of grouping steps in sections. Lastly, you explored the different ways to make your user journey diagram more beautiful, by overriding its diagram-specific theme variables to get your perfect-looking diagram.

Congratulations—you have now reached the end of this book! Through this book, you first made yourself familiar with efficient documentation and why it is important. Then, you were introduced...