-
-
Notifications
You must be signed in to change notification settings - Fork 610
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
docs(search): searching with keyboard shortcut #1770
Conversation
Thanks for the PR @ydcjeff ! I disabled for a moment netlify as we can run out in the number of builds per month. Let me activate it for this PR. |
For this, I think we can build the docs in github actions and upload the |
Nice addition @ydcjeff ! I was just wondering if we can change this searchbar button to something more subtle I'm a bit bothered by large [Cmd][K] button images and small length of the button vs previous version... |
@vfdev-5 it is now almost same like previous one, it looks good now |
Yeah, looks much better now. Do you think we could remove drawn [Apple][K] buttons and just put that into the text "Search", like "Search Docs (Cmd/Ctrl + K)"? |
It tells keyboard shortcut for searching, so removing isn't good IMO. |
Yeah, I know, I propose to display the shortcut a bit differently. The size of those buttons is a bit too large IMO. |
OK I see. I inspected that they are directly inside html, I don't know how to edit them. |
@ydcjeff looks like they are binded to classes that probably could be modified with css ? |
Following this answer and adding this to ignite_theme.css .DocSearch-Button-Placeholder, .DocSearch-Button-Key {
display: none !important;
}
.DocSearch:after {
content: "Search Docs (⌘/CTRL + K)";
padding: 0 12px 0 6px;
} This works but display failed when launch search modal. |
Thanks for digging into it @ydcjeff ! Do you think we could just tweak button's graphical representation, for example, change their size to a smaller one ? |
IMO looks better. What do you think, Jeff ? |
I am ok with both styles |
OK, can you update the PR with buttons without shadows to see that integrated |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great for me now ! Thanks @ydcjeff
Description: searching within the docs is faster now, we can now search with command + K on mac and ctrl + K on windows/linux. And, it still searches correct version docs on each version docs.
https://deploy-preview-1770--pytorch-ignite-preview.netlify.app
Check list: