jekyll-webawesome 0.14.0 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 245ba4dad039172f52286841d437c0949cc10e0769324b192707589dbde2ac84
-  data.tar.gz: 2035f8185bdf9da3b664d88c22351842142098fcc185af977a091bf6cea79c65
+  metadata.gz: adeebc3995bb614e0c221f9424cf22200eb70c062f8c4d5500bc8e92f935b0f6
+  data.tar.gz: a49c3aec2dc3159b4f03854aa2646fd3410cbae910e4c060e0207f45fbe29a2d
 SHA512:
-  metadata.gz: fd137a5495ce01aa36194f528873758706b9925d491a564e3b86e0080481ea1499bbd7d8380e844a80b791810893aa8f77603353fec76b0cc73e254061d214d8
-  data.tar.gz: dc4318b0450ef4fd151b7ef5cdec10d1c72b2c63361a64eb39892a17685763355b9d283b06d562773fb3efd05a96172ad2fd326504e1e3865b52d9947c6e5de5
+  metadata.gz: 0eb010999a613a1cd9e58e29a852f6c479ce0d4e11c91e371f6406b2ee66ae4cf1d6a2d739ac0ffb6a85eb63dd7453d1e4b6798b165d5453bccec55a68b3798f
+  data.tar.gz: 15cbd4e4f50c414ac5ce11f9f34da33b6afae15edeb4a50ed9b894ef76215d4354dd1cc0b80847c954c137374aeeb9f0816146a6c4d709fa2b163d29f5a04ae4

data/CHANGELOG.md

@@ -4,6 +4,29 @@ 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.1.0/)
 
+## [0.16.0] - 2026-05-05
+
+### Changed
+
+- Internal: code block protection (replacing fenced code blocks with placeholders before Markawesome transforms run, so `:::info`/`^^^`/`@@@` examples inside fenced code stay intact) is now delegated to `Markawesome::CodeBlockProtector` instead of being implemented locally. The Jekyll-specific `{% highlight %}` substitution at priority 15 stays in this gem. No behavior change for Jekyll users.
+- Updated `markawesome` dependency to `~> 0.10`. The 0.10.0 release adds `Markawesome::PlainMarkdownRenderer` (an alternate renderer that emits clean GFM instead of HTML) and exposes `Markawesome::CodeBlockProtector` as a public helper.
+
+## [0.15.0] - 2026-03-12
+
+### Added
+
+- **Inline popover syntax** via markawesome 0.9.0: `&&&trigger text >>> popover content&&&` for use within sentences
+  - Always renders as link-styled trigger (underlined text)
+  - Supports all parameters: placement, `without-arrow`, `distance:N`
+  - Plain text content (HTML-escaped, no markdown processing)
+  - Multiple inline popovers supported on the same line
+- Inline popover examples added to example site
+- Updated README with inline popover documentation
+
+### Changed
+
+- Updated `markawesome` dependency to `~> 0.9`
+
 ## [0.14.0] - 2026-03-12
 
 ### Changed

data/README.md

@@ -1180,6 +1180,20 @@ Multiple paragraphs work too.
 &&&
 ```
 
+#### Inline Syntax
+
+Popovers can be used inline within a sentence using `&&&trigger text >>> popover content&&&` on a single line. Inline popovers always render as link-styled triggers:
+
+```markdown
+Send invoices via &&&Peppol >>> A standardized e-invoicing network&&& to your customers.
+
+Learn about &&&bottom API keys >>> API keys authenticate your requests&&& in the docs.
+
+Check &&&right without-arrow distance:5 validation >>> Invoices are validated against business rules&&& before submitting.
+```
+
+Parameters (placement, `without-arrow`, `distance:N`) come before the trigger text. Inline popover content is plain text (use block syntax for rich markdown content).
+
 #### Alternative Syntax
 
 You can also use the explicit `:::wa-popover` syntax:
@@ -1197,7 +1211,7 @@ Popover content using the alternative syntax.
 | Option | Values | Default | Description |
 |--------|--------|---------|-------------|
 | `placement` | `top`, `bottom`, `left`, `right` | `top` | Where the popover appears |
-| `link` | keyword | off | Renders trigger as underlined text instead of button |
+| `link` | keyword | off (always on for inline) | Renders trigger as underlined text instead of button |
 | `without-arrow` | keyword | off | Hides the popover arrow |
 | `distance:N` | number (pixels) | (default) | Distance between trigger and popover |
 

data/jekyll-webawesome.gemspec

@@ -33,7 +33,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'jekyll', '>= 3.7', '< 5.0'
-  spec.add_dependency 'markawesome', '~> 0.7'
+  spec.add_dependency 'markawesome', '~> 0.10'
 
   spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'rake', '~> 13.0'

data/lib/jekyll/webawesome/code_block_transformer.rb

@@ -1,71 +1,61 @@
 # frozen_string_literal: true
 
+require 'markawesome/code_block_protector'
+
 module Jekyll
   module WebAwesome
-    # Transforms markdown code blocks to Jekyll highlight syntax
+    # Protects markdown fenced code blocks before Markawesome transforms
+    # run, and substitutes them with Jekyll `{% highlight %}` tags after,
+    # so code examples containing `:::`/`^^^`/`@@@` survive intact and
+    # language-tagged blocks still render with Jekyll's syntax highlighter.
+    #
+    # Protection/restore is delegated to Markawesome::CodeBlockProtector;
+    # the `{% highlight %}` substitution at priority 15 is Jekyll-specific
+    # and stays here.
     module CodeBlockTransformer
-      CODE_BLOCK_PATTERN = /```([a-zA-Z0-9.+#_-]+)?(\n.*?)```/m
+      CODE_BLOCK_PATTERN = Markawesome::CodeBlockProtector::CODE_BLOCK_PATTERN
 
-      # Class variable to store protected blocks across hook calls
-      @@protected_blocks = {}
+      @protected_blocks = {}
 
       class << self
+        attr_reader :protected_blocks
+
         def clear_protected_blocks
-          @@protected_blocks.clear
+          @protected_blocks.clear
         end
 
         # Check if pages transformation is enabled
         def transform_pages_enabled?(site)
-          # Check plugin configuration first
           return Jekyll::WebAwesome.configuration.transform_pages if Jekyll::WebAwesome.configuration
-
-          # Check site config
           return site.config.dig('webawesome', 'transform_pages') if site.config.dig('webawesome', 'transform_pages') != nil
 
-          # Default to true
           true
         end
 
         # Check if documents transformation is enabled
         def transform_documents_enabled?(site)
-          # Check plugin configuration first
           return Jekyll::WebAwesome.configuration.transform_documents if Jekyll::WebAwesome.configuration
-
-          # Check site config
           return site.config.dig('webawesome', 'transform_documents') if site.config.dig('webawesome', 'transform_documents') != nil
 
-          # Default to true
           true
         end
 
-        # Check if a code block contains WebAwesome syntax that should be preserved
-        def contains_webawesome_syntax?(content)
-          # Check for WebAwesome patterns
-          callout_pattern = /^:::(info|success|neutral|warning|danger)/m
-          details_pattern = /^\^\^\^/m
-          tabs_pattern = /^\+{6}/m
-
-          content.match?(callout_pattern) || content.match?(details_pattern) || content.match?(tabs_pattern)
-        end
-
-        # Protect all code blocks by converting them to placeholders
-        # This prevents markdown processing from corrupting code blocks inside custom elements
+        # Protect all code blocks by converting them to placeholders via
+        # Markawesome::CodeBlockProtector. The resulting token map is
+        # merged into @protected_blocks so per-page placeholders survive
+        # across the pre_render priority chain (50 → 15 → 10).
         def protect_all_code_blocks(content)
-          counter = @@protected_blocks.size
-
-          content.gsub(CODE_BLOCK_PATTERN) do |match|
-            placeholder = "<!--PROTECTED_CODE_BLOCK_#{counter}-->"
-            @@protected_blocks[placeholder] = match
-            counter += 1
-            placeholder
-          end
+          protected_content, tokens = Markawesome::CodeBlockProtector.protect(content)
+          @protected_blocks.merge!(tokens)
+          protected_content
         end
 
-        # Transform code blocks from markdown syntax to Jekyll highlight tags
-        # This should be called AFTER WebAwesome transformers have processed the content
+        # Rewrite each protected fenced block to a Jekyll `{% highlight %}`
+        # tag, except for blocks without a language or with `plain` — those
+        # are restored verbatim. Called at priority 15, i.e. after
+        # Markawesome transformers but before restore.
         def transform_code_blocks(content)
-          # Transform code blocks that were previously protected
-          @@protected_blocks.transform_values! do |match|
+          @protected_blocks.transform_values! do |match|
             if match =~ CODE_BLOCK_PATTERN
               language = Regexp.last_match(1)
               code_content = Regexp.last_match(2).strip
@@ -73,7 +63,7 @@ module Jekyll
               if language && language.downcase != 'plain'
                 "{% highlight #{language} %}\n#{code_content}\n{% endhighlight %}"
               else
-                match # Return original block if no language or 'plain'
+                match
               end
             else
               match
@@ -82,12 +72,14 @@ module Jekyll
           content
         end
 
-        # Restore protected WebAwesome example blocks after WaElementTransformer processing
+        # Restore protected code blocks using Markawesome::CodeBlockProtector,
+        # then clear the per-page token map so the next page starts fresh.
+        # CodeBlockProtector.protect always restarts its counter at 0, so
+        # clearing between pages prevents placeholder-id collisions.
         def restore_protected_blocks(content)
-          @@protected_blocks.each do |placeholder, original_block|
-            content = content.gsub(placeholder, original_block)
-          end
-          content
+          restored = Markawesome::CodeBlockProtector.restore(content, @protected_blocks)
+          @protected_blocks.clear
+          restored
         end
 
         def process(content)
@@ -95,15 +87,11 @@ module Jekyll
         end
       end
 
-      # Register hooks directly in the transformer module
-      # Wrapped in conditional to prevent errors when Jekyll::Hooks is not fully loaded
       if defined?(Jekyll::Hooks)
-        # Clear protected blocks at start of build
         Jekyll::Hooks.register :site, :pre_render do |_site|
           CodeBlockTransformer.clear_protected_blocks
         end
 
-        # STEP 1: Protect all code blocks BEFORE any transformations (highest priority)
         Jekyll::Hooks.register :documents, :pre_render, priority: 50 do |document|
           next unless document.relative_path =~ /.*\.md$/i
           next unless CodeBlockTransformer.transform_documents_enabled?(document.site)
@@ -120,8 +108,6 @@ module Jekyll
           page.content = CodeBlockTransformer.protect_all_code_blocks(page.content)
         end
 
-        # STEP 2: Transform protected code blocks to Jekyll highlight syntax
-        # This happens AFTER WebAwesome transformers (priority 20) but BEFORE restoration
         Jekyll::Hooks.register :documents, :pre_render, priority: 15 do |document|
           next unless document.relative_path =~ /.*\.md$/i
           next unless CodeBlockTransformer.transform_documents_enabled?(document.site)
@@ -138,7 +124,6 @@ module Jekyll
           page.content = CodeBlockTransformer.transform_code_blocks(page.content)
         end
 
-        # STEP 3: Restore protected blocks after transformation (lowest priority)
         Jekyll::Hooks.register :documents, :pre_render, priority: 10 do |document|
           next unless document.relative_path =~ /.*\.md$/i
           next unless CodeBlockTransformer.transform_documents_enabled?(document.site)

data/lib/jekyll/webawesome/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   module WebAwesome
-    VERSION = '0.14.0'
+    VERSION = '0.16.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-webawesome
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.16.0
 platform: ruby
 authors:
 - Janne Waren
@@ -35,14 +35,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement