Restyle the docs sidebar and make it work with hotkeys - #3471
Merged
Merged
Conversation
fsdocs 23 adds keyboard navigation: j and k walk the links of the main menu, h and l move between the menu, the content and the page menu. Our menu folds its sections with visibility: hidden, which a browser will not focus, so the walk stalled at the first folded section. A folded section now hides by height alone and unfolds when a link inside it receives the focus, from the hotkeys or from Tab, which before had no way to open a section at all. The hotkey outline is white inside the sidebar, where the primary colour it uses by default is invisible. While there, give the sidebar the polish it lacked. Sections get a rail with their items inset under the header, and the current page is a rounded highlight with a marker on that rail. Hover and highlight are translucent white, so they hold up on both the light and the dark panel colour. The fold animates, the chevron is sized from the stylesheet rather than the template, and the type sits on the default scale. docs-setup.js was left behind when the Bootstrap theme went; nothing has loaded it since and everything it looked for is gone from the page. Bump fsdocs-tool to 23.0.0-alpha.4 and fantomas to 8.0.0-beta-003.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
fsdocs 23 adds keyboard navigation: j and k walk the links of the main menu, h and l move between the menu, the content and the page menu. Our menu folds its sections with visibility: hidden, which a browser will not focus, so the walk stalled at the first folded section. A folded section now hides by height alone and unfolds when a link inside it receives the focus, from the hotkeys or from Tab, which before had no way to open a section at all. The hotkey outline is white inside the sidebar, where the primary colour it uses by default is invisible.
While there, give the sidebar the polish it lacked. Sections get a rail with their items inset under the header, and the current page is a rounded highlight with a marker on that rail. Hover and highlight are translucent white, so they hold up on both the light and the dark panel colour. The fold animates, the chevron is sized from the stylesheet rather than the template, and the type sits on the default scale.
docs-setup.js was left behind when the Bootstrap theme went; nothing has loaded it since and everything it looked for is gone from the page.
Bump fsdocs-tool to 23.0.0-alpha.4 and fantomas to 8.0.0-beta-003.