.. djlint documentation master file, created by
   sphinx-quickstart on Tue Jul 27 15:28:35 2021.

HTML Template Linter and Formatter
==================================

.. toctree::
   :hidden:
   :glob:
   :maxdepth: 1
   :titlesonly:

   Welcome<self>
   djlint/usage
   djlint/rules
   djlint/formatter
   djlint/configuration
   djlint/best_practices
   djlint/changelog

.. toctree::
   :hidden:

   GitHub ↪ <https://github.com/Riverside-Healthcare/djlint>
   PyPI ↪ <https://pypi.org/project/djlint/>
   Discord ↪ <https://discord.gg/taghAqebzU>


Find common formatting issues and *reformat* HTML templates.

*Django · Jinja · Nunjucks · Handlebars*

Ps, ``--check`` it out on other templates as well!

.. image:: /_static/demo.gif

|codecov| |test| |Codacy Badge| |Maintainability| |Downloads| |chat|

.. note:: djLint is not an html parser or syntax validator.


Show your format
----------------

Add a badge to your projects `readme.md`:

.. code-block:: md

   [![Code style: djLint](https://img.shields.io/badge/html%20style-djLint-blue.svg)](https://github.com/Riverside-Healthcare/djlint)


Add a badge to your `readme.rst`:

.. code-block:: rst

   .. image:: https://img.shields.io/badge/html%20style-djLint-blue.svg
      :target: https://github.com/Riverside-Healthcare/djlint


Looks like this:

.. image:: https://img.shields.io/badge/html%20style-djLint-blue.svg
   :target: https://github.com/Riverside-Healthcare/djlint


Contributing - Please Help!
---------------------------

Send a pr with a new feature, or checkout the `issue <https://github.com/Riverside-Healthcare/djlint/issues>`_ list and help where you can.

.. |codecov| image:: https://codecov.io/gh/Riverside-Healthcare/djlint/branch/master/graph/badge.svg?token=eNTG721BAA
   :target: https://codecov.io/gh/Riverside-Healthcare/djlint
.. |test| image:: https://github.com/Riverside-Healthcare/djlint/actions/workflows/test.yml/badge.svg
   :target: https://github.com/Riverside-Healthcare/djlint/actions/workflows/test.yml
.. |Codacy Badge| image:: https://app.codacy.com/project/badge/Grade/dba6338b0e7a4de896b45b382574f369
   :target: https://www.codacy.com/gh/Riverside-Healthcare/djlint/dashboard?utm_source=github.com&utm_medium=referral&utm_content=Riverside-Healthcare/djlint&utm_campaign=Badge_Grade
.. |Maintainability| image:: https://api.codeclimate.com/v1/badges/5febe4111a36c7e0d2ed/maintainability
   :target: https://codeclimate.com/github/Riverside-Healthcare/djlint/maintainability
.. |Downloads| image:: https://img.shields.io/pypi/dm/djlint.svg
   :target: https://pypi.org/project/djlint/
.. |chat| image:: https://img.shields.io/badge/chat-discord-green
   :target: https://discord.gg/taghAqebzU