jekyll-pagefind 0.1.3 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cbd8ba0e93aa54320149205e50f5d87b35e5f49426cb80a85cc243eeefd391b2
-  data.tar.gz: 15eb4711ca7ecd7c6968290ef7e7b29c56c69087ab74e3a22a05ce351de64946
+  metadata.gz: da6350f1cdab2054988ffbd388592a97df71a8a193dd7c086c94f56f63073ae1
+  data.tar.gz: 41ef3c9bbb2e05ab8b7e960ba36f52bb444295f3bf209036635987917d7dc5c9
 SHA512:
-  metadata.gz: d84afcbb7b0c89329d22a1f2d6527a3366c489ae4d2bfa09c764592f076e0391f8d538480e4b32685efa6859419c8ec4f480250371387831f89429632104221e
-  data.tar.gz: dee8bc1cb6cfd7ee8937813251d2392586d2ba654e2a976b41119f5d6a94fafaff29450f01a72032f0a958e4120eed62ed1f63f08f6310e40dc3dd235975ae95
+  metadata.gz: 84ceb9bcaeb5feaae2f28c00be44de3a03ceaa8eb26adf0f5060a22807558a0f50f8f4b81179438b88d6971e13cdf44f4089c6e1db3e2a0e4bd2ec8a8968070d
+  data.tar.gz: 8902b9fcb368cec056f541b07a92753e05b98862be590aaaa8ddbc649fc203bd01061919f9689f2836a14fbd5b55ca42842309c683778dddfca5377970560c6e

data/README.md

@@ -1,28 +1,75 @@
-# Jekyll::Pagefind
+<!-- markdownlint-disable MD033 -->
+<!-- markdownlint-disable MD041 -->
+<p align="center">
+<img src="https://github.com/phothinmg/jekykll-pagefind/blob/main/rubygems_logo.png" width="160" height="160" alt="mmdevs" style="border-radius:50%" />
+</p>
+<h1 align="center">Jekyll::Pagefind</h1>
 
