Hopiu/djLint
1
0
Fork 0
mirror of https://github.com/Hopiu/djLint.git synced 2026-03-16 21:40:24 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

changed to md

Browse source
This commit is contained in:
Christopher Pickering 2021-07-29 14:12:14 -05:00
parent e1ab337cf6
commit 8e7d2d3112
No known key found for this signature in database
GPG key ID: E14DB3B0A0FACF84
3 changed files with 37 additions and 54 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

35
README.md Normal file
View file

@ -0,0 +1,35 @@
# 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](https://codecov.io/gh/Riverside-Healthcare/djlint/branch/master/graph/badge.svg?token=eNTG721BAA)](https://codecov.io/gh/Riverside-Healthcare/djlint) [![test](https://github.com/Riverside-Healthcare/djlint/actions/workflows/test.yml/badge.svg)](https://github.com/Riverside-Healthcare/djlint/actions/workflows/test.yml) [![Codacy Badge](https://app.codacy.com/project/badge/Grade/dba6338b0e7a4de896b45b382574f369)](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](https://api.codeclimate.com/v1/badges/5febe4111a36c7e0d2ed/maintainability)](https://codeclimate.com/github/Riverside-Healthcare/djlint/maintainability)
## Documentation
Read the [documentation](https://djlint.readthedocs.io)
## Show your format
Add a badge to your projects ```readme.md```:
```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```:
```rst
.. image:: https://img.shields.io/badge/html%20style-djlint-blue.svg
:target: https://github.com/Riverside-Healthcare/djlint
```
Looks like this:
[![djlint](https://img.shields.io/badge/html%20style-djlint-blue.svg)](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!

52
README.rst
View file

@ -1,52 +0,0 @@
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

4
setup.py
View file

@ -12,7 +12,7 @@ __version__ = "0.1.2"
def long_description():
"""Build long description from readme and changelog."""
return (
(project_path / "README.rst").read_text(encoding="utf8")
(project_path / "README.md").read_text(encoding="utf8")
+ "\n\n"
+ (project_path / "CHANGELOG.md").read_text(encoding="utf8")
)
@ -31,7 +31,7 @@ setup(
author_email="cpickering@rhc.net",
description="Django Template Linter",
long_description=long_description(),
long_description_content_type="text/x-rst",
long_description_content_type="text/markdown",
url="https://github.com/Riverside-Healthcare/djlint",
include_package_data=True,
package_data={"djlint": ["rules.yaml"]},