Image embeds
Gambar
Gambar adalah cara paling umum untuk menambahkan konten visual ke dokumentasi Anda.
Dasar-dasar
Sintaksmarkdown syntax memungkinkan Anda menambahkan gambar menggunakan kode berikut
Untuk memastikan gambar ditampilkan dengan benar dalam produksi, tambahkan garis miring ke depan pada path gambar (misalnya /path/image.jpg
).
Perhatikan bahwa ukuran file gambar harus kurang dari 20MB. Jika tidak, kami menyarankan untuk meng-host pada penyedia CDN seperti S3, Cloudinary atau layanan serupa.
Embeds
Untuk mendapatkan lebih banyak kemampuan kustomisasi dengan gambar, Anda juga dapat menggunakan embeds untuk menambahkan gambar.
Menonaktifkan Zoom Gambar
Untuk menonaktifkan zoom default saat mengklik gambar, tambahkan properti noZoom ke embeds gambar.
Menautkan Gambar
Untuk menautkan gambar, misalnya untuk membuat tombol pada dokumentasi Anda, masukkan gambar dalam tautan dengan properti noZoom
. Gambar dalam tag a
akan secara otomatis memiliki kursor pointer.
Mode Gelap
Untuk menggunakan gambar yang berbeda untuk mode terang dan gelap, gunakan Tailwind CSS untuk menyembunyikan dan menampilkan gambar.
Terkait
Untuk informasi lebih lanjut, kami merekomendasikan bagian-bagian berikut:
Frame Component Reference
Baca referensi untuk komponen Frame
Video
Mintlify mendukung HTML tags in Markdown. Ini berguna jika Anda lebih suka tag HTML daripada sintaks Markdown, dan memungkinkan Anda membuat dokumentasi dengan fleksibilitas tak terbatas.
Untuk video YouTube gunakan:
Untuk video lainnya, gunakan:
Untuk memutar video secara otomatis, gunakan:
Karena Mintlify perlu mematuhi sintaks JSX, atribut kata ganda perlu ditulis dalam camelCase: autoPlay, playsInline.
iFrames
Memuat halaman HTML lain dalam dokumen.