History

Michael Howell 8266ea9f9c Add the cache generator subcommand and docs for custom syntaxes		2022-08-15 14:03:09 -07:00
..
cli	Update documentation	2021-12-19 20:26:37 -08:00
for_developers	style: add missing word	2022-02-22 18:00:41 +02:00
format	Add the cache generator subcommand and docs for custom syntaxes	2022-08-15 14:03:09 -07:00
guide	Mention how to uninstall.	2022-06-27 11:10:09 -07:00
misc	Use syntect instead of highlight.js	2022-08-15 14:03:09 -07:00
404.md	Rename `book-example` to `guide` (#1336 )	2020-09-23 03:16:09 +02:00
README.md	Update documentation	2021-12-19 20:26:37 -08:00
SUMMARY.md	Update documentation	2021-12-19 20:26:37 -08:00
continuous-integration.md	Update to 0.4.21	2022-07-22 10:54:53 -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.