jesus/mdbook
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
mdbook/guide/src
History
Eric Huss 1b55d4a389 Add sidebar heading navigation 
This adds dynamic navigation of headers of the current page in the
sidebar. This is intended to help the user see what is on the current
page, and to be able to more easily navigate it. The "current" header is
tracked based on the scrolling behavior of the user, and is marked with
a small circle. This includes automatic folding to help keep it from
being too unwieldy on a page with a lot of nested headers.

This includes the `output.html.sidebar-header-nav` option to disable it.

I'm sure there are tweaks, fixes, and improvements that can be made. I'd
like to get this out now, and iterate on it over time to make
improvements.
2025-08-27 14:44:12 -07:00
..
cli Change CLI dest-dir to be relative to the current directory 2025-08-18 16:28:08 -07:00
for_developers Rename Book.sections to Book.items 2025-08-22 18:51:04 -07:00
format Add sidebar heading navigation 2025-08-27 14:44:12 -07:00
guide Use consistent sentence case for section headers 2025-08-16 14:59:05 -07:00
misc Update documentation 2021-12-19 20:26:37 -08:00
404.md Rename book-example to guide (#1336) 2020-09-23 03:16:09 +02:00
continuous-integration.md Use consistent sentence case for section headers 2025-08-16 14:59:05 -07:00
README.md Update documentation 2021-12-19 20:26:37 -08:00
SUMMARY.md Use consistent sentence case for section headers 2025-08-16 14:59:05 -07:00

README.md

Introduction

mdBook is a command line tool to create books with Markdown. It is ideal for creating product or API documentation, tutorials, course materials or anything that requires a clean, easily navigable and customizable presentation.

  • Lightweight Markdown syntax helps you focus more on your content
  • Integrated search support
  • Color syntax highlighting for code blocks for many different languages
  • Theme files allow customizing the formatting of the output
  • Preprocessors can provide extensions for custom syntax and modifying content
  • Backends can render the output to multiple formats
  • Written in Rust for speed, safety, and simplicity
  • Automated testing of Rust code samples

This guide is an example of what mdBook produces. mdBook is used by the Rust programming language project, and The Rust Programming Language book is another fine example of mdBook in action.

Contributing

mdBook is free and open source. You can find the source code on GitHub and issues and feature requests can be posted on the GitHub issue tracker. mdBook relies on the community to fix bugs and add features: if you'd like to contribute, please read the CONTRIBUTING guide and consider opening a pull request.

License

The mdBook source and documentation are released under the Mozilla Public License v2.0.