Sitepress::Pagefind
A Pagefind integration for Sitepress-Rails
Important
For now, this plugin is intended to be used with a mounted Sitepress installation (i.e. sitepress-rails)
Caution
For now the only tested case is one where no dynamic parts (i.e. those pertaining to a logged in user) are embedded in the static Sitepress pages.
Installation
Add this line to your application's Gemfile:
gem "sitepress-pagefind"And then execute:
$ bundleThen run the installer:
$ bin/rails g sitepress:pagefind:installThis installs
- the
@pagefind/default-uiJavaScript package - a Stimulus controller attachable to a
<dialog> - a template
_searchpartial for your convenience.
Usage
To compile a Pagefind index, run the following rake task:
$ bin/rails sitepress:pagefind:buildThis task will also be invoked by assets:precompile so you don't have to alter your build scripts.
Tip
If you want to opt out of this behavior, just set the SKIP_SITEPRESS_PAGEFIND_BUILD environment variable.
License
The gem is available as open source under the terms of the MIT License.