Docusaurus Integration
Add the Asyntai chat assistant to your Docusaurus documentation site with one plugin
Übersicht
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.
So funktioniert es
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.
Voraussetzungen
- Ein Asyntai-Konto. Die Registrierung ist kostenlos, und der kostenlose Tarif genügt, um das Widget zu testen.
- A Docusaurus site, version 2 or 3
- Node.js 18 or newer, which Docusaurus already needs
Installation
Follow these steps to add Asyntai to your Docusaurus site:
Plugin installieren
Run this command in the folder that holds your Docusaurus site.
npm install docusaurus-plugin-asyntai
Widget-ID kopieren
Öffnen Sie die Seite Installation in Ihrem Asyntai-Dashboard. Ihre Widget-ID ist der Wert von data-asyntai-id in dem dort gezeigten Codeschnipsel.
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: Fügen Sie Ihre Dokumente, Ihre Fragen und Antworten und Ihre Anweisungen im Asyntai-Dashboard hinzu, bevor Sie veröffentlichen, damit der Assistent schon den ersten Besucher richtig beantwortet.
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.
Optionen
- 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.
Modul entfernen
Delete the plugin entry from docusaurus.config.js and build the site again. The widget is gone.
Datenschutz
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. Datenschutzerklärung.
Tarife und Preise
Das Plugin ist kostenlos, und das Widget funktioniert mit jedem Asyntai-Tarif, auch dem kostenlosen. Jeder Tarif enthält eine monatliche Anzahl an Nachrichten, die sich Ihr Website-Widget und alle Ihre Integrationen teilen. Bezahlte Tarife erhöhen diese Anzahl. Preise ansehen.
Brauchen Sie Hilfe?
Wenn Sie Fragen haben oder auf Probleme stoßen, kontaktieren Sie uns unter [email protected].