Markdown Biçimlendirici

Biçimlendiricinin düzelttikleri

• Liste işaretleri. *, -, + tümü tutarlı tek bir karaktere (varsayılan -) standartlaştırılır.
• Başlık hiyerarşisi. H2’yi arada H3 olmadan H4 izlediğinde uyarır (veya düzeyi yükseltir).
• Boş satırlar. Bloklar arasında tam olarak bir boş satır; üç veya daha fazla ardışık satır olmaz.
• Tablolar. Markdown işleyicileri umursamasa da, kaynakta borular (|) hizalansın diye her sütunu doldurur.
• Sondaki boşluklar. İki boşluklu kasıtlı satır sonu işareti dışında her satırın sonundaki boşlukları temizler.
• Referans bağlantıları. [label]: url tanımlarını belgenin sonunda toplar, alfabetik olarak sıralar.
• Kod çitleri. Dil etiketi küçük harfe standartlaştırılır; girinti tabanlı kod blokları çitli bloklara dönüşür.

Ayarlayabileceğiniz stil seçenekleri

Tutarlı Markdown neden önemlidir

Bir ekip deposunda tutarsız Markdown gürültülü farklar üretir: biri dosyayı farklı bir düzenleyiciyle her kaydettiğinde liste işaretleri yer değiştirir ve tablolar yeniden akar. Bir biçimlendirici tek bir stili dayatır, böylece pull request inceleyicileri yalnızca içerik değişikliklerini görür. Bunu düzyazı için prettier gibi düşünün.

Ne zaman biçimlendirilmemeli

• Çitli kod blokları bayt bayt olduğu gibi kalır, biçimlendirici bir kod bloğunun içeriğine asla dokunmaz. Biçimlendirme kodu değiştiriyorsa bu bir hatadır.
• Dar genişliklerde kasıtlı sabit satır sonları (terminal projesindeki readme.md gibi), sarma sütununu etkinleştirirseniz yeniden sarılır. Elle ayarlanmış satır sonlarını koruyorsanız sarmayı kapatın.
• Gömülü HTML blokları değişmeden geçer.

Doğrudan yerine geçenler

Yerel bir CLI’yi tercih ediyorsanız, biçimlendirici remark-gfm eklentisiyle remark-stringify ile aynı AST kurallarını kullanır. prettier --parser markdown de benzer bir sonuç üretir.