Çevrimiçi Markdown önizlemesi ve yerel doküman yapısı farklı sorulara yanıt verir. Çevrimiçi bir önizleme şu soruyu sorar: "Bu İşaretleme genel önizlemede temiz bir şekilde işleniyor mu ve bariz yazma sorunları var mı?" Yerel bir doküman yapısı şu soruyu sorar: "Bu içerik gerçek dokümantasyon sistemimizde çalışıyor mu?"
Her ikisi de faydalıdır. Hata, bir katmandan diğer katmanın işini yapmasını istemektir. Converty'nin Markdown Doğrulayıcısı hızlı bir erken kontroldür. Yerel doküman derlemeniz, platforma özel oluşturmanın önemli olduğu durumlarda son ortam kontrolü olmaya devam eder.
Hızlı taslak incelemesi için çevrimiçi önizlemeyi kullanın
İçerik hala hareket halindeyken çevrimiçi Markdown önizlemesi kullanışlıdır. Bir README bölümü, sürüm notu, değişiklik günlüğü girişi veya destek belgesi, bir çekme isteği veya belge derlemesi haline gelmeden önce kontrol edilebilir.
Önizleme şunları yakalamanıza yardımcı olur:
- kırık görünümlü masalar
- başlık yapısı sorunları
- alternatif metin eksik
- boş bağlantılar
- etiketlenmemiş kod çitleri
- incelenmesi gereken ham HTML
Bu, hızlı geri bildirimin tam ortam doğruluğundan daha önemli olduğu aşamadır.
Son işleme için yerel bir doküman yapısı kullanın
Yerel doküman yapısı, son platformun özel davranışı olduğunda doğru katmandır. Birçok doküman sistemi Markdown'ı bileşenler, yönlendirme, sözdizimi vurgulama, özel belirtme çizgileri veya çerçeveye özgü stil aracılığıyla dönüştürür.
Yalnızca yerel yapı, içeriğin o ortamda çalışıp çalışmadığını gösterebilir. Bir sayfada özel bileşenler, içe aktarılan parçacıklar veya ürüne özel oluşturma kullanılıyorsa, tarayıcı önizlemesi sonuncu değil ilk sırada gelmelidir.
En iyi iş akışı her ikisini de kullanır
Kaynağı temizlemek için çevrimiçi önizlemeyi kullanın. Hedefi doğrulamak için yerel yapıyı kullanın.
Bu sıra, yerel yapının artık temel Markdown hatalarını yakalayamamasından dolayı zaman tasarrufu sağlar. Benzersiz bir şekilde test edebildiği platforma özgü davranışa odaklanabilir.
Pratik bir erken inceleme iş akışı için Taahhüt Etmeden Önce GitHub-Flavored Markdown Nasıl Önizlenir konusunu okuyun. Ürün ve dokümanların aktarımı için Ürün ve Dokümanlar Ekipleri Biçimlendirmeyi Kaybetmeden Markdown'ı Nasıl İnceleyebilir? konusunu okuyun.
Aynı içeriği yerel bir doküman derlemesine veya son yayınlama önizlemesine taşımadan önce hızlı çevrimiçi önizleme katmanına ihtiyaç duyduğunuzda Markdown Doğrulayıcı'yı açın.
