Docusaurus Integration
Add the Asyntai chat assistant to your Docusaurus documentation site with one plugin
Přehled
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.
Jak to funguje
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.
Požadavky
- Účet Asyntai. Založení je zdarma a bezplatný tarif stačí na vyzkoušení widgetu.
- A Docusaurus site, version 2 or 3
- Node.js 18 or newer, which Docusaurus already needs
Instalace
Follow these steps to add Asyntai to your Docusaurus site:
Nainstalujte plugin
Run this command in the folder that holds your Docusaurus site.
npm install docusaurus-plugin-asyntai
Zkopírujte ID widgetu
Otevřete stránku Instalace ve svém přehledu Asyntai. ID widgetu je hodnota data-asyntai-id v tam zobrazeném kódu.
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: Před publikováním přidejte své dokumenty, otázky a odpovědi a pokyny v přehledu Asyntai, aby asistent správně odpověděl už prvnímu návštěvníkovi.
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.
Možnosti
- 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.
Jak jej odebrat
Delete the plugin entry from docusaurus.config.js and build the site again. The widget is gone.
Ochrana osobních údajů
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. Zásady ochrany osobních údajů.
Tarify a ceny
Plugin je zdarma a widget funguje ve všech tarifech Asyntai, i v bezplatném. Každý tarif obsahuje měsíční počet zpráv, který sdílí widget na webu a všechny vaše integrace. Placené tarify tento počet zvyšují. Zobrazit ceník.
Potřebujete pomoc?
Máte-li jakékoli dotazy nebo narazíte na problémy, kontaktujte nás na [email protected].