Skip to main content

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 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.

Meta

Apoorva Pandey – apoorvapandey365@gmail.com

Distributed under the BSD license.

https://github.com/apoorvaeternity

Contributing

  1. Fork it (https://github.com/apoorvaeternity/django-pygmento/)
  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

Project details


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 hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page