Sign In Start Free Trial
Account

Add to playlist

Create a Playlist

Modal Close icon
You need to login to use this feature.
  • Book Overview & Buying The Official Guide to Mermaid.js
  • Table Of Contents Toc
The Official Guide to Mermaid.js

The Official Guide to Mermaid.js

By : Knut Sveidqvist, Jain
4.3 (7)
close
close
The Official Guide to Mermaid.js

The Official Guide to Mermaid.js

4.3 (7)
By: Knut Sveidqvist, 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)
close
close
1
Section 1: Getting Started with Mermaid
7
Section 2: The Most Popular Diagrams
12
Section 3: Powerful Diagrams for the Advanced User

Using different types of Directives

All directives are comments formatted in a special way to allow passing configuration parameters to Mermaid.

The syntax of directives is simple: they start with the line comment format, %%, followed by an opening bracket, {, then the directive, and finally a closing bracket, } (matching the opening one):

%%{directive}

There are several types of directives. We will cover them all, but let's start by looking at the most important and versatile type: the init or initialize directive.

The init directive

This is a directive that you can use to modify the initial configuration of the Mermaid diagram. This directive starts with init or initialize keyword, followed by a colon (:) and a JSON formatted configuration object:

%%{init: configuration-object}

Let's look at an example of using the init directive. There is a configuration option that you can use to turn mirrorActors on or off in sequence diagrams. We used...

Visually different images
CONTINUE READING
83
Tech Concepts
36
Programming languages
73
Tech Tools
Icon Unlimited access to the largest independent learning library in tech of over 8,000 expert-authored tech books and videos.
Icon Innovative learning tools, including AI book assistants, code context explainers, and text-to-speech.
Icon 50+ new titles added per month and exclusive early access to books as they are being written.
The Official Guide to Mermaid.js
notes
bookmark Notes and Bookmarks search Search in title playlist Add to playlist download Download options font-size Font size

Change the font size

margin-width Margin width

Change margin width

day-mode Day/Sepia/Night Modes

Change background colour

Close icon Search
Country selected

Close icon Your notes and bookmarks

Confirmation

Modal Close icon
claim successful

Buy this book with your credits?

Modal Close icon
Are you sure you want to buy this book with one of your credits?
Close
YES, BUY

Submit Your Feedback

Modal Close icon
Modal Close icon
Modal Close icon