jekyll-glossary_tooltip 2.1.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 91e6fca1d659df4ab67f4a9ef820714061537414e3abbe8f9a7c7dc6d38ae7b4
-  data.tar.gz: 8df03a1c8ce31c37f1515f48382b41cec4505d8642a543a0d3159f6dddd23da7
+  metadata.gz: a1fd1d446beff3c06cbd32156d5c08bd2354a2a03653724c34eadc95a17af65a
+  data.tar.gz: f30ebd7d637f3138ba747fe08168fc829a9bf9f921a8027df04556977d1e53a3
 SHA512:
-  metadata.gz: 8bc49f67ef08dc212f0cea012a8c950952eacfd67c3e166d5c7312e0d4b402265e29ccbf98d5e01e2a7c538b5ea45d860e66a77d909f2041d43506810194b10b
-  data.tar.gz: 8da008c59ce1dc5c794e80423145254406350b2b0610ab8e0c927ed4b2dac139b7a7e74e53fb0167aef9bd583bb6a1555516a050c5d848247df2c5046dd3004f
+  metadata.gz: f6cb53f1ee8ce3d1138f6bf1b5cbe0cfe848152ed698bca7baca353b8f729410a139e2be945c6b9bf8aa6d1508323f768b8fe37c9b0042a16fb8edc25185ac6c
+  data.tar.gz: 7aba8038e95c111f6c05a379b74f7c06dd8ec19b877fe6b7f943f8c2cc9d3f3d88723d86488281352278a68e0395fc930b327b271780a10f9bd91f7dc4ced656

data/.github/workflows/ci.yml

@@ -43,7 +43,8 @@ jobs:
       - name: Run linting
         run: bundle exec rake rubocop
 
-      - uses: qltysh/qlty-action/coverage@v2
+      - name: Publish code coverage to qlty
+        uses: qltysh/qlty-action/coverage@v2
         with:
           oidc: true
           format: simplecov

data/.rubocop.yml

@@ -7,17 +7,17 @@ plugins:
 
 inherit_mode:
   merge:
-    - Exclude  # Merge my AllCops.Exclude with default excludes from https://github.com/rubocop/rubocop/blob/master/config/default.yml
+    - Exclude # Merge my AllCops.Exclude with default excludes from https://github.com/rubocop/rubocop/blob/master/config/default.yml
 
 AllCops:
   TargetRubyVersion: 3.0
   Include:
-  - lib/**/*.rb
-  - spec/**/*.rb
+    - lib/**/*.rb
+    - spec/**/*.rb
   Exclude:
-  # Travis: during build there will be a lot of rubocop config files in this path which will cause build failure as the refer to gems which are not installed by this project.
-  # See https://github.com/rubocop/rubocop/issues/9832
-  - gemfiles/vendor/bundle/**/*
+    # Travis: during build there will be a lot of rubocop config files in this path which will cause build failure as the refer to gems which are not installed by this project.
+    # See https://github.com/rubocop/rubocop/issues/9832
+    - gemfiles/vendor/bundle/**/*
   NewCops: disable
 
 Gemspec/DeprecatedAttributeAssignment:
@@ -30,7 +30,7 @@ Layout/LineEndStringConcatenationIndentation:
 Layout/EmptyLineBetweenDefs:
   Enabled: true
   Exclude:
-  - lib/jekyll-glossary_tooltip/errors.rb
+    - lib/jekyll-glossary_tooltip/errors.rb
 Layout/SpaceBeforeBrackets:
   Enabled: true
 
@@ -93,11 +93,13 @@ Metrics/BlockLength:
 Metrics/MethodLength:
   Enabled: true
   Max: 25
+Metrics/ParameterLists:
+  Max: 6
 
 Naming/FileName:
   Enabled: false
   Exclude:
-  - lib/jekyll-glossary_tooltip.rb
+    - lib/jekyll-glossary_tooltip.rb
 Naming/InclusiveLanguage:
   Enabled: true
 Naming/BlockForwarding:
@@ -113,7 +115,7 @@ Style/CollectionCompact:
 Style/Documentation:
   Enabled: true
   Exclude:
-  - lib/jekyll-glossary_tooltip/errors.rb
+    - lib/jekyll-glossary_tooltip/errors.rb
 Style/DocumentDynamicEvalDefinition:
   Enabled: true
 Style/EndlessMethod:
@@ -141,7 +143,7 @@ Style/RegexpLiteral:
 Style/SingleLineMethods:
   Enabled: true
   Exclude:
-  - lib/jekyll-glossary_tooltip/errors.rb
+    - lib/jekyll-glossary_tooltip/errors.rb
 Style/StringChars:
   Enabled: true
 Style/StringLiterals:
