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

Need ability to search #27

Open
shirotech opened this issue May 26, 2020 · 6 comments
Open

Need ability to search #27

shirotech opened this issue May 26, 2020 · 6 comments

Comments

@shirotech
Copy link
Contributor

I guess the main difference with this and https://svelte.dev/docs is that on the svelte website the whole docs is a single page and scrolled along with the left nav. This allows the user to use the browser search because everything is there on a single page. However, this is not the case for svelte-docs, it is not a single page and hence we need a search functionality if we intend to keep this behaviour. Just a thought.

@AlexxNB
Copy link
Owner

AlexxNB commented May 26, 2020

Have you any experience or thoughts how we can perform this?

@shirotech
Copy link
Contributor Author

I think there can be 2 reasonable solutions.

  1. Replicate the same behavior of https://svelte.dev/docs will have breaking changes.
  2. Need to index all contents into a JSON, possibly a build step as a rollup plugin. Similar to what I have on https://shirotech.com/ using a static site.

Might be other ways, those are the obvious ones I see.

@AlexxNB
Copy link
Owner

AlexxNB commented May 26, 2020

  1. No, splited pages are more universal. Single page won't allow us to code-spliting in future. And can't be be used for huge documents.
  2. Looks like true way. We may have separate bundle with search engine and indexed pages.

@Thebigbignooby
Copy link

have you looked at https://docsearch.algolia.com/ ?

@stordahl
Copy link

have you looked at https://docsearch.algolia.com/ ?

Gonna second this, Angolia would be a great simple solution

@stordahl
Copy link

stordahl commented Dec 1, 2020

another potential option: https://github.com/roxiness/poindexter

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