Prasyarat: Harap instal Node.js (versi 19 atau lebih tinggi) sebelum melanjutkan.

Langkah 1: Instal CLI:

npm i -g mint

Langkah 2: Navigasikan ke direktori docs (di mana file docs.json berada) dan jalankan perintah berikut:

mint dev

Atau, jika Anda tidak ingin menginstal CLI secara global, Anda dapat menggunakan skrip satu kali:

npx mint dev

Pratinjau lokal dokumentasi Anda akan tersedia di http://localhost:3000.

​
Pembaruan

Setiap rilis CLI terkait dengan versi tertentu dari platform Mintlify. Jika pratinjau lokal Anda tidak sesuai dengan versi produksi, harap perbarui CLI:

npm i -g mint@latest

​
Port Kustom

Secara default, CLI menggunakan port 3000. Anda dapat menyesuaikan port menggunakan flag --port. Untuk menjalankan CLI di port 3333, misalnya, gunakan perintah ini:

mint dev --port 3333

Jika Anda mencoba menjalankan pada port yang sudah digunakan, CLI akan menggunakan port berikutnya yang tersedia:

Port 3000 is already in use. Trying 3001 instead.

​
Perintah Tambahan

Meskipun mint dev adalah perintah yang paling sering digunakan, ada perintah lain yang dapat Anda gunakan untuk mengelola dokumentasi Anda.

​
Temukan Tautan Rusak

CLI dapat membantu memvalidasi tautan referensi yang dibuat dalam dokumentasi Anda. Untuk mengidentifikasi tautan yang rusak, gunakan perintah berikut:

mint broken-links

​
Periksa Spesifikasi OpenAPI

Anda dapat menggunakan CLI untuk memeriksa file OpenAPI Anda untuk kesalahan menggunakan perintah berikut:

mint openapi-check <openapiFilenameOrUrl>

Anda dapat memasukkan nama file (misalnya ./openapi.yaml) atau URL (misalnya https://petstore3.swagger.io/api/v3/openapi.json).

​
Mengganti Nama File

Anda dapat mengganti nama file menggunakan perintah berikut:

mint rename <oldFilename> <newFilename>

Ini adalah peningkatan dibandingkan dengan memperbarui nama file secara normal karena juga akan memperbarui semua referensi ke file tersebut, memastikan tidak ada tautan yang rusak.

​
Pemformatan

Saat mengembangkan secara lokal, kami merekomendasikan penggunaan ekstensi pada IDE Anda untuk mengenali dan memformat MDX.

Jika Anda menggunakan Cursor, Windsurf, atau VSCode, kami merekomendasikan ekstensi MDX VSCode untuk penyorotan sintaks, dan Prettier untuk pemformatan kode.

Jika Anda menggunakan JetBrains, kami merekomendasikan plugin MDX IntelliJ IDEA untuk penyorotan sintaks, dan pengaturan Prettier untuk pemformatan kode.

​
Pemecahan Masalah