Metadata-Version: 2.4
Name: mkdocs-ai-chatbot
Version: 1.0.0
Summary: Add the Asyntai AI chat assistant to your MkDocs site. It answers visitor questions from your own documentation.
Author-email: Asyntai <hello@asyntai.com>
License-Expression: MIT
Project-URL: Homepage, https://asyntai.com/documentation/integrations/mkdocs/
Project-URL: Documentation, https://asyntai.com/documentation/integrations/mkdocs/
Project-URL: Source, https://github.com/asyntai/mkdocs-ai-chatbot
Project-URL: Issues, https://github.com/asyntai/mkdocs-ai-chatbot/issues
Keywords: mkdocs,mkdocs-plugin,chatbot,ai,chat,support,documentation,asyntai
Classifier: Framework :: MkDocs
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Documentation
Classifier: Topic :: Communications :: Chat
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: mkdocs>=1.4
Dynamic: license-file

# mkdocs-ai-chatbot

Add the [Asyntai](https://asyntai.com) 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

```bash
pip install mkdocs-ai-chatbot
```

Then add the plugin in `mkdocs.yml`:

```yaml
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](https://asyntai.com/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

| Option | Type | Default | What it does |
| --- | --- | --- | --- |
| `widget_id` | string | required | Your Asyntai widget ID |
| `enable_on_serve` | boolean | `true` | Set to `false` to keep the widget off the site during `mkdocs serve` |
| `script_url` | string | the Asyntai CDN | Advanced. Load the widget from another URL |

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](mailto:hello@asyntai.com), or read the
[MkDocs guide](https://asyntai.com/documentation/integrations/mkdocs/).

## Licence

MIT. See [LICENSE](LICENSE).
