1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
|
pelican-htmlmin
###############
A `Pelican <https://github.com/getpelican/pelican/>`_ plugin using
`htmlmin <https://github.com/mankyd/htmlmin>`_ to remove comments and extra
whitespace from your website.
Turning this:
.. code-block:: html
<head>
<title> Hello, World! </title>
</head>
<body>
<p> How <em>you</em> doing? </p>
</body>
Into this:
.. code-block:: html
<head><title>Hello, World!</title><body><p> How <em>you</em> doing? </p></body>
Installing
##########
:code:`pelican-htmlmin`, is available on :code:`pip` and takes advantage of
Pelican's namespace system to automatically register installed plugins.
Just install with :code:`pip` and you're ready to go:
.. code-block::
$ pip install pelican-htmlmin
For a more detailed plugin installation guide, please refer to the
`Pelican Plugin Documentation`_.
.. _`Pelican Plugin Documentation`: https://docs.getpelican.com/en/latest/plugins.html
Options
#######
Being a very small wrapper around :code:`htmlmin`, there are only a few options
that you may need.
HTMLMIN_ENABLED
===============
By Default, if Pelican is in :code:`DEBUG` mode, :code:`pelican-htmlmin` will
not minify any files, to help with debugging. To override this, set
:code:`HTMLMIN_ENABLED = True` to minify files regardless of the
:code:`DEBUG` flag.
.. code-block:: python
HTMLMIN_ENABLED = logger.getEffectiveLevel() > logging.DEBUG
HTMLMIN_MATCH
=============
Out of the box, :code:`pelican-htmlmin` looks for files ending with
:code:`.html` or :code:`.htm` to minify. You can use the :code:`HTMLMIN_MATCH`
to change the regular expression that matches the files you wish to minify.
.. code-block:: python
HTMLMIN_MATCH = r'.html?$'
HTMLMIN_OPTIONS
===============
If you wish to pass arguments directly to :code:`htmlmin`, use the
:code:`HTMLMIN_OPTIONS` to pass keyword arguments.
.. code-block:: python
HTMLMIN_OPTIONS = {
'remove_comments': True,
'remove_all_empty_space': True,
'remove_optional_attribute_quotes': False
}
For more information on the arguments you can give :code:`htmlmin`, see their
`documentation here
<https://htmlmin.readthedocs.io/en/latest/reference.html#main-functions>`_
Contributing
############
Please feel free to help. `Buying me Beer
<https://www.buymeacoffee.com/bryanbrattlof>`_, emailing issues, or `patches via
email <https://bryanbrattlof.com/connect/>`_, are all warmly welcomed,
especially beer.
.. image:: https://img.shields.io/badge/license-MIT-green.svg
:alt: License: MIT
|
