mdBook/README.md

# 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
Add documentation for Serve feature 2016-04-02 05:38:53 +02:00			`# mdBook`
Add windows (AppVeyor) build badge 2016-03-08 01:03:44 +01:00
Change CI badge to only push events (#1174) I noticed that the CI badge was failing and it seems to be caused by the fact that it reflects the latest build including PRs. This change filters the events to only "push events on the master branch" so the badge stays green even if a PR fails. 2020-03-23 13:22:12 +01:00			`[![Build Status](https://github.com/rust-lang/mdBook/workflows/CI/badge.svg?event=push)](https://github.com/rust-lang/mdBook/actions?workflow=CI)`
Switch to GitHub Actions. 2019-10-20 14:44:28 -07:00			`[![crates.io](https://img.shields.io/crates/v/mdbook.svg)](https://crates.io/crates/mdbook)`
rust-lang-nursery -> rust-lang Fixes #1080 2019-10-29 08:04:16 -05:00			`[![LICENSE](https://img.shields.io/github/license/rust-lang/mdBook.svg)](LICENSE)`
Added README.md 2015-07-08 00:04:28 +02:00
Fix some minor typos 2016-12-29 16:25:51 +01:00			`mdBook is a utility to create modern online books from Markdown files.`
Added README.md 2015-07-08 00:04:28 +02:00
Update documentation 2021-12-19 20:26:37 -08:00			`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.`
Added link to example 2015-07-30 12:58:54 +02:00
Update documentation 2021-12-19 20:26:37 -08:00			`If you are interested in contributing to the development of mdBook, check out the [Contribution Guide].`
Update README.md 2015-07-29 14:34:15 +02:00
			`## License`

Reformatted the README and added a link to the `master` docs (#525) 2018-01-05 11:32:54 +08:00			`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.`

rust-lang-nursery -> rust-lang Fixes #1080 2019-10-29 08:04:16 -05:00			`[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`