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

SearchBar #249

Open
noam-honig opened this issue Aug 16, 2024 · 5 comments
Open

SearchBar #249

noam-honig opened this issue Aug 16, 2024 · 5 comments
Labels
enhancement New feature or request

Comments

@noam-honig
Copy link
Contributor

Is your feature request related to a problem?

It'll be great to have a searchbar, so that users can search the tutorial and find relevant chapters for their search

Describe the solution you'd like.

.

Describe alternatives you've considered.

.

Additional context

No response

@AriPerkkio
Copy link
Member

Would VitePress-like algolia search work here? https://vitepress.dev/

So the search should be run against lesson markdown files, right? And maybe the titles of chapters and parts.

@AriPerkkio AriPerkkio added the enhancement New feature or request label Aug 16, 2024
@noam-honig
Copy link
Contributor Author

Yes - the search should run against lessons and titles

As for algolia - I don't know - on our vitepres site (https://remult.dev) we use the basic vitepress search functionality.

@AriPerkkio
Copy link
Member

Svelte tutorial has something similar: https://learn.svelte.dev

@AriPerkkio
Copy link
Member

We discussed this with @Nemikolh and decided to try adding similar search as Starlight has: https://starlight.astro.build/guides/site-search/. It's using Pagefind, that allows users to perform the search against static files. Services like algolia would require third party servers which is not something we would like at this point.

@noam-honig
Copy link
Contributor Author

@AriPerkkio I agree with the approach - it sounds great

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants