Skip to main content

Minifies HTML files generated by Pelican

Project description

pelican-htmlmin

A Pelican plugin using htmlmin to remove comments and extra whitespace from your website.

Turning this:

<head>
  <title>  Hello, World!  </title>
</head>
<body>
  <p> How  <em>you</em> doing?  </p>
</body>

Into this:

<head><title>Hello, World!</title><body><p> How <em>you</em> doing? </p></body>

Installing

pelican-htmlmin, is available on pip and takes advantage of Pelican’s namespace system to automatically register installed plugins.

Just install with pip and you’re ready to go:

$ pip install pelican-htmlmin

For a more detailed plugin installation guide, please refer to the Pelican Plugin Documentation.

Options

Being a very small wrapper around htmlmin, there are only a few options that you may need.

HTMLMIN_ENABLED

By Default, if Pelican is in DEBUG mode, pelican-htmlmin will not minify any files, to help with debugging. To override this, set HTMLMIN_ENABLED = True to minify files regardless of the DEBUG flag.

HTMLMIN_ENABLED = logger.getEffectiveLevel() > logging.DEBUG

HTMLMIN_MATCH

Out of the box, pelican-htmlmin looks for files ending with .html or .htm to minify. You can use the HTMLMIN_MATCH to change the regular expression that matches the files you wish to minify.

HTMLMIN_MATCH = r'.html?$'

HTMLMIN_OPTIONS

If you wish to pass arguments directly to htmlmin, use the HTMLMIN_OPTIONS to pass keyword arguments.

HTMLMIN_OPTIONS = {
    'remove_comments': True,
    'remove_all_empty_space': True,
    'remove_optional_attribute_quotes': False
}

For more information on the arguments you can give htmlmin, see their documentation here

Contributing

Please feel free to help. Buying me Beer, emailing issues, or patches via email, are all warmly welcomed, especially beer.

License: MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pelican-htmlmin-2.0.0.tar.gz (3.5 kB view details)

Uploaded Source

Built Distribution

pelican_htmlmin-2.0.0-py3-none-any.whl (3.6 kB view details)

Uploaded Python 3

File details

Details for the file pelican-htmlmin-2.0.0.tar.gz.

File metadata

  • Download URL: pelican-htmlmin-2.0.0.tar.gz
  • Upload date:
  • Size: 3.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.6.1 requests/2.25.1 setuptools/52.0.0.post20210125 requests-toolbelt/0.9.1 tqdm/4.58.0 CPython/3.8.8

File hashes

Hashes for pelican-htmlmin-2.0.0.tar.gz
Algorithm Hash digest
SHA256 9be51a994bdd6916d2c5d313226761a161628ccd16adffa65cae99cca54b9598
MD5 ae392b2e242258dbd112fc0841011b5e
BLAKE2b-256 2964030c5a6ff21e1f1639d7666a60b2e36d9b759ad043b8368629074581fd4e

See more details on using hashes here.

File details

Details for the file pelican_htmlmin-2.0.0-py3-none-any.whl.

File metadata

  • Download URL: pelican_htmlmin-2.0.0-py3-none-any.whl
  • Upload date:
  • Size: 3.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.6.1 requests/2.25.1 setuptools/52.0.0.post20210125 requests-toolbelt/0.9.1 tqdm/4.58.0 CPython/3.8.8

File hashes

Hashes for pelican_htmlmin-2.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d18fa15d70fee9163dc91f7e12db73c337e1450a076592f37f9a8b895d6023fa
MD5 c1d99015f86665b42bcb70dfbecc8c95
BLAKE2b-256 27ef71c4e4baea6c483f53fc5c8ba58509c172c81d26294ce70a51233e626792

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page