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

Other Books You May Enjoy

If you enjoyed this book, you may be interested in these other books by Packt:

Supercharge your Slack Productivity

Moshe Markovich

ISBN: 978-1-80056-962-1

  • Understand how to set up a Slack workspace
  • Migrate existing workspaces to your organization
  • Explore expert tips and techniques for using Slack effectively
  • Improve collaboration within your team by integrating multiple apps with Slack
  • Find the right bots and apps to use for your workspace
  • Discover how to build your own Slack bot
  • Explore the right channels on Slack to improve your presence in professional communities
  • Find the best solutions for automating your work directly through Slack

Mastering Adobe Captivate 2019 - Fifth Edition

Svelte 3 Up and Running

Alessandro Segala

ISBN: 978-1-83921-362-5

  • Understand why Svelte 3 is the go-to framework for building static web apps that offer great UX
  • Explore the tool setup that makes it easier to build and debug Svelte apps
  • Scaffold...