Merenneitokaavioiden sisällyttäminen GitHub-projektiisi

Suosittu koodinjakoalusta GitHub on ilmoittanut tukevansa uudenlaista upotettua sisältöä. Merkintätiedostoissa voit nyt käyttää Mermaid-syntaksia luodaksesi helposti vuokaavioita, sekvenssikaavioita ja paljon muuta.

GitHubin markdown-maku käsittelee jo kuvia, tehtäväluetteloita ja emoji-lyhyitä koodeja. Yleisten kaavioiden tuella GitHub tekee osansa informatiivisemman ja hyödyllisemmän dokumentaation saamiseksi.

Mitä uutta GitHubissa?

Voit nyt upottaa Mermaid-koodin omaan README.md ja muut merkintätiedostot. Jos teet niin, GitHub hahmontaa koodin kuvaaman kaavion. Merenneitokoodi käyttää yksinkertaista syntaksia, joka kuvaa kunkin kaavion yksittäiset osat pelkkänä tekstinä.

Katso myös: Mikä on GitHub? Johdatus sen perusominaisuuksiin

Kuinka sisällytät kaavioita?

1. Valitse joko olemassa oleva merkintätiedosto tai luo uusi lisättäväksi arkistoon. Käytä jompaakumpaa .md tai .markdown laajennuksia.
2. Lisää siihen tiedostoon merenneitokoodi. Tarkka koodi on sinun; tässä yksinkertainen esimerkki aloittaaksesi:

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

instagram viewer
3. Tarkastele tiedostoa GitHubissa. Sinun pitäisi nähdä kaaviostasi kaunis esitys.

Nyt sinun tarvitsee vain oppia Mermaidin saatavilla olevat kaaviot. Tai voit yksinkertaisesti viitata Merenneito dokumentaatio aina kun tarvitset kaavion.

Millaisia ​​kaavioita voin käyttää?

Mermaid tukee seuraavan tyyppisiä kaavioita:

• Vuokaavio
• Järjestys
• Luokka
• Osavaltio
• Kokonaisuussuhde
• Käyttäjän matka
• Gantt
• Piirakka
• Vaatimus

Katso myös: Gantt-kaavio vs. PERT-kaavio: Mitkä ovat erot?

Jokaisella on oma syntaksinsa, joka kuvastaa kaaviossa näytettävän datan tyyppiä. Tässä on esimerkiksi koodi yksinkertaiselle sekvenssikaaviolle:

sekvenssikaavio
 Bart->> Homer: Älä pidä lehmää, mies.

Joka näyttää renderöitynä tältä:

Ja tässä on perustilakaavion koodi:

tilakaavio-v2
 [*] --> Uusi
 Uusi --> Valmis: hyväksytty
 Valmis --> Käynnissä: ajoituslähetys
 Käynnissä --> Valmis: keskeytä
 Käynnissä --> Odottaa: I/O tai tapahtuma odota
 Odotetaan --> Valmis: I/O tai tapahtuma on valmis
 Käynnissä --> Lopetettu: poistu
 Lopetettu --> [*]

Mikä tekee sellaisena:

Lisää arvoa GitHub-projekteihisi merenneitokaavioiden avulla

Merenneitokaaviot ovat hyödyllinen lisä GitHubiin, varsinkin kun uskomme niiden kannustavan parempaan dokumentointiin. Monia projekteja voitaisiin parantaa visuaalisilla selityksillä suoraan niiden dokumentaatiossa tai README-tiedostoissa.

GitHub on nyt niin suosittu palvelu, että sen ominaisuudet ja muutokset vaikuttavat moniin kehittäjiin ympäri maailmaa. Onneksi Mermaid-kaavioiden tuki on olemassa, jos tarvitset sitä, ja näkymätöntä, jos et tarvitse. Mutta toivottavasti alat nähdä ainakin hienompaa dokumentaatiota.

Kuinka isännöidä verkkosivustoa ilmaiseksi GitHub-sivujen avulla

Jos sinulla on yksinkertainen verkkosivusto, sinun ei tarvitse maksaa webhotellista. Voit käyttää GitHub-sivuja ilmaiseksi!

Lue Seuraava

Kirjailijasta