Docusaurus Integration
Add the Asyntai chat assistant to your Docusaurus documentation site with one plugin
Descripción general
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.
Cómo funciona
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.
Requisitos
- Una cuenta de Asyntai. Crearla es gratis, y el plan gratuito basta para probar el widget.
- A Docusaurus site, version 2 or 3
- Node.js 18 or newer, which Docusaurus already needs
Instalación
Follow these steps to add Asyntai to your Docusaurus site:
Instala el plugin
Run this command in the folder that holds your Docusaurus site.
npm install docusaurus-plugin-asyntai
Copia tu ID de widget
Abre la página Instalación en tu panel de Asyntai. Tu ID de widget es el valor de data-asyntai-id en el fragmento que se muestra allí.
data-asyntai-id="asyntai_xxxxxxxxxxxx"
Add It to Your Configuration
Open docusaurus.config.js and add the plugin with your widget ID.
plugins: [
['docusaurus-plugin-asyntai', {widgetId: 'asyntai_xxxxxxxxxxxx'}],
],Build Your Site
Run your usual build command and publish the site. The chat bubble is on every page.
npm run build
Consejo: Añade tus documentos, tus preguntas y respuestas y tus instrucciones en el panel de Asyntai antes de publicar, para que el asistente responda bien desde el primer visitante.
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.
Opciones
- 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.
Cómo quitarlo
Delete the plugin entry from docusaurus.config.js and build the site again. The widget is gone.
Privacidad
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. Política de privacidad.
Planes y precios
El plugin es gratuito, y el widget funciona con todos los planes de Asyntai, incluido el gratuito. Cada plan incluye un número mensual de mensajes, compartido entre el widget de tu sitio web y todas tus integraciones. Los planes de pago aumentan ese número. Ver precios.
¿Necesita ayuda?
Si tiene alguna pregunta o encuentras problemas, contáctanos en [email protected].