-
Notifications
You must be signed in to change notification settings - Fork 17
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.
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
base: master
Are you sure you want to change the base?
Conversation
…feature Co-authored-by: yarikoptic <[email protected]>
| accent: "light blue" | ||
| features: | ||
| - toc.integrate | ||
| features: [] |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
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.
|
Is there a dev branch deployment of docs to try out what this feels like? |
The documentation lacked a right-side table of contents for in-page navigation, similar to BIDS specification and GitHub's markdown viewer.
Changes
toc.integratefeature from MkDocs Material theme configurationpreviews
## ResultBefore: TOC integrated into left navigation sidebar

After: TOC displayed on right side for in-page navigation


Original prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.