Skip to content
Snippets Groups Projects
  1. Sep 15, 2022
  2. 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
  3. 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`.
      e484ad03
    • Matt Wang's avatar
      Update CHANGELOG.md · e88f7f32
      Matt Wang authored
      e88f7f32
    • Matt Wang's avatar
      prep for `v0.4.0.rc2` (#957) · d9594fb7
      Matt Wang authored
      prep for v0.4.0.rc2
      d9594fb7
    • Matt Wang's avatar
      Update CHANGELOG.md · 7e646caa
      Matt Wang authored
      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.)
      457dce36
  4. Sep 11, 2022
  5. Sep 07, 2022
    • Matt Wang's avatar
      Update CHANGELOG.md · 3f891455
      Matt Wang authored
      3f891455
    • Matt Wang's avatar
      Add docs for custom search placeholder (#939) · 91a894c0
      Matt Wang authored
      
      Follow-up to #613. Relatively self-explanatory!
      
      Co-authored-by: default avatarPeter Mosses <18308236+pdmosses@users.noreply.github.com>
      91a894c0
    • Alyssa Ross's avatar
      Improve display of AsciiDoc examples with titles (#944) · e03483d8
      Alyssa Ross authored
      
      The jekyll-asciidoc plugin will take AsciiDoc markup like this:
      
      	.A method that returns the string "Hello, world"
      	[example]
      	[source,ruby]
      	----
      	def hello
      	  "Hello, world"
      	end
      	----
      
      And produce HTML like this (syntax highlighting disabled):
      
      	<div class="listingblock">
      	  <div class="title">A method that returns the string "Hello, world"</div>
      	  <div class="content">
      	    <pre class="highlight"><code class="language-ruby" data-lang="ruby">def hello
      	  "Hello, world"
      	end</code></pre>
      	  </div>
      	</div>
      
      Previously, because we were applying code block styling to the whole
      listingblock, the title would be rendered as normal body text, inside
      the code block, which did not look good.  With this change, it will
      instead be rendered similarly to a Just The Docs rendered example —
      the title will appear where the rendered example usually would.
      
      Co-authored-by: default avatarMatt Wang <matt@matthewwang.me>
      e03483d8
    • Matt Wang's avatar
      Update CHANGELOG.md · fb5161ff
      Matt Wang authored
      fb5161ff
  6. Sep 06, 2022
  7. Aug 26, 2022
  8. Aug 24, 2022
  9. Aug 23, 2022
  10. Aug 22, 2022
  11. Aug 13, 2022
  12. Aug 12, 2022
  13. Aug 08, 2022
Loading