django-helpapp
Drop-in in-app help center for Django projects, designed for Any Project.
- Django MVT — plain server-rendered views/templates, no required build step.
- Tailwind CSS — Use the Play CDN to try Tailwind right in the browser without any build step.
- Vanilla JS — a single dependency-free
helpapp.js. Works with or without a JS framework in your project. - Embeddable anywhere — a floating help widget, inline contextual hints, and a full standalone help portal.
Install
pip install django-helpapp
# settings.py
INSTALLED_APPS = [
...,
"froala_editor",
"helpapp",
]
HELPAPP_SETTINGS = {
"BRAND_NAME": "Brand Name (Help Center)",
"PRIMARY_COLOR": "#1c088b",
}
# urls.py
from django.urls import include, path
urlpatterns = [
...,
path("froala_editor/", include('froala_editor.urls')),
path("help/", include("helpapp.urls")),
]
python manage.py migrate
python manage.py seed_helpapp_demo # optional: loads sample content
Add the floating widget to every page
<!-- base.html -->
{% load helpapp_tags %}
...
{% helpapp_announcements %}
{% helpapp_widget %}
</body>
</html>
Use the Play CDN to try Tailwind right in the browser without any build step
<!-- base.html -->
{% load helpapp_tags %}
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>{% block title %}Your Django Project{% endblock %}</title>
<script src="https://cdn.jsdelivr.net/npm/@tailwindcss/browser@4"></script>
</head>
<body>
...
{% helpapp_announcements %}
{% helpapp_widget %}
</body>
</html>
Content authoring
Articles are authored in Django admin (HelpArticle), written in Markdown, organized into HelpCategory, tagged with HelpTag, and can be restricted by role (all, user, admin, staff). Visibility is enforced by helpapp.permissions.can_view_article, which you can override entirely via PERMISSION_CALLBACK.
Building a custom frontend (API-only mode)
If you don't want the bundled templates, use the JSON endpoints directly:
GET /help/api/search/?q=...GET /help/api/articles/<slug>/GET /help/api/hints/<key>/
Overriding templates
Any template can be overridden by creating a matching path in your project's own templates/helpapp/ directory (standard Django template-loading precedence), e.g. templates/helpapp/widget.html.
Compatibility
Django 5.0 LTS, 5.x ,6.x; Python 3.10+. SQLite, PostgreSQL, MySQL.
django-helpapp
1 maintainer
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file django_helpapp-0.1.0.tar.gz.
File metadata
- Download URL: django_helpapp-0.1.0.tar.gz
- Upload date:
- Size: 37.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.14.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
701b8dd746ff240f608846629cb68fc18d26c7ebb13e6ff27ed60ea83a62868e
|
|
| MD5 |
6cb21177da2b7a017f509670b6c9d5a1
|
|
| BLAKE2b-256 |
604a44f89ce76d7fe03733e7cab8bfca016777231434b13e03b7f4c24c2cef1d
|
File details
Details for the file django_helpapp-0.1.0-py3-none-any.whl.
File metadata
- Download URL: django_helpapp-0.1.0-py3-none-any.whl
- Upload date:
- Size: 49.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.14.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
030eb629f67088470a01184275fc3006e796b2a42e0d6cfc3c4d2d4bfff206f0
|
|
| MD5 |
d9579a1017a34b70981f57d5b54c9713
|
|
| BLAKE2b-256 |
9ca8c67eddb1978bb0e64819fb9545bbdfe5f9197755e3c89d41a4dd58f49397
|
