Docusaurus Integration
Add the Asyntai chat assistant to your Docusaurus documentation site with one plugin
Prezentare 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.
Cum funcționează
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.
Cerințe
- Un cont Asyntai. Crearea este gratuită, iar planul gratuit este suficient pentru a testa widgetul.
- A Docusaurus site, version 2 or 3
- Node.js 18 or newer, which Docusaurus already needs
Instalare
Follow these steps to add Asyntai to your Docusaurus site:
Instalează pluginul
Run this command in the folder that holds your Docusaurus site.
npm install docusaurus-plugin-asyntai
Copiază identificatorul de widget
Deschide pagina Instalare din panoul Asyntai. Identificatorul de widget este valoarea data-asyntai-id din codul afișat acolo.
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
Sfat: Adaugă documentele tale, întrebările și răspunsurile tale și instrucțiunile tale în panoul Asyntai înainte de publicare, ca asistentul să răspundă corect chiar de la primul vizitator.
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țiuni
- 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.
Cum îl elimini
Delete the plugin entry from docusaurus.config.js and build the site again. The widget is gone.
Confidențialitate
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. Politica de confidențialitate.
Planuri și prețuri
Pluginul este gratuit, iar widgetul funcționează cu orice plan Asyntai, inclusiv cel gratuit. Fiecare plan include un număr lunar de mesaje, împărțit între widgetul de pe site și toate integrările tale. Planurile plătite măresc acel număr. Vezi prețurile.
Ai nevoie de ajutor?
Dacă ai întrebări sau întâmpini probleme, contactează-ne la [email protected].