Retour au tableau de bord

Documentation

Apprenez à utiliser Asyntai

Intégration Docusaurus

Ajoutez l'assistant de chat Asyntai à votre site de documentation Docusaurus avec un seul plugin

Créer un compte

Aperçu

Docusaurus transforme vos fichiers Markdown en site de documentation. Le plugin Asyntai ajoute l'assistant de chat à chaque page qu'il génère, pour que vos lecteurs puissent poser une question au lieu de chercher. Vous ajoutez une ligne à votre fichier de configuration, rien de plus.

Comment ça marche

Le plugin ajoute une balise script après le corps de chaque page générée. La balise est marquée async, donc votre documentation s'affiche d'abord et le widget se charge ensuite. Rien d'autre ne change sur votre site.

Prérequis

  • Un compte Asyntai. La création est gratuite, et le forfait gratuit suffit pour tester le widget.
  • Un site Docusaurus, version 2 ou 3
  • Node.js 18 ou plus récent, dont Docusaurus a déjà besoin

Installation

Suivez ces étapes pour ajouter Asyntai à votre site Docusaurus :

1

Installer le plugin

Lancez cette commande dans le dossier qui contient votre site Docusaurus.

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

Ajoutez-le à votre configuration

Ouvrez docusaurus.config.js et ajoutez le plugin avec votre identifiant de widget.

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

Construisez votre site

Lancez votre commande de build habituelle et publiez le site. La bulle de chat est sur chaque 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.

Répondre à partir de votre documentation

Asyntai lit vos pages publiées. Ajoutez l'adresse de votre site dans le tableau de bord, et l'assistant répond à partir de la documentation même sur laquelle se trouve le widget. Vous pouvez aussi ajouter d'autres documents ainsi que des questions et réponses.

Options

  • widgetId indique quel compte Asyntai répond. Il est obligatoire, et une valeur erronée arrête le build avec un message clair.
  • enableInDevelopment réglé sur false garde le widget hors du site pendant que vous utilisez le serveur de développement local.
  • scriptUrl charge le widget depuis une autre adresse. La plupart des sites n'en ont jamais besoin.

Le retirer

Supprimez l'entrée du plugin dans docusaurus.config.js et reconstruisez le site. Le widget a disparu.

Confidentialité

Le plugin n'envoie aucune donnée de lui-même. Asyntai reçoit des données seulement quand un visiteur ouvre le chat et écrit un message, exactement comme avec un extrait de code collé à la main. 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 ?

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