stop using navigation integration#287
Merged
branfosj merged 1 commit intoeasybuilders:developfrom Jan 8, 2025
Merged
Conversation
branfosj
approved these changes
Jan 8, 2025
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
2 participants
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.
Not using
toc.integrateimplies that the table of contents of a page is shown in a sidebar on the right, rather than being integrated in the menu on the left.A small downside of that is that the body of the documentation in the middle is less wide, but perhaps that's not a bad thing (shorter line make for easier reading).
The Materials for MkDocs documentation nicely shows an example of the effect, see https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#navigation-integration
The main motivation for this to make the menu on the left a bit less daunting, and pages which do not have a menu entry on the left (like https://docs.easybuild.io/easybuild-v5/backwards-incompatible-changes/ for example)