mdbook/crates/mdbook-driver
Eric Huss 3e673ce424 Switch from log to tracing
This switches to using the tracing crate instead of log. Tracing
provides a lot of nice features which we can take advantage of moving
forward.

This also adjusts the output fairly significantly. This includes:

- Switched the environment variable from RUST_LOG to MDBOOK_LOG.
- Dropped the timestamp. I experimented with various different time
  displays, but ultimately decided to omit it for now. I don't think
  I've ever found it to be useful, and it takes up a very significant
  amount of space. It could potentially be useful for basic profiling,
  but I think there are other, better mechanisms for that. We could
  consider leveraging tracing itself for doing some basic profiling
  (like using something like tracing-chrome).
- Dropped the target unless MDBOOK_LOG is set. The target tends to be
  pretty noisy, and doesn't really convey much information unless you
  are debugging or otherwise trying to adjust the log output.
- Added color.
- Slightly reworked the way the error cause trace is displayed.
- Slightly changed the way html5ever filtering is done, as well as add
  handlebars to the list since they both are very noisy. You can
  override this now by explicitly listing them as targets.

I still expect that mdbook will eventually change how it displays things
to the console, possibly switching away from tracing and printing things
itself. However, that is a larger project for the future.
2025-09-12 06:13:45 -07:00
..
src Switch from log to tracing 2025-09-12 06:13:45 -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