mkdocs-minify-html-plugin 0.3.6__cp313-cp313-win_arm64.whl

mkdocs_minify_html_plugin/_minify_html.pyi

@@ -0,0 +1,20 @@
+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/plugin.py

@@ -0,0 +1,51 @@
+from __future__ import annotations
+
+import sys
+from typing import Optional
+
+from mkdocs.config import config_options as c
+from mkdocs.config.base import Config
+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
+
+if sys.version_info >= (3, 12):
+    from typing import override
+else:
+    from typing_extensions import override
+
+
+class MinifyHtmlConfig(Config):
+    allow_noncompliant_unquoted_attribute_values = c.Type(bool, default=False)
+    allow_optimal_entities = c.Type(bool, default=False)
+    allow_removing_spaces_between_attributes = c.Type(bool, default=False)
+    keep_closing_tags = c.Type(bool, default=False)
+    keep_comments = c.Type(bool, default=False)
+    keep_html_and_head_opening_tags = c.Type(bool, default=False)
+    keep_input_type_text_attr = c.Type(bool, default=True)
+    keep_ssi_comments = c.Type(bool, default=False)
+    minify_css = c.Type(bool, default=True)
+    minify_doctype = c.Type(bool, default=False)
+    minify_js = c.Type(bool, default=True)
+    preserve_brace_template_syntax = c.Type(bool, default=False)
+    preserve_chevron_percent_template_syntax = c.Type(bool, default=False)
+    remove_bangs = c.Type(bool, default=False)
+    remove_processing_instructions = c.Type(bool, default=False)
+
+
+class MinifyHtmlPlugin(BasePlugin[MinifyHtmlConfig]):
+    @override
+    def on_post_page(
+        self, output: str, *, page: Page, config: MkDocsConfig
+    ) -> Optional[str]:
+        return minify(output, **self.config)
+
+    @override
+    def on_post_template(
+        self, output_content: str, *, template_name: str, config: MkDocsConfig
+    ) -> Optional[str]:
+        if template_name.endswith(".html"):
+            return minify(output_content, **self.config)
+        return output_content

mkdocs_minify_html_plugin-0.3.6.dist-info/METADATA

@@ -0,0 +1,83 @@
+Metadata-Version: 2.4
+Name: mkdocs-minify-html-plugin
+Version: 0.3.6
+Classifier: Framework :: MkDocs
+Classifier: Natural Language :: English
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Classifier: Programming Language :: Rust
+Classifier: Typing :: Typed
+Requires-Dist: mkdocs>=1.4
+Requires-Dist: typing-extensions>=4.4 ; python_full_version < '3.12'
+License-File: LICENSE
+Summary: MkDocs plugin for minification using minify-html, an extremely fast and smart HTML + JS + CSS minifier
+Author-email: monosans <hsyqixco@protonmail.com>
+Requires-Python: >=3.9
+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
+
+[![CI](https://github.com/monosans/mkdocs-minify-html-plugin/actions/workflows/ci.yml/badge.svg)](https://github.com/monosans/mkdocs-minify-html-plugin/actions/workflows/ci.yml)
+[![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.
+
+## Usage
+
+Install:
+
+```bash
+pip install -U mkdocs-minify-html-plugin
+```
+
+Activate in `mkdocs.yml`:
+
+```yaml
+plugins:
+  - search
+  - minify_html
+```
+
+## 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:
+
+```yaml
+plugins:
+  - search
+  - minify_html:
+      allow_noncompliant_unquoted_attribute_values: false
+      allow_optimal_entities: false
+      allow_removing_spaces_between_attributes: false
+      keep_closing_tags: false
+      keep_comments: false
+      keep_html_and_head_opening_tags: false
+      keep_input_type_text_attr: true
+      keep_ssi_comments: false
+      minify_css: true
+      minify_doctype: false
+      minify_js: true
+      preserve_brace_template_syntax: false
+      preserve_chevron_percent_template_syntax: false
+      remove_bangs: false
+      remove_processing_instructions: false
+```
+
+## License
+
+[MIT](https://github.com/monosans/mkdocs-minify-html-plugin/blob/main/LICENSE)
+

mkdocs_minify_html_plugin-0.3.6.dist-info/RECORD

@@ -0,0 +1,10 @@
+mkdocs_minify_html_plugin-0.3.6.dist-info/METADATA,sha256=XybWOphn81C_vSRqOVsu1HIpycU-L2Mzl-js3qzfnFQ,3011
+mkdocs_minify_html_plugin-0.3.6.dist-info/WHEEL,sha256=Bi2q0P5TlSZ2TKT0DV_meIlrmEQw_X7vRzNoWK-e7hA,96
+mkdocs_minify_html_plugin-0.3.6.dist-info/entry_points.txt,sha256=A_wXAYr3Az8ibTw3A3u7BQYvmPDu5zNeOgAWcg2CUR4,79
+mkdocs_minify_html_plugin-0.3.6.dist-info/licenses/LICENSE,sha256=CXoglBzFBps3W6thE0bcqKjrms8H1rtzq7Vf3tXrxUQ,1086
+mkdocs_minify_html_plugin/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+mkdocs_minify_html_plugin/_minify_html.cp313-win_arm64.pyd,sha256=FaYM1U8wb2WTHG5zRZ3FHGd6djEO6aAFdzU44gymBMw,15869952
+mkdocs_minify_html_plugin/_minify_html.pyi,sha256=hpIaalCWhA9ReQ7Cy4yNgBOeThypb6_dccR1Bi7LR9Q,609
+mkdocs_minify_html_plugin/plugin.py,sha256=haxjg1yTELVQBreiUPr09Y12sjkl2tjnOwiUyNKPunY,1919
+mkdocs_minify_html_plugin/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+mkdocs_minify_html_plugin-0.3.6.dist-info/RECORD,,

mkdocs_minify_html_plugin-0.3.6.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: maturin (1.9.6)
+Root-Is-Purelib: false
+Tag: cp313-cp313-win_arm64

mkdocs_minify_html_plugin-0.3.6.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[mkdocs.plugins]
+minify_html=mkdocs_minify_html_plugin.plugin:MinifyHtmlPlugin

mkdocs_minify_html_plugin-0.3.6.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 monosans
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.