MkDocs Tukibotti

MkDocs AI-chatbot MkDocs-dokumentaatio

AI-chatbot MkDocs- ja Material for MkDocs -dokumentaatioon. ChattyBox haravoi julkisen sivustosi, vastaa kysymyksiin kuten "Kuinka otan navigointivälilehdet käyttöön?" näiltä sivuilta ja lainaa lähteen. Ei Python-indeksointiputkea tai omaa RAG-ratkaisua ylläpidettäväksi.

Indeksoi julkaistut asiakirjasivut

Lähdeviittauksia

Upota yhdellä skriptillä

Asiakirjojen siirtoa ei vaadita

Luo ilmainen MkDocs AI chatbot Lue asennusopas

Luottokorttia ei vaaditaSisältösi pysyy sinun

Kysy ChattyBoxilta

Mistä minun kannattaa aloittaa, jos tarvitsen luotettavan vastauksen tältä sivustolta?

Aloita lisäämällä verkkosivustosi URL ChattyBoxiin. Se haravoi sisältösi, vastaa löytämiensä sivujen perusteella ja näyttää kävijöille jokaisen vastauksen lähteet.

iLähteet3^

MkDocs opas

chattybox.ai

Analytiikka

chattybox.ai

Etusivu

chattybox.ai

Esitä kysymys...

Palvelun tarjoaa ChattyBox

Rakennettu mallille MkDocs joukkueita

Käynnistä lähteeseen viitattu chatbot rakentamatta uudelleen dokumenttipinoasi

ChattyBox indeksoi olemassa olevan dokumentaatiosi, indeksoi sisällön haettavaksi ja upottaa chatbotin, joka vastaa käyttämällä asiakirjojasi yleisen mallimuistin sijaan.

Material-ohitus säilyttää teeman JavaScript ja lisää yhden asynkronisen widget-lataajan.

Vanilla MkDocs käyttää erillistä mukautettua teemahakemistoa Material-polkujen oletuksen sijaan.

Tarkistukset kattavat haun rinnakkaiselon, välittömän navigoinnin, päällekkäiset latauslaitteet ja kapeat mobiilinäkymät.

Versiotietoinen indeksointivalinta pitää vakaat, uusimmat ja vanhat mike-reitit tarkoituksellisena.

Työnkulun vaihe

Indeksoi käyttöön otettu MkDocs-sivustokartta tai vakaat ja versioidut polut, joita tuet tarkoituksella.

Työnkulun vaihe

Testaa tuotetta, Python ja API kysymyksiä ja avaa jokainen lainaus ennen asennusta.

Työnkulun vaihe

Jos kyseessä on Material, määritä theme.custom_dir ja laajenna base.html kohdasta overrides/main.html säilyttäen samalla komentosarjalohkon super().

Työnkulun vaihe

Tarkista sisäänrakennettu haku, välitön navigointi, mobiiliohjaimet, CSP ja jokainen julkaistu mike-versio.

Kolmivaiheinen käynnistys

Liitä MkDocs URL-osoite, testaa lainatut vastaukset ja asenna sitten widget.

Luo ilmainen MkDocs AI chatbot

MkDocs-kohtainen työnkulku

Keskustelutuki staattisille Python-dokumentaatiosivustoille

MkDocs-tiimit haluavat yleensä nopeita staattisia rakennelmia, selkeää navigointia ja luettavaa teknistä sisältöä. ChattyBox pitää työnkulun ennallaan ja lisää lähteeseen viitatun avustajan julkaistun sivuston päälle.

Päätöksen polku

Käytä näitä tarkistuspisteitä päättääksesi, pitäisikö ChattyBox istua dokumenttialustan viereen, vaihtaa erillinen avustaja vai pysyä erillään testausta varten.

Toimii MkDocs-sivujen materiaalin kanssa

Hakemistooppaat, viitesivut ja luotu staattinen HTML-koodi julkisista MkDocs- tai Material for MkDocs -käyttöönotuksista vaihtamatta teemaasi.

Käsittele versioitua dokumentaatiota tarkoituksella

Osoita ChattyBox versiopolkuja, joista haluat käyttäjien kysyvän, ja testaa sitten, viittaavatko vastaukset aiottuihin vakiintuneisiin, uusimpiin tai vanhoihin asiakirjoihin.

Python-indeksointityötä ei ylläpidetä

Koska ChattyBox indeksoi julkisen sivuston, tiimien ei tarvitse lisätä vektori-indeksointia MkDocs-koontiversioihinsa tai CI-skripteihinsä.

Paranna asiakirjoja oikeista kysymyksistä

