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