jekyll-callout 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cae7be1da3b75b5c2fb8034baa6a7ea5ecf4e0abc398d698d8034f3be1bc2ade
+  data.tar.gz: 660d6ef03b54b3d7beeaa6fe4c3f83f2fa1db1eec8032cf343abdf1c4b3b2a35
+SHA512:
+  metadata.gz: e24b16f5e099db766c4ccc2a8314d4b799845210f476664dda3bc2b84df319bbca1df2d44a5fa0ececcf7f9d7c673d581723618b9770eb15af2a0233ef7daada
+  data.tar.gz: ef0373bd49dc68b8ab121255b0c4fe346674e2b7f16e657c2e20c92df19b0d494c73619629fbef03fa927ac17d779e08ed7db53cf95a5549d26f656995150133

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Changelog
+
+## [0.1.0] - 2026-08-20
+
+### Added
+- Initial release
+- `{% callout TYPE %}...{% endcallout %}` Liquid block tag
+- Supported types: `note`, `tip`, `warning`, `danger`, `info`
+- Optional custom title: `{% callout warning "Before You Deploy" %}`
+- Markdown rendering inside callout body via kramdown
+- BEM-style output classes: `callout`, `callout--TYPE`, `callout__title`, `callout__body`

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Jason Chance
+
+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

@@ -0,0 +1,109 @@
+# jekyll-callout
+
+A Jekyll plugin that provides a `{% callout %}` Liquid block tag for styled callout and admonition blocks. Content inside the block renders as Markdown.
+
+## Installation
+
+Add to your `Gemfile`:
+
+```ruby
+gem "jekyll-callout", "~> 0.1"
+```
+
+Add to your `_config.yml`:
+
+```yaml
+plugins:
+  - jekyll-callout
+```
+
+Then run:
+
+```
+bundle install
+```
+
+## Usage
+
+**Basic callout:**
+
+```liquid
+{% callout note %}
+This is a **note** with Markdown support.
+{% endcallout %}
+```
+
+**With a custom title:**
+
+```liquid
+{% callout warning "Before You Deploy" %}
+Make sure you've run the full test suite.
+{% endcallout %}
+```
+
+**Supported types:** `note`, `tip`, `warning`, `danger`, `info`
+
+```liquid
+{% callout note %}...{% endcallout %}
+{% callout tip %}...{% endcallout %}
+{% callout warning %}...{% endcallout %}
+{% callout danger %}...{% endcallout %}
+{% callout info %}...{% endcallout %}
+```
+
+Omitting the type defaults to `note`.
+
+## Output HTML
+
+```html
+<div class="callout callout--warning">
+  <div class="callout__title">Warning</div>
+  <div class="callout__body">
+    <p>Make sure you've run the full test suite.</p>
+  </div>
+</div>
+```
+
+## Default Titles
+
+| Type | Default Title |
+|---|---|
+| `note` | Note |
+| `tip` | Tip |
+| `warning` | Warning |
+| `danger` | Danger |
+| `info` | Info |
+
+## Styling
+
+The plugin outputs unstyled BEM-classed markup. Add your own CSS. Here's a minimal starting point:
+
+```css
+.callout {
+  padding: 1rem 1.25rem;
+  border-left: 4px solid #ccc;
+  margin-bottom: 1.5rem;
+  background: #f9f9f9;
+}
+
+.callout--note    { border-color: #5b8dee; background: #eef3fd; }
+.callout--tip     { border-color: #28a745; background: #eafaf1; }
+.callout--warning { border-color: #ffc107; background: #fffbea; }
+.callout--danger  { border-color: #dc3545; background: #fdf2f2; }
+.callout--info    { border-color: #17a2b8; background: #e8f7f9; }
+
+.callout__title {
+  font-weight: bold;
+  margin-bottom: 0.4rem;
+}
+
+.callout__body > *:last-child {
+  margin-bottom: 0;
+}
+```
+
+No styles are injected by the plugin — all visual design belongs in your site's CSS.
+
+## License
+
+MIT — see [LICENSE.txt](LICENSE.txt).

data/lib/jekyll/callout_tag.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require "kramdown"
+require "liquid"
+
+module Jekyll
+  class CalloutBlock < Liquid::Block
+    VALID_TYPES = %w[note tip warning danger info].freeze
+
+    DEFAULT_TITLES = {
+      "note"    => "Note",
+      "tip"     => "Tip",
+      "warning" => "Warning",
+      "danger"  => "Danger",
+      "info"    => "Info"
+    }.freeze
+
+    def initialize(tag_name, markup, tokens)
+      super
+      @type, @title = parse_markup(markup.strip)
+    end
+
+    def render(context)
+      raw_content = super
+      rendered_body = Kramdown::Document.new(raw_content.strip).to_html.strip
+
+      title_html = if @title && !@title.empty?
+        "  <div class=\"callout__title\">#{@title}</div>\n"
+      else
+        ""
+      end
+
+      <<~HTML.strip
+        <div class="callout callout--#{@type}">
+        #{title_html}  <div class="callout__body">
+          #{rendered_body}
+          </div>
+        </div>
+      HTML
+    end
+
+    private
+
+    def parse_markup(markup)
+      # Match: type optionally followed by quoted title
+      # e.g. `warning` or `warning "Before You Deploy"` or `warning 'title'`
+      if (m = markup.match(/\A(\w+)(?:\s+"([^"]*)"|\s+'([^']*)')?\z/))
+        type  = m[1].downcase
+        title = m[2] || m[3]
+
+        unless VALID_TYPES.include?(type)
+          warn "jekyll-callout: Unknown type '#{type}', falling back to 'note'"
+          type = "note"
+        end
+
+        title ||= DEFAULT_TITLES[type]
+        [type, title]
+      else
+        ["note", DEFAULT_TITLES["note"]]
+      end
+    end
+  end
+end
+
+Liquid::Template.register_tag("callout", Jekyll::CalloutBlock)

data/lib/jekyll-callout.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "jekyll/callout_tag"

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-callout
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jason Chance
+bindir: bin
+cert_chain: []
+date: 2026-08-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: jekyll-callout provides a {% callout TYPE %} Liquid block tag that wraps
+  content in BEM-classed callout divs. Supports note, tip, warning, danger, and info
+  types. Content renders as Markdown.
+email:
+- jason@jasonchance.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/jekyll-callout.rb
+- lib/jekyll/callout_tag.rb
+homepage: https://jasonchance.com/projects/jekyll-callout/
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://jasonchance.com/projects/jekyll-callout/
+  source_code_uri: https://github.com/jchance/jekyll-callout
+  bug_tracker_uri: https://github.com/jchance/jekyll-callout/issues
+  changelog_uri: https://github.com/jchance/jekyll-callout/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: A Jekyll plugin that provides a {% callout %} Liquid block tag for styled
+  callout/admonition blocks.
+test_files: []