djLint/README.rst
2021-07-29 13:41:34 -05:00

52 lines
1.9 KiB
ReStructuredText

djLint
======
Simple html template linter and reformatter to find common formatting issues with and *reformat* django html templates
Ps, ``--check`` it out on Jinja and Handlebar templates as well!
|codecov| |test| |Codacy Badge| |Maintainability|
Documentation
-------------
Read the `documentation <https://djlint.readthedocs.io>`_
Show your format
----------------
Add a badge to your projects `readme.md`:
.. code-block:: md
[![Code style: black](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!
---------------------------
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