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

stop using navigation integration #287

Merged
merged 1 commit into from
Jan 8, 2025

Conversation

boegel
Copy link
Member

@boegel boegel commented Jan 8, 2025

Not using toc.integrate implies 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)

@boegel boegel requested a review from branfosj January 8, 2025 12:39
@branfosj branfosj merged commit 23f0737 into easybuilders:develop Jan 8, 2025
4 checks passed
@boegel boegel deleted the no_toc_integrate branch January 8, 2025 12:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants