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

Chapter 3: Mermaid Versions and Using the Live Editor

In the previous chapter, you learned about Mermaid, what it is, and how it can be used. You also gained an insight into the different tools and other platforms that are available for integration with Mermaid.

In this chapter, we will learn more about different versions of Mermaid, how Mermaid is evolving, where to check for its latest version, and what strategy Mermaid follows while releasing a newer version. We will also take an in-depth look at Mermaid Live Editor, its different features, and how to render your first diagram using the Live Editor.

You will learn about the following:

  • Understanding Mermaid Versions and the Release Cycle
  • Exploring Mermaid Live Editor
  • Rendering your first Mermaid diagram using the Live Editor

By the end of this chapter, you will understand how Mermaid as an open source library is being developed and released in different versions. You will know what semantic versioning...