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] पर संपर्क करें।