mdbook/crates/mdbook-core
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-core

Documentation crates.io Changelog

This is the base support library for mdBook. It is intended for internal use only. Other mdBook crates depend on this for any types that are shared across the crates.

This crate is maintained by the mdBook team, primarily for use by mdBook and not intended for external use (except as a transitive dependency). This crate may make major changes to its APIs or be deprecated without warning.

License

Mozilla Public License, version 2.0