django-spaceless-templates 1.0

Simple Django template loader that minifies html output.

Django application, providing simple template loader. It reduces HTML output in templates by stripping out whitespace characters between HTML and django template tags. This is an update of django-template-minifier that works with django 1.10.

Things to note:

• It does not make any fancy compression, to do that use GZip Middleware.

• To compress CSS and JS use django-compressor.

Installation

• via virtualenv - yup we highly recommend it!

pip install django-spaceless-templates

Basic usage

Modify Your Django project settings’s module.

For production (note cached loader):

TEMPLATES = [
  {
      'DIRS': [
          str(APPS_DIR.path('templates')),
      ],
      'OPTIONS': {
          'loaders': [
              (
                  'django.template.loaders.cached.Loader', [
                      'django_spaceless_templates.loaders.filesystem.Loader',
                      'django_spaceless_templates.loaders.app_directories.Loader',
                  ],
              ),
          ],
      },
  },
]

For development (each refresh reloads template):

TEMPLATES = [
  {
      'DIRS': [
          str(APPS_DIR.path('templates')),
      ],
      'OPTIONS': {
          'loaders': [
              'django_spaceless_templates.loaders.filesystem.Loader',
              'django_spaceless_templates.loaders.app_directories.Loader',
          ],
      },
  },
]

Be happy having less spaces and new lines in Your templates!

Advanced usage:

Using modified settings You can:

• turn on stripping only for templates with given extensions

TEMPLATE_MINIFIER_FILENAME_EXTENSIONS = ('.html', '.htm', )

• turn off stripping for particular directories

TEMPLATE_MINIFIER_EXCLUDED_DIRS = ('admin/', )

• turn off all stripping

TEMPLATE_MINIFIER = False # default = True

• run Your own strip_function, which preprocess templates

TEMPLATE_MINIFIER_STRIP_FUNCTION = 'template_minifier.utils.strip_spaces_in_template'

• use only in production

if DEBUG:
  TEMPLATE_MINIFIER = False

Known issues:

• Don’t use // one line comments in Your inline javascript <script> or .js templates. In some cases, if You are using lot of {% if %} there, it can comment out }; or }, for example:

// comment something - !!it's evil!!
{% if %}
function name(){
}
{% endif %}

Use /* */ instead

/* comment something - it's nice and clean <3! */
{% if %}
function name(){
}
{% endif %}

Or just set TEMPLATE_MINIFIER_TEMPLATE_TAGS = False

• Don’t use multiline {% blockquote %} without parameter trimmed. Otherwise your blockquote translations won’t be translated. Correct usage:

{% blockquote trimmed %}
    My paragraph...
{% blockquote %}

Running Tests:

(myenv) $ pip install -e .
(myenv) $ python ./runtests.py

Check package:

python -m build; python -m twine check dist/*

To do:

• {% new_line %} template_tag