rendering.template_functions.navigation

Returns

Section | None —

Section object if found, None otherwise

Returns

list[Page] —

List of pages (empty if section not found)

Returns

list[dict[str, Any]] —

List of breadcrumb items (dicts with title, url, is_current)

Example (basic): {% for item in get_breadcrumbs(page) %} {% if item.is_current %} <span>{{ item.title }}</span> {% else %} <a href="{{ item.url }}">{{ item.title }}</a> {% endif %} {% endfor %}

Example (with custom styling): <nav aria-label="Breadcrumb"> <ol class="breadcrumb"> {% for item in get_breadcrumbs(page) %} <li class="breadcrumb-item {{ 'active' if item.is_current else '' }}"> {% if item.is_current %} {{ item.title }} {% else %} <a href="{{ item.url }}">{{ item.title }}</a> {% endif %} </li> {% endfor %} </ol> </nav>

Example (JSON-LD structured data): <script type="application/ld+json"> { "@context": "https://schema.org", "@type": "BreadcrumbList", "itemListElement": [ {% for item in get_breadcrumbs(page) %} { "@type": "ListItem", "position": {{ loop.index }}, "name": "{{ item.title }}", "item": "{{ item.url | absolute_url }}" }{{ "," if not loop.last else "" }} {% endfor %} ] } </script>

Returns

list[dict[str, Any]] —

Combined list of TOC items with section headers and nested headings

Returns

list[dict[str, Any]] —

List of groups, each with:

• header: The group header item (dict with id, title, level)
• children: List of child items (empty list if standalone)
• is_group: True if has children, False for standalone items

Example (basic): {% for group in get_toc_grouped(page.toc_items) %} {% if group.is_group %} <details> <summary> <a href="#{{ group.header.id }}">{{ group.header.title }}</a> <span class="count">{{ group.children|length }}</span> </summary> <ul> {% for child in group.children %} <li><a href="#{{ child.id }}">{{ child.title }}</a></li> {% endfor %} </ul> </details> {% else %} <a href="#{{ group.header.id }}">{{ group.header.title }}</a> {% endif %} {% endfor %}

Example (with custom styling): {% for group in get_toc_grouped(page.toc_items) %} <div class="toc-group"> <div class="toc-header"> <button class="toggle" aria-expanded="false">▶</button> <a href="#{{ group.header.id }}">{{ group.header.title }}</a> </div> {% if group.children %} <ul class="toc-children"> {% for child in group.children %} <li class="level-{{ child.level }}"> <a href="#{{ child.id }}">{{ child.title }}</a> </li> {% endfor %} </ul> {% endif %} </div> {% endfor %}

Returns

dict[str, Any] —

Dictionary with:

• pages: List of page items (num, url, is_current, is_ellipsis)
• prev: Previous page info (num, url) or None
• next: Next page info (num, url) or None
• first: First page info (num, url)
• last: Last page info (num, url)

Example (basic): {% set pagination = get_pagination_items(current_page, total_pages, base_url) %}

<nav class="pagination">
  {% if pagination.prev %}
    <a href="{{ pagination.prev.url }}">← Prev</a>
  {% endif %}

  {% for item in pagination.pages %}
    {% if item.is_ellipsis %}
      <span>...</span>
    {% elif item.is_current %}
      <strong>{{ item.num }}</strong>
    {% else %}
      <a href="{{ item.url }}">{{ item.num }}</a>
    {% endif %}
  {% endfor %}

  {% if pagination.next %}
    <a href="{{ pagination.next.url }}">Next →</a>
  {% endif %}
</nav>

Example (Bootstrap): {% set p = get_pagination_items(current_page, total_pages, base_url) %}

<ul class="pagination">
  {% if p.prev %}
    <li class="page-item">
      <a class="page-link" href="{{ p.prev.url }}">Previous</a>
    </li>
  {% endif %}

  {% for item in p.pages %}
    <li class="page-item {{ 'active' if item.is_current }}">
      {% if item.is_ellipsis %}
        <span class="page-link">...</span>
      {% else %}
        <a class="page-link" href="{{ item.url }}">{{ item.num }}</a>
      {% endif %}
    </li>
  {% endfor %}

  {% if p.next %}
    <li class="page-item">
      <a class="page-link" href="{{ p.next.url }}">Next</a>
    </li>
  {% endif %}
</ul>

Returns

list[dict[str, Any]] —

List of navigation items, each with:

• title: Display title
• url: Link URL
• is_current: True if this is the current page
• is_in_active_trail: True if in path to current page
• is_section: True if this is a section (vs regular page)
• depth: Nesting level (0 = top level)
• children: List of child items (for nested rendering)
• has_children: Boolean shortcut

Example (flat rendering with indentation): {% for item in get_nav_tree(page) %} <a href="{{ item.url }}" class="nav-link depth-{{ item.depth }} {{ 'active' if item.is_current }} {{ 'in-trail' if item.is_in_active_trail }}" style="padding-left: {{ item.depth * 20 }}px"> {{ item.title }} {% if item.has_children %} <span class="has-children">▶</span> {% endif %} </a> {% endfor %}

Example (nested rendering with macro): {% macro render_nav_item(item) %} <li class="{{ 'active' if item.is_current }} {{ 'in-trail' if item.is_in_active_trail }}"> <a href="{{ item.url }}"> {% if item.is_section %}📁{% endif %} {{ item.title }} </a> {% if item.children %} <ul class="nav-children"> {% for child in item.children %} {{ render_nav_item(child) }} {% endfor %} </ul> {% endif %} </li> {% endmacro %}

<ul class="nav-tree">
  {% for item in get_nav_tree(page) %}
    {{ render_nav_item(item) }}
  {% endfor %}
</ul>

Returns

list[dict[str, Any]] —

List of navigation items with name, url, weight, parent (for hierarchy)