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

Add search functionality #95

Open
xplosionmind opened this issue May 1, 2023 · 6 comments
Open

Add search functionality #95

xplosionmind opened this issue May 1, 2023 · 6 comments
Assignees

Comments

@xplosionmind
Copy link
Contributor

It would be super useful to search for stuff in the documentation.

@jacksonh jacksonh self-assigned this Aug 7, 2023
@jacksonh
Copy link
Contributor

jacksonh commented Aug 7, 2023

I think there is a vitepress plugin we can use here. will test it after bumping the version

@bengeois
Copy link

Hi @jacksonh, I can work on bumping the version and add the feature to search in the docs, if you're ok ?

@matthieugd
Copy link
Contributor

matthieugd commented Aug 27, 2024

I have read the documentation page about search on the VitePress website, I see 4 options:

  1. Built-in via minisearch
  2. Algolia (but this is free only for technical blogs/websites so I think we can remove it from the list)
  3. Plugin aptly named Search (version 1.0, last published 8 months ago)
  4. Plugin pagefind (version 0.4 last publish a month ago)

Before going on the plugin path, I would test the built-in feature + bumping to the latest version of VitePress (1.3.4).

What do you think ?

@bengeois
Copy link

A few weeks ago, I've tried to bump the version of VitePress and activate the search built-in feature. It works except for the placeholder like {{ $frontmatter.title }} which are not replaced in the search results.

Maybe there is another thing to setup ? I can push the branch if you want to have a look.

@matthieugd
Copy link
Contributor

Yes, please push it and I will try to go from there. Thanks !

@bengeois
Copy link

Here is the associated PR in progress

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

No branches or pull requests

4 participants