jekyll-ai-chatbot

Add the Asyntai AI chat assistant to your Jekyll site. It answers visitor questions from your own content, in more than 80 languages.

Add the gem to your Gemfile, in the jekyll_plugins group:

group :jekyll_plugins do
  gem "jekyll-ai-chatbot"
end

Run bundle install. Then add your widget ID to _config.yml:

asyntai:
  widget_id: asyntai_1a2b3c4d5e6f

If your site lists its plugins in _config.yml instead of the Gemfile group, add it there too:

plugins:
  - jekyll-ai-chatbot

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

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.

All options go under asyntai: in _config.yml.

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

Jekyll uses development when JEKYLL_ENV is not set, also for jekyll build. If you set enable_in_development: false, build with JEKYLL_ENV=production jekyll build to get the widget.

To keep the widget off one page, add this to its front matter:

asyntai: false

• It adds the Asyntai loader to every HTML page, just before </body>. That includes pages, posts, collection documents and pagination pages.
• The loader waits for the page's load event, so your own content always renders first.
• Feeds, JSON, CSS, Sass and other non-HTML files stay as they are.
• A page that already has the Asyntai snippet keeps it and gets no second one.

Tested with Jekyll 3.10 and 4.4.

The classic GitHub Pages build runs only the plugins on its own approved list. To use this gem on GitHub Pages, build the site with GitHub Actions (the "Jekyll" workflow in your repository's Pages settings). Then the gem runs like on any other host.

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

Remove the gem from your Gemfile and the asyntai: block from _config.yml, then build again. The widget is gone.

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

MIT