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].