jekyll-ai-chatbot 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8534449e9a21053a99ef60381c817b176a9bf265775a970d21516ec20157d6f8
+  data.tar.gz: 3591194a072e9bb4586737c972a0ab516093ffd7bde1d3b48bcc693d60b30955
+SHA512:
+  metadata.gz: 34567640711fe7db9ded7543f9d3b092e054f26779679302c98826d648513138041aec90a2e3d35fffa03bc0a80923e6625117442987e7e6fd057b616e15d4bd
+  data.tar.gz: b944e557c0005ee750e8ef0367dee607ef6cd7a2cb2192fef5b09387b80f49ac48b0cf217727f58fe9a5e0e66210e8b5c5cd429a2bd15bc48f8f972617731d32

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Asyntai
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,100 @@
+# jekyll-ai-chatbot
+
+Add the [Asyntai](https://asyntai.com) AI chat assistant to your Jekyll site.
+It answers visitor questions from your own content, in more than 80 languages.
+
+## Install
+
+Add the gem to your `Gemfile`, in the `jekyll_plugins` group:
+
+```ruby
+group :jekyll_plugins do
+  gem "jekyll-ai-chatbot"
+end
+```
+
+Run `bundle install`. Then add your widget ID to `_config.yml`:
+
+```yaml
+asyntai:
+  widget_id: asyntai_1a2b3c4d5e6f
+```
+
+If your site lists its plugins in `_config.yml` instead of the Gemfile group,
+add it there too:
+
+```yaml
+plugins:
+  - jekyll-ai-chatbot
+```
+
+Build the site. The chat bubble is on every page.
+
+## 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
+
+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 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.
+
+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:
+
+```yaml
+asyntai: false
+```
+
+## What the plugin does
+
+- 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.
+
+## GitHub Pages
+
+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.
+
+## 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 extra
+documents and question and answer pairs.
+
+## Removing it
+
+Remove the gem from your `Gemfile` and the `asyntai:` block from `_config.yml`,
+then build again. The widget is gone.
+
+## Support
+
+Email [hello@asyntai.com](mailto:hello@asyntai.com), or read the
+[Jekyll guide](https://asyntai.com/documentation/integrations/jekyll/).
+
+## Licence
+
+MIT

data/lib/jekyll-ai-chatbot/core.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+# Asyntai AI chatbot for Jekyll: the logic, without the hooks, so it can be
+# tested outside a Jekyll build.
+#
+# Adds the Asyntai chat widget to every HTML page the site builds. After a page
+# is rendered, the plugin puts the ordinary embed loader just before </body>
+# and changes nothing else about the page.
+
+require "json"
+require "jekyll-ai-chatbot/version"
+
+module JekyllAiChatbot
+  DEFAULT_SCRIPT_URL = "https://widget.asyntai.com/static/js/chat-widget.js"
+  WIDGET_ID_PATTERN = /\Aasyntai_[A-Za-z0-9]+\z/
+  NAME = "jekyll-ai-chatbot"
+  CONFIG_KEY = "asyntai"
+
+  class ConfigurationError < StandardError; end
+
+  Settings = Struct.new(:widget_id, :script_url, :enable_in_development)
+
+  module_function
+
+  # Reads the `asyntai:` block of _config.yml. A wrong option stops the build
+  # with a clear message instead of producing a site with no chat.
+  def validate_options(options)
+    unless options.nil? || options.is_a?(Hash)
+      raise ConfigurationError,
+            "#{NAME}: \"#{CONFIG_KEY}\" in _config.yml must be a block with " \
+            "widget_id inside it, for example:\n\n" \
+            "  #{CONFIG_KEY}:\n    widget_id: asyntai_1a2b3c4d5e6f"
+    end
+
+    opts = (options || {}).each_with_object({}) { |(k, v), h| h[k.to_s] = v }
+    widget_id = opts["widget_id"].is_a?(String) ? opts["widget_id"].strip : ""
+
+    if widget_id.empty?
+      raise ConfigurationError,
+            "#{NAME}: \"widget_id\" is required. Add it to _config.yml under " \
+            "\"#{CONFIG_KEY}:\". Copy it from the Install page of your Asyntai " \
+            "dashboard, for example asyntai_1a2b3c4d5e6f."
+    end
+    unless WIDGET_ID_PATTERN.match?(widget_id)
+      raise ConfigurationError,
+            "#{NAME}: \"#{widget_id}\" does not look like a widget ID. It starts with " \
+            "asyntai_, for example asyntai_1a2b3c4d5e6f."
+    end
+
+    script_url = opts["script_url"].is_a?(String) && !opts["script_url"].strip.empty? ?
+      opts["script_url"].strip : DEFAULT_SCRIPT_URL
+
+    Settings.new(
+      widget_id,
+      script_url,
+      # Set to false to keep the widget off the site while JEKYLL_ENV is development.
+      opts["enable_in_development"] != false
+    )
+  end
+
+  # JSON string, safe inside an HTML <script> element.
+  def js_string(value)
+    JSON.generate(value.to_s).gsub("<", "\\u003c")
+  end
+
+  # The loader waits for the page's load event before it fetches the widget.
+  # An ordinary `<script async src>` holds the load event open until its own
+  # fetch finishes, so an unreachable server would delay the host page. This
+  # pattern cannot.
+  def build_loader(widget_id, script_url)
+    "(function(){var l=function(){" \
+      "if(document.querySelector(\"script[data-asyntai-id]\"))return;" \
+      "var s=document.createElement(\"script\");" \
+      "s.src=#{js_string(script_url)};s.async=true;" \
+      "s.setAttribute(\"data-asyntai-id\",#{js_string(widget_id)});" \
+      "document.head.appendChild(s)};" \
+      "if(document.readyState===\"complete\"){l()}" \
+      "else{window.addEventListener(\"load\",l)}})();"
+  end
+
+  def build_tag(settings)
+    "<script data-asyntai-loader>#{build_loader(settings.widget_id, settings.script_url)}</script>"
+  end
+
+  # Puts the tag before the last </body>, or before </html> when the page has no
+  # body tag. A fragment with neither is left alone: it is not a whole page.
+  # A page that already carries an Asyntai snippet is left alone too.
+  def inject_into_html(html, tag)
+    return html unless html.is_a?(String)
+    return html if html.include?("data-asyntai-id")
+
+    lower = html.downcase
+    at = lower.rindex("</body>") || lower.rindex("</html>")
+    return html if at.nil?
+
+    html[0...at] + tag + html[at..-1]
+  end
+
+  # Only pages that are written to disk as .html get the widget. Feeds, JSON,
+  # CSS, Sass and pages with `published: false` or no output stay as they are.
+  def html_output?(document)
+    if document.respond_to?(:write?)
+      return false unless document.write?
+    end
+    ext = document.respond_to?(:output_ext) ? document.output_ext.to_s.downcase : ""
+    [".html", ".htm"].include?(ext)
+  end
+
+  # A page can opt out with `asyntai: false` in its front matter.
+  def opted_out?(document)
+    data = document.respond_to?(:data) ? document.data : nil
+    data.is_a?(Hash) && data[CONFIG_KEY] == false
+  end
+
+  def apply(document, settings, tag, environment)
+    return if !settings.enable_in_development && environment.to_s == "development"
+    return unless html_output?(document)
+    return if opted_out?(document)
+
+    document.output = inject_into_html(document.output, tag)
+  end
+end

data/lib/jekyll-ai-chatbot/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module JekyllAiChatbot
+  VERSION = "1.0.0"
+end

data/lib/jekyll-ai-chatbot.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+# Asyntai AI chatbot for Jekyll.
+#
+# In _config.yml:
+#
+#   plugins:
+#     - jekyll-ai-chatbot
+#
+#   asyntai:
+#     widget_id: asyntai_1a2b3c4d5e6f
+
+require "jekyll"
+require "jekyll-ai-chatbot/core"
+
+module JekyllAiChatbot
+  # Settings of the site being built, read once per build.
+  @settings = nil
+  @tag = nil
+
+  class << self
+    attr_reader :settings, :tag
+
+    def configure(site)
+      @settings = validate_options(site.config[CONFIG_KEY])
+      @tag = build_tag(@settings)
+    rescue ConfigurationError => e
+      raise Jekyll::Errors::FatalException, e.message
+    end
+  end
+end
+
+# `after_reset` runs at the start of every build, also on each rebuild of
+# `jekyll serve`, so a changed widget ID in _config.yml is picked up.
+Jekyll::Hooks.register :site, :after_reset do |site|
+  JekyllAiChatbot.configure(site)
+end
+
+# Pages, posts and collection documents. Low priority, so the widget goes in
+# after other plugins change the page.
+Jekyll::Hooks.register [:pages, :documents], :post_render, priority: :low do |doc|
+  next if JekyllAiChatbot.settings.nil?
+
+  JekyllAiChatbot.apply(doc, JekyllAiChatbot.settings, JekyllAiChatbot.tag, Jekyll.env)
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-ai-chatbot
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Asyntai
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-10-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Adds the Asyntai AI chatbot to every page of your Jekyll site. It answers
+  visitor questions from your own content, in 80+ languages.
+email: hello@asyntai.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/jekyll-ai-chatbot.rb
+- lib/jekyll-ai-chatbot/core.rb
+- lib/jekyll-ai-chatbot/version.rb
+homepage: https://asyntai.com/documentation/integrations/jekyll/
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://asyntai.com/documentation/integrations/jekyll/
+  source_code_uri: https://github.com/asyntai/jekyll-ai-chatbot
+  bug_tracker_uri: https://github.com/asyntai/jekyll-ai-chatbot/issues
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: Add the Asyntai AI chat assistant to your Jekyll site.
+test_files: []