GitHub/mermaid
1
0
Fork 0
mirror of https://github.com/mermaid-js/mermaid.git synced 2025-01-28 07:03:17 +08:00
Code Issues Projects Releases Wiki Activity

Update n00b-overview.md

Browse Source
This commit is contained in:
Neil Cuzon 2020-07-31 00:56:32 -07:00 committed by GitHub
parent e43fd0c48a
commit 7ee9c4fb30
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/n00b-overview.md
View File

@ -36,14 +36,16 @@ And they are rendered into this and made part of the documentation:
## Advantages of Using Mermaid ## Advantages of Using Mermaid
- The Advantages of mermaid include its ease of generation, modification and rendering. - Ease of generation, modification and rendering.
- The number of integrations that it has. - The number of integrations and plugins it has.
- It is a package that can be deployed to create - It can be added to your or your company's website.
## Diagramming and charting is a gigantic waste of developer time, but not having diagrams ruins productivity. ## The catch-22 of Diagrams and Charts:
mermaid can cut down the amount of time, effort and the learning curve that is associated with creating diagrams and charts, by a wide margin. **Diagramming and charting is a gigantic waste of developer time, but not having diagrams ruins productivity. **
mermaid solves this by cutting the time, effort and tooling that is required to create diagrams and charts.
Because, the text base for diagrams allows for it to be updated easily, it can also be made part of production scripts (and other pieces of code). So less time needs be spent on documenting, as a separate task. Because, the text base for diagrams allows for it to be updated easily, it can also be made part of production scripts (and other pieces of code). So less time needs be spent on documenting, as a separate task.