Docusaurus Integration
Fügen Sie den Asyntai Chat-Assistenten mit einem Plugin zu Ihrer Docusaurus Dokumentation hinzu
Übersicht
Docusaurus macht aus Ihren Markdown-Dateien eine Dokumentations-Website. Das Asyntai Plugin fügt den Chat-Assistenten auf jeder erzeugten Seite hinzu, damit Leser fragen können, statt zu suchen. Sie ergänzen eine Zeile in Ihrer Konfigurationsdatei, sonst nichts.
So funktioniert es
Das Plugin fügt ein Skript-Tag nach dem Body jeder erzeugten Seite ein. Das Tag ist als async markiert, damit Ihre Dokumentation zuerst erscheint und das Widget danach lädt. Sonst ändert sich nichts an Ihrer Website.
Voraussetzungen
- Ein Asyntai-Konto. Die Registrierung ist kostenlos, und der kostenlose Tarif genügt, um das Widget zu testen.
- Eine Docusaurus Website, Version 2 oder 3
- Node.js 18 oder neuer, das Docusaurus ohnehin benötigt
Installation
Führen Sie diese Schritte aus, um Asyntai zu Ihrer Docusaurus Website hinzuzufügen:
Plugin installieren
Führen Sie diesen Befehl in dem Ordner aus, der Ihre Docusaurus Website enthält.
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"
Zur Konfiguration hinzufügen
Öffnen Sie docusaurus.config.js und fügen Sie das Plugin mit Ihrer Widget-ID hinzu.
plugins: [
['docusaurus-plugin-asyntai', {widgetId: 'asyntai_xxxxxxxxxxxx'}],
],
Website bauen
Führen Sie Ihren üblichen Build-Befehl aus und veröffentlichen Sie die Website. Die Chat-Blase ist auf jeder Seite.
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.
Antworten aus Ihrer Dokumentation
Asyntai liest Ihre veröffentlichten Seiten. Tragen Sie Ihre Website-Adresse im Dashboard ein, und der Assistent antwortet aus derselben Dokumentation, auf der das Widget sitzt. Sie können auch weitere Dokumente sowie Fragen und Antworten ergänzen.
Optionen
- widgetId legt fest, welches Asyntai Konto antwortet. Der Wert ist erforderlich, und ein falscher Wert stoppt den Build mit einer klaren Meldung.
- enableInDevelopment auf false hält das Widget von der Website fern, solange Sie den lokalen Entwicklungsserver nutzen.
- scriptUrl lädt das Widget von einer anderen Adresse. Die meisten Websites brauchen das nie.
Modul entfernen
Löschen Sie den Plugin-Eintrag aus docusaurus.config.js und bauen Sie die Website erneut. Das Widget ist weg.
Datenschutz
Das Plugin sendet von sich aus keine Daten. Asyntai erhält Daten nur, wenn ein Besucher den Chat öffnet und eine Nachricht schreibt, genau wie bei einem von Hand eingefügten Code-Schnipsel. 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?
If you have any questions or run into issues, contact us at [email protected].