Integração com o Docusaurus
Adicione o assistente de chat da Asyntai ao seu site de documentação Docusaurus com um plugin
Visão Geral
O Docusaurus transforma seus arquivos Markdown em um site de documentação. O plugin da Asyntai adiciona o assistente de chat a cada página gerada, para que quem lê possa perguntar em vez de procurar. Você adiciona uma linha ao arquivo de configuração e nada mais.
Como funciona
O plugin adiciona uma tag script depois do corpo de cada página gerada. A tag é marcada como async, então a sua documentação aparece primeiro e o widget carrega depois. Nada mais muda no seu site.
Requisitos
- Uma conta Asyntai. Criar uma é gratuito, e o plano gratuito chega para testar o widget.
- Um site Docusaurus, versão 2 ou 3
- Node.js 18 ou mais novo, que o Docusaurus já exige
Instalação
Siga estes passos para adicionar a Asyntai ao seu site Docusaurus:
Instale o plugin
Execute este comando na pasta que contém o seu site Docusaurus.
npm install docusaurus-plugin-asyntai
Copie o seu ID de widget
Abra a página Instalação no seu painel Asyntai. O seu ID de widget é o valor de data-asyntai-id no código aí mostrado.
data-asyntai-id="asyntai_xxxxxxxxxxxx"
Adicione à sua configuração
Abra o docusaurus.config.js e adicione o plugin com o seu ID de widget.
plugins: [
['docusaurus-plugin-asyntai', {widgetId: 'asyntai_xxxxxxxxxxxx'}],
],
Gere o seu site
Execute o seu comando de build de sempre e publique o site. A bolha de chat está em todas as páginas.
npm run build
Dica: Acrescente os seus documentos, as suas perguntas e respostas e as suas instruções no painel Asyntai antes de publicar, para que o assistente responda bem logo ao primeiro visitante.
Respostas a partir da sua documentação
A Asyntai lê as suas páginas publicadas. Adicione o endereço do seu site no painel, e o assistente responde a partir da mesma documentação em que o widget está. Você também pode adicionar outros documentos e perguntas e respostas.
Opções
- widgetId define qual conta da Asyntai responde. Ele é obrigatório, e um valor errado interrompe o build com uma mensagem clara.
- enableInDevelopment com valor false mantém o widget fora do site enquanto você usa o servidor de desenvolvimento local.
- scriptUrl carrega o widget de outro endereço. A maioria dos sites nunca precisa disso.
Como remover
Exclua a entrada do plugin no docusaurus.config.js e gere o site de novo. O widget some.
Privacidade
O plugin não envia dado nenhum por conta própria. A Asyntai recebe dados apenas quando um visitante abre o chat e escreve uma mensagem, exatamente como com um trecho de código colado à mão. Política de privacidade.
Planos e preços
O plugin é gratuito, e o widget funciona com todos os planos Asyntai, incluindo o gratuito. Cada plano inclui um número mensal de mensagens, partilhado entre o widget do seu site e todas as suas integrações. Os planos pagos aumentam esse número. Ver preços.
Precisa de Ajuda?
If you have any questions or run into issues, contact us at [email protected].