Markdown'da İçerik Yazmak
Starlight, .md
uzantılı dosyalarda Markdown sözdizimini, YAML önbölümünde olduğu gibi başlık ve açıklama gibi metaverileri tanımlamak için destekler.
Markdown desteği ve kullanımı farklılık gösterebileceğinden dolayı, bu dosya formatlarını kullanıyorsanız MDX dokümantasyonu ya da Markdoc dokümantasyonu‘nu incelediğinizden emin olun.
Satır İçi Stiller
Metin kalın, italik ya da üstü çizili olabilir.
Başka bir sayfaya bağlantı ekleyebilirsiniz.
Kesme işaretleri ile satır için kodu
vurgulayabilirsiniz.
Görseller
Starlight’ta görseller Astro’nun kurulu optimize edilen dosya desteği ile kullanılır.
Markdown ve MDX, ekran okuyucular ve yardımcı teknolojilere yönelik alternatif metin içeren görselleri göstermek için Markdown sözdizimini destekler.
Ayrıca, yerel olarak projenizde barındırılan görseller için ilişkili görsel dizin yolları desteklenir.
Başlıklar
Başlık kullanarak içerik yapınızı kurabilirsiniz. Markdown’daki başlıklar #
sayısı ile satır başında oluşturulabilir.
Starlight’ta sayfa içeriği yapısı nasıl kurulur
Starlight, sayfa başlığınızı en üst seviye başlık olarak kullanılacak şekilde yapılandırılmıştır ve içerik tablosunda “Genel Bakış” olarak yer alacaktır. Her sayfanın bir paragraf metniyle ve sayfa üstü başlığının <h2>
ve alt seviyelerini kullanarak oluşturulmasını öneriyoruz:
Otomatik Başlık Bağlantıları
Markdown’da başlık kullanmak, otomatik olarak başlıklar için bağlantı oluşturur. Böylece sayfanızın belli bölümlerini direkt olarak bağlantılandırabilirsiniz:
Seviye 2 (<h2>
) ve Seviye 3 (<h3>
) başlıklar otomatik olarak içerik tablosunda görünecektir.
Ara Bölümler
Ara bölümler, sayfanın ana içeriğinin yanında ikincil bilgi gösterimi için kullanışlıdır.
Starlight ara bölümleri oluşturmak için özel Markdown sözdizimi sunar. Ara bölüm blokları üç adet iki nokta üst üste’nin :::
içeriği sarmalamasıyla kullanılır ve tip olarak note
,tip
, caution
ya da danger
kullanılabilir.
Herhangi bir Markdown içerik tipini ara bölümü içerisine yerleştirebilirsiniz, ancak ara bölümler kısa ve öz içerikler için biçilmiş kaftandır.
Note Ara bölümü
Özel ara bölümler
Ara bölümler için ara bölüm tipinin tanımından hemen sonra, köşeli parantez arasında olacak şekilde ara bölümlerinizi özelleştirebilirsiniz (örn.:::tip[Bunu biliyor musun?]
).
Diğer Ara bölümler
Uyarı ve tehlike ara bölümleri, kullanıcıların dikkatini gözden kaçabilecek detaylara çekmek için kullanışlıdır. Bunları çok kullandığınızı farkederseniz, dokümanınızın yeniden oluşturulmasına gerek kalmayacağının işareti olabilir.
Blok Alıntılar
Bu, genelde başka bir belge ya da kişiden alıntılanan bir blok alıntıdır.
Blok alıntılar her satırda
>
ile başlar.
Kod Blokları
Kod bloğu, başında ve sonunda üç kesme işaretinin arasında kalan ```
bir bloktur. Üç kesme işaretiyle başladıktan hemen sonra göstermek istediğiniz programlama dilini belirtebilirsiniz.
Diğer ortak Markdown Özellikleri
Starlight, liste ve tablo gibi diğer tüm Markdown yazım sözdizimini destekler. Markdown Rehberi’nden Markdown Kopya Kağıdı‘na tüm Markdown sözdizimi elemanlarına hızlı bir genel bakış için göz atın.