Docusaurus Integration
Add the Asyntai chat assistant to your Docusaurus documentation site with one plugin
Panoramica
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.
Come funziona
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.
Requisiti
- Un account Asyntai. Crearlo è gratuito, e il piano gratuito basta per provare il widget.
- A Docusaurus site, version 2 or 3
- Node.js 18 or newer, which Docusaurus already needs
Installazione
Follow these steps to add Asyntai to your Docusaurus site:
Installa il plugin
Run this command in the folder that holds your Docusaurus site.
npm install docusaurus-plugin-asyntai
Copia il tuo ID widget
Apri la pagina Installazione nella tua dashboard Asyntai. Il tuo ID widget è il valore di data-asyntai-id nel codice mostrato lì.
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
Suggerimento: Aggiungi i tuoi documenti, le tue domande e risposte e le tue istruzioni nella dashboard Asyntai prima di pubblicare, così l'assistente risponde bene già al primo visitatore.
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.
Opzioni
- 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.
Come rimuoverlo
Delete the plugin entry from docusaurus.config.js and build the site again. The widget is gone.
Privacy
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. Informativa sulla privacy.
Piani e prezzi
Il plugin è gratuito e il widget funziona con ogni piano Asyntai, compreso quello gratuito. Ogni piano include un numero mensile di messaggi, condiviso tra il widget del sito e tutte le tue integrazioni. I piani a pagamento aumentano quel numero. Visualizza i prezzi.
Hai bisogno di aiuto?
Se hai domande o riscontri problemi, contattaci a [email protected].