jekyll-deskcrew 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 90dc53c2da8abff1e6f73e79b6a3195a98984efc33ec2bba2e1846e7f77e68ae
+  data.tar.gz: 9cb03737d7a59ea4b8c511bc76b06ca3d961bd3462e02845b9b85166f557903a
+SHA512:
+  metadata.gz: 43469596e4731d29814fc1858382222391c56c0bece9e1c0ad845f4b9cd4471d729106dafa5e20ff386e4965f5a33868e74a10513d069cd43f15d1489d2f50bf
+  data.tar.gz: 1148a24b1bff013206597f137e80550b8ecd174b87dfad0a8384701f2dc8be117c4d600b915310ce1438fd61744ad738440630fa413ec9453609dbfe2be4eabc

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 DeskCrew
+
+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,44 @@
+# jekyll-deskcrew
+
+![DeskCrew widget on every Jekyll page](https://deskcrew.io/packages/deskcrew-jekyll.gif)
+
+Add the [DeskCrew](https://deskcrew.io) support widget to a Jekyll site: live chat, AI answers grounded in your knowledge base, and a help center. One plugin, configured in `_config.yml`, and every page and post carries the widget. No layout changes.
+
+You need a free DeskCrew account to get a widget key: https://deskcrew.io/signup
+
+## Install
+
+```ruby
+# Gemfile
+group :jekyll_plugins do
+  gem "jekyll-deskcrew"
+end
+```
+
+```yaml
+# _config.yml
+plugins:
+  - jekyll-deskcrew
+
+deskcrew:
+  key: pub_your_widget_key # from your DeskCrew dashboard, Install page
+  board: your-board # optional
+  # color: "#4f46e5"        # optional, 6-digit hex
+  # position: right         # optional, or left
+  # greeting: "Hi! How can we help?"
+  # enabled: false          # keep the plugin installed but switch the widget off
+```
+
+Build the site. The launcher appears on every generated HTML page. GitHub Pages does not run custom plugins; build with GitHub Actions or another host instead.
+
+## How it works
+
+A `post_render` hook injects one `<script>` tag before `</body>` on every page and document with an `.html` output. Every value from `_config.yml` is validated and HTML-escaped first; a missing or malformed key means nothing is injected, and a page that already carries the tag is never given a second one.
+
+## What the plugin adds to your site
+
+One script tag loading `https://deskcrew.io/desk.js` with your public widget key. The widget runs inside a Shadow DOM and does not touch your styles. Terms: https://deskcrew.io/terms. Privacy: https://deskcrew.io/privacy.
+
+## License
+
+MIT

data/lib/jekyll-deskcrew/tag.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require "erb"
+
+module JekyllDeskcrew
+  # Builds the widget <script> tag from the `deskcrew` block of _config.yml.
+  # Every value is validated, then HTML-escaped; a missing or malformed key gives an
+  # empty string, so a bad config never puts arbitrary markup on the page.
+  module Tag
+    KEY_FORMAT = /\Apub_[A-Za-z0-9]+\z/
+    BOARD_FORMAT = /\A[a-z0-9-]+\z/
+    COLOR_FORMAT = /\A#[0-9a-fA-F]{6}\z/
+    APP_URL = "https://deskcrew.io"
+
+    module_function
+
+    def build(config)
+      cfg = (config || {}).transform_keys(&:to_s)
+      key = cfg["key"].to_s.strip
+      return "" if cfg.key?("enabled") && !cfg["enabled"]
+      return "" unless KEY_FORMAT.match?(key)
+
+      attrs = { "src" => "#{APP_URL}/desk.js", "data-key" => key }
+      board = cfg["board"].to_s.strip
+      attrs["data-board"] = board if BOARD_FORMAT.match?(board) && !board.empty?
+      color = cfg["color"].to_s.strip
+      attrs["data-color"] = color if COLOR_FORMAT.match?(color)
+      attrs["data-position"] = cfg["position"].to_s if %w[left right].include?(cfg["position"].to_s)
+      greeting = cfg["greeting"].to_s.strip
+      attrs["data-greeting"] = greeting[0, 120] unless greeting.empty?
+
+      pairs = attrs.map { |k, v| %(#{k}="#{ERB::Util.html_escape(v)}") }
+      "<script #{pairs.join(' ')} defer></script>"
+    end
+
+    def inject(html, tag)
+      return html if tag.empty? || !html.is_a?(String)
+      return html if html.include?("#{APP_URL}/desk.js")
+      return html unless html =~ %r{</body>}i
+
+      html.sub(%r{</body>}i) { "#{tag}\n</body>" }
+    end
+  end
+end

data/lib/jekyll-deskcrew/version.rb

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

data/lib/jekyll-deskcrew.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "jekyll"
+require "jekyll-deskcrew/version"
+require "jekyll-deskcrew/tag"
+
+# _config.yml:
+#   plugins: [jekyll-deskcrew]
+#   deskcrew:
+#     key: pub_your_widget_key   # from your DeskCrew dashboard, Install page
+#     board: your-board          # optional
+#     color: "#4f46e5"           # optional
+#     position: right            # optional, or left
+#     greeting: "Hi! How can we help?"  # optional
+#
+# The widget tag is injected before </body> of every rendered page and document.
+Jekyll::Hooks.register [:pages, :documents], :post_render do |item|
+  next unless item.output_ext == ".html" || item.output_ext.nil?
+
+  tag = JekyllDeskcrew::Tag.build(item.site.config["deskcrew"])
+  item.output = JekyllDeskcrew::Tag.inject(item.output, tag)
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-deskcrew
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- DeskCrew
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.9'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.9'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+description: DeskCrew is an AI-powered helpdesk. This plugin injects the DeskCrew
+  support widget (live chat, AI answers from your knowledge base, a help center) before
+  </body> on every generated HTML page. Configure it from _config.yml; no layout changes.
+email:
+- support@deskcrew.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/jekyll-deskcrew.rb
+- lib/jekyll-deskcrew/tag.rb
+- lib/jekyll-deskcrew/version.rb
+homepage: https://deskcrew.io/integrations/jekyll
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://deskcrew.io/integrations/jekyll
+  source_code_uri: https://github.com/webmilmind1/support-tickets/tree/main/jekyll-deskcrew
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Add the DeskCrew AI support widget to every page and post of a Jekyll site.
+test_files: []