mkdocs-ai-chatbot

Add the Asyntai AI chat assistant to your MkDocs site. It answers visitor questions from your own documentation, day and night.

Works with every MkDocs theme, including Material for MkDocs and Read the Docs.

Install

pip install mkdocs-ai-chatbot

Then add the plugin in mkdocs.yml:

plugins:
  - search
  - asyntai:
      widget_id: asyntai_1a2b3c4d5e6f

Build the site. The chat bubble is on every page.

Keep search in the list if you use it. When mkdocs.yml has a plugins section, MkDocs only loads the plugins named there.

Where the widget ID comes from

Open the Install page in your Asyntai dashboard. The widget ID is the value of data-asyntai-id in the snippet shown there. It starts with asyntai_.

Creating an account is free, and the Free plan is enough to try the widget.

Options

A missing or malformed widget_id stops the build with a message that says how to fix it.

What the plugin does

• It adds one <script> tag in front of the closing body tag of every page.
• It marks the tag async, so your documentation renders first.
• It changes nothing else. No theme files are overridden and no CSS is added.
• If a page already has the Asyntai snippet, for example from a theme override, the plugin leaves that page alone.

Answering from your documentation

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

Removing it

Delete the asyntai entry from mkdocs.yml and build again. The widget is gone.

Support

Email hello@asyntai.com, or read the MkDocs guide.

Licence

MIT. See LICENSE.