Personalization
Personalisasi mengacu pada serangkaian fitur yang memungkinkan Anda menyesuaikan pengalaman dokumentasi Anda berdasarkan beberapa informasi tentang pengguna. Ada tiga fitur utama Personalisasi:
-
Sesuaikan konten MDX dengan informasi pengguna, seperti nama, paket, atau judul mereka.
-
Pra-isi kunci API di API Playground untuk penggunaan yang efisien.
-
Tampilkan halaman secara selektif di navigasi berdasarkan grup pengguna.
Cara Penggunaan
Menyesuaikan Konten MDX
Saat menulis konten, Anda dapat menggunakan variabel user
untuk mengakses informasi yang telah Anda kirim ke dokumentasi Anda. Berikut contoh sederhana:
Halo, !
Fitur ini menjadi lebih kuat ketika dipasangkan dengan data kustom tentang pengguna. Berikut contoh dunia nyata yang memungkinkan kita memberikan instruksi spesifik tentang cara mengakses fitur Personalisasi berdasarkan paket pelanggan yang ada:
Personalisasi adalah fitur enterprise.
Informasi dalam user
hanya tersedia setelah pengguna masuk. Untuk pengguna yang belum masuk, nilai user
akan menjadi {}
. Untuk mencegah halaman crash untuk pengguna yang belum masuk, selalu gunakan optional chaining pada bidang user
Anda, misalnya {user.org?.plan}
Pra-isi Kunci API
Jika Anda mengembalikan input API Playground dalam info pengguna, mereka akan secara otomatis diisi di API Playground. Pastikan nama bidang dalam info pengguna cocok persis dengan nama di API Playground.
Menampilkan/Menyembunyikan Halaman
Secara default, setiap halaman terlihat oleh setiap pengguna. Jika Anda ingin membatasi halaman mana yang terlihat oleh pengguna Anda, Anda dapat menambahkan groups
field dalam metadata halaman Anda.
Ketika menentukan halaman mana yang akan ditampilkan kepada pengguna, Mintlify akan memeriksa grup mana yang dimiliki oleh pengguna.
Jika pengguna tidak berada dalam grup yang tercantum dalam metadata halaman, halaman tersebut tidak akan ditampilkan.
Berikut adalah tabel yang menampilkan apakah sebuah halaman ditampilkan untuk kombinasi yang berbeda darigroups
dalam metadata Pengguna dan halaman:
groups tidak ada dalam Pengguna | groups: [] ada dalam Pengguna | groups: ['admin'] ada dalam Pengguna | |
---|---|---|---|
groups tidak ada dalam metadata | ✅ | ✅ | ✅ |
groups: [] ada dalam metadata | ❌ | ❌ | ❌ |
groups: ['admin'] ada dalam metadata | ❌ | ❌ | ✅ |
Perhatikan bahwa array kosong dalam metadata halaman diinterpretasikan sebagai “Tidak ada grup yang boleh melihat halaman ini.”