jekyll-gfm-admonitions 1.0.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36fde0cfed94f6d07ba07bb23551ddfb045ba9a1d587811a78b6be9407bc4ad9
-  data.tar.gz: efcf212c70ccffeb7f4d834445adec477d2c748e15e2408ea94782bbee70852d
+  metadata.gz: 6e430262ea2a0d62b88656fc9d61a244f4840e6ae0a67699440f64c129671c98
+  data.tar.gz: 580f689cdf7e6072108a039164198ef17dd32e160879d7fdfc0ffe7dcce24ac6
 SHA512:
-  metadata.gz: 230a0a16955e61fd32809530db0ca343730d9ce366f89416696ca5d8f85843f824121bfa3ab816aa5c264b9761aff3b3d1eabfa72264154b748a5fdaf4121c2e
-  data.tar.gz: 2c4b40928769e81341fc9961e0a8b8c6a55c02d492e1ac93d9db6ba38912a8ba09a0c0a3c16448bf69d292282b1ccf3a2a3e837bd80287db5fe25cdb34b4b2d4
+  metadata.gz: 27109d0a6495fbec17fd52b46872362a3fa056832e5faa16a8837b77c4f4596c0177a08c9f53e020312370046530d9afd7f80bdaa7315245c30b9235ffd59bbc
+  data.tar.gz: eae65a1558f810cdd52d8af2b5cc91d8acfc210ae6cf5380f9047766baa94aff5961c20084793c486cb612100b7bd4aa621e3024adfe48878404b737b1d5f115

data/README.md

@@ -61,16 +61,9 @@ group :jekyll_plugins do
    
    # ... Add this line:
    gem "jekyll-gfm-admonitions"
-   gem "jekyll-optional-front-matter"
 end
 ```
 
-> [!TIP]
-> 
-> By installing `jekyll-optional-front-matter` alongside this package, you won't need to
-> add ([visible](https://github.com/github/markup/issues/994)) frontmatter headers to each
-> of your files.
-
 Then run:
 
 ```bash
@@ -84,7 +77,6 @@ Next, you need to enable the plugin in your Jekyll configuration file (`_config.
 ```yaml
 plugins:
   - jekyll-gfm-admonitions
-  - jekyll-optional-front-matter
 ```
 
 Then, during `build`/`serve`, you should see logs similar to:
@@ -158,28 +150,6 @@ end
 gem 'jekyll-remote-theme'
 ```
 
-### Add [front matter](https://jekyllrb.com/docs/front-matter/)
-
-This step is optional if you've added `jekyll-front-matter`. If you do not, any file
-without a front matter header will be ignored by Jekyll, and only partially included by
-the GitHub Pages plugin.
-
-Make sure that all your `.md` files begin with a valid front matter header:
-
-```markdown
----
----
-
-Your markdown files should start like this.
-```
-
-> [!IMPORTANT]
-> 
-> Your root `README.md` front matter should contain the following `permalink` attribute:
-> ```yaml
-> permalink: /index.html
-> ```
-
 ## License
 
 This project is licensed under the MIT License. See the [LICENSE.txt](LICENSE.txt) file

data/lib/jekyll-gfm-admonitions.rb

@@ -23,60 +23,72 @@ module JekyllGFMAdmonitions
   # syntax with HTML markup that includes appropriate iconography and CSS styling.
   class GFMAdmonitionConverter < Jekyll::Generator
     safe true
-    @@admonition_pages = []
+    priority :lowest
+    @admonition_pages = []
 
-    def initialize(*args)
-      super(*args)
-      @converted = 0
+    def generate(site)
+      init_converter(site)
+      process_posts(site)
+      process_pages(site)
+      Jekyll.logger.info 'GFMA:', 'Converted adminitions in' \
+        " #{self.class.admonition_pages.length} file(s)."
     end
 
-    def generate(site)
+    def init_converter(site)
       @markdown = site.converters.find { |c| c.is_a?(Jekyll::Converters::Markdown) }
-      unless @markdown
-        raise "Markdown converter not found. Please ensure that you have a markdown converter configured in your Jekyll site."
-      end
+      return if @markdown
 
-      # Process admonitions in posts
+      raise 'Markdown converter not found. Please ensure that you have a markdown' \
+              ' converter configured in your Jekyll site.'
+    end
+
+    def process_posts(site)
       site.posts.docs.each do |doc|
         Jekyll.logger.debug 'GFMA:', "Processing post '#{doc.path}' (#{doc.content.length} characters)."
-        process(doc)
+        process_doc(doc)
       end
+    end
 
-      # Process admonitions in pages
+    def process_pages(site)
       site.pages.each do |page|
-        # Patch the root README for GitHub Pages builds
-        if page.path == 'README.md' && page.dir == '/'
-          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)
+        process_doc_content(page)
       end
-
-      Jekyll.logger.info 'GFMA:', "Converted adminitions in #{@converted} file(s)."
     end
 
-    def process(doc)
+    def process_doc_content(doc)
       original_content = doc.content.dup
-      convert_admonitions(doc)
+      process_doc(doc)
 
       return unless doc.content != original_content
 
-      @@admonition_pages << doc
-      @converted += 1
+      # Store a reference to all the pages we modified, to inject the CSS post render
+      # (otherwise GitHub Pages sanitizes the CSS into plaintext)
+      self.class.admonition_pages << doc
     end
 
-    def self.admonition_pages
-      return @@admonition_pages
+    class << self
+      attr_reader :admonition_pages
     end
 
-    def convert_admonitions(doc)
+    def process_doc(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
 
+      convert_admonitions(doc)
+
+      # Put the code blocks back in place
+      doc.content.gsub!(/```\{\{CODE_BLOCK_(\d+)}}```/) do
+        code_blocks[::Regexp.last_match(1).to_i]
+      end
+    end
+
+    def convert_admonitions(doc)
       doc.content.gsub!(/>\s*\[!(IMPORTANT|NOTE|WARNING|TIP|CAUTION)\]\s*\n((?:>.*\n?)*)/) do
         type = ::Regexp.last_match(1).downcase
         title = type.capitalize
@@ -84,26 +96,29 @@ module JekyllGFMAdmonitions
         icon = Octicons::Octicon.new(ADMONITION_ICONS[type]).to_svg
         Jekyll.logger.debug 'GFMA:', "Converting #{type} admonition."
 
-        "<div class='markdown-alert markdown-alert-#{type}'>
+        admonition_html(type, title, text, icon)
+      end
+    end
+
+    def admonition_html(type, title, text, icon)
+      "<div class='markdown-alert markdown-alert-#{type}'>
           <p class='markdown-alert-title'>#{icon} #{title}</p>
           <p>#{@markdown.convert(text)}</p>
         </div>\n\n"
-      end
-
-      doc.content.gsub!(/```\{\{CODE_BLOCK_(\d+)}}```/) do
-        "```#{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!(%r{<head>(.*?)</head>}m) do |match|
+        "#{match[0..-7]}<style>#{CSSminify.compress(css)}</style>#{match[-7..]}"
+      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.2
 platform: ruby
 authors:
 - Robin De Schepper
@@ -11,33 +11,33 @@ cert_chain: []
 date: 2024-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: jekyll
+  name: cssminify
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: cssminify
+  name: jekyll
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: octicons
   requirement: !ruby/object:Gem::Requirement