https://rust-lang.github.io/mdBook/

Create book from markdown files. Like Gitbook but implemented in Rust
https://rust-lang.github.io/mdBook/

Last synced: 2 months ago
JSON representation

Create book from markdown files. Like Gitbook but implemented in Rust

• Host: GitHub
• URL: https://rust-lang.github.io/mdBook/
• Owner: rust-lang
• License: mpl-2.0
• Created: 2015-07-07T00:57:25.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2025-04-08T15:48:42.000Z (2 months ago)
• Last Synced: 2025-04-15T22:14:49.344Z (2 months ago)
• Language: Rust
• Homepage: https://rust-lang.github.io/mdBook/
• Size: 5.79 MB
• Stars: 19,438
• Watchers: 122
• Forks: 1,715
• Open Issues: 642
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• backend-cheats - mdBook
• awesome-plaintext - mdBook
• awesome-static-sites - mdBook - lang/mdBook) | Rust | Markdown | GitBook alternative implemented in Rust | (Frameworks by Type / Book and eBook Generators)
• awesome-static-sites - mdBook - lang/mdBook) | Rust | Markdown | GitBook alternative implemented in Rust | (Frameworks by Type / Documentation Generators)

README

        
# mdBook

[![CI Status](https://github.com/rust-lang/mdBook/actions/workflows/main.yml/badge.svg)](https://github.com/rust-lang/mdBook/actions/workflows/main.yml)

[![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