Markdown Mermaid planting grass (1)_ Introduction to Mermaid

Markdown mermaid Want to buy (1)_ mermaid brief introduction

1 Why recommend mermaid

​ Ben Xiaobai has been infatuated with markdown And markdown Related tools . Maybe it's because the genuine programming skills can't be learned , You can only learn this to add to the icing on the cake （zhuangbility) The technique of . To make fun of , Good notes, good presentation , It can contribute to the learning effect .

​ Markdown What about language , It can be said to be a friend of programmers . Whether it's github Or what you are looking at now CSDN, And various note taking products , Both support this graphic and textual editing format . Ben Xiaobai first recommends one that everyone recommends markdown Artifact typora, This product is currently used by me markdown The main product of language , After experiencing several online editors and several note taking software , I still think typora It is the local end markdown The best solution of the editor （ Ben Xiaobai's personal opinion , Expert light spray ）.

​ Get down to business , Let's talk about the main character of this article mermaid. Ben Xiaobai thought ,markdown Only in the text 、 The table level is wonderful , Until recently, I happened to find mermaid This markdown The additive artifact of language .

​ so to speak ,mermaid It basically meets the editing needs of programmers for commonly used charts in their work . To this point , It is worthy of Ben Xiaobai's recommendation .

2 mermaid brief introduction

​ Go to the previous one directly mermaid The home page of ：mermaid Portal .

​ mermaid The following types of graphical rendering are currently available ：

Number	English title	Chinese title
1	Flowchart	flow chart
2	Sequence Diagram	Sequence diagram
3	Class Diagram	Class diagram
4	State Diagram	State diagram
5	Entity Relationship Diagram	Entity relation diagram
6	User Journey	Laundry list
7	Gantt	Gantt Chart
8	Pie Chart	The pie chart

Mermaid lets you represent diagrams using text and code.

​ mermaid The goal is to allow you to use a text editor and code to draw diagrams . OK, Since it's a profile , Let's give an example of each diagram ( The following example is excerpted from , No copyright protection )：

thank CSDN Support mermaid Most drawings of , But Gantt chart is not supported ？？？

2.1 flow chart

graph TD;
    A-->B;
    A-->C;
    B-->D;
    C-->D;

2.2 Sequence diagram

sequenceDiagram
    participant Alice
    participant Bob
    Alice->>John: Hello John, how are you?
    loop Healthcheck
        John->>John: Fight against hypochondria
    end
    Note right of John: Rational thoughts <br/>prevail!
    John-->>Alice: Great!
    John->>Bob: How about you?
    Bob-->>John: Jolly good!

2.3 Class diagram

classDiagram
Class01 <|-- AveryLongClass : Cool
Class03 *-- Class04
Class05 o-- Class06
Class07 .. Class08
Class09 --> C2 : Where am i?
Class09 --* C3
Class09 --|> Class07
Class07 : equals()
Class07 : Object[] elementData
Class01 : size()
Class01 : int chimp
Class01 : int gorilla
Class08 <--> C2: Cool label

2.4 State diagram

   stateDiagram-v2
    state fork_state <<fork>>
      [*] --> fork_state
      fork_state --> State2
      fork_state --> State3

      state join_state <<join>>
      State2 --> join_state
      State3 --> join_state
      join_state --> State4
      State4 --> [*]

2.5 Entity relation diagram (ER chart )

erDiagram
    CUSTOMER ||--o{
     ORDER : places
    ORDER ||--|{
     LINE-ITEM : contains
    CUSTOMER }|..|{
     DELIVERY-ADDRESS : uses

2.6 User experience map

journey
    title My working day
    section Go to work
      Make tea: 5: Me
      Go upstairs: 3: Me
      Do work: 1: Me, Cat
    section Go home
      Go downstairs: 5: Me
      Sit down: 5: Me

2.7 Gantt Chart

gantt
dateFormat  YYYY-MM-DD
axisFormat  %m-%d
title Adding GANTT diagram to mermaid
excludes weekdays 2021-01-10

section A section
Completed task            :done,    des1, 2021-01-16,2021-01-28
Active task               :active,  des2, 2021-01-29, 3d
Future task               :         des3, after des2, 5d
Future task2               :         des4, after des3, 5d

2.8 The pie chart

pie
    title Key elements in Product X
    "Calcium" : 42.96
    "Potassium" : 50.05
    "Magnesium" : 10.01
    "Iron" :  5