Cargando…
The official guide to Mermaid.js : create complex diagrams and beautiful flowcharts easily using text and code /
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...
| Clasificación: | Libro Electrónico |
|---|---|
| Autores principales: | , |
| Formato: | Electrónico eBook |
| Idioma: | Inglés |
| Publicado: |
Birmingham :
Packt Publishing,
2021.
|
| Temas: | |
| Acceso en línea: | Texto completo (Requiere registro previo con correo institucional) |
Tabla de Contenidos:
- 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