Search icon CANCEL
Subscription
0
Cart icon
Your Cart (0 item)
Close icon
You have no products in your basket yet
Arrow left icon
Explore Products
Best Sellers
New Releases
Books
Videos
Audiobooks
Learning Hub
Free Learning
Arrow right icon
Arrow up icon
GO TO TOP
The Official Guide to Mermaid.js

You're reading from   The Official Guide to Mermaid.js Create complex diagrams and beautiful flowcharts easily using text and code

Arrow left icon
Product type Paperback
Published in Sep 2021
Publisher Packt
ISBN-13 9781801078023
Length 492 pages
Edition 1st Edition
Languages
Arrow right icon
Authors (2):
Arrow left icon
Knut Sveidqvist Knut Sveidqvist
Author Profile Icon Knut Sveidqvist
Knut Sveidqvist
Ashish Jain Ashish Jain
Author Profile Icon Ashish Jain
Ashish Jain
Arrow right icon
View More author details
Toc

Table of Contents (19) Chapters Close

Preface 1. Section 1: Getting Started with Mermaid
2. Chapter 1: The Art of Documentation with Mermaid FREE CHAPTER 3. Chapter 2: How to Use Mermaid 4. Chapter 3: Mermaid Versions and Using the Live Editor 5. Chapter 4: Modifying Configurations with or without Directives 6. Chapter 5: Changing Themes and Making Mermaid Look Good 7. Section 2: The Most Popular Diagrams
8. Chapter 6: Using Flowcharts 9. Chapter 7: Creating Sequence Diagrams 10. Chapter 8: Rendering Class Diagrams 11. Chapter 9: Illustrating Data with Pie Charts and Understanding Requirement Diagrams 12. Section 3: Powerful Diagrams for the Advanced User
13. Chapter 10: Demonstrating Connections Using Entity Relationship Diagrams 14. Chapter 11: Representing System Behavior with State Diagrams 15. Chapter 12: Visualizing Your Project Schedule with Gantt Chart 16. Chapter 13: Presenting User Behavior with User Journey Diagrams 17. Other Books You May Enjoy Appendix :Configuration Options

Preface

This is a book about Mermaid, which lets you represent diagrams using text and code, simplifying the maintenance of complex diagrams.

Having the diagram in code simplifies maintenance and enables support by version control systems. In some cases, it is even possible to get refactoring support for name changes. It also facilitates simple collaboration within a team, where it is easy to distribute reviews and updates between team members. This ultimately saves you time and effort.

You will learn about Mermaid and put your knowledge to work with this practical guide to using Mermaid for documentation. The book takes a hands-on approach to implementation and associated methodologies that will have you up and running and productive in no time. The book can also serve as a reference for looking up the syntax for a particular diagram when authoring diagrams.

The book contains complete step-by-step explanations of essential concepts, practical examples, and practice exercises. You will begin by learning about Mermaid and documentation, before moving on to the general handling of Mermaid and finishing off with detailed descriptions of how to create the various diagrams supported by Mermaid.

With this book, you are first made familiar with efficient documentation and why it is important. Then, this book introduces Mermaid and establishes where it fits into the picture. Finally, you will learn how to use Mermaid syntax for various diagrams, using different tools and editors or a custom documentation platform. At the end, you will have enough confidence and knowledge to use Mermaid in your day-to-day work.

By the end of this book, you will know about the many different tools used to create Mermaid diagrams, and you will also have gained detailed knowledge about the different types of Mermaid diagrams, their configuration, and how they can be used in your workflows.

lock icon The rest of the chapter is locked
Next Section arrow right
Register for a free Packt account to unlock a world of extra content!
A free Packt account unlocks extra newsletters, articles, discounted offers, and much more. Start advancing your knowledge today.
Unlock this book and the full library FREE for 7 days
Get unlimited access to 7000+ expert-authored eBooks and videos courses covering every tech area you can think of
Renews at $19.99/month. Cancel anytime
Banner background image