jesus/mdbook
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1
No description
2930 commits 2 branches 0 tags 9.1 MiB
Find a file
Eric Huss 797112ef36 Clean up some fs-related utilities 
This does a little cleanup around the usage of filesystem functions:

- Add `mdbook_core::utils::fs::read_to_string` as a wrapper around
  `std::fs::read_to_string` to provide better error messages. Use
  this wherever a file is read.
- Add `mdbook_core::utils::fs::create_dir_all` as a wrapper around
  `std::fs::create_dir_all` to provide better error messages. Use
  this wherever a file is read.
- Replace `mdbook_core::utils::fs::write_file` with `write` to mirror
  the `std::fs::write` API.
- Remove `mdbook_core::utils::fs::create_file`. It was generally not
  used anymore.
- Scrub the usage of `std::fs` to use the new wrappers. This doesn't
  remove it 100%, but it is now significantly reduced.
2025-09-20 17:13:31 -07:00
.github Add a new HTML rendering pipeline 2025-09-16 20:26:35 -07:00
ci Support publishing a pre-release version of the guide 2025-09-04 17:08:49 -07:00
crates Clean up some fs-related utilities 2025-09-20 17:13:31 -07:00
examples Add an iterator over chapters 2025-09-15 07:11:19 -07:00
guide Add link to output.html.definition-lists 2025-09-18 20:20:25 -07:00
src Move get_404_output_file to HtmlConfig 2025-09-19 18:11:29 -07:00
test_book Add sidebar heading navigation 2025-08-27 14:44:12 -07:00
tests Clean up some fs-related utilities 2025-09-20 17:13:31 -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 Add a new HTML rendering pipeline 2025-09-16 20:26:35 -07:00
Cargo.toml Add a new HTML rendering pipeline 2025-09-16 20:26:35 -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
eslint.config.mjs Lint HBS JS templates 2025-08-25 15:15:47 -07:00
LICENSE Create LICENSE 2015-07-29 01:11:30 +02:00
package.json Update browser-ui-test version to 0.22.1 2025-09-08 17:25:08 +02: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

README.md

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.