Dasar-dasar

Setiap halaman adalah file MDX yang harus dimulai dengan --- di awal dan akhir. Ini digunakan untuk mendefinisikan metadata halaman, seperti judul dan deskripsi.

Misalnya, Anda dapat mendefinisikan judul untuk halaman ini sebagai berikut.

---
title: "Your title goes here"
---

Deskripsi

Anda dapat menambahkan deskripsi yang menunjukkan ringkasan halaman di bawah judul dengan metadata description.

---
description: "Your description goes here"
---

Judul Sidebar

Jika Anda ingin menampilkan judul yang berbeda di navigasi, Anda dapat mengatur metadata sidebarTitle. Ini berguna jika judul Anda panjang dan Anda ingin sesuatu yang lebih pendek di tautan navigasi.

---
title: "Your very long page title you want to shorten"
sidebarTitle: "Short title"
---

Ikon

Anda dapat mengatur ikon untuk item sidebar Anda seperti yang ada di halaman ini. Anda dapat mengatur ikon dengan menggunakan metadata icon.

---
title: "Code Block"
icon: "code"
---

Anda dapat mengatur ikon dari Font Awesome dan Lucide, tergantung pada pengaturan pustaka ikon.

Anda juga dapat mengatur jenis ikon untuk ikon Font Awesome (opsional). Jika tidak diatur, jenis ikon akan menjadi regular.

---
iconType: "solid"
---

Halaman API

Halaman API memungkinkan Anda membangun playground API interaktif. Untuk membuat halaman API, Anda harus mengatur properti api atau openapi dalam metadata halaman.

Pelajari lebih lanjut tentang halaman API dengan mengunjungi panduan halaman API.

---
openapi: "GET /endpoint"
---

Mode Halaman

Pengaturan Mode Halaman memungkinkan Anda untuk menyesuaikan tampilan halaman Anda. Anda dapat memilih dari berbagai mode untuk menyesuaikan tata letak sesuai kebutuhan Anda. Jika tidak ada mode yang ditentukan, halaman akan menggunakan pengaturan default.

Default

Jika tidak ada mode spesifik yang diberikan, halaman akan menggunakan pengaturan standar. Ini berarti halaman akan menampilkan daftar isi default dan elemen standar lainnya.

---
title: "Default page title"
---

Mode Lebar

Dalam Mode Lebar, Anda dapat menyembunyikan daftar isi (ToC) di sisi kanan halaman. Ini sangat berguna jika halaman Anda tidak memiliki judul atau jika Anda lebih suka memanfaatkan ruang horizontal ekstra untuk konten lebih banyak.

---
mode: "wide"
---

Mode Kustom

Mode Kustom menyediakan tata letak minimalis dengan menghapus semua elemen kecuali bar atas. Mode ini menawarkan kanvas kosong, yang ideal untuk membuat “halaman arahan” atau halaman apa pun di mana Anda menginginkan lingkungan yang bersih dan bebas gangguan.

---
mode: "custom"
---

Mode Tengah

Mode Tengah menghapus sidebar dan daftar isi, dan memusatkan konten halaman. Mode ini bagus untuk changelog atau halaman apa pun di mana Anda ingin fokus pada konten.

---
mode: "center"
---

Tautan Eksternal

Jika Anda ingin sidebar membuka URL eksternal, Anda dapat mengatur metadata url di halaman mana pun.

---
title: "Page that goes to external link"
url: "https://www.npmjs.com/package/mint"
---

Optimisasi Mesin Pencari

Anda dapat mengatur meta tag seperti gambar yang diatur ketika dibagikan di media sosial dengan memasukkannya ke dalam metadata halaman Anda.

Perhatikan bahwa meta tag dengan titik dua perlu dibungkus dalam tanda kutip.

---
"twitter:image": "/images/your-photo.jpg"
---

Lihat SEO untuk mempelajari lebih lanjut tentang metadata SEO.

Optimisasi Pencarian Internal

Anda juga dapat meningkatkan kemampuan ditemukan halaman tertentu dalam pencarian bawaan dengan menyediakan keywords dalam metadata Anda. Kata kunci ini tidak akan muncul sebagai bagian dari konten halaman atau dalam hasil pencarian, tetapi pengguna yang mencarinya akan ditampilkan halaman tersebut sebagai hasil.

---
keywords: ['search', 'indexing']
---