Markdown Girintisi: İç İçe Listeler, Paragraflar ve Kod
İç içe maddeler, numaralı listeler, devam paragrafları ve çitle çevrili kod örnekleriyle Markdown girintisini düzeltin. Yanlışlıkla kod bloğu oluşturmaktan kaçının.
Markdown alt listesine girinti vermek için işaretini üst öğe metninin ilk karakterinin altına hizalayın. - Üst öğe için bu iki boşluk demektir. 1. Üst öğe için üç boşluktur. Girinti belge yapısını kontrol eder; dolayısıyla normal bir paragrafa boşluk eklemek, Word paragrafının görsel girintisini değiştirmekten çok farklı sonuç verebilir.
Markdown görüntüleyicide şu örnekle başlayın:
- Proje belgeleri
- Kurulum rehberi
- Sürüm notları
- İnceleme kontrol listesi
Kurulum rehberi ve sürüm notları, proje belgeleri öğesinin altında görünmelidir. İnceleme kontrol listesi dış düzeyde kalmalıdır.
Üst Öğenin İçeriğinden İtibaren Sayın
İşaretten sonra tek boşluk bırakılan normal liste öğeleri için bu hizalama rehberini kullanın:
| Üst öğenin başlangıcı | Metninden önceki karakterler | Alt liste girintisi |
|---|---|---|
- | 2 | 2 boşluk |
1. | 3 | 3 boşluk |
12. | 4 | 4 boşluk |
100. | 5 | 5 boşluk |
Bu yüzden “her zaman iki boşluk kullanın” gibi genel bir kural numaralı listelerde başarısız olur. GitHub'ın iç içe liste belgeleri, daha uzun sayısal işaretler de dahil olmak üzere üst içeriğe göre hizalamayı gösterir.
1. Sürümü hazırlayın
- Sürüm numarasını doğrulayın.
- Değişiklik günlüğünü güncelleyin.
2. Dokümantasyonu yayımlayın
İç içe işaretlerin başında üç boşluk vardır. Sol kenardan başlarlarsa ilk numaralı adıma ait olmak yerine ayrı bir liste başlatırlar.
Eski bir Markdown işleyicisiyle çalışırken dosyanın önizlemesini o işleyicide de kontrol edin. Buradaki örnekler CommonMark tarzı ayrıştırmayı ve GitHub Markdown'ı hedefler; eski uygulamalar iç içe blokları farklı tanıyabilir.
Liste Öğesinin İçine Paragraf Ekleyin
Uzun açıklamanın kendi madde işaretine ihtiyacı yoktur. Boş bir satır bırakın, ardından yeni paragrafı öğenin metni altına hizalayın:
1. Kurulum rehberini inceleyin.
Yeni bir okuyucunun kurum içi belgeyi açmadan
kurulumu tamamlayabildiğini doğrulayın.
2. Sürüm notlarını onaylayın.
Açıklama paragrafı birinci adıma aittir. Açık bir satır sonu eklemezseniz iki kaynak satırı birlikte akar.
Üç boşluğun atlanması numaralı listeyi sonlandırıp açıklamayı normal paragrafa dönüştürebilir. Bazı düzenleme süreçlerinde bu durum sonraki listenin numaralandırmasının yeniden başlamasına da yol açabilir.
Aynı düzen madde işaretleriyle de çalışır:
- Kurulum rehberi
Ön koşulları, kurulum komutlarını ve bir doğrulama adımını ekleyin.
- Sürüm notları
Açıklama birkaç cümle içeriyorsa ayrı paragraf kullanın. Okuyucuların tek tek taraması gereken ayrı maddeler içeriyorsa alt liste kullanın.
Numaralı Adımın İçine Kod Yerleştirin
Çitle çevrili kod, komut örneğinin sınırını görünür kılar. Bloğu liste öğesinin içinde tutmak için açılış çitini, içeriği ve kapanış çitini girintileyin:
1. Yüklü sürümü kontrol edin.
```sh
node --version
```
Sonucu inceleme notlarına kaydedin.
2. Proje kontrollerini çalıştırın.
Burada çit, Yüklü sözcüğünün ilk harfinin altında başlar. Çitten sonraki paragraf aynı hizalamayı kullandığı için o da ilk adımın içinde kalır.
Sonraki numaralı adım kod bloğunun parçasına dönüşüyorsa kapanış çitini inceleyin. Kod listenin dışında görünüyorsa çitin başındaki boşlukları kontrol edin. Dil etiketleri ve gerçek ters tırnaklar için kod bloğu rehberine bakın.
Dört Boşluk Metni Neden Koda Dönüştürebilir?
Belgenin dış düzeyinde, boş bir satırdan sonra satır başındaki dört boşluk girintili kod bloğu oluşturabilir:
Normal bir paragraf.
Bu satır kod olarak gösterilir.
Bu, bozuk bir girinti denetimi değil, amaçlanan Markdown söz dizimidir. CommonMark girintili kod bloğu başvurusu, girintinin ve blok sınırlarının rolünü açıklar.
Normal paragraf metninin hemen ardından gelen girintili satırın ayrıştırma kısıtları farklıdır; bu nedenle boşluk eklemek görsel paragraf girintisi oluşturmanın güvenilir bir yolu değildir. Listelerin içinde gereken boşluklar da kapsayan öğeye göre hesaplanır.
Alıntı için blok alıntısı kullanın. Son raporda ilk satır girintisi gerektiren normal metni Markdown'da normal paragraf olarak tutun ve dışa aktardıktan sonra paragraf biçimini Word'de uygulayın. Bu seçimler içeriğin amaçlanan anlamını korur.
Hata Ayıklarken Boşlukları Tercih Edin
Sekmeler görüntüde birkaç sütun kaplayabilir ve farklı düzenleyiciler bunları farklı genişliklerde gösterebilir. Liste kaynakta hizalı görünmesine rağmen yanlış görüntüleniyorsa düzenleyicide boşluk karakterlerini gösterin ve baştaki sekmeleri gereken sayıda boşlukla değiştirin.
Kod örneklerinin içindeki sekmeleri gelişigüzel değiştirmeyin. Orada boşluk karakterleri örneğin kendisinin parçası olabilir. Temizliği, çevreleyen liste yapısını belirleyen Markdown işaretleri ve devam girintileriyle sınırlayın.
İç içe listeyi taklit etmek için art arda bölünmez boşluk varlıkları kullanmaktan kaçının. Bu, metni bir önizlemede kaydırılmış gösterebilir ancak alttaki belgeyi birbiriyle ilgisiz paragraflar halinde bırakır.
Word'e Aktarmadan Önce Yapıyı Doğrulayın
Üst öğe, alt liste, ikinci paragraf ve çitle çevrili kod bloğu içeren temsili bir bölümü inceleyin. Markdown'dan HTML'e dönüştürücüde, gerçek bir iç içe liste üst liste öğesinin içinde bulunur; yalnızca görsel kaydırma bu ilişkiyi kurmaz.
Ardından Markdown'dan Word'e dönüştürücüyü kullanın ve DOCX dosyasını açın. Numaralandırmanın amaçlandığı gibi sürdüğünü ve komutların adımlarıyla ilişkili kaldığını kontrol edin. Word'ün liste stilleri tarayıcıdan farklı görsel aralıklar kullanabilir; bu nedenle paylaşmadan önce hem hiyerarşiyi hem de son belgenin görünümünü değerlendirin.