Skip to content

Enable right-side table of contents in MkDocs #217

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.

Sign up for GitHub

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Enable right-side table of contents in MkDocs #217

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2656dd4
Initial plan
Copilot Nov 12, 2025
8e0cdeb
Enable table of contents on the right side by removing toc.integrate …
Copilot Nov 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,7 @@ theme:
name: Light mode
primary: "dark blue"
accent: "light blue"
features:
- toc.integrate
features: []
Copy link
Member

@yarikoptic yarikoptic Nov 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@copilot could you check git history on when we added that toc.integrate here -- may be there is description on why we decided to go that way?

Copy link
Author

Copilot AI Nov 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The toc.integrate feature was added in commit 73ad53b by @yarikoptic on July 27, 2022, and merged via PR #73 on August 30, 2022.

The reasoning from the commit message was:

"Instead of having a separate TOC on the right, it would just expand already present navigation on the left, IMHO making 1. a better use of screen real estate, 2. no longer requiring user to jump with mouse from left to right to navigate"

However, the current issue #216 requests the opposite behavior to match modern documentation sites like BIDS specification and GitHub's markdown viewer, which display the TOC on the right side. The current PR removes toc.integrate to enable that right-side TOC display.

Copy link
Member

@yarikoptic yarikoptic Nov 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

WDYT @kabilar @satra ? boils down to

  • consistency with other portals vs more horizontal real estate

Copy link
Member

@kabilar kabilar Nov 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @yarikoptic, I prefer a single, unified navigation which is easier for me to navigate. And provides more space for content.


# Pages
nav:
Expand Down