Skip to content
Snippets Groups Projects
  1. Sep 29, 2022
  2. Sep 27, 2022
    • Matt Wang's avatar
      Update CHANGELOG.md · 2e48a7e6
      Matt Wang authored
      Unverified
      2e48a7e6
    • Peter Mosses's avatar
      Improve docs for code highlighting with line numbers (#974) · 93857587
      Peter Mosses authored
      * Add toc heading custom include
      
      Closes #961.
      
      * Revert "Add toc heading custom include"
      
      This reverts commit 49813c341973e313db0a21f075a60ebf2120989e.
      
      * Update code highlighting with line numbers
      
      - Add the example of code highlighting with line numbers explained in the [Jekyll docs](https://jekyllrb.com/docs/liquid/tags/#line-numbers).
      - Fix the styling of narrow code with line numbers, which floats to the centre without this CSS adjustment. (The line numbers column expands as needed with larger numbers of lines, despite using `width`; using `min-width` doesn't work.)
      
      To apply HTML compression, I removed `vendor` from `exclude`; that change is left to a different PR.
      Unverified
      93857587
  3. Sep 26, 2022
    • Peter Mosses's avatar
      Make more CHANGELOG urls clickable (#984) · ce820828
      Peter Mosses authored
      * Make more CHANGELOG  urls clickable
      
      Extension of PR #977 to v0.4.0.rc1:
      
      - Make callouts `loud`.
      - Replace a warning paragraph by a callout.
      - Use a reference link instead of an explicit url for @pmarsceill .
      - Add link reference definitions for PRs and new contributors in v0.4.0.rc1.
      - Replace inline urls by shortcut link references.
      
      The changes to replace URLs by link references would be too tedious and error-prone to do completely manually for v0.4.0.rc1.
      The following regexp replacements were applied to the sections of v0.4.0.rc1, using Atom:
      
      - Copy a section of changes.
      - In the copy, replace `.*(https://.*pull/)([0-9]+).*$` by `[#$2]: $1$2`.
      - In the original, replace `(https://.*pull/)([0-9]+)` by `[#$2]`.
      
      - Copy a section of new contributors.
      - In the copy, replace `\* @([^ ]+) .*$` by `[@$1]: https://githhub.com/$1`.
      - In the original, replace `@([a-zA-Z0-9]+)` by `[@$1]`.
      
      Add (co)authors in [#578]:
      
      * [@AdityaTiwari2102] made their first contribution in [#477]
      * [@svrooij] made their first contribution in [#544]
      
      [@AdityaTiwari2102]: https://githhub.com/AdityaTiwari2102
      [@svrooij]: https://githhub.com/svrooij
      
      To test:
      
      1. Check that the CHANGELOG contents looks the same in the docs and in the repo (apart from the callouts) with clickable links to all PRs and contributors for v0.4.0.rc1.
      
      2. Check that none of the lines with changes or new contributors have been removed.
      
      * Revert to quiet callouts
      Unverified
      ce820828
    • Matt Wang's avatar
      Update CHANGELOG.md · 58ca9394
      Matt Wang authored
      Unverified
      58ca9394
    • Peter Mosses's avatar
      Fix excluded vendor cleanup (#985) · 13a1ac2a
      Peter Mosses authored
      Fix #973
      
      Update the array of excluded directories and files to be:
      
      - those that Jekyll excludes by default (since our `exclude` replaces Jekyll's defaults in Jekyll 3) and
      - the others that the theme previously excluded, but omitting `vendor` – also ones that are no longer in the repo.
      
      Excluding `vendor` was preventing HTML compression of the theme docs, since the layout used for compression is in `_layouts/vendor/compress.html`.
      
      The change from one-line to multi-line YAML layout for the array of excluded files enhances readability. The addition of explanatory comments supports maintenance.
      
      To test the effect of this PR on the theme docs:
      
      - Build and serve the theme docs.
      - Check that  the HTML files are now compressed.
      - Check that the last example of code with line numbers has incorrect formatting.
      
      (This PR cannot affect sites that use the theme as a gem or as a remote theme, since we don't include our `_config.yml`.)
      Unverified
      13a1ac2a
    • Matt Wang's avatar
      typo fix - agh! · 42c81a92
      Matt Wang authored
      Unverified
      42c81a92
    • Matt Wang's avatar
      Update CHANGELOG.md · a7ebb450
      Matt Wang authored
      Unverified
      a7ebb450
    • Peter Mosses's avatar
      Add custom include for TOC heading (#980) · 6061dd27
      Peter Mosses authored
      Closes #961. Replays a previous attempt.
      Unverified
      6061dd27
  4. Sep 22, 2022
  5. Sep 19, 2022
  6. Sep 16, 2022
  7. Sep 15, 2022
  8. Sep 13, 2022
    • Peter Mosses's avatar
      Update CHANGELOG.md · 7cda88df
      Peter Mosses authored
      Remove inaccurate comments about unpinned gem versions
      - pre-release gems have lower precedence than release gems.
      7cda88df
  9. Sep 12, 2022
    • Peter Mosses's avatar
      Update CHANGELOG.md · e484ad03
      Peter Mosses authored
      Clarify that there aren't yet any changes to `main` since the release of `v0.4.0.rc2`.
      Unverified
      e484ad03
    • Matt Wang's avatar
      Update CHANGELOG.md · e88f7f32
      Matt Wang authored
      Unverified
      e88f7f32
    • Matt Wang's avatar
      prep for `v0.4.0.rc2` (#957) · d9594fb7
      Matt Wang authored
      prep for v0.4.0.rc2
      Unverified
      d9594fb7
    • Matt Wang's avatar
      Update CHANGELOG.md · 7e646caa
      Matt Wang authored
      Unverified
      7e646caa
    • 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
  10. Sep 11, 2022
  11. Sep 07, 2022
  12. Sep 06, 2022
Loading