jekyll-pagefind 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da6350f1cdab2054988ffbd388592a97df71a8a193dd7c086c94f56f63073ae1
-  data.tar.gz: 41ef3c9bbb2e05ab8b7e960ba36f52bb444295f3bf209036635987917d7dc5c9
+  metadata.gz: 7354120e9ae2690548d13b7f1caca98d7d9565b3326c1dca67ec417c82c0be12
+  data.tar.gz: cb762ce2575300b20c80cba8c99e6dd3cc2981af14101b3f8e657679b9ed5197
 SHA512:
-  metadata.gz: 84ceb9bcaeb5feaae2f28c00be44de3a03ceaa8eb26adf0f5060a22807558a0f50f8f4b81179438b88d6971e13cdf44f4089c6e1db3e2a0e4bd2ec8a8968070d
-  data.tar.gz: 8902b9fcb368cec056f541b07a92753e05b98862be590aaaa8ddbc649fc203bd01061919f9689f2836a14fbd5b55ca42842309c683778dddfca5377970560c6e
+  metadata.gz: 4110df9a227f32c095f5b569a59b103794c842f935ecb5ef717daa20cc87398ff8d1480a518601728bcc69ad9d3779e5fc3cb489fdac65d14561b50dfafcca65
+  data.tar.gz: 90a8d55735e526c12fed6cae896a9c1c03b19bd547a6c04c1039c216b34a851fbeed0846ad8603e7ebc270f774bca1c01732cf0669b2ff8174f1005cbf86fc57

data/README.md

@@ -1,29 +1,25 @@
 <!-- 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%" />
+<img src="https://susee.phothin.dev/logo/rubygems_logo.png" width="160" height="160" alt="mmdevs" style="border-radius:50%" />
 </p>
