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

Feature Request: search function in docs #197

Open
rs7q5 opened this issue Jan 23, 2023 · 1 comment
Open

Feature Request: search function in docs #197

rs7q5 opened this issue Jan 23, 2023 · 1 comment

Comments

@rs7q5
Copy link
Contributor

rs7q5 commented Jan 23, 2023

Any chance you could add a search function to the docs. I have been playing around with it, but realized it also has some design implications on your end of the docs, and haven't found a good way of doing it since I haven't played around with react too much.

Through some googling, algolia instantsearch may be a good option, but I don't know too much about the best way to go about this. I think if a search function that could link to either pages or sections/subsections of the docs in the results that would be helpful.

Thanks!

@rs7q5 rs7q5 changed the title Feature Request: search bar in docs Feature Request: search function in docs Jan 23, 2023
@rs7q5
Copy link
Contributor Author

rs7q5 commented Jan 27, 2023

And/or if the headings of the markdown file could be expanded on the nav bar (if optionally) like subheadings or something when you are on a current page that would also be nice, particularly if there is no search function.

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

1 participant