Django Markdown Content Management System
Django Spellbook extends Django's templating and rendering capabilities with a focus on markdown-based content. It transforms markdown files into fully-rendered Django templates with auto-generated views and URLs, eliminating boilerplate code while maintaining Django's flexibility.
Spells at your disposal:
-
python manage.py spellbook_md- Auto-generation: Creates Django templates, views, and URL patterns from markdown files
- Extended Markdown: Django-inspired tag syntax for custom HTML attributes and structures
- Content Organization: Support for multiple source directories mapped to different Django apps
-
from django_spellbook.parsers import render_spellbook_markdown_to_html- Markdown String Processing: Takes a raw Python string containing markdown text as its primary input.
- SpellBlock Recognition: Intelligently parses and processes any embedded
{~ SpellBlock ~}tags (like{~ card ~}or{~ alert ~}) and their parameters found within the markdown string. - HTML Output Generation: Converts the input markdown and fully resolved SpellBlocks into a single HTML string, ready to be injected into your Django templates.
- Direct View Integration: Enables developers to leverage `django-spellbook`'s core rendering power directly within custom Django views for flexible and dynamic content presentation.
Get Started in Minutes
Django Spellbook integrates with your project by generating server-side code from markdown content:
pip install django-spellbook
Configure with these essential settings:
INSTALLED_APPS = [
'django_spellbook',
'my_app', # for SPELLBOOK_MD_APP
]
# Necessary for markdown parsing
SPELLBOOK_MD_PATH = BASE_DIR / 'markdown_files'
SPELLBOOK_MD_APP = 'my_app'
# Optional for markdown parsing - customize your base template
SPELLBOOK_MD_BASE_TEMPLATE = 'django_spellbook/bases/base_sidebar_left.html'
Quick Setup Steps
- Install the package using pip
- Add to INSTALLED_APPS in your Django settings
- Configure paths for your markdown content
- Run the command to generate views and templates:
bash python manage.py spellbook_md - Start writing magical markdown with SpellBlocks!
Pro Tip: Check out our Quick Start Guide for a complete walkthrough with examples!