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, включая бесплатный. Каждый тариф включает месячное количество сообщений, общее для виджета на сайте и всех интеграций. Платные тарифы увеличивают это количество. Посмотреть цены.
Нужна помощь?
Если у вас есть вопросы или возникли проблемы, свяжитесь с нами по адресу [email protected].