Django-Spellbook

Django Content Management Magic

Improve your projects with Django Spellbook! Tools, commands, and features that seamlessly blend into Django, adding powerful capabilities to your workflow.

Spells at your disposal:

• 🪶 python manage.py spellbook_md

  • Transform markdown into dynamic HTML templates.
  • Extend markdown with Django-like tags & modular custom blocks.
  • Auto-generate Views, URLs, and Navigation based on your content's file structure.
🪄 {% invoke 'action' 'bound_element_id' 'config' %}
• Define dynamic behavior for template elements without writing JavaScript.
• Perform actions like toggling classes, styles, or attributes based on conditions.
• Supports advanced configurations for events like `on-click`, `on-load`, and custom targets.
⌛ {% lazy_include 'template_name' 'bound_element_id' 'config' %}
• Load heavy or secondary templates only when visible or triggered by an event.
• Integrates seamlessly with HTMX or custom triggers like scrolling or button clicks.
• Improves performance by deferring content rendering until it's needed.

Get Started in Minutes

Install Django Spellbook and add a touch of magic to your project:

pip install django-spellbook

Configure your settings and start casting spells:

INSTALLED_APPS = [
    # ...
    'django_spellbook',
    # ...
]

# necessary for markdown parsing
SPELLBOOK_MD_PATH = BASE_DIR / 'markdown_files'
SPELLBOOK_CONTENT_APP = 'my_app'

# optional for markdown parsing
SPELLBOOK_MD_BASE_TEMPLATE = 'django_spellbook/bases/base_sidebar_left.html'