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

Variables for modifying a theme

There are more variables that can be used to tweak the theme than were used in the previous sections.

What follows are variables common to all diagrams. In the following chapters, we discuss each diagram type in more detail and the theming variables specific to that type of diagram.

Now, let's look at the variables common to all diagrams. The following variables define fonts, color mode, and background color:

Figure 5.26 – A table describing the color variables, setting the stage for the theme

Figure 5.26 – A table describing the color variables, setting the stage for the theme

The next set of variables defines the colors of the theme. With these variables, you define the base colors in play when rendering the diagrams. Diagram-specific variables are, in turn, either using these colors directly or deriving colors from them. You can see a list of these variables here:

Figure 5.27 – A table describing the main color variables for a theme

Figure 5.27 – A table describing the main color variables for a theme

Finally, we have...