Back to Dashboard

Documentation

Learn how to use Asyntai

Getting Started
Installation Knowledge Base How the AI Accesses Your Content Connect Your Website Test Your AI Manage Websites
Customization
Widget Colors AI Assistant Name Initial Message Widget Position Auto-Trigger Greeting Bubble Unread Badge Instruction Mode Ask Questions Use Emoji Collect Emails Collect Phone Numbers Smart Lead Capture Localization Hide Branding Privacy Link Custom Notice Transcript Download New Conversation Conversation History Tagline & Status Dot Speech to Text Chat Icon Company Logo Character Limit Temperature
AI Instructions Tips Switching From Another Chatbot Compare Plans
Features
Ask AI Bar AI Search Bar Website Crawl Knowledge Gaps Product Cards Dynamic Product Cards Dynamic Images User Context Custom Tools Link Parameters Live Monitoring Human Takeover Escalation AI Notifications Daily Report Real-Time Data Feed Real-Time Data Feed Max Team Members Single Sign-On Two-Factor Authentication Include Images Image Vision Translation Widget Localization AI Transparency Leads Smart Lead Capture Support Tickets Bookings Embeds Exclude Pages Blocked IPs Retention Policy Zero Retention Mode PII Redaction Output Classifier Access Tags Widget Version Pinning Audit Log Smarter Model Enable Thinking Reply Suggestions Follow-up Messages Speech to Text Transcript Download Embedded Chat Iframe Embed
Analytics
Chat Analytics Chat Logs
Integrations
REST API Instagram Messenger WhatsApp Discord Zulip phpBB NodeBB Rocket.Chat WHMCS Airtable Trello Matomo Coda Thinkific Docusaurus Google Tag Manager Webex Zapier Email Notion GitBook Confluence Jira Service Management Contao Zoho Desk Mobile Apps
Other
Add to Home Screen Custom Open Button Ask AI Buttons Payment Failed?
Ask AI

Docusaurus Integration

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

Create Account

Overview

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.

How It Works

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.

Requirements

  • An Asyntai account. Creating one is free, and the Free plan is enough to test the widget.
  • 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

Install the Plugin

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

npm install docusaurus-plugin-asyntai
2

Copy Your Widget ID

Open the Install page in your Asyntai dashboard. Your widget ID is the value of data-asyntai-id in the snippet shown there.

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

Tip: Add your documents, questions and answers, and your instructions in the Asyntai Dashboard before you publish, so the assistant answers properly from the first visitor.

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.

Options

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

Removing It

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. Privacy policy.

Plans & Pricing

The plugin is free, and the widget works on every Asyntai plan, including the Free plan. Each plan includes a monthly number of messages, shared across your website widget and all your integrations. Paid plans raise that number. View pricing.

Need Help?

If you have any questions or run into issues, contact us at [email protected].