Githuba bir proje eklediğimizde ister istemez projemiz ile ilgili açıklama eklememiz gerekiyor. açıklama yaparken genelde nasıl kullanılır ne işe yarar özellikleri nelerdir bunlardan bahsederiz.
Bizler yazılımcılar olarak genelde açıklamaları uygulamalı yani kod yazarak gösteririz.
githubda açıklama dosyasında(readme.md) direk kod yazarsak kod renklendirilmeden text olarak gösterilir ve bu hiçbir yazılımcının hoşuna gitmez :) bunu github da düşünmüş ve bizim için bir syntax highlighter özelliği yapmış bizede bunu kullanmak kalıyor :)
Şimdi github daki syntax highlighter özelliğini nasıl kullanacağımıza bakalım.
öncelikle readme.md dosyamızı açıyoruz ve açıklamamızı yazıyoruz kod eklemek istediğimiz zaman ise githtub un kodumuzu bir kod olduğunu ve bunu renklendirmesi gerektiğini anlatmak içinde aşağıdaki şekilde bir kullanım yapıyoruz.
[html]
```code_type
kodlarımız burada olacak
```
[/html]
code_type yazan kısma ise yazdığımız kodun hangi programlama dilinde yazıldığını belirtiyoruz
örn:
javascript : js
html : html
Css : css
c++ : cpp
java : java
bunlar bildiklerimden birkaçı.
artık kodlarınızı renkli olarak ekleyebilirsiniz :)
Hiç yorum yok:
Yorum Gönder