Kuidas lisada oma GitHubi projekti merineitsi diagrammid

Populaarne koodijagamisplatvorm GitHub on teatanud toetust uut tüüpi manustatud sisule. Märgistusfailides saate nüüd kasutada Mermaid süntaksit, et hõlpsasti luua vooskeeme, järjestusskeeme ja muud.

GitHubi allahindluse maitse käsitleb juba pilte, ülesannete loendeid ja emotikonide lühikoode. Levinud diagrammide toega annab GitHub oma panuse informatiivsema ja kasulikuma dokumentatsiooni saamiseks.

Mis on GitHubis uut?

Nüüd saate oma merineitsi koodi manustada README.md ja muud allahindlusfailid. Kui teete, renderdab GitHub selle koodiga kirjeldatud diagrammi. Merineitsi kood kasutab lihtsat süntaksit, mis kirjeldab iga diagrammi üksikuid osi lihttekstina.

Vaata ka: Mis on GitHub? Sissejuhatus selle põhifunktsioonidesse

Kuidas diagramme kaasata?

1. Valige olemasolev allahindlusfail või looge hoidlasse lisamiseks uus. Kasutage kumbagi .md või .markdown laiendused.
2. Lisage sellele failile merineitsi kood. Täpselt, milline kood on teie otsustada; siin on alustamiseks lihtne näide:

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

instagram viewer
3. Vaadake faili GitHubis. Peaksite nägema oma diagrammi ilusat renderdamist.

Nüüd peate lihtsalt õppima Mermaid saadaolevate diagrammide rikkalikkust. Või võite lihtsalt viidata Merineitsi dokumentatsioon, kui ja millal vajate diagrammi.

Milliseid diagramme saan kasutada?

Mermaid toetab järgmist tüüpi diagramme:

• Vooskeem
• Järjestus
• Klass
• osariik
• Olemi suhe
• Kasutaja teekond
• Gantt
• Pirukas
• Nõue

Vaata ka: Gantti diagramm vs. PERT-i diagramm: millised on erinevused?

Igal neist on oma süntaks, mis kajastab diagrammil kuvatavate andmete tüüpi. Näiteks siin on lihtsa järjestusskeemi kood:

järjestusskeem
 Bart->> Homer: Ära pea lehma, mees.

Mis renderdamisel näeb välja selline:

Ja siin on põhioleku diagrammi kood:

olekDiagramm-v2
 [*] --> Uus
 Uus --> Valmis: lubatud
 Valmis --> Töötab: ajakava saatmine
 Töötab --> Valmis: katkesta
 Töötab --> Ootamine: I/O või sündmuse ootamine
 Ootel --> Valmis: I/O või sündmuse lõpetamine
 Töötab --> Lõpetatud: välju
 Lõpetatud --> [*]

Mis renderdab sellisena:

Lisage oma GitHubi projektidele väärtust merineitsi diagrammide abil

Merineitsi diagrammid on GitHubile kasulik lisand, eriti kuna usume, et need soodustavad paremat dokumenteerimist. Paljusid projekte saab täiustada visuaalsete selgitustega otse nende dokumentatsioonis või README-failides.

GitHub on nüüd nii populaarne teenus, selle funktsioonid ja muudatused mõjutavad paljusid arendajaid üle maailma. Õnneks on Merineitsi diagrammide tugi olemas, kui seda vajate, ja nähtamatu, kui te seda ei vaja. Kuid loodetavasti hakkate nägema vähemalt ilusamat dokumentatsiooni.

Kuidas GitHubi lehtede abil veebisaiti tasuta majutada

Kui teil on lihtne veebisait, ei pea te veebimajutuse eest maksma. GitHubi lehti saate kasutada tasuta!

Loe edasi

Autori kohta