Merhaba arkadaşlar.
GitHub üzerinde basit söz dizimleriyle etkili belgeler oluşturun.
Kullanabileceğiniz söz dizimleri başlıca şunlardır.
Başlıklar(Headings):
Başlıklarda # işareti kullanılır.# işaretinden sonra boşluk bırakıyoruz başlık olabilmesi için.# işaretini html deki h1 tag ı gibi düşünebilirsiniz.
Bir # işareti en büyük başlık iki ## işareti bir alt başlık üç ### işareti onun bir altı diye devam eder.
Örnek vermek gerekirse
# Birinci başlık ## ikinci başlık ### üçüncü başlık
Yazıları biçimlendirme(Styling text):
Stil | Söz dizimi | Klavye kısayolu | Örnek | Çıkış |
---|---|---|---|---|
Kalın | ** ** veya __ __ | command/ctrl +b | **Kalın yazı örneği** | Kalın yazı örneği |
italik | * * veya _ _ | command/ctrl +i | **italik yazı örneği** | italik yazı örneği |
Üstü çizili | ~~ ~~ | ~~çizili yazı örneği~~ | ||
Kalın ve italik | ** ** ve _ _ | **Kalın ve _itailk_ yazı** | Kalın ve itailk yazı |
Metni alıntı yapma(Quoting text):
Metnin alıntı olduğunu göstermek için başına > işareti koyuyoruz.
> Metin alıntısı
| Metin alıntısı
Kod alıntı yapma(Quoting code):
Kod alıntısı yapmak için ` ` işareti kullanılır.
Örnek vermek gerekirse
Bu gün günlerden `Kod yazma` günü
Bu gün günlerden kod yazma günü
Satır birden fazla olacaksa
Kod yazmak ```` Sabır Emek Dikkat ```` ister.
Link oluşturma(Links):
Link oluştururken bağlantı metni köşeli parantez [] içine yazılır vereceğimiz link devamında parantez () içine yazılır.
Örnek
Dosyayı şu [link](http://www.ramazantufekci.com) den indireblirsiniz.
Kesit linkler(Section links):
Kesit linklerle herhangi bir resme veya herhangi birşeye link verebilirsiniz.
Örnek
[![At resmi](http://www.ramazantufekci.com/favicon.png)](http://nereyegidecekbuat.com)
Relative linkler (Relative links):
Relative linklerle GitHub depomuzdaki dosyaların yolunu gösterebiliriz.
Örnek
[Projenin CoC belgesi](docs/CONTRIBUTING.md)
Liste kullanımı (Lists):
GitHub belgelerinde liste yapmak için – veya * işareti kullanılır.
Eğer listeyi tab tuşu yaparak girintili bir şekilde yazarsanız gruplayarak yazar.
- ekmek - su - peynir
Görev listesi (Task lists):
Görev listeleri oluşturmak için – [] işareti kullanılır.
Tamamlanmış görev için – [x] yazın.
Örnek
- [x] ekmek alındı - [] su al - [] peynir al
Mention kullanma (Mentioning users and teams):
GitHub belgelerinde mention kullanmak için @ işareti kulanmalısınız.
Örnek
@gitHub/ramazantufekci
Issue ve pull isteklerine referans verme (Referencing issues and pull requests):
Belge de referans vermek istediğiniz ıssue ve pull isteklerin numarasının başına # işareti koyuyoruz.
Belge de referans vermek istediğiniz ıssue ve pull isteklerin numarasının başına # işareti koyuyoruz.
Emoji kullanmak (Using emoji):
Belgelerde emoji kullanmak için iki nokta(:emoji: ) arasına kullanmak istediğimiz emojiyi yazıyoruz.
Örnek
:shipit:
Paragraf ve satır sonları (Paragraphs and line breaks):
Satırlar arası boş bir satır bırakarak paragraf oluşturabilirsiniz.
Örnek
Bu bir satırdır. Bu ikinci satırdır.
Escape işlemi (Ignoring Markdown formatting):
Özel karekterlere izin vermek için başına \ işareti kullanıyoruz.