MkDocs Bot Dukungan

MkDocs AI Chatbot untuk MkDocs Dokumentasi

Gunakan ChattyBox untuk membuat konten MkDocs Anda dapat dicari melalui widget percakapan yang tetap berada di halaman sumber Anda.

Merangkak halaman dokumen yang dipublikasikan

Jawaban yang dikutip dari sumber

Sematkan dengan satu skrip

Tidak diperlukan migrasi dokumen

Buat MkDocs chatbot AI gratis Baca panduan pengaturan

Tidak perlu kartu kreditKonten Anda tetap milik Anda

Tanya ChattyBox

Di mana saya harus mulai jika membutuhkan jawaban tepercaya dari situs ini?

Mulailah dengan menambahkan URL situs web Anda ke ChattyBox. ChattyBox merayapi konten Anda, menjawab dari halaman yang ditemukan, dan menunjukkan sumber di balik setiap respons kepada pengunjung.

iSumber3^

MkDocs panduan

chattybox.ai

Analitik

chattybox.ai

Beranda

chattybox.ai

Ajukan pertanyaan...

Didukung oleh ChattyBox

Dibuat untuk MkDocs tim

Luncurkan chatbot yang dikutip sumber tanpa membangun kembali tumpukan dokumen Anda

ChattyBox merayapi dokumentasi Anda yang ada, mengindeks konten untuk diambil, dan menyematkan chatbot yang menjawab menggunakan dokumen Anda, bukan memori model umum.

Override Material mempertahankan JavaScript tema dan menambahkan satu loader widget asinkron.

MkDocs vanilla menggunakan direktori tema khusus terpisah alih-alih mengasumsikan jalur Material.

Pemeriksaan mencakup koeksistensi pencarian, navigasi instan, loader duplikat, dan viewport seluler yang sempit.

Pemilihan crawling yang menyadari versi menjaga jalur mike stabil, terbaru, dan lama tetap disengaja.

Langkah alur kerja

Lakukan crawling pada sitemap MkDocs yang telah di-deploy atau jalur stabil dan berversi yang sengaja Anda dukung.

Langkah alur kerja

Uji pertanyaan produk, Python, dan API serta buka setiap kutipan sebelum instalasi.

Langkah alur kerja

Untuk Material, konfigurasikan theme.custom_dir dan perluas base.html dari overrides/main.html sambil mempertahankan blok scripts dengan super().

Langkah alur kerja

Verifikasi pencarian bawaan, navigasi instan, kontrol seluler, CSP, dan setiap versi mike yang dipublikasikan.

Peluncuran tiga langkah

Tempelkan URL MkDocs Anda, uji jawaban yang dikutip, lalu pasang widget.

Buat MkDocs chatbot AI gratis

Alur kerja khusus MkDocs

Dukungan percakapan untuk situs dokumentasi Python statis

Tim MkDocs biasanya menginginkan pembuatan statis yang cepat, navigasi yang jelas, dan konten teknis yang dapat dibaca. ChattyBox menjaga alur kerja tetap utuh sambil menambahkan asisten yang dikutip sumber di atas situs yang dipublikasikan.

Jalur keputusan

Gunakan pos pemeriksaan ini untuk memutuskan apakah ChattyBox harus ditempatkan di samping platform dokumen Anda, menggantikan asisten terpisah, atau tetap terisolasi untuk pengujian.

Bekerja dengan halaman Material untuk MkDocs

Panduan indeks, halaman referensi, dan HTML statis yang dihasilkan dari penerapan MkDocs publik atau Material untuk MkDocs tanpa mengganti tema Anda.

Tangani dokumentasi berversi dengan sengaja

Arahkan ChattyBox ke jalur versi yang ingin Anda tanyakan kepada pengguna, lalu uji apakah jawaban mengutip dokumen stabil, terbaru, atau lama yang diinginkan.

Tidak ada pekerjaan pengindeksan Python yang harus dipertahankan

Karena ChattyBox merayapi situs publik, tim tidak perlu menambahkan pengindeksan vektor ke alur build MkDocs atau skrip CI mereka.

Tingkatkan dokumen dari pertanyaan nyata

Gunakan pertanyaan yang belum terjawab untuk mengidentifikasi contoh yang hilang, langkah instalasi yang tidak jelas, atau halaman pemecahan masalah yang ketinggalan jaman di situs MkDocs Anda.

