summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTom Milligan <tom.milligan@uipath.com>2023-12-30 21:41:13 +0100
committerGitHub <noreply@github.com>2023-12-30 21:41:13 +0100
commit8a0ecc5dd17495f53e3ec9687e2d35494d7d1f27 (patch)
treebf353b754cf0d606fa9d4c2a91ba93e386bcd2ea
parentc4a05dae9dbb472d03cdd0e316e984939f10b9d3 (diff)
parent467f5f8f137dc441c4c063d4d842e90a657ee095 (diff)
Merge pull request #167 from tommilligan/prep-1.15.0v1.15.0
chore: prep v1.15.0 release
-rw-r--r--CHANGELOG.md8
-rw-r--r--Cargo.lock2
-rw-r--r--Cargo.toml2
-rw-r--r--src/custom.rs1
-rw-r--r--src/lib.rs5
5 files changed, 13 insertions, 5 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 73225fe..7deb916 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -2,13 +2,15 @@
## Unreleased
-### Changed
+## 1.15.0
+
+### Added
-- `additional-css` _UNIX_ style path normalization ([#161](https://github.com/tommilligan/mdbook-admonish/issues/161))
+- Support [custom directives](https://tommilligan.github.io/mdbook-admonish/overview.html#custom-blocks) with the new `mdbook-admonish generate-custom` helper. See the [mdbook-admonish book](https://tommilligan.github.io/mdbook-admonish/overview.html#custom-blocks) for guidance. Thanks to [@Sky9x](https://github.com/Sky9x) for helping design this feature! ([#165](https://github.com/tommilligan/mdbook-admonish/pull/165))
### Fixed
-- Typo from _prereprocessor_ to _preprocessor_
+- `additional-css` unix style path normalization. Thanks to [@carlocorradini](https://github.com/carlocorradini) for reporting and fixing! ([#163](https://github.com/tommilligan/mdbook-admonish/pull/163))
## 1.14.0
diff --git a/Cargo.lock b/Cargo.lock
index de3bc22..6462703 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -969,7 +969,7 @@ dependencies = [
[[package]]
name = "mdbook-admonish"
-version = "1.14.0"
+version = "1.15.0"
dependencies = [
"anyhow",
"clap",
diff --git a/Cargo.toml b/Cargo.toml
index 6b2be5a..43d73c9 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -1,6 +1,6 @@
[package]
name = "mdbook-admonish"
-version = "1.14.0"
+version = "1.15.0"
edition = "2021"
rust-version = "1.66.0"
diff --git a/src/custom.rs b/src/custom.rs
index 119e94f..a258422 100644
--- a/src/custom.rs
+++ b/src/custom.rs
@@ -67,6 +67,7 @@ fn directive_css(name: &str, svg_data: &str, tint: HexColor) -> String {
)
}
+#[doc(hidden)]
pub fn css_from_config(book_dir: &Path, config: &str) -> Result<String> {
let config = crate::book_config::admonish_config_from_str(config)?;
let custom_directives = config.custom;
diff --git a/src/lib.rs b/src/lib.rs
index 66bf44b..da10931 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -1,5 +1,10 @@
+//! For usage and reference, see the [mdbook-admonish book](https://tommilligan.github.io/mdbook-admonish/)
+//!
+//! Documentation is hosted externally, as docs.rs does not currently support plugins.
+
mod book_config;
mod config;
+#[doc(hidden)]
pub mod custom;
mod markdown;
mod parse;