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