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].

## Container

> **NOTE**: You need to have docker installed
> https://docs.docker.com/language/golang/run-containers/

1. Locate a local directory with md files
2. Quickly run a docker container with the current version:

```console
docker run -ti -v $(pwd)/src:/src -p 3000:3000 rust-lang/mdbook
```

## 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 11:38:53 +08:00			`# mdBook`
Add windows (AppVeyor) build badge 2016-03-08 08:03:44 +08: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 20:22:12 +08: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-21 05:44:28 +08: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 21:04:16 +08:00			`[![LICENSE](https://img.shields.io/github/license/rust-lang/mdBook.svg)](LICENSE)`
Added README.md 2015-07-08 06:04:28 +08:00
Fix some minor typos 2016-12-29 23:25:51 +08:00			`mdBook is a utility to create modern online books from Markdown files.`
Added README.md 2015-07-08 06:04:28 +08:00
Update documentation 2021-12-20 12: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 18:58:54 +08:00
Update documentation 2021-12-20 12: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 20:34:15 +08:00
:memo: README: add container support for users without rust/cargo 2023-02-23 11:19:58 +08:00			`## Container`

			`> NOTE: You need to have docker installed`
			`> https://docs.docker.com/language/golang/run-containers/`

			`1. Locate a local directory with md files`
			`2. Quickly run a docker container with the current version:`

			```console
			`docker run -ti -v $(pwd)/src:/src -p 3000:3000 rust-lang/mdbook`
			```

Update README.md 2015-07-29 20:34:15 +08: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 21:04:16 +08: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`