django-pygmento is a syntax highlighter based on Pygments for django>=4.0.0
Project description
django-pygmento
Syntax highlighter for django templates based on Pygments.
Usage example
- Install the package using
pip install django-pygmento
- Add
pygmentotoINSTALLED_APPSin your settings file. - Load
pygmentotemplate tag
{% load pygmento %}
- Include pygment css in
headusing thepygmento_csstemplate tag or manually generate it as described here and add it to static files.
<head>
{% pygmento_css %}
</head>
- Use
pygmentoas 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" %}
<!DOCTYPE html>
<html>
<body>
<h1>My Heading</h1>
<p>My paragraph.</p>
</body>
</html>
{% endpygmentoblock %}
The above code will get rendered as
Available styles
Styles can be set using PYGMENTO_STYLE setting.
PYGMENTO_STYLE = "default"
See the list of available styles and how they look here.
Meta
Apoorva Pandey – apoorvapandey365@gmail.com
Distributed under the BSD license.
https://github.com/apoorvaeternity
Contributing
- Fork it (https://github.com/apoorvaeternity/django-pygmento/)
- Create your feature branch (
git checkout -b feature/fooBar) - Commit your changes (
git commit -m 'Add some fooBar') - Push to the branch (
git push origin feature/fooBar) - Create a new Pull Request
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
django-pygmento-0.2.tar.gz
(3.9 kB
view details)
File details
Details for the file django-pygmento-0.2.tar.gz.
File metadata
- Download URL: django-pygmento-0.2.tar.gz
- Upload date:
- Size: 3.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.9 tqdm/4.63.0 importlib-metadata/4.11.3 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
28e4cacfbf722ea90131641eaaf8bbd0d5e87813eaf934dbe7a6fd8000281356
|
|
| MD5 |
e35de6e710234259afdec5eb578bea87
|
|
| BLAKE2b-256 |
e091057688b9f892183ce457a5f8e511e5ecb77326b9966870b1cd1c100b6cc4
|