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