Docusaurus Integration
Add the Asyntai chat assistant to your Docusaurus documentation site with one plugin
Overzicht
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.
Hoe het werkt
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.
Vereisten
- Een Asyntai-account. Aanmaken is gratis, en het gratis abonnement is genoeg om de widget te testen.
- A Docusaurus site, version 2 or 3
- Node.js 18 or newer, which Docusaurus already needs
Installatie
Follow these steps to add Asyntai to your Docusaurus site:
Installeer de plugin
Run this command in the folder that holds your Docusaurus site.
npm install docusaurus-plugin-asyntai
Kopieer je widget-ID
Open de pagina Installatie in je Asyntai-dashboard. Je widget-ID is de waarde van data-asyntai-id in het stukje code dat daar staat.
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
Tip: Voeg je documenten, je vragen en antwoorden en je instructies toe in het Asyntai-dashboard voordat je publiceert, zodat de assistent al de eerste bezoeker goed beantwoordt.
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.
Opties
- 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.
Hem verwijderen
Delete the plugin entry from docusaurus.config.js and build the site again. The widget is gone.
Privacy
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. Privacybeleid.
Abonnementen en prijzen
De plugin is gratis, en de widget werkt met elk Asyntai-abonnement, ook het gratis abonnement. Elk abonnement bevat een maandelijks aantal berichten, gedeeld door je websitewidget en al je integraties. Betaalde abonnementen verhogen dat aantal. Prijzen bekijken.
Hulp nodig?
Als u vragen heeft of problemen ondervindt, neem dan contact met ons op via [email protected].