Docusaurus Integration
Add the Asyntai chat assistant to your Docusaurus documentation site with one plugin
Pregled
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.
Kako funkcionira
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.
Zahtjevi
- Asyntai račun. Otvaranje je besplatno, a besplatni plan dovoljan je za isprobavanje widgeta.
- A Docusaurus site, version 2 or 3
- Node.js 18 or newer, which Docusaurus already needs
Instalacija
Follow these steps to add Asyntai to your Docusaurus site:
Instalirajte dodatak
Run this command in the folder that holds your Docusaurus site.
npm install docusaurus-plugin-asyntai
Kopirajte identifikator widgeta
Otvorite stranicu Instalacija u svojoj Asyntai nadzornoj ploči. Identifikator widgeta je vrijednost data-asyntai-id u tamo prikazanom kodu.
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
Savjet: Dodajte svoje dokumente, svoja pitanja i odgovore i svoje upute u Asyntai nadzornoj ploči prije objave, kako bi pomoćnik točno odgovorio već prvom posjetitelju.
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.
Opcije
- 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.
Kako ga ukloniti
Delete the plugin entry from docusaurus.config.js and build the site again. The widget is gone.
Privatnost
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. Pravila privatnosti.
Planovi i cijene
Dodatak je besplatan, a widget radi sa svakim Asyntai planom, uključujući besplatni. Svaki plan uključuje mjesečni broj poruka, zajednički za widget na stranici i sve vaše integracije. Plaćeni planovi povećavaju taj broj. Pogledajte cijene.
Trebate pomoć?
Ako imate pitanja ili naiđete na probleme, kontaktirajte nas na [email protected].