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

Adjusting the theme of sequence diagrams

It might be the case that there is something we want to adjust in the theme of sequence diagrams without changing how other diagrams look. If this is the case, we should avoid modifying the main color variables such as primaryColor, and so on. The variables discussed next have a narrower scope than the main variables and have default values derived from the main color variables. If we modify them, they will override the derived ones and will only change the colors for sequence diagrams. If you want to know more about general theming concepts, these are explained in depth in Chapter 5, Changing Themes and Making Mermaid Look Good.

In the following subsections, we will look at different ways you can change the theme for sequence diagrams. We will look at each variable and show how it affects the output of the diagrams.

actorBkg

This color variable sets the background color of boxes used for actors, as illustrated in the following code...