semvec/pypi-packages huggingface dataset:
django-highlightjs 0.2.14
A Django app to easyily integrate highlight.js syntax highlighter.
License: MIT
Requires Python: <3.14,>=3.10
Keywords: django, highlightjs, syntax, highlighter, syntax highlighter, highlight.js

# 🎉 Welcome to django-highlightjs 🎉

![Build Status](https://github.com/mounirmesselmeni/django-highlightjs/actions/workflows/workflow.yml/badge.svg)
![Latest Version](https://img.shields.io/pypi/v/django-highlightjs.svg)

Use [Highlight.js](https://highlightjs.org) in your Django templates, the Django way.

## 🚀 Installation

1. Install using pip:

   ```bash
   pip install django-highlightjs
   ```

   Alternatively, you can download or clone this repo and call:

   ```bash
   pip install -e .
   ```

2. Add to `INSTALLED_APPS` in your `settings.py`:

   ```python
   'highlightjs',
   ```

3. 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 contains these settings and defaults:

```python
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`:

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

All other styles are available at [highlight.js styles](https://github.com/isagalaev/highlight.js/tree/main/src/styles).

## 📝 Example template

```django
{% 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, 3.12 or 3.13
- Django >= 4.2

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.

[GitHub Issues](https://github.com/mounirmesselmeni/django-highlightjs/issues)

## 📜 License

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

## 👤 Author

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