1
0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-11-30 18:24:35 +01:00
mkdocs-material/docs/plugins/minify-html.md
Martin B c44ea77172 Separated plugin documentation from extensions (#1390)
* Create minify-html.md

* Rename docs/minify-html.md to docs/plugins/minify-html.md

* Create search.md

* Update and rename docs/extensions/revision-date.md to docs/plugins/revision-date.md

* Update getting-started.md

* Update mkdocs.yml
2019-12-18 17:13:17 +01:00

745 B

Minify HTML

mkdocs-minify-plugin is an extension that minifies HTML by stripping all whitespace from the generated documentation.

Installation

Install the plugin using pip with the following command:

pip install mkdocs-minify-plugin

Next, add the following lines to your mkdocs.yml:

plugins:
  - search
  - minify:
      minify_html: true

!!! warning "Remember to re-add the search plugin"

If you have no `plugins` entry in your config file yet, you'll likely also
want to add the `search` plugin. MkDocs enables it by default if there is
no `plugins` entry set.

Usage

The output is automatically minified by the plugin.