Markdown Linter
Markdown stili ve yapı sorunlarını analiz edin
Girdi Markdown
Lint Raporu
Markdown Linter Nedir?
Markdown linter, Markdown dosyalarını analiz eden ve belgeleri okunması ve bakımı zor hale getiren stil ihlallerini, biçimlendirme tutarsızlıklarını ve yapısal sorunları raporlayan bir kod kalite aracıdır. Masaüstündeki markdownlint'e benzer şekilde, bu tarayıcı tabanlı linter içerikleri hiçbir yere yüklemeden yerel olarak çalışır.
Markdown linterların çoğu yanlış iç içe geçmiş başlık seviyeleri (H1'den doğrudan H3'e atlamak), aşırı uzun satırlar, tutarsız liste işaretçileri ve başlıkların etrafındaki eksik boş satırlar gibi sorunları kontrol eder. markdownlint projesi, endüstri standardı haline gelen kapsamlı bir kural seti tanımlar.
Bu sorunları erken tespit ederek, Markdown linter belgeleme incelemelerinde zaman kazandırır ve okuyucularda karışıklığı önler. Tarayıcı tabanlı yaklaşım, harici bağımlılıklar olmadan anında geri bildirim sağlar — belgeleme, README'ler, blog gönderileri ve teknik kılavuzlar yazmak için mükemmeldir.
Markdown Linter Nasıl Kullanılır?
Markdown stili ve yapısını analiz etmek için bu adımları izleyin. Her adım bu sayfadaki gerçek düğmeleri ve panelleri kullanır.
Yapıştırın, yükleyin veya örnek yükleyin
Sol Girdi Markdown paneline Markdown yapıştırın veya bir .md dosyası yüklemek için Yükleye tıklayın. Kasıtlı stil sorunları içeren belgeleri görmek için Örneke tıklayın. Başlık hiyerarşisini, satır uzunluğunu, liste tutarlılığını ve sondaki boşlukları kontrol eder.
Lint raporunu görüntüleyin
Sağ Lint Raporu paneli sorunları satır numaraları ve açıklamalarla listeler. Başlık atlamalarını, uzun satırları, karma liste işaretçilerini ve boşluk sorunlarını düzeltin.
Raporu kopyalayın veya indirin
Raporu kullanmak için Kopyala veya İndire tıklayın. Sıfırdan başlamak için Temizleyi kullanın. Tüm işlemler tarayıcınızda çalışır.
Gerçek Kullanım Senaryoları
Belgeleme İnceleme İş Akışları
Belgeleme güncellemelerini içeren pull requestleri göndermeden önce stil ihlallerini tespit etmek için linter'ı çalıştırın. GitHub Docs gibi büyük siteleri yöneten ekipler CI/CD pipeline'larında benzer araçlar kullanır.
Teknik Yazarlık Standartları
Blog yazıları, eğitimler ve kılavuzlarda tutarlı başlık yapısını ve biçimlendirmeyi zorunlu kılın. dev.to veya Medium gibi Markdown odaklı platformlar için özellikle önemlidir.
Açık Kaynak Proje Bakımı
Katkıda bulunanların gönderdiği belgelerin proje stili kılavuzuna uymasını birleştirmeden önce doğrulayın. Lint kontrollerini yerel olarak çalıştırmak katkıda bulunanların kendilerini düzeltmesine yardımcı olur. Birçok proje linting'i GitHub Actions iş akışlarına ekler.
Hızlı Kalite Kontrolü
Yayınlamadan önce README dosyaları, API belgeleri ve sürüm notlarında son kontrol için kullanın. Ekstra boşluklar ve geçersiz başlık dizileri gibi kolayca gözden kaçabilecek sorunları tespit eder.
Sık Sorulan Sorular
Linter ve doğrulayıcı arasındaki fark nedir?
Doğrulayıcı, Markdown'ın sözdizimsel olarak doğru olup olmadığını ve doğru şekilde işlenip işlenmediğini kontrol eder. Linter daha ileri giderek stil tutarlılığını ve iyi uygulamaları zorlar. Doğrulamayı yazım denetimi, linting'i ise dilbilgisi kontrolü olarak düşünün. markdownlint belgesi bu ayrımı açıklar.
Linter'ın hangi kuralları kontrol edeceğini özelleştirebilir miyim?
Bu tarayıcı tabanlı linter, en yaygın sorunlara odaklanan önceden tanımlanmış bir kural seti kullanır. Tam özelleştirme için masaüstü paketi markdownlint, yapılandırma dosyaları aracılığıyla belirli kuralları etkinleştirmeye/devre dışı bırakmaya izin verir.
Linter Markdown'ımı herhangi bir sunucuya gönderiyor mu?
Hayır. Tüm linting, JavaScript kullanarak tamamen tarayıcıda gerçekleşir. Markdown içeriği hiçbir zaman bilgisayarı terk etmez. Tescilli belgeler, özel projeler ve hassas bilgiler için güvenlidir.
Bu linter hangi Markdown lehçesini destekler?
Bu linter, en taşınabilir ve geniş çapta desteklenen Markdown standardı olan CommonMark spesifikasyonunu temel olarak izler. GitHub Flavored Markdown, CommonMark'ı tablolar ve üstü çizili metin ile genişletir.
Linter tarafından bulunan sorunları nasıl düzeltirim?
Rapordaki her sorun satır numarasını ve açıklamayı içerir. Yaygın düzeltmeler: başlıkları mantıksal olarak sıralama, sondaki boşlukları kaldırma, başlıkların etrafına boş satırlar ekleme, satırları 80 karakterin altında tutma ve tutarlı liste işaretçileri kullanma. Markdown Guide'da ayrıntılı örnekler bulunur.
Üretim belgeleme kontrolleri için kullanabilir miyim?
Bir kerelik kontroller için evet. CI/CD pipeline'larında otomatik zorlama için komut satırı aracı markdownlint-cli'yi derleme sürecinize entegre edin.