Markdown Preview
Live Markdown preview
Live Markdown preview Tarayıcınızda yerel olarak çalışır
About the
Markdown Önizleme, siz yazarken Markdown dosyanızı, çoğu kişinin gerçekte kullandığı GitHub uzantılarıyla CommonMark'ı takip ederek yan yana görünümde işler: tablolar, görev listeleri, çitle çevrilmiş kod blokları, üstü çizili ve otomatik bağlantılar. Bu, bir README'yi işlemeden önce kontrol etmenin en hızlı yoludur, çünkü Markdown'nin kaynakta nasıl göründüğü ile oluşturulmuş gibi nasıl göründüğü arasındaki farklar açık değildir ve özellikle tek bir çizgi veya çizgi yanlış olduğunda tablo sözdizimi sessizce başarısız olur. Oluşturulan HTML, Markdown'nin kendisini işlemeyen bir yere ihtiyaç duymanız durumunda da kopyalanabilir.
Where people use the
- Bir README'nin kontrol edilmesi, onu basmadan önce doğru şekilde işlenir.
- Sonucun canlı görüntüsünü içeren sürüm notları veya değişiklik günlüğü taslağı hazırlamak.
- Markdown kabul etmeyen bir CMS için Markdown belgesini HTML'ye dönüştürme.
- Başka birinin Markdown çekme isteğini incelemek ve neye benzeyeceğini görmek.
How to use the
- 1
Markdown kodunu yapıştırın veya yazın
Editör, tek bir paragraftan başlıklar, listeler, bağlantılar ve kod çerçeveleri içeren tam bir belgeye kadar her şeyi kabul eder.
- 2
Oluşturulan paneli izleyin
Önizleme her tuş vuruşunda güncellenir, böylece kırık bir masa veya kapatılmamış bir çit, yayınlama adımından sonra hemen ortaya çıkar.
- 3
Önizlemeyi değil kaynağı düzeltin
Önizleme salt okunurdur. Bir şey yanlış işlendiğinde bunun nedeni neredeyse her zaman listeden önce eksik olan boş bir satır veya sınırlayıcı satırı olmayan bir tablo başlığıdır.
- 4
İhtiyacınız varsa HTML'yi kopyalayın
Oluşturulan işaretlemeyi almak için HTML görünümüne geçin; bu, Markdown yerine HTML bekleyen bir CMS'ye yapıştırmak için kullanışlıdır.
İpuçları ve en iyi uygulamalar
- Her blok öğesinden önce ve sonra boş bir satır bırakın; Çoğu gizemli görüntü oluşturma hatası eksik bir boş satırdır.
- Kodun düz metin olarak değerlendirilmek yerine vurgulanması için dil adı içeren çitlerle çevrili kod blokları kullanın.
- Uzun belgelerde satır başına bir cümle tutun; farkları daha sonra okunabilir hale getirir.
Sık sorulan sorular
Hangi Markdown spesifikasyonu kullanılıyor?
Temel olarak CommonMark'ın yanı sıra tablolar, görev listeleri, çitli kod ve üstü çizili için GitHub Aromalı Markdown uzantıları. Bu kombinasyon GitHub, GitLab ve çoğu dokümantasyon sitesindeki README formatını kapsar.
Masam neden oluşturulmuyor?
Bir tablonun, bloktan önce boş bir satır bulunan bir başlık satırının hemen ardından sınırlayıcı çizgi satırına ihtiyacı vardır. Her satırda başlıkla aynı sayıda boru bulunmalıdır. Eksik olanlardan herhangi biri, her şeyi içinde boru karakterleri bulunan bir paragraf paragrafına dönüştürür.
Liste öğelerim neden tek bir paragrafta birleşti?
Markdown paragraf ile onu takip eden liste arasında boş bir satıra ihtiyaç duyar. Bu olmadan liste işaretçileri sıradan metin olarak kabul edilir.
LaTeX'i veya matematiği destekliyor mu?
Hayır. Math rendering, KaTeX veya MathJax gibi ayrı bir kitaplığa ve farklı bir sözdizimine ihtiyaç duyar. Buradaki dolar işareti ifadesi düz metin olarak işlenecektir.
Ham HTML'ye izin veriliyor mu?
Evet, satır içi HTML doğrudan geçer; GitHub da bunu yapar. Çıktıyı halka açık herhangi bir yerde yayınlarsanız, önce onu temizleyin, çünkü ham HTML aynı zamanda komut dosyalarının da nasıl enjekte edildiğini gösterir.
Mesajım nereye gidiyor?
Hiçbir yerde. Ayrıştırma ve oluşturma, tarayıcınızda bir JavaScript Markdown kitaplığıyla gerçekleşir. Hiçbir şey kaydedilmez veya iletilmez, dolayısıyla kopyalamadığınız sürece sekmeyi kapattığınızda taslak kaybolur.