Docusaurus Integration
Add the Asyntai chat assistant to your Docusaurus documentation site with one plugin
Pārskats
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.
Kā tas darbojas
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.
Prasības
- Asyntai konts. Tā izveide ir bez maksas, un bezmaksas plāns ir pietiekams, lai izmēģinātu logu.
- A Docusaurus site, version 2 or 3
- Node.js 18 or newer, which Docusaurus already needs
Instalēšana
Follow these steps to add Asyntai to your Docusaurus site:
Uzstādiet spraudni
Run this command in the folder that holds your Docusaurus site.
npm install docusaurus-plugin-asyntai
Nokopējiet loga identifikatoru
Atveriet lapu Uzstādīšana savā Asyntai vadības panelī. Loga identifikators ir data-asyntai-id vērtība tur redzamajā kodā.
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
Padoms: Pirms publicēšanas pievienojiet savus dokumentus, jautājumus un atbildes un norādījumus Asyntai vadības panelī, lai palīgs pareizi atbildētu jau pirmajam apmeklētājam.
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.
Opcijas
- 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.
Kā to noņemt
Delete the plugin entry from docusaurus.config.js and build the site again. The widget is gone.
Privātums
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. Privātuma politika.
Plāni un cenas
Spraudnis ir bez maksas, un logs darbojas ar katru Asyntai plānu, arī bezmaksas. Katrs plāns ietver mēneša ziņu skaitu, kas kopīgs jūsu vietnes logam un visām integrācijām. Maksas plāni šo skaitu palielina. Skatīt cenas.
Nepieciešama palīdzība?
Ja jums ir jautājumi vai rodas problēmas, sazinieties ar mums [email protected].