mkdocs-minify-html-plugin 0.3.14__tar.gz → 0.3.16__tar.gz

{mkdocs_minify_html_plugin-0.3.14 → mkdocs_minify_html_plugin-0.3.16}/Cargo.lock

@@ -722,7 +722,7 @@ dependencies = [
 
 [[package]]
 name = "mkdocs-minify-html-plugin"
-version = "0.3.14"
+version = "0.3.16"
 dependencies = [
  "minify-html",
  "pyo3",

{mkdocs_minify_html_plugin-0.3.14 → mkdocs_minify_html_plugin-0.3.16}/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "mkdocs-minify-html-plugin"
-version = "0.3.14"
+version = "0.3.16"
 edition = "2024"
 license = "MIT"
 include = [

{mkdocs_minify_html_plugin-0.3.14 → mkdocs_minify_html_plugin-0.3.16}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocs-minify-html-plugin
-Version: 0.3.14
+Version: 0.3.16
 Classifier: Framework :: MkDocs
 Classifier: Natural Language :: English
 Classifier: Operating System :: MacOS
@@ -27,17 +27,19 @@ Requires-Python: >=3.11
 Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
 Project-URL: repository, https://github.com/monosans/mkdocs-minify-html-plugin
 
-# mkdocs-minify-html-plugin
+# <img src="https://raw.githubusercontent.com/monosans/mkdocs-minify-html-plugin/main/assets/logo.svg" alt="" width="40" align="top"> mkdocs-minify-html-plugin
 
 [![Downloads](https://static.pepy.tech/badge/mkdocs-minify-html-plugin)](https://pepy.tech/project/mkdocs-minify-html-plugin)
 
-MkDocs plugin for minification using [minify-html](https://github.com/wilsonzlin/minify-html), an extremely fast and smart HTML + JS + CSS minifier.
+MkDocs plugin that minifies the built HTML pages, including inline CSS and JS, with [minify-html](https://github.com/wilsonzlin/minify-html).
 
 ## Usage
 
 Install:
 
 ```bash
+uv add --dev mkdocs-minify-html-plugin
+# or
 pip install -U mkdocs-minify-html-plugin
 ```
 
@@ -51,9 +53,7 @@ plugins:
 
 ## Options
 
-A description of all options is available in the [minify_html docs](https://docs.rs/minify-html/0.16.4/minify_html/struct.Cfg.html#fields).
-
-The default plugin options are aimed at the best possible minification while maintaining compliance with the specification:
+The options are the fields of minify-html's [`Cfg`](https://docs.rs/minify-html/latest/minify_html/struct.Cfg.html#fields). The defaults aim for the smallest output that stays spec-compliant:
 
 ```yaml
 plugins:

{mkdocs_minify_html_plugin-0.3.14 → mkdocs_minify_html_plugin-0.3.16}/README.md

@@ -1,14 +1,16 @@
-# mkdocs-minify-html-plugin
+# <img src="https://raw.githubusercontent.com/monosans/mkdocs-minify-html-plugin/main/assets/logo.svg" alt="" width="40" align="top"> mkdocs-minify-html-plugin
 
 [![Downloads](https://static.pepy.tech/badge/mkdocs-minify-html-plugin)](https://pepy.tech/project/mkdocs-minify-html-plugin)
 
-MkDocs plugin for minification using [minify-html](https://github.com/wilsonzlin/minify-html), an extremely fast and smart HTML + JS + CSS minifier.
+MkDocs plugin that minifies the built HTML pages, including inline CSS and JS, with [minify-html](https://github.com/wilsonzlin/minify-html).
 
 ## Usage
 
 Install:
 
 ```bash
+uv add --dev mkdocs-minify-html-plugin
+# or
 pip install -U mkdocs-minify-html-plugin
 ```
 
@@ -22,9 +24,7 @@ plugins:
 
 ## Options
 
-A description of all options is available in the [minify_html docs](https://docs.rs/minify-html/0.16.4/minify_html/struct.Cfg.html#fields).
-
-The default plugin options are aimed at the best possible minification while maintaining compliance with the specification:
+The options are the fields of minify-html's [`Cfg`](https://docs.rs/minify-html/latest/minify_html/struct.Cfg.html#fields). The defaults aim for the smallest output that stays spec-compliant:
 
 ```yaml
 plugins:

{mkdocs_minify_html_plugin-0.3.14 → mkdocs_minify_html_plugin-0.3.16}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "mkdocs-minify-html-plugin"
-version = "0.3.14"
+version = "0.3.16"
 description = "MkDocs plugin for minification using minify-html, an extremely fast and smart HTML + JS + CSS minifier"
 readme = "README.md"
 requires-python = ">=3.11"

mkdocs_minify_html_plugin-0.3.16/python/mkdocs_minify_html_plugin/_minify_html.pyi

@@ -0,0 +1,24 @@
+from typing import final
+
+@final
+class Minifier:
+    def __init__(
+        self,
+        *,
+        allow_noncompliant_unquoted_attribute_values: bool,
+        allow_optimal_entities: bool,
+        allow_removing_spaces_between_attributes: bool,
+        keep_closing_tags: bool,
+        keep_comments: bool,
+        keep_html_and_head_opening_tags: bool,
+        keep_input_type_text_attr: bool,
+        keep_ssi_comments: bool,
+        minify_css: bool,
+        minify_doctype: bool,
+        minify_js: bool,
+        preserve_brace_template_syntax: bool,
+        preserve_chevron_percent_template_syntax: bool,
+        remove_bangs: bool,
+        remove_processing_instructions: bool,
+    ) -> None: ...
+    def minify(self, code: str, /) -> str: ...

{mkdocs_minify_html_plugin-0.3.14 → mkdocs_minify_html_plugin-0.3.16}/python/mkdocs_minify_html_plugin/plugin.py

@@ -8,7 +8,7 @@ from mkdocs.config.defaults import MkDocsConfig
 from mkdocs.plugins import BasePlugin
 from mkdocs.structure.pages import Page
 
-from mkdocs_minify_html_plugin._minify_html import minify
+from mkdocs_minify_html_plugin._minify_html import Minifier
 
 if sys.version_info >= (3, 12):
     from typing import override
@@ -35,16 +35,23 @@ class MinifyHtmlConfig(Config):
 
 
 class MinifyHtmlPlugin(BasePlugin[MinifyHtmlConfig]):
+    _minifier: Minifier
+
+    @override
+    def on_config(self, config: MkDocsConfig) -> MkDocsConfig | None:
+        self._minifier = Minifier(**self.config)
+        return config
+
     @override
     def on_post_page(
         self, output: str, *, page: Page, config: MkDocsConfig
     ) -> str | None:
-        return minify(output, **self.config)
+        return self._minifier.minify(output)
 
     @override
     def on_post_template(
         self, output_content: str, *, template_name: str, config: MkDocsConfig
     ) -> str | None:
         if template_name.endswith(".html"):
-            return minify(output_content, **self.config)
+            return self._minifier.minify(output_content)
         return output_content

mkdocs_minify_html_plugin-0.3.16/src/lib.rs

@@ -0,0 +1,130 @@
+#![deny(
+    warnings,
+    deprecated_safe,
+    future_incompatible,
+    keyword_idents,
+    let_underscore,
+    nonstandard_style,
+    refining_impl_trait,
+    rust_2018_compatibility,
+    rust_2018_idioms,
+    rust_2021_compatibility,
+    rust_2024_compatibility,
+    unused,
+    clippy::all,
+    clippy::pedantic,
+    clippy::restriction,
+    clippy::nursery,
+    clippy::cargo
+)]
+#![allow(
+    clippy::absolute_paths,
+    clippy::allow_attributes_without_reason,
+    clippy::arbitrary_source_item_ordering,
+    clippy::as_conversions,
+    clippy::blanket_clippy_restriction_lints,
+    clippy::cast_precision_loss,
+    clippy::cognitive_complexity,
+    clippy::else_if_without_else,
+    clippy::float_arithmetic,
+    clippy::implicit_return,
+    clippy::integer_division_remainder_used,
+    clippy::iter_over_hash_type,
+    clippy::min_ident_chars,
+    clippy::missing_docs_in_private_items,
+    clippy::mod_module_files,
+    clippy::multiple_crate_versions,
+    clippy::pattern_type_mismatch,
+    clippy::question_mark_used,
+    clippy::separated_literal_suffix,
+    clippy::shadow_reuse,
+    clippy::shadow_unrelated,
+    clippy::single_call_fn,
+    clippy::single_char_lifetime_names,
+    clippy::std_instead_of_alloc,
+    clippy::std_instead_of_core,
+    clippy::too_many_lines,
+    clippy::unwrap_used
+)]
+
+use pyo3::prelude::*;
+
+#[pymodule]
+mod _minify_html {
+    use pyo3::prelude::*;
+
+    /// Minifies HTML with options set once, so that each page only passes
+    /// its code.
+    #[pyclass(frozen, module = "mkdocs_minify_html_plugin._minify_html")]
+    struct Minifier(::minify_html::Cfg);
+
+    #[pymethods]
+    impl Minifier {
+        #[new]
+        #[pyo3(signature = (
+            *,
+            allow_noncompliant_unquoted_attribute_values,
+            allow_optimal_entities,
+            allow_removing_spaces_between_attributes,
+            keep_closing_tags,
+            keep_comments,
+            keep_html_and_head_opening_tags,
+            keep_input_type_text_attr,
+            keep_ssi_comments,
+            minify_css,
+            minify_doctype,
+            minify_js,
+            preserve_brace_template_syntax,
+            preserve_chevron_percent_template_syntax,
+            remove_bangs,
+            remove_processing_instructions,
+        ))]
+        #[expect(clippy::fn_params_excessive_bools, clippy::too_many_arguments)]
+        const fn new(
+            allow_noncompliant_unquoted_attribute_values: bool,
+            allow_optimal_entities: bool,
+            allow_removing_spaces_between_attributes: bool,
+            keep_closing_tags: bool,
+            keep_comments: bool,
+            keep_html_and_head_opening_tags: bool,
+            keep_input_type_text_attr: bool,
+            keep_ssi_comments: bool,
+            minify_css: bool,
+            minify_doctype: bool,
+            minify_js: bool,
+            preserve_brace_template_syntax: bool,
+            preserve_chevron_percent_template_syntax: bool,
+            remove_bangs: bool,
+            remove_processing_instructions: bool,
+        ) -> Self {
+            Self(::minify_html::Cfg {
+                allow_noncompliant_unquoted_attribute_values,
+                allow_optimal_entities,
+                allow_removing_spaces_between_attributes,
+                keep_closing_tags,
+                keep_comments,
+                keep_html_and_head_opening_tags,
+                keep_input_type_text_attr,
+                keep_ssi_comments,
+                minify_css,
+                minify_doctype,
+                minify_js,
+                preserve_brace_template_syntax,
+                preserve_chevron_percent_template_syntax,
+                remove_bangs,
+                remove_processing_instructions,
+            })
+        }
+
+        #[pyo3(signature = (code, /))]
+        fn minify<'py>(
+            &self,
+            py: Python<'py>,
+            code: &str,
+        ) -> PyResult<Bound<'py, pyo3::types::PyString>> {
+            let minified =
+                py.detach(|| ::minify_html::minify(code.as_bytes(), &self.0));
+            pyo3::types::PyString::from_bytes(py, &minified)
+        }
+    }
+}

