Diagram in github markdown

github markdown에서 diagram을 그릴 수 있는 방법을 소개한다.

github에서는 다음과 같이 diagram을 그릴 수 있는 방법을 제공한다.

creating diagram in github

PlantUML과 유사한 다이어그램 툴로서 Mermaid를 사용한다.

Mermaid intro

example of graph

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

example of class diagram

---
title: Animal example
---
classDiagram
    note "From Duck till Zebra"
    Animal <|-- Duck
    note for Duck "can fly\ncan swim\ncan dive\ncan help in debugging"
    Animal <|-- Fish
    Animal <|-- Zebra
    Animal : +int age
    Animal : +String gender
    Animal: +isMammal()
    Animal: +mate()
    class Duck{
        +String beakColor
        +swim()
        +quack()
    }
    class Fish{
        -int sizeInFeet
        -canEat()
    }
    class Zebra{
        +bool is_wild
        +run()
    }