jekyll-pagefind 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e8984579d241274aedab47fb65d068c4fb963c4695d6a06a0fd4d3f4b7a2636
-  data.tar.gz: 48d51482f1506b7286891df917d6eccc33abbe0f68e94421fe9aa06d102338af
+  metadata.gz: 7354120e9ae2690548d13b7f1caca98d7d9565b3326c1dca67ec417c82c0be12
+  data.tar.gz: cb762ce2575300b20c80cba8c99e6dd3cc2981af14101b3f8e657679b9ed5197
 SHA512:
-  metadata.gz: 53fba7b6eb1961fd013fc625489601177b7ade0dfdb2311bc4cff248c7ef91d872c1201fd61045309b7e7da950d6182d01413b43169b56ae2ef56999763dfcad
-  data.tar.gz: 8a3433e32d7a351198b6e0c5fc6c353845dd2d6669c20d4d98a1329c59e29ee4cc1f8cc8e6238b39b69edebdc70e46dca85f27b7223008b97ce06c0725e8c2fd
+  metadata.gz: 4110df9a227f32c095f5b569a59b103794c842f935ecb5ef717daa20cc87398ff8d1480a518601728bcc69ad9d3779e5fc3cb489fdac65d14561b50dfafcca65
+  data.tar.gz: 90a8d55735e526c12fed6cae896a9c1c03b19bd547a6c04c1039c216b34a851fbeed0846ad8603e7ebc270f774bca1c01732cf0669b2ff8174f1005cbf86fc57

data/README.md

@@ -1,38 +1,188 @@
-# Jekyll::Pagefind
+<!-- markdownlint-disable MD033 -->
+<!-- markdownlint-disable MD041 -->
+<p align="center">
+<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>
 
-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 that runs the Pagefind binary for a Jekyll site.
 
-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:
+Install the gem and add it to your application's Gemfile by running:
 
-```bash
-bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```sh
+bundle add jekyll-pagefind
 ```
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+In your `Gemfile`:
 
-```bash
-gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```ruby
+group :jekyll_plugins do
+  # other jekyll plugins
+  gem 'jekyll-pagefind' # add pagefind plugin
+end
 ```
 
-## Usage
+```sh
+bundle install
+```
+
+If Bundler is not being used to manage dependencies, install the gem by running:
+
+```sh
+gem install jekyll-pagefind
+```
+
+## Use
+
+### Jekyll site configuration
+
+**`_config.yml`**
+
+```yaml
+plugins:
+  # other plugin
+  - jekyll-pagefind
+# other config
+# Optional Jekyll Pagefind Options
+jekyll_pagefind:
+  output_subdir: pagefind
+```
+
+---
+
+### Jekyll Pagefind options (optional)
+
+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).
+
+For more details, see [Pagefind CLI configuration options](https://pagefind.app/docs/config-options/). `jekyll_pagefind` supports the following options.
+
+#### 1. output_subdir
+
+The folder where the search bundle is written, relative to Jekyll `{{ site.dest }}`. The default is `pagefind`.
+
+**Example:**
+
+```yaml
+output_subdir: pf # becomes _site/pf
+```
+
+#### 2. exclude_selectors
+
+Pass extra element selectors that Pagefind should ignore when indexing.
+
+**Example :**
+
+```yaml
+exclude_selectors:
+  - "#my_navigation"
+  - "blockquote > span"
+  - "[id^='prefix-']"
+```
+
+#### 3. keep_index_url
 
-TODO: Write usage instructions here
+Keeps `index.html` at the end of search result paths. The default is `false`.
 
-## Development
+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 }}" />
+```
+
+For dark mode:
+
+```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;
+  }
+}
+```
 
-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.
+For more details, see [Using the Default UI](https://pagefind.app/docs/search-ui/).
 
-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).
+---
 
 ## 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 +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/[USERNAME]/jekyll-pagefind/blob/master/CODE_OF_CONDUCT.md).
+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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative "lib/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.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"
+
+  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.rb

@@ -1,22 +1,114 @@
 # frozen_string_literal: true
 
-require_relative "jekyll/pagefind/version"
+require "rbconfig"
+require "open3"
+require "jekyll"
+
+require_relative "version"
 
 module Jekyll
+  # module Jekyll::Pagefind
   module Pagefind
-    # class Jekyll::Pagefind::PagefindGenerator
-    class PagefindGenerator < Jekyll::Generator
-      safe true
-      priority :low
-
-      def generate(site)
-        dest_dir = site.dest
-        pf_location = site.config["pagefind"] || "pagefind"
-        Jekyll::Hooks.register :site, :post_write do |_site|
-          command = "./#{pf_location} --site #{dest_dir}"
-          system(command)
+    GEM_ROOT = File.expand_path("..", __dir__)
+
+    def self.pagefind_binary_path # rubocop:disable Metrics/MethodLength,Metrics/PerceivedComplexity
+      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
+        # 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-Pagefind Mismatch Error: Pagefind binary not provided for host environment: #{os} (#{cpu})"
+      end
+    end
+
+    # 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
+      # spellchecker:disable-next-line
+      if RbConfig::CONFIG["host_os"] !~ /mswin|msys|mingw|cygwin|bccwin/i && !File.executable?(binary)
+        File.chmod(0o755, binary)
+      end
+
+      # 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-Pagefind:", "Indexing finished successfully!"
+        puts stdout
+      else
+        Jekyll.logger.error "Jekyll-Pagefind 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|
+  # 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.0"
+    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.0
+  version: 0.3.0
 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,8 +46,15 @@ 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-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
@@ -48,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:
   - - ">="