Kako vključiti diagrame morske deklice v svoj projekt GitHub

Priljubljena platforma za skupno rabo kode GitHub je napovedala podporo za novo vrsto vdelane vsebine. V datotekah markdown lahko zdaj uporabite sintakso Mermaid za preprosto ustvarjanje diagramov poteka, diagramov zaporedja in še več.

GitHubov okus markdown že obravnava slike, sezname opravil in kratke kode emodžijev. S podporo za običajne diagrame GitHub naredi svoje za bolj informativno in uporabno dokumentacijo.

Kaj je novega z GitHub?

Zdaj lahko vdelate kodo Mermaid v svoj README.md in druge datoteke z znižanjem vrednosti. Če to storite, bo GitHub prikazal diagram, opisan s to kodo. Koda Mermaid uporablja preprosto sintakso, ki opisuje posamezne dele vsakega diagrama v navadnem besedilu.

Poglej tudi: Kaj je GitHub? Uvod v njegove osnovne značilnosti

Kako vključite diagrame?

1. Izberite obstoječo datoteko za znižanje vrednosti ali ustvarite novo, ki jo želite dodati v svoje skladišče. Uporabite katero koli .md oz .markdown razširitve.
2. Tej datoteki dodajte nekaj kode Mermaid. Kakšna točno koda je odvisna od vas; tukaj je preprost primer za začetek:

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

instagram viewer
3. Oglejte si datoteko na GitHubu. Videti bi morali lepo upodobitev svojega diagrama.

Zdaj se morate samo naučiti bogastva diagramov, ki jih ima Mermaid na voljo. Lahko pa se preprosto sklicujete na morska deklica dokumentacijo, ko in ko potrebujete diagram.

Kakšne vrste diagramov lahko uporabim?

Mermaid podpira naslednje vrste diagramov:

• Diagram poteka
• Zaporedje
• razred
• Država
• Razmerje med entitetami
• Uporabniško potovanje
• Gantt
• pita
• Zahteva

Poglej tudi: Ganttov grafikon vs. Diagram PERT: kakšne so razlike?

Vsaka ima svojo sintakso, ki odraža vrsto podatkov, ki jih prikazuje diagram. Tukaj je na primer koda za preprost diagram zaporedja:

diagram zaporedja
 Bart->>Homer: Ne imej krave, človek.

Kar izgleda takole, ko je upodobljeno:

In tukaj je koda za osnovni diagram stanja:

stateDiagram-v2
 [*] --> Novo
 Novo --> Pripravljen: sprejet
 Pripravljen --> Teče: odpošiljanje razporejevalnika
 Teče --> Pripravljen: prekinitev
 Teče --> Čakanje: čakanje na V/I ali dogodek
 Čakanje --> Pripravljen: V/I ali zaključek dogodka
 Teče --> Prekinjeno: izhod
 Prekinjeno --> [*]

Kar se kaže kot tako:

Dodajte vrednost svojim projektom GitHub z diagrami Mermaid

Diagrami morske deklice so koristen dodatek GitHubu, še posebej, ker verjamemo, da spodbujajo boljšo dokumentacijo. Številne projekte bi lahko izboljšali z nekaterimi vizualnimi razlagali kar v njihovi dokumentaciji ali datotekah README.

GitHub je zdaj tako priljubljena storitev, njene funkcije in spremembe vplivajo na številne razvijalce po vsem svetu. Na srečo je podpora za diagrame Mermaid na voljo, če jo potrebujete, in nevidna, če je ne potrebujete. Toda upajmo, da boste začeli videti vsaj nekaj lepše dokumentacije.

Kako brezplačno gostiti spletno mesto z uporabo strani GitHub

Če imate preprosto spletno mesto, vam za spletno gostovanje ni treba plačati. Strani GitHub lahko uporabljate brezplačno!

Preberite Naprej

O avtorju