Menulis Konten dalam Format Markdown
Starlight mendukung seluruh variasi sintaks Markdown dalam file .md
serta menggunakan frontmatter YAML untuk mendefinisikan metadata seperti judul dan deskripsi.
Pastikan untuk mengecek dokumentasi MDX atau dokumentasi Markdoc jika menggunakan format file tersebut, karena dukungan dan penggunaan Markdown dapat berbeda.
Inline styles
Teks bisa bold, italic, atau strikethrough.
Anda dapat menautkan ke halaman lain.
Anda dapat menandakan inline code
dengan backticks.
Gambar
Gambar dalam Starlight menggunakan dukungan aset teroptimalkan bawaan Astro.
Markdown dan MDX mendukung sintaks Markdown untuk menampilkan gambar yang mencakup teks alternatif untuk pembaca layar dan teknologi assistif.
Relative paths juga didukung untuk gambar yang disimpan secara lokal di proyek anda.
Judul
Anda dapat menyusun konten dengan menggunakan judul. Judul dalam Markdown ditandai dengan sejumlah #
di awal baris.
Bagaimana cara menyusun konten halaman di Starlight
Starlight dikonfigurasi untuk secara otomatis menggunakan judul halaman Anda sebagai judul tingkat atas dan akan menyertakan judul “Ringkasan” di bagian atas daftar isi setiap halaman. Kami merekomendasikan memulai setiap halaman dengan konten paragraf biasa dan menggunakan judul di dalam halaman dari <h2>
ke bawah:
Automatic heading anchor links
Menggunakan judul dalam Markdown secara otomatis akan memberi Anda anchor links sehingga Anda dapat langsung menautkan ke bagian-bagian tertentu dari halaman Anda:
Judul Level 2 (<h2>
) dan Level 3 (<h3>
) akan secara otomatis muncul di daftar isi halaman.
Asides
Asides (juga sering disebut sebagai “admonitions” atau “callouts”) berguna untuk menampilkan informasi sekunder di samping konten utama halaman.
Starlight menyediakan sintaks Markdown kustom untuk merender asides. Blok asides ditandai dengan sepasang tiga titik dua :::
untuk melingkupi konten Anda, dan dapat berjenis note
, tip
, caution
, atau danger
.
Anda dapat menyusun berbagai jenis konten Markdown lainnya di dalam sebuah asides, tetapi asides lebih cocok untuk potongan konten yang pendek dan padat.
Catatan Asides
Judul Asides Kustom
Anda dapat menentukan judul kustom untuk asides dengan menambahkan tanda kurung siku setelah jenis asides-nya, misalnya :::tip[Apakah Anda tahu?]
.
Jenis Asides Lainnya
Asides berjenis caution dan danger berguna untuk menarik perhatian pengguna pada detail-detail yang mungkin membuat mereka bingung. Jika Anda sering menggunakan ini, mungkin juga pertanda bahwa hal yang Anda dokumentasikan sepertinya bisa di-desain ulang.
Blockquote
Ini adalah blockquote, yang biasanya digunakan saat mengutip orang lain atau dokumen lain.
Blockquotes ditandai dengan tanda
>
di awal setiap barisnya.
Code blocks
Code blocks ditandai dengan blok tiga tanda kutip terbalik ```
di awal dan akhir. Anda dapat menunjukkan bahasa pemrograman yang digunakan setelah tanda kutip terbalik pembuka.
Fitur Umum Markdown Lainnya
Starlight mendukung penulisan semua sintaks Markdown lainnya, seperti daftar dan tabel. Lihat Markdown Cheat Sheet dari The Markdown Guide untuk penjelasan singkat tentang semua sintaks elemen Markdown.
Konfigurasi Markdown dan MDX Lanjutan
Starlight menggunakan Markdown dan renderer MDX Astro yang dibangun berdasarkan remark dan rehype. Anda dapat menambahkan dukungan untuk sintaks dan perilaku khusus dengan menambahkan remarkPlugins
atau rehypePlugins
di file konfigurasi Astro Anda. Lihat “Configuring Markdown and MDX” dalam dokumentasi Astro untuk mempelajari lebih lanjut.