GitHub/mermaid
1
0
Fork 0
mirror of https://github.com/mermaid-js/mermaid.git synced 2025-01-14 06:43:25 +08:00
Code Issues Projects Releases Wiki Activity

Update n00b-overview.md

Browse Source
This commit is contained in:
Neil Cuzon 2020-02-23 23:16:13 -08:00 committed by GitHub
parent e8a3ffcb41
commit 7a44e46d6d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/n00b-overview.md
View File

@ -1,8 +1,8 @@
# Overview for n00bs
As a sysadmin I frequently have to document things, including drawing stuff.
mermaid is a tool that aims to make diagrams and flowcharts for documentation, easier.
Using mermaid, I can type this as a comment in a script:
with mermaid, diagramscan be created through comments like this in a script:
```
graph TD
@ -11,17 +11,19 @@ B --> C[Server01]
B --> D[Server02]
```
And end up with this in the documentation:
And they are rendered into this and made part of the documentation:
![Flowchart](./img/n00b-firstFlow.png)
Most of the stuff I need to visualize can be scripted in a similar way, with a varitety of different symbols and chart types available. Since the diagram source is text based, it can be part of production scripts (and other pieces of code). So less time needs be spent on documenting as a separate task.
Most of the similar visuals that you might need to create can be scripted in a similar way, with a varitety of different symbols and chart types available.
Since the diagram source is text based, it can be part of production scripts (and other pieces of code). So less time needs be spent on documenting as a separate task.
Comparing with Visio and similar applications, mermaid is a really fast way to create good visualizations. This is especially apparent when editing a complex visualisation, this could take me hours in a desktop application but takes minutes (or even less if generation has been scripted) with mermaid.
With mermaid I can spend a fraction of the time I normally would spend, and instead automate the diagram generation and end up saving even more time. I love it!
Comparing with Visio and similar applications, mermaid is a really fast way to create good visualizations. This is especially apparent when editing a complex visualisations, a process that usually takes hours in a desktop application, but only takes minutes (or even less if generation has been scripted) with mermaid.
mermaid can potentially cut down the amount of time and effort spent on the process of creating diagrams, to a fraction of what you sually put in.
However, a lot of the mermaid documentation is geared to professional frontend developers, presuming a skill set which I simply do not have.
I needed a really basic instruction. And here it is.
If you need some basic instructions and introductions. And here are a few good places to start:
For information on how to use mermaid, click [here](https://mermaid-js.github.io/mermaid/#/n00b-gettingStarted), or you can try out the mermaid [live editor](https://mermaid-js.github.io/mermaid-live-editor/)