wilhelmer / mkdocs-minify-plugin

A mkdocs plugin to minify the HTML of a page before it is written to disk.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

mkdocs-minify-plugin

An MkDocs plugin to minify HTML and/or JS files prior to being written to disk.

HTML minification is done using htmlmin.

JS minification is done using jsmin.

Setup

Install the plugin using pip:

pip install mkdocs-minify-plugin

Activate the plugin in mkdocs.yml:

plugins:
  - search
  - minify:
      minify_html: true
      minify_js: true
      htmlmin_opts:
          remove_comments: true
      js_files:
          - my/javascript/dir/file1.js
          - my/javascript/dir/file2.js

Note: 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, but now you have to enable it explicitly.

Options

  • minify_html: Sets whether HTML files should be minified. Defaults to false.
  • htmlmin_opts: Sets runtime htmlmin API options using the config parameters of htmlmin
  • minify_js: Sets whether JS files should be minified. Defaults to false. If set to true, you must specificy the JS to be minified files using js_files (see below).
  • js_files: List of JS files to be minified. The plugin will generate minified versions of these files and save them as .min.js in the output directory.

Note: When using minify_js, you don't have to modify the extra_javascript entries in your mkdocs.yml file. The plugins automatically takes care of that.

More information about plugins in the MkDocs documentation.

See Also

More information about templates here.

More information about blocks here.

About

A mkdocs plugin to minify the HTML of a page before it is written to disk.

License:MIT License


Languages

Language:Python 97.9%Language:Shell 2.1%