Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Switch from tipue to lunr for search #674

Conversation

d7919
Copy link
Contributor

@d7919 d7919 commented Nov 13, 2024

The tipue search plugin is not actively maintained and hence we are reliant on a frozen version of the package shipped with Ford. This PR switches to lunr.js. This particular search option was simply motivated by the existence of some examples and good compatibility with the existing tipuesearch infrastructure. For example https://learn.cloudcannon.com/jekyll/jekyll-search-using-lunr-js/ and https://github.com/Pelican-Elegant/elegant/pull/573/files .

Pros:

  • Use of an actively maintained plugin
  • No explicit dependence on jQuery
  • Can be included via a CDN, reducing storage / ship size of website with search.

Cons:

  • Include via a CDN, search won't work on a machine with no internet connection.
  • May be slower than tipue search (no measurements, just feel)
  • Less pleasing out of the box styling of search results (possible we can customise css for this)

@d7919 d7919 changed the title Draft : Major/switch from tipue to lunr for search Switch from tipue to lunr for search Nov 21, 2024
@ZedThree ZedThree merged commit 410011b into Fortran-FOSS-Programmers:master Dec 18, 2024
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants