Docusaurus Integration
Add the Asyntai chat assistant to your Docusaurus documentation site with one plugin
Visão Geral
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.
Como 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
- Uma conta Asyntai. Criar uma é gratuito, e o plano gratuito chega para testar o widget.
- A Docusaurus site, version 2 or 3
- Node.js 18 or newer, which Docusaurus already needs
Instalação
Follow these steps to add Asyntai to your Docusaurus site:
Instale o plugin
Run this command in the folder that holds your Docusaurus site.
npm install docusaurus-plugin-asyntai
Copie o seu ID de widget
Abra a página Instalação no seu painel Asyntai. O seu ID de widget é o valor de data-asyntai-id no código aí mostrado.
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
Dica: Acrescente os seus documentos, as suas perguntas e respostas e as suas instruções no painel Asyntai antes de publicar, para que o assistente responda bem logo ao primeiro 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.
Opções
- 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.
Como remover
Delete the plugin entry from docusaurus.config.js and build the site again. The widget is gone.
Privacidade
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 privacidade.
Planos e preços
O plugin é gratuito, e o widget funciona com todos os planos Asyntai, incluindo o gratuito. Cada plano inclui um número mensal de mensagens, partilhado entre o widget do seu site e todas as suas integrações. Os planos pagos aumentam esse número. Ver preços.
Precisa de Ajuda?
Se você tiver alguma dúvida ou encontrar problemas, entre em contato conosco em [email protected].