Panduan cepat ini akan memandu Anda melalui proses pengaturan dan penerapan situs dokumentasi Anda hanya dalam beberapa menit.

Pada akhir panduan ini, Anda akan memiliki situs dokumentasi langsung yang siap untuk dikustomisasi dan diperluas.

Prasyarat: Sebelum Anda memulai, pastikan untuk create an account dan menyelesaikan onboarding.

​
Memulai

Setelah Anda menyelesaikan proses onboarding, situs dokumentasi Anda akan secara otomatis diterapkan ke URL unik dengan format berikut.

https://<your-project-name>.mintlify.app

Anda dapat menemukan URL Anda dari halaman Ikhtisar dashboard.

URL ini langsung tersedia dan akan diperbarui setiap kali Anda membuat perubahan pada dokumentasi Anda. Ini sempurna untuk pengujian dan berbagi dengan tim Anda selama pengembangan.

​
Instal Aplikasi GitHub

Mintlify menyediakan Aplikasi GitHub yang mengotomatisasi proses penerapan ketika Anda mendorong perubahan ke repositori Anda.

Anda dapat menginstal Aplikasi GitHub dengan mengikuti instruksi dari daftar periksa onboarding atau dari dashboard Anda.

  1. Navigasi ke Settings di dashboard Mintlify Anda.
  2. Pilih GitHub App dari sidebar.
  3. Pilih Install GitHub App. Ini akan membuka tab baru ke halaman instalasi Aplikasi GitHub.
  4. Pilih organisasi atau akun pengguna tempat Anda ingin menginstal aplikasi. Kemudian pilih repositori yang ingin Anda hubungkan.

Ingatlah untuk memperbarui izin Aplikasi GitHub jika Anda memindahkan dokumentasi ke repositori yang berbeda.

​
Otorisasi Akun GitHub Anda

  1. Navigasi ke Settings di dashboard Mintlify Anda.
  2. Pilih My Profile dari sidebar.
  3. Pilih Authorize GitHub account. Ini akan membuka tab baru ke halaman otorisasi GitHub.

Anda mungkin memerlukan admin untuk organisasi GitHub Anda untuk mengotorisasi akun Anda tergantung pada pengaturan organisasi Anda.

​
Alur Kerja Pengeditan

Mintlify menawarkan dua alur kerja berbeda untuk membuat dan memelihara dokumentasi Anda.

Alur kerja berbasis kode

Untuk pengembang yang lebih suka bekerja dengan alat yang sudah ada. Klik untuk melompat ke bagian.

Alur kerja editor web

Untuk mereka yang lebih suka antarmuka visual. Klik untuk melompat ke bagian.

​
Alur Kerja Berbasis Kode

Alur kerja berbasis kode terintegrasi dengan lingkungan pengembangan dan repositori Git yang sudah ada, membuatnya ideal untuk tim teknis yang ingin mengelola dokumentasi bersama dengan kode mereka.

​
Instal CLI

Untuk bekerja secara lokal dengan dokumentasi Anda, instal Command Line Interface (CLI), yang disebut mint, dengan menjalankan perintah berikut di terminal Anda:

npm install -g mint

Anda memerlukan Node.js versi 19 atau lebih tinggi yang diinstal di mesin Anda. Jika Anda mengalami masalah instalasi, periksa panduan pemecahan masalah.

​
Edit Dokumentasi

Sekarang lingkungan Anda sudah siap, Anda dapat mulai mengedit file dokumentasi Anda. Sebagai contoh, mari kita perbarui judul halaman pengantar:

Buka repositori yang Anda buat selama onboarding, cariintroduction.mdxfile, dan temukan bagian atas file, yang seharusnya terlihat seperti ini:

introduction.mdx
---
title: "Introduction"
description: "This is the introduction to the documentation"
---

Perbaruititlefield menjadi"Hello World".

introduction.mdx
---
title: "Hello World"
description: "This is the introduction to the documentation"
---

​
Pratinjau Perubahan

