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

That was all for this chapter. You have now mastered class-diagram generation using Mermaid. You learned about the basics: what a class diagram is, what the various components of a class diagram are, and how these are represented. You know the two different ways to declare your classes. You learned how to add a member, its type, return type, and usage of generics in Mermaid. You were exposed to the concept of visibility of members, and how to use it. You explored the different types of relationships between classes that are specified by the UML class diagram. You now know that to give more detail to the relationships, you may use cardinalities and labels. You learned about the importance of annotations and comments, and their usage. Finally, you ventured into the advanced concepts of interaction handling using URL links and JavaScript callback functions. Lastly, you explored the different ways to make your class diagram more beautiful, by supplying custom CSS styles to specific...