Docusaurus Integration
Add the Asyntai chat assistant to your Docusaurus documentation site with one plugin
Oversigt
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.
Sådan fungerer det
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.
Krav
- En Asyntai-konto. Det er gratis at oprette en, og gratisplanen er nok til at teste widgetten.
- A Docusaurus site, version 2 or 3
- Node.js 18 or newer, which Docusaurus already needs
Installation
Follow these steps to add Asyntai to your Docusaurus site:
Installer udvidelsen
Run this command in the folder that holds your Docusaurus site.
npm install docusaurus-plugin-asyntai
Kopier dit widget-ID
Åbn siden Installation i dit Asyntai-kontrolpanel. Dit widget-ID er værdien af data-asyntai-id i det stykke kode, der vises der.
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
Tip: Tilføj dine dokumenter, dine spørgsmål og svar og dine instruktioner i Asyntai-kontrolpanelet, før du udgiver, så assistenten svarer rigtigt allerede over for den første besøgende.
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.
Valgmuligheder
- 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.
Sådan fjerner du det
Delete the plugin entry from docusaurus.config.js and build the site again. The widget is gone.
Privatliv
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. Privatlivspolitik.
Abonnementer og priser
Udvidelsen er gratis, og widgetten virker med alle Asyntai-planer, også gratisplanen. Hver plan indeholder et månedligt antal beskeder, delt mellem widgetten på dit websted og alle dine integrationer. Betalte planer hæver det antal. Se priser.
Brug for hjælp?
Hvis du har spørgsmål eller støder på problemer, kan du kontakte os på [email protected].