Docusaurus Integration
Add the Asyntai chat assistant to your Docusaurus documentation site with one plugin
Przegląd
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.
Jak to działa
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.
Wymagania
- Konto Asyntai. Założenie jest bezpłatne, a plan darmowy wystarczy, aby przetestować widget.
- A Docusaurus site, version 2 or 3
- Node.js 18 or newer, which Docusaurus already needs
Instalacja
Follow these steps to add Asyntai to your Docusaurus site:
Zainstaluj wtyczkę
Run this command in the folder that holds your Docusaurus site.
npm install docusaurus-plugin-asyntai
Skopiuj identyfikator widgetu
Otwórz stronę Instalacja w panelu Asyntai. Twój identyfikator widgetu to wartość data-asyntai-id w pokazanym tam fragmencie kodu.
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
Wskazówka: Dodaj swoje dokumenty, pytania i odpowiedzi oraz instrukcje w panelu Asyntai przed publikacją, aby asystent dobrze odpowiedział już pierwszemu odwiedzającemu.
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.
Opcje
- 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.
Jak go usunąć
Delete the plugin entry from docusaurus.config.js and build the site again. The widget is gone.
Prywatność
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. Polityka prywatności.
Plany i ceny
Wtyczka jest bezpłatna, a widget działa w każdym planie Asyntai, także darmowym. Każdy plan zawiera miesięczną liczbę wiadomości, wspólną dla widgetu na stronie i wszystkich integracji. Plany płatne zwiększają tę liczbę. Zobacz cennik.
Potrzebujesz pomocy?
Jeśli masz pytania lub napotkasz problemy, skontaktuj się z nami pod adresem [email protected].