Docusaurus Integration
Add the Asyntai chat assistant to your Docusaurus documentation site with one plugin
Огляд
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.
Як це працює
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.
Вимоги
- Обліковий запис Asyntai. Створити його можна безкоштовно, і безкоштовного тарифу достатньо, щоб перевірити віджет.
- A Docusaurus site, version 2 or 3
- Node.js 18 or newer, which Docusaurus already needs
Встановлення
Follow these steps to add Asyntai to your Docusaurus site:
Встановіть плагін
Run this command in the folder that holds your Docusaurus site.
npm install docusaurus-plugin-asyntai
Скопіюйте ідентифікатор віджета
Відкрийте сторінку Встановлення у панелі Asyntai. Ідентифікатор віджета — це значення data-asyntai-id у показаному там коді.
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
Порада: Додайте свої документи, запитання й відповіді та вказівки в панелі Asyntai до публікації, щоб помічник правильно відповів уже першому відвідувачу.
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.
Параметри
- 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.
Як його прибрати
Delete the plugin entry from docusaurus.config.js and build the site again. The widget is gone.
Конфіденційність
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. Політика конфіденційності.
Тарифи та ціни
Плагін безкоштовний, а віджет працює на будь-якому тарифі Asyntai, зокрема безкоштовному. Кожен тариф містить місячну кількість повідомлень, спільну для віджета на сайті та всіх інтеграцій. Платні тарифи збільшують цю кількість. Переглянути ціни.
Потрібна допомога?
Якщо у вас є запитання або виникли проблеми, зв'яжiться з нами за адресою [email protected].