https://github.com/apoorvaeternity/django-pygmento
A syntax highlighter for django templates based on Pygments - For django >= 4.0
https://github.com/apoorvaeternity/django-pygmento
code-highlighter django highlight pygmentize pygments python syntax syntax-highlighting template
Last synced: 29 days ago
JSON representation
A syntax highlighter for django templates based on Pygments - For django >= 4.0
- Host: GitHub
- URL: https://github.com/apoorvaeternity/django-pygmento
- Owner: apoorvaeternity
- License: bsd-2-clause
- Created: 2022-03-18T09:13:45.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2022-03-18T15:36:36.000Z (about 4 years ago)
- Last Synced: 2025-04-22T02:15:36.367Z (about 1 year ago)
- Topics: code-highlighter, django, highlight, pygmentize, pygments, python, syntax, syntax-highlighting, template
- Language: Python
- Homepage: https://pypi.org/project/django-pygmento/
- Size: 82 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# django-pygmento
> Syntax highlighter for django templates based on Pygments.
## Usage example
- Install the package using
```bash
pip install django-pygmento
```
- Add `pygmento` to `INSTALLED_APPS` in your settings file.
- Load `pygmento` template tag
```html
{% load pygmento %}
```
- Include pygment css in `head` using the `pygmento_css` template tag or manually generate it as described [here](https://pygments.org/docs/quickstart/#command-line-usage) and add it to static files.
```html
{% pygmento_css %}
```
- Use `pygmento` as shown below
```
# Single line code
{{ "print('hello')"|pygmento:"python" }}
# Multi-line code block in python
{% pygmentoblock "python" %}
class Dog:
def __init__(self, name):
self.name = name
self.tricks = [] # creates a new empty list for each dog
def add_trick(self, trick):
self.tricks.append(trick)
{% endpygmentoblock %}
# Multi-line code block in html
{% pygmentoblock "html" %}
My Heading
My paragraph.
{% endpygmentoblock %}
```
The above code will get rendered as
# Available styles
Styles can be set using `PYGMENTO_STYLE` setting.
```python
PYGMENTO_STYLE = "default"
```
See the list of available styles and how they look [here](https://pygments.org/styles/).
## Meta
Apoorva Pandey – apoorvapandey365@gmail.com
Distributed under the BSD license.
[https://github.com/apoorvaeternity](https://github.com/apoorvaeternity)
## Contributing
1. Fork it ()
2. Create your feature branch (`git checkout -b feature/fooBar`)
3. Commit your changes (`git commit -m 'Add some fooBar'`)
4. Push to the branch (`git push origin feature/fooBar`)
5. Create a new Pull Request