- Sep 26, 2022
-
-
Peter Mosses authored
Closes #961. Replays a previous attempt.
-
- Sep 22, 2022
-
-
dependabot[bot] authored
Bumps [stylelint](https://github.com/stylelint/stylelint) from 14.12.0 to 14.12.1. - [Release notes](https://github.com/stylelint/stylelint/releases) - [Changelog](https://github.com/stylelint/stylelint/blob/main/CHANGELOG.md) - [Commits](https://github.com/stylelint/stylelint/compare/14.12.0...14.12.1 ) --- updated-dependencies: - dependency-name: stylelint dependency-type: direct:development update-type: version-update:semver-patch ... Signed-off-by:
dependabot[bot] <support@github.com> Signed-off-by:
dependabot[bot] <support@github.com> Co-authored-by:
dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
-
Peter Mosses authored
* Make CHANGELOG urls clickable - Add link reference definitions for PRs and new contributors in v0.4.0.rc2 - Replace inline urls by shortcut link references - Add front matter so the page appears in the navigation - Change the link to the CHANGELOG on the home page The CHANGELOG contents should look the same in the docs and in the repo (apart from the callouts) with clickable links to PRs and some contributors. The urls shown in the changes in v0.4.0.rc1 (and previous releases) haven't yet been made clickable – it would be too tedious and error-prone to do it manually. * Make CHANGELOG urls clickable - Add a callout
-
Matt Wang authored
-
Matt Wang authored
Change link/anchor styling to use `text-decoration`, `text-decoration-color`, `text-underline-offset`. Looking to tackle some low-hanging fruit! Closes #636. [Link to deploy preview](https://deploy-preview-967--just-the-docs.netlify.app/). Old behaviour: <img width="582" alt="Screen Shot 2022-09-16 at 11 56 26 AM" src="https://user-images.githubusercontent.com/14893287/190711440-8e56c3a2-250f-4121-8c57-8e6e20c4ae07.png"> New behaviour: <img width="546" alt="Screen Shot 2022-09-16 at 11 56 19 AM" src="https://user-images.githubusercontent.com/14893287/190711520-2cc7fd4d-d449-4e14-9e75-96545f9f578d.png"> Some notes: - the only visible change should be minor differences in the thickness of the line (browser defaults) + how underhangs (ex a "g") interact with the line - color-wise, this is a no-op :) - I added an offset to mimic the behaviour of `background-size: 1px 1px;` Let me know what we think!
-
- Sep 19, 2022
-
-
dependabot[bot] authored
Bumps [stylelint](https://github.com/stylelint/stylelint) from 14.11.0 to 14.12.0. - [Release notes](https://github.com/stylelint/stylelint/releases) - [Changelog](https://github.com/stylelint/stylelint/blob/main/CHANGELOG.md) - [Commits](https://github.com/stylelint/stylelint/compare/14.11.0...14.12.0 ) --- updated-dependencies: - dependency-name: stylelint dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by:
dependabot[bot] <support@github.com> Signed-off-by:
dependabot[bot] <support@github.com> Co-authored-by:
dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
-
- Sep 16, 2022
-
-
Matt Wang authored
-
Matt Wang authored
This is a bite-sized PR that fixes #681. It adds a very minimal styling set to `blockquote` that can be easily overridden by a user. The [markdown kitchen sink](https://deploy-preview-965--just-the-docs.netlify.app/docs/index-test/) has the example described in the issue: <img width="772" alt="Screen Shot 2022-09-15 at 5 49 44 PM" src="https://user-images.githubusercontent.com/14893287/190533247-60ddaba3-85b2-4c03-b520-a67f6b047345.png"> Note that it differs from GFM/GitHub's renderer: > This is a blockquote! I'm not sure if the intention is to bring it to one-to-one parity. If that's the case, I can dim the text color and make the sidebar thicker.
-
- Sep 15, 2022
-
-
Matt Wang authored
-
Matt Wang authored
Closes #963. - redundant `role="navigation"` on nav elements - redundant `type="text/javascript"` on script tags - misplaced mermaid script tag Note that [running the validator on the deploy preview](https://validator.w3.org/nu/?doc=https%3A%2F%2Fdeploy-preview-964--just-the-docs.netlify.app%2F) has no errors now!
-
Matt Wang authored
-
Peter Mosses authored
An occurrence of `grandchild` was miss-spelled `grand_child` (!). That caused omission of the `active` class in the link in the nav panel for all grandchildren. This bug was discovered using `diff` to compare the generated sites built using v0.4.0.rc1 and commit 4396b6b1c836f354bb7aa7edc1a06a49f137d615 on the fix-nav-performance PR branch.
-
Matt Wang authored
-
Henry Schreiner authored
Fixes #396.
-
- Sep 13, 2022
-
-
Peter Mosses authored
Remove inaccurate comments about unpinned gem versions - pre-release gems have lower precedence than release gems.
-
- Sep 12, 2022
-
-
Peter Mosses authored
Clarify that there aren't yet any changes to `main` since the release of `v0.4.0.rc2`.
-
Matt Wang authored
-
Matt Wang authored
prep for v0.4.0.rc2
-
Matt Wang authored
-
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.)
-
- Sep 11, 2022
-
-
Matt Wang authored
-
Jeremy Prevost authored
Why are these changes being introduced: * The current tab order requires keyboard or screenreader users to tab though all of the navigation links before they get to the main content of the page Relevant ticket(s): * Discussed as part of larger WCAG ticket https://github.com/just-the-docs/just-the-docs/issues/566 How does this address that need: * Introduces an off screen link as the first element in the tab order that will display when it has focus but remain off screen for users not using tab to navigate the document. * Introduces a new scss file with the required style elements and uses colors variables to ensure both light and dark mode are respected. Background information on this technique: - https://www.w3.org/TR/WCAG20-TECHS/G1.html - https://accessibility.oit.ncsu.edu/it-accessibility-at-nc-state/developers/accessibility-handbook/mouse-and-keyboard-events/skip-to-main-content/
-
Matt Wang authored
-
Peter Mosses authored
This PR updates the home page and the CHANGELOG to refer to v0.4.0.rc1 as a pre-release or release candidate, rather than a release. See [this comment](https://github.com/just-the-docs/just-the-docs/pull/613#issuecomment-1240442518) for motivation. It also adds the versioned docs issue (#728) to the roadmap in the CHANGELOG. As the config for the theme docs now needs to declare callouts, the [callouts docs](https://just-the-docs.github.io/just-the-docs/docs/ui-components/callouts/) can now illustrate the rendered appearance. (These callouts are merely examples: the names and colors should eventually be replaced by a principled collection, taking account of WCAG.)
-
- Sep 07, 2022
-
-
Matt Wang authored
-
Matt Wang authored
Follow-up to #613. Relatively self-explanatory! Co-authored-by:
Peter Mosses <18308236+pdmosses@users.noreply.github.com>
-
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:
Matt Wang <matt@matthewwang.me>
-
Matt Wang authored
-
- Sep 06, 2022
-
-
Matt Wang authored
-
Jeremy Prevost authored
Adds accessible nav elements for nested pages Why are these changes being introduced: * The current links to show/hide the nested pages use a visual only svg image with no accessible affordance provided so screenreaders will not be able to provide appropriate context for users as to what they should expect when clicking these links * You can see the problem by running a tool like ANDI on the current main branch of this repository and then running it again on this branch. ANDI shows what a screenreader would read. * You can also use a tool like Voiceover to hear the importance of what this introduces to users that use that technology. Before this change, Voiceover would read all of these navigation links as "link image just-the-docs" but with this change it will read `link image toggle links in <categoryName> category` Relevant ticket(s): * This was discussed as part of the larger WCAG compliance ticket https://github.com/just-the-docs/just-the-docs/issues/566 How does this address that need: * This adds an `aria-label` to the link https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-label Document any side effects to this change: It appears it might be prefereable to use `aria-labelledby` whenever possible, but from what I can tell these links are just the visual cue of the svg with no other affordance given to users to understand what they'll do so there is nothing to point `aria-labelledby` at. An `svg` title was considered, but in reading more about it it seemed like `aria-label` was more appropriate as it puts the label on the `a` rather than the `svg` which feels more accurate. * https://developer.mozilla.org/en-US/docs/Web/SVG/Element/title * https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-labelledby Co-authored-by:
Matt Wang <matt@matthewwang.me>
-
Matt Wang authored
-
Manuel Henke authored
Building the jekyll site on your own in GitHub workflows fails due missing exclude of `vendor` in `_config.yml`. If someone reuses your `_config.yml` he/she will come across some issues. Reference: https://github.com/jekyll/jekyll/issues/5267#issuecomment-241379902
-
Matt Wang authored
-
Olga Matoula authored
-
- Aug 26, 2022
-
-
Peter Mosses authored
Added a missing `{: .no_toc }`, to avoid a 3rd-level item in the displayed TOC at the top of the page.
-
Matt Wang authored
-
Robin Pokorny authored
-
- Aug 24, 2022
-
-
Matt Wang authored
-
Matt Wang authored
99% certain we don't use this file; - [script](https://github.com/just-the-docs/just-the-docs/search?q=script) has no non-`<script>`/doc uses - [build](https://github.com/just-the-docs/just-the-docs/search?q=build) has no mentions - we don't need to manually build / package the gem anymore
-
- Aug 23, 2022
-
-
dependabot[bot] authored
Bumps [stylelint](https://github.com/stylelint/stylelint) from 14.10.0 to 14.11.0. - [Release notes](https://github.com/stylelint/stylelint/releases) - [Changelog](https://github.com/stylelint/stylelint/blob/main/CHANGELOG.md) - [Commits](https://github.com/stylelint/stylelint/compare/14.10.0...14.11.0 ) --- updated-dependencies: - dependency-name: stylelint dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by:
dependabot[bot] <support@github.com> Signed-off-by:
dependabot[bot] <support@github.com> Co-authored-by:
dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
-