Docusaurus Integration
Add the Asyntai chat assistant to your Docusaurus documentation site with one plugin
Gambaran Keseluruhan
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 Ia Berfungsi
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.
Keperluan
- Satu akaun Asyntai. Membukanya percuma, dan pelan percuma sudah memadai untuk mencuba widget.
- A Docusaurus site, version 2 or 3
- Node.js 18 or newer, which Docusaurus already needs
Pemasangan
Follow these steps to add Asyntai to your Docusaurus site:
Pasang pemalam
Run this command in the folder that holds your Docusaurus site.
npm install docusaurus-plugin-asyntai
Salin ID widget anda
Buka halaman Pemasangan dalam papan pemuka Asyntai anda. ID widget ialah nilai data-asyntai-id dalam cebisan kod yang ditunjukkan di situ.
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
Petua: Sebelum menerbitkan, tambah dokumen anda, soal jawab anda dan arahan anda dalam papan pemuka Asyntai, supaya pembantu menjawab dengan betul sejak pelawat 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.
Pilihan
- 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 membuangnya
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. Dasar privasi.
Pelan dan harga
Pemalam ini percuma, dan widget berfungsi dengan setiap pelan Asyntai, termasuk pelan percuma. Setiap pelan merangkumi bilangan mesej bulanan, dikongsi antara widget laman anda dan semua penyepaduan anda. Pelan berbayar menaikkan bilangan itu. Lihat harga.
Perlukan Bantuan?
Jika anda mempunyai sebarang soalan atau menghadapi masalah, hubungi kami di [email protected].