Installation

Install using pip:

pip install django-highlightjs

Alternatively, you can install download or clone this repo and call pip install -e ..
Add to INSTALLED_APPS in your settings.py:

'highlightjs',
In your templates, load the highlightjs library and use the highlightjs_* tags:

Settings

The django-highlightjs has some pre-configured settings. They can be modified by adding a dict variable called HIGHLIGHTJS in your settings.py and customizing the values you want. The HIGHLIGHTJS dict variable is contains these settings and defaults:

HIGHLIGHTJS = {
  # The URL to the jQuery JavaScript file
  'jquery_url': '//code.jquery.com/jquery.min.js',
  # The highlight.js base URL
  'base_url': '//cdnjs.cloudflare.com/ajax/libs/highlight.js/8.3/highlight.min.js',
  # The complete URL to the highlight.js CSS file
  'css_url': '//cdnjs.cloudflare.com/ajax/libs/highlight.js/8.3/styles/{0}.min.css',
  # Include jQuery with highlight.js JavaScript (affects django-highlightjs template tags)
  'include_jquery': False,
  # The default used style.
  'style': 'monokai_sublime',
  }

Usage in your `settings.py`:

HIGHLIGHTJS = {
  'style': 'github',
}

All other styles available at https://github.com/isagalaev/highlight.js/tree/master/src/styles

Example template

{% load highlightjs %}
<html>
<head>
  <link href="{% highlightjs_css_url %}" rel='stylesheet' type='text/css'>
</head>
<body>
    {# Highlight Syntax using Highlightjs #}

    {% highlightjs_this code_to_highlight %}
    {% highlightjs_this code_to_highlight 'python' %}

    {% highlightjs_javascript jquery=1 %}
</body>
</html>

Requirements

Python 2.7, 3.4, 3.5 or 3.6
Django >= 1.8

Contributions and pull requests for other Django and Python versions are welcome.

Bugs and requests

If you have found a bug or if you have a request for additional functionality, please use the issue tracker on GitHub.

https://github.com/MounirMesselmeni/django-highlightjs/issues

License

You can use this under MIT See LICENSE file for details.

Author

My name is Mounir Messelmeni, you can reach me at messelmeni.mounir@gmail.com .