Initial release of Jekyll Fast Reader
Key Features
- Build-Time Word Anchoring: Bolds the opening characters of each word directly in your rendered HTML — no client-side JavaScript required for the reading effect itself.
- Zero Template Changes: Install the gem, add it to
plugins, and build. The stylesheet is injected into<head>automatically. - Flexible Targeting
- Process entire collections via
fast_reader.collections, with per-collection options. - Opt any single page or document in or out with
fast_reader: true/falsein Front Matter. - Skip individual elements with
data-fr-skip, or globally viaexclude_selectors.
- Process entire collections via
- Smart Tokenization: Skips stop words, digits, and non-Latin tokens; anchor length scales with word length.
- Runtime Toggle (optional): A CSP-safe floating button (with Alt+Shift+B shortcut) flips the effect on/off and persists the choice in
localStorage. Supports both default-on and opt-in modes. - Liquid Filters:
reading_time,word_count, andfast_readerfor excerpts, headings, or any plain string. - Accessibility Built In: Respects
prefers-reduced-motion, resets anchors when printing, and advertises the keyboard shortcut viaaria-keyshortcuts.
Requirements
- Ruby >= 2.7.0
- Jekyll >= 4.0, < 5.0
Links
Note: v0.1.0 was yanked from RubyGems shortly after publication due to a packaging metadata issue. v0.1.1 is functionally identical.