Repository navigation
various: better sidebar organization via sub-chapters - #297
Merged
Merged
Conversation
Signed-off-by: NotAShelf <raf@notashelf.dev> Change-Id: I7069005481bb4d2b55c1b256c3bf3e036a6a6964
Signed-off-by: NotAShelf <raf@notashelf.dev> Change-Id: I115bf0f92cbcc6c885c0abf0d7e1bd3c6a6a6964
Signed-off-by: NotAShelf <raf@notashelf.dev> Change-Id: I53a4cbec522761df84872859143ee1e86a6a6964
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
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.
Fixes #290
Introduces explicit sub-chapter, i.e., hierarchical section support for documentation sidebars. This is a step in allowing pages to be nested under parent pages using a new
parentfield insidebar.matches. Consequently the sidebar now supports hierarchical numbering (e.g.,4.1,4.1.1), and custom ordering within sibling groups. Misconfigurations such as cycles or missing parents are reported neatly as errors.tl;dr: more flexible and powerful sidebar navigation for documentation sites, supporting complex hierarchies and custom ordering.