django-admin-json-highlight 0.1.0

A simple Django Admin mixin to highlight JSONB fields using highlight.js

django-admin-json-highlight

A simple Django Admin mixin to render and syntax-highlight JSON / JSONField values using highlight.js.

Installation

pip install django-admin-json-highlight

Add to INSTALLED_APPS:

INSTALLED_APPS = [
    # ...
    "django_admin_json_highlight",
]

Usage

Mix JsonHighlightMixin into your ModelAdmin and use render_json_field to produce HTML for any JSON-serializable attribute on the object.

from django.contrib import admin
from django_admin_json_highlight import JsonHighlightMixin

from .models import Event


@admin.register(Event)
class EventAdmin(JsonHighlightMixin, admin.ModelAdmin):
    readonly_fields = ("payload_pretty",)

    def payload_pretty(self, obj):
        return self.render_json_field(obj, "payload")

    payload_pretty.short_description = "Payload"

Configuration

The mixin loads highlight.js from cdnjs by default. Override either URL in settings.py to use a different version, theme, or self-hosted asset:

HIGHLIGHT_JS_JS_URL = "https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.11.1/highlight.min.js"
HIGHLIGHT_JS_CSS_URL = "https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.11.1/styles/github-dark.min.css"

Relative paths are resolved through Django's static tag, so you can also point these at files served from your own STATICFILES_DIRS.

Requirements

• Python 3.10+
• Django 4.2+

License

MIT