Ako zahrnúť schémy morskej panny do vášho projektu GitHub

Populárna platforma na zdieľanie kódu, GitHub, oznámila podporu pre nový typ vloženého obsahu. V súboroch markdown môžete teraz použiť syntax Morskej panny na jednoduché vytváranie vývojových diagramov, sekvenčných diagramov a ďalších.

Príchuť markdown na GitHub už zvláda obrázky, zoznamy úloh a krátke kódy emoji. Vďaka podpore bežných diagramov sa GitHub snaží získať informatívnejšiu a užitočnejšiu dokumentáciu.

Čo je nové na GitHub?

Teraz môžete vložiť kód morskej panny do svojho README.md a ďalšie markdown súbory. Ak tak urobíte, GitHub vykreslí diagram popísaný týmto kódom. Kód morskej panny používa jednoduchú syntax, ktorá popisuje jednotlivé časti každého diagramu v obyčajnom texte.

Pozri tiež: Čo je GitHub? Úvod do jeho základných funkcií

Ako zahrniete diagramy?

1. Buď vyberte existujúci súbor markdown alebo vytvorte nový, ktorý pridáte do svojho úložiska. Použite buď .md alebo .markdown rozšírenia.
2. Pridajte do toho súboru nejaký kód morskej panny. Aký kód presne závisí od vás; tu je jednoduchý príklad na začiatok:

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

instagram viewer
3. Pozrite si súbor na GitHub. Mali by ste vidieť pekné vykreslenie vášho diagramu.

Teraz sa stačí naučiť množstvo diagramov, ktoré má Morská panna k dispozícii. Alebo sa môžete jednoducho odvolať na Morská panna dokumentáciu, keď potrebujete schému.

Aké druhy diagramov môžem použiť?

Morská panna podporuje nasledujúce typy diagramov:

• Vývojový diagram
• Sekvencia
• Trieda
• Štát
• Vzťah entity
• Cesta užívateľa
• Gantt
• Koláč
• Požiadavka

Pozri tiež: Ganttov diagram vs. Graf PERT: Aké sú rozdiely?

Každý má svoju vlastnú syntax, ktorá odráža typ údajov, ktoré diagram zobrazuje. Tu je napríklad kód pre jednoduchý sekvenčný diagram:

sekvenčný diagram
 Bart->>Homer: Nemaj kravu, človeče.

Čo po vykreslení vyzerá takto:

A tu je kód pre základný stavový diagram:

stateDiagram-v2
 [*] --> Nové
 Nové --> Pripravené: prijaté
 Pripravené --> Spustené: odoslanie plánovača
 Beží --> Pripravený: prerušenie
 Beží --> Čaká sa: I/O alebo čakanie na udalosť
 Čaká sa --> Pripravený: I/O alebo dokončenie udalosti
 Beží --> Ukončené: ukončite
 Ukončené --> [*]

Čo sa takto vykresľuje:

Pridajte hodnotu svojim projektom GitHub pomocou schém morských panen

Diagramy morských panen sú užitočným doplnkom GitHub, najmä preto, že veríme, že podporujú lepšiu dokumentáciu. Mnohé projekty by mohli byť vylepšené niektorými vizuálnymi vysvetlivkami priamo v ich dokumentácii alebo súboroch README.

GitHub je teraz taká populárna služba, jej funkcie a zmeny ovplyvňujú mnohých vývojárov po celom svete. Našťastie existuje podpora pre schémy morskej panny, ak ju potrebujete, a neviditeľná, ak ju nepotrebujete. Ale dúfajme, že začnete vidieť aspoň nejakú krajšiu dokumentáciu.

Ako bezplatne hosťovať webovú stránku pomocou stránok GitHub

Ak máte jednoduchý web, nemusíte platiť za webhosting. Stránky GitHub môžete používať zadarmo!

Prečítajte si ďalej

O autorovi