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
위젯 ID 복사하기
Asyntai 대시보드에서 설치 페이지를 엽니다. 위젯 ID는 거기 보이는 코드의 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]으로 문의하세요.