-<h1 align="center">Jekyll::Pagefind</h1>
+<h1 align="center">jekyll-pagefind</h1>
 
 [![Gem Version](https://badge.fury.io/rb/jekyll-pagefind.svg?icon=si%3Arubygems)](https://badge.fury.io/rb/jekyll-pagefind)
 
 ## Overview
 
-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.
+Jekyll-Pagefind is a plugin that runs the Pagefind binary for a Jekyll site.
 
 ## Install
 
-Install the gem and add to the application's Gemfile by executing:
+Install the gem and add it to your application's Gemfile by running:
 
 ```sh
 bundle add jekyll-pagefind
 ```
 
-```sh
-bundle install
-```
-
-In `Gemfile`
+In your `Gemfile`:
 
 ```ruby
 group :jekyll_plugins do
@@ -32,50 +28,157 @@ group :jekyll_plugins do
 end
 ```
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+```sh
+bundle install
+```
+
+If Bundler is not being used to manage dependencies, install the gem by running:
 
 ```sh
 gem install jekyll-pagefind
 ```
 
-## How to
+## Use
+
+### Jekyll site configuration
 
-This guide is intended for Jekyll sites deployed to GitHub Pages.
+**`_config.yml`**
 
-### Download pagefind
+```yaml
+plugins:
+  # other plugin
+  - jekyll-pagefind
+# other config
+# Optional Jekyll Pagefind Options
+jekyll_pagefind:
+  output_subdir: pagefind
+```
 
-First, download the standalone binary (`pagefind`) from the [pagefind releases][pf_release_page] page.
+---
 
-Make sure to use the correct binary:
+### Jekyll Pagefind options (optional)
 
-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`.
+These options map to the settings available in [Pagefind config files](https://pagefind.app/docs/config-sources/#:~:text=overriding%20configuration%20files.-,Config%20files,-Pagefind%20will%20look).
 
-### Place the binary file `pagefind`
+For more details, see [Pagefind CLI configuration options](https://pagefind.app/docs/config-options/). `jekyll_pagefind` supports the following options.
 
-Place the `pagefind` binary in the root of your Jekyll project, which is the recommended default, or anywhere else under the project root.
+#### 1. output_subdir
 
-### Jekyll Config
+The folder where the search bundle is written, relative to Jekyll `{{ site.dest }}`. The default is `pagefind`.
 
-**`_config.yml`**
+**Example:**
 
 ```yaml
-plugins:
-  # other plugin
-  - jekyll-pagefind
+output_subdir: pf # becomes _site/pf
 ```
 
-If your `pagefind` binary is not in the project root, add this configuration option:
+#### 2. exclude_selectors
+
+Pass extra element selectors that Pagefind should ignore when indexing.
+
+**Example :**
 
 ```yaml
-pagefind: path_to_your/pagefind # where your `pagefind` was located
+exclude_selectors:
+  - "#my_navigation"
+  - "blockquote > span"
+  - "[id^='prefix-']"
+```
+
+#### 3. keep_index_url
+
+Keeps `index.html` at the end of search result paths. The default is `false`.
+
+By default, a file at `animals/cat/index.html` will be given the URL `/animals/cat/`. Setting this option to true will result in the URL `/animals/cat/index.html`.
+
+#### 4. quiet
+
+Logs only errors and warnings while indexing the site.
+
+---
+
+### Pagefind UI
+
+#### 1. Using the Default UI
+
+Using the Default UI is still supported, but it is no longer Pagefind's primary recommendation.
+
+You can add the Pagefind UI to any page with the following snippet. The `/pagefind/` directory, or the directory specified by `output_subdir` in the [config](#1-output_subdir), will be created along with its files.
+
+```liquid
+<script src="{{ '/pagefind/pagefind-ui.js' | relative_url }}"></script>
+<link rel="stylesheet" href="{{ '/pagefind/pagefind-ui.css' | relative_url }}" />
+
+<div id="search"></div>
+<script>
+    window.addEventListener('DOMContentLoaded', (event) => {
+        new PagefindUI({ element: "#search", showSubResults: true });
+    });
+</script>
+```
+
+For dark mode:
+
+```css
+body.dark {
+  --pagefind-ui-primary: #eeeeee;
+  --pagefind-ui-text: #eeeeee;
+  --pagefind-ui-background: #152028;
+  --pagefind-ui-border: #152028;
+  --pagefind-ui-tag: #152028;
+}
+```
+
+For more details, see [Using the Default UI](https://pagefind.app/docs/ui-usage/).
+
+#### 2. Pagefind Component UI
+
+Add the following snippet to `<head>`. The `/pagefind/` directory, or the directory specified by `output_subdir` in the [config](#1-output_subdir), will be created along with its files.
+
+```liquid
+<script src="{{ '/pagefind/pagefind-component-ui.js' | relative_url }}" type="module"></script>
+<link rel="stylesheet" href="{{ '/pagefind/pagefind-component-ui.css' | relative_url }}" />
 ```
 
-## Development
+For dark mode:
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+```html
+<div data-pf-theme="dark">
+  <pagefind-searchbox></pagefind-searchbox>
+</div>
+```
+
+```css
+@media (prefers-color-scheme: dark) {
+  :root {
+    --pf-text: #e5e5e5;
+    --pf-text-secondary: #a0a0a0;
+    --pf-text-muted: #949494;
+    --pf-background: #1a1a1a;
+    --pf-border: #333;
+    --pf-border-focus: #555;
+    --pf-skeleton: #2a2a2a;
+    --pf-skeleton-shine: #333;
+    --pf-hover: #252525;
+    --pf-mark: #e5e5e5;
+    --pf-scroll-shadow: rgba(255, 255, 255, 0.1);
+    --pf-outline-focus: #58a6ff;
+
+    --pf-shadow-sm: 0 2px 8px rgba(0, 0, 0, 0.3);
+    --pf-shadow-md: 0 4px 12px rgba(0, 0, 0, 0.4);
+    --pf-shadow-lg: 0 16px 48px rgba(0, 0, 0, 0.5);
+
+    --pf-error-bg: #2a1a1a;
+    --pf-error-border: #5c2828;
+    --pf-error-text: #f87171;
+    --pf-error-text-secondary: #ef4444;
+  }
+}
+```
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+For more details, see [Using the Default UI](https://pagefind.app/docs/search-ui/).
+
+---
 
 ## Contributing
 
@@ -87,9 +190,4 @@ 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/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
+Everyone interacting in the Jekyll::Pagefind project's codebase, 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).

data/jekyll-pagefind.gemspec

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "lib/jekyll/pagefind/version"
+require_relative "lib/version"
 
 Gem::Specification.new do |spec|
   spec.name = "jekyll-pagefind"
@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   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.required_ruby_version = ">= 3.1.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"

data/lib/jekyll-pagefind.rb

@@ -4,14 +4,14 @@ require "rbconfig"
 require "open3"
 require "jekyll"
 
-require_relative "jekyll/pagefind/version"
+require_relative "version"
 
 module Jekyll
   # module Jekyll::Pagefind
   module Pagefind
     GEM_ROOT = File.expand_path("..", __dir__)
 
-    def self.pagefind_binary_path # rubocop:disable Metrics/MethodLength
+    def self.pagefind_binary_path # rubocop:disable Metrics/MethodLength,Metrics/PerceivedComplexity
       os = RbConfig::CONFIG["host_os"]
       cpu = RbConfig::CONFIG["host_cpu"]
 
@@ -34,13 +34,52 @@ module Jekyll
         end
         # spellchecker:disable-next-line
       when /mswin|msys|mingw|cygwin|bccwin/i
-        File.join(GEM_ROOT, "assets", "windows-x64", "pagefind.exe")
+        # Differentiate between Intel/AMD and ARM Windows machines
+        if cpu =~ /arm64|aarch64/i
+          File.join(GEM_ROOT, "assets", "windows-arm64", "pagefind.exe")
+        else
+          File.join(GEM_ROOT, "assets", "windows-x64", "pagefind.exe")
+        end
       else
-        raise "Jekyll-PF Mismatch Error: Pagefind binary not provided for host environment: #{os} (#{cpu})"
+        raise "Jekyll-Pagefind 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
+    # valid the cli flag
+    def self.valid_args(arg)
+      %w[output_subdir exclude_selectors keep_index_url quiet].include?(arg)
+    end
+
+    # Converts Jekyll config options into matching Pagefind command line flags
+    def self.build_cli_arguments(config) # rubocop:disable Metrics/MethodLength,Metrics/CyclomaticComplexity
+      plugin_config = config["jekyll_pagefind"] || {}
+      args = []
+
+      plugin_config.each do |key, value|
+        next unless valid_args(key)
+
+        # Transform snake_case keys to kebab-case (e.g., keep_index_url -> keep-index-url)
+        flag_name = key.to_s.gsub("_", "-")
+
+        case value
+        when TrueClass
+          # Boolean flags like --keep-index-url require no attached value
+          args << "--#{flag_name}"
+        when FalseClass
+          # Ignore false booleans unless Pagefind specifically supports a negative override
+          next
+        when Array
+          # Arrays like exclude_selectors need to be repeated: --exclude-selectors ".footer" --exclude-selectors "nav"
+          value.each { |val| args << "--#{flag_name} \"#{val}\"" }
+        else
+          # Strings or numbers like --bundle-dir "search"
+          args << "--#{flag_name} \"#{value}\""
+        end
+      end
+      args.join(" ")
+    end
+
+    def self.run_pagefind(site_destination, extra_arguments = "") # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
       binary = pagefind_binary_path
 
       # Force execution bits on UNIX hosts because gem unpacking can reset permissions flags
@@ -49,15 +88,17 @@ module Jekyll
         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}\"")
+      # Combine the mandatory --site parameter with any user-defined configuration flags
+      full_command = "#{binary} --site \"#{site_destination}\" #{extra_arguments}".strip
+
+      Jekyll.logger.info "Jekyll-Pagefind:", "Running command: #{full_command}"
+      stdout, stderr, status = Open3.capture3(full_command)
 
       if status.success?
-        Jekyll.logger.info "Jekyll-PF:", "Indexing finished successfully!"
+        Jekyll.logger.info "Jekyll-Pagefind:", "Indexing finished successfully!"
         puts stdout
       else
-        Jekyll.logger.error "Jekyll-PF Error:", stderr
+        Jekyll.logger.error "Jekyll-Pagefind Error:", stderr
         raise "Pagefind binary exited with non-zero status code: #{status.exitstatus}"
       end
     end
@@ -66,6 +107,8 @@ 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
+  # 1. Parse your plugin settings out of site.config
+  custom_flags = Jekyll::Pagefind.build_cli_arguments(site.config)
+  # 2. Run Pagefind with the compiled flags
+  Jekyll::Pagefind.run_pagefind(site.dest, custom_flags)
+end

data/lib/{jekyll/pagefind/version.rb → version.rb}

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-pagefind
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - phothinmg
@@ -50,10 +50,11 @@ files:
 - assets/linux-x64/pagefind
 - assets/macos-arm64/pagefind
 - assets/macos-x64/pagefind
+- assets/windows-arm64/pagefind.exe
 - assets/windows-x64/pagefind.exe
 - jekyll-pagefind.gemspec
 - lib/jekyll-pagefind.rb
-- lib/jekyll/pagefind/version.rb
+- lib/version.rb
 homepage: https://rubygems.org/gems/jekyll-pagefind
 licenses:
 - MIT
@@ -68,7 +69,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.2.0
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="