Template Tags

Django Spellbook includes several useful template tags to enhance your templates with markdown-specific features. These tags help with presenting table of contents, metadata, styling, and URL handling for your markdown-generated content.

Loading the Template Tags

To use these template tags, you need to load them at the top of your Django template:

{% load spellbook_tags %}

Available Template Tags

sidebar_toc

Generates a structured table of contents based on your markdown content hierarchy for display in a sidebar.

Syntax:

{% sidebar_toc %}

When rendered, this tag produces a hierarchical navigation menu based on your markdown files directory structure.

spellbook_styles

Includes the Spellbook's default styles in your template. These styles ensure proper rendering of SpellBlocks, code highlighting, and other markdown-specific features.

Syntax:

{% spellbook_styles %}

spellbook_url

Does what Django's built-in url tag does, but for markdown-generated content.

Syntax:

{% spellbook_url 'docs:folder_first-page' %}

Examples:

<a href="{% spellbook_url 'tutorials:beginner_getting-started' %}">Getting Started</a> <

If the URL can't be reversed, it will return the original path.

dash_strip

Removes leading dashes from a string. This is particularly useful for cleaning up file names when displaying them as titles or navigation items.

Syntax:

{% dash_strip string %}

Examples:

<h1>{% dash_strip "---introduction" %}</h1>
<!-- Renders as: <h1>introduction</h1> -->

show_metadata

Displays metadata in a formatted way. This tag is designed to present page metadata such as author, date, tags, etc.

Syntax:

{% show_metadata %}