Tillbaka till instrumentpanelen

Dokumentation

Lär dig hur du använder Asyntai

Docusaurus Integration

Add the Asyntai chat assistant to your Docusaurus documentation site with one plugin

Skapa konto

Översikt

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.

Hur det fungerar

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

  • Ett Asyntai-konto. Att skapa ett är gratis, och gratisplanen räcker för att testa widgeten.
  • 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:

1

Installera tillägget

Run this command in the folder that holds your Docusaurus site.

npm install docusaurus-plugin-asyntai
2

Kopiera ditt widget-ID

Öppna sidan Installation i din Asyntai-instrumentpanel. Ditt widget-ID är värdet på data-asyntai-id i kodstycket som visas där.

data-asyntai-id="asyntai_xxxxxxxxxxxx"
3

Add It to Your Configuration

Open docusaurus.config.js and add the plugin with your widget ID.

plugins: [
  ['docusaurus-plugin-asyntai', {widgetId: 'asyntai_xxxxxxxxxxxx'}],
],
4

Build Your Site

Run your usual build command and publish the site. The chat bubble is on every page.

npm run build

Tips: Lägg till dina dokument, dina frågor och svar och dina instruktioner i Asyntai-instrumentpanelen innan du publicerar, så att assistenten svarar rätt redan för den första besökaren.

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.

Alternativ

  • 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.

Ta bort den

Delete the plugin entry from docusaurus.config.js and build the site again. The widget is gone.

Integritet

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. Integritetspolicy.

Paket och priser

Tillägget är gratis, och widgeten fungerar med alla Asyntai-planer, även gratisplanen. Varje plan innehåller ett månatligt antal meddelanden, delat mellan din webbplatswidget och alla dina integrationer. Betalda planer höjer det antalet. Visa priser.

Behöver du hjälp?

Om du har några frågor eller stöter på problem, kontakta oss på [email protected].