mirror of
https://github.com/Hopiu/djLint.git
synced 2026-04-12 18:00:57 +00:00
58 lines
2.8 KiB
Markdown
58 lines
2.8 KiB
Markdown
# 
|
|
|
|
Find common formatting issues and *reformat* HTML templates.
|
|
|
|
***[Django](https://django.readthedocs.io/en/stable/ref/templates/language.html) · [Jinja](https://jinja2docs.readthedocs.io/en/stable/) · [Nunjucks](https://mozilla.github.io/nunjucks/) · [Twig](https://twig.symfony.com) · [Handlebars](https://handlebarsjs.com) · [Mustache](http://mustache.github.io/mustache.5.html) · [GoLang](https://pkg.go.dev/text/template)***
|
|
|
|
Ps, ``--check`` it out on other templates as well!
|
|
|
|
[](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)[](https://discord.gg/taghAqebzU) [](https://pypi.org/project/djlint/)
|
|
|
|
## Documentation
|
|
|
|
Read the [documentation](https://djlint.com)
|
|
|
|
## 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
|
|
|
|
# using stdin
|
|
echo "<div></div>" | djlint -
|
|
|
|
```
|
|
|
|
## 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
|
|
|
|
Send a pr with a new feature, or checkout the [issue](https://github.com/Riverside-Healthcare/djlint/issues) list and help where you can.
|