Како укључити дијаграме сирене у свој ГитХуб пројекат

Популарна платформа за дељење кодова, ГитХуб, најавила је подршку за нову врсту уграђеног садржаја. У датотекама за означавање сада можете да користите синтаксу Мермаид за лако креирање дијаграма тока, дијаграма секвенце и још много тога.

ГитХуб-ов укус маркдовн-а већ обрађује слике, листе задатака и кратке кодове емоџија. Уз подршку за уобичајене дијаграме, ГитХуб чини свој део за информативнију, кориснију документацију.

Шта је ново са ГитХуб-ом?

Сада можете да уградите сирени код у свој РЕАДМЕ.мд и друге датотеке за смањење вредности. Ако то учините, ГитХуб ће приказати дијаграм описан тим кодом. Мермаид код користи једноставну синтаксу која описује појединачне делове сваког дијаграма у обичном тексту.

Такође видети: Шта је ГитХуб? Увод у његове основне карактеристике

Како укључујете дијаграме?

1. Или изаберите постојећу маркдовн датотеку или креирајте нову за додавање у своје спремиште. Користите било које .доктор медицине или .маркдовн проширења.
2. Додајте мало сирене кода у ту датотеку. Који тачно код зависи од вас; ево једноставног примера за почетак:
   instagram viewer

   граф ТД;
    А-->Б;
    А-->Ц;
    Б-->Д;
    Ц-->Д;

3. Погледајте датотеку на ГитХуб-у. Требало би да видите леп приказ вашег дијаграма.

Сада само треба да научите богатство дијаграма које Мермаид има на располагању. Или можете једноставно да се позовете на сирена документацију као и када вам је потребан дијаграм.

Које врсте дијаграма могу да користим?

Мермаид подржава следеће типове дијаграма:

• Дијаграм тока
• Низ
• Класа
• Држава
• Однос ентитета
• Путовање корисника
• Гантт
• Пита
• Услов

Такође видети: Гантов графикон вс. ПЕРТ графикон: Које су разлике?

Сваки има своју синтаксу, која одражава тип података које дијаграм приказује. На пример, ево кода за једноставан дијаграм секвенце:

секвенцијаграм
 Барт->>Хомер: Немој имати краву, човече.

Што изгледа овако када се прикаже:

А ево кода за основни дијаграм стања:

статеДиаграм-в2
 [*] --> Ново
 Ново --> Спремно: примљено
 Спреман --> Покреће се: отпремање планера
 Трчање --> Спреман: прекид
 Трчање --> Чекање: И/О или чекање догађаја
 Чекање --> Спреман: И/О или завршетак догађаја
 Трчање --> Завршено: излаз
 Прекинуто --> [*]

Што се као такво приказује:

Додајте вредност својим ГитХуб пројектима помоћу Мермаид дијаграма

Дијаграми сирене су користан додатак ГитХуб-у, посебно зато што верујемо да подстичу бољу документацију. Многи пројекти би се могли побољшати неким визуелним објашњењима директно у њиховој документацији или РЕАДМЕ датотекама.

ГитХуб је сада тако популаран сервис, његове карактеристике и промене утичу на многе програмере широм света. Срећом, подршка за дијаграме сирене је ту ако вам је потребна, а невидљива је ако не. Али, надамо се да ћете почети да видите барем неку лепшу документацију.

Како бесплатно хостовати веб локацију користећи ГитХуб странице

Ако имате једноставну веб локацију, не морате да плаћате за веб хостинг. Можете бесплатно користити ГитХуб странице!

Реад Нект

О аутору