Untuk melihat pratinjau perubahan secara lokal, jalankan perintah berikut.

mint dev

Pratinjau Anda akan tersedia dilocalhost:3000.

​
Push Perubahan

Ketika Anda siap untuk mempublikasikan perubahan Anda, cukup push perubahan ke repositori Anda.

Mintlify akan secara otomatis mendeteksi perubahan, membangun dokumentasi Anda, dan menerapkan pembaruan ke situs Anda. Anda dapat memantau status penerapan di riwayat commit repositori GitHub Anda ataudashboard.

Setelah penerapan selesai, pembaruan terakhir Anda akan tersedia di<your-project-name>.mintlify.app.

Lompat ke menambahkan domain kustom

Secara opsional lewati alur kerja editor web dan lompat ke menambahkan domain kustom.

​
Alur Kerja Editor Web

Alur kerja editor web menyediakan antarmuka what-you-see-is-what-you-get (WYSIWYG) untuk membuat dan mengedit dokumentasi. Ini ideal untuk orang yang ingin bekerja di browser web mereka tanpa alat pengembangan lokal tambahan.

​
Akses Editor Web

  1. Masuk keMintlify Dashboard.
  2. PilihEditordi sidebar kiri.

Jika Anda belum menginstal GitHub App, Anda akan diminta untuk melakukannya saat membuka editor web.

​
Edit Dokumentasi

Di editor web, Anda dapat menavigasi file dokumentasi Anda di sidebar. Mari kita perbarui halaman pengantar.

Temukan dan klikintroduction.mdxdi penjelajah file.

Kemudian, di editor visual, perbarui field judul menjadi “Hello World”.

Editor menyediakan serangkaian alat pemformatan dan komponen yang kaya. Akses mereka dengan mengetik ”/” di editor untuk membuka menu perintah.

​
Publikasikan Perubahan Anda

Ketika Anda puas dengan edit Anda, klik tombolPublishdi pojok kanan atas.

Perubahan Anda akan segera diterapkan ke situs dokumentasi Anda.

Untuk detail lebih lanjut tentang penggunaan editor web, termasuk fitur lanjutan seperti perintah garis miring dan unggahan gambar, lihatdokumentasi Editor Webkami.

​
Menambahkan Domain Kustom

Meskipun subdomain<your-project-name>.mintlify.appAnda berfungsi dengan baik untuk pengujian dan pengembangan, kebanyakan tim lebih suka menggunakan domain kustom untuk dokumentasi produksi.

Untuk menambahkan domain kustom, pergi keSettings>Custom Domaindari dashboard.

Masukkan domain Anda (misalnya, docs.perusahaananda.com) dan ikuti instruksi yang diberikan untuk mengkonfigurasi pengaturan DNS dengan penyedia domain Anda.

Perubahan DNS dapat memakan waktu hingga 48 jam untuk menyebar, meskipun sering kali selesai lebih cepat.

​
Langkah Selanjutnya

Selamat! Anda telah berhasil menerapkan situs dokumentasi Anda dengan Mintlify. Berikut adalah beberapa langkah selanjutnya yang disarankan untuk meningkatkan dokumentasi Anda:

Kustomisasi Tema Anda

Pelajari cara menyesuaikan warna, font, dan tampilan keseluruhan situs dokumentasi Anda.

Atur Navigasi

Strukturkan dokumentasi Anda dengan navigasi yang intuitif untuk membantu pengguna menemukan apa yang mereka butuhkan.

Tambahkan Komponen Interaktif

Tingkatkan dokumentasi Anda dengan komponen interaktif seperti akordeon, tab, dan contoh kode.

Siapkan Referensi API

Buat referensi API interaktif dengan spesifikasi OpenAPI dan AsyncAPI.

​
Pemecahan Masalah

Jika Anda mengalami masalah selama proses pengaturan, periksa solusi pemecahan masalah umum kami:

Butuh bantuan lebih lanjut?Hubungi Tim Dukungan kami.