Bukti editorial yang telah diuji

Jalur instalasi Material dan MkDocs vanilla yang telah diuji

Material for MkDocs dan tema bawaan MkDocs sama-sama mendukung pewarisan template, tetapi harus menggunakan direktori khusus yang terpisah. Jalur Material di bawah mempertahankan blok scripts dengan super(), menambahkan satu loader async, dan tetap berfungsi dalam navigasi instan tanpa mengganti perilaku pencarian.

Penulis teknis: Tim Dokumentasi ChattyBox
Peninjau teknis: Tim Rekayasa ChattyBox
Terakhir diperbarui: 2026-07-09
Informasi diperiksa: MkDocs, Material for MkDocs, dan mike

Periksa kembali blok template dan perilaku navigasi instan setelah upgrade tema, serta lakukan crawling ulang setiap kali alias mike berpindah.

Konfigurasi custom_dir Material for MkDocs dan override template utama yang mempertahankan skrip tema — Referensi instalasi asli: theme.custom_dir memilih override dan super() menjaga skrip pencarian serta navigasi Material tetap utuh.

Keputusan instalasi Material dan MkDocs vanilla dengan pemeriksaan menyeluruh.
Aspek MkDocs	Keputusan implementasi	Verifikasi
Override Material	Atur theme.name ke material dan theme.custom_dir ke overrides. Perluas base.html, override scripts, panggil super(), lalu tambahkan skrip widget.	Build dan sajikan situs, lalu pastikan pencarian dan navigasi Material tetap berfungsi.
MkDocs vanilla	Gunakan theme.name: mkdocs dengan direktori custom_theme terpisah. Tambahkan override custom_theme/main.html yang setara alih-alih menyalin template Material.	Jalankan mkdocs serve dan verifikasi pencarian, tautan berikutnya dan sebelumnya, serta widget pada lebih dari satu halaman.
Pemuatan async dan duplikat	Pertahankan satu loader dalam blok scripts yang diwariskan, beri ID stabil, dan jangan tambahkan snippet yang sama melalui extra_javascript atau partial lain.	Setelah pemuatan penuh dan transisi instan Material, pastikan document.querySelectorAll("#chattybox-widget").length bernilai 1.
Kebijakan Keamanan Konten	Izinkan chattybox.ai di script-src, origin API yang dikonfigurasi di connect-src, fonts.googleapis.com di style-src, dan fonts.gstatic.com di font-src. Widget saat ini menyisipkan CSS komponennya sendiri, sehingga style-src yang ketat juga memerlukan 'unsafe-inline' sampai build berbasis nonce atau stylesheet eksternal tersedia.	Periksa konsol browser dan panel Network untuk permintaan script, style, font, fetch, atau WebSocket yang diblokir.
Pencarian, navigasi instan, dan perangkat seluler	Pertahankan skrip tema dengan super() dan jaga launcher agar tidak menghalangi dialog pencarian, drawer, paginasi, dan kontrol persetujuan.	Uji pencarian keyboard, beberapa tautan instan, dan viewport 390 piksel tanpa tumpang tindih atau pengguliran horizontal.
Versi mike	Pilih jalur versi stable, latest, atau eksplisit secara sengaja. Lakukan crawling ulang setelah memindahkan alias, dan kecualikan rilis yang tidak didukung jika jawaban lintas versi dapat menyesatkan pengguna.	Gunakan mike serve untuk menguji pergantian versi dan memastikan kutipan dapat diakses dalam versi yang dimaksud.
Kegagalan widget atau kutipan	Periksa indentasi YAML, custom_dir aktif, nama blok yang diwariskan, kunci API, CSP, isi sitemap, dan apakah build yang di-deploy menyertakan override.	Periksa HTML yang dihasilkan dan uji artefak produksi alih-alih hanya mengandalkan live reload.

Pemeriksaan jawaban dengan kutipan

Uji jawaban terhadap versi aktif

Gunakan pertanyaan tema dengan aturan template yang dapat diverifikasi, lalu buka kutipan dan pastikan cocok dengan versi yang dipilih pengunjung Anda.

Tanyakan panduan MkDocs

Bagaimana cara menambahkan widget tanpa merusak pencarian Material?

