mirror of
https://github.com/snachodog/just-the-docs.git
synced 2025-04-04 03:01:23 -06:00
a4e4e312aa
* Allow unlimited multi-level navigation This PR supersedes #462. The only user-level difference from #462 is that disambiguation of parent pages has to use either `grand_parent` or `ancestor` titles: the somewhat unnatural `section_id` and `in_section` fields are not supported. The implementation has been significantly simplified by the changes introduced in v0.7.0 of the theme. * Detect cyclic parenthood A page should not have a parent or ancestor with the same title. If it does, the location of the repeated link is marked by ∞, to facilitate debugging the navigation (and an unbounded loop leading to a build exception is avoided). * Add nav_error_report warning in main navigation When activated by `nav_error_report: true` in `_config.yml`, displays warnings about pages with the same title as their parent page or an ancestral page. * Cache site-nav with links to all pages The extra cached site-nav is used for determining breadcrumbs and children navigation, which may involve pages that are excluded from the main navigation. * Replace code for determining children by inclusion of components/nav/children.html * Update CHANGELOG.md --------- Co-authored-by: Matt Wang <matt@matthewwang.me>
54 lines
2.2 KiB
HTML
54 lines
2.2 KiB
HTML
{%- comment -%}
|
|
Include as: {%- include components/nav/links.html pages=page_array ancestors=title_array all=bool -%}
|
|
Depends on: include.pages, include.ancestors, include.all.
|
|
Results in: HTML for the main navigation when all is nil or false;
|
|
includes links to pages excluded from the main navigation when all is true.
|
|
Includes: components/nav/sorted.html, components/nav/children.html, components/nav/links.html.
|
|
Overwrites:
|
|
node, nav_children, nav_ancestors.
|
|
{%- endcomment -%}
|
|
|
|
<ul class="nav-list">
|
|
{%- for node in include.pages -%}
|
|
{%- if include.all == true or node.nav_exclude != true -%}
|
|
|
|
{%- if include.ancestors contains node.title -%}
|
|
|
|
<li class="nav-list-item">
|
|
<a href="{{ node.url | relative_url }}" class="nav-list-link"> ∞ </a>
|
|
</li>
|
|
{%- capture nav_error_report -%}
|
|
<blockquote class="warning">
|
|
A page has the same title as its parent page or one of its ancestral pages!<br>
|
|
This causes an incorrect link in the main navigation panel.<br>
|
|
Page title: <code>{{ node.title }}</code>, location: <code>{{ node.path }}</code>.
|
|
</blockquote>
|
|
{%- endcapture -%}
|
|
|
|
{%- else -%}
|
|
|
|
{%- include components/nav/children.html node=node ancestors=include.ancestors all=include.all -%}
|
|
|
|
<li class="nav-list-item">
|
|
{%- if nav_children.size >= 1 -%}
|
|
<button class="nav-list-expander btn-reset" aria-label="toggle items in {{ node.title }} category" aria-pressed="false">
|
|
<svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg>
|
|
</button>
|
|
{%- endif -%}
|
|
<a href="{{ node.url | relative_url }}" class="nav-list-link">{{ node.title }}</a>
|
|
{%- if nav_children.size >= 1 -%}
|
|
{%- if node.child_nav_order == 'desc' or node.child_nav_order == 'reversed' -%}
|
|
{%- assign nav_children = nav_children | reverse -%}
|
|
{%- endif -%}
|
|
{%- assign nav_ancestors = include.ancestors | push: node.title -%}
|
|
{%- include components/nav/links.html pages=nav_children ancestors=nav_ancestors all=include.all -%}
|
|
{%- endif -%}
|
|
</li>
|
|
|
|
{%- endif -%}
|
|
|
|
{%- endif -%}
|
|
{%- endfor -%}
|
|
</ul>
|
|
{%- comment -%}{%- endcomment -%}
|