Jekyll Plugin

Add the Asyntai AI chat assistant to your Jekyll site

Overview

Jekyll is a static site generator for blogs, documentation and company websites. The Asyntai plugin is a Ruby gem called jekyll-ai-chatbot. Add it to your site, put your widget ID in _config.yml, build the site, and the chat bubble is on every page.

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

Requirements

Jekyll 3.7 or later, including 4.x
An Asyntai account. The Free plan is enough to try the widget

Installation

Follow these steps to add Asyntai to your Jekyll 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 Gem

Open your Gemfile and add the gem to the jekyll_plugins group:

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

Then run bundle install in your site folder.

Add Your Widget ID

Open _config.yml and add your widget ID:

asyntai:
  widget_id: asyntai_1a2b3c4d5e6f

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

plugins:
  - jekyll-ai-chatbot

Build the Site

Run bundle exec jekyll build and publish, or run bundle exec jekyll serve to see it locally. Open your site and the chat bubble is in the corner of every page.

Options

All options go under asyntai: in _config.yml.

Option	Type	Default	What it does
`widget_id`	string	required	Your Asyntai widget ID
`enable_in_development`	boolean	`true`	Set it to `false` to keep the widget off the site while `JEKYLL_ENV` is `development`
`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.

To keep the widget off one page, add asyntai: false to that page's front matter.

How It Works

The plugin adds the Asyntai loader to every HTML page your site builds, 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.

GitHub Pages

The classic GitHub Pages build runs only the plugins on its own approved list. To use the gem on GitHub Pages, build the site with GitHub Actions: in your repository, open Settings → Pages and choose GitHub Actions as the source, with the Jekyll workflow. The gem then runs like on any other host.

Answering From Your Content

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 documents, and question and answer pairs.

Tip: Jekyll uses development when JEKYLL_ENV is not set, also for jekyll build. If you set enable_in_development: false, build the live site with JEKYLL_ENV=production bundle exec jekyll build.

Removing It

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

Plans & Pricing

The gem is free. View pricing.

Need Help?

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

Documentation