Create book from markdown files. Like Gitbook but implemented in Rust
Go to file
Jacek Sieka 5c8941ba16 Add Nim to default languages
Nim is a systems programming language (included in the highlight.js
`system` group), and we're quite happily using `mdBook` in several of
our documentation projects starting with our [style
guide](https://status-im.github.io/nim-style-guide/).

While we can maintain our own highlight.js, including `Nim` in the
default distribution would allow us to promote more mdBook usage in the
Nim community at the cost of a ~2kb increase in the `highlight.js` size.
2023-11-08 15:34:35 +01:00
.github Use a better merge-queue success check. 2023-07-29 09:13:55 -07:00
ci Rewrite asset deploy. 2023-07-16 17:16:15 -07:00
examples upgrade clap to 4.0 2022-12-14 17:11:08 -08:00
guide Add Nim to default languages 2023-11-08 15:34:35 +01:00
src Add Nim to default languages 2023-11-08 15:34:35 +01:00
test_book Add Nim to default languages 2023-11-08 15:34:35 +01:00
tests Fix search for custom heading attributes 2023-05-28 12:03:03 -07:00
.gitattributes Explicitly mark fonts and images files as binary (#951) 2019-06-11 21:44:15 +02:00
.gitignore Setup basic structure for test book 2021-10-04 13:14:49 +05:30
CHANGELOG.md Update to 0.4.35 2023-09-29 14:33:45 -07:00
CODE_OF_CONDUCT.md add explicit code of conduct, copying other rust-lang repos 2021-07-26 11:52:24 -07:00
CONTRIBUTING.md Add Nim to default languages 2023-11-08 15:34:35 +01:00
Cargo.lock Update to 0.4.35 2023-09-29 14:33:45 -07:00
Cargo.toml Update to 0.4.35 2023-09-29 14:33:45 -07:00
LICENSE Create LICENSE 2015-07-29 01:11:30 +02:00
README.md Update documentation 2021-12-19 20:26:37 -08:00
release.toml Metadata for cargo-release should be in release.toml (#722) 2018-07-09 18:36:55 +08:00
triagebot.toml Add issue templates and update contributor docs 2023-01-16 09:22:54 -08:00

README.md

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.

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.