mirror of
https://github.com/snachodog/just-the-docs.git
synced 2025-04-04 03:01:23 -06:00
2ccc451c2a
* Remove "passive" toggle PR #1244 introduced the "passive" toggle, but just-the-docs.js subsequently disabled the only styling that used it, so it became redundant. This removes it. * Reduce build time for page-dependent CSS Fix #1323 - Remove `_includes/head_nav.html`. - Generate page-independent SCSS in `assets/css/just-the-docs-head-nav.css`. - Link to `/assets/css/just-the-docs-head-nav.css` in `head.html`. - Disable the above stylesheet in `assets/js/just-the-docs.js`. - Generate page-dependent CSS in `_includes/css/activation.scss.liquid` and include in `head.html`. * No override svg rotate * Disable both stylesheets safely * Move the site nav to a new include - Fix the complete site nav - Move the site nav to `_includes/site_nav.html` - Cache the site nav - Uncache `nav.html` * Move nav and site_nav to _includes/components * Replace id prefix * Update breadcrumbs.html Replace several filters by a single loop through all the pages, but breaking as soon as possible. Profiling indicates that this saves up to 50% of the breadcrumbs build time for the filters. * Update just-the-docs-head-nav.css Adjust the number of lines to keep * Update head.html Remove superflous type. * Update activation.scss.liquid Remove a superfluous closing brace. Adjust layout. * Use `scssify` to remove nesting Preliminary profiling indicates that using `scssify` on the small number of nested CSS rules produced by `activation.scss.liquid` is quick enough. * Update head.scss Manual attempt at prettier (pending installation in Atom). * Avoid generation of nested CSS Local profiling indicated that using `scssify` on each page takes about 1% of the build time. - Update `_includes/css/activation.scss.liquid` to generate non-nested CSS. - Remove use of `scssify` from `_includes/head.html`. * Ignore false positives from validator Ignores: `:1.810-1.823: error: CSS: Parse Error.` and `:1.811-1.824: error: CSS: Parse Error.`; had to shift things around since the local config overrides the CI flag. * Inline `_sass/head.css` * Update CHANGELOG.md --------- Co-authored-by: Matthew Wang <matt@matthewwang.me>
76 lines
3.1 KiB
HTML
76 lines
3.1 KiB
HTML
{%- comment -%}
|
|
Include as: {%- include components/nav.html pages=pages -%}
|
|
Depends on: include.pages.
|
|
Results in: HTML for the navigation panel.
|
|
Includes:
|
|
sorted_pages.html
|
|
Overwrites:
|
|
nav_pages, first_level_pages, second_level_pages, third_level_pages,
|
|
node, children_list, child, grand_children_list, grand_child.
|
|
{%- endcomment -%}
|
|
|
|
{%- assign nav_pages = include.pages
|
|
| where_exp: "item", "item.title != nil"
|
|
| where_exp: "item", "item.nav_exclude != true" -%}
|
|
|
|
{%- include sorted_pages.html pages = nav_pages -%}
|
|
|
|
{%- comment -%}
|
|
It might be more efficient to sort the pages at each level separately.
|
|
{%- endcomment -%}
|
|
|
|
{%- assign first_level_pages = sorted_pages
|
|
| where_exp: "item", "item.parent == nil" -%}
|
|
{%- assign second_level_pages = sorted_pages
|
|
| where_exp: "item", "item.parent != nil"
|
|
| where_exp: "item", "item.grand_parent == nil" -%}
|
|
{%- assign third_level_pages = sorted_pages
|
|
| where_exp: "item", "item.grand_parent != nil" -%}
|
|
|
|
<ul class="nav-list">
|
|
{%- for node in first_level_pages -%}
|
|
<li class="nav-list-item">
|
|
{%- if node.has_children -%}
|
|
<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 node.has_children -%}
|
|
{%- assign children_list = second_level_pages
|
|
| where: "parent", node.title -%}
|
|
{%- if node.child_nav_order == 'desc' or node.child_nav_order == 'reversed' -%}
|
|
{%- assign children_list = children_list | reverse -%}
|
|
{%- endif -%}
|
|
<ul class="nav-list">
|
|
{%- for child in children_list -%}
|
|
<li class="nav-list-item">
|
|
{%- if child.has_children -%}
|
|
<button class="nav-list-expander btn-reset" aria-label="toggle items in {{ child.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="{{ child.url | relative_url }}" class="nav-list-link">{{ child.title }}</a>
|
|
{%- if child.has_children -%}
|
|
{%- assign grand_children_list = third_level_pages
|
|
| where: "parent", child.title
|
|
| where: "grand_parent", node.title -%}
|
|
{%- if child.child_nav_order == 'desc' or child.child_nav_order == 'reversed' -%}
|
|
{%- assign grand_children_list = grand_children_list | reverse -%}
|
|
{%- endif -%}
|
|
<ul class="nav-list">
|
|
{%- for grand_child in grand_children_list -%}
|
|
<li class="nav-list-item">
|
|
<a href="{{ grand_child.url | relative_url }}" class="nav-list-link">{{ grand_child.title }}</a>
|
|
</li>
|
|
{%- endfor -%}
|
|
</ul>
|
|
{%- endif -%}
|
|
</li>
|
|
{%- endfor -%}
|
|
</ul>
|
|
{%- endif -%}
|
|
</li>
|
|
{%- endfor -%}
|
|
</ul>
|