mkdocs-material/docs/plugins/minification.md

1.0 KiB

template
overrides/main.html

Minification

The mkdocs-minify-plugin will minify all *.html files generated by mkdocs build in a post-processing step, stripping all unnecessary characters to reduce the payload served to the client.

!!! success "Bundled with the official Docker image"

This plugin is already installed for your convenience when you use the
official [Docker image][2], so the installation step can be skipped. Read
the [getting started guide][3] to get up and running with Docker.

Installation

Install the plugin using pip:

pip install mkdocs-minify-plugin

Configuration

Add the following lines to mkdocs.yml:

plugins:
  - search # necessary for search to work
  - minify:
      minify_html: true

Usage

When enabled, all *.html will be minified automatically.