jekyll-gfm-admonitions 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36fde0cfed94f6d07ba07bb23551ddfb045ba9a1d587811a78b6be9407bc4ad9
-  data.tar.gz: efcf212c70ccffeb7f4d834445adec477d2c748e15e2408ea94782bbee70852d
+  metadata.gz: 75cc2a5cd4eaf0017bf2a47ca438f1be25b4a20212faf13e3e40f048ec263cb4
+  data.tar.gz: 274fe45c83097424b627c66d721c68760298f6e2413b361d0f87cb0d62cc6462
 SHA512:
-  metadata.gz: 230a0a16955e61fd32809530db0ca343730d9ce366f89416696ca5d8f85843f824121bfa3ab816aa5c264b9761aff3b3d1eabfa72264154b748a5fdaf4121c2e
-  data.tar.gz: 2c4b40928769e81341fc9961e0a8b8c6a55c02d492e1ac93d9db6ba38912a8ba09a0c0a3c16448bf69d292282b1ccf3a2a3e837bd80287db5fe25cdb34b4b2d4
+  metadata.gz: 10967a4046bd913e5611421e3fb5d2d2253fde61161b588af2c294ad79340e53143a83390590b1a7252c616df73f3e3ba7991e1f4646731d045af7960c0592bd
+  data.tar.gz: 50fc8c02dc6b000e4824bd60da24b1f324289b83784d8e6e870879eaeb65d887916e142bbb5daaf232d15617483046ac4009821e163bb3f76a83303dd7d04840

data/lib/jekyll-gfm-admonitions.rb

@@ -23,6 +23,7 @@ module JekyllGFMAdmonitions
   # syntax with HTML markup that includes appropriate iconography and CSS styling.
   class GFMAdmonitionConverter < Jekyll::Generator
     safe true
+    priority :lowest
     @@admonition_pages = []
 
     def initialize(*args)
@@ -49,6 +50,7 @@ module JekyllGFMAdmonitions
           Jekyll.logger.info 'GFMA:', "Patched /README.html to /index.html"
           page.instance_variable_set(:@url, '/index.html')
         end
+
         Jekyll.logger.debug 'GFMA:', "Processing page '#{page.path}' (#{page.content.length} characters)."
         process(page)
       end
@@ -61,7 +63,8 @@ module JekyllGFMAdmonitions
       convert_admonitions(doc)
 
       return unless doc.content != original_content
-
+      # Store a reference to all the pages we modified, to inject the CSS post render
+      # (otherwise GitHub Pages sanitizes the CSS into plaintext)
       @@admonition_pages << doc
       @converted += 1
     end
@@ -72,11 +75,14 @@ module JekyllGFMAdmonitions
 
     def convert_admonitions(doc)
       code_blocks = []
-      doc.content.gsub!(/```.*?```/m) do |match|
+      # Temporarily replace code blocks by a tag, so that we don't process any admonitions
+      # inside of code blocks.
+      doc.content.gsub!(/(?:^|\n)(?<!>)\s*```.*?```/m) do |match|
         code_blocks << match
         "```{{CODE_BLOCK_#{code_blocks.length - 1}}}```"
       end
 
+      # Match the admonition syntax
       doc.content.gsub!(/>\s*\[!(IMPORTANT|NOTE|WARNING|TIP|CAUTION)\]\s*\n((?:>.*\n?)*)/) do
         type = ::Regexp.last_match(1).downcase
         title = type.capitalize
@@ -84,26 +90,31 @@ module JekyllGFMAdmonitions
         icon = Octicons::Octicon.new(ADMONITION_ICONS[type]).to_svg
         Jekyll.logger.debug 'GFMA:', "Converting #{type} admonition."
 
+        # Replace them by the GFM admonition HTML
         "<div class='markdown-alert markdown-alert-#{type}'>
           <p class='markdown-alert-title'>#{icon} #{title}</p>
           <p>#{@markdown.convert(text)}</p>
         </div>\n\n"
       end
 
+      # Put the code blocks back in place
       doc.content.gsub!(/```\{\{CODE_BLOCK_(\d+)}}```/) do
-        "```#{code_blocks[$1.to_i]}```"
+        code_blocks[$1.to_i]
       end
     end
   end
 
-  Jekyll::Hooks.register :site, :post_render do |site|
-    Jekyll.logger.info 'GFMA:', "Injecting admonition CSS in #{GFMAdmonitionConverter.admonition_pages.length} page(s)."
+  # Insert the minified CSS before the closing head tag of all pages we put admonitions on
+  Jekyll::Hooks.register :site, :post_render do
+    Jekyll.logger.info 'GFMA:', "Inserting admonition CSS in #{GFMAdmonitionConverter.admonition_pages.length} page(s)."
 
-    for page in GFMAdmonitionConverter.admonition_pages do
+    GFMAdmonitionConverter.admonition_pages.each do |page|
       Jekyll.logger.debug 'GFMA:', "Appending admonition style to '#{page.path}'."
       css = File.read(File.expand_path('../assets/admonitions.css', __dir__))
 
-      page.output += "<style>#{CSSminify.compress(css)}</style>"
+      page.output.gsub!(/<head>(.*?)<\/head>/m) do |match|
+        "#{match[0..-7]}<style>#{CSSminify.compress(css)}</style>#{match[-7..-1]}"
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-gfm-admonitions
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Robin De Schepper