Takaisin hallintapaneeliin

Dokumentaatio

Opi käyttämään Asyntai

Docusaurus Integration

Add the Asyntai chat assistant to your Docusaurus documentation site with one plugin

Luo tili

Yleiskatsaus

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.

Miten se toimii

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.

Vaatimukset

  • Asyntai-tili. Sen luominen on maksutonta, ja maksuton taso riittää widgetin kokeiluun.
  • A Docusaurus site, version 2 or 3
  • Node.js 18 or newer, which Docusaurus already needs

Asennus

Follow these steps to add Asyntai to your Docusaurus site:

1

Asenna lisäosa

Run this command in the folder that holds your Docusaurus site.

npm install docusaurus-plugin-asyntai
2

Kopioi widget-tunnuksesi

Avaa Asennus-sivu Asyntain hallintanäkymässä. Widget-tunnuksesi on siellä näkyvän koodinpätkän data-asyntai-id-arvo.

data-asyntai-id="asyntai_xxxxxxxxxxxx"
3

Add It to Your Configuration

Open docusaurus.config.js and add the plugin with your widget ID.

plugins: [
  ['docusaurus-plugin-asyntai', {widgetId: 'asyntai_xxxxxxxxxxxx'}],
],
4

Build Your Site

Run your usual build command and publish the site. The chat bubble is on every page.

npm run build

Vinkki: Lisää asiakirjasi, kysymyksesi ja vastauksesi sekä ohjeesi Asyntain hallintanäkymässä ennen julkaisua, jotta avustaja vastaa oikein heti ensimmäiselle kävijälle.

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.

Valinnat

  • 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.

Poistaminen

Delete the plugin entry from docusaurus.config.js and build the site again. The widget is gone.

Tietosuoja

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. Tietosuojakäytäntö.

Tilaukset ja hinnat

Lisäosa on maksuton, ja widget toimii kaikilla Asyntain tasoilla, myös maksuttomalla. Jokainen taso sisältää kuukausittaisen viestimäärän, joka on yhteinen sivustosi widgetille ja kaikille integraatioillesi. Maksulliset tasot nostavat tuota määrää. Näytä hinnoittelu.

Tarvitsetko apua?

Jos sinulla on kysyttävää tai kohtaat ongelmia, ota meihin yhteyttä osoitteessa [email protected].