No description
Find a file
Eric Huss f4012757a7 Introduce options struct for markdown rendering
This adds `MarkdownOptions` for creating the pulldown-cmark parser, and
`HtmlRenderOptions` for converting markdown to HTML. These types should
help make it easier to extend the rendering options while remaining
semver compatible. It should also help with just general ergonomics of
using these functions.
2025-08-22 16:17:41 -07:00
.github Update to Rust 2024 2025-07-23 17:29:12 -07:00
ci Test more targets. 2024-05-16 17:27:28 -07:00
crates Introduce options struct for markdown rendering 2025-08-22 16:17:41 -07:00
examples Change PreProcessor::supports_renderer to return a Result 2025-08-16 13:26:01 -07:00
guide Change CLI dest-dir to be relative to the current directory 2025-08-18 16:28:08 -07:00
src Change CLI dest-dir to be relative to the current directory 2025-08-18 16:28:08 -07:00
test_book Add support for fragment redirects 2025-07-08 15:37:46 -07:00
tests Introduce options struct for markdown rendering 2025-08-22 16:17:41 -07:00
.eslintrc.json Fix eslint errors 2025-03-31 11:50:13 -07:00
.git-blame-ignore-revs Add .git-blame-ignore-revs 2025-07-23 17:29:53 -07:00
.gitattributes Mark more font files as binary 2025-04-05 20:41:36 -04:00
.gitignore Add testsuite book directories to ignore list 2025-04-22 21:11:54 -07:00
Cargo.lock Change with_renderer/with_preprocessor to overwrite 2025-08-18 11:18:31 -07:00
Cargo.toml Change with_renderer/with_preprocessor to overwrite 2025-08-18 11:18:31 -07:00
CHANGELOG.md Update to 0.4.52 2025-07-14 15:45:55 -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 Use consistent sentence case for section headers 2025-08-16 14:59:05 -07:00
LICENSE Create LICENSE 2015-07-29 01:11:30 +02:00
package.json Move theme to mdbook-html 2025-07-23 17:40:52 -07:00
README.md README.md: update workflow status badge 2025-02-13 11:01:08 -05:00
rustfmt.toml Add rustfmt.toml 2025-07-23 17:29:55 -07:00
triagebot.toml Add more triagebot features 2025-03-23 13:04:10 -07:00

mdBook

CI 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.