Skip to content
Snippets Groups Projects
  1. Dec 21, 2022
    • Matt Wang's avatar
      vendor: update `jekyll-anchor-headings`, `lunr.js` (#1071) · 197d18d8
      Matt Wang authored
      Closes #1070.
      
      This PR:
      
      - updates `jekyll-anchor-headings` to `1.0.12`; this was a simple copy-paste
      - updates `lunr.js` to `2.3.9`; this was a bit more involved:
          - I didn't see a minified build in the repo, so I ran it through [DigitalOcean's minifier](https://www.digitalocean.com/community/tools/minify)
          - copyright notices weren't properly included in the previous minified build, so I:
              - include an actual copy of the original MIT License for `lunr.js`
              - includes proper attribution for other functions, which include derivative works
      
      There's a tiny bundle size increase in `lunr.js` due to the comments, but I think that's reasonable given that it's related to licensing; still trivial in the grand scheme of things.
      
      As an aside: it would be neat if we could include minification as part of the build pipeline instead!  
      Unverified
      197d18d8
  2. Dec 18, 2022
  3. Dec 17, 2022
  4. Dec 13, 2022
  5. Nov 15, 2022
    • Tom Brouwer's avatar
      Fix duplicate `title` if `jekyll-seo-tag` not in users's plugins (#1040) · c498a569
      Tom Brouwer authored
      In case 'just-the-docs' is used as a theme, and a user does not
      eplicitly include 'jekyll-seo-tag' inside the plugins list in
      _config.yml, two 'title' elements were rendered. Since
      jekyll-seo-tag is always available, because it's set in the plugins
      list of the theme itself, the 'seo' tag will aways work, making
      the seperate title and description elements obsolete.
      
      Fixes #1008
      Unverified
      c498a569
  6. Nov 05, 2022
    • Peter Mosses's avatar
      Fix external links for sites with no pages (#1021) · 29b5d147
      Peter Mosses authored
      
      Fix #1020
      
      - Move the display of nav external links from `_includes/nav.html` to `_layouts/default.html`.
      - Replace ` unless include.key` by `if site.nav_external_links`.
      - Wrap the body of `if site.nav_external_links` in `<ul class="nav-list">…</ul>`.
      
      To test this PR:
      
      1.  Add to `_config.yml`:
          ```yaml
          defaults:
            -
              scope: {path: ""}
              values: {nav_exclude: true}
          ```
      
      2.  Check that the only link to appear in the nav panel is external.
      
      Co-authored-by: default avatarMatt Wang <matt@matthewwang.me>
      Unverified
      29b5d147
  7. Oct 30, 2022
    • Peter Mosses's avatar
      Fix top-level active link (#1015) · 063acaca
      Peter Mosses authored
      * Fix top-level active link
      
      Fixes #1014
      
      1.  Reverse the order of `page.parent == node.title or page.grand_parent == node.title`. This makes no difference.
      2.  Replace `page.parent == node.title` by `page.parent == node.title  and page.grand_parent == nil`. The condition is evaluated first because it is rightmost.
          We have `node in first_level_pages`.
          The old condition holds not only when `page` is a child of `node`,
          but also when `page` is a grandchild of a *different* top-level page and its parent happens to have the same title as `node`.
          The new condition never holds for a grandchild.
      
      This change has been tested locally: in v0.4.0.rc3, when the 3rd-level page `G` was selected, the link to the top-level page `F` was active, and the link to its child `G` was shown; after making the change, it is no longer active, so the link to its child `G` is not shown.
      
      * Update nav.html
      
      Add a comment to clarify just when top-level nodes are active.
      Unverified
      063acaca
  8. Oct 24, 2022
  9. Oct 14, 2022
  10. Oct 10, 2022
    • Matt Wang's avatar
      Experimental nav optimization for simple cases (#992) · b4b951fe
      Matt Wang authored
      
      * Optimize simple navigation cases
      
      Fix inefficiency reported in feedback on v0.4.0.rc2 (see discussion #958).
      
      This PR:
      
      * essentially reverts `_includes/nav.html` to v0.4.0.rc1
      * preserves the ARIA labels added by #950
      * adds a test to optimize builds of sites that rely on `title` fields to order pages.
      
      Building the `endoflife.date` site (130 pages) now takes only about 7 seconds.
      
      Building the `machinetranslate.org` site ( 350 pages) takes about 7 minutes. (Without the added test, it takes just over 5 minutes: the condition of the test is merely to compare the size of two arrays, but that is apparently enough to prevent Jekyll from applying some optimization).
      
      A warning is added to the docs about the need for numbers to be in quotes when used as title values.
      
      * Update navigation-structure.md
      
      A clarification is added to the docs about the need for numbers to be in quotes when used as title values.
      
      * Simplify the control and data flow
      
      - Defer concatenation of `string_order_pages` with `title_order_pages` until needed.
      - Replace tests on size with tests for `empty`.
      - Rename variables accordingly.
      
      * Fix child nav order
      
      This PR started from the navigation in RC1. Some cosmetic improvements had been made in RC2. This commit adds some of those changes to this PR.
      
      It also fixes a bug (revealed by a new regression test) due to a reference to `node.child_nav_order` instead of `child.child_nav_order`, which prevented reversal of the order in children of children. Presumably a top-level reversal should apply only to direct children, and not to grandchildren. The latter interpretation would be very confusing in a deep multi-level hierarchy.
      
      * Allow pages with numeric titles
      
      An omitted `nav_order` value should default to the `title` value, regardless of its type. Jekyll 3 gives build errors when numbers and strings are sorted together. This commit drops the assumption that `title` values are always strings – a 404 page naturally has a numeric title. It updates the docs page accordingly.
      
      The extra code does not affect the build time for the `endoflife.date` site (7 seconds). For the `machinetranslate` site, changing the title of the 404 page to a number increases the build time from 7 minutes to 9 minutes – the `nav_order` numbers on that site are program-generated in the range 1..1000, which might be atypical.
      
      This commit has not yet been checked using the regression tests.
      
      The gemspec used for testing specifies `spec.add_runtime_dependency "jekyll", "~> 3.8.5"`, and `Gemfile.lock` shows `jekyll (3.8.7)`.
      
      * Update nav.html
      
      Add comment about an optimization that will be possible in Jekyll 4.
      
      * Update nav.html
      
      - Update the comment about optimization possibility.
      - TEMPORARILY add Jekyll 3 code for conditionally optimizing.
      
      * Update nav.html
      
      Minor improvements and cosmetic changes.
      
      * Major revision
      
      This update is based on extensive experimentation and profiling with alternative versions of the Liquid code used to build the main navigation panel.
      
      Due to the fragility of Jekyll's optimizations, combining alternative approaches with conditionals turned out to be too expensive: merely adding a condition to check whether some array of pages is empty can add about 20% to the build time!
      
      The current code avoids sorting pages on `nav_order` and `title` fields together. The standard way of doing that in Jekyll is to use the `group_by` filter; but extracting the sorted pages from the groups turned out to be too inefficient (as seen in RC1), as was generating links directly from the groups (in RC2).
      
      Making all pages with `nav_order` values come before all those ordered by their `title` values is not ideal (it doesn't support tweaking the relative order of two pages in a list of pages ordered by their titles) but it appears to be necessary for efficient builds on large sites.
      
      This version has not yet been fully tested for regression, but otherwise seems to give the expected navigation on the endoflife.date and machinetranslate websites. (I'm unable to install the Python-based how2data repository on my laptop, due to package version issues on Apple silicon).
      
      Co-authored-by: default avatarPeter Mosses <18308236+pdmosses@users.noreply.github.com>
      Unverified
      b4b951fe
  11. Sep 29, 2022
    • Peter Mosses's avatar
      Fix default highlighting in custom color schemes (#986) · 33a7b2ac
      Peter Mosses authored
      
      * Fix default highlighting in custom schemes
      
      Fix #982
      
      The variable settings for highlighting in the default `light` scheme are currently (v0.4.0.rc2`) in `_sass/color_schemes/light.scss`.
      This PR ensures that custom schemes are based on the `light` scheme.
      
      It also adds a note explaining the default to the customization docs,
      and gives an example of how to define a custom scheme based on the `dark` scheme
      
      * Prettier
      
      * Deleted test file
      
      Co-authored-by: default avatarMatt Wang <matt@matthewwang.me>
      Unverified
      33a7b2ac
  12. Sep 26, 2022
  13. Sep 15, 2022
  14. Sep 12, 2022
    • Peter Mosses's avatar
      Improve build time of navigation panel (#956) · 457dce36
      Peter Mosses authored
      Fix #863.
      
      The current Liquid code to generate the navigation panel involves the inefficient extraction of a list of pages from a list of page groups (identified by @captn3m0 in his original [explanation of the performance issue](https://github.com/just-the-docs/just-the-docs/issues/863)). 
      
      The optimisation implemented by this PR generates navigation links directly from the list of page groups, thereby avoiding the extraction of a list of pages from it. The Liquid code is now a bit tedious, but I don't see a simpler solution. 
      
      The need for grouping pages arises because Jekyll doesn't provide a filter to sort a list of pages on the value of an arbitrary expression.
      
      Using Jekyll v4.2.2 (macOS 12.5, M2 MacBook Air, 16 GB memory), building https://github.com/endoflife-date/endoflife.date using https://github.com/pdmosses/just-the-docs/blob/fix-nav-performance/_includes/nav.html produced the following profile extract:
      
      Filename                                                    | Count |    Bytes |   Time
      ------------------------------------------------------------|-------|----------|-------
      | just-the-docs-0.4.0.rc1/_layouts/default.html                    |   130 |  3792.04K |  5.160 |
      | _includes/nav.html                                               |   130 |  1405.20K |  4.054 |
      | just-the-docs-0.4.0.rc1/_includes/head.html                      |   130 |   617.82K |  0.495 |
      | _layouts/product.html                                            |   127 |  1014.38K |  0.413 |
      | _includes/head_custom.html                                       |   130 |   427.83K |  0.393 |
      | assets/js/zzzz-search-data.json                                  |     1 |   149.31K |  0.050 |
      
      @nathancarter has tried adding the new `nav.html` to [a site with over 300 pages](https://nathancarter.github.io/how2data/site/), and reported that it improved the build time of more than 3 minutes to about 30 seconds.
      
      Further optimisation of navigation might be possible (e.g., using [Jekyll include caching](https://github.com/benbalter/jekyll-include-cache)), but the current optimisation should be sufficient for v0.4.0.
      
      To test that this PR does not appear to affect the navigation panel generated by v0.3.3:
      
      1. Clone https://github.com/just-the-docs/just-the-docs-tests.
      2. Update `_config.yml` and `Gemfile` to use this PR branch.
      3. Run `bundle update`.
      4. Inspect the rendering of the entire collection of navigation tests.
      
      (Many of the differences reported in the GitHub visualisation of the changes are due to shifting much of the code 2 spaces to the left, in connection with moving the first `ul` element to be close to its first item.)
      Unverified
      457dce36
  15. Sep 06, 2022
  16. Aug 12, 2022
    • Matt Wang's avatar
      `mermaid`: refactor config to use `mermaid_config.js` include, only require... · e2f1546c
      Matt Wang authored
      `mermaid`: refactor config to use `mermaid_config.js` include, only require `mermaid.version` in `_config.yml` (#909)
      
      This PR has a bit of scope creep! This PR now:
      
      - changes the mermaid opt-in logic to only check for the existence of a `mermaid` key instead of `mermaid != false`: this resolves the follow-up in #857
      - changes the behaviour of mermaid configuration
          - instead of using `mermaid_init.html` with default settings, makes the include `mermaid_config.js`
          - the include is loaded directly into the contents of `mermaid_initialize`
          - by default, it is an empty object (i.e. `{}`), triggering the defaults
      - updates docs
      - adds an example to the markdown kitchen sink  
      
      It does significantly change the interface provided in #857, and I apologize for the confusion. However, given the discussion in this PR, I think it's the best move forward!
      Unverified
      e2f1546c
  17. Jul 23, 2022
  18. Jul 13, 2022
  19. Jul 12, 2022
  20. Jul 04, 2022
  21. Oct 12, 2020
  22. Sep 28, 2020
    • PLanCompS's avatar
      List children also when excluded from main navigation · 09ab1c31
      PLanCompS authored
      - Limit the effect of `nav_exclude: true` to the main navigation.
      - Include links to excluded pages in auto-generating lists of child pages
      and in breadcrumbs.
      - Refactor implementation by moving assignment of `first_level_url` and `second_level_url` from `_includes/nav.html` to `_layouts/default.html`.
      - Clarify the effect of `nav_exclude` in the documentation.
      09ab1c31
  23. Sep 12, 2020
  24. Aug 13, 2020
  25. Aug 11, 2020
    • PLanCompS's avatar
      Update nav.html · e4759dae
      PLanCompS authored
      Indentation adjusted
      e4759dae
    • PLanCompS's avatar
      Update nav.html · a7be52df
      PLanCompS authored
      a7be52df
    • PLanCompS's avatar
      Separate sorting of numbers and strings for navigation order · 4fc59a57
      PLanCompS authored
      The values of `title` and `nav_order` can be numbers or strings.
      Jekyll gives build failures when sorting on mixtures of different types,
      so numbers and strings need to be sorted separately.
      
      Here, numbers are sorted by their values, and come before all strings.
      An omitted `nav_order` value is equivalent to the page's `title` value
      (except that a numerical `title` value is treated as a string).
      
      The case-sensitivity of string sorting is determined by `site.nav_sort`.
      4fc59a57
  26. Aug 10, 2020
    • PLanCompS's avatar
      Ensure pages with nav_exclude are ignored by navigation · 83ec5533
      PLanCompS authored
      Pages with `nav_exclude: true` were included when sorting on `title` or `nav_order`. That could cause build failures when the type of value of the field differs from that on other pages, as reported in https://github.com/pmarsceill/just-the-docs/issues/406.
      
      Pages with `nav_exclude: true` or no `title` are never displayed in the navigation, so removing them from `pages_list` cannot break existing sites. This change also allows the removal of some tests in the code. (The indentation of the code should now be adjusted, but that has been deferred, to restrict the size of the diff for review.)
      
      For testing, the title of `404.html` has been changed to the number `404`,  the page `docs/untitled-test.md`  has been added, and `nav_sort_order` has been set to `case_sensitive`. Those updates give build failures with the current version of `_includes/nav.html`, but not after the suggested changes.
      
      It will still be possible for build failures to occur due to sorting fields of *non-excluded* pages with differing types of values (e.g., `nav_order`a mixture of numbers and strings). To make the code completely safe will require relatively complicated changes,.
      83ec5533
  27. Aug 04, 2020
  28. Aug 02, 2020
    • PLanCompS's avatar
      Update anchor_headings.html · 52588355
      PLanCompS authored
      Fixes a bug where content after headings in header elements disappeared.
      Header elements are not currently used in JtD, but could make the HTML more semantic.
      52588355
  29. Jul 25, 2020
  30. Jul 09, 2020
  31. Jul 06, 2020
  32. Jul 04, 2020
Loading