mkdocs_minify_html_plugin-0.3.14/python/mkdocs_minify_html_plugin/_minify_html.pyi

@@ -1,20 +0,0 @@
-def minify(
-    code: str,
-    /,
-    *,
-    allow_noncompliant_unquoted_attribute_values: bool,
-    allow_optimal_entities: bool,
-    allow_removing_spaces_between_attributes: bool,
-    keep_closing_tags: bool,
-    keep_comments: bool,
-    keep_html_and_head_opening_tags: bool,
-    keep_input_type_text_attr: bool,
-    keep_ssi_comments: bool,
-    minify_css: bool,
-    minify_doctype: bool,
-    minify_js: bool,
-    preserve_brace_template_syntax: bool,
-    preserve_chevron_percent_template_syntax: bool,
-    remove_bangs: bool,
-    remove_processing_instructions: bool,
-) -> str: ...

mkdocs_minify_html_plugin-0.3.14/src/lib.rs

@@ -1,119 +0,0 @@
-#![deny(
-    warnings,
-    deprecated_safe,
-    future_incompatible,
-    keyword_idents,
-    let_underscore,
-    nonstandard_style,
-    refining_impl_trait,
-    rust_2018_compatibility,
-    rust_2018_idioms,
-    rust_2021_compatibility,
-    rust_2024_compatibility,
-    unused,
-    clippy::all,
-    clippy::pedantic,
-    clippy::restriction,
-    clippy::nursery,
-    clippy::cargo
-)]
-#![allow(
-    clippy::absolute_paths,
-    clippy::allow_attributes_without_reason,
-    clippy::arbitrary_source_item_ordering,
-    clippy::as_conversions,
-    clippy::blanket_clippy_restriction_lints,
-    clippy::cast_precision_loss,
-    clippy::cognitive_complexity,
-    clippy::else_if_without_else,
-    clippy::float_arithmetic,
-    clippy::implicit_return,
-    clippy::integer_division_remainder_used,
-    clippy::iter_over_hash_type,
-    clippy::min_ident_chars,
-    clippy::missing_docs_in_private_items,
-    clippy::mod_module_files,
-    clippy::multiple_crate_versions,
-    clippy::pattern_type_mismatch,
-    clippy::question_mark_used,
-    clippy::separated_literal_suffix,
-    clippy::shadow_reuse,
-    clippy::shadow_unrelated,
-    clippy::single_call_fn,
-    clippy::single_char_lifetime_names,
-    clippy::std_instead_of_alloc,
-    clippy::std_instead_of_core,
-    clippy::too_many_lines,
-    clippy::unwrap_used
-)]
-
-use pyo3::prelude::*;
-
-#[pymodule]
-mod _minify_html {
-    use pyo3::prelude::*;
-
-    #[pyfunction]
-    #[pyo3(signature = (
-        code,
-        /,
-        *,
-        allow_noncompliant_unquoted_attribute_values,
-        allow_optimal_entities,
-        allow_removing_spaces_between_attributes,
-        keep_closing_tags,
-        keep_comments,
-        keep_html_and_head_opening_tags,
-        keep_input_type_text_attr,
-        keep_ssi_comments,
-        minify_css,
-        minify_doctype,
-        minify_js,
-        preserve_brace_template_syntax,
-        preserve_chevron_percent_template_syntax,
-        remove_bangs,
-        remove_processing_instructions,
-    ))]
-    #[expect(clippy::fn_params_excessive_bools, clippy::too_many_arguments)]
-    fn minify<'py>(
-        py: Python<'py>,
-        code: &str,
-        allow_noncompliant_unquoted_attribute_values: bool,
-        allow_optimal_entities: bool,
-        allow_removing_spaces_between_attributes: bool,
-        keep_closing_tags: bool,
-        keep_comments: bool,
-        keep_html_and_head_opening_tags: bool,
-        keep_input_type_text_attr: bool,
-        keep_ssi_comments: bool,
-        minify_css: bool,
-        minify_doctype: bool,
-        minify_js: bool,
-        preserve_brace_template_syntax: bool,
-        preserve_chevron_percent_template_syntax: bool,
-        remove_bangs: bool,
-        remove_processing_instructions: bool,
-    ) -> PyResult<Bound<'py, pyo3::types::PyString>> {
-        let minified = py.detach(move || {
-            let cfg = ::minify_html::Cfg {
-                allow_noncompliant_unquoted_attribute_values,
-                allow_optimal_entities,
-                allow_removing_spaces_between_attributes,
-                keep_closing_tags,
-                keep_comments,
-                keep_html_and_head_opening_tags,
-                keep_input_type_text_attr,
-                keep_ssi_comments,
-                minify_css,
-                minify_doctype,
-                minify_js,
-                preserve_brace_template_syntax,
-                preserve_chevron_percent_template_syntax,
-                remove_bangs,
-                remove_processing_instructions,
-            };
-            ::minify_html::minify(code.as_bytes(), &cfg)
-        });
-        pyo3::types::PyString::from_bytes(py, &minified)
-    }
-}