A sellődiagramok felvétele a GitHub projektbe

A népszerű kódmegosztó platform, a GitHub bejelentette, hogy támogatja az új típusú beágyazott tartalmakat. A lejelölő fájlokban a Mermaid szintaxis segítségével egyszerűen hozhat létre folyamatábrákat, szekvenciadiagramokat és sok mást.

A GitHub markdown íze már kezeli a képeket, a feladatlistákat és az emoji rövid kódokat. A gyakori diagramok támogatásával a GitHub mindent megtesz az informatívabb, hasznosabb dokumentációért.

Mi új a GitHubban?

Most már beágyazhat Mermaid kódot a sajátjába README.md és egyéb leértékelési fájlok. Ha igen, a GitHub egy diagramot jelenít meg, amelyet az adott kód ír le. A Mermaid kód egy egyszerű szintaxist használ, amely egyszerű szövegben írja le az egyes diagramok egyes részeit.

Lásd még: Mi az a GitHub? Bevezetés az alapvető funkciókba

Hogyan kell beépíteni a diagramokat?

1. Vagy válasszon egy meglévő leértékelési fájlt, vagy hozzon létre egy újat, amelyet hozzáadhat a tárhoz. Használja bármelyiket .md vagy .árleszállítás kiterjesztések.
2. Adjon hozzá egy hableány kódot a fájlhoz. Hogy pontosan milyen kódot, az Önön múlik; íme egy egyszerű példa a kezdéshez:
   instagram viewer

   gráf TD;
    A-->B;
    A-->C;
    B-->D;
    C-->D;

3. Tekintse meg a fájlt a GitHubon. Látnia kell a diagram szép megjelenítését.

Most már csak meg kell tanulnia a Mermaid által elérhető diagramok gazdagságát. Vagy egyszerűen hivatkozhat a Sellő dokumentációt, amikor és amikor diagramra van szüksége.

Milyen diagramokat használhatok?

A Mermaid a következő típusú diagramokat támogatja:

• Folyamatábra
• Sorrend
• Osztály
• Állapot
• Entitás kapcsolat
• Felhasználói utazás
• Gantt
• Pite
• Követelmény

Lásd még: Gantt diagram vs. PERT diagram: Mik a különbségek?

Mindegyiknek saját szintaxisa van, amely tükrözi a diagramon megjelenített adatok típusát. Például itt van egy egyszerű szekvenciadiagram kódja:

szekvenciadiagram
 Bart->>Homer: Ne legyen tehened, ember.

Ami így néz ki rendereléskor:

És itt van az alap állapotdiagram kódja:

stateDiagram-v2
 [*] --> Új
 Új --> Kész: elismerve
 Kész --> Fut: ütemező feladás
 Futás --> Kész: megszakítás
 Futás --> Várakozás: I/O vagy esemény várakozás
 Várakozás --> Kész: I/O vagy esemény befejezése
 Futás --> Megszakítva: kilépés
 Megszűnt --> [*]

Ami így jelenik meg:

Adjon értéket GitHub-projektjeihez sellődiagramokkal

A sellődiagramok hasznos kiegészítői a GitHubnak, különösen azért, mert úgy gondoljuk, hogy jobb dokumentációra ösztönöznek. Számos projekt javítható vizuális magyarázatokkal közvetlenül a dokumentációban vagy a README fájlokban.

A GitHub ma már nagyon népszerű szolgáltatás, szolgáltatásai és változásai sok fejlesztőt érintenek szerte a világon. Szerencsére a Mermaid diagramok támogatása rendelkezésre áll, ha szüksége van rá, és láthatatlan, ha nincs rá szüksége. De remélhetőleg legalább szebb dokumentációt fog látni.

Hogyan lehet ingyenesen tárolni egy webhelyet a GitHub oldalak használatával

Ha egyszerű webhelye van, nem kell fizetnie a webtárhelyért. A GitHub oldalakat ingyenesen használhatod!

Olvassa el a következőt

A szerzőről