Docusaurus Integration
Add the Asyntai chat assistant to your Docusaurus documentation site with one plugin
Pregled
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.
Kako deluje
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.
Zahteve
- Račun Asyntai. Odprtje je brezplačno, brezplačni paket pa zadostuje za preizkus pripomočka.
- A Docusaurus site, version 2 or 3
- Node.js 18 or newer, which Docusaurus already needs
Namestitev
Follow these steps to add Asyntai to your Docusaurus site:
Namestite vtičnik
Run this command in the folder that holds your Docusaurus site.
npm install docusaurus-plugin-asyntai
Kopirajte identifikator pripomočka
Odprite stran Namestitev v svoji nadzorni plošči Asyntai. Identifikator pripomočka je vrednost data-asyntai-id v tam prikazani kodi.
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
Nasvet: Pred objavo dodajte svoje dokumente, vprašanja in odgovore ter navodila v nadzorni plošči Asyntai, da pomočnik pravilno odgovori že prvemu obiskovalcu.
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.
Možnosti
- 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.
Kako ga odstranite
Delete the plugin entry from docusaurus.config.js and build the site again. The widget is gone.
Zasebnost
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. Politika zasebnosti.
Paketi in cene
Vtičnik je brezplačen, pripomoček pa deluje z vsakim paketom Asyntai, tudi brezplačnim. Vsak paket vključuje mesečno število sporočil, skupno za pripomoček na vašem spletnem mestu in vse vaše integracije. Plačljivi paketi to število zvišajo. Ogled cen.
Potrebujete pomoč?
Če imate kakršna koli vprašanja ali naletite na težave, nas kontaktirajte na [email protected].