Docusaurus Integration
Add the Asyntai chat assistant to your Docusaurus documentation site with one plugin
Áttekintés
Docusaurus turns your Markdown files into a documentation website. The Asyntai plugin adds the chat assistant to every page it builds, so readers can ask a question instead of searching. You add one line to your configuration file and nothing else.
Hogyan működik
The plugin adds one script tag after the body of every generated page. The tag is marked async, so your documentation renders first and the widget loads after it. Nothing else about your site changes.
Követelmények
- Egy Asyntai-fiók. A létrehozása ingyenes, és az ingyenes csomag elég az ablak kipróbálásához.
- A Docusaurus site, version 2 or 3
- Node.js 18 or newer, which Docusaurus already needs
Telepítés
Follow these steps to add Asyntai to your Docusaurus site:
Telepítsd a bővítményt
Run this command in the folder that holds your Docusaurus site.
npm install docusaurus-plugin-asyntai
Másold ki a widget-azonosítót
Nyisd meg a Telepítés oldalt az Asyntai vezérlőpultján. A widget-azonosítód az ott mutatott kódrészletben a data-asyntai-id értéke.
data-asyntai-id="asyntai_xxxxxxxxxxxx"
Add It to Your Configuration
Open docusaurus.config.js and add the plugin with your widget ID.
plugins: [
['docusaurus-plugin-asyntai', {widgetId: 'asyntai_xxxxxxxxxxxx'}],
],Build Your Site
Run your usual build command and publish the site. The chat bubble is on every page.
npm run build
Tipp: Közzététel előtt add hozzá dokumentumaidat, kérdéseidet és válaszaidat, valamint utasításaidat az Asyntai vezérlőpultján, hogy a segéd már az első látogatónak is jól válaszoljon.
Answering From Your Documentation
Asyntai reads your published pages. Add your site address in the dashboard, and the assistant answers from the same documentation the widget sits on. You can add extra documents and question and answer pairs as well.
Opciók
- widgetId sets which Asyntai account answers. It is required, and a wrong value stops the build with a clear message.
- enableInDevelopment set to false keeps the widget off the site while you run the local development server.
- scriptUrl loads the widget from another address. Most sites never need this.
Eltávolítás
Delete the plugin entry from docusaurus.config.js and build the site again. The widget is gone.
Adatvédelem
The plugin sends no data on its own. Asyntai receives data only when a visitor opens the chat and writes a message, exactly as it would with a snippet pasted by hand. Adatvédelmi tájékoztató.
Csomagok és árak
A bővítmény ingyenes, és az ablak minden Asyntai-csomaggal működik, az ingyenessel is. Minden csomag havi üzenetszámot tartalmaz, amelyen a webhelyed ablaka és az összes integrációd osztozik. A fizetős csomagok növelik ezt a számot. Árak megtekintése.
Segítségre van szükséged?
Ha bármilyen kérdésed van vagy problémába ütközöl, lépj kapcsolatba velünk a [email protected] e-mail-címen.