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

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

Last synced: about 1 month ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/rust-lang/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-03-04T17:42:36.000Z (about 1 month ago)
• Last Synced: 2025-03-05T15:53:24.200Z (about 1 month ago)
• Language: Rust
• Homepage: https://rust-lang.github.io/mdBook/
• Size: 5.77 MB
• Stars: 19,119
• Watchers: 122
• Forks: 1,697
• Open Issues: 602
• 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

• stars - rust-lang/mdBook
• awesomeLibrary - mdBook - Create book from markdown files. Like Gitbook but implemented in Rust (语言资源库 / rust)
• awesome-tools - rust-lang/mdBook - Create book from markdown files. Like Gitbook but implemented in Rust (Command Line / Dependency Management)
• awesome - rust-lang/mdBook - Create book from markdown files. Like Gitbook but implemented in Rust (Rust)
• awesome-ccamel - rust-lang/mdBook - Create book from markdown files. Like Gitbook but implemented in Rust (Rust)
• my-awesome-github-stars - rust-lang/mdBook - Create book from markdown files. Like Gitbook but implemented in Rust (Rust)
• awesome-starred-test - rust-lang/mdBook - Create book from markdown files. Like Gitbook but implemented in Rust (Rust)
• awesome-github-repos - rust-lang/mdBook - Create book from markdown files. Like Gitbook but implemented in Rust (Rust)
• awesome-rust - mdBook - lang/mdBook/workflows/CI/badge.svg?branch=master)](https://github.com/rust-lang/mdBook/actions) (Applications)
• awesome-repositories - rust-lang/mdBook - Create book from markdown files. Like Gitbook but implemented in Rust (Rust)
• awesome-list - mdBook - lang | 7094 | (Rust)
• awesome-docs - mdBook
• awesome-rust - mdBook - A command line utility to create books from markdown files [](https://github.com/rust-lang/mdBook/actions) (Applications)
• my-awesome - rust-lang/mdBook - 04 star:19.3k fork:1.7k Create book from markdown files. Like Gitbook but implemented in Rust (Rust)
• project-awesome - rust-lang/mdBook - Create book from markdown files. Like Gitbook but implemented in Rust (Rust)
• awesome-starred - rust-lang/mdBook - Create book from markdown files. Like Gitbook but implemented in Rust (others)
• StarryDivineSky - rust-lang/mdBook
• awesome-rust - mdBook - 命令行工具，用于从Markdown文件创建电子书。 (应用程序)
• awesome-rust - mdBook - 命令行工具，用于从Markdown文件创建电子书。 (应用程序)
• jimsghstars - rust-lang/mdBook - Create book from markdown files. Like Gitbook but implemented in Rust (Rust)
• awesome-starred - rust-lang/mdBook - Create book from markdown files. Like Gitbook but implemented in Rust (Rust)
• awesome-starred - rust-lang/mdBook - Create book from markdown files. Like Gitbook but implemented in Rust (Rust)
• awesome-documentation - mdBook - lang/mdBook) - Create book from markdown files. Like Gitbook but implemented in Rust. (General Tools / Site Builder)
• awesome-homelab - mdBook - lang/mdBook?style=flat)  | Create book from markdown files. Like Gitbook but implemented in Rust | (Apps / Writing)
• stars - rust-lang/mdBook - Create book from markdown files. Like Gitbook but implemented in Rust \[*Mozilla Public License 2.0*\] (⭐️19366) (Rust)
• fucking-awesome-rust - mdBook - A command line utility to create books from markdown files [](https://github.com/rust-lang/mdBook/actions) (Applications)
• stars - rust-lang/mdBook - Create book from markdown files. Like Gitbook but implemented in Rust \[*Mozilla Public License 2.0*\] (⭐️18600) (Rust)

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