Docusaurus Integration
Add the Asyntai chat assistant to your Docusaurus documentation site with one plugin
Prehľad
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.
Ako to funguje
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.
Požiadavky
- Účet Asyntai. Založenie je zadarmo a bezplatný program stačí na vyskúšanie widgetu.
- A Docusaurus site, version 2 or 3
- Node.js 18 or newer, which Docusaurus already needs
Inštalácia
Follow these steps to add Asyntai to your Docusaurus site:
Nainštalujte plugin
Run this command in the folder that holds your Docusaurus site.
npm install docusaurus-plugin-asyntai
Skopírujte ID widgetu
Otvorte stránku Inštalácia vo svojom prehľade Asyntai. ID widgetu je hodnota data-asyntai-id v tam zobrazenom kóde.
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
Tip: Pred publikovaním pridajte svoje dokumenty, otázky a odpovede a pokyny v prehľade Asyntai, aby asistent správne odpovedal už prvému návštevníkovi.
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.
Možnosti
- 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.
Ako ho odstrániť
Delete the plugin entry from docusaurus.config.js and build the site again. The widget is gone.
Ochrana osobných údajov
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. Zásady ochrany osobných údajov.
Tarify a ceny
Plugin je zadarmo a widget funguje vo všetkých programoch Asyntai, aj v bezplatnom. Každý program obsahuje mesačný počet správ, ktorý zdieľa widget na webe a všetky vaše integrácie. Platené programy tento počet zvyšujú. Zobraziť ceny.
Potrebujete pomoc?
Ak máte akékoľvek otázky alebo narazíte na problémy, kontaktujte nás na [email protected].