2021-07-27 21:06:47 +00:00
|
|
|
|
.. djlint documentation master file, created by
|
|
|
|
|
|
sphinx-quickstart on Tue Jul 27 15:28:35 2021.
|
|
|
|
|
|
|
2021-09-08 08:46:40 +00:00
|
|
|
|
HTML Template Linter and Formatter
|
2021-07-29 18:41:34 +00:00
|
|
|
|
==================================
|
2021-07-27 21:06:47 +00:00
|
|
|
|
|
|
|
|
|
|
.. toctree::
|
2021-07-29 18:41:34 +00:00
|
|
|
|
:hidden:
|
|
|
|
|
|
:glob:
|
|
|
|
|
|
:maxdepth: 1
|
|
|
|
|
|
:titlesonly:
|
|
|
|
|
|
|
|
|
|
|
|
Welcome<self>
|
2021-07-29 18:46:15 +00:00
|
|
|
|
djlint/usage
|
|
|
|
|
|
djlint/rules
|
|
|
|
|
|
djlint/formatter
|
|
|
|
|
|
djlint/configuration
|
2021-09-30 08:02:05 +00:00
|
|
|
|
djlint/best_practices
|
2021-09-08 08:46:40 +00:00
|
|
|
|
djlint/changelog
|
2021-07-27 21:06:47 +00:00
|
|
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
|
:hidden:
|
|
|
|
|
|
|
|
|
|
|
|
GitHub ↪ <https://github.com/Riverside-Healthcare/djlint>
|
|
|
|
|
|
PyPI ↪ <https://pypi.org/project/djlint/>
|
2021-09-08 08:46:40 +00:00
|
|
|
|
Discord ↪ <https://discord.gg/taghAqebzU>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Find common formatting issues and *reformat* HTML templates.
|
|
|
|
|
|
|
2021-09-08 09:29:43 +00:00
|
|
|
|
*Django · Jinja · Nunjucks · Handlebars*
|
2021-09-08 08:46:40 +00:00
|
|
|
|
|
|
|
|
|
|
Ps, ``--check`` it out on other templates as well!
|
2021-07-29 18:41:34 +00:00
|
|
|
|
|
2021-07-30 20:18:38 +00:00
|
|
|
|
.. image:: /_static/demo.gif
|
|
|
|
|
|
|
2021-09-08 08:46:40 +00:00
|
|
|
|
|codecov| |test| |Codacy Badge| |Maintainability| |Downloads| |chat|
|
2021-07-29 18:41:34 +00:00
|
|
|
|
|
|
|
|
|
|
.. note:: djLint is not an html parser or syntax validator.
|
|
|
|
|
|
|
2021-09-20 09:33:23 +00:00
|
|
|
|
|
2021-07-29 18:41:34 +00:00
|
|
|
|
Show your format
|
|
|
|
|
|
----------------
|
|
|
|
|
|
|
|
|
|
|
|
Add a badge to your projects `readme.md`:
|
|
|
|
|
|
|
|
|
|
|
|
.. code-block:: md
|
|
|
|
|
|
|
2021-09-23 08:19:11 +00:00
|
|
|
|
[](https://github.com/Riverside-Healthcare/djlint)
|
2021-07-29 18:41:34 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Add a badge to your `readme.rst`:
|
|
|
|
|
|
|
|
|
|
|
|
.. code-block:: rst
|
|
|
|
|
|
|
2021-09-23 08:19:11 +00:00
|
|
|
|
.. image:: https://img.shields.io/badge/html%20style-djLint-blue.svg
|
2021-07-29 18:41:34 +00:00
|
|
|
|
:target: https://github.com/Riverside-Healthcare/djlint
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Looks like this:
|
|
|
|
|
|
|
2021-09-23 08:19:11 +00:00
|
|
|
|
.. image:: https://img.shields.io/badge/html%20style-djLint-blue.svg
|
2021-07-29 18:41:34 +00:00
|
|
|
|
:target: https://github.com/Riverside-Healthcare/djlint
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Contributing - Please Help!
|
|
|
|
|
|
---------------------------
|
|
|
|
|
|
|
2021-09-23 08:19:11 +00:00
|
|
|
|
Send a pr with a new feature, or checkout the `issue <https://github.com/Riverside-Healthcare/djlint/issues>`_ list and help where you can.
|
2021-07-29 18:41:34 +00:00
|
|
|
|
|
|
|
|
|
|
.. |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
|
2021-07-29 19:48:48 +00:00
|
|
|
|
.. |Downloads| image:: https://img.shields.io/pypi/dm/djlint.svg
|
|
|
|
|
|
:target: https://pypi.org/project/djlint/
|
2021-09-08 09:29:43 +00:00
|
|
|
|
.. |chat| image:: https://img.shields.io/badge/chat-discord-green
|
|
|
|
|
|
:target: https://discord.gg/taghAqebzU
|
