Integración con Docusaurus
Añade el asistente de chat de Asyntai a tu sitio de documentación Docusaurus con un solo complemento
Descripción general
Docusaurus convierte tus archivos Markdown en un sitio de documentación. El complemento de Asyntai añade el asistente de chat a cada página que genera, para que quien lee pueda preguntar en lugar de buscar. Añades una línea a tu archivo de configuración y nada más.
Cómo funciona
El complemento añade una etiqueta script después del cuerpo de cada página generada. La etiqueta lleva async, así tu documentación se muestra primero y el widget se carga después. Nada más cambia en tu sitio.
Requisitos
- Una cuenta de Asyntai. Crearla es gratis, y el plan gratuito basta para probar el widget.
- Un sitio Docusaurus, versión 2 o 3
- Node.js 18 o más reciente, que Docusaurus ya necesita
Instalación
Sigue estos pasos para añadir Asyntai a tu sitio Docusaurus:
Instala el plugin
Ejecuta este comando en la carpeta que contiene tu sitio Docusaurus.
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"
Añádelo a tu configuración
Abre docusaurus.config.js y añade el complemento con tu ID de widget.
plugins: [
['docusaurus-plugin-asyntai', {widgetId: 'asyntai_xxxxxxxxxxxx'}],
],
Compila tu sitio
Ejecuta tu comando de compilación habitual y publica el sitio. La burbuja de chat está en cada página.
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.
Responder desde tu documentación
Asyntai lee tus páginas publicadas. Añade la dirección de tu sitio en el panel, y el asistente responde desde la misma documentación en la que está el widget. También puedes añadir más documentos y preguntas y respuestas.
Opciones
- widgetId indica qué cuenta de Asyntai responde. Es obligatorio, y un valor incorrecto detiene la compilación con un mensaje claro.
- enableInDevelopment en false mantiene el widget fuera del sitio mientras usas el servidor de desarrollo local.
- scriptUrl carga el widget desde otra dirección. La mayoría de los sitios nunca lo necesitan.
Cómo quitarlo
Elimina la entrada del complemento en docusaurus.config.js y compila el sitio de nuevo. El widget desaparece.
Privacidad
El complemento no envía ningún dato por sí mismo. Asyntai recibe datos solo cuando un visitante abre el chat y escribe un mensaje, igual que con un fragmento de código pegado a mano. 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?
If you have any questions or run into issues, contact us at [email protected].