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.8, 3.9, 3.10 or 3.11
Django >= 3
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.
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
Built Distribution
Hashes for django_highlightjs-0.2.7-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | df9b8ba47ff3db0c4cc02f0e5a9b402ca598d1c1d04a06006a90db6dca42a14c |
|
MD5 | 70ce6d6aa55ea2f54a094aadefcec262 |
|
BLAKE2b-256 | f31dd428187fa9bc476943b0711861d2c4029e789b4876fdd33cc5c0a49773f9 |