stackblitz / tutorialkit

TutorialKit by StackBlitz - Create interactive tutorials powered by the WebContainer API
https://tutorialkit.dev
MIT License
232 stars 22 forks source link

SearchBar #249

Open noam-honig opened 4 weeks ago

noam-honig commented 4 weeks ago

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 commented 4 weeks ago

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.

noam-honig commented 4 weeks ago

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 commented 4 weeks ago

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

AriPerkkio commented 3 weeks ago

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 commented 3 weeks ago

@AriPerkkio I agree with the approach - it sounds great