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