Kaip įtraukti undinės diagramas į savo „GitHub“ projektą

Populiari kodų dalijimosi platforma „GitHub“ paskelbė palaikanti naujo tipo įterptąjį turinį. Pažymėjimo failuose dabar galite naudoti Mermaid sintaksę, kad lengvai sukurtumėte srautų diagramas, sekos diagramas ir kt.

„GitHub“ žymėjimo skonis jau tvarko vaizdus, ​​​​užduočių sąrašus ir jaustukų trumpus kodus. Palaikydamas įprastas diagramas, „GitHub“ stengiasi gauti daugiau informatyvių ir naudingų dokumentų.

Kas naujo naudojant „GitHub“?

Dabar galite įterpti Mermaid kodą į savo README.md ir kiti žymėjimo failai. Jei tai padarysite, „GitHub“ pateiks diagramą, aprašytą tuo kodu. Mermaid kodas naudoja paprastą sintaksę, kuri aprašo atskiras kiekvienos diagramos dalis paprastu tekstu.

Taip pat žiūrėkite: Kas yra GitHub? Įvadas į pagrindines jo savybes

Kaip įtraukti diagramas?

1. Pasirinkite esamą žymėjimo failą arba sukurkite naują, kurį norite pridėti prie saugyklos. Naudokite bet kurį .md arba .užsirašyk plėtiniai.
2. Prie to failo pridėkite šiek tiek Mermaid kodo. Koks tiksliai kodas priklauso nuo jūsų; čia yra paprastas pavyzdys, kaip pradėti:

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

instagram viewer
3. Peržiūrėkite failą „GitHub“. Turėtumėte pamatyti gražų savo diagramos atvaizdavimą.

Dabar jums tereikia išmokti daugybę diagramų, kurias turi „Mermaid“. Arba galite tiesiog kreiptis į Undinėlė dokumentus, kai jums reikia diagramos.

Kokias diagramas galiu naudoti?

Mermaid palaiko šių tipų diagramas:

• Struktūrinė schema
• Seka
• Klasė
• valstybė
• Esybės santykiai
• Vartotojo kelionė
• Gantas
• Pyragas
• Reikalavimas

Taip pat žiūrėkite: Ganto diagrama vs. PERT diagrama: kokie yra skirtumai?

Kiekvienas iš jų turi savo sintaksę, atspindinčią diagramoje rodomų duomenų tipą. Pavyzdžiui, čia yra paprastos sekos diagramos kodas:

sekos diagrama
 Bartas->>Homeras: Neturėk karvės, žmogau.

Kas atrodo taip, kai pateikiama:

Ir čia yra pagrindinės būsenos diagramos kodas:

būsenos diagrama-v2
 [*] --> Nauja
 Nauja --> Paruošta: pripažinta
 Parengta --> Veikia: planuotojo išsiuntimas
 Veikia --> Parengta: pertraukti
 Veikia --> Laukiama: laukti įvesties/išvesties arba įvykio
 Laukiama --> Parengta: I/O arba įvykio pabaiga
 Veikia --> Nutraukta: išeiti
 Nutraukta --> [*]

Kuris atvaizduojamas kaip toks:

Pridėkite vertę savo „GitHub“ projektams naudodami „Undinės“ diagramas

Mermaid diagramos yra naudingas „GitHub“ papildymas, ypač todėl, kad manome, kad jos skatina geresnį dokumentavimą. Daugelis projektų gali būti patobulinti naudojant tam tikrus vaizdinius paaiškinimus jų dokumentuose arba README failuose.

GitHub dabar tokia populiari paslauga, jos funkcijos ir pakeitimai turi įtakos daugeliui kūrėjų visame pasaulyje. Laimei, Mermaid diagramų palaikymas yra, jei jums to reikia, ir nematomas, jei to nereikia. Tačiau tikimės, kad bent jau pamatysite gražesnius dokumentus.

Kaip nemokamai priglobti svetainę naudojant „GitHub“ puslapius

Jei turite paprastą svetainę, jums nereikia mokėti už žiniatinklio prieglobą. „GitHub“ puslapius galite naudoti nemokamai!

Skaitykite toliau

Apie autorių