Add per page TOC in the rustc book
#140113
Open
+190
−0
Conversation
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
rustbot
added
the
S-waiting-on-review
Urgau
force-pushed
the
rustc-book-page-toc
branch
from
988a34a to
b266992
Compare
Urgau
commented
Apr 21, 2025
| @@ -0,0 +1,104 @@ | |||
| /* Inspired by https://github.com/JorelAli/mdBook-pagetoc/ */ | |||
There was a problem hiding this comment.
@davidtwco @wesleywiser, legal question here, pagetoc.css and pagetoc.js are both heavily inspired by https://github.com/JorelAli/mdBook-pagetoc/ which is licensed under the "WTFPL" license (Do What The F*ck You Want To Public License).
Is it okay for us to re-license those files under our dual license MIT/Apache-2?
There was a problem hiding this comment.
I will start a thread with the Foundation to see what they think.
|
cc @ehuss |
jieyouxu
added
T-compiler
jieyouxu
approved these changes
Apr 22, 2025
|
r? @ehuss (in case you have any concerns about the extra js/css of the book itself) |
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.
This PR adds per page Table of Content (TOC) in the
rustcbook (to be extended in the future to our other books).The goal is to easy the navigation inside the page by providing quick overview of the page content and our position inside that page.
That functionality is unfortunately not available natively in
mdbook, which prompted community members to create mdBook-pagetoc (which this PR is heavily inspired by). It's "only" a JS file (to handle the TOC) and a CSS file (to handle the margin, colors, screen size, ...), there is no "post-processor" needed (in mdbook sense).Live preview at: http://urgau.rf.gd/book
r? @jieyouxu