2016-04-02 11:38:53 +08:00
|
|
|
# mdBook
|
2016-03-08 08:03:44 +08:00
|
|
|
|
2020-03-23 20:22:12 +08:00
|
|
|
[](https://github.com/rust-lang/mdBook/actions?workflow=CI)
|
2019-10-21 05:44:28 +08:00
|
|
|
[](https://crates.io/crates/mdbook)
|
2019-10-29 21:04:16 +08:00
|
|
|
[](LICENSE)
|
2015-07-08 06:04:28 +08:00
|
|
|
|
2016-12-29 23:25:51 +08:00
|
|
|
mdBook is a utility to create modern online books from Markdown files.
|
2015-07-08 06:04:28 +08:00
|
|
|
|
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.
|
2015-07-30 18:58:54 +08:00
|
|
|
|
2021-12-20 12:26:37 +08:00
|
|
|
If you are interested in contributing to the development of mdBook, check out the [Contribution Guide].
|
2015-07-29 20:34:15 +08:00
|
|
|
|
2023-02-23 11:19:58 +08:00
|
|
|
## Container
|
|
|
|
|
|
|
|
|
|
> **NOTE**: You need to have docker installed
|
2023-11-24 00:46:42 +08:00
|
|
|
> https://docs.docker.com/engine/install/
|
2023-02-23 11:19:58 +08:00
|
|
|
|
|
|
|
|
1. Locate a local directory with md files
|
|
|
|
|
2. Quickly run a docker container with the current version:
|
|
|
|
|
|
|
|
|
|
```console
|
2023-11-24 00:46:42 +08:00
|
|
|
docker run -ti -v $(pwd):/mdbook -p 3000:3000 rust-lang/mdbook
|
2023-02-23 11:19:58 +08:00
|
|
|
```
|
|
|
|
|
|
2015-07-29 20:34:15 +08:00
|
|
|
## License
|
|
|
|
|
|
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.
|
|
|
|
|
|
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
|
