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

Show more than just a single word on search results page #1437

Closed
logankilpatrick opened this issue Oct 16, 2020 · 0 comments · Fixed by #2202
Closed

Show more than just a single word on search results page #1437

logankilpatrick opened this issue Oct 16, 2020 · 0 comments · Fixed by #2202
Labels
Format: HTML Related to the default HTML output help wanted Type: Enhancement

Comments

@logankilpatrick
Copy link
Contributor

I think the searchability with documenter could be improved by doing including more info (like a search engine) in the results page. Currently, this is what shows when I search for sin in the Julia Docs:
Screen Shot 2020-10-16 at 5 37 03 AM

It's not terrible but I have to click around a lot and not really know if what I am clicking on is what I actually need. I propose something like this:
Screen Shot 2020-10-16 at 5 37 03 AM
where the actual info from the page the link goes to is previewed on the search page either to the right or below the title of the item.

I think this will significantly improve the ability for search to be done effectively with documenter.

@logankilpatrick logankilpatrick changed the title Show more than just a single work when you do a search using documenter.jl Show more than just a single word when you do a search using documenter.jl Oct 16, 2020
@mortenpi mortenpi added Format: HTML Related to the default HTML output Type: Enhancement labels Oct 18, 2020
@mortenpi mortenpi changed the title Show more than just a single word when you do a search using documenter.jl Show more than just a single word on search results page Oct 18, 2020
@Hetarth02 Hetarth02 mentioned this issue Aug 23, 2023
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Format: HTML Related to the default HTML output help wanted Type: Enhancement
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants