Releases: just-the-docs/just-the-docs
v0.12.0
Release v0.12.0
Hi folks,
This minor release actually should fix all relevant issues with the placement of .site-footer, first introduced in v0.11.0. I apologize greatly for the delay and the confusion around this issue - the interactions between this component and the many different ways that users overrode different components were more complex than I expected. I've done some more thorough tests and am much more confident that this set of fixes resolves the issue, once necessary migration steps are made.
I've written up migration instructions, which may be relevant for
- all users who have a custom
_includes/nav_footer_custom.html - all users who override the
sidebar.htmlorfooter.htmlcomponents
Thank you for your patience, and apologies again for this mistake. I'll do my best to make sure that this doesn't happen again.
Theme
- Fixed: site footer placement on
md/xs/below, for real @mattxwang in #1771
v0.11.2
Release v0.11.2
Hi folks,
This patch release actually fixes a different regression I introduced in v0.11.0 (the (please see 0.12.0 for a fix), as well as fixing various accessibility issues reported by @cuteshaun. It also fixes the usage of some long-deprecated (and now-aliased) CSS properties.nav_footer showing up twice below the xs viewport)
This should be a straightforward upgrade for all users. However, users who have custom sidebars should follow the migration steps in 0.11.0.
Thank you!
Theme
- Fixed: incorrect behaviour of
nav_footerbelowxsviewport by @mattxwang in #1760 - Fixed: usage of deprecated css properties (
word-wrap,clip) and values (appearance: button) by @mattxwang in #1761 - Fixed: incorrect main content spacing in print styles by @mattxwang in #1765
- Fixed: focus indicator clipping and consistency for sidebar and top nav elements by @mattxwang in #1769
- Fixed: search bar focus trap and search result focus outline clipping by @mattxwang in #1770
v0.11.1
Release v0.11.1
Hi folks,
This is a very quick patch release that fixes a regression I introduced in v0.11.0, related to the nav_footer showing up twice on the xs viewport. Sorry folks! Thank you to those who reported this issue quickly.
Theme
- Fixed: incorrect behaviour of
nav_footeronxsviewport
v0.11.0
Release v0.11.0
Happy new year folks! As promised, this is a very quick release following 0.10.2 that makes some bigger changes to the theme to improve its accessibility. In some corner cases, these are breaking changes, though I do not anticipate that this will affect most users. Separately, there are some styling changes that will look different -- but should also generally improve the accessibility of the theme for its users.
I'm also immensely grateful to @cycomachead, who submitted a PR in 2024 to run automated accessibility tests (via aXe) over our entire site. I have been chipping away at various accessibility issues surfaced by this PR over the past two years. After fixing the majority of them, we have added his suite as part of our light scheme CI pipeline. This should help theme users better meet the WCAG 2.1 AA accessibility standards (and others). Outside of reverse-footnotes, the majority of our docs site (and test sites) pass WAVE with no errors!
I plan to continue improving the accessibility of the theme - particularly in dark mode - in future PRs. I also hope to be more active in theme maintenance in 2026. Thank you everybody for your support!
Migrating to v0.11.0
Migration: users may need to migrate if:
- they have custom code that imports
OneLightJekyllandOneDarkJekyll - they have
theme: legacy_lightin their_config.yml - they have a custom
_includes/components/sidebar.htmland/or _includes/components/footer.html` - have custom code or logic that relies on
.site-footeroutside of_includes/nav_footer_custom.html
For more, refer to POTENTIALLY-BREAKING CHANGES IN v0.11.0 in the migration guide..
Theme
- Fixed: low-contrast syntax highlighting via
accessible-pygmentsand harsher backgrounds by @mattxwang in #1749 - Fixed: callout body text color contrast by @mattxwang in #1748
- Fixed: button and label color contrast by @mattxwang in #1750
- Fixed: inability to focus on scrollable code blocks via keyboard navigation by @mattxwang in #1533
- Fixed:
.site-footerfocus order onsm(mobile) viewport by @mattxwang in #1751 - Fixed: color contrast between dark mode background and
$link-colorby @mattxwang in #1752 - Fixed: color contrast for selected
.nav-list-linkin light mode by @mattxwang in #1753 - Fixed: sidebar ARIA role (by including navigation) by @mattxwang in #1754
- Fixed:
footer_content/footer_customcolor contrast by @mattxwang in #1755
Documentation
- Added: aXe accessibility tests by @cycomachead in #1756
New Contributors
- @cycomachead made their first contribution in #1756 (which is #1513 rebased)
v0.10.2
Release v0.10.2
Hi folks! I'm coming back after a long hiatus to start to make some accessibility updates to the theme. Thank you for your patience as I get back up to speed on all things JtD.
This release mostly contains accessibility fixes. None are breaking, though the ones that resolve contrast and focus issues do induce a (minor) visual change to the site. Upgrading should be straightforward.
Separately, the CHANGELOG has now become significantly slimmer and easier to read. Thank you to the other maintainers for suggesting this!
I plan on following up this release with another v0.11.0 that incorporates some semi-breaking changes to resolve larger layout issues. Thanks everyone for your support, and hope that you have a lovely end to your 2025 (or a start to your 2026)!
Theme
- Fixed:
margin-topandmargin-bottomfor<hr>elements in print styles by @jacksonj04 in #1677 - Fixed: sidenav footer (
.site-footer) color contrast by @mattxwang in #1746 - Fixed: use
aria-expandedinstead ofaria-pressedfor buttons connected to expandable content by @rianrietveld in #1679 - Fixed: accessibility issues with search bar (color contrast, focus indicator, decorative icons) by @mattxwang in #1747
Documentation
- Remove non-essential CHANGELOG information by @mattxwang in #1745
New Contributors
- @jacksonj04 made their first contribution in #1677
- @rianrietveld made their first contribution in #1679
v0.10.1
Release v0.10.1
Hi folks! This patch fixes two bugs related to generated navigation elements and improves our docs.
This release should be a straightforward upgrade for all users of Just the Docs. Thank you for your continued support!
Bugfixes
- Fixed:
back_to_topnot displaying when no other footer variables are set by [@mattxwang] in [#1461] - Fixed: auto-generated child navigation (TOC) by [@pdmosses] in [#1590]
Documentation
- Fixed: incorrect docs for example with minimal layout parent, default layout child by [@janbrasna] in [#1540]
- Fixed: unclear docs on using in-page table of contents by [@sebjameswml] in [#1551]
New Contributors
- [@janbrasna] made their first contribution in [#1540]
- [@sebjameswml] made their first contribution in [#1551]
v0.10.0
Release v0.10.0
Hi folks! This minor release adds one of our most-requested features: unlimited multi-level navigation (also known as recursive navigation). Huge thanks to [@pdmosses] for his wonderful work in implementing this feature!
This release should be a straightforward upgrade for all users of Just the Docs. Thank you for your continued support!
Using Release v0.10.0
Users who have not pinned the theme version will be automatically upgraded to v0.9.0 the next time they build their site.
To use this release explicitly as a remote theme:
remote_theme: just-the-docs/just-the-docs@v0.10.0To use this version explicitly as a gem-based theme, pin the version in your Gemfile and re-run bundle install or bundle update just-the-docs:
gem "just-the-docs", "0.10.0"To use and pin a previous version of the theme, replace the 0.10.0 with the desired release tag.
New Features
Documentation
- Added: Allow unlimited multi-level navigation by [@pdmosses] in [#1440]
- Added: sitemap (via
jekyll-sitemapplugin) by [@mattxwang] in [#1530] - Fixed: (non-systemic) accessibility issues flagged by aXe by [@mattxwang] in [#1531]
v0.9.0
Release v0.9.0
Hi folks! This minor release adds a nav_enabled set of variables to enable/disable the navigation at a site, layout, and page level --- and uses that to add search and auxilary links to the minimal layout. In addition, it fixes search-data.json corruption with default layouts and some minor CSS/SCSS issues.
This release should be a straightforward upgrade for all users of Just the Docs. Thank you for your continued support!
Using Release v0.9.0
Users who have not pinned the theme version will be automatically upgraded to v0.9.0 the next time they build their site.
To use this release explicitly as a remote theme:
remote_theme: just-the-docs/just-the-docs@v0.9.0To use this version explicitly as a gem-based theme, pin the version in your Gemfile and re-run bundle install or bundle update just-the-docs:
gem "just-the-docs", "0.9.0"To use and pin a previous version of the theme, replace the 0.9.0 with the desired release tag.
New Features
- Added:
nav_enabledsite, layout, and page-level variable to selectively show or hide the side/mobile menu by [@kevinlin1] in [#1441] - Added: site-wide search bar and auxiliary links to the
minimallayout by [@kevinlin1] in [#1441]
Bugfixes
- Fixed: protect
search-data.jsonfile from front matter default for layout by [@mattxwang] in [#1468] - Fixed: Sass mixed declarations by [@bobvandevijver] in [#1495]
- Fixed: redundant
monospaceinpre,code,kbd,sampreset by [@mattxwang] in [#1508]
Documentation
- Docs: Explained the
nav_enabledvariables as an alternative to using the minimal layout [@kevinlin1] in [#1441].
New Contributors
- [@bobvandevijver] made their first contribution in [#1495]
v0.8.2
(note: we forgot to make this release post when first releasing 0.8.2 - sorry about that!)
Release v0.8.2
Hi everyone! This patch release fixes a bug where a default layout with unrestricted scope (path: "") breaks JavaScript functionality. Users who do not use a default layout with unrestricted scope should not be affected. This should be a straightforward upgrade for all users. Thank you to [@pdmosses] for triaging and fixing the bug!
Bugfixes
v0.8.1
Release v0.8.1
Hi folks! This patch release fixes a bug introduced in 0.8.0 that affects users who build their sites in strict mode. It is a straightforward upgrade that should require no manual migration changes. Thank you to [@Zarthus] for quickly catching and fixing this bug!