mdBook/README.md

1.3 KiB

mdBook

Build Status crates.io 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:
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.