Skip to content

Docs: Add pagefind search for bnd manual - #6475

Merged
chrisrueger merged 2 commits into
bndtools:masterfrom
chrisrueger:add-pagefind-search-to-docs
Feb 19, 2025
Merged

Docs: Add pagefind search for bnd manual#6475
chrisrueger merged 2 commits into
bndtools:masterfrom
chrisrueger:add-pagefind-search-to-docs

Conversation

@chrisrueger

@chrisrueger chrisrueger commented Feb 18, 2025

Copy link
Copy Markdown
Contributor

adding pagefind based full text search for bnd manual, just as we did recently for bndtools.org

image

Note: In order to make this work, we have to disable Github's own Github Pages build and deployment based on jekyll.
Otherwise Github's own Github Pages will overwrite the result of this build and then the pagefind stuff is missing.

- replace the google search with a pagfind based search

Signed-off-by: Christoph Rueger <chrisrueger@gmail.com>
@chrisrueger
chrisrueger marked this pull request as draft February 18, 2025 21:47
@chrisrueger chrisrueger changed the title Add pagefind search to docs Docs: Add pagefind search to docs Feb 18, 2025
@chrisrueger chrisrueger changed the title Docs: Add pagefind search to docs Docs: Add pagefind search Feb 18, 2025
@chrisrueger chrisrueger changed the title Docs: Add pagefind search Docs: Add pagefind search for bnd manual Feb 18, 2025
@chrisrueger
chrisrueger force-pushed the add-pagefind-search-to-docs branch 3 times, most recently from 68ebad8 to 1369b1b Compare February 18, 2025 22:02
Note: For this change to take effect, we need to disable the Github's own Github Pages build and deployment in gIthub Backend / Settings for bnd repo

Signed-off-by: Christoph Rueger <chrisrueger@gmail.com>

build pagefindindex

Update docs.yml

Update docs.yml
@chrisrueger
chrisrueger force-pushed the add-pagefind-search-to-docs branch from 1369b1b to 72d90b4 Compare February 18, 2025 22:06
@chrisrueger
chrisrueger marked this pull request as ready for review February 18, 2025 22:34
@pkriens

pkriens commented Feb 19, 2025

Copy link
Copy Markdown
Member

LGTM!

@chrisrueger
chrisrueger merged commit cb225d5 into bndtools:master Feb 19, 2025
@chrisrueger

Copy link
Copy Markdown
Contributor Author

@pkriens thanks it works :) New search is live.

I need to fix the close button (Use ESC Button in the meantime to close the modal or just click a result)

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.

2 participants