Settings

Setiap situs dokumentasi memerlukan docs.json file.

File ini berisi pengaturan konfigurasi global dan mengontrol segala hal mulai dari gaya dan navigasi hingga integrasi.

Referensi

Bagian ini berisi referensi lengkap untuk file docs.json.

Kustomisasi

theme · required

Salah satu dari berikut: mint, maple, palm, willow, linden, almond.

Tema tata letak proyek. Lihat halaman Themes untuk informasi lebih lanjut.

name · string · required

Nama proyek, organisasi, atau produk

colors · object · required

Warna yang akan digunakan dalam dokumentasi Anda. Setidaknya, Anda harus menentukan warna utama. Contoh:

{
  "colors": {
    "primary": "#ff0000"
  }
}

Show Colors

primary · string matching ^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$ · required

Warna utama tema

Harus berupa kode hex yang dimulai dengan #

light · string matching ^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$

Warna terang tema. Digunakan untuk mode gelap

Harus berupa kode hex yang dimulai dengan #

dark · string matching ^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$

Warna gelap tema. Digunakan untuk mode terang

Harus berupa kode hex yang dimulai dengan #

description · string

Deskripsi opsional yang digunakan untuk SEO dan pengindeksan LLM

logo · string or object

Logo (untuk mode terang dan gelap)

Show Logo

light · string · required

Path yang menunjuk ke file logo terang untuk digunakan dalam mode gelap, termasuk ekstensi file. Contoh: /logo.png

dark · string · required

Path yang menunjuk ke file logo gelap untuk digunakan dalam mode terang, termasuk ekstensi file. Contoh: /logo-dark.png

href · string (uri)

URL untuk dialihkan saat mengklik logo. Jika tidak disediakan, logo akan mengarah ke halaman utama. Contoh: https://example.com

favicon · string or object

Path ke file favicon Anda di folder docs, termasuk ekstensi file. File akan secara otomatis diubah ukurannya menjadi ukuran favicon yang sesuai. Bisa berupa file tunggal atau sepasang untuk mode terang dan gelap. Contoh: /favicon.png

Show Favicon

light · string · required

Path yang menunjuk ke file favicon terang untuk digunakan dalam mode gelap, termasuk ekstensi file. Contoh: /favicon.png

dark · string · required

Path yang menunjuk ke file favicon gelap untuk digunakan dalam mode terang, termasuk ekstensi file. Contoh: /favicon-dark.png

styling · object

Konfigurasi gaya

Show Styling

eyebrows · "section" | "breadcrumbs"

Gaya alis konten. Default ke section.

codeblocks · "system" | "dark"

Tema blok kode. Default ke system.

icons · object

Pengaturan pustaka ikon

Show Icons

library · "fontawesome" | "lucide" · required

Pustaka ikon yang akan digunakan. Default ke fontawesome.

fonts · object

Show Fonts

family · string · required

Keluarga font, seperti “Open Sans”, “Playfair Display”

weight · number

Berat font, seperti 400, 700. Berat font yang tepat seperti 550 didukung untuk font variabel.

source · string (uri)

Sumber font, seperti https://mintlify-assets.b-cdn.net/fonts/Hubot-Sans.woff2

format · "woff" | "woff2"

Format font, bisa salah satu dari woff, woff2

heading · object

Show Heading

family · string · required

Keluarga font, seperti “Open Sans”, “Playfair Display”

weight · number

Berat font, seperti 400, 700. Berat font yang tepat seperti 550 didukung untuk font variabel.

source · string (uri)

Sumber font, seperti https://mintlify-assets.b-cdn.net/fonts/Hubot-Sans.woff2

format · "woff" | "woff2"

Format font, bisa salah satu dari woff, woff2

body · object

Show Body

family · string · required

Keluarga font, seperti “Open Sans”, “Playfair Display”

weight · number

Berat font, seperti 400, 700. Berat font yang tepat seperti 550 didukung untuk font variabel.

source · string (uri)

Sumber font, seperti https://mintlify-assets.b-cdn.net/fonts/Hubot-Sans.woff2

format · "woff" | "woff2"

Format font, bisa salah satu dari woff, woff2

appearance · object

Pengaturan toggle mode terang / gelap

Show Appearance

default · "system" | "light" | "dark"

Mode terang/gelap default. Default ke system

strict · boolean

Apakah akan menyembunyikan toggle mode terang / gelap. Default ke true.

background · object

Pengaturan warna latar belakang dan dekorasi

Show Background

image · string or object

Show Image

light · string · required

dark · string · required

decoration · "gradient" | "grid" | "windows"

Dekorasi latar belakang tema

color · object

