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

Customize theme variables for Requirement Diagrams

This is the last section in this chapter, but not the least important. In this section, we will focus on the requirement diagram-specific theme variables that can be modified to give a different look to your overall diagram. This is one way to control and override the Mermaid theme variable configurations across the site/system for all diagrams.

An alternate way, which is more user-friendly if you only want to modify one specific diagram, is by using directives, which you can use directly in the Mermaid Live Editor for on-the-fly customized diagrams without creating HTML files. We will be using this approach to override the requirement diagram-specific theme variables.

In this section, we will continue where Chapter 5, Changing Themes and Making Mermaid Look Good, left off, and get into details about the theming variables available specifically for requirement diagrams. Let's imagine that there are some aspects of a requirement...