MkDocs Minify Plugin

Warnings

• breaking MkDocs 1.5 compatibility was introduced in plugin version 0.7.0. If you are using MkDocs 1.5 or newer, you must use mkdocs-minify-plugin version 0.7.0 or later to ensure compatibility and avoid potential build errors.
  Fix: Upgrade mkdocs-minify-plugin to version 0.7.0 or higher: `pip install --upgrade mkdocs-minify-plugin`.
• gotcha When you explicitly define a `plugins` section in your `mkdocs.yml`, MkDocs no longer implicitly enables the built-in `search` plugin. To retain search functionality alongside `minify`, you must explicitly list `search` in your `plugins` section.
  Fix: Ensure your `plugins` section includes `- search` if desired: `plugins: \n - search \n - minify: ...`.
• gotcha Enabling `minify_js: true` or `minify_css: true` alone is not sufficient. You must also specify the JavaScript and CSS files to be minified using the `js_files` and `css_files` options (which support glob patterns).
  Fix: Provide explicit `js_files` and `css_files` lists when enabling JS/CSS minification, for example: `js_files: ['**/*.js']`.
• deprecated Versions prior to 0.6.2 might experience issues with minifying modern ES6 JavaScript due to `jsmin` not always being called with the appropriate `quote_chars` option.
  Fix: Upgrade to `mkdocs-minify-plugin` version 0.6.2 or newer to improve JavaScript minification compatibility: `pip install --upgrade mkdocs-minify-plugin`.
• deprecated Versions prior to 0.6.3 may produce a `DeprecationWarning` related to an older `htmlmin` dependency during the build process.
  Fix: Upgrade to `mkdocs-minify-plugin` version 0.6.3 or newer to resolve the `htmlmin` deprecation warning: `pip install --upgrade mkdocs-minify-plugin`.

Install

• pip install mkdocs-minify-plugin Install latest version

Quickstart

Add the `minify` plugin to your `mkdocs.yml` file under the `plugins` section. Remember to also explicitly add the `search` plugin if you don't have other plugins defined, as MkDocs disables default plugins when a `plugins` section is present. Configure `minify_html`, `minify_js`, `minify_css`, and specify `js_files`/`css_files` for minification.

plugins:
  - search # Often needed, see warnings
  - minify:
      minify_html: true
      minify_js: true
      minify_css: true
      htmlmin_opts:
        remove_comments: true
      cache_safe: true
      js_files:
        - '**/*.js'
      css_files:
        - '**/*.css'