Docusaurus Integration
Add the Asyntai chat assistant to your Docusaurus documentation site with one plugin
Apžvalga
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.
Kaip tai veikia
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.
Reikalavimai
- Asyntai paskyra. Ją susikurti nemokama, o nemokamo plano pakanka langeliui išbandyti.
- A Docusaurus site, version 2 or 3
- Node.js 18 or newer, which Docusaurus already needs
Įdiegimas
Follow these steps to add Asyntai to your Docusaurus site:
Įdiekite papildinį
Run this command in the folder that holds your Docusaurus site.
npm install docusaurus-plugin-asyntai
Nusikopijuokite langelio identifikatorių
Atidarykite puslapį Diegimas savo Asyntai skydelyje. Langelio identifikatorius yra data-asyntai-id reikšmė ten rodomame kode.
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
Patarimas: Prieš paskelbdami pridėkite savo dokumentus, klausimus ir atsakymus bei nurodymus Asyntai skydelyje, kad padėjėjas teisingai atsakytų jau pirmam lankytojui.
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.
Parinktys
- 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.
Kaip jį pašalinti
Delete the plugin entry from docusaurus.config.js and build the site again. The widget is gone.
Privatumas
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. Privatumo politika.
Planai ir kainos
Papildinys nemokamas, o langelis veikia su kiekvienu Asyntai planu, įskaitant nemokamą. Kiekvienas planas apima mėnesinį žinučių kiekį, bendrą svetainės langeliui ir visoms integracijoms. Mokami planai tą kiekį padidina. Peržiūrėti kainas.
Reikia pagalbos?
Jei turite klausimų arba kilo problemų, susisiekite su mumis adresu [email protected].