Retour au tableau de bord

Documentation

Apprenez à utiliser Asyntai

Docusaurus Integration

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

Créer un compte

Aperçu

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.

Comment ça marche

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.

Prérequis

  • Un compte Asyntai. La création est gratuite, et le forfait gratuit suffit pour tester le 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

Installer le plugin

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

npm install docusaurus-plugin-asyntai
2

Copier votre identifiant de widget

Ouvrez la page Installation dans votre tableau de bord Asyntai. Votre identifiant de widget est la valeur de data-asyntai-id dans le code affiché.

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

Astuce : Ajoutez vos documents, vos questions et réponses et vos instructions dans le tableau de bord Asyntai avant de publier, afin que l'assistant réponde correctement dès le premier visiteur.

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.

Le retirer

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

Confidentialité

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. Politique de confidentialité.

Formules et tarifs

Le plugin est gratuit, et le widget fonctionne avec tous les forfaits Asyntai, y compris le forfait gratuit. Chaque forfait comprend un nombre mensuel de messages, partagé entre le widget de votre site et toutes vos intégrations. Les forfaits payants augmentent ce nombre. Voir les tarifs.

Besoin d'aide ?

Si vous avez des questions ou rencontrez des problèmes, contactez-nous à [email protected].