Docusaurus Integration
Add the Asyntai chat assistant to your Docusaurus documentation site with one plugin
Oversikt
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.
Slik fungerer det
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.
Krav
- En Asyntai-konto. Det er gratis å opprette en, og gratisplanen holder for å teste widgeten.
- A Docusaurus site, version 2 or 3
- Node.js 18 or newer, which Docusaurus already needs
Installasjon
Follow these steps to add Asyntai to your Docusaurus site:
Installer utvidelsen
Run this command in the folder that holds your Docusaurus site.
npm install docusaurus-plugin-asyntai
Kopier widget-ID-en din
Åpne siden Installasjon i Asyntai-oversikten. Widget-ID-en din er verdien av data-asyntai-id i kodesnutten som vises der.
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
Tips: Legg inn dokumentene dine, spørsmålene og svarene dine og instruksjonene dine i Asyntai-oversikten før du publiserer, slik at assistenten svarer riktig allerede for den første besøkende.
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.
Alternativer
- 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.
Slik fjerner du den
Delete the plugin entry from docusaurus.config.js and build the site again. The widget is gone.
Personvern
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. Personvernerklæring.
Abonnementer og priser
Utvidelsen er gratis, og widgeten virker med alle Asyntai-planer, også gratisplanen. Hver plan inneholder et månedlig antall meldinger, delt mellom widgeten på nettstedet og alle integrasjonene dine. Betalte planer øker det antallet. Se priser.
Trenger du hjelp?
Hvis du har spørsmål eller støter på problemer, kontakt oss på [email protected].