Warna-warna latar belakang

Show Color

light · string matching ^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$

Warna dalam format hex untuk digunakan dalam mode terang

Harus sesuai pola: ^#([a-fA-F0-9]|[a-fA-F0-9])$

dark · string matching ^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$

Warna dalam format hex untuk digunakan dalam mode gelap

Harus sesuai pola: ^#([a-fA-F0-9]|[a-fA-F0-9])$

Structure

navbar · object

Konten dan pengaturan navbar

Show Navbar

links · array of object

Tautan di navbar

Show Links

label · string · required

href · string (uri) · required

Path yang valid atau tautan eksternal

primary · object

Show Primary

type · "button" | "github" · required

label · string · required

Label untuk tombol utama. Ini hanya berlaku ketika type diatur ke button.

href · string (uri) · required

Path yang valid atau tautan eksternal. Jika type diatur ke github, ini akan menjadi URL ke repositori.

navigation · object · required

Struktur navigasi konten

Show Navigation

global · object

Tambahkan tautan eksternal yang akan muncul di semua bagian dan halaman terlepas dari penyarangan navigasi

Show Global

languages · array of object

Show Languages

language · "en" | "cn" | "zh" | "zh-Hans" | "zh-Hant" | "es" | "fr" | "ja" | "jp" | "pt" | "pt-BR" | "de" | "ko" | "it" | "ru" | "id" | "ar" | "tr" · required

Nama bahasa dalam format ISO 639-1

default · boolean

Apakah bahasa ini adalah bahasa default

hidden · boolean

Apakah opsi saat ini default disembunyikan

href · string (uri) · required

Path yang valid atau tautan eksternal

versions · array of object

Show Versions

version · string · required

Nama versi

Panjang minimum: 1

default · boolean

Apakah versi ini adalah versi default

hidden · boolean

Apakah opsi saat ini default disembunyikan

href · string (uri) · required

Tautan eksternal

tabs · array of object

Show Tabs

tab · string · required

Nama tab

Panjang minimum: 1

icon · string or object

Ikon yang akan ditampilkan di bagian

hidden · boolean

Apakah opsi saat ini default disembunyikan

href · string (uri) · required

Tautan eksternal

anchors · array of object

Show Anchors

anchor · string · required

Nama anchor

Panjang minimum: 1

icon · string or object

Ikon yang akan ditampilkan di bagian

color · object

Show Color

light · string matching ^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$

Warna dalam format hex untuk digunakan dalam mode terang

Harus sesuai pola: ^#([a-fA-F0-9]|[a-fA-F0-9])$

dark · string matching ^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$

Warna dalam format hex untuk digunakan dalam mode gelap

Harus sesuai pola: ^#([a-fA-F0-9]|[a-fA-F0-9])$

hidden · boolean

Apakah opsi saat ini default disembunyikan

href · string (uri) · required

Path yang valid atau tautan eksternal

dropdowns · array of object

Show Dropdowns

dropdown · string · required

Nama dropdown

Panjang minimum: 1

icon · string or object

Ikon yang akan ditampilkan di bagian

hidden · boolean

Apakah opsi saat ini default disembunyikan

href · string (uri) · required

Tautan eksternal

languages · array of object

Mengorganisir berdasarkan bahasa

versions · array of object

Mengatur berdasarkan versi

tabs · array of object

Mengatur berdasarkan tab

anchors · array of object

Mengatur berdasarkan anchor

dropdowns · array of object

Mengatur berdasarkan dropdown

groups · array of object

Mengatur berdasarkan grup

pages · array of string or object

Sebuah array dari jalur halaman atau grup

footer · object

Konfigurasi footer

Show Footer

socials · object

Sebuah objek di mana setiap kunci adalah nama platform media sosial, dan setiap nilai adalah url ke profil Anda. Contohnya:

{
  "x": "https://x.com/mintlify"
}

Nama properti yang valid: x, website, facebook, youtube, discord, slack, github, linkedin, instagram, hacker-news, medium, telegram, twitter, x-twitter, earth-americas, bluesky, threads, reddit, podcast

links · array of object

Tautan yang akan ditampilkan di footer

Show Tautan

header · string

Judul header dari kolom

Panjang minimum: 1

items · array of object · required

Tautan yang akan ditampilkan di kolom

Show Item

label · string · required

Label dari tautan

Panjang minimum: 1

href · string (uri) · required

URL dari tautan

banner · object

Konfigurasi banner

Show Banner

content · string

Konten dari banner. Ini bisa berupa string teks atau string markdown. Contohnya:

{
  "content": "🚀 Banner is live! [Learn more](mintlify.com)"
}

