Torna alla Dashboard

Documentazione

Scopri come usare Asyntai

Integrazione con Docusaurus

Aggiungi l'assistente di chat Asyntai al tuo sito di documentazione Docusaurus con un solo plugin

Crea account

Panoramica

Docusaurus trasforma i tuoi file Markdown in un sito di documentazione. Il plugin Asyntai aggiunge l'assistente di chat a ogni pagina che genera, così chi legge può fare una domanda invece di cercare. Aggiungi una riga al file di configurazione e nient'altro.

Come funziona

Il plugin aggiunge un tag script dopo il corpo di ogni pagina generata. Il tag è marcato async, così la tua documentazione appare per prima e il widget si carica dopo. Nient'altro cambia nel tuo sito.

Requisiti

  • Un account Asyntai. Crearlo è gratuito, e il piano gratuito basta per provare il widget.
  • Un sito Docusaurus, versione 2 o 3
  • Node.js 18 o più recente, che Docusaurus richiede già

Installazione

Segui questi passaggi per aggiungere Asyntai al tuo sito Docusaurus:

1

Installa il plugin

Esegui questo comando nella cartella che contiene il tuo sito Docusaurus.

npm install docusaurus-plugin-asyntai
2

Copia il tuo ID widget

Apri la pagina Installazione nella tua dashboard Asyntai. Il tuo ID widget è il valore di data-asyntai-id nel codice mostrato lì.

data-asyntai-id="asyntai_xxxxxxxxxxxx"
3

Aggiungilo alla configurazione

Apri docusaurus.config.js e aggiungi il plugin con il tuo ID widget.

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

Compila il sito

Esegui il tuo solito comando di build e pubblica il sito. La bolla di chat è su ogni pagina.

npm run build

Suggerimento: Aggiungi i tuoi documenti, le tue domande e risposte e le tue istruzioni nella dashboard Asyntai prima di pubblicare, così l'assistente risponde bene già al primo visitatore.

Risposte dalla tua documentazione

Asyntai legge le tue pagine pubblicate. Aggiungi l'indirizzo del tuo sito nella dashboard, e l'assistente risponde dalla stessa documentazione su cui si trova il widget. Puoi aggiungere anche altri documenti e coppie di domande e risposte.

Opzioni

  • widgetId indica quale account Asyntai risponde. È obbligatorio, e un valore errato ferma la build con un messaggio chiaro.
  • enableInDevelopment impostato su false tiene il widget fuori dal sito mentre usi il server di sviluppo locale.
  • scriptUrl carica il widget da un altro indirizzo. La maggior parte dei siti non ne ha mai bisogno.

Come rimuoverlo

Elimina la voce del plugin da docusaurus.config.js e compila di nuovo il sito. Il widget sparisce.

Privacy

Il plugin non invia dati da solo. Asyntai riceve dati solo quando un visitatore apre la chat e scrive un messaggio, esattamente come con uno snippet incollato a mano. Informativa sulla privacy.

Piani e prezzi

Il plugin è gratuito e il widget funziona con ogni piano Asyntai, compreso quello gratuito. Ogni piano include un numero mensile di messaggi, condiviso tra il widget del sito e tutte le tue integrazioni. I piani a pagamento aumentano quel numero. Visualizza i prezzi.

Hai bisogno di aiuto?

If you have any questions or run into issues, contact us at [email protected].