Docusaurus Integration
Add the Asyntai chat assistant to your Docusaurus documentation site with one plugin
Ülevaade
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.
Kuidas see töötab
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.
Nõuded
- Asyntai konto. Selle loomine on tasuta ja tasuta pakett on akna proovimiseks piisav.
- A Docusaurus site, version 2 or 3
- Node.js 18 or newer, which Docusaurus already needs
Paigaldamine
Follow these steps to add Asyntai to your Docusaurus site:
Paigaldage lisandmoodul
Run this command in the folder that holds your Docusaurus site.
npm install docusaurus-plugin-asyntai
Kopeerige akna tunnus
Avage oma Asyntai töölaual leht Paigaldus. Akna tunnus on seal näidatud koodijupi data-asyntai-id väärtus.
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
Vihje: Lisage enne avaldamist oma dokumendid, küsimused ja vastused ning juhised Asyntai töölaual, et abiline vastaks õigesti juba esimesele külastajale.
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.
Valikud
- 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.
Kuidas see eemaldada
Delete the plugin entry from docusaurus.config.js and build the site again. The widget is gone.
Privaatsus
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. Privaatsuspoliitika.
Paketid ja hinnad
Lisandmoodul on tasuta ja aken töötab iga Asyntai paketiga, ka tasuta paketiga. Iga pakett sisaldab kuu sõnumite arvu, mis on jagatud teie saidi akna ja kõigi integratsioonide vahel. Tasulised paketid tõstavad seda arvu. Vaata hindu.
Vajate abi?
Kui teil on küsimusi või tekib probleeme, võtke meiega ühendust aadressil [email protected].