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_top not 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]

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.0

To 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

• Added: Allow unlimited multi-level navigation by [@pdmosses] in [#1431]

Documentation

• Added: Allow unlimited multi-level navigation by [@pdmosses] in [#1440]
• Added: sitemap (via jekyll-sitemap plugin) by [@mattxwang] in [#1530]
• Fixed: (non-systemic) accessibility issues flagged by aXe by [@mattxwang] in [#1531]

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.0

To 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_enabled site, 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 minimal layout by [@kevinlin1] in [#1441]

Bugfixes

• Fixed: protect search-data.json file from front matter default for layout by [@mattxwang] in [#1468]
• Fixed: Sass mixed declarations by [@bobvandevijver] in [#1495]
• Fixed: redundant monospace in pre, code, kbd, samp reset by [@mattxwang] in [#1508]

Documentation

• Docs: Explained the nav_enabled variables as an alternative to using the minimal layout [@kevinlin1] in [#1441].

New Contributors

• [@bobvandevijver] made their first contribution in [#1495]

(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

• Fixed: Protect theme JS file from front matter default for layout by [@pdmosses] in #1447

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!

Bugfixes

• Fixed: Liquid filter typo in breadcrumb component (strip instead of trim) by [@Zarthus] in [#1434]

Documentation

• Build docs site using strict mode and strict_filters by [@Zarthus] in [#1435]

New Contributors

• [@Zarthus] made their first contribution in [#1434]

Release v0.8.0

Hi folks! This first minor release of 2024 has a short number of changes: a large improvement of build times for large sites, a new keyboard shortcut to focus the search bar, and sidebar navigation bugfixes for "pretty" URLs (with .html omitted) and the clickable area on Safari. This release has no explicit breaking changes and should be a straightforward upgrade for most (if not all) users.

Using Release v0.8.0

Users who have not pinned the theme version will be automatically upgraded to v0.8.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.8.0

To 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.8.0"

To use and pin a previous version of the theme, replace the 0.8.0 with the desired release tag.

New Features

• Added: configurable keyboard shortcut to focus search input by [@kcromanpl-bajra] in [#1411]

Bugfixes

• Fixed: quicker build by [@pdmosses] in [#1397]
• Fixed: incorrect navigation when .html omitted from URL by [@pdmosses] in [#1374]
• Fixed: incorrect positioning of clickable area for navigation links on Safari by [@mattxwang] in [#1403]

Documentation

• Add documentation to "Navigation Structure" on grouping pages with collections by [@mitchnemirov] in [#1390]

New Contributors

• [@mitchnemirov] made their first contribution in [#1390]
• [@kcromanpl-bajra] made their first contribution in [#1411]

Release v0.7.0

Hi folks! This is a minor release that adds a new configuration option for opening external links in a new tab and provides many bugfixes (in both correctness and performance) for Just the Docs users with large sites. We anticipate that for most users, this is a straightforward upgrade. However, it introduces some potentially-breaking internal changes to undocumented features of the theme.

Migrating to v0.7.0

Migration: users will need to migrate if:

• they overrode _includes/nav.html, which has moved to _includes/components/nav.html
• they have an element with the IDs jtd-nav-activation or jtd-head-nav-stylesheet

For more, refer to the migration guide.

Using Release v0.7.0

Users who have not pinned the theme version will be automatically upgraded to v0.7.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.7.0

To 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.7.0"

To use and pin a previous version of the theme, replace the 0.7.0 with the desired release tag.

New Features

• Added: configuration options for opening external links in new tab by [@CarbonNeuron] in [#1360]

Bugfixes

• Fixed: remove href from the navigation link to the current page by [@pdmosses] in [#1356]
• Fixed: improve build time by [@pdmosses] in [#1358]
• Fixed: erroneous parentheses in site_nav conditional by [@mattxwang] in [#1366]
• Fixed: navigation scroll to active link regression by [@pdmosses] in [#1367]
• Fixed: invalid CSS rules in head elements by [@pdmosses] in [#1368]
• Fixed: accidental disabling of forward-declared stylesheets by [@mattxwang] in [#1373]

Warning
[#1358] moved _includes/nav.html to the _includes/components directory,
Users who were overriding that file will need to adjust their sites accordingly.

Documentation:

• Docs: fix typos in CHANGELOG and MIGRATION by [@thapasusheel] in [#1377]

New Contributors

• [@CarbonNeuron] made their first contribution in [#1360]
• [@thapasusheel] made their first contribution in [#1377]

Release v0.6.2

Hi all, this is a small patch release that includes two changes: adding a missing Windows emoji font fallback, and removing some (now-unused) code introduced in 0.6.

Bugfixes

• Fixed: Windows emoji font fallback by [@flanakin] in [#1337]
• Removed: unused .passive toggle in navigation by [@pdmosses] in [#1335]

New Contributors

• [@flanakin] made their first contribution in [#1337]

Release v0.6.1

Hi all, this is a small patch release that only includes one change: resolving a bug introduced in 0.6.0 that causes a JS error for pages excluded from navigation.

Bugfixes

• Fixed: JS error for pages excluded from navigation by [@pdmosses] in [#1332]

Release v0.6.0

Hi all, this is a minor release that introduces performance improvements for build times on large sites, correctly sets the color-scheme property, and fixes invalid HTML. However, it introduces some potentially-breaking internal changes to undocumented features of the theme.

Migrating to v0.6.0

Migration: users will need to migrate if:

• they have an existing _includes file named favicon.html, head_nav.html, or css/activation.scss.liquid
• they have code that refers to #main-content-wrap
• they override the default light theme's code, or the theme-loading logic
• they have different favicons for different pages

For more, refer to the migration guide.

Using Release v0.6.0

Users who have not pinned the theme version will be automatically upgraded to v0.6.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.6.0

To 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.6.0"

To use and pin a previous version of the theme, replace the 0.6.0 with the desired release tag.

New Features and Bugfixes

• Added: $color-scheme theme variable to specify color-scheme for :root by [@sigv] in [#1280]
• Fixed: build times for large sites by [@pdmosses] in [#1244]
• Fixed: missing closing </button> tag in sidebar.html by [@mattxwang] in [#1304]
• Fixed: removed duplicate #main-content-wrap minimal and default layouts by [@mattxwang] in [#1305]

Documentation

{: .warning }
The theme docs are unversioned, and already reflect the above changes.

Docs changes:

• A footnote in the configuration docs explains how disabling JavaScript affects the display of navigation links when browsing folded collections.
• Invalid HTML has been removed from most documentation examples.

New Contributors

• [@sigv] made their first contribution in [#1280]