A Django app to generate HTML breadcrumbs dynamically from URL path
Project description
django-dynamic-breadcrumbs
django-dynamic-breadcrumbs
is a Django app to generate HTML breadcrumbs
dynamically from URL paths.
At https://example.com/reference/instrument/guitar/
, shows:
Home > Reference > Instrument > Guitar
.
Quick start
1. Install
pip install django-dynamic-breadcrumbs
2. Add to settings
Add "dynamic_breadcrumbs" label to your INSTALLED_APPS settings:
INSTALLED_APPS = [
...
'dynamic_breadcrumbs',
]
Add dynamic_breadcrumbs.context_processors.breadcrumbs
to context_processors:
TEMPLATES = [
{
"BACKEND": "django.template.backends.django.DjangoTemplates",
"DIRS": [os.path.join(BASE_DIR, "templates")],
"APP_DIRS": True,
"OPTIONS": {
"context_processors": [
#...
"dynamic_breadcrumbs.context_processors.breadcrumbs",
],
},
},
]
3. Add template
Include the dynamic_breadcrumbs/breadcrumbs.html
in your base template.
{% if breadcrumbs %}
<div class="container">
{% include "dynamic_breadcrumbs/breadcrumbs.html" with breadcrumbs=breadcrumbs%}
</div>
{% endif %}
Now each time you visit a page which makes use of the above template, it will have the breadcrumbs generated from the URL path.
4. (Optional) Customization
Tweak default settings.
Documentation
Full docs at: https://django-dynamic-breadcrumbs.readthedocs.io/
License
MIT
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Hashes for django-dynamic-breadcrumbs-0.4.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a6e89a67eabd47aa32fea3f55a3f5fb89bfccc90a35d0119e2b30656914eaa4b |
|
MD5 | 66202ce52bbca137f92a64ec7b0fa719 |
|
BLAKE2b-256 | 637e417a8f176f1fbf03a9a10320d976e8352de54153c0efed3bc06339babcef |