-TODO: Delete this and the text below, and describe your gem
+[![Gem Version](https://badge.fury.io/rb/jekyll-pagefind.svg?icon=si%3Arubygems)](https://badge.fury.io/rb/jekyll-pagefind)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/jekyll/pagefind`. To experiment with that code, run `bin/console` for an interactive prompt.
+## Overview
 
-## Installation
+Jekyll-Pagefind is a plugin I use for my personal and project sites. It was inspired by [Adding search to Jekyll using pagefind][pf_to_jekyll]. It fits easily into the default Jekyll GitHub Actions workflow for deploying to GitHub Pages.
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+## Install
 
 Install the gem and add to the application's Gemfile by executing:
 
-```bash
-bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```sh
+bundle add jekyll-pagefind
+```
+
+```sh
+bundle install
+```
+
+In `Gemfile`
+
+```ruby
+group :jekyll_plugins do
+  # other jekyll plugins
+  gem 'jekyll-pagefind' # add pagefind plugin
+end
 ```
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
-```bash
-gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```sh
+gem install jekyll-pagefind
+```
+
+## How to
+
+This guide is intended for Jekyll sites deployed to GitHub Pages.
+
+### Download pagefind
+
+First, download the standalone binary (`pagefind`) from the [pagefind releases][pf_release_page] page.
+
+Make sure to use the correct binary:
+
+1. For local development, download the standalone binary (`pagefind`) for your host platform.
+2. For deployment to GitHub Pages, the binary must be `pagefind-v{version}-x86_64-unknown-linux-musl.tar.gz`.
+
+### Place the binary file `pagefind`
+
+Place the `pagefind` binary in the root of your Jekyll project, which is the recommended default, or anywhere else under the project root.
+
+### Jekyll Config
+
+**`_config.yml`**
+
+```yaml
+plugins:
+  # other plugin
+  - jekyll-pagefind
 ```
 
-## Usage
+If your `pagefind` binary is not in the project root, add this configuration option:
 
-TODO: Write usage instructions here
+```yaml
+pagefind: path_to_your/pagefind # where your `pagefind` was located
+```
 
 ## Development
 
@@ -32,7 +79,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/jekyll-pagefind. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/jekyll-pagefind/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at <https://github.com/phothinmg/jekyll-pagefind>. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/phothinmg/jekyll-pagefind/blob/master/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -40,4 +87,9 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Jekyll::Pagefind project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/jekyll-pagefind/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Jekyll::Pagefind project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/phothinmg/jekyll-pagefind/blob/master/CODE_OF_CONDUCT.md).
+
+<!-- markdownlint-disable MD053 -->
+
+[pf_release_page]: https://github.com/Pagefind/pagefind/releases/latest
+[pf_to_jekyll]: https://www.bfoliver.com/2025/pagefind

data/jekyll-pagefind.gemspec

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative "lib/jekyll/pagefind/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "jekyll-pagefind"
+  spec.version = Jekyll::Pagefind::VERSION
+  spec.authors = ["phothinmg"]
+  spec.email = ["phothinmg@disroot.org"]
+
+  spec.summary = "Pagefind plugin for Jekyll"
+  spec.description = "Run pagefind binary in jekyll site"
+  spec.homepage = "https://rubygems.org/gems/jekyll-pagefind"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.2.0"
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/phothinmg/jekykll-pagefind"
+  spec.metadata["changelog_uri"] = "https://github.com/phothinmg/jekykll-pagefind/blob/main/CHANGELOG.md"
+
+  spec.files = Dir.chdir(__dir__) do
+    Dir["README.md", "LICENSE.txt", "lib/**/*", "assets/**/*", "jekyll-pagefind.gemspec"]
+  end
+  spec.require_paths = ["lib"]
+  spec.add_dependency "jekyll", "~> 4.4"
+  spec.add_dependency "open3", "~> 0.2.1"
+end

data/lib/jekyll/pagefind/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   module Pagefind
-    VERSION = "0.1.3"
+    VERSION = "0.2.1"
   end
 end

data/lib/jekyll-pagefind.rb

@@ -1,10 +1,71 @@
 # frozen_string_literal: true
 
+require "rbconfig"
+require "open3"
+require "jekyll"
+
 require_relative "jekyll/pagefind/version"
 
 module Jekyll
+  # module Jekyll::Pagefind
   module Pagefind
-    class Error < StandardError; end
-    # Your code goes here...
+    GEM_ROOT = File.expand_path("..", __dir__)
+
+    def self.pagefind_binary_path # rubocop:disable Metrics/MethodLength
+      os = RbConfig::CONFIG["host_os"]
+      cpu = RbConfig::CONFIG["host_cpu"]
+
+      case os
+      when /darwin|mac os/i
+        # Differentiate between Apple Silicon and Intel Macs
+        if cpu =~ /arm64|aarch64/i
+          File.join(GEM_ROOT, "assets", "macos-arm64",
+                    "pagefind")
+        else
+          File.join(GEM_ROOT, "assets", "macos-x64", "pagefind")
+        end
+      when /linux/i
+        # Differentiate between standard servers and ARM instances
+        if cpu =~ /arm64|aarch64/i
+          File.join(GEM_ROOT, "assets", "linux-arm64",
+                    "pagefind")
+        else
+          File.join(GEM_ROOT, "assets", "linux-x64", "pagefind")
+        end
+        # spellchecker:disable-next-line
+      when /mswin|msys|mingw|cygwin|bccwin/i
+        File.join(GEM_ROOT, "assets", "windows-x64", "pagefind.exe")
+      else
+        raise "Jekyll-PF Mismatch Error: Pagefind binary not provided for host environment: #{os} (#{cpu})"
+      end
+    end
+
+    def self.run_pagefind(site_destination) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
+      binary = pagefind_binary_path
+
+      # Force execution bits on UNIX hosts because gem unpacking can reset permissions flags
+      # spellchecker:disable-next-line
+      if RbConfig::CONFIG["host_os"] !~ /mswin|msys|mingw|cygwin|bccwin/i && !File.executable?(binary)
+        File.chmod(0o755, binary)
+      end
+
+      # Run the indexer pointing explicitly at Jekyll's output directory
+      Jekyll.logger.info "Jekyll-PF:", "Starting Pagefind indexing on target folder..."
+      stdout, stderr, status = Open3.capture3("#{binary} --site \"#{site_destination}\"")
+
+      if status.success?
+        Jekyll.logger.info "Jekyll-PF:", "Indexing finished successfully!"
+        puts stdout
+      else
+        Jekyll.logger.error "Jekyll-PF Error:", stderr
+        raise "Pagefind binary exited with non-zero status code: #{status.exitstatus}"
+      end
+    end
   end
 end
+
+# Hook ensures Jekyll is entirely done writing HTML pages to disk
+Jekyll::Hooks.register :site, :post_write do |site|
+  # site.dest points dynamically to the configured destination folder (usually '_site')
+  Jekyll::Pagefind.run_pagefind(site.dest)
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-pagefind
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.1
 platform: ruby
 authors:
 - phothinmg
@@ -23,6 +23,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.4'
+- !ruby/object:Gem::Dependency
+  name: open3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.1
 description: Run pagefind binary in jekyll site
 email:
 - phothinmg@disroot.org
@@ -32,6 +46,12 @@ extra_rdoc_files: []
 files:
 - LICENSE.txt
 - README.md
+- assets/linux-arm64/pagefind
+- assets/linux-x64/pagefind
+- assets/macos-arm64/pagefind
+- assets/macos-x64/pagefind
+- assets/windows-x64/pagefind.exe
+- jekyll-pagefind.gemspec
 - lib/jekyll-pagefind.rb
 - lib/jekyll/pagefind/version.rb
 homepage: https://rubygems.org/gems/jekyll-pagefind