Atur theme.custom_dir ke overrides, buat overrides/main.html, perluas base.html, dan tambahkan loader async di dalam blok scripts setelah super(). Memanggil super() mempertahankan skrip yang digunakan Material untuk pencarian dan navigasi.

iSumber2^

Material: penyesuaian

squidfunk.github.io/mkdocs-material

MkDocs: menyesuaikan tema Anda

mkdocs.org/user-guide

Ajukan pertanyaan...

Didukung oleh ChattyBox

Referensi seluler asli: pencarian tetap tersedia, launcher memiliki target sentuh yang mudah digunakan, dan halaman tidak bergulir secara horizontal.

Sumber primer dan bukti yang dapat direproduksi

Penyesuaian Material for MkDocsPanduan resmi custom_dir, pewarisan template, dan override blok.Navigasi instan MaterialPerilaku resmi untuk penggantian dokumen tanpa memuat ulang halaman sepenuhnya.Penyesuaian tema MkDocsPanduan resmi direktori tema khusus, template dasar, dan super() untuk MkDocs vanilla.Dokumentasi berversi mikeDeployment versi, alias, versi default, dan pengujian multiversi lokal.Contoh MkDocs yang dapat direproduksiProyek Material dan vanilla terpisah dengan override template yang telah diuji.

Jalur pemasangan

Bagaimana cara menambahkan widget ke MkDocs

Untuk Material for MkDocs, atur theme.custom_dir ke overrides, perluas base.html di overrides/main.html, dan panggil super() sebelum skrip widget async. MkDocs vanilla memerlukan direktori tema khusus tersendiri dan override main.html yang setara.

1Buat proyek ChattyBox dan masukkan URL atau peta situs MkDocs atau Material untuk MkDocs Anda.
2Uji pertanyaan MkDocs yang sebenarnya di dasbor dan konfirmasikan kutipan mengarah ke halaman yang tepat.
3Tambahkan override yang telah diuji, build situs, dan verifikasi pencarian, navigasi, CSP, serta perilaku di perangkat seluler.

Buat MkDocs chatbot AI gratis

overrides/main.html

html

{% extends "base.html" %}

{% block scripts %}
  {{ super() }}
  <script
    id="chattybox-widget"
    src="https://chattybox.ai/widget.js"
    async
    data-api-key="YOUR_API_KEY"
    data-api-url="https://adorable-woodpecker-629.convex.site/chat"
    data-chattybox-widget="true"
  ></script>
{% endblock %}

Jelajahi berikutnya

Lebih banyak cara menggunakan ChattyBox

Jelajahi semua solusi

Chatbot AI untuk dokumentasi

Lihat alur kerja chatbot dokumentasi yang dikutip sumber yang berlaku di seluruh platform.

Buka

API dokumentasi chatbot

Jawab pertanyaan titik akhir, parameter, dan autentikasi dari dokumen referensi Python dan API.

Buka

Obrolan Docusaurus AI

Bandingkan alur kerja dasar yang sama untuk situs dokumentasi Docusaurus.

Buka

Telusuri semua panduan platform

Temukan panduan pengaturan untuk Docusaurus, VitePress, Starlight, Nextra, Mintlify, ReadMe, dan platform dokumen lainnya.

Buka

Tanya Jawab

Pertanyaan umum

Apakah ChattyBox berfungsi dengan Material for MkDocs?

Ya. ChattyBox dapat merayapi halaman MkDocs dan Material for MkDocs publik dan menyematkannya sebagai widget situs web standar.

Apakah saya perlu mengubah pipeline build Python saya?

Tidak. Tambahkan cuplikan widget ke templat situs Anda atau penggantian tema setelah mengonfigurasi chatbot.

Bisakah bot menjawab dari dokumen berversi?

Ya, jika laman dokumen berversi bersifat publik dan disertakan dalam perayapan atau peta situs.

Bisakah hal ini mengidentifikasi kesenjangan dokumentasi?

Ya. Analisis ChattyBox membantu mengungkap pertanyaan yang belum terjawab dengan jelas oleh konten MkDocs Anda.

Mulai gratis

Tidak perlu kartu kredit. Konten Anda tidak digunakan untuk pelatihan model.

Buat chatbot gratis

Paket gratis. Tanpa kartu.