dismissible · boolean

Apakah banner dapat ditutup. Defaultnya false.

redirects · array of object

Show Pengalihan

source · string · required

destination · string · required

permanent · boolean

contextual · object

Show Kontekstual

options · array of "copy" | "view" | "chatgpt" | "claude" · required

Opsi yang akan ditampilkan dalam menu kontekstual. Opsi pertama adalah opsi default.

• copy: Salin halaman saat ini sebagai markdown ke clipboard
• view: Lihat halaman saat ini sebagai markdown di tab baru
• chatgpt: Masukkan halaman saat ini ke ChatGPT
• claude: Masukkan halaman saat ini ke Claude

Menu kontekstual hanya tersedia pada deployment preview & produksi.

Konfigurasi API

api · object

Konfigurasi referensi API dan pengaturan playground

Show Api

openapi · string or array or object

Sebuah string atau array string dari url absolut atau relatif yang menunjuk ke file OpenAPI

Show Openapi

source · string

Panjang minimum: 1

directory · string

tidak ada garis miring awal di direktori

asyncapi · string or array or object

Sebuah string atau array string dari url absolut atau relatif yang menunjuk ke file AsyncAPI

Show Asyncapi

source · string

Panjang minimum: 1

directory · string

playground · object

Konfigurasi untuk playground API

Show Playground

display · "interactive" | "simple" | "none"

Mode tampilan playground API. Defaultnya interactive.

proxy · boolean

Apakah akan meneruskan permintaan API melalui server proxy. Defaultnya true.

examples · object

Konfigurasi untuk contoh API yang dibuat otomatis

Show Contoh

languages · array of string

Bahasa contoh untuk snippet API yang dibuat otomatis

defaults · "required" | "all"

Apakah akan menampilkan parameter opsional dalam contoh api, defaultnya all

mdx · object

Konfigurasi untuk halaman API yang dihasilkan dari file MDX

Show Mdx

auth · object

Konfigurasi autentikasi untuk API

Show Auth

method · "bearer" | "basic" | "key" | "cobo"

Metode autentikasi untuk API

name · string

Nama autentikasi untuk API

server · string or array

SEO & Pencarian

seo · object

Konfigurasi pengindeksan SEO

Show Seo

metatags · object

Meta tag yang ditambahkan ke setiap halaman. Harus berupa pasangan kunci-nilai yang valid. Opsi yang mungkin di sini

indexing · "navigable" | "all"

Tentukan halaman mana yang akan diindeks oleh mesin pencari. Pengaturan navigable mengindeks halaman yang diatur dalam navigasi, all mengindeks semua halaman. Defaultnya navigable.

search · object

Pengaturan tampilan pencarian

Show Pencarian

prompt · string

Prompt yang akan ditampilkan di placeholder kotak pencarian

Integrasi

integrations · object

Konfigurasi untuk integrasi resmi

Show Integrasi

amplitude · object

Show Amplitude

apiKey · string · required

clearbit · object

Show Clearbit

publicApiKey · string · required

fathom · object

Show Fathom

siteId · string · required

frontchat · object

Show Frontchat

snippetId · string · required

Panjang minimum: 6

ga4 · object

Show Ga4

measurementId · string matching ^G · required

Harus cocok dengan pola: ^G

gtm · object

Show Gtm

tagId · string matching ^G · required

Harus cocok dengan pola: ^G

heap · object

Show Heap

appId · string · required

hotjar · object

Show Hotjar

hjid · string · required

hjsv · string · required

intercom · object

Show Intercom

appId · string · required

Panjang minimum: 6

koala · object

Show Koala

publicApiKey · string · required

Panjang minimum: 2

logrocket · object

Show Logrocket

appId · string · required

mixpanel · object

Show Mixpanel

projectToken · string · required

osano · object

Show Osano

scriptSource · string · required

pirsch · object

Show Pirsch

id · string · required

posthog · object

Show Posthog

apiKey · string matching ^phc\_ · required

Harus cocok dengan pola: ^phc_

apiHost · string (uri)

plausible · object

Show Plausible

domain · string · required

server · string

segment · object

Show Segment

key · string · required

telemetry · object

Show Telemetry

enabled · boolean

cookies · object

Show Cookie

key · string

value · string

Error

errors · object

Show Error

404 · object

Show 404

redirect · boolean

Apakah akan mengalihkan ke halaman utama, jika halaman tidak ditemukan

Validasi

Disarankan untuk menyertakan referensi skema berikut di bagian atas file docs.json Anda untuk memastikan validasi yang tepat saat mengedit:

{
  "$schema": "https://mintlify.com/docs.json",
  ...
}