Docusaurus Integration
Add the Asyntai chat assistant to your Docusaurus documentation site with one plugin
Genel Bakış
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.
Nasıl Çalışır
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.
Gereksinimler
- Bir Asyntai hesabı. Hesap açmak ücretsizdir ve ücretsiz plan pencereyi denemeye yeter.
- A Docusaurus site, version 2 or 3
- Node.js 18 or newer, which Docusaurus already needs
Kurulum
Follow these steps to add Asyntai to your Docusaurus site:
Eklentiyi kurun
Run this command in the folder that holds your Docusaurus site.
npm install docusaurus-plugin-asyntai
Pencere kimliğinizi kopyalayın
Asyntai panonuzdaki Kurulum sayfasını açın. Pencere kimliğiniz, orada gösterilen kod parçasındaki data-asyntai-id değeridir.
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
İpucu: Yayınlamadan önce belgelerinizi, soru ve yanıtlarınızı ve yönergelerinizi Asyntai panosuna ekleyin, böylece asistan daha ilk ziyaretçiye doğru yanıt verir.
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.
Seçenekler
- 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.
Nasıl kaldırılır
Delete the plugin entry from docusaurus.config.js and build the site again. The widget is gone.
Gizlilik
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. Gizlilik politikası.
Planlar ve fiyatlar
Eklenti ücretsizdir ve pencere ücretsiz plan dâhil her Asyntai planında çalışır. Her plan aylık bir mesaj sayısı içerir; bu sayı site penceresi ile tüm entegrasyonlarınız arasında paylaşılır. Ücretli planlar bu sayıyı artırır. Fiyatlandırmayı görün.
Yardıma mı İhtiyacınız Var?
Herhangi bir sorunuz varsa veya sorunla karşılaşırsanız, [email protected] adresinden bizimle iletişime geçin.