jekyll-pagefind 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1b9126064b930d58f4f4d2c7f3a3426431a7e8a28a173b566e4ed05a45affbc5
+  data.tar.gz: acad73057c0e4cc468b210617ad9580b357b16d8129fa6cf44e8ee48c7be2df5
+SHA512:
+  metadata.gz: f47f5071b76af118f567bec3dd3d01d58522a4a4220cc8fb4b815b2a5a18db8e3344149113ecd7b391dd5984290b422e324fb35f1434fed7468450234fedfaf2
+  data.tar.gz: b2e796c3a0ecf01f9e707805be75bda4ef29847b8bb0b610261e390f288376d116e88c64916d0fe1701839460b6ac806a7798e2cb31313faf3f44da1fc9f39d1

data/.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+  "cSpell.words": ["autorun"]
+}

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2026-05-14
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,10 @@
+# Code of Conduct
+
+"jekyll-pagefind" follows [The Ruby Community Conduct Guideline](https://www.ruby-lang.org/en/conduct) in all "collaborative space", which is defined as community communications channels (such as mailing lists, submitted patches, commit comments, etc.):
+
+* Participants will be tolerant of opposing views.
+* Participants must ensure that their language and actions are free of personal attacks and disparaging personal remarks.
+* When interpreting the words and actions of others, participants should always assume good intentions.
+* Behaviour which can be reasonably considered harassment will not be tolerated.
+
+If you have any concerns about behaviour within this project, please contact us at ["phothinmg@disroot.org"](mailto:"phothinmg@disroot.org").

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 phothinmg
+
+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,89 @@
+# jekyll-pagefind
+
+`jekyll-pagefind` is a Jekyll plugin that runs the Pagefind CLI after your site is written. It lets you keep search indexing as part of the normal Jekyll build instead of running a separate manual step.
+
+## Installation
+
+Add the gem to your site's Gemfile:
+
+```ruby
+gem "jekyll-pagefind"
+```
+
+Then install dependencies:
+
+```bash
+bundle install
+```
+
+Enable the plugin in your Jekyll configuration:
+
+```yml
+plugins:
+	- jekyll-pagefind
+```
+
+This plugin shells out to the Pagefind CLI, so make sure `pagefind` is installed and available on your system. For example:
+
+```bash
+npm install -g pagefind
+```
+
+## Usage
+
+With the plugin enabled, a normal Jekyll build will run Pagefind after the site output has been written:
+
+```bash
+bundle exec jekyll build
+```
+
+By default the plugin executes:
+
+```bash
+./pagefind --site _site
+```
+
+You can override the Pagefind executable location in `_config.yml`:
+
+```yml
+pagefind:
+	pf_location: /path/to/pagefind
+```
+
+That value is used to build the command:
+
+```bash
+/path/to/pagefind --site _site
+```
+
+## Development
+
+After checking out the repository, run:
+
+```bash
+bin/setup
+```
+
+To build the gem locally:
+
+```bash
+gem build jekyll-pagefind.gemspec
+```
+
+To install it into your local Ruby environment:
+
+```bash
+bundle exec rake install
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome at https://github.com/phothinmg/jekyll-pagefind.
+
+## License
+
+This project is available under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Please review [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) before contributing.

data/Rakefile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+require "rubocop/rake_task"
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << "lib"
+  test.libs << "test"
+  test.pattern = "test/**/*_test.rb"
+end
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/jekyll/pagefind/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Pagefind
+    VERSION = "0.1.0"
+  end
+end

data/lib/jekyll/pagefind.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "jekyll"
+require_relative "pagefind/version"
+
+module Jekyll
+  module Pagefind
+    class Error < StandardError; end
+
+    # Jekyll::Pagefind::PagefindGenerator
+    class PagefindGenerator < Jekyll::Generator
+      safe true
+      priority :lowest
+
+      def generate(site)
+        pf = site.config["pagefind"] || {}
+        pf_file = pf["pf_location"] || "./pagefind"
+        dest_dir = site.dest
+        Jekyll::Hooks.register :site, :post_write do |_site|
+          command = "#{pf_file} --site #{dest_dir}"
+          puts "Running: #{command}"
+          system(command)
+        end
+      end
+    end
+  end
+end

data/sig/jekyll/pagefind.rbs

@@ -0,0 +1,6 @@
+module Jekyll
+  module Pagefind
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

data/test/pagefind_generator_test.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require "minitest/autorun"
+require "jekyll"
+require_relative "../lib/jekyll/pagefind"
+
+module SystemCapture
+  class << self
+    attr_reader :commands
+
+    def reset!
+      @commands = []
+    end
+  end
+
+  def system(command) # rubocop:disable Naming/PredicateMethod
+    SystemCapture.commands << command
+    true
+  end
+end
+
+Kernel.prepend(SystemCapture) unless Kernel.ancestors.include?(SystemCapture)
+
+class PagefindGeneratorTest < Minitest::Test
+  SiteStub = Struct.new(:config, :dest)
+
+  def setup
+    SystemCapture.reset!
+    @registry = Jekyll::Hooks.instance_variable_get(:@registry)
+    @hook_priority = Jekyll::Hooks.instance_variable_get(:@hook_priority)
+    @original_post_write_hooks = @registry[:site][:post_write].dup
+    @original_hook_priority = @hook_priority.dup
+  end
+
+  def teardown
+    @registry[:site][:post_write] = @original_post_write_hooks
+    Jekyll::Hooks.instance_variable_set(:@hook_priority, @original_hook_priority)
+  end
+
+  def test_runs_pagefind_with_configured_executable_after_site_write
+    site = SiteStub.new({ "pagefind" => { "pf_location" => "/tmp/pagefind" } }, "_site")
+
+    Jekyll::Pagefind::PagefindGenerator.new.generate(site)
+    Jekyll::Hooks.trigger(:site, :post_write, site)
+
+    assert_equal ["/tmp/pagefind --site _site"], SystemCapture.commands
+  end
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-pagefind
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- phothinmg
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: A Jekyll plugin that runs the Pagefind CLI after the site is written
+  so search indexes are generated alongside the built site.
+email:
+- phothinmg@disroot.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".vscode/settings.json"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/jekyll/pagefind.rb
+- lib/jekyll/pagefind/version.rb
+- sig/jekyll/pagefind.rbs
+- test/pagefind_generator_test.rb
+homepage: https://github.com/phothinmg/jekyll-pagefind
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/phothinmg/jekyll-pagefind
+  source_code_uri: https://github.com/phothinmg/jekyll-pagefind/tree/main
+  changelog_uri: https://github.com/phothinmg/jekyll-pagefind/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.11
+specification_version: 4
+summary: Integrates Pagefind indexing into Jekyll builds.
+test_files: []