2021-07-29 19:52:55 +00:00
2021-07-29 19:12:14 +00:00
2021-07-29 19:58:04 +00:00
Simple html template linter and reformatter to find common formatting issues. djLint is intended as a django template linter and django template formatter.
2021-07-29 19:12:14 +00:00
Ps, ```--check``` it out on Jinja and Handlebar templates as well!
2021-07-30 13:51:45 +00:00
[](https://codecov.io/gh/Riverside-Healthcare/djlint) [](https://github.com/Riverside-Healthcare/djlint/actions/workflows/test.yml) [](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) [](https://codeclimate.com/github/Riverside-Healthcare/djlint/maintainability) [](https://pepy.tech/project/djlint)
2021-07-29 19:12:14 +00:00
## Documentation
Read the [documentation ](https://djlint.readthedocs.io )
2021-07-30 13:56:31 +00:00
## Installation and Usage
djLint can be installed with `pip install djlint` , and is easy to run:
```sh
# to lint a directory
djlint /path
# to lint a directory with custom extension
djlint /path -e html.dj
# to check formatting on a file
djlint /path/file.html.j2 --check
# to reformt a directory without printing the file diff
djlint /path --reformat --quiet
```
2021-07-29 19:12:14 +00:00
## Show your format
Add a badge to your projects ```readme.md```:
```md
[](https://github.com/Riverside-Healthcare/djlint)
```
Add a badge to your ```readme.rst```:
```rst
.. image:: https://img.shields.io/badge/html%20style-djlint-blue.svg
:target: https://github.com/Riverside-Healthcare/djlint
```
Looks like this:
[](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!
