A modern, high customizable, responsive Jekyll theme for documentation with built-in search.
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!
strip instead of trim) by [@Zarthus] in [#1434]strict_filters by [@Zarthus] in [#1435]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.
v0.8.0Users 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/[email protected]
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.
.html omitted from URL by [@pdmosses] in [#1374]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.
v0.7.0Migration: users will need to migrate if:
_includes/nav.html, which has moved to _includes/components/nav.html
jtd-nav-activation or jtd-head-nav-stylesheet
For more, refer to the migration guide.
v0.7.0Users 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/[email protected]
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.
site_nav conditional by [@mattxwang] in [#1366]Warning [#1358] moved
_includes/nav.htmlto the_includes/componentsdirectory, Users who were overriding that file will need to adjust their sites accordingly.
CHANGELOG and MIGRATION by [@thapasusheel] in [#1377]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.
.passive toggle in navigation by [@pdmosses] in [#1335]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.
v0.6.0Migration: users will need to migrate if:
_includes file named favicon.html, head_nav.html, or css/activation.scss.liquid
#main-content-wrap
light theme's code, or the theme-loading logicFor more, refer to the migration guide.
v0.6.0Users 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/[email protected]
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.
$color-scheme theme variable to specify color-scheme for :root by [@sigv] in [#1280]</button> tag in sidebar.html by [@mattxwang] in [#1304]#main-content-wrap minimal and default layouts by [@mattxwang] in [#1305]{: .warning } The theme docs are unversioned, and already reflect the above changes.
Docs changes:
Hi all, this is a small patch release that only includes one change: fixing a style clash between Mermaid's labels and Just the Docs' labels.
Note: for subsequent patch releases, we will omit migration instructions (for brevity). In all cases, immediate migration should be backwards-compatible. Refer to previous major or minor update instructions for more information.
.label styling by [@mattxwang] in [#1278]Hi all, this is a minor patch release that only includes one change: changing all text-based CSS properties to use rem instead of hard-coded px values. This has two effects:
jekyll build.$root-font-size SCSS variable. We will remove it in an upcoming release of the theme.If you use the stock Just the Docs theme, this release should have no impact on your final built site. If you change the $root-font-size SCSS variable, you might experience light layout shifts.
v0.5.3Users who have not pinned the theme version will be automatically upgraded to v0.5.3 the next time they build their site.
To use this release explicitly as a remote theme:
remote_theme: just-the-docs/[email protected]
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.5.3"
To use and pin a previous version of the theme, replace the 0.5.3 with the desired release tag.
rem instead of fixed px values; deprecate $root-font-size by [@mattxwang] in [#1169]Hi all, this is a minor patch release that mostly focuses on accessibility. Since we follow semantic versioning, this should be a smooth upgrade with no breaking changes.
In addition, the theme docs website has a new canonical URL: https://just-the-docs.com. We've also retroactively published the theme docs website for version v0.3.3 at https://v0-3-3-docs.just-the-docs.com/. Thank you to our GitHub sponsors for funding our domain name!
v0.5.2Users who have not pinned the theme version will be automatically upgraded to v0.5.2 the next time they build their site.
To use this release explicitly as a remote theme:
remote_theme: just-the-docs/[email protected]
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.5.2"
To use and pin a previous version of the theme, replace the 0.5.2 with the desired release tag.
href="#"; adds aria-pressed information for toggles by [@mattxwang] in [#1262]Full Changelog: https://github.com/just-the-docs/just-the-docs/compare/v0.5.1...v0.5.2
Hi all, this is a very small minor patch release that has two small behavioral bugfixes: fixing a regression introduced in v0.5.0 on Safari versions <16.4 (broken media query), and the copy code button providing incorrect feedback in insecure browser contexts. This should be a smooth upgrade with no breaking changes.
As always, we'd love your feedback. Open an issue or start a discussion for bug reports, feature requests, and any other feedback. Thanks for continuing to use Just the Docs!
v0.5.1Users who have not pinned the theme version will be automatically upgraded to v0.5.1 the next time they build their site.
To use this release explicitly as a remote theme:
remote_theme: just-the-docs/[email protected]
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.5.1"
To use and pin a previous version of the theme, replace the 0.5.1 with the desired release tag.
<16.4 by [@mattxwang] in [#1240]font-weight typo (Utilities > Typography) by [@mattxwang] in [#1229]just the docs typo in migration guide by [@mattxwang] in [#1230]