Markdown Önizleme
Solda Markdown yazın. Sağ taraf biçimlenmiş sonucu gösterir. Metindeki HTML etiketleri metin olarak kalır; bir README burada betik (script) çalıştıramaz.
Ne işe yarar?Ne işe yarar?
Markdown, birkaç işaretle yazılmış düz metindir: başlık için #, liste için -, kalın için **. README dosyaları, GitHub yorumları ve değişiklik günlükleri (changelog) bunu kullanır. Bu sayfa bir önizlemedir. CommonMark kurallarının hepsini uygulamaz. Tablo, dipnot ve ham HTML, HTML’e çevrilmez.
Ne tanınır
- # ile ###### arasında başlayan başlıklar.
- - veya * ile madde listesi, 1. ile numaralı liste.
- Yalnızca --- veya *** olan bir satır, yatay çizgi olarak gösterilir.
- > ile başlayan satır, alıntı olur.
- Üçlü ters tırnak (backtick) arasındaki kod bloğu ve tek ters tırnak arasındaki satır içi kod.
- **kalın** ve *italik*.
- Bağlantı ve görsel, yalnızca adres http:// veya https:// ile başlıyorsa. javascript: ve göreli yollar bağlantı yapılmaz.
GitHub ve CommonMark’tan farkları
- Her satır ayrı bir paragraftır. CommonMark’ta aralarında boş satır olmadan art arda gelen satırlar tek paragrafta birleşir.
- İç içe listeler desteklenmez. Girintili bir liste öğesi düz paragraf olarak gösterilir.
- Alt çizgiler vurgu oluşturmaz. _italic_ veya __bold__ yerine *italic* ve **bold** kullanın.
- Hiç kapatılmayan bir kod bloğu metnin sonuna kadar sürer.
Dolayısıyla önizleme, bir README’nin veya yorumun yapısını ve ifadelerini paylaşmadan önce kontrol etmek için uygundur. Birebir görünüm için metni yayınlanacağı sitede kontrol edin.
HTML neden metin olarak gösterilir
Metindeki her türlü HTML, Markdown işlenmeden önce escape edilir. Bilinmeyen bir depodan kopyalanan bir README, script etiketi veya onerror özniteliği içerebilir. Burada bunlar düz metin olarak gösterilir ve çalışamaz. Bağlantılar rel=noopener ile yeni sekmede açılır.
Tarayıcıda kalır
Sunucuya bir şey gönderilmez. Metin bu sekmede kalır. Bir başlıktan URL kısa adı (slug) gerekiyorsa slug aracını kullanın.