GitHub Projenize Deniz Kızı Diyagramlarını Nasıl Dahil Edersiniz?

Popüler kod paylaşım platformu GitHub, yeni bir gömülü içerik türü için desteğini duyurdu. İşaretleme dosyalarında, akış çizelgeleri, sıra şemaları ve daha fazlasını kolayca oluşturmak için artık Deniz Kızı sözdizimini kullanabilirsiniz.

GitHub'ın işaretleme özelliği zaten görüntüleri, görev listelerini ve emoji kısa kodlarını işliyor. Yaygın diyagramları destekleyen GitHub, daha bilgilendirici ve kullanışlı belgeler için üzerine düşeni yapıyor.

GitHub'daki Yeni Neler Var?

Artık Denizkızı kodunu gömebilirsiniz. BENİOKU.md ve diğer markdown dosyaları. Bunu yaparsanız GitHub, bu kod tarafından açıklanan bir diyagram oluşturacaktır. Deniz kızı kodu, her bir diyagramın tek tek bölümlerini düz metin olarak açıklayan basit bir sözdizimi kullanır.

Ayrıca bakınız: GitHub Nedir? Temel Özelliklerine Giriş

Diyagramları Nasıl Eklersiniz?

1. Ya mevcut bir markdown dosyası seçin ya da deponuza eklemek için yeni bir tane oluşturun. Either "kalıbını kullanınız .md veya .markdown uzantılar.
2. Bu dosyaya biraz Denizkızı kodu ekleyin. Tam olarak hangi kod size kalmış; İşte başlamak için basit bir örnek:
   instagram viewer

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

3. Dosyayı GitHub'da görüntüleyin. Diyagramınızın güzel bir görüntüsünü görmelisiniz.

Şimdi sadece Mermaid'in sunduğu zengin diyagramları öğrenmeniz gerekiyor. Veya basitçe şuna başvurabilirsiniz: Deniz Kızı bir diyagrama ihtiyaç duyduğunuzda belgeler.

Ne Tür Diyagramlar Kullanabilirim?

Deniz kızı aşağıdaki diyagram türlerini destekler:

• akış şeması
• Sekans
• Sınıf
• Belirtmek, bildirmek
• Varlık İlişkisi
• Kullanıcı Yolculuğu
• Gantt
• Turta
• Gereklilik

Ayrıca bakınız: Gantt Grafiği vs. PERT Şeması: Farklar Nelerdir?

Her birinin, diyagramın görüntülediği veri türünü yansıtmak için kendi sözdizimi vardır. Örneğin, basit bir dizi diyagramının kodu:

sıra diyagramı
 Bart->>Homer: İnek alma dostum.

İşlendiğinde şuna benzer:

Ve işte temel durum diyagramının kodu:

durum Diyagramı-v2
 [*] --> Yeni
 Yeni --> Hazır: kabul edildi
 Hazır --> Çalışıyor: zamanlayıcı gönderimi
 Çalışıyor --> Hazır: kesinti
 Çalışıyor --> Bekliyor: G/Ç veya olay bekleme
 Bekliyor --> Hazır: G/Ç veya olay tamamlama
 Çalışıyor --> Sonlandırıldı: çıkış
 Sonlandırılmış --> [*]

Hangi gibi işler:

Deniz Kızı Diyagramları ile GitHub Projelerinize Değer Katın

Denizkızı diyagramları, özellikle daha iyi belgeleri teşvik ettiklerini düşündüğümüzden, GitHub'a faydalı bir ektir. Pek çok proje, belgelerinde veya README dosyalarında bazı görsel açıklayıcılar ile geliştirilebilir.

GitHub artık çok popüler bir hizmet, özellikleri ve değişiklikleri dünya çapında birçok geliştiriciyi etkiliyor. Neyse ki, ihtiyacınız olduğunda Deniz Kızı diyagramları desteği var ve ihtiyacınız yoksa görünmez. Ancak, umarım, en azından daha güzel belgeler görmeye başlarsınız.

GitHub Sayfalarını Kullanarak Bir Web Sitesini Ücretsiz Olarak Barındırma

Basit bir web siteniz varsa, web barındırma için ödeme yapmanız gerekmez. GitHub Sayfalarını ücretsiz kullanabilirsiniz!

Sonrakini Oku

Yazar hakkında