@@ -169,7 +171,6 @@ Style/RedundantSelfAssignmentBranch:
 Style/SelectByRegexp:
   Enabled: true
 
-
 # Reference: https://github.com/rubocop/rubocop-rake/blob/master/config/default.yml
 Rake:
   Enabled: true
@@ -191,10 +192,10 @@ RSpec/MultipleMemoizedHelpers:
   Enabled: true
   Max: 10
 RSpec/SpecFilePathFormat:
- # Disable to match structure of lib/. For jekyll plugin inclusion convention features, not having lib/jekyll/sth.rb but lib/jekyll-sth.rb
+  # Disable to match structure of lib/. For jekyll plugin inclusion convention features, not having lib/jekyll/sth.rb but lib/jekyll-sth.rb
   Enabled: false
 RSpec/SpecFilePathSuffix:
- # Disable to match structure of lib/. For jekyll plugin inclusion convention features, not having lib/jekyll/sth.rb but lib/jekyll-sth.rb
+  # Disable to match structure of lib/. For jekyll plugin inclusion convention features, not having lib/jekyll/sth.rb but lib/jekyll-sth.rb
   Enabled: false
 RSpec/IndexedLet:
   Enabled: false

data/CHANGELOG.md

@@ -1,4 +1,5 @@
 # Changelog
+
 All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
