2021-07-25 09:41:53 +08:00
|
|
|
# Introduction
|
2015-07-30 17:59:08 +08:00
|
|
|
|
2021-12-20 12:26:37 +08:00
|
|
|
**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][trpl] book is another fine example of mdBook in action.
|
|
|
|
|
|
|
|
|
|
[Markdown]: format/markdown.md
|
|
|
|
|
[search]: guide/reading.md#search
|
|
|
|
|
[syntax highlighting]: format/theme/syntax-highlighting.md
|
|
|
|
|
[theme]: format/theme/index.html
|
|
|
|
|
[preprocessors]: format/configuration/preprocessors.md
|
|
|
|
|
[backends]: format/configuration/renderers.md
|
|
|
|
|
[Rust]: https://www.rust-lang.org/
|
|
|
|
|
[trpl]: https://doc.rust-lang.org/book/
|
|
|
|
|
[Rust code samples]: cli/test.md
|
2015-08-06 21:24:34 +08:00
|
|
|
|
2021-07-25 09:41:53 +08:00
|
|
|
## Contributing
|
|
|
|
|
|
|
|
|
|
mdBook is free and open source. You can find the source code on
|
|
|
|
|
[GitHub](https://github.com/rust-lang/mdBook) and issues and feature requests can be posted on
|
|
|
|
|
the [GitHub issue tracker](https://github.com/rust-lang/mdBook/issues). mdBook relies on the community to fix bugs and
|
|
|
|
|
add features: if you'd like to contribute, please read
|
|
|
|
|
the [CONTRIBUTING](https://github.com/rust-lang/mdBook/blob/master/CONTRIBUTING.md) guide and consider opening
|
|
|
|
|
a [pull request](https://github.com/rust-lang/mdBook/pulls).
|
2015-08-06 21:24:34 +08:00
|
|
|
|
2015-07-30 17:59:08 +08:00
|
|
|
## License
|
|
|
|
|
|
2021-07-25 12:17:41 +08:00
|
|
|
The mdBook source and documentation are released under
|
2021-07-25 09:41:53 +08:00
|
|
|
the [Mozilla Public License v2.0](https://www.mozilla.org/MPL/2.0/).
|
