Create book from markdown files. Like Gitbook but implemented in Rust
Go to file
Johannes Gloeckle c144c26dcf Reduce allocations in `fs::copy_files_except_ext`
Above mentioned function copies files (recursively) from a source to a
destination directory. For that, file/directory paths have to be created
repeatedly. This allocates as directory and file names are concatenated
into an owning path structure.

The number of allocations can be reduced by creating file/directory
paths only once and borrowing them instead of cloning/recreating them.

In bigger projects, this reduces execution time noticeably. Please note
that file system operations are dominant from performance POV.
2024-04-07 10:43:23 +02:00
.github Update env_logger to 0.11 2024-02-05 14:22:21 -08: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 Rename curly-quotes to smart-punctuation. 2024-02-25 13:42:44 -08:00
src Reduce allocations in `fs::copy_files_except_ext` 2024-04-07 10:43:23 +02:00
test_book Add MathJax tests. 2024-02-25 14:53:10 -08:00
tests Merge pull request #2308 from ehuss/pulldown_cmark-0.10 2024-02-05 22:21:55 +00: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.37 2024-02-06 19:34:15 -08: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.37 2024-02-06 19:34:15 -08:00
Cargo.toml Update to 0.4.37 2024-02-06 19:34:15 -08: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.