Awesome
mdBook-pagetoc
A page table of contents for mdBook. Currently supports mdBook 0.4.43.
What is this?
On 23rd June, I opened an issue for mdBook to add a table of contents for individual pages here. After some time, I noticed that there had been no response to the issue and decided to do something about it.
I don't know Rust and have very little experience in web development, but could not stand to not have this features any longer.
A sample of it in action can be viewed here.
How do I use it?
-
Copy these files to the
theme
directory in your mdBook.-
theme/pagetoc.js
, which handles the scrolling and clicking for the table of contents -
theme/pagetoc.css
which handles the styling -
theme/index.hbs
, which updates<main>
<main> <div class="content-wrap"> {{{ content }}} </div> <div class="sidetoc"> <nav class="pagetoc"></nav> </div> </main>
-
-
Add the following to your
book.toml
file:
[output.html]
additional-css = ["theme/pagetoc.css"]
additional-js = ["theme/pagetoc.js"]
- If you're still stuck, don't worry - this entire repository is an example of it working in action!
Acknowledgements
- This answer on Stack Overflow which has code for handling automatic highlighting for sidebar elements