mirror of
https://github.com/rust-lang/mdBook
synced 2024-12-13 14:22:35 +00:00
20 lines
1 KiB
Markdown
20 lines
1 KiB
Markdown
# mdBook
|
|
|
|
[![Build Status](https://github.com/rust-lang/mdBook/workflows/CI/badge.svg?event=push)](https://github.com/rust-lang/mdBook/actions?workflow=CI)
|
|
[![crates.io](https://img.shields.io/crates/v/mdbook.svg)](https://crates.io/crates/mdbook)
|
|
[![LICENSE](https://img.shields.io/github/license/rust-lang/mdBook.svg)](LICENSE)
|
|
|
|
mdBook is a utility to create modern online books from Markdown files.
|
|
|
|
Check out the **[User Guide]** for a list of features and installation and usage information.
|
|
The User Guide also serves as a demonstration to showcase what a book looks like.
|
|
|
|
If you are interested in contributing to the development of mdBook, check out the [Contribution Guide].
|
|
|
|
## License
|
|
|
|
All the code in this repository is released under the ***Mozilla Public License v2.0***, for more information take a look at the [LICENSE] file.
|
|
|
|
[User Guide]: https://rust-lang.github.io/mdBook/
|
|
[contribution guide]: https://github.com/rust-lang/mdBook/blob/master/CONTRIBUTING.md
|
|
[LICENSE]: https://github.com/rust-lang/mdBook/blob/master/LICENSE
|