Markdown Lint
Markdown dosyalarını, birçok düzenleyici ve CI işlem hattında kullanılan markdownlint ile stil ve söz dizimi sorunlarına karşı denetleyin. Bir belge yapıştırın; satırını, MD001 gibi kuralı ve açıklamasıyla birlikte her bulguyu görün. İsteğe bağlı olarak markdownlint'in boş satırlar, liste işaretleri ve boşluklar gibi düzeltebildiği noktaları düzelttiği bir sürüm alın.
Sık sorulan sorular
Hangi kurallar denetlenir?
markdownlint'in varsayılan olarak etkinleştirdiği tüm kurallar denetlenir: MD001'den (başlık düzeyleri birer birer artar) listeler, boş satırlar, kod blokları, bağlantılar ve vurgu kurallarına kadar. En fazla satır uzunluğu ayarlamadığınız sürece satır uzunluğu kuralı MD013 kapalıdır.
Kuralları nasıl kapatabilirim?
Kapatılacak kuralları, MD033 gibi numaralar veya no-inline-html gibi adlar kullanarak ve virgül ya da boşlukla ayırarak devre dışı bırakılacak kurallar alanına yazın. <!-- markdownlint-disable MD033 --> gibi satır içi yorumlar da işe yarar.
Düzeltme seçeneği ne işe yarar?
markdownlint'in sunduğu otomatik düzeltmeleri uygular; örneğin başlıkların ve listelerin çevresine boş satır ekler, liste işaretlerini tutarlı hâle getirir veya sondaki boşlukları kaldırır ve düzeltilmiş belgeyi gösterir. Otomatik düzeltmesi olmayan bulguları elle düzeltmeniz gerekir.
Hangi markdownlint sürümü kullanılıyor?
markdownlint 0.42.0; Visual Studio Code için markdownlint uzantısının ve markdownlint-cli2'nin temel aldığı kitaplıktır. Aynı sürüm ve varsayılan yapılandırmayla aynı bulguları bildirirler.
İlk başlığımdan neden şikâyet ediyor?
MD041 kuralı, belgenin en üst düzey bir başlıkla başlamasını bekler; MD025 ise yalnızca bir başlığa izin verir. Platformunuz başlığı kendisi ekliyorsa bu kuralları belgeniz için devre dışı bırakın.
Kaç bulgu gösteriliyor?
Toplam sayı her zaman bildirilir ve ilk 500 bulgu tabloda listelenir. İlk bulguları düzeltip gerisini görmek için denetimi yeniden çalıştırın.