From 2ccc451c2a6713b665719edab820780056ea8375 Mon Sep 17 00:00:00 2001 From: Peter Mosses <18308236+pdmosses@users.noreply.github.com> Date: Sun, 1 Oct 2023 14:47:26 +0200 Subject: [PATCH] Fix: improve build time (#1358) * 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 --- .github/workflows/ci.yml | 3 +- CHANGELOG.md | 6 ++ _includes/components/breadcrumbs.html | 46 +++++---- _includes/{ => components}/nav.html | 2 +- _includes/components/sidebar.html | 61 +---------- _includes/components/site_nav.html | 63 ++++++++++++ _includes/css/activation.scss.liquid | 141 +++++++++++++++++--------- _includes/head.html | 8 +- _includes/head_nav.html | 48 --------- assets/css/just-the-docs-head-nav.css | 24 +++++ assets/js/just-the-docs.js | 20 ++-- fixtures/html5validator-config.yml | 6 ++ 12 files changed, 247 insertions(+), 181 deletions(-) rename _includes/{ => components}/nav.html (98%) create mode 100644 _includes/components/site_nav.html delete mode 100644 _includes/head_nav.html create mode 100644 assets/css/just-the-docs-head-nav.css create mode 100644 fixtures/html5validator-config.yml diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 46dfd54..f403ead 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -84,8 +84,7 @@ jobs: - name: Test with Nu Validator uses: Cyb3r-Jak3/html5validator-action@2a593a9f2c10593cbac84791a6fc4c47e9a106c8 with: - root: _site - blacklist: line-numbers + config: fixtures/html5validator-config.yml - name: Test with html-proofer run: bundle exec htmlproofer _site --ignore-urls "/github.com/,/web.archive.org/" env: diff --git a/CHANGELOG.md b/CHANGELOG.md index 5247830..45418dc 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -20,8 +20,14 @@ Code changes to `main` that are *not* in the latest release: ### Bugfixes - Fixed: remove href from the navigation link to the current page by [@pdmosses] in [#1356] +- Fixed: improve build time by [@pdmosses] in [#1358] + +{: .warning } +[#1358] moved `_includes/nav.html` to the `_includes/components` directory, +Users who were overriding that file will need to adjust their sites accordingly. [#1356]: https://github.com/just-the-docs/just-the-docs/pull/1356 +[#1358]: https://github.com/just-the-docs/just-the-docs/pull/1358 ## Release v0.6.2 diff --git a/_includes/components/breadcrumbs.html b/_includes/components/breadcrumbs.html index 82ad6bd..5db2342 100644 --- a/_includes/components/breadcrumbs.html +++ b/_includes/components/breadcrumbs.html @@ -3,30 +3,38 @@ Depends on: page, site. Results in: HTML for the breadcrumbs component. Overwrites: - pages_list, parent_page, grandparent_page. + node, pages_list, parent_page, grandparent_page. {%- endcomment -%} {%- if page.url != "/" and page.parent -%} - {%- assign pages_list = site[page.collection] - | default: site.html_pages - | where_exp: "item", "item.title != nil" - | where_exp: "item", "item.has_children != nil" -%} + {%- assign pages_list = site[page.collection] | default: site.html_pages -%} - {%- if page.grand_parent -%} - {%- assign parent_page = pages_list - | where: "title", page.parent - | where: "parent", page.grand_parent - | first -%} - {%- assign grandparent_page = pages_list - | where: "title", page.grand_parent - | first -%} - {%- else -%} - {%- assign parent_page = pages_list - | where: "title", page.parent - | where_exp: "item", "item.parent == nil" - | first -%} - {%- endif -%} + {%- assign parent_page = nil -%} + {%- assign grandparent_page = nil -%} + + {%- for node in pages_list -%} + + {%- if node.has_children and page.grand_parent -%} + + {%- if node.title == page.parent and node.parent == page.grand_parent -%} + {%- assign parent_page = node -%} + {%- endif -%} + {%- if node.title == page.grand_parent -%} + {%- assign grandparent_page = node -%} + {%- endif -%} + {%- if parent_page and grandparent_page -%} + {%- break -%} + {%- endif -%} + + {%- elsif node.has_children and node.title == page.parent and node.parent == nil -%} + + {%- assign parent_page = node -%} + {%- break -%} + + {%- endif -%} + + {%- endfor -%}