Components / Shells
Docs shell
Documentation article plus responsive navigation rail, with separate site-wide and page-local chrome seams.
Full-page preview
The preview is a registered, same-origin template for this shell. It does not run visitor supplied source.
Use it
Read the pinned package source
{% extends "brickwork/shell/docs.html" %}
{% load brickwork_nav %}
{% block docs_nav %}<nav aria-label="Documentation">{% bw_nav items=docs_nav_items active=docs_active_nav_item %}</nav>{% endblock %}
{% block content %}<h1>Guide title</h1><p>Article content.</p>{% endblock %}Public blocks
| Block | Use |
|---|---|
docs_site_header / docs_site_footer | Repeated chrome outside main. |
docs_header / docs_footer | Page-local article content. |
docs_nav / docs_nav_label | Rail and its matching summary label. |
content | Article body. |
Accessibility and no-JavaScript behaviour
Article content precedes the rail in source order. Keep global navigation in docs_site_header, never docs_header.
The rail is a native details disclosure at narrow widths.
Troubleshooting
- Site navigation appears inside the article.
- Use docs_site_header rather than docs_header.