Fitur ini hanya tersedia untuk pelanggan dengan paket berbayar dan untuk GitHub. Dukungan untuk platform lain akan segera hadir. Silakan hubungi sales untuk informasi lebih lanjut.

Gunakan pemeriksaan CI untuk memeriksa kesalahan pada dokumen Anda, dan memberikan peringatan sebelum Anda melakukan deploy.

​
Instalasi

Untuk memulai, Anda perlu mengikuti langkah-langkah pada halaman GitHub.

Untuk GitHub Apps, Anda dapat memilih untuk hanya memberikan izin pada satu repositori saja. Kami sangat menyarankan Anda melakukannya karena kami hanya membutuhkan akses ke repositori tempat dokumen Anda dihosting.

​
Konfigurasi

Anda dapat mengonfigurasi pemeriksaan CI yang diaktifkan untuk deployment di dashboard Mintlify dengan menavigasi ke tab ‘Add-Ons’. Di sana Anda dapat mengaktifkan atau menonaktifkan pemeriksaan yang ingin Anda jalankan.

Saat mengaktifkan pemeriksaan, Anda dapat memilih untuk menjalankannya pada tingkat Warning atau Blocking.

Pemeriksaan tingkat Blocking akan memberikan status kegagalan jika tidak lulus, atau jika ada perubahan yang disarankan.

Pemeriksaan tingkat Warning tidak akan pernah memberikan status kegagalan, bahkan jika ada kesalahan atau saran.

​
Kapan Mereka Berjalan?

Pemeriksaan CI dikonfigurasi untuk berjalan pada commit ke cabang deployment yang telah Anda konfigurasi, atau pada pull request terhadap cabang tersebut.

​
Pemeriksaan CI yang Tersedia

​
Tautan Rusak

Mirip dengan cara kerja pemeriksa tautan CLI di mesin lokal Anda, kami akan secara otomatis memeriksa dokumen Anda untuk tautan yang rusak. Untuk melihat hasil pemeriksaan ini, Anda dapat mengunjungi halaman hasil pemeriksaan GitHub untuk commit tertentu.

​
Vale

Vale adalah linter prosa berbasis aturan open-source yang mendukung berbagai jenis dokumen, termasuk Markdown dan MDX.

Mintlify mendukung menjalankan Vale secara otomatis dalam pemeriksaan CI, dan menampilkan hasilnya sebagai status pemeriksaan.

​
Konfigurasi

Jika Anda memiliki file .vale.ini di root direktori konten untuk deployment Anda, kami akan secara otomatis menggunakan file konfigurasi tersebut. Kami juga akan secara otomatis menggunakan file konfigurasi apa pun di stylesPath yang Anda tentukan.

Tidak memiliki konfigurasi Vale atau tidak yakin dari mana harus memulai? Jangan khawatir, Mintlify memiliki konfigurasi default yang akan secara otomatis digunakan jika tidak ada yang disediakan.

Harap dicatat bahwa untuk alasan keamanan, kami tidak dapat mendukung stylesPath absolut, atau stylesPath yang menyertakan nilai ... Harap gunakan path relatif dan sertakan stylesPath di repositori Anda.

​
Paket

Vale mendukung berbagai paket, yang dapat digunakan untuk memeriksa kesalahan ejaan dan gaya. Setiap paket yang Anda sertakan dalam repositori Anda di bawah stylesPath yang benar akan secara otomatis diinstal dan digunakan dalam konfigurasi Vale Anda.

Untuk paket yang tidak disertakan dalam repositori Anda, Anda dapat menentukan paket apa pun dari Vale package registry, dan mereka akan secara otomatis diunduh dan digunakan dalam konfigurasi Vale Anda.

Harap dicatat bahwa untuk alasan keamanan, kami tidak dapat mendukung pengunduhan otomatis paket yang bukan dari Vale package registry.

​
Vale dengan MDX

Vale tidak secara alami mendukung MDX, tetapi penulis Vale telah menyediakan ekstensi kustom untuk mendukungnya.

Jika Anda lebih suka tidak menggunakan ekstensi ini, kami merekomendasikan baris-baris berikut dalam .vale.ini file:

[formats]
mdx = md

[*.mdx]
CommentDelimiters = {/*, */}

TokenIgnores = (?sm)((?:import|export) .+?$), \
(?<!`)(<\w+ ?.+ ?\/>)(?!`), \
(<[A-Z]\w+>.+?<\/[A-Z]\w+>)

BlockIgnores = (?sm)^(<\w+\n .*\s\/>)$, \
(?sm)^({.+.*})

Untuk menggunakan komentar dalam dokumen Vale, gunakan komentar gaya MDX {/* ... */}. Jika Anda menggunakan pengaturan CommentDelimiters = {/*, */} setting dalam konfigurasi Anda, Vale akan secara otomatis menafsirkan komentar ini saat melakukan linting. Ini berarti Anda dapat dengan mudah menggunakan fitur bawaan Vale, seperti melewati baris atau bagian.

{/* vale off */}

This text will be ignored by Vale

{/* vale on */}

Jika Anda memilih untuk tidak menggunakan CommentDelimiters, tetapi masih memilih untuk menggunakan komentar Vale, Anda harus membungkus komentar Vale dalam komentar MDX {/* ... */}. Contohnya:

{/* <!-- vale off --> */}

This text will be ignored by Vale

{/* <!-- vale on --> */}

Harap dicatat bahwa tag komentar ini tidak didukung dalam komponen Mintlify, tetapi dapat digunakan di mana saja pada tingkat dasar dokumen.