Käytä vastaamattomia kysymyksiä tunnistaaksesi puuttuvat esimerkit, epäselvät asennusvaiheet tai vanhentuneet vianetsintäsivut MkDocs-sivustoltasi.

Testattu toimituksellinen näyttö

Testatut Material for MkDocs- ja MkDocs-asennuspolut

Material for MkDocs ja MkDocsin sisäänrakennettu teema tukevat mallipohjien periytymistä, mutta niille pitää käyttää erillisiä mukautettuja hakemistoja. Alla oleva Material-polku säilyttää scripts-lohkon super()-kutsulla, lisää yhden asynkronisen lataajan ja kestää välittömän navigoinnin muuttamatta hakutoimintoa.

Tekninen kirjoittaja: ChattyBox-dokumentaatioryhmä
Tekninen arvioija: ChattyBoxin tekninen tiimi
Viimeksi päivitetty: 2026-07-09
Tiedot tarkistettu: MkDocs, Material for MkDocs ja mike

Tarkista mallien lohkot ja välittömän navigoinnin toiminta teemapäivitysten jälkeen ja indeksoi uudelleen aina, kun mike-alias liikkuu.

Material for MkDocs -teeman custom_dir-määritys ja teemakomponentit säilyttävä päämallipohjan korvaus — Alkuperäinen asennusviite: theme.custom_dir valitsee ohituksen ja super() pitää Material-haku- ja navigointikomentosarjat ennallaan.

Material for MkDocs- ja MkDocs-asennusten päätökset päästä päähän ulottuvine tarkistuksineen.
MkDocs huolenaihe	Täytäntöönpanopäätös	Vahvistus
Material ohitus	Aseta theme.name arvoksi material ja theme.custom_dir arvoksi overrides. Laajenna base.html-mallipohjaa, korvaa scripts-lohko, kutsu super() ja lisää sitten widget-skripti.	Rakenna ja palvele sivusto ja vahvista sitten, että Material-haku ja navigointi toimivat edelleen.
Vanilja MkDocs	Käytä theme.name: mkdocsia erillisen custom_theme-hakemiston kanssa. Lisää vastaava custom_theme/main.html ohitus Material-mallien kopioimisen sijaan.	Suorita mkdocs serve ja tarkista haku, seuraavan ja edellisen sivun linkit sekä widget useammalla kuin yhdellä sivulla.
Asynkroninen lataus ja kopiot	Säilytä yksi latausohjelma perittyjen komentosarjojen lohkossa, anna sille vakaa tunnus, äläkä lisää samaa katkelmaa extra_javascript:n tai muun osan kautta.	Varmista täysien sivulatausten ja Materialin välittömien siirtymien jälkeen, että document.querySelectorAll("#chattybox-widget").length on 1.
Sisällön suojauskäytäntö	Salli chattybox.ai script-src:ssä, määritetty API-alkuperä connect-src:ssä, fonts.googleapis.com style-src:ssä ja fonts.gstatic.com font-src:ssä. Nykyinen widget injektoi oman komponenttinsa CSS:n, joten tiukka style-src tarvitsee myös 'unsafe-inline'n, kunnes nonce-tietoinen tai ulkoinen tyylitiedostokoontiversio on saatavilla.	Tarkista selainkonsolista ja Network-paneelista estettyjen komentosarja-, tyyli-, fontti-, haku- tai WebSocket-pyyntöjen varalta.
Haku, välitön navigointi ja mobiili	Säilytä teemaskriptit super():lla ja pidä käynnistysohjelma poissa hakuikkunasta, vetolaatikosta, sivutus- ja suostumussäätimistä.	Testaa näppäimistöhakua, useita pikalinkkejä ja 390 pikselin näkymää ilman päällekkäisyyttä tai vaakasuuntaista vieritystä.
mike versiot	Valitse vakaat, uusimmat tai eksplisiittiset versiot tietoisesti. Indeksoi uudelleen aliaksen siirtämisen jälkeen ja sulje pois ei-tuetut julkaisut, jos versioiden väliset vastaukset johtaisivat käyttäjiä harhaan.	Käytä mike-palvelua versionvaihdon testaamiseen ja varmista, että lainaukset ratkeavat aiotun version sisällä.
Widget tai lainausvirhe	Tarkista YAML-sisennys, aktiivinen custom_dir, peritty lohkon nimi, API-avain, CSP, sivustokartan sisältö ja sisältääkö käyttöön otettu koontiversio ohituksen.	Tarkista luotu HTML ja testaa tuotantoartefaktia sen sijaan, että luottaisit vain reaaliaikaiseen uudelleenlataukseen.

Siteerattujen vastausten tarkistus

Testaa vastausta aktiiviseen versioon

Käytä teemakysymystä todennettavissa olevalla mallisäännöllä, avaa sitaatti ja varmista, että se vastaa vierailijasi valitsemaa versiota.

Kysy MkDocs-oppaista

Kuinka lisään widgetin rikkomatta Material-hakua?

Aseta theme.custom_dir arvoksi overrides, luo overrides/main.html, laajenna base.html-mallipohjaa ja lisää asynkroninen lataaja scripts-lohkoon super()-kutsun jälkeen. super()-kutsu säilyttää Materialin haussa ja navigoinnissa käyttämät komentosarjat.

iLähteet2^

Material: räätälöinti

squidfunk.github.io/mkdocs-material

MkDocs: teeman mukauttaminen

mkdocs.org/user-guide

Esitä kysymys...

Palvelun tarjoaa ChattyBox

Alkuperäinen mobiiliviite: haku on edelleen käytettävissä, käynnistysohjelmassa on käyttökelpoinen kosketuskohde, eikä sivu vieritä vaakasuunnassa.

Ensisijaiset lähteet ja toistettava näyttö

Material for MkDocs -teeman mukauttaminenVirallinen custom_dir, mallin periytyminen ja lohkon ohitusopastus.Material pikanavigointiVirallinen toimintatapa asiakirjan korvaamisessa ilman koko sivun uudelleenlatausta.MkDocs-teeman mukauttaminenVirallinen mukautettu teemahakemisto, perusmalli ja super()-opastus vaniljalle MkDocs.mike-versioinen dokumentaatioVersion käyttöönotto, aliakset, oletusversio ja paikallinen usean version testaus.Toistettavia MkDocs-esimerkkejäErilliset Material- ja vaniljaprojektit testatuilla mallien ohituksilla.

Asennuspolku

Widgetin lisääminen MkDocsiin

Aseta Material for MkDocsissa theme.custom_dir arvoon overrides, laajenna base.html tiedostossa overrides/main.html ja kutsu super() ennen asynkronista widget-skriptiä. Vanilla MkDocs tarvitsee oman mukautetun teemahakemiston ja vastaavan main.html-ohituksen.

1Luo ChattyBox-projekti ja kirjoita MkDocs- tai Material for MkDocs -sivustosi URL-osoite tai sivustokartta.
2Testaa oikeita MkDocs-kysymyksiä kojelaudassa ja varmista, että lainaukset osoittavat oikeille sivuille.
3Lisää testattu ohitus, rakenna sivusto ja varmista haku, navigointi, CSP ja mobiilikäyttäytyminen.

Luo ilmainen MkDocs AI chatbot

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 %}

Tutustu seuraavaksi

Lisää tapoja käyttää ChattyBoxia

Tutustu kaikkiin ratkaisuihin

AI chatbot dokumentointia varten

Katso lähdeviitattu dokumentaatio chatbotin työnkulku, joka koskee kaikkia alustoja.

Avaa

API dokumentaatio-chatbot

Vastaa päätepiste-, parametri- ja todennuskysymyksiin Pythonista ja API-viiteasiakirjoista.

Avaa

Docusaurus AI chatbot

Vertaa samaa maadoitettua työnkulkua Docusaurus-dokumentaatiosivustoille.

Avaa

Selaa kaikkia alustan oppaita

Löydä asennusoppaat Docusaurus-, VitePress-, Starlight-, Nextra-, Mintlify-, ReadMe- ja muille dokumenttialustoille.

Avaa

UKK

Yleisiä kysymyksiä

Toimiiko ChattyBox Material for MkDocs:n kanssa?

Kyllä. ChattyBox voi indeksoida julkisia MkDocs- ja Material for MkDocs-sivuja ja upottaa ne tavallisena verkkosivuston widgetina.

Pitääkö minun vaihtaa Python-rakennusputkistoani?

Ei. Lisää widget-koodinpätkä sivustosi malliin tai teeman ohitukseen, kun olet määrittänyt chatbotin.

Voiko robotti vastata versioiduista asiakirjoista?

Kyllä, jos versioidut asiakirjasivut ovat julkisia ja sisältyvät indeksointiin tai sivustokarttaan.

Voiko se tunnistaa asiakirjojen aukkoja?

Kyllä. ChattyBox-analytiikka auttaa paljastamaan kysymyksiä, joihin MkDocs-sisältösi ei vielä vastaa selkeästi.

Aloita ilmaiseksi

Luottokorttia ei vaadita. Sisältöäsi ei käytetä mallien kouluttamiseen.

Luo ilmainen chatbot

Ilmainen taso. Ei korttia.