Kako uključiti dijagrame sirene u svoj GitHub projekt

Popularna platforma za dijeljenje koda, GitHub, najavila je podršku za novu vrstu ugrađenog sadržaja. U datotekama s markdownom sada možete koristiti sintaksu Mermaid za jednostavno stvaranje dijagrama toka, dijagrama slijeda i još mnogo toga.

GitHubov okus markdowna već obrađuje slike, popise zadataka i kratke kodove emojija. Uz podršku za uobičajene dijagrame, GitHub čini svoj dio za informativniju, korisniju dokumentaciju.

Što je novo s GitHubom?

Sada možete ugraditi Mermaid kod u svoj README.md i druge marže datoteke. Ako to učinite, GitHub će prikazati dijagram opisan tim kodom. Mermaid kod koristi jednostavnu sintaksu koja opisuje pojedinačne dijelove svakog dijagrama u običnom tekstu.

Vidi također: Što je GitHub? Uvod u njegove osnovne značajke

Kako uključujete dijagrame?

1. Ili odaberite postojeću markdown datoteku ili stvorite novu za dodavanje u svoje spremište. Koristite bilo koje .doktor medicine ili .smanjenje proširenja.
2. Dodajte sirenski kod u tu datoteku. Koji točno kod ovisi o vama; evo jednostavnog primjera za početak:

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

instagram viewer
3. Pogledajte datoteku na GitHubu. Trebali biste vidjeti lijep prikaz vašeg dijagrama.

Sada samo trebate naučiti bogatstvo dijagrama koje Mermaid ima na raspolaganju. Ili se jednostavno možete pozvati na Sirena dokumentaciju kada i kada vam zatreba dijagram.

Koje vrste dijagrama mogu koristiti?

Mermaid podržava sljedeće vrste dijagrama:

• Dijagram toka
• Slijed
• Razred
• država
• Odnos entiteta
• Putovanje korisnika
• Gantt
• Pita
• Zahtjev

Vidi također: Ganttov grafikon vs. PERT grafikon: Koje su razlike?

Svaki ima svoju sintaksu, koja odražava vrstu podataka koje dijagram prikazuje. Na primjer, evo koda za jednostavan dijagram slijeda:

dijagram sekvence
 Bart->>Homer: Nemoj imati kravu, čovječe.

Što izgleda ovako kada se renderira:

A evo i koda za osnovni dijagram stanja:

stateDiagram-v2
 [*] --> Novo
 Novo --> Spremno: primljeno
 Spremno --> Izvršeno: otpremanje planera
 Trčanje --> Spreman: prekid
 Trčanje --> Čekanje: I/O ili čekanje događaja
 Čekanje --> Spreman: I/O ili završetak događaja
 Trčanje --> Prekinuto: izlaz
 Prekinuto --> [*]

Što se kao takvo prikazuje:

Dodajte vrijednost svojim GitHub projektima pomoću sirena dijagrama

Sirena dijagrami su koristan dodatak GitHubu, pogotovo jer vjerujemo da potiču bolju dokumentaciju. Mnogi projekti bi se mogli poboljšati nekim vizualnim objašnjenjima izravno u njihovoj dokumentaciji ili README datotekama.

GitHub je sada tako popularan servis, njegove značajke i promjene utječu na mnoge programere diljem svijeta. Srećom, podrška za dijagrame sirene je tu ako vam je potrebna, a nevidljiva ako ne. No, nadamo se da ćete početi vidjeti barem neku ljepšu dokumentaciju.

Kako besplatno ugostiti web stranicu pomoću GitHub stranica

Ako imate jednostavnu web stranicu, ne morate plaćati web hosting. Možete besplatno koristiti GitHub stranice!

Pročitajte dalje

O autoru