Dokumentasi Markdown

Apidog melampaui dokumentasi API dengan memungkinkan Anda mengintegrasikan konten Markdown yang kaya secara langsung dalam dokumentasi Anda. Hal ini memungkinkan Anda membuat panduan pengguna yang komprehensif yang secara mulus menggabungkan referensi API dengan teks penjelasan, tutorial, dan contoh. Dokumen Markdown dapat ditambahkan pada berbagai tingkat dan ditampilkan bersama dokumentasi API untuk pengalaman dokumentasi yang lengkap.

Dokumen Markdown Mandiri

Tambahkan dokumen Markdown mandiri ke folder endpoint mana pun dengan mengeklik tombol plus (+). Tulis konten Markdown di editor dan langsung pratinjau hasil yang dirender di panel sisi kanan.

Markdown dalam Endpoint

Markdown juga didukung di bidang Deskripsi pada setiap endpoint. Markdown apa pun yang Anda tambahkan di sini akan dirender sebagai teks berformat dalam dokumentasi API, sehingga deskripsi endpoint Anda menjadi jelas dan menarik secara visual.

Markdown Tingkat Folder

Tambahkan konten Markdown pada tingkat folder untuk menyediakan konteks dan informasi ikhtisar. Ketika pembaca mengeklik nama folder dalam dokumentasi, mereka akan melihat konten Markdown folder tersebut. Tanpa Markdown tingkat folder, mengeklik folder hanya akan memperluasnya untuk menampilkan isinya.

Untuk menambahkan Markdown tingkat folder:

Ekstensi Markdown Apidog

Markdown Apidog mendukung berbagai gaya yang diperluas, termasuk Card, Accordion, Frame, dan lainnya. Komponen kustom ini memungkinkan Anda membuat pengalaman dokumentasi yang lebih kaya dan lebih interaktif.

Sisipkan gaya-gaya ini dengan mudah melalui editor Markdown dengan mengeklik tombol Insert, yang menyediakan kumpulan elemen yang tersedia.

Pelajari Lebih Lanjut

Pelajari lebih lanjut tentang Apidog Markdown.

Dokumen Markdown Mandiri#

Markdown dalam Endpoint#

Markdown Tingkat Folder#

Ekstensi Markdown Apidog#

Dokumen Markdown Mandiri

Markdown dalam Endpoint

Markdown Tingkat Folder

Ekstensi Markdown Apidog