jekyll-pagefind 0.3.1-x86_64-linux

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 020eafea9b1a718af7ecc409269efaf7c700ba2a765b07f43a2f05c3c3a74354
+  data.tar.gz: 7cb10dcc68deb11fc4709868c666590f8d1c46a27ca24ad7fded262d952df0b0
+SHA512:
+  metadata.gz: 5de94bf3aee9cbb44ebd0ba618188c32e61824d449a39f8949e30333ce114979e9c7f5331f28361b5c2b25541cf54a6d32d0b1573f5dcf707fb3397ea0842cda
+  data.tar.gz: 4392bdab72278743811558b08bef350511d36827270eb578c495082145ce608b2f9307e3f7fbf11d24b0ca53186439808ca9211b61363c283126cf9bd53d3573

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,232 @@
+<!-- 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>
+
+[![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 that runs the Pagefind binary for a Jekyll site.
+
+## Install
+
+Install the gem and add it to your application's Gemfile by running:
+
+```sh
+bundle add jekyll-pagefind
+```
+
+In your `Gemfile`:
+
+```ruby
+group :jekyll_plugins do
+  # other jekyll plugins
+  gem 'jekyll-pagefind' # add pagefind plugin
+end
+```
+
+```sh
+bundle install
+```
+
+If Bundler is not being used to manage dependencies, install the gem by running:
+
+```sh
+gem install jekyll-pagefind
+```
+
+RubyGems will install the platform-specific package that matches the host OS and CPU.
+
+## 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
+
+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 }}" />
+```
+
+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;
+  }
+}
+```
+
+For more details, see [Pagefind Component UI](https://pagefind.app/docs/search-ui/).
+
+---
+
+## Contributing
+
+## Maintainer Release Notes
+
+This gem is published as platform-specific packages so users only download the binary for their host OS.
+
+Build the current host variant:
+
+```sh
+make build
+```
+
+Run the fixture-based smoke test:
+
+```sh
+make smoke-test
+```
+
+Build every supported variant:
+
+```sh
+make build-all
+```
+
+Publish the built platform gems for a version:
+
+```sh
+make publish
+```
+
+`bin/build-platform-gems` currently maps these asset folders to RubyGems platforms:
+
+- `assets/linux-x64` -> `x86_64-linux`
+- `assets/linux-arm64` -> `aarch64-linux`
+- `assets/macos-x64` -> `x86_64-darwin`
+- `assets/macos-arm64` -> `arm64-darwin`
+- `assets/windows-x64` -> `x64-mingw32`, `x64-mingw-ucrt`
+- `assets/windows-arm64` -> `arm64-mingw32`, `arm64-mingw-ucrt`
+
+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
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+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,45 @@
+# frozen_string_literal: true
+
+require "rbconfig"
+require_relative "lib/version"
+
+host_os = RbConfig::CONFIG["host_os"]
+host_cpu = RbConfig::CONFIG["host_cpu"]
+
+default_pagefind_asset_directory = case host_os
+                                   when /darwin|mac os/i
+                                     host_cpu =~ /arm64|aarch64/i ? "assets/macos-arm64" : "assets/macos-x64"
+                                   when /linux/i
+                                     host_cpu =~ /arm64|aarch64/i ? "assets/linux-arm64" : "assets/linux-x64"
+                                   when /mswin|msys|mingw|cygwin|bccwin/i
+                                     host_cpu =~ /arm64|aarch64/i ? "assets/windows-arm64" : "assets/windows-x64"
+                                   else
+                                     raise "Unable to determine a default Pagefind asset directory for host environment: #{host_os} (#{host_cpu})"
+                                   end
+
+pagefind_asset_directory = ENV.fetch("PAGEFIND_ASSET_DIR", default_pagefind_asset_directory)
+pagefind_gem_platform = ENV.fetch("PAGEFIND_GEM_PLATFORM", Gem::Platform::RUBY)
+
+Gem::Specification.new do |spec|
+  spec.name = "jekyll-pagefind"
+  spec.version = Jekyll::Pagefind::VERSION
+  spec.platform = Gem::Platform.new(pagefind_gem_platform)
+  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/**/*", "#{pagefind_asset_directory}/**/*", "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

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+require "rbconfig"
+require "open3"
+require "jekyll"
+require "shellwords"
+
+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,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/MethodLength,Metrics/AbcSize
+      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 = [
+        Shellwords.escape(binary),
+        "--site",
+        Shellwords.escape(site_destination),
+        extra_arguments
+      ].join(" ").strip
+      started_at = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+
+      Jekyll.logger.info "Jekyll-Pagefind:", "Running Pagefind..."
+      _stdout, stderr, status = Open3.capture3(full_command)
+
+      if status.success?
+        elapsed = Process.clock_gettime(Process::CLOCK_MONOTONIC) - started_at
+        Jekyll.logger.info "Jekyll-Pagefind:", format("Done in %.2fs", elapsed)
+      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|
+  # Parse plugin settings out of site.config
+  custom_flags = Jekyll::Pagefind.build_cli_arguments(site.config)
+  # Run Pagefind with the compiled flags
+  Jekyll::Pagefind.run_pagefind(site.dest, custom_flags)
+end

data/lib/version.rb

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

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-pagefind
+version: !ruby/object:Gem::Version
+  version: 0.3.1
+platform: x86_64-linux
+authors:
+- phothinmg
+bindir: bin
+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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- assets/linux-x64/pagefind
+- jekyll-pagefind.gemspec
+- lib/jekyll-pagefind.rb
+- lib/version.rb
+homepage: https://rubygems.org/gems/jekyll-pagefind
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://rubygems.org/gems/jekyll-pagefind
+  source_code_uri: https://github.com/phothinmg/jekykll-pagefind
+  changelog_uri: https://github.com/phothinmg/jekykll-pagefind/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.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: Pagefind plugin for Jekyll
+test_files: []