Version 0.2.4 (Unreleased)
Added
New Parser Function: spellbook_render
Introduced a new, cleaner parser function name for better developer experience.
New function:
from django_spellbook.parsers import spellbook_render
html = spellbook_render(markdown_text)
Benefits:
-
Shorter, easier to remember
-
Better aligns with "spellbook" branding
-
Improved documentation and examples
Deprecated
Parser Function: render_spellbook_markdown_to_html
The function render_spellbook_markdown_to_html is now deprecated in favor of spellbook_render.
Migration:
# Old (deprecated - will be removed in 0.4.0)
from django_spellbook.parsers import render_spellbook_markdown_to_html
html = render_spellbook_markdown_to_html(markdown_text)
# New (recommended)
from django_spellbook.parsers import spellbook_render
html = spellbook_render(markdown_text)
Timeline:
-
0.2.4: Deprecation warning added
-
0.4.0: Function will be removed
What to do:
-
Replace all uses of
render_spellbook_markdown_to_htmlwithspellbook_render -
Signatures are identical - simple find/replace works
-
Deprecation warnings will guide you to update