jekyll-smart-reading-time 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: aa31644aaebee41f97dc831c82d9b73af771d5ea675ed3a097ff4fa5da30974a
+  data.tar.gz: 3cca14536c0a78344b609ed0abef31c60051d2d096869e11e104cbcf82233dea
+SHA512:
+  metadata.gz: d33553d2dd8ca3dc7a0c109d663142ba0496107f5b7a93c7ab5735ad3bcb35e226dbb5f483a173051c3aa6fcdf3e7d7c4a9bbb1bf91195186398af23d9114c43
+  data.tar.gz: e08136b9fbd990037a2e1e292f0f5bd64c09b1e9eabcd3d018b5b61178dc18bb2aa0b49be4903b1ee4f67ee7c79e63ab13865b4c77d7bac39974aa61a15c7b9f

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 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,88 @@
+# jekyll-smart-reading-time
+
+Smart reading time estimation for Jekyll — strips code blocks before counting.
+
+[![Gem Version](https://badge.fury.io/rb/jekyll-smart-reading-time.svg)](https://badge.fury.io/rb/jekyll-smart-reading-time)
+
+Most existing Jekyll reading-time gems are abandoned and count everything — including
+hundreds of lines of code samples — as prose. This gem strips fenced code blocks,
+indented code blocks, HTML tags, and Liquid tags before counting words, so the
+estimate actually reflects reading time for your *content*.
+
+## Why not the others?
+
+| Gem | Last release | Strips code? |
+|-----|-------------|--------------|
+| `jekyll-smart-reading-time` (this gem) | 2025 | ✅ Yes |
+| `jekyll-timetoread` | 2014 | ❌ No |
+| `reading_time` | 2013 | ❌ No |
+
+## Installation
+
+Add to your site's `Gemfile`:
+
+```ruby
+gem "jekyll-smart-reading-time"
+```
+
+Then add to `_config.yml`:
+
+```yaml
+plugins:
+  - jekyll-smart-reading-time
+```
+
+Run:
+
+```bash
+bundle install
+```
+
+## Usage
+
+### In templates (recommended)
+
+The gem automatically injects `page.reading_time` into every post and page:
+
+```liquid
+{{ page.reading_time }} min read
+```
+
+Example in a post layout:
+
+```html
+<span class="reading-time">{{ page.reading_time }} min read</span>
+```
+
+### Liquid tag
+
+You can also use the `{% reading_time %}` tag, which renders `"X min read"` directly:
+
+```liquid
+{% reading_time %}
+```
+
+## Configuration
+
+Override the default 238 WPM in `_config.yml`:
+
+```yaml
+reading_time:
+  wpm: 200
+```
+
+The default of **238 WPM** is drawn from [research on average adult reading speed](https://journals.sagepub.com/doi/10.1177/0956797617738271).
+
+## What gets stripped
+
+Before counting words, the following are removed:
+
+1. YAML frontmatter (`---` blocks)
+2. Fenced code blocks (`` ``` ... ``` ``)
+3. Indented code blocks (lines starting with 4+ spaces or a tab)
+4. HTML tags (`<...>`)
+5. Liquid tags (`{{ ... }}` and `{% ... %}`)
+
+## License
+
+[MIT](LICENSE.txt) © 2025 Jason Chance

data/lib/jekyll/reading_time_generator.rb

@@ -0,0 +1,55 @@
+require "jekyll"
+
+module Jekyll
+  # Generator that injects `page.reading_time` (integer minutes) into every
+  # post and page before Jekyll renders them.
+  class ReadingTimeGenerator < Jekyll::Generator
+    priority :low
+
+    def generate(site)
+      wpm = site.config.dig("reading_time", "wpm") || 238
+
+      all_docs = site.posts.docs + site.pages
+      site.collections.each_value { |col| all_docs += col.docs unless col.label == "posts" }
+      all_docs.each do |doc|
+        next unless doc.respond_to?(:content) && doc.content
+        doc.data["reading_time"] = reading_time(doc.content, wpm)
+      end
+    end
+
+    private
+
+    def reading_time(content, wpm = 238)
+      text = content.dup
+
+      # 1. Strip YAML frontmatter
+      text.gsub!(/\A---.*?---\s*/m, "")
+
+      # 2. Strip fenced code blocks (``` ... ```)
+      text.gsub!(/```.*?```/m, "")
+
+      # 3. Strip indented code blocks (lines starting with 4+ spaces or a tab)
+      text.gsub!(/^( {4,}|\t).*$/, "")
+
+      # 4. Strip HTML tags
+      text.gsub!(/<[^>]+>/, "")
+
+      # 5. Strip Liquid tags ({% ... %} and {{ ... }})
+      text.gsub!(/\{[{%].*?[%}]\}/m, "")
+
+      words = text.split.length
+      [[(words / wpm.to_f).ceil, 1].max, 1].max
+    end
+  end
+
+  # Liquid tag: {% reading_time %} — renders "X min read" for the current page.
+  class ReadingTimeTag < Liquid::Tag
+    def render(context)
+      page = context["page"]
+      minutes = page && page["reading_time"]
+      minutes ? "#{minutes} min read" : "1 min read"
+    end
+  end
+end
+
+Liquid::Template.register_tag("reading_time", Jekyll::ReadingTimeTag)

data/lib/jekyll-smart-reading-time/version.rb

@@ -0,0 +1,5 @@
+module Jekyll
+  module SmartReadingTime
+    VERSION = "0.1.1"
+  end
+end

data/lib/jekyll-smart-reading-time.rb

@@ -0,0 +1,2 @@
+require "jekyll-smart-reading-time/version"
+require "jekyll/reading_time_generator"

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-smart-reading-time
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Jason Chance
+bindir: bin
+cert_chain: []
+date: 2026-08-21 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'
+description: Injects page.reading_time into every Jekyll post and page. Strips fenced
+  code blocks, indented code, HTML tags, and Liquid tags before counting words at
+  238 WPM (configurable).
+email:
+- jason@jasonchance.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/jekyll-smart-reading-time.rb
+- lib/jekyll-smart-reading-time/version.rb
+- lib/jekyll/reading_time_generator.rb
+homepage: https://github.com/jchance/jekyll-smart-reading-time
+licenses:
+- MIT
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: Smart reading time estimation for Jekyll — strips code blocks before counting.
+test_files: []