django-pygmento

django-pygmento is a syntax highlighter based on Pygments for django>=4.0.0

Maintainers: 1

django-pygmento

Syntax highlighter for django templates based on Pygments.

Usage example

Install the package using

pip install django-pygmento

Add pygmento to INSTALLED_APPS in your settings file.
Load pygmento template tag

{% load pygmento %}

Include pygment css in head using the pygmento_css template tag or manually generate it as described here and add it to static files.

<head>
    {% pygmento_css %}
</head>

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" %}
<!DOCTYPE html>
<html>
<body>
<h1>My Heading</h1>
<p>My paragraph.</p>
</body>
</html>
{% endpygmentoblock %}

The above code will get rendered as

image info

Available styles

Styles can be set using PYGMENTO_STYLE setting.

PYGMENTO_STYLE = "default"

See the list of available styles and how they look here.

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

Keywords

syntax highlighter for django

FAQs

What is django-pygmento?

Is django-pygmento well maintained?

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install