| Description |
1 online resource |
|
text file |
| Contents |
Cover -- Copyright -- Contributors -- Table of Contents -- Preface -- Section 1: Getting Started with Mermaid -- Chapter 1: The Art of Documentation with Mermaid -- Understanding the importance of documentation -- Clear definition of requirements and scope -- Assisting in testing and maintenance -- Better collaboration and teamwork -- Increases the team's competencies -- Preserve good procedures in the organizational memory -- Documentation is important when working with agile development processes -- Understanding Good, Bad, and Efficient documentation -- What is bad documentation? |
|
What is good documentation? -- What is Efficient Documentation? -- Guidelines for setting up Good Documentation -- Archiving Documentation -- Introducing Mermaid with Markdown -- Blending Mermaid with Markdown -- Blending text-based documentation with your code -- Advantages of using Mermaid with Markdown -- Summary -- Chapter 2: How to Use Mermaid -- Technical requirements -- Adding Mermaid to a simple web page -- Various Mermaid integrations (Editors, Wikis, CMS, and others etc.) -- GitLab -- Azure DevOps -- WordPress -- VuePress -- MediaWiki -- Remark -- Pandoc -- Mermaid Live Editor |
|
Documentation with Markdown -- What is Markdown? -- Why use Markdown for documentation? -- Quick Crash Course in Markdown -- Setting up a simple custom documentation system using Docsify with Mermaid -- Setting up your custom documentation system that supports Mermaid using Gatsby -- Summary -- Chapter 3: Mermaid Versions and the Using Live Editor -- Technical requirements -- Understanding Mermaid versions and the Release cycle -- Semantic Versioning in Mermaid -- The release cycle of Mermaid -- Exploring the Mermaid Live Editor -- How to access the Mermaid Live Editor |
|
Functionality of Mermaid Live Editor -- Rendering your first diagram using the Live Editor -- Summary -- Chapter 4: Modifying Configurations with or without Directives -- Technical requirements -- What are Directives? -- Using different types of Directives -- The init directive -- The wrap directive -- Different configuration options -- Top-level configuration options -- Flowcharts -- Sequence Diagrams -- Gantt charts -- User Journey diagrams -- ER diagrams -- Pie charts -- State diagrams -- Setting configuration options using initialize -- Setting up the site configuration -- Summary |
|
Chapter 5: Changing Themes and Making Mermaid Look Good -- Selecting a theme -- Changing the theme for a whole site -- Changing the theme for only one diagram -- Different pre-built theme options for Mermaid -- Customizing a theme using theme variables -- Color theory -- Selecting colors -- Finalizing the new theme -- Variables for modifying a theme -- Summary -- Section 2: The Most Popular Diagrams -- Chapter 6: Using Flowcharts -- Technical requirements -- Getting started with flowcharts -- Shapes and types of shapes -- The rectangle shape -- The diamond shape -- The rounded rectangle shape |
| Summary |
Get up to speed with using Mermaid diagrams to facilitate a seamless development workflow with the help of real-world examples and expert tips from the creators of the tool Key Features Learn how to use and customize the different diagram types in Mermaid Discover examples of how to add Mermaid to a documentation system Use Mermaid with various tools available such as editors, wiki, and more Book Description 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. What you will learn Understand good and bad documentation, and the art of effective documentation Become well-versed with maintaining complex diagrams with ease Discover how to draw different types of Mermaid diagrams such as flowcharts, class diagrams, Gantt charts, and more Implement Mermaid diagrams in your workflows Understand how to set up themes for a Mermaid diagram or an entire site Get to grips with setting up a custom documentation system Who this book is for This book is for content generators such as technical writers, developers, architects, business analysts, and managers who want to learn effective documentation or how to effectively represent diagrams using simple text code snippets and ex ... |
| Subject |
Flow charts.
|
|
JavaScript (Computer program language)
|
|
Ordinogrammes. |
|
JavaScript (Langage de programmation) |
|
Flow charts |
|
JavaScript (Computer program language) |
| Added Author |
Jain, Ashish, author.
|
| Other Form: |
Print version : 9781801078023 |
| ISBN |
9781801076258 (ebook) |
|
1801076251 |
|
1801078025 |
|
9781801078023 |
| Standard No. |
9781801078023 |
|
More Resources