From e0a4fb1ea96db2501dfc04142dec9223bbe1b5ff Mon Sep 17 00:00:00 2001 From: Eric Huss Date: Wed, 23 Jul 2025 15:17:11 -0700 Subject: [PATCH] Add READMEs for all new crates --- crates/mdbook-core/README.md | 13 +++++++++++++ crates/mdbook-driver/README.md | 13 +++++++++++++ crates/mdbook-html/README.md | 13 +++++++++++++ crates/mdbook-markdown/README.md | 13 +++++++++++++ crates/mdbook-preprocessor/README.md | 13 +++++++++++++ crates/mdbook-renderer/README.md | 13 +++++++++++++ crates/mdbook-summary/README.md | 13 +++++++++++++ 7 files changed, 91 insertions(+) create mode 100644 crates/mdbook-core/README.md create mode 100644 crates/mdbook-driver/README.md create mode 100644 crates/mdbook-html/README.md create mode 100644 crates/mdbook-markdown/README.md create mode 100644 crates/mdbook-preprocessor/README.md create mode 100644 crates/mdbook-renderer/README.md create mode 100644 crates/mdbook-summary/README.md diff --git a/crates/mdbook-core/README.md b/crates/mdbook-core/README.md new file mode 100644 index 00000000..9d541479 --- /dev/null +++ b/crates/mdbook-core/README.md @@ -0,0 +1,13 @@ +# mdbook-core + +[![Documentation](https://img.shields.io/docsrs/mdbook-core)](https://docs.rs/mdbook-core) +[![crates.io](https://img.shields.io/crates/v/mdbook-core.svg)](https://crates.io/crates/mdbook-core) +[![Changelog](https://img.shields.io/badge/CHANGELOG-Latest-green)](https://github.com/rust-lang/mdBook/blob/master/CHANGELOG.md) + +This is the base support library for [mdBook](https://rust-lang.github.io/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](https://github.com/rust-lang/mdBook/blob/master/LICENSE) diff --git a/crates/mdbook-driver/README.md b/crates/mdbook-driver/README.md new file mode 100644 index 00000000..21cf8d63 --- /dev/null +++ b/crates/mdbook-driver/README.md @@ -0,0 +1,13 @@ +# mdbook-driver + +[![Documentation](https://img.shields.io/docsrs/mdbook-driver)](https://docs.rs/mdbook-driver) +[![crates.io](https://img.shields.io/crates/v/mdbook-driver.svg)](https://crates.io/crates/mdbook-driver) +[![Changelog](https://img.shields.io/badge/CHANGELOG-Latest-green)](https://github.com/rust-lang/mdBook/blob/master/CHANGELOG.md) + +This is the high-level Rust library for running [mdBook](https://rust-lang.github.io/mdBook/). New books can be created using [`BookBuilder`](https://docs.rs/mdbook-driver/latest/mdbook_driver/init/struct.BookBuilder.html). The primary type [`MDBook`](https://docs.rs/mdbook-driver/latest/mdbook_driver/struct.MDBook.html) 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](https://doc.rust-lang.org/cargo/reference/semver.html) for its APIs. + +## License + +[Mozilla Public License, version 2.0](https://github.com/rust-lang/mdBook/blob/master/LICENSE) diff --git a/crates/mdbook-html/README.md b/crates/mdbook-html/README.md new file mode 100644 index 00000000..ad11a4e4 --- /dev/null +++ b/crates/mdbook-html/README.md @@ -0,0 +1,13 @@ +# mdbook-html + +[![Documentation](https://img.shields.io/docsrs/mdbook-html)](https://docs.rs/mdbook-html) +[![crates.io](https://img.shields.io/crates/v/mdbook-html.svg)](https://crates.io/crates/mdbook-html) +[![Changelog](https://img.shields.io/badge/CHANGELOG-Latest-green)](https://github.com/rust-lang/mdBook/blob/master/CHANGELOG.md) + +This is the HTML renderer for [mdBook](https://rust-lang.github.io/mdBook/). This is intended for internal use only. It is automatically included by [`mdbook-driver`](https://crates.io/crates/mdbook-driver) to render books to HTML. + +> 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](https://github.com/rust-lang/mdBook/blob/master/LICENSE) diff --git a/crates/mdbook-markdown/README.md b/crates/mdbook-markdown/README.md new file mode 100644 index 00000000..53544f23 --- /dev/null +++ b/crates/mdbook-markdown/README.md @@ -0,0 +1,13 @@ +# mdbook-markdown + +[![Documentation](https://img.shields.io/docsrs/mdbook-markdown)](https://docs.rs/mdbook-markdown) +[![crates.io](https://img.shields.io/crates/v/mdbook-markdown.svg)](https://crates.io/crates/mdbook-markdown) +[![Changelog](https://img.shields.io/badge/CHANGELOG-Latest-green)](https://github.com/rust-lang/mdBook/blob/master/CHANGELOG.md) + +This is the Markdown support library for [mdBook](https://rust-lang.github.io/mdBook/). Rust crates (such as preprocessors) can use this library to process Markdown in the same way as mdBook. + +> This crate is maintained by the mdBook team for use by the wider ecosystem. This crate follows [semver compatibility](https://doc.rust-lang.org/cargo/reference/semver.html) for its APIs. + +## License + +[Mozilla Public License, version 2.0](https://github.com/rust-lang/mdBook/blob/master/LICENSE) diff --git a/crates/mdbook-preprocessor/README.md b/crates/mdbook-preprocessor/README.md new file mode 100644 index 00000000..1063d3fb --- /dev/null +++ b/crates/mdbook-preprocessor/README.md @@ -0,0 +1,13 @@ +# mdbook-preprocessor + +[![Documentation](https://img.shields.io/docsrs/mdbook-preprocessor)](https://docs.rs/mdbook-preprocessor) +[![crates.io](https://img.shields.io/crates/v/mdbook-preprocessor.svg)](https://crates.io/crates/mdbook-preprocessor) +[![Changelog](https://img.shields.io/badge/CHANGELOG-Latest-green)](https://github.com/rust-lang/mdBook/blob/master/CHANGELOG.md) + +This is the Rust library to implement a [preprocessor](https://rust-lang.github.io/mdBook/for_developers/preprocessors.html) for [mdBook](https://rust-lang.github.io/mdBook/). + +> This crate is maintained by the mdBook team for use by the wider ecosystem. This crate follows [semver compatibility](https://doc.rust-lang.org/cargo/reference/semver.html) for its APIs. + +## License + +[Mozilla Public License, version 2.0](https://github.com/rust-lang/mdBook/blob/master/LICENSE) diff --git a/crates/mdbook-renderer/README.md b/crates/mdbook-renderer/README.md new file mode 100644 index 00000000..11e9c821 --- /dev/null +++ b/crates/mdbook-renderer/README.md @@ -0,0 +1,13 @@ +# mdbook-renderer + +[![Documentation](https://img.shields.io/docsrs/mdbook-renderer)](https://docs.rs/mdbook-renderer) +[![crates.io](https://img.shields.io/crates/v/mdbook-renderer.svg)](https://crates.io/crates/mdbook-renderer) +[![Changelog](https://img.shields.io/badge/CHANGELOG-Latest-green)](https://github.com/rust-lang/mdBook/blob/master/CHANGELOG.md) + +This is the Rust library to implement a [renderer](https://rust-lang.github.io/mdBook/for_developers/backends.html) for [mdBook](https://rust-lang.github.io/mdBook/). + +> This crate is maintained by the mdBook team for use by the wider ecosystem. This crate follows [semver compatibility](https://doc.rust-lang.org/cargo/reference/semver.html) for its APIs. + +## License + +[Mozilla Public License, version 2.0](https://github.com/rust-lang/mdBook/blob/master/LICENSE) diff --git a/crates/mdbook-summary/README.md b/crates/mdbook-summary/README.md new file mode 100644 index 00000000..543335f3 --- /dev/null +++ b/crates/mdbook-summary/README.md @@ -0,0 +1,13 @@ +# mdbook-summary + +[![Documentation](https://img.shields.io/docsrs/mdbook-summary)](https://docs.rs/mdbook-summary) +[![crates.io](https://img.shields.io/crates/v/mdbook-summary.svg)](https://crates.io/crates/mdbook-summary) +[![Changelog](https://img.shields.io/badge/CHANGELOG-Latest-green)](https://github.com/rust-lang/mdBook/blob/master/CHANGELOG.md) + +This is the Rust library used to parse the [`SUMMARY.md`](https://rust-lang.github.io/mdBook/format/summary.html) file structure for [mdBook](https://rust-lang.github.io/mdBook/). + +> This crate is maintained by the mdBook team for use by the wider ecosystem. This crate follows [semver compatibility](https://doc.rust-lang.org/cargo/reference/semver.html) for its APIs. + +## License + +[Mozilla Public License, version 2.0](https://github.com/rust-lang/mdBook/blob/master/LICENSE)