01
Yn gweithio gyda Deunydd ar gyfer tudalennau MkDocs
Canllawiau mynegeio, tudalennau cyfeirio, a HTML statig wedi'i gynhyrchu o MkDocs cyhoeddus neu Ddeunydd ar gyfer defnydd MkDocs heb ddisodli'ch thema.
MkDocs Cefnogi Bot
Ychwanegwch chatbot AI sy'n dyfynnu ffynonellau at eich dogfennaeth MkDocs a Material
Defnyddiwch ChattyBox i wneud eich cynnwys MkDocs yn chwiliadwy trwy declyn sgwrsio sy'n aros wedi'i seilio ar eich tudalennau ffynhonnell.
Crawls tudalennau dogfennau cyhoeddedigAtebion ffynhonnellMewnosod gydag un sgriptNid oes angen mudo dogfennauNid oes angen cerdyn credydMae eich cynnwys yn parhau'n eiddo i chi
Cofrestrwch i brofi ein cynllun Free
Ydych chi'n gwerthuso ChattyBox ar gyfer sefydliad? Cysylltwch â'r tîm cymorth i drafod treial o gynllun mwy.
Gofynnwch i ChattyBox
xBle ddylwn i ddechrau os oes angen ateb dibynadwy arnaf o'r wefan hon?
Dechreuwch trwy ychwanegu URL eich gwefan at ChattyBox. Mae'n cropian eich cynnwys, yn ateb o'r tudalennau y mae'n dod o hyd iddynt, ac yn dangos i ymwelwyr y ffynonellau y tu ôl i bob ymateb.
iFfynonellau3^
MkDocs canllaw
chattybox.ai
Dadansoddeg
chattybox.ai
Cartref
chattybox.ai
Gofynnwch gwestiwn...
Wedi'i bweru gan ChattyBox
Adeiladwyd ar gyfer MkDocs timau
Lansiwch chatbot â dyfyniadau ffynhonnell heb ailadeiladu pentwr eich gwefan
Mae ChattyBox yn cropian eich gwefan bresennol, dogfennaeth, canolfan gymorth, CMS neu sylfaen wybodaeth, ac yna'n mewnosod chatbot sy'n ateb o'ch cynnwys cyhoeddedig eich hun yn hytrach na chof generig model.
Mae'r gwrthwneud Material yn cadw thema JavaScript ac yn ychwanegu un llwythwr teclyn asyncronaidd.
Mae Vanilla MkDocs yn defnyddio cyfeiriadur thema arfer ar wahân yn lle rhagdybio llwybrau Material.
Mae'r gwiriadau'n cynnwys chwilio ochr yn ochr â'r teclyn, llywio ar unwaith, llwythwyr dyblyg, a golygfannau symudol cul.
Mae detholiad cropian ymwybodol o fersiynau yn cadw llwybrau sefydlog, diweddaraf, ac etifeddiaeth mike yn fwriadol.
1Cam llif gwaith
Cropiwch y map gwefan MkDocs sydd wedi'i ddefnyddio neu'r llwybrau sefydlog a fersiynau rydych chi'n eu cefnogi'n fwriadol.
2Cam llif gwaith
Profwch gwestiynau am y cynnyrch, Python ac API, ac agorwch bob dyfyniad cyn gosod.
3Cam llif gwaith
Ar gyfer Material, ffurfweddwch theme.custom_dir ac ymestyn base.html o overrides/main.html tra'n cadw'r bloc sgriptiau gyda super().
4Cam llif gwaith
Dilyswch chwiliad adeiledig, llywio ar unwaith, rheolyddion symudol, CSP, a phob fersiwn mike cyhoeddedig.
Lansiad tri cham
Gludwch eich URL MkDocs, profwch yr atebion a ddyfynnir, yna gosodwch y teclyn.
Llif gwaith penodol i MkDocs
Cefnogaeth sgwrsio ar gyfer safleoedd dogfennu Python statig
Mae timau MkDocs fel arfer eisiau adeiladau statig cyflym, llywio clir, a chynnwys technegol darllenadwy. Mae ChattyBox yn cadw'r llif gwaith hwnnw'n gyfan tra'n ychwanegu cynorthwyydd y cyfeiriwyd ato yn y ffynhonnell ar ben y wefan gyhoeddedig.
Llwybr penderfyniad
Defnyddiwch y pwyntiau gwirio hyn i benderfynu a ddylai ChattyBox eistedd wrth ymyl eich platfform docs, amnewid cynorthwyydd ar wahân, neu aros yn ynysig ar gyfer profi.
02
Trin dogfennaeth fersiwn yn fwriadol
Pwyntiwch ChattyBox at y llwybrau fersiwn rydych chi am i ddefnyddwyr ofyn amdanynt, yna profwch a yw'r atebion yn dyfynnu'r dogfennau sefydlog, diweddaraf neu etifeddiaeth bwriedig.
03
Dim swydd mynegeio Python i'w chynnal
Gan fod ChattyBox yn cropian o'r safle cyhoeddus, nid oes angen i dimau ychwanegu mynegeio fector i'w piblinell adeiladu MkDocs neu sgriptiau CI.
04
Gwella dogfennau o gwestiynau go iawn
Defnyddiwch gwestiynau heb eu hateb i nodi enghreifftiau coll, camau gosod aneglur, neu dudalennau datrys problemau hen ffasiwn yn eich gwefan MkDocs.
Tystiolaeth olygyddol wedi'i phrofi
Wedi profi llwybrau gosod Material a fanila MkDocs
Mae Material for MkDocs a thema barod MkDocs ill dau yn cefnogi etifeddu templedi, ond dylent ddefnyddio cyfeiriaduron personol ar wahân. Mae'r llwybr Material isod yn cadw ei floc scripts gyda super(), yn ychwanegu un llwythwr async, ac yn goroesi llywio ar unwaith heb ddisodli ymddygiad chwilio.
- Awdur technegol
- Tîm Dogfennaeth ChattyBox
- Adolygydd technegol
- Peirianneg ChattyBox
- Diweddarwyd diwethaf
- Gwybodaeth wedi'i gwirio
- MkDocs, Material for MkDocs a mike
Ailwiriwch flociau templed ac ymddygiad llywio ar unwaith ar ôl uwchraddio'r thema, ac ailgropiwch pryd bynnag y bydd alias mike yn symud.
| Mater MkDocs | Penderfyniad gweithredu | Dilysu |
|---|---|---|
Mater MkDocs Gwrthwneud Material | Penderfyniad gweithredu Gosodwch theme.name yn material a theme.custom_dir yn overrides. Estynnwch base.html, gwrthwneudwch scripts, galwch super(), ac yna atodwch sgript y teclyn. | Dilysu Adeiladwch a gweinwch y safle, yna cadarnhewch fod chwilio a llywio Material yn dal i weithio. |
Mater MkDocs Fanila MkDocs | Penderfyniad gweithredu Defnyddiwch theme.name: mkdocs gyda chyfeiriadur custom_theme ar wahân. Ychwanegwch y gwrthwneud custom_theme/main.html cyfatebol yn hytrach na chopïo templedi Material. | Dilysu Rhedeg mkdocs serve a gwirio chwiliad, dolenni nesaf a blaenorol, a'r teclyn ar fwy nag un dudalen. |
Mater MkDocs Llwytho async a dyblygu | Penderfyniad gweithredu Cadwch un llwythwr yn y bloc scripts a etifeddwyd, rhowch ID sefydlog iddo, a pheidiwch ag ychwanegu'r un snippet drwy extra_javascript neu ddarn arall. | Dilysu Ar ôl llwythi llawn a thrawsnewidiadau sydyn Material, cadarnhewch mai 1 yw document.querySelectorAll("#chattybox-widget").length. |
Mater MkDocs Polisi Diogelwch Cynnwys | Penderfyniad gweithredu Caniatewch chattybox.ai yn script-src, y tarddiad API wedi'i ffurfweddu yn connect-src, fonts.googleapis.com yn style-src, a fonts.gstatic.com yn font-src. Mae'r teclyn cyfredol yn chwistrellu ei CSS cydran, felly mae style-src llym hefyd angen 'unsafe-inline' hyd nes bod build sy'n ymwybodol o nonce neu ddalen arddull allanol ar gael. | Dilysu Gwiriwch gonsol y porwr a'r panel Network am geisiadau script, fetch neu WebSocket sydd wedi'u rhwystro. |
Mater MkDocs Chwilio, llywio ar unwaith, a symudol | Penderfyniad gweithredu Cadwch sgriptiau thema gyda super() a chadwch y lansiwr yn glir o'r deialog chwilio, y drôr, y dudaleniad, a'r rheolyddion caniatâd. | Dilysu Profwch chwiliad bysellfwrdd, sawl dolen wib, a golygfan 390-picsel heb unrhyw orgyffwrdd na sgrolio llorweddol. |
Mater MkDocs fersiynau mike | Penderfyniad gweithredu Dewiswch lwybrau stable, latest neu fersiwn benodol yn fwriadol. Ailgropiwch ar ôl symud alias, a hepgorwch ddatganiadau heb gefnogaeth pan fyddai atebion traws-fersiwn yn camarwain defnyddwyr. | Dilysu Defnyddiwch mike serve i brofi newid fersiwn a chadarnhau datrysiad dyfyniadau y tu mewn i'r fersiwn arfaethedig. |
Mater MkDocs Methiant teclyn neu ddyfyniad | Penderfyniad gweithredu Gwiriwch fewnoliad YAML, y custom_dir gweithredol, enw bloc etifeddol, allwedd API, CSP, cynnwys map gwefan, ac a yw'r adeiladwaith a ddefnyddir yn cynnwys y gwrthwneud. | Dilysu Archwiliwch HTML a gynhyrchir a phrofwch yr arteffact cynhyrchu yn hytrach na dibynnu ar ail-lwytho byw yn unig. |
Gwiriad ateb a ddyfynnwyd
Profwch ateb yn erbyn y fersiwn gweithredol
Defnyddiwch gwestiwn thema gyda rheol dempled gwiriadwy, yna agorwch y dyfyniad a chadarnhewch ei fod yn cyfateb i'r fersiwn a ddewisodd eich ymwelydd.
Gofynnwch i'r canllawiau MkDocs
xSut mae ychwanegu'r teclyn heb dorri chwiliad Material?
Gosodwch theme.custom_dir yn overrides, crëwch overrides/main.html, estynnwch base.html, ac ychwanegwch y llwythwr async yn y bloc scripts ar ôl super(). Mae galw super() yn cadw'r sgriptiau y mae Material yn eu defnyddio ar gyfer chwilio a llywio.
Gofynnwch gwestiwn...
Wedi'i bweru gan ChattyBox
Ffynonellau cynradd a thystiolaeth atgynhyrchadwy
Addasu Material for MkDocsCanllawiau swyddogol ar custom_dir, etifeddu templedi a gwrthwneud blociau.Llywio ar unwaith yn MaterialYmddygiad swyddogol ar gyfer amnewid dogfen heb ail-lwytho tudalen lawn.Addasu thema MkDocsCyfeiriadur thema arfer swyddogol, templed sylfaen, a chanllawiau super() ar gyfer fanila MkDocs.Dogfennaeth fersiwn mikeDefnyddio fersiwn, arallenwau, fersiwn ddiofyn, a phrofi aml-fersiwn lleol.Enghreifftiau MkDocs y gellir eu rhedegEnghreifftiau Material a MkDocs vanilla gyda throsysgrifiadau thema, tudalennau profi, a phriodoleddau cyfredol y teclyn.
Gosod llwybr
Sut i ychwanegu'r teclyn at MkDocs
Ar gyfer Material for MkDocs, gosodwch theme.custom_dir i overrides, ymestynwch base.html yn overrides/main.html, a ffoniwch super() cyn y sgript widget async. Mae angen cyfeiriadur thema cyfaddas ei hun ar MkDocs plaen a gwrthwneud main.html cyfatebol.
- 1Crëwch brosiect ChattyBox a rhowch eich MkDocs neu Ddeunydd ar gyfer URL safle MkDocs neu fap gwefan.
- 2Profwch gwestiynau MkDocs go iawn yn y dangosfwrdd a chadarnhewch y dyfyniadau sy'n pwyntio at y tudalennau cywir.
- 3Ychwanegwch y gwrthwneud a brofwyd, adeiladwch y safle, a gwiriwch chwilio, llywio, CSP, ac ymddygiad symudol.
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 %}Archwiliwch nesaf
Mwy o ffyrdd i ddefnyddio ChattyBox
01AI chatbot ar gyfer dogfennaethGweler y llif gwaith chatbot dogfennaeth a ddyfynnwyd yn ffynhonnell sy'n berthnasol ar draws platfformau.02API chatbot dogfennaethAtebwch ddiweddbwynt, paramedr, a chwestiynau dilysu o ddogfennau cyfeirio Python a API.03Chatbot Docusaurus AICymharwch yr un llif gwaith sylfaenol ar gyfer safleoedd dogfennu Docusaurus.04Porwch yr holl ganllawiau platfformDewch o hyd i ganllawiau gosod ar gyfer llwyfannau Docusaurus, VitePress, Starlight, Nextra, Mintlify, ReadMe, a mwy.
Cwestiynau cyffredin
Cwestiynau cyffredin
1
Ydy ChattyBox yn gweithio gyda Material for MkDocs?
Oes. Gall ChattyBox gropian tudalennau cyhoeddus MkDocs a Material for MkDocs a'u hymgorffori fel teclyn gwefan safonol.
2
A oes angen i mi newid fy mhiblinell adeiladu Python?
Nac ydy. Ychwanegwch y pyt teclyn at eich templed gwefan neu wrthwneud thema ar ôl ffurfweddu'r chatbot.
3
A all y bot ateb o ddogfennau fersiwn?
Oes, os yw tudalennau dogfennau fersiwn yn gyhoeddus ac wedi'u cynnwys yn y cropian neu'r map gwefan.
4
A all nodi bylchau yn y ddogfennaeth?
Oes. Mae dadansoddeg ChattyBox yn helpu i ddatgelu cwestiynau nad yw eich cynnwys MkDocs yn eu hateb yn glir eto.
Cofrestrwch i brofi ein cynllun Free
Ydych chi'n gwerthuso ChattyBox ar gyfer sefydliad? Cysylltwch â'r tîm cymorth i drafod treial o gynllun mwy.