01
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.
MkDocs Bot Dukungan
Tambahkan chatbot AI dengan kutipan sumber ke dokumentasi MkDocs dan Material Anda
Gunakan ChattyBox untuk membuat konten MkDocs Anda dapat dicari melalui widget percakapan yang tetap berada di halaman sumber Anda.
Merangkak halaman dokumen yang dipublikasikanJawaban yang dikutip dari sumberSematkan dengan satu skripTidak diperlukan migrasi dokumenTidak perlu kartu kreditKonten Anda tetap milik Anda
Daftar untuk mencoba paket Free kami
Sedang mengevaluasi ChattyBox untuk organisasi? Hubungi tim dukungan untuk mendiskusikan uji coba paket yang lebih besar.
Tanya ChattyBox
xDi 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 dengan kutipan sumber tanpa membangun ulang stack situs Anda
ChattyBox merayapi situs web, dokumentasi, pusat bantuan, CMS, atau basis pengetahuan yang sudah ada, lalu menyematkan chatbot yang menjawab berdasarkan konten terbitan Anda sendiri, bukan memori model generik.
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.
1Langkah alur kerja
Lakukan crawling pada sitemap MkDocs yang telah di-deploy atau jalur stabil dan berversi yang sengaja Anda dukung.
2Langkah alur kerja
Uji pertanyaan produk, Python, dan API serta buka setiap kutipan sebelum instalasi.
3Langkah alur kerja
Untuk Material, konfigurasikan theme.custom_dir dan perluas base.html dari overrides/main.html sambil mempertahankan blok scripts dengan super().
4Langkah 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.
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.
02
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.
03
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.
04
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
- 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.
| Aspek MkDocs | Keputusan implementasi | Verifikasi |
|---|---|---|
Aspek MkDocs Override Material | Keputusan implementasi Atur theme.name ke material dan theme.custom_dir ke overrides. Perluas base.html, override scripts, panggil super(), lalu tambahkan skrip widget. | Verifikasi Build dan sajikan situs, lalu pastikan pencarian dan navigasi Material tetap berfungsi. |
Aspek MkDocs MkDocs vanilla | Keputusan implementasi Gunakan theme.name: mkdocs dengan direktori custom_theme terpisah. Tambahkan override custom_theme/main.html yang setara alih-alih menyalin template Material. | Verifikasi Jalankan mkdocs serve dan verifikasi pencarian, tautan berikutnya dan sebelumnya, serta widget pada lebih dari satu halaman. |
Aspek MkDocs Pemuatan async dan duplikat | Keputusan implementasi Pertahankan satu loader dalam blok scripts yang diwariskan, beri ID stabil, dan jangan tambahkan snippet yang sama melalui extra_javascript atau partial lain. | Verifikasi Setelah pemuatan penuh dan transisi instan Material, pastikan document.querySelectorAll("#chattybox-widget").length bernilai 1. |
Aspek MkDocs Kebijakan Keamanan Konten | Keputusan implementasi 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. | Verifikasi Periksa konsol browser dan panel Network untuk permintaan script, style, font, fetch, atau WebSocket yang diblokir. |
Aspek MkDocs Pencarian, navigasi instan, dan perangkat seluler | Keputusan implementasi Pertahankan skrip tema dengan super() dan jaga launcher agar tidak menghalangi dialog pencarian, drawer, paginasi, dan kontrol persetujuan. | Verifikasi Uji pencarian keyboard, beberapa tautan instan, dan viewport 390 piksel tanpa tumpang tindih atau pengguliran horizontal. |
Aspek MkDocs Versi mike | Keputusan implementasi 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. | Verifikasi Gunakan mike serve untuk menguji pergantian versi dan memastikan kutipan dapat diakses dalam versi yang dimaksud. |
Aspek MkDocs Kegagalan widget atau kutipan | Keputusan implementasi Periksa indentasi YAML, custom_dir aktif, nama blok yang diwariskan, kunci API, CSP, isi sitemap, dan apakah build yang di-deploy menyertakan override. | Verifikasi 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
xBagaimana 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.
Ajukan pertanyaan...
Didukung oleh ChattyBox
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-contoh MkDocs yang dapat dijalankanContoh Material dan MkDocs vanilla dengan penggantian tema, halaman pengujian, dan atribut widget terkini.
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.
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
01Chatbot AI untuk dokumentasiLihat alur kerja chatbot dokumentasi yang dikutip sumber yang berlaku di seluruh platform.02API dokumentasi chatbotJawab pertanyaan titik akhir, parameter, dan autentikasi dari dokumen referensi Python dan API.03Obrolan Docusaurus AIBandingkan alur kerja dasar yang sama untuk situs dokumentasi Docusaurus.04Telusuri semua panduan platformTemukan panduan pengaturan untuk Docusaurus, VitePress, Starlight, Nextra, Mintlify, ReadMe, dan platform dokumen lainnya.
Tanya Jawab
Pertanyaan umum
1
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.
2
Apakah saya perlu mengubah pipeline build Python saya?
Tidak. Tambahkan cuplikan widget ke templat situs Anda atau penggantian tema setelah mengonfigurasi chatbot.
3
Bisakah bot menjawab dari dokumen berversi?
Ya, jika laman dokumen berversi bersifat publik dan disertakan dalam perayapan atau peta situs.
4
Bisakah hal ini mengidentifikasi kesenjangan dokumentasi?
Ya. Analisis ChattyBox membantu mengungkap pertanyaan yang belum terjawab dengan jelas oleh konten MkDocs Anda.
Daftar untuk mencoba paket Free kami
Sedang mengevaluasi ChattyBox untuk organisasi? Hubungi tim dukungan untuk mendiskusikan uji coba paket yang lebih besar.