@@ -6,55 +7,92 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [3.1.0] - 2026-05-29
+
+### Added
+
+* The plugin now automatically injects its bundled tooltip CSS as a `<style>` block into every rendered HTML page — no manual CSS setup required. [#1](https://github.com/erikw/jekyll-glossary_tooltip/issues/1)
+  * To disable automatic injection and provide your own stylesheet, set `glossary_tooltip: { include_default_style: false }` in `_config.yml`.
+  * **Upgrading from a previous version?** If you were already manually copying and including the CSS, you can remove that manual step after upgrading. If you leave it in place, both styles will load — the injected one and your linked one. To avoid this, either remove your manual `<link>` tag or set `include_default_style: false` and keep your own stylesheet.
+
+### Changed
+
+* When using `display:`, the tooltip now prepends the original glossary term before the definition to preserve the original term context. [#19](https://github.com/erikw/jekyll-glossary_tooltip/issues/19)
+
 ## [2.1.0] - 2025-10-30
+
 ### Added
-- Unicode support [#20](https://github.com/erikw/jekyll-glossary_tooltip/pull/20)
+
+* Unicode support [#20](https://github.com/erikw/jekyll-glossary_tooltip/pull/20)
+
 ### Changed
-- Migrated CI from Travis to GitHub Actions.
+
+* Migrated CI from Travis to GitHub Actions.
 
 ## [2.0.0] - 2025-03-31
+
 ### Added
-- [BREAKING] Hidden with CSS parenthesis around term definition. These parenthesis will be revealed when jekyll produces a post.except as typically HTML and CSS stripped => the plain text rendering of the glossary tag will be "<term-name> (term-description> <term-url>)". [#7](https://github.com/erikw/jekyll-glossary_tooltip/issues/7)
-    - To **upgrade** to new version, you need to update the CSS by re-copy the full contexts of [jekyll-glossary_tooltip.css](lib/jekyll-glossary_tooltip/jekyll-glossary_tooltip.css) to your side. The new CSS class `.jekyll-glossary-tooltip-hidden` is added and needed to hide parenthesis in the tooltip.
+
+* [BREAKING] Hidden with CSS parenthesis around term definition. These parenthesis will be revealed when jekyll produces a post.except as typically HTML and CSS stripped => the plain text rendering of the glossary tag will be "<term-name> (term-description> <term-url>)". [#7](https://github.com/erikw/jekyll-glossary_tooltip/issues/7)
+  * To **upgrade** to new version, you need to update the CSS by re-copy the full contexts of [jekyll-glossary_tooltip.css](lib/jekyll-glossary_tooltip/jekyll-glossary_tooltip.css) to your side. The new CSS class `.jekyll-glossary-tooltip-hidden` is added and needed to hide parenthesis in the tooltip.
 
 ## [1.5.1] - 2025-03-10
+
 ### Fixed
-- Strip newlines from generated HTML to prevent unnecessary spaces to be added. [#9](https://github.com/erikw/jekyll-glossary_tooltip/issues/9)
+
+* Strip newlines from generated HTML to prevent unnecessary spaces to be added. [#9](https://github.com/erikw/jekyll-glossary_tooltip/issues/9)
 
 ## [1.5.0] - 2022-09-08
+
 ### Added
-- Support for embedded liquid tags in the url field. ([#3](https://github.com/erikw/jekyll-glossary_tooltip/issues/3])
+
+* Support for embedded liquid tags in the url field. ([#3](https://github.com/erikw/jekyll-glossary_tooltip/issues/3])
 
 ## [1.4.0] - 2021-08-18
+
 ### Changed
+
 * Bump local ruby to 3.1.0
 
 ## [1.3.1] - 2021-08-18
+
 ### Added
-- GitHub workflow to publish to GitHub Packages.
+
+* GitHub workflow to publish to GitHub Packages.
 
 ## [1.3.1] - 2021-08-18
+
 ### Fixed
-- gemspec dependency range stynax.
+
+* gemspec dependency range stynax.
 
 ## [1.3.0] - 2021-08-07
+
 ### Changed
-- Open the souce link from a tooltip in a new tab.
+
+* Open the souce link from a tooltip in a new tab.
 
 ## [1.2.0] - 2021-08-06
+
 ### Added
-- Bottom arrow to the tooltip.
-- Tooltip hover animation from invisible to visible.
+
+* Bottom arrow to the tooltip.
+* Tooltip hover animation from invisible to visible.
 
 ### Changed
-- Restyle the glossary term bottom border style and color.
+
+* Restyle the glossary term bottom border style and color.
 
 ## [1.1.0] - 2021-08-06
+
 ### Added
-- Optional `display:` argument to set a different term display name, rather than using the term name as defined in the glossary file. Usage: `{% glossary term_name, display: Different Name To Display %}`.
+
+* Optional `display:` argument to set a different term display name, rather than using the term name as defined in the glossary file. Usage: `{% glossary term_name, display: Different Name To Display %}`.
 
 ## [1.0.0] - 2021-08-05
-- No changes from `v0.1.0` but just bumping to final first major release version!
+
+* No changes from `v0.1.0` but just bumping to final first major release version!
 
 ## [0.1.0] - 2021-08-05
-- First release version. The plugin is fully working but I suspect that there might be a few point releases just to nail the release process. Once this is working, there will soon be an 1.0.0 release!
+
+* First release version. The plugin is fully working but I suspect that there might be a few point releases just to nail the release process. Once this is working, there will soon be an 1.0.0 release!

data/README.md

@@ -50,7 +50,6 @@ It's also possible to provide an optional URL for, for example, a term definitio
    ```
 1. Create a `_data/glossary.yml` file, according to the 'Glossary Term Definition File' section below, with your terms.
 1. Use the liquid tag in a page like `{% glossary term_name %}`
-1. Add CSS styling for the tooltip from [jekyll-glossary_tooltip.css](lib/jekyll-glossary_tooltip/jekyll-glossary_tooltip.css). You need to make sure that the pages where you will use the glossary tag have this styling applied. Typically, this would mean 1) copying this file to your `assets/css/` directory, 2) editing your theme's template for blog posts (or what pages you desire) to include this CSS in the header like `<link rel="stylesheet" href="/assets/css/jekyll-glossary_tooltip.css">`. However, you could also copy this file's content into your `main.css` or `main.scss` or however you build your site's CSS.
 1. Now just build your site, and you will get nice, nice term definition tooltips on mouse hover (or mobile, tap) for your terms!
    ```shell
    bundle exec jekyll build
@@ -107,6 +106,9 @@ use the plural "cats"? Then you can supply an optional `display` argument. The s
 This could be, e.g.
 {% glossary cat, display: cats %}
 {% glossary some term, display: some other display text %}
+
+When `display:` is used, the tooltip prepends the original glossary term before the definition so
+readers still get the term's original context.
 ```
 
 > [!WARNING]
@@ -114,7 +116,18 @@ This could be, e.g.
 
 
 ## CSS Style Override
-Simply modify the rules [jekyll-glossary_tooltip.css](lib/jekyll-glossary_tooltip/jekyll-glossary_tooltip.css) that you copied to your project. The tooltip is based on this [tutorial](https://www.w3schools.com/css/css_tooltip.asp). View the generated HTML output to see the HTML tags that are styled, or check the [tag.rb](lib/jekyll-glossary_tooltip/tag.rb) implementation in the method `render()`.
+The plugin automatically injects its bundled tooltip CSS as a `<style>` block into every rendered HTML page, so no manual CSS setup is required.
+
+The injected styles are placed at the start of `<head>`, which means any CSS your site loads afterward will naturally take precedence. To override specific rules, simply add your own declarations in your site's stylesheet — they will win without any extra configuration.
+
+If you want full control (e.g., to replace the styles entirely with your own stylesheet), you can disable the built-in injection in `_config.yml`:
+
+```yml
+glossary_tooltip:
+  include_default_style: false
+```
+
+Then add your own CSS based on [jekyll-glossary_tooltip.css](lib/jekyll-glossary_tooltip/jekyll-glossary_tooltip.css). View the generated HTML output to see the HTML tags that are styled, or check the [tag.rb](lib/jekyll-glossary_tooltip/tag.rb) implementation in the method `render()`.
 
 
 ## Page listing all terms

data/lib/jekyll-glossary_tooltip/css_injector.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module GlossaryTooltip
+    # Automatically injects the plugin's bundled tooltip CSS into rendered HTML pages and
+    # documents. Injection can be disabled via site configuration:
+    #
+    #   glossary_tooltip:
+    #     include_default_style: false
+    #
+    module CssInjector
+      CSS_FILE    = File.join(__dir__, "jekyll-glossary_tooltip.css")
+      CSS_CONTENT = File.read(CSS_FILE).freeze
+      STYLE_ID    = "jekyll-glossary-tooltip-style"
+      STYLE_BLOCK = "<style id=\"#{STYLE_ID}\">\n#{CSS_CONTENT}</style>".freeze
+
+      # Matches an opening <head> tag, including any attributes (e.g. <head lang="en">).
+      HEAD_TAG_REGEX = /<head\b[^>]*>/i.freeze
+
+      class << self
+        def register_hooks
+          Jekyll::Hooks.register(%i[pages documents], :post_render) do |doc|
+            inject_style(doc)
+          end
+        end
+
+        def inject_style(doc)
+          return unless enabled?(doc.site)
+          return unless doc.output.to_s.match?(HEAD_TAG_REGEX)
+          return if doc.output.include?(STYLE_ID)
+
+          doc.output = doc.output.sub(HEAD_TAG_REGEX) { |match| "#{match}\n#{STYLE_BLOCK}" }
+        end
+
+        private
+
+        def enabled?(site)
+          config = site.config["glossary_tooltip"] || {}
+          config.fetch("include_default_style", true)
+        end
+      end
+    end
+  end
+end
+
+Jekyll::GlossaryTooltip::CssInjector.register_hooks

data/lib/jekyll-glossary_tooltip/tag.rb

@@ -2,6 +2,7 @@
 
 require "jekyll"
 require "jekyll-glossary_tooltip/errors"
+require "jekyll-glossary_tooltip/options_parser"
 
 module Jekyll
   module GlossaryTooltip
@@ -14,11 +15,11 @@ module Jekyll
 
       def render(context)
         entry = lookup_entry(context.registers[:site], @opts[:term_query])
-        @opts[:display] ||= @opts[:term_query]
+        display = @opts[:display] || @opts[:term_query]
         html = <<~HTML
           <span class="jekyll-glossary">
-            #{@opts[:display]}
-            <span class="jekyll-glossary-tooltip"><span class="jekyll-glossary-tooltip-hidden">(</span>#{entry["definition"]}#{render_tooltip_url(entry, context)}<span class="jekyll-glossary-tooltip-hidden">)</span></span>
+            #{display}
+            <span class="jekyll-glossary-tooltip"><span class="jekyll-glossary-tooltip-hidden">(</span>#{render_tooltip_definition(entry)}#{render_tooltip_url(entry, context)}<span class="jekyll-glossary-tooltip-hidden">)</span></span>
           </span>
         HTML
         html.gsub("\n", "")
@@ -28,6 +29,12 @@ module Jekyll
 
       LOG_TAG = "Glossary Tag:"
 
+      def render_tooltip_definition(entry)
+        return entry["definition"] unless @opts[:display]
+
+        "#{entry["term"]}: #{entry["definition"]}"
+      end
+
       def render_tooltip_url(entry, context)
         # The content of the anchor is set from the CSS class jekyll-glossary-source-link,
         # so that the plugin user can customize the text without touching ruby source.

data/lib/jekyll-glossary_tooltip/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   module GlossaryTooltip
-    VERSION = "2.1.0"
+    VERSION = "3.0.0"
   end
 end

data/lib/jekyll-glossary_tooltip.rb

@@ -3,6 +3,7 @@
 require_relative "jekyll-glossary_tooltip/options_parser"
 require_relative "jekyll-glossary_tooltip/tag"
 require_relative "jekyll-glossary_tooltip/version"
+require_relative "jekyll-glossary_tooltip/css_injector"
 
 module Jekyll
   # Module for the plugin.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-glossary_tooltip
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Erik Westrup
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-10-30 00:00:00.000000000 Z
+date: 2026-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -73,6 +73,7 @@ files:
 - img/tooltip_screenshot.xcf
 - jekyll-glossary_tooltip.gemspec
 - lib/jekyll-glossary_tooltip.rb
+- lib/jekyll-glossary_tooltip/css_injector.rb
 - lib/jekyll-glossary_tooltip/errors.rb
 - lib/jekyll-glossary_tooltip/jekyll-glossary_tooltip.css
 - lib/jekyll-glossary_tooltip/options_parser.rb