docsify Plugin

Add the Asyntai AI chat assistant to your docsify documentation site

Overview

docsify turns Markdown files into a documentation site in the browser, with no build step. The Asyntai plugin is one script tag. Add it after docsify, and the chat bubble is on every page of your docs.

The assistant answers your readers from your own documentation, in more than 80 languages, day and night.

Requirements

docsify 4 or 5
An Asyntai account. The Free plan is enough to try the widget

Installation

Follow these steps to add Asyntai to your docsify site:

Get Your Widget ID

Sign in to Asyntai and open the Install page. The widget ID is the value of data-asyntai-id in the snippet shown there. It starts with asyntai_.

Add the Widget ID to Your Config

Open the index.html of your docs and add asyntai to window.$docsify:

<script>
  window.$docsify = {
    name: 'My docs',
    asyntai: { widgetId: 'asyntai_1a2b3c4d5e6f' },
  };
</script>

Add the Plugin Script

Add the plugin script after the docsify script:

<script src="//cdn.jsdelivr.net/npm/docsify@4"></script>
<script src="//cdn.jsdelivr.net/npm/docsify-ai-chatbot@1"></script>

On docsify 5 it is the same line after the docsify 5 script:

<script src="//cdn.jsdelivr.net/npm/docsify@5/dist/docsify.min.js"></script>
<script src="//cdn.jsdelivr.net/npm/docsify-ai-chatbot@1"></script>

Publish

Publish your docs as usual. Open your site and the chat bubble is in the corner of every page.

Options

Option	Type	Default	What it does
`widgetId`	string	required	Your Asyntai widget ID
`scriptUrl`	string	the Asyntai CDN	Advanced. Load the widget from another URL

The short form asyntai: 'asyntai_1a2b3c4d5e6f' works too. A missing or malformed widget ID never breaks your docs: the site renders as usual, and the browser console says how to fix the setting.

How It Works

The plugin loads the Asyntai widget once, after docsify shows the first page. It waits for the page's load event, so your docs always render first.

docsify changes pages without a reload, so the chat stays open with its conversation while the reader moves through your docs.

Answering From Your Docs

Asyntai reads your published pages. Add your docs URL in the dashboard, and the assistant answers from the same pages the widget sits on. You can also add documents, and question and answer pairs.

Tip: Already use a window.$docsify function config? The plugin works with it too. Return asyntai in the object your function returns.

Removing It

Delete the plugin <script> line. The chat bubble is gone.

Plans & Pricing

The plugin is free. View pricing.

Need Help?

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

Documentation