A Django app to easyily integrate highlight.js syntax highlighter.
Project description
Use Highlight.js (https://highlightjs.org) in your Django templates, the Django way.
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/11.7.0/highlight.min.js', # The complete URL to the highlight.js CSS file 'css_url': '//cdnjs.cloudflare.com/ajax/libs/highlight.js/11.7.0/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/main/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 3.10, 3.11 or 3.12
Django >= 4
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.
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
Built Distribution
Hashes for django_highlightjs-0.2.12.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 80ab4451caed6c6b7fffc57ffd2784b80b4ccb5e99f5eb742653e4e6efb8a6f5 |
|
| MD5 | 1703652d6077af0a0bb3884cc4b878cc |
|
| BLAKE2b-256 | 27c37c919c3387e6d93ebcab985c22264cd3050384de26d7f1b171de3cacc253 |
Hashes for django_highlightjs-0.2.12-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 217897d8021b60932beefd28c6c6ef9a01baf07283cde095714f2f07f97666a4 |
|
| MD5 | d373915f9e1960868541d48ec80fe152 |
|
| BLAKE2b-256 | 0d3187f6908928192d8688e50aafbb1c1dbbf2a96f341c241bdaa58e1d7af27f |
