jekyll-gfm-admonitions 1.0.1 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 75cc2a5cd4eaf0017bf2a47ca438f1be25b4a20212faf13e3e40f048ec263cb4
-  data.tar.gz: 274fe45c83097424b627c66d721c68760298f6e2413b361d0f87cb0d62cc6462
+  metadata.gz: 8c856c5c80e38dd3778962e1387a3274a44466bf18a1b2eb80d52ad6249e724b
+  data.tar.gz: e7b5ec263f858813126b9b166192f8fd904971132923212aa245d334fd047a33
 SHA512:
-  metadata.gz: 10967a4046bd913e5611421e3fb5d2d2253fde61161b588af2c294ad79340e53143a83390590b1a7252c616df73f3e3ba7991e1f4646731d045af7960c0592bd
-  data.tar.gz: 50fc8c02dc6b000e4824bd60da24b1f324289b83784d8e6e870879eaeb65d887916e142bbb5daaf232d15617483046ac4009821e163bb3f76a83303dd7d04840
+  metadata.gz: e32f87292a299bdcb8e205596d22f4a894ab119fdcc1b8f95a90d8a156be1b1939903d9319b206ca180222ed55bdfd4b745ff5b690a693fead05b5d982ee77fc
+  data.tar.gz: df9cb535ee7125500ae0198de79567206a8f9ef69af92e58222d77395c558d524b37536c95c57fc84807081afb82ccdc4a7614771307c6b928d75567d4f55a2a

data/LICENSE.txt

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2024 Robin De Schepper
-
-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.
+MIT License
+
+Copyright (c) 2024 Robin De Schepper
+
+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

@@ -8,47 +8,50 @@ blocks for notes, warnings, tips, cautions, and important messages.
 
 The following admonitions are supported:
 
-- **Important**: `> [!IMPORTANT]`
-- **Note**: `> [!NOTE]`
-- **Tip**: `> [!TIP]`
-- **Warning**: `> [!WARNING]`
-- **Caution**: `> [!CAUTION]`
+| **Type**      | **Markdown**          |
+|---------------|-----------------------|
+| Note          | `> [!NOTE]`           |
+| Tip           | `> [!TIP]`            |
+| Important     | `> [!IMPORTANT]`      |
+| Warning       | `> [!WARNING]`        |
+| Caution       | `> [!CAUTION]`        |
+
 
 ### Example Usage
 
 To use admonitions in your markdown files, simply add the following syntax:
 
 ```markdown
-> [!IMPORTANT]
-> This is an **important** message.
-
-> [!NOTE]
-> This is a **note**.
+> [!NOTE]  
+> Highlights information that users should take into account, even when skimming.
 
 > [!TIP]
-> This is a **helpful** tip.
+> Optional information to help a user be more successful.
 
-> [!WARNING]
-> This is a **warning**.
+> [!IMPORTANT]  
+> Crucial information necessary for users to succeed.
+
+> [!WARNING]  
+> Critical content demanding immediate user attention due to potential risks.
 
 > [!CAUTION]
-> This is a **caution** message.
+> Negative potential consequences of an action.
 ```
 
-> [!IMPORTANT]
-> This is an **important** message.
-
-> [!NOTE]
-> This is a **note**.
+> [!NOTE]  
+> Highlights information that users should take into account, even when skimming.
 
 > [!TIP]
-> This is a **helpful** tip.
+> Optional information to help a user be more successful.
 
-> [!WARNING]
-> This is a **warning**.
+> [!IMPORTANT]  
+> Crucial information necessary for users to succeed.
+
+> [!WARNING]  
+> Critical content demanding immediate user attention due to potential risks.
 
 > [!CAUTION]
-> This is a **caution** message.
+> Negative potential consequences of an action.
 
 ## Installation
 
@@ -61,16 +64,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 +80,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 +153,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/assets/admonitions.css

@@ -1,73 +1,69 @@
-.markdown-alert {
-    padding: 0.5rem 1rem;
-    margin-bottom: 1rem;
-    color: inherit;
-    border-left: .25em solid #30363d;
-}
-
-.markdown-body .markdown-alert > :first-child {
-    margin-top: 0;
-}
-
-.markdown-body .markdown-alert > :last-child {
-    margin-bottom: 0;
-}
-
-.markdown-body .markdown-alert .markdown-alert-title {
-    display: flex;
-    font-weight: 500;
-    align-items: center;
-    line-height: 1;
-}
-
-.markdown-body .markdown-alert svg {
-    margin-right: 0.5rem !important;
-}
-
-.markdown-body .markdown-alert svg path {
-    fill: currentColor;
-}
-
-.markdown-body .markdown-alert.markdown-alert-note {
-    border-left-color: #4493f8;
-}
-
-.markdown-body .markdown-alert.markdown-alert-note .markdown-alert-title {
-    color: #4493f8;
-}
-
-.markdown-body .markdown-alert.markdown-alert-important {
-    border-left-color: #ab7df8;
-}
-
-.markdown-body .markdown-alert.markdown-alert-important .markdown-alert-title {
-    color: #ab7df8;
-}
-
-.markdown-body .markdown-alert.markdown-alert-warning {
-    border-left-color: #9e6a03;
-}
-
-.markdown-body .markdown-alert.markdown-alert-warning .markdown-alert-title {
-    color: #d29922;
-}
-
-.markdown-body .markdown-alert.markdown-alert-tip {
-    border-left-color: #238636;
-}
-
-.markdown-body .markdown-alert.markdown-alert-tip .markdown-alert-title {
-    color: #3fb950;
-}
-
-.markdown-body .markdown-alert.markdown-alert-caution {
-    border-left-color: #da3633;
-}
-
-.markdown-body .markdown-alert.markdown-alert-caution .markdown-alert-title {
-    color: #f85149;
-}
-
-.markdown-body > :first-child > .heading-element:first-child {
-    margin-top: 0 !important;
+.markdown-alert {
+    padding: 0.5rem 1rem;
+    margin-bottom: 1rem;
+    color: inherit;
+    border-left: .25em solid #30363d;
+}
+
+.markdown-alert > :first-child {
+    margin-top: 0;
+}
+
+.markdown-alert > :last-child {
+    margin-bottom: 0;
+}
+
+.markdown-alert .markdown-alert-title {
+    display: flex;
+    font-weight: 500;
+    align-items: center;
+    line-height: 1;
+}
+
+.markdown-alert svg {
+    margin-right: 0.5rem !important;
+}
+
+.markdown-alert svg path {
+    fill: currentColor;
+}
+
+.markdown-alert.markdown-alert-note {
+    border-left-color: #4493f8;
+}
+
+.markdown-alert.markdown-alert-note .markdown-alert-title {
+    color: #4493f8;
+}
+
+.markdown-alert.markdown-alert-important {
+    border-left-color: #ab7df8;
+}
+
+.markdown-alert.markdown-alert-important .markdown-alert-title {
+    color: #ab7df8;
+}
+
+.markdown-alert.markdown-alert-warning {
+    border-left-color: #9e6a03;
+}
+
+.markdown-alert.markdown-alert-warning .markdown-alert-title {
+    color: #d29922;
+}
+
+.markdown-alert.markdown-alert-tip {
+    border-left-color: #238636;
+}
+
+.markdown-alert.markdown-alert-tip .markdown-alert-title {
+    color: #3fb950;
+}
+
+.markdown-alert.markdown-alert-caution {
+    border-left-color: #da3633;
+}
+
+.markdown-alert.markdown-alert-caution .markdown-alert-title {
+    color: #f85149;
 }

data/lib/jekyll-gfm-admonitions.rb

@@ -1,120 +1,131 @@
-# frozen_string_literal: true
-
-require 'octicons'
-require 'cssminify'
-require 'liquid/template'
-
-ADMONITION_ICONS = {
-  'important' => 'report',
-  'note' => 'info',
-  'tip' => 'light-bulb',
-  'warning' => 'alert',
-  'caution' => 'stop'
-}.freeze
-
-# JekyllGFMAdmonitions is a module that provides functionality to process and
-# convert GitHub-flavored markdown admonitions into HTML within Jekyll.
-module JekyllGFMAdmonitions
-  # GFMAdmonitionConverter is a Jekyll generator that converts custom
-  # admonition blocks in markdown (e.g., `> [!IMPORTANT]`) into styled HTML
-  # alert boxes with icons.
-  #
-  # This generator processes both posts and pages, replacing admonition
-  # syntax with HTML markup that includes appropriate iconography and CSS styling.
-  class GFMAdmonitionConverter < Jekyll::Generator
-    safe true
-    priority :lowest
-    @@admonition_pages = []
-
-    def initialize(*args)
-      super(*args)
-      @converted = 0
-    end
-
-    def generate(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
-
-      # Process admonitions in posts
-      site.posts.docs.each do |doc|
-        Jekyll.logger.debug 'GFMA:', "Processing post '#{doc.path}' (#{doc.content.length} characters)."
-        process(doc)
-      end
-
-      # Process admonitions in pages
-      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)
-      end
-
-      Jekyll.logger.info 'GFMA:', "Converted adminitions in #{@converted} file(s)."
-    end
-
-    def process(doc)
-      original_content = doc.content.dup
-      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
-
-    def self.admonition_pages
-      return @@admonition_pages
-    end
-
-    def convert_admonitions(doc)
-      code_blocks = []
-      # 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
-        text = ::Regexp.last_match(2).gsub(/^>\s*/, '').strip
-        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]
-      end
-    end
-  end
-
-  # 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)."
-
-    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.gsub!(/<head>(.*?)<\/head>/m) do |match|
-        "#{match[0..-7]}<style>#{CSSminify.compress(css)}</style>#{match[-7..-1]}"
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+require 'octicons'
+require 'cssminify'
+require 'liquid/template'
+
+ADMONITION_ICONS = {
+  'important' => 'report',
+  'note' => 'info',
+  'tip' => 'light-bulb',
+  'warning' => 'alert',
+  'caution' => 'stop'
+}.freeze
+
+# JekyllGFMAdmonitions is a module that provides functionality to process and
+# convert GitHub-flavored markdown admonitions into HTML within Jekyll.
+module JekyllGFMAdmonitions
+  # GFMAdmonitionConverter is a Jekyll generator that converts custom
+  # admonition blocks in markdown (e.g., `> [!IMPORTANT]`) into styled HTML
+  # alert boxes with icons.
+  #
+  # This generator processes both posts and pages, replacing admonition
+  # syntax with HTML markup that includes appropriate iconography and CSS styling.
+  class GFMAdmonitionConverter < Jekyll::Generator
+    safe true
+    priority :lowest
+    @admonition_pages = []
+
+    class << self
+      attr_reader :admonition_pages
+    end
+
+
+    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 init_converter(site)
+      @markdown = site.converters.find { |c| c.is_a?(Jekyll::Converters::Markdown) }
+      return if @markdown
+
+      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(doc)
+      end
+    end
+
+    def process_pages(site)
+      site.pages.each do |page|
+        Jekyll.logger.debug 'GFMA:', "Processing page '#{page.path}' (#{page.content.length} characters)."
+        process_doc_content(page)
+      end
+    end
+
+    def process_doc_content(doc)
+      original_content = doc.content.dup
+      process_doc(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)
+      self.class.admonition_pages << doc
+    end
+
+    def process_doc(doc)
+      code_blocks = []
+      # 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
+        text = ::Regexp.last_match(2).gsub(/^>\s*/, '').strip
+        icon = Octicons::Octicon.new(ADMONITION_ICONS[type]).to_svg
+        Jekyll.logger.debug 'GFMA:', "Converting #{type} admonition."
+
+        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
+  end
+
+  # 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)."
+
+    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.gsub!(%r{<head>(.*?)</head>}m) do |match|
+        "#{match[0..-7]}<style>#{CSSminify.compress(css)}</style>#{match[-7..]}"
+      end
+
+      # If no <head> tag is found, insert the CSS at the start of the output
+      if !page.output.match(%r{<head>(.*?)</head>}m)
+        Jekyll.logger.debug 'GFMA:', "No <head> tag found in '#{page.path}', inserting CSS at the beginning of the page."
+        page.output = "<head><style>#{CSSminify.compress(css)}</style></head>" + page.output
+      end
+    end
+  end
+end

metadata

@@ -1,43 +1,49 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-gfm-admonitions
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.3
 platform: ruby
 authors:
 - Robin De Schepper
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-28 00:00:00.000000000 Z
+date: 2025-01-01 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'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.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::Version
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: octicons
   requirement: !ruby/object:Gem::Requirement
@@ -97,7 +103,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.20
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: A Jekyll plugin to render GitHub-flavored admonitions.