Markdown Biçimlendirme

Nasıl çalışır?

Birkaç kişinin yazdığı bir README ya da yıllardır tutulan bir not dosyası zamanla karışır: kimi madde * ile, kimi - ile başlar, tablo sütunları kaymıştır, başlıkların altında boş satır yoktur. Metni sol panele yapıştırın; sağ panelde her liste maddesi seçtiğiniz imle başlar, alt maddeler iki boşlukla girintilenir, 1) gibi numaralar 1. biçimine geçer ve tablolar sütun sütun hizalanır. Örneğin |Komut|Açıklama| satırı ile altındaki satırlar, en uzun hücreye göre boşlukla doldurulup düz sütunlar hâline gelir; :- ve -: gibi hizalama işaretleri korunur. Başlık, paragraf, liste ve kod bloklarının arasına birer boş satır girer. Kod bloklarının (``` ile açılan) içine hiç dokunulmaz ve paragraflarınızın satır kırılımları olduğu gibi kalır. Sonuç satırı satır sayısını, liste maddesi ve tablo sayısını söyler; metin zaten düzgünse bunu bildirir.

Bu araç markdown formatter, markdown beautifier, markdown tablo hizalama, md formatter aramalarıyla da biliniyor.

Markdown nedir?

Markdown, düz metne birkaç işaretle biçim veren bir yazım dilidir: # başlık, * ya da - madde, ** kalın, ` kod anlamına gelir. GitHub'daki README dosyaları, pek çok not uygulaması ve belge sitesi Markdown kullanır. Metin düz hâliyle de okunacak biçimde tasarlanmıştır; bu yüzden ham metnin düzgün durması, yani tabloların hizalı ve listelerin tek tip olması, ekip çalışmasında önemlidir.

Markdown tablosu (GFM) nedir?

Markdown tablosu, GitHub'ın eklediği (GitHub Flavored Markdown, GFM) bir yazım biçimidir: hücreler | ile ayrılır, başlık satırının altındaki --- satırı tabloyu tanımlar ve :--, --:, :-: işaretleri sütunun sola, sağa ya da ortaya hizalanacağını söyler. Tarayıcıdaki görünüş hücre genişliğine bağlı değildir ama ham metinde sütunlar hizalı değilse tablo okunmaz.

Markdown biçimlendirme ile Markdown'dan HTML'e çevirme arasındaki fark nedir?

Biçimlendirme Markdown'u yine Markdown olarak bırakır; yalnız ham metni düzenler: imleri tekleştirir, tabloyu hizalar, boş satırları yerleştirir. Sonuç aynı README dosyasına geri yapıştırılır. HTML'e çevirme ise Markdown'u bir web sayfasının koduna dönüştürür: # başlık <h1> etiketi, madde <li> olur ve sonuç bir web sayfasına ya da e-postaya konur. Bu sayfa birincisini yapar; ikincisi için Markdown'dan HTML'e aracını kullanın.

Biçimlendirme Markdown'un görünüşünü değiştirir mi?

Hayır. GitHub, GitLab ya da bir not uygulaması Markdown'u HTML'e çevirirken fazladan boşlukları ve hangi madde imini kullandığınızı önemsemez; düzenlenmiş metin aynı sayfayı üretir. Değişen, metnin ham hâlinin okunurluğudur: tabloyu düz metin olarak da okuyabilirsiniz, farklı kişilerin düzenlemeleri aynı görünür ve sürüm kontrolündeki farklar küçülür.

Dikkat edilecek tek nokta şudur: Markdown kuralına göre farklı imle (* ve +) başlayan ardışık satırlar iki ayrı listedir. Araç bu ayrımı korur; ikinci liste diğer imle yazılır. Tek listede toplamak istiyorsanız maddelerin hepsini aynı imle yazın.

Tire mi, yıldız mı?

İkisi de geçerli ve aynı sonucu verir. GitHub'ın kendi belgeleri, Prettier ve çoğu açık kaynak proje tireyi (-) kullanır; yıldız (*) ise eski belgelerde ve bazı not uygulamalarında yaygındır. Projenizde hangisi çoğunluktaysa onu seçin; önemli olan dosyanın içinde tek tip olmasıdır.

Alt alta iki ayrı liste varsa araç ikincisini diğer imle yazar; bu, Markdown'un iki listeyi birleştirmemesi için gereklidir. Numaralı listelerde sayı ve nokta kullanılır (1.), parantezli 1) biçimi de noktaya çevrilir.

• GitHub README, açık kaynak proje → - tire
• Eski belgelere uymak, ekibin alışkanlığı → * yıldız
• Numaralı adımlar → 1. 2. 3. (araç kendisi düzeltir)

Sık sorulanlar

Markdown tablosu nasıl hizalanır?

Tabloyu bu sayfadaki sol panele yapıştırın. Her sütun en uzun hücresine göre boşlukla doldurulur, ayırıcı satır aynı genişliğe getirilir ve hizalama işaretleri (:--, --:, :-:) korunur. Hücre içeriği değişmez.

Kod bloklarımın içi de değişir mi?

Hayır. ``` ya da ~~~ ile açılan kod bloklarının içindeki her karakter olduğu gibi kalır; yalnız bloğun önüne ve arkasına boş satır konur.

Paragraflarımın satırları birleştirilir mi?

Hayır. Paragraf içindeki satır kırılımlarınız korunur; araç uzun satırları kesmez, kısa satırları da birleştirmez.

Metnim bir sunucuya gönderiliyor mu?

Hayır. Düzenleme tamamen tarayıcınızda yapılır; yapıştırdığınız metin bu sayfadan çıkmaz ve hiçbir yere kaydedilmez.