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. Η δημιουργία είναι δωρεάν, και το δωρεάν πρόγραμμα αρκεί για να δοκιμάσετε το widget.
- 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
Αντιγράψτε το αναγνωριστικό widget
Ανοίξτε τη σελίδα Εγκατάσταση στον πίνακα της Asyntai. Το αναγνωριστικό widget είναι η τιμή του 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. Πολιτική απορρήτου.
Προγράμματα και τιμές
Το πρόσθετο είναι δωρεάν, και το widget λειτουργεί με κάθε πρόγραμμα Asyntai, ακόμη και το δωρεάν. Κάθε πρόγραμμα περιλαμβάνει έναν μηνιαίο αριθμό μηνυμάτων, κοινό για το widget του ιστότοπου και όλες τις ενσωματώσεις σας. Τα επί πληρωμή προγράμματα αυξάνουν αυτόν τον αριθμό. Προβολή τιμών.
Χρειάζεστε Βοήθεια;
Αν έχετε οποιεσδήποτε ερωτήσεις ή αντιμετωπίσετε προβλήματα, επικοινωνήστε μαζί μας στο [email protected].