mdbook/crates/mdbook-driver
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
..
src Clean up some fs-related utilities 2025-09-20 17:13:31 -07:00
Cargo.toml Switch from log to tracing 2025-09-12 06:13:45 -07:00
README.md Add READMEs for all new crates 2025-07-23 17:47:31 -07:00

mdbook-driver

Documentation crates.io Changelog

This is the high-level Rust library for running mdBook. New books can be created using BookBuilder. The primary type MDBook can be used to manage and render books.

This crate is maintained by the mdBook team for use by the wider ecosystem. This crate follows semver compatibility for its APIs.

License

Mozilla Public License, version 2.0