Docusaurus Integration
Add the Asyntai chat assistant to your Docusaurus documentation site with one plugin
Ringkasan
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.
Cara Kerjanya
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.
Persyaratan
- Sebuah akun Asyntai. Membuatnya gratis, dan paket gratis sudah cukup untuk mencoba widget.
- A Docusaurus site, version 2 or 3
- Node.js 18 or newer, which Docusaurus already needs
Instalasi
Follow these steps to add Asyntai to your Docusaurus site:
Pasang plugin
Run this command in the folder that holds your Docusaurus site.
npm install docusaurus-plugin-asyntai
Salin ID widget Anda
Buka halaman Pemasangan di dasbor Asyntai Anda. ID widget adalah nilai data-asyntai-id pada potongan kode yang ditampilkan di sana.
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: Sebelum menerbitkan, tambahkan dokumen, tanya jawab, dan instruksi Anda di dasbor Asyntai, agar asisten menjawab dengan benar sejak pengunjung pertama.
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.
Opsi
- 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.
Cara menghapusnya
Delete the plugin entry from docusaurus.config.js and build the site again. The widget is gone.
Privasi
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. Kebijakan privasi.
Paket dan harga
Plugin ini gratis, dan widget bekerja pada semua paket Asyntai, termasuk paket gratis. Setiap paket mencakup jumlah pesan bulanan, yang dipakai bersama oleh widget situs dan semua integrasi Anda. Paket berbayar menaikkan jumlah itu. Lihat harga.
Butuh Bantuan?
Jika Anda memiliki pertanyaan atau mengalami masalah, hubungi kami di [email protected].