From 5919e919d5afb25411a3ecc713a0f2893bc0e807 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Tue, 25 Jul 2023 12:50:32 +0100 Subject: [PATCH 1/2] Update dependency jekyll to v4.3.2 (#71) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit [![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Update | Change | |---|---|---| | [jekyll](https://jekyllrb.com) ([source](https://togithub.com/jekyll/jekyll), [changelog](https://togithub.com/jekyll/jekyll/releases)) | patch | `4.3.0` -> `4.3.2` | --- ### Release Notes
jekyll/jekyll (jekyll) ### [`v4.3.2`](https://togithub.com/jekyll/jekyll/blob/HEAD/History.markdown#432--2023-01-20) [Compare Source](https://togithub.com/jekyll/jekyll/compare/v4.3.1...v4.3.2) ##### Bug Fixes - Backport [#​9257](https://togithub.com/jekyll/jekyll/issues/9257) for v4.3.x: Rename sass partial created for new blank site ([#​9262](https://togithub.com/jekyll/jekyll/issues/9262)) - Backport [#​9187](https://togithub.com/jekyll/jekyll/issues/9187) for v4.3.x: Optimize `Site#each_site_file` ([#​9256](https://togithub.com/jekyll/jekyll/issues/9256)) - Backport [#​9186](https://togithub.com/jekyll/jekyll/issues/9186) for v4.3.x: Remove totals in profile table properly ([#​9255](https://togithub.com/jekyll/jekyll/issues/9255)) ##### Development Fixes - Backport [#​9223](https://togithub.com/jekyll/jekyll/issues/9223) for 4.3.x: Update sass related tests for jekyll-sass-converter 3.x ([#​9254](https://togithub.com/jekyll/jekyll/issues/9254)) ### [`v4.3.1`](https://togithub.com/jekyll/jekyll/blob/HEAD/History.markdown#431--2022-10-26) [Compare Source](https://togithub.com/jekyll/jekyll/compare/v4.3.0...v4.3.1) ##### Bug Fixes - Respect user-defined name attribute in documents ([#​9167](https://togithub.com/jekyll/jekyll/issues/9167)) - Revert "Incrementally rebuild when a data file is changed" ([#​9170](https://togithub.com/jekyll/jekyll/issues/9170)) ##### Documentation - Release post for v4.3.1 ([#​9171](https://togithub.com/jekyll/jekyll/issues/9171))
--- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/UCL-ARC/python-template). Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Patrick Roddy --- docs/Gemfile.lock | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/Gemfile.lock b/docs/Gemfile.lock index 9a71d09a..5bc2b347 100644 --- a/docs/Gemfile.lock +++ b/docs/Gemfile.lock @@ -1,7 +1,7 @@ GEM remote: https://rubygems.org/ specs: - addressable (2.8.1) + addressable (2.8.4) public_suffix (>= 2.0.2, < 6.0) colorator (1.1.0) concurrent-ruby (1.1.10) @@ -14,7 +14,7 @@ GEM http_parser.rb (0.8.0) i18n (1.12.0) concurrent-ruby (~> 1.0) - jekyll (4.3.0) + jekyll (4.3.2) addressable (~> 2.4) colorator (~> 1.0) em-websocket (~> 0.5) @@ -44,20 +44,20 @@ GEM rexml kramdown-parser-gfm (1.1.0) kramdown (~> 2.0) - liquid (4.0.3) + liquid (4.0.4) listen (3.7.1) rb-fsevent (~> 0.10, >= 0.10.3) rb-inotify (~> 0.9, >= 0.9.10) mercenary (0.4.0) pathutil (0.16.2) forwardable-extended (~> 2.6) - public_suffix (5.0.0) + public_suffix (5.0.3) rake (13.0.6) rb-fsevent (0.11.2) rb-inotify (0.10.1) ffi (~> 1.0) rexml (3.2.5) - rouge (4.0.0) + rouge (4.0.1) safe_yaml (1.0.5) sassc (2.4.0) ffi (~> 1.9) From 2d07c334ee71844506f67d7eb56bb0dca7a33083 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Tue, 25 Jul 2023 12:52:35 +0100 Subject: [PATCH 2/2] Update dependency just-the-docs to v0.5.4 (#72) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit [![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Update | Change | |---|---|---| | [just-the-docs](https://togithub.com/just-the-docs/just-the-docs) ([changelog](https://togithub.com/just-the-docs/just-the-docs/blob/main/CHANGELOG.md)) | minor | `"0.4.0.rc4"` -> `"0.5.4"` | --- ### Release Notes
just-the-docs/just-the-docs (just-the-docs) ### [`v0.5.4`](https://togithub.com/just-the-docs/just-the-docs/blob/HEAD/CHANGELOG.md#Release-v054) [Compare Source](https://togithub.com/just-the-docs/just-the-docs/compare/v0.5.3...v0.5.4) 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.* ##### Bugfixes - Fixed: Mermaid labels inheriting theme `.label` styling by \[[@​mattxwang](https://togithub.com/mattxwang)] in [#​1278] [#​1278]: https://togithub.com/just-the-docs/just-the-docs/pull/1278 ### [`v0.5.3`](https://togithub.com/just-the-docs/just-the-docs/blob/HEAD/CHANGELOG.md#Release-v053) [Compare Source](https://togithub.com/just-the-docs/just-the-docs/compare/v0.5.2...v0.5.3) 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: 1. All deprecation warnings are now fixed on build; you should now get a clean build with `jekyll build`. 2. We have **deprecated the `$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. ##### Using Release `v0.5.3` Users 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: ```yml remote_theme: just-the-docs/just-the-docs@v0.5.3 ``` 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`: ```ruby 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. ##### Bugfixes - Fixed: font-size scaling for text-related CSS properties by using `rem` instead of fixed `px` values; deprecate `$root-font-size` by \[[@​mattxwang](https://togithub.com/mattxwang)] in [#​1169] [#​1169]: https://togithub.com/just-the-docs/just-the-docs/pull/1169 ### [`v0.5.2`](https://togithub.com/just-the-docs/just-the-docs/blob/HEAD/CHANGELOG.md#Release-v052) [Compare Source](https://togithub.com/just-the-docs/just-the-docs/compare/v0.5.1...v0.5.2) 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: . We've also retroactively published the theme docs website for version `v0.3.3` at . Thank you to our GitHub sponsors for funding our domain name! ##### Using Release `v0.5.2` Users 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: ```yml remote_theme: just-the-docs/just-the-docs@v0.5.2 ``` 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`: ```ruby 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. ##### Bugfixes - Fixed: liquid variable leakage in navigation components by \[[@​pdmosses](https://togithub.com/pdmosses)] in [#​1243] - Fixed: ARIA roles and labels for search, header, logo, mobile menu button, and main content by [@​joelhawksley] in [#​1259] - Fixed: ARIA labels for all anchors with `href="#"`; adds `aria-pressed` information for toggles by \[[@​mattxwang](https://togithub.com/mattxwang)] in [#​1262] ##### New Contributors - [@​joelhawksley] made their first contribution in [#​1259] [@​joelhawksley]: https://togithub.com/joelhawksley [#​1243]: https://togithub.com/just-the-docs/just-the-docs/pull/1243 [#​1259]: https://togithub.com/just-the-docs/just-the-docs/pull/1259 [#​1262]: https://togithub.com/just-the-docs/just-the-docs/pull/1262 ### [`v0.5.1`](https://togithub.com/just-the-docs/just-the-docs/blob/HEAD/CHANGELOG.md#Release-v051) [Compare Source](https://togithub.com/just-the-docs/just-the-docs/compare/v0.5.0...v0.5.1) 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](https://togithub.com/just-the-docs/just-the-docs/issues) or [start a discussion](https://togithub.com/just-the-docs/just-the-docs/discussions) for bug reports, feature requests, and any other feedback. Thanks for continuing to use Just the Docs! ##### Using Release `v0.5.1` Users 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: ```yml remote_theme: just-the-docs/just-the-docs@v0.5.1 ``` 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`: ```ruby 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. ##### Bugfixes - Fixed: disable copy code button in insecure contexts [@​rmoff] in [#​1226] - Fixed: context-based media feature not supported by Safari `<16.4` by \[[@​mattxwang](https://togithub.com/mattxwang)] in [#​1240] ##### Documentation - Added: document copy code button requiring secure context by [@​rmoff] in [#​1225] - Fixed: typo ("them" → "theme") in MIGRATION.md by \[[@​waldyrious](https://togithub.com/waldyrious)] in [#​1219] - Fixed: `font-weight` typo (Utilities > Typography) by \[[@​mattxwang](https://togithub.com/mattxwang)] in [#​1229] - Fixed: `just the docs` typo in migration guide by \[[@​mattxwang](https://togithub.com/mattxwang)] in [#​1230] ##### New Contributors - [@​rmoff] made their first contribution in [#​1225] [#​1219]: https://togithub.com/just-the-docs/just-the-docs/pull/1219 [#​1225]: https://togithub.com/just-the-docs/just-the-docs/pull/1225 [#​1226]: https://togithub.com/just-the-docs/just-the-docs/pull/1226 [#​1229]: https://togithub.com/just-the-docs/just-the-docs/pull/1229 [#​1230]: https://togithub.com/just-the-docs/just-the-docs/pull/1230 [#​1240]: https://togithub.com/just-the-docs/just-the-docs/pull/1240 [@​rmoff]: https://togithub.com/rmoff ### [`v0.5.0`](https://togithub.com/just-the-docs/just-the-docs/blob/HEAD/CHANGELOG.md#Release-v050) [Compare Source](https://togithub.com/just-the-docs/just-the-docs/compare/v0.4.2...v0.5.0) Hope your April is going well! This new release of Just the Docs is relatively minor. It has one **breaking change**: we've reverted the import order of `setup.scss` to be *before* color schemes. In addition, we include two requested fixes: color contrast issues with `::selection` and using Just the Docs with mermaid versions `>=10`. We've marked this as a minor version bump due to the breaking change. In the next section, we briefly outline what migration steps should be. Users who did not migrate to `v0.4.2` or who do not have a custom `setup.scss` are guaranteed no breaking changes. As always, we'd love your feedback. [Open an issue](https://togithub.com/just-the-docs/just-the-docs/issues) or [start a discussion](https://togithub.com/just-the-docs/just-the-docs/discussions) for bug reports, feature requests, and any other feedback. Thanks for continuing to use Just the Docs! ##### Migrating to `v0.5.0` **Migration**: users with a custom `setup.scss` cannot rely on variables or functions defined in `color_scheme`. This reverts to the behaviour in `v0.4.1`. Users should instead move those variables or functions to the `color_scheme` files themselves. For more, refer to the [migration guide](https://just-the-docs.com/MIGRATION/). ##### Using Release `v0.5.0` Users who have not pinned the theme version will be **automatically upgraded to `v0.5.0` the next time they build their site**. To use this release explicitly as a remote theme: ```yml remote_theme: just-the-docs/just-the-docs@v0.5.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`: ```ruby gem "just-the-docs", "0.5.0" ``` To use and pin a previous version of the theme, replace the `0.5.0` with the desired release tag. ##### Bugfixes - **Reverted (breaking)**: "Fix import order for `setup.scss` ([#​1184](https://togithub.com/just-the-docs/just-the-docs/issues/1184))" by \[[@​mattxwang](https://togithub.com/mattxwang)] in [#​1209] - Fixed: color contrast issues with `::selection` (reverting to browser defaults) \[[@​mattxwang](https://togithub.com/mattxwang)] in [#​1208] - Fixed: mermaid `v10`, bundle all mermaid code in component by \[[@​mattxwang](https://togithub.com/mattxwang)] in [#​1190] - Removed: unused images (`just-the-docs.png`, `search.svg`) by \[[@​mattxwang](https://togithub.com/mattxwang)] in [#​1107] - Removed: `CODE_OF_CONDUCT`, `docker-compose`, and `Dockerfile` files from site by \[[@​mattxwang](https://togithub.com/mattxwang)] in [#​1187] **Full Changelog**: [#​1107]: https://togithub.com/just-the-docs/just-the-docs/pull/1107 [#​1187]: https://togithub.com/just-the-docs/just-the-docs/pull/1187 [#​1190]: https://togithub.com/just-the-docs/just-the-docs/pull/1190 [#​1208]: https://togithub.com/just-the-docs/just-the-docs/pull/1208 [#​1209]: https://togithub.com/just-the-docs/just-the-docs/pull/1209 ### [`v0.4.2`](https://togithub.com/just-the-docs/just-the-docs/blob/HEAD/CHANGELOG.md#Release-v042) [Compare Source](https://togithub.com/just-the-docs/just-the-docs/compare/v0.4.1...v0.4.2) Hello! We're back again with another small release. Like `v0.4.1`, this release is a [semver patch](https://semver.org/): it only includes bugfixes, and is fully backwards-compatible. The big highlight of this theme is fixing our light scheme code highlighting contrast issues; this was one of our most-requested features! This change is fully backwards-compatible; users can [opt-in to our old highlighting theme](https://just-the-docs.com/docs/customization/#deprecated-legacy_light) by using `legacy_light` instead of `light`. As always, we'd love your feedback. [Open an issue](https://togithub.com/just-the-docs/just-the-docs/issues) or [start a discussion](https://togithub.com/just-the-docs/just-the-docs/discussions) for bug reports, feature requests, and any other feedback. Thanks for continuing to use Just the Docs! ##### Using Release `v0.4.2` Users who have not pinned the theme version will be **automatically upgraded to `v0.4.2` the next time they build their site**. To use this release explicitly as a remote theme: ```yml remote_theme: just-the-docs/just-the-docs@v0.4.2 ``` To use this RC explicitly as a gem-based theme, pin the version in your `Gemfile` and re-run `bundle install` or `bundle update just-the-docs`: ```ruby gem "just-the-docs", "0.4.2" ``` To use and pin a previous version of the theme, replace the `0.4.2` with the desired release tag. ##### Bugfixes - Fixed: light scheme code highlighting contrast issues; updated to use Atom's One Light colors, consolidate theme variables by \[[@​mattxwang](https://togithub.com/mattxwang)] in [#​1166] - Fixed: duplicate import of `color_schemes` by \[[@​mattxwang](https://togithub.com/mattxwang)] in [#​1173] - Fixed: import order for `setup.scss` by \[[@​mattxwang](https://togithub.com/mattxwang)] in [#​1184] - Removed: unused dark syntax themes by \[[@​mattxwang](https://togithub.com/mattxwang)] in [#​1192] ##### Documentation - Added: docs for using mermaid with AsciiDoc by \[[@​flyx](https://togithub.com/flyx)] in [#​1182] **Full Changelog**: [#​1166]: https://togithub.com/just-the-docs/just-the-docs/pull/1166 [#​1173]: https://togithub.com/just-the-docs/just-the-docs/pull/1173 [#​1182]: https://togithub.com/just-the-docs/just-the-docs/pull/1182 [#​1184]: https://togithub.com/just-the-docs/just-the-docs/pull/1184 [#​1192]: https://togithub.com/just-the-docs/just-the-docs/pull/1192 ### [`v0.4.1`](https://togithub.com/just-the-docs/just-the-docs/blob/HEAD/CHANGELOG.md#Release-v041) [Compare Source](https://togithub.com/just-the-docs/just-the-docs/compare/v0.4.0...v0.4.1) Hello! We hope you've been enjoying the new `v0.4.0`; we appreciate all the feedback we've gotten already! As promised, future releases will be small with simple steps to upgrade. This is one of them! `v0.4.1` is a [semver patch](https://semver.org/): it only includes bugfixes, and is fully backwards-compatible. As always, we'd love your feedback. [Open an issue](https://togithub.com/just-the-docs/just-the-docs/issues) or [start a discussion](https://togithub.com/just-the-docs/just-the-docs/discussions) for bug reports, feature requests, and any other feedback. Thanks for continuing to use Just the Docs! ##### Using Release `v0.4.1` Users who have not pinned the theme version will be **automatically upgraded to `v0.4.1` the next time they build their site**. To use this release explicitly as a remote theme: ```yml remote_theme: just-the-docs/just-the-docs@v0.4.1 ``` To use this RC explicitly as a gem-based theme, pin the version in your `Gemfile` and re-run `bundle install` or `bundle update just-the-docs`: ```ruby gem "just-the-docs", "0.4.1" ``` To use and pin a previous version of the theme, replace the `0.4.1` with the desired release tag. ##### Bugfixes - Fixed: allow later versions of `bundler` by \[[@​mattxwang](https://togithub.com/mattxwang)] in [#​1165] - Fixed: AsciiDoc code block styling by [@​flyx] in [#​1168] - Fixed: main content negative margin for viewports in `[$md, $nav-width + $content-width]` by [@​Dima-369] in [#​1177] - Removed: unused `OneDarkJekyll` files by \[[@​mattxwang](https://togithub.com/mattxwang)] in [#​1167] ##### Documentation - Fixed: re-add `jekyll-github-metadata` to docs site by \[[@​mattxwang](https://togithub.com/mattxwang)] in [#​1108] ##### New Contributors - [@​flyx] made their first contribution in [#​1168] - [@​Dima-369] made their first contribution in [#​1177] [#​1108]: https://togithub.com/just-the-docs/just-the-docs/pull/1108 [#​1165]: https://togithub.com/just-the-docs/just-the-docs/pull/1165 [#​1167]: https://togithub.com/just-the-docs/just-the-docs/pull/1167 [#​1168]: https://togithub.com/just-the-docs/just-the-docs/pull/1168 [#​1177]: https://togithub.com/just-the-docs/just-the-docs/pull/1177 [@​flyx]: https://togithub.com/flyx [@​Dima-369]: https://togithub.com/Dima-369 **Full Changelog**: ### [`v0.4.0`](https://togithub.com/just-the-docs/just-the-docs/blob/HEAD/CHANGELOG.md#Release-v040) [Compare Source](https://togithub.com/just-the-docs/just-the-docs/compare/v0.4.0.rc5...v0.4.0) We're so excited to release Just the Docs `v0.4.0`. This release has been almost a year in the making - after our new maintenance team has taken over the project, we've added two years of backlogged features and bugfixes to modernize the theme. This CHANGELOG will summarize some of the key changes, discuss migrations strategies, and outline broad future plans for this theme. ##### Brief Overview - Highlighted Changes `v0.4.0` contains many new features and bugfixes. We enumerate all of them in further sections in this changelog; however, we'd like to call out some of the most-requested changes: - better support for dark theme: dark highlighting, search input color - [callouts](https://just-the-docs.com/docs/ui-components/callouts/), a new design component to highlight content - [configuring mermaid.js](https://just-the-docs.com/docs/ui-components/code/#mermaid-diagram-code-blocks), a markdown-native diagram visualization library - [copy code button](https://just-the-docs.com/docs/ui-components/code/#copy-button) for code snippets - [external navigation links](https://just-the-docs.com/docs/navigation-structure/#external-navigation-links) - major improvements to nav generation efficiency and robustness - minor improvements to built-in accessibility (SVG icons, nav titles, skip to main content) - [modularized site components](https://just-the-docs.com/docs/customization/#custom-layouts-and-includes) (advanced feature) - [new custom includes](https://just-the-docs.com/docs/customization/#override-includes): table of contents heading, navigation panel footer, search placeholder, lunr search indices - bugfixes involving WEBrick and Ruby 3, Liquid processing in CSS comments, nested task lists, relative URLs, scroll navigation, corrupted search data from rake, breadcrumbs, and more! - more documentation for [custom includes](https://just-the-docs.com/docs/customization/#override-includes), this changelog, and the [migration guide](https://just-the-docs.com/MIGRATION/) *After usage instructions and the roadmap, we enumerate all changes from `v0.3.3`.* ##### Using Release `v0.4.0` Unlike pre-releases, `v0.4.0` is a new semver minor release for the theme. That means that users who have not pinned the theme version will be **automatically upgraded to `v0.4.0` the next time they build their site**. To use this release explicitly as a remote theme: ```yml remote_theme: just-the-docs/just-the-docs@v0.4.0 ``` To use this RC explicitly as a gem-based theme, pin the version in your `Gemfile` and re-run `bundle install` or `bundle update just-the-docs`: ```ruby gem "just-the-docs", "0.4.0" ``` If you would prefer to not upgrade, you can enforce that explicitly: 1. pin your gem version in your `Gemfile`, like so ```ruby gem "just-the-docs", "0.3.3" ``` 2. freeze the `remote_theme`, like so ```yml remote_theme: just-the-docs/just-the-docs@v0.3.3 ``` ##### Migration Guide and Strategies We've developed a new [migration guide](https://just-the-docs.com/MIGRATION/) for users to migrate from version `v0.3.3` to `v0.4.0`. It outlines major changes in project maintenance (e.g. new repository link, team) as well as breaking changes that may break your site (and potential solutions). We suggest that all users refer to the guide before manually upgrading their site. **For the vast majority of users, we do not anticipate that this will be a breaking change.** The major touch points are surrounding new includes, navigation (ordering, pages, and collections), the favicon, and a shift to relative URLs. However, users who heavily customize the theme (primarily by overriding includes) will likely have to make minor changes. Given the length of features added in this release, users may want to incrementally upgrade through the pre-releases. To follow this approach, read this changelog from `v0.4.0.rc1` to `v0.4.0.rc5`; this breaks down the release into small chunks, each of which should be easier to upgrade. `v0.4.0.rc5` is identical to this release. For support with migrating to `v0.4.0`, [open an issue](https://togithub.com/just-the-docs/just-the-docs/issues) or [start a discussion](https://togithub.com/just-the-docs/just-the-docs/discussions) and let us know! ##### Roadmap (What's Next?) Moving forward, we plan to release more frequently with smaller, bite-sized changes. This should make it easier for users to upgrade in the future! Broadly, many features are still on the radar. We anticipate the rest of `v0.4.x` to be bugfixes surrounding this new release. For version `v0.5`, our roadmap includes: - a theme toggle (light/dark mode), with automatic theme switching based on browser preferences - better GDPR compliance for analytics - multi-level/recursive navigation (unlimited hierarchy of child pages) In future versions, we also plan on: - adding better dark theme defaults - adding better internationalization support - exploring offline PDF generation - improving accessibility within the theme - improving search functionality - refactoring and improving the robustness of our codebase Have ideas for what's next, or want to get involved? [Open an issue](https://togithub.com/just-the-docs/just-the-docs/issues) or [start a discussion](https://togithub.com/just-the-docs/just-the-docs/discussions) and let us know! We're looking for more contributors and maintainers to help us develop the theme. ##### New Features - Added: Combination by \[[@​pdmosses](https://togithub.com/pdmosses)] in \[[#​578](https://togithub.com/just-the-docs/just-the-docs/issues/578)] - Added: dark highlighting in \[[#​463](https://togithub.com/just-the-docs/just-the-docs/issues/463)] - Added: pages and collections in \[[#​448](https://togithub.com/just-the-docs/just-the-docs/issues/448)] - Added: callouts in \[[#​466](https://togithub.com/just-the-docs/just-the-docs/issues/466)] - Fixed: breadcrumb behaviour … by \[[@​AdityaTiwari2102](https://togithub.com/AdityaTiwari2102)] in \[[#​477](https://togithub.com/just-the-docs/just-the-docs/issues/477)] - Fixed: prevent rake command corrupting search data in \[[#​495](https://togithub.com/just-the-docs/just-the-docs/issues/495)] (also listed below) - Fixed: nested lists in \[[#​496](https://togithub.com/just-the-docs/just-the-docs/issues/496)] - Fixed: set color for search input in \[[#​498](https://togithub.com/just-the-docs/just-the-docs/issues/498)] (also listed below) - Fixed: sites with no child pages (no PR) - Fixed: TOC/breadcrumbs for multiple collections in \[[#​494](https://togithub.com/just-the-docs/just-the-docs/issues/494)] - Added: collection configuration option `nav_fold` (no PR) - Fixed: indentation and color for folded collection navigation (no PR) - Fixed: scroll navigation to show the link to the current page in \[[#​639](https://togithub.com/just-the-docs/just-the-docs/issues/639)] - Fixed: Replace all uses of `absolute_url` by `relative_url`, by \[[@​svrooij](https://togithub.com/svrooij)] in \[[#​544](https://togithub.com/just-the-docs/just-the-docs/issues/544)] - Added: custom favicon `_includes` by \[[@​burner1024](https://togithub.com/burner1024)] in \[[#​364](https://togithub.com/just-the-docs/just-the-docs/issues/364)] - Added: set color for search input by \[[@​pdmosses](https://togithub.com/pdmosses)] in \[[#​498](https://togithub.com/just-the-docs/just-the-docs/issues/498)] - Added: search placeholder configuration by \[[@​mattxwang](https://togithub.com/mattxwang)] in \[[#​613](https://togithub.com/just-the-docs/just-the-docs/issues/613)] - Added: 'child_nav_order' front matter to be able to sort navigation pages in reverse by \[[@​jmertic](https://togithub.com/jmertic)] in \[[#​726](https://togithub.com/just-the-docs/just-the-docs/issues/726)] - Added: `nav_footer_custom` include by \[[@​nathanjessen](https://togithub.com/nathanjessen)] in \[[#​474](https://togithub.com/just-the-docs/just-the-docs/issues/474)] - Added: style fixes for jekyll-asciidoc by \[[@​alyssais](https://togithub.com/alyssais)] in \[[#​829](https://togithub.com/just-the-docs/just-the-docs/issues/829)] - Added: mermaid.js support by \[[@​nascosto](https://togithub.com/nascosto)] in \[[#​857](https://togithub.com/just-the-docs/just-the-docs/issues/857)] - Added: support for external navigation links by \[[@​SPGoding](https://togithub.com/SPGoding)] in \[[#​876](https://togithub.com/just-the-docs/just-the-docs/issues/876)] - Added: refactor `mermaid` config to use `mermaid_config.js` include, only require `mermaid.version` in `_config.yml` by \[[@​mattxwang](https://togithub.com/mattxwang)] in \[[#​909](https://togithub.com/just-the-docs/just-the-docs/issues/909)] - Added: accessible titles to nested page nav toggle by \[[@​JPrevost](https://togithub.com/JPrevost)] in \[[#​950](https://togithub.com/just-the-docs/just-the-docs/issues/950)] - Added: better title styling for AsciiDoc examples by \[[@​alyssais](https://togithub.com/alyssais)] in \[[#​944](https://togithub.com/just-the-docs/just-the-docs/issues/944)] - Added: docs for custom search placeholder by \[[@​mattxwang](https://togithub.com/mattxwang)] in \[[#​939](https://togithub.com/just-the-docs/just-the-docs/issues/939)] - Added: provide ability to skip to main content by \[[@​JPrevost](https://togithub.com/JPrevost)] in \[[#​949](https://togithub.com/just-the-docs/just-the-docs/issues/949)] - Added: styling for `
` by \[[@​mattxwang](https://togithub.com/mattxwang)] in \[[#​965](https://togithub.com/just-the-docs/just-the-docs/issues/965)] - Added: custom include for TOC heading by \[[@​pdmosses](https://togithub.com/pdmosses)] in \[[#​980](https://togithub.com/just-the-docs/just-the-docs/issues/980)] - Added: experimental nav optimization for simple cases by \[[@​pdmosses](https://togithub.com/pdmosses)] in \[[#​992](https://togithub.com/just-the-docs/just-the-docs/issues/992)] - Added: support multiple Google Analytics tracking IDs, document UA -> GA4 switch by \[[@​MichelleBlanchette](https://togithub.com/MichelleBlanchette)] in \[[#​1029](https://togithub.com/just-the-docs/just-the-docs/issues/1029)] - Added: copy code button to code snippets by \[[@​simonebortolin](https://togithub.com/simonebortolin)] in \[[#​945](https://togithub.com/just-the-docs/just-the-docs/issues/945)] - Added: restore simple configuration of `favicon.ico` via `site.static_files` by \[[@​pdmosses](https://togithub.com/pdmosses)] in \[[#​1095](https://togithub.com/just-the-docs/just-the-docs/issues/1095)] - Added: modularize site components by \[[@​mattxwang](https://togithub.com/mattxwang)] in \[[#​1058](https://togithub.com/just-the-docs/just-the-docs/issues/1058)] - Added: includes for custom `lunr` Liquid and JS code by \[[@​diablodale](https://togithub.com/diablodale)] in \[[#​1068](https://togithub.com/just-the-docs/just-the-docs/issues/1068)] - Added: new `_sass/custom/setup.scss` for variable definition by \[[@​mattxwang](https://togithub.com/mattxwang)] in \[[#​1135](https://togithub.com/just-the-docs/just-the-docs/issues/1135)] - Added: configuration key to load a local version of mermaid by \[[@​fabrik42](https://togithub.com/fabrik42)] in \[[#​1153](https://togithub.com/just-the-docs/just-the-docs/issues/1153)] ##### Bugfixes - Fixed: prepend `site.collections_dir` if exists by \[[@​alexsegura](https://togithub.com/alexsegura)] in \[[#​519](https://togithub.com/just-the-docs/just-the-docs/issues/519)] - Fixed: nested task lists ([#​517](https://togithub.com/just-the-docs/just-the-docs/issues/517)) by \[[@​pdmosses](https://togithub.com/pdmosses)] in \[[#​855](https://togithub.com/just-the-docs/just-the-docs/issues/855)] - Fixed: suppress Liquid processing in CSS comments by \[[@​pdmosses](https://togithub.com/pdmosses)] in \[[#​686](https://togithub.com/just-the-docs/just-the-docs/issues/686)] - Fixed: prevent rake command from corrupting search data by \[[@​pdmosses](https://togithub.com/pdmosses)] in \[[#​495](https://togithub.com/just-the-docs/just-the-docs/issues/495)] - Fixed: anchor heading links should be visible on focus by \[[@​jacobhq](https://togithub.com/jacobhq)] in \[[#​846](https://togithub.com/just-the-docs/just-the-docs/issues/846)] - Fixed: add `overflow-x: auto` to `figure.highlight` by \[[@​iridazzle](https://togithub.com/iridazzle)] in \[[#​727](https://togithub.com/just-the-docs/just-the-docs/issues/727)] - Fixed: add `overflow-wrap: word-break` to `body` by \[[@​iridazzle](https://togithub.com/iridazzle)] in \[[#​889](https://togithub.com/just-the-docs/just-the-docs/issues/889)] - Fixed: vertical alignment for consecutive labels by \[[@​Eisverygoodletter](https://togithub.com/Eisverygoodletter)] in \[[#​893](https://togithub.com/just-the-docs/just-the-docs/issues/893)] - Fixed: allow links to wrap by \[[@​pdmosses](https://togithub.com/pdmosses)] in \[[#​905](https://togithub.com/just-the-docs/just-the-docs/issues/905)] - Fixed: nav scroll feature and absolute/relative URLs by \[[@​pdmosses](https://togithub.com/pdmosses)] in \[[#​898](https://togithub.com/just-the-docs/just-the-docs/issues/898)] - Fixed: exclude `vendor/` in Jekyll config by \[[@​manuelhenke](https://togithub.com/manuelhenke)] in \[[#​941](https://togithub.com/just-the-docs/just-the-docs/issues/941)] - Fixed: improve build time of navigation panel by \[[@​pdmosses](https://togithub.com/pdmosses)] in \[[#​956](https://togithub.com/just-the-docs/just-the-docs/issues/956)] - Fixed: spacing issue when search is disabled by \[[@​henryiii](https://togithub.com/henryiii)] in \[[#​960](https://togithub.com/just-the-docs/just-the-docs/issues/960)] - Fixed: active grandchild link class by \[[@​pdmosses](https://togithub.com/pdmosses)] in \[[#​962](https://togithub.com/just-the-docs/just-the-docs/issues/962)] - Fixed: HTML validation issues (W3C validator) by \[[@​mattxwang](https://togithub.com/mattxwang)] in \[[#​964](https://togithub.com/just-the-docs/just-the-docs/issues/964)] - Fixed: link styling now uses `text-decoration` values by \[[@​mattxwang](https://togithub.com/mattxwang)] in \[[#​967](https://togithub.com/just-the-docs/just-the-docs/issues/967)] - Fixed: cleaning up Jekyll excludes by \[[@​pdmosses](https://togithub.com/pdmosses)] in \[[#​985](https://togithub.com/just-the-docs/just-the-docs/issues/985)] - Fixed: docs, narrow styling for code highlighting with line numbers by \[[@​pdmosses](https://togithub.com/pdmosses)] in \[[#​974](https://togithub.com/just-the-docs/just-the-docs/issues/974)] - Fixed: default syntax highlighting in custom color schemes \[[@​pdmosses](https://togithub.com/pdmosses)] in \[[#​986](https://togithub.com/just-the-docs/just-the-docs/issues/986)] - Fixed: incorrect disambiguation in generated TOCs by \[[@​pdmosses](https://togithub.com/pdmosses)] in \[[#​999](https://togithub.com/just-the-docs/just-the-docs/issues/999)] - Fixed: duplicated external links in collections by \[[@​pdmosses](https://togithub.com/pdmosses)] in \[[#​1001](https://togithub.com/just-the-docs/just-the-docs/issues/1001)] - Fixed: import order of `custom.scss`; puts at end by \[[@​deseo](https://togithub.com/deseo)] in \[[#​1010](https://togithub.com/just-the-docs/just-the-docs/issues/1010)] - Fixed: top-level active link styling by \[[@​pdmosses](https://togithub.com/pdmosses)] in \[[#​1015](https://togithub.com/just-the-docs/just-the-docs/issues/1015)] - Fixed: external links for sites with no pages by \[[@​pdmosses](https://togithub.com/pdmosses)] in \[[#​1021](https://togithub.com/just-the-docs/just-the-docs/issues/1021)] - Fixed: duplicate `title` if `jekyll-seo-tag` not in users's plugins by \[[@​Tom-Brouwer](https://togithub.com/Tom-Brouwer)] in \[[#​1040](https://togithub.com/just-the-docs/just-the-docs/issues/1040)] - Fixed: removes (duplicate) `favicon.html`, shifts content to `head_custom.html` by \[[@​mattxwang](https://togithub.com/mattxwang)] in \[[#​1027](https://togithub.com/just-the-docs/just-the-docs/issues/1027)] - Fixed: add `reversed`, deprecate `desc` for nav `child_nav_order` by \[[@​jmertic](https://togithub.com/jmertic)] in \[[#​1061](https://togithub.com/just-the-docs/just-the-docs/issues/1061)] - Fixed: `child.child_nav_order` to `node.child_nav_order` by \[[@​mattxwang](https://togithub.com/mattxwang)] in \[[#​1065](https://togithub.com/just-the-docs/just-the-docs/issues/1065)] - Fixed: remove all uses of `/` as SASS division by \[[@​mattxwang](https://togithub.com/mattxwang)] in \[[#​1074](https://togithub.com/just-the-docs/just-the-docs/issues/1074)] - note: this was originally merged as \[[#​1074](https://togithub.com/just-the-docs/just-the-docs/issues/1074)] with a bug; it was reverted in \[[#​1076](https://togithub.com/just-the-docs/just-the-docs/issues/1076)], and then reimplemented in \[[#​1077](https://togithub.com/just-the-docs/just-the-docs/issues/1077)] - Fixed: skip nav collection generation when site has no pages by \[[@​pdmosses](https://togithub.com/pdmosses)] in \[[#​1092](https://togithub.com/just-the-docs/just-the-docs/issues/1092)] - Fixed: standardize SCSS with `declaration-block-no-redundant-longhand-properties` by \[[@​simonebortolin](https://togithub.com/simonebortolin)] in \[[#​1102](https://togithub.com/just-the-docs/just-the-docs/issues/1102)] - Fixed: incorrect `padding` property value pair in `labels.scss` by \[[@​SConaway](https://togithub.com/SConaway)] in \[[#​1104](https://togithub.com/just-the-docs/just-the-docs/issues/1104)] - Fixed: various bugs with copy code button by \[[@​simonebortolin](https://togithub.com/simonebortolin)] in \[[#​1096](https://togithub.com/just-the-docs/just-the-docs/issues/1096)] - Fixed: replace inline styling for `` icons by \[[@​captn3m0](https://togithub.com/captn3m0)] in \[[#​1110](https://togithub.com/just-the-docs/just-the-docs/issues/1110)] - Fixed: incorrect `padding` property value pair in `search.scss` by \[[@​kevinlin1](https://togithub.com/kevinlin1)] in \[[#​1123](https://togithub.com/just-the-docs/just-the-docs/issues/1123)] - Fixed: minor spacing and comment nits by \[[@​EricFromCanada](https://togithub.com/EricFromCanada)] in \[[#​1128](https://togithub.com/just-the-docs/just-the-docs/issues/1128)] - Fixed: exclude images from being bundled with gem by \[[@​m-r-mccormick](https://togithub.com/m-r-mccormick)] in \[[#​1142](https://togithub.com/just-the-docs/just-the-docs/issues/1142)] - Fixed: dark theme code block background, line number colors by \[[@​m-r-mccormick](https://togithub.com/m-r-mccormick)] in \[[#​1124](https://togithub.com/just-the-docs/just-the-docs/issues/1124)] - Fixed: copy code button interaction with kramdown line numbers by \[[@​mattxwang](https://togithub.com/mattxwang)] in \[[#​1143](https://togithub.com/just-the-docs/just-the-docs/issues/1143)] ##### Maintenance - Added: VScode devcontainer by \[[@​max06](https://togithub.com/max06)] in \[[#​783](https://togithub.com/just-the-docs/just-the-docs/issues/783)] - Added: `webrick` to `Gemfile` by \[[@​mattxwang](https://togithub.com/mattxwang)] in \[[#​799](https://togithub.com/just-the-docs/just-the-docs/issues/799)] - Added: 'This site is powered by Netlify.' to the footer by \[[@​mattxwang](https://togithub.com/mattxwang)] in \[[#​797](https://togithub.com/just-the-docs/just-the-docs/issues/797)] - Updated: new repo path by \[[@​pmarsceill](https://togithub.com/pmarsceill)] in \[[#​775](https://togithub.com/just-the-docs/just-the-docs/issues/775)] - Updated: rename `master` -> `main` by \[[@​pmarsceill](https://togithub.com/pmarsceill)] in \[[#​776](https://togithub.com/just-the-docs/just-the-docs/issues/776)] - Updated: README by \[[@​pmarsceill](https://togithub.com/pmarsceill)] in \[[#​777](https://togithub.com/just-the-docs/just-the-docs/issues/777)] - Updated: Code of Conduct to Contributor Covenant v2.1 by \[[@​mattxwang](https://togithub.com/mattxwang)] in \[[#​790](https://togithub.com/just-the-docs/just-the-docs/issues/790)] - Updated: CI files, Ruby & Node Versions by \[[@​mattxwang](https://togithub.com/mattxwang)] in \[[#​820](https://togithub.com/just-the-docs/just-the-docs/issues/820)] - Updated: Stylelint to v14, extend SCSS plugins, remove primer-\* configs, resolve issues by \[[@​mattxwang](https://togithub.com/mattxwang)] in \[[#​821](https://togithub.com/just-the-docs/just-the-docs/issues/821)] - Deleted: unused script directory by \[[@​mattxwang](https://togithub.com/mattxwang)] in \[[#​937](https://togithub.com/just-the-docs/just-the-docs/issues/937)] - Vendor: update `jekyll-anchor-headings`, `lunr.js` by \[[@​mattxwang](https://togithub.com/mattxwang)] in \[[#​1071](https://togithub.com/just-the-docs/just-the-docs/issues/1071)] ##### Documentation - Added: docs on how to break an `ol` by \[[@​pdmosses](https://togithub.com/pdmosses)] in \[[#​856](https://togithub.com/just-the-docs/just-the-docs/issues/856)] - Added: docs for custom includes by \[[@​nathanjessen](https://togithub.com/nathanjessen)] in \[[#​806](https://togithub.com/just-the-docs/just-the-docs/issues/806)] - Added: document caveat about variable dependencies by \[[@​waldyrious](https://togithub.com/waldyrious)] in \[[#​555](https://togithub.com/just-the-docs/just-the-docs/issues/555)] - Added: docs on how to use `custom_head` to add a custom favicon by \[[@​UnclassedPenguin](https://togithub.com/UnclassedPenguin)] in \[[#​814](https://togithub.com/just-the-docs/just-the-docs/issues/814)] - Added: docs load mermaid.js by default by \[[@​mattxwang](https://togithub.com/mattxwang)] in \[[#​935](https://togithub.com/just-the-docs/just-the-docs/issues/935)] - Added: warning about mandatory `_`-prefix for collections by \[[@​max06](https://togithub.com/max06)] in \[[#​1091](https://togithub.com/just-the-docs/just-the-docs/issues/1091)] - Added: migration guide by \[[@​pdmosses](https://togithub.com/pdmosses)] in \[[#​1059](https://togithub.com/just-the-docs/just-the-docs/issues/1059)] - Added: label new features introduced in `v0.4` by \[[@​mattxwang](https://togithub.com/mattxwang)] in \[[#​1138](https://togithub.com/just-the-docs/just-the-docs/issues/1138)] - Fixed: `ol` on `index.md` by \[[@​pmarsceill](https://togithub.com/pmarsceill)] in \[[#​778](https://togithub.com/just-the-docs/just-the-docs/issues/778)] - Fixed: image link in Markdown kitchen sink by \[[@​JeffGuKang](https://togithub.com/JeffGuKang)] in \[[#​221](https://togithub.com/just-the-docs/just-the-docs/issues/221)] - Fixed: images in Markdown kitchen sink by \[[@​dougaitken](https://togithub.com/dougaitken)] in \[[#​782](https://togithub.com/just-the-docs/just-the-docs/issues/782)] - Fixed: clearer label of link to Jekyll quickstart by \[[@​waldyrious](https://togithub.com/waldyrious)] in \[[#​549](https://togithub.com/just-the-docs/just-the-docs/issues/549)] - Fixed: remove extra spaces in component docs by \[[@​MichelleBlanchette](https://togithub.com/MichelleBlanchette)] in \[[#​554](https://togithub.com/just-the-docs/just-the-docs/issues/554)] - Fixed: double "your" typo in `index.md` by \[[@​sehilyi](https://togithub.com/sehilyi)] in \[[#​499](https://togithub.com/just-the-docs/just-the-docs/issues/499)] - Fixed: "you" -> "your" typo in `index.md` by \[[@​nathanjessen](https://togithub.com/nathanjessen)] in \[[#​473](https://togithub.com/just-the-docs/just-the-docs/issues/473)] - Fixed: spacing in toc example by \[[@​henryiii](https://togithub.com/henryiii)] in \[[#​835](https://togithub.com/just-the-docs/just-the-docs/issues/835)] - Fixed: typo in `README` on `_config.yml` by \[[@​ivanskodje](https://togithub.com/ivanskodje)] in \[[#​891](https://togithub.com/just-the-docs/just-the-docs/issues/891)] - Fixed: missing code fence in navigation structure docs by \[[@​mattxwang](https://togithub.com/mattxwang)] in \[[#​906](https://togithub.com/just-the-docs/just-the-docs/issues/906)] - Fixed: table of contents on search docs by \[[@​robinpokorny](https://togithub.com/robinpokorny)] in \[[#​940](https://togithub.com/just-the-docs/just-the-docs/issues/940)] - Fixed: broken docs link (custom footer) by \[[@​olgarithms](https://togithub.com/olgarithms)] in \[[#​951](https://togithub.com/just-the-docs/just-the-docs/issues/951)] - Fixed: clarify version docs by \[[@​pdmosses](https://togithub.com/pdmosses)] in \[[#​955](https://togithub.com/just-the-docs/just-the-docs/issues/955)] - Fixed: typo in changelog links \[[@​koppor](https://togithub.com/koppor)] in \[[#​1000](https://togithub.com/just-the-docs/just-the-docs/issues/1000)] - Fixed: two bugs in "Customization" (custom favicon, new annotation) by \[[@​mattxwang](https://togithub.com/mattxwang)] in \[[#​1090](https://togithub.com/just-the-docs/just-the-docs/issues/1090)] - Fixed: "View Typography Utilities" link by \[[@​agabrys](https://togithub.com/agabrys)] in \[[#​1130](https://togithub.com/just-the-docs/just-the-docs/issues/1130)] - Fixed: broken relative page links by \[[@​mattxwang](https://togithub.com/mattxwang)] in \[[#​1106](https://togithub.com/just-the-docs/just-the-docs/issues/1106)] - Fixed: clarify steps to add custom `lunr` index code by \[[@​diablodale](https://togithub.com/diablodale)] in \[[#​1139](https://togithub.com/just-the-docs/just-the-docs/issues/1139)] - Updated: homepage (focus: new features, conciseness, deduplication) by \[[@​pdmosses](https://togithub.com/pdmosses)] in \[[#​1018](https://togithub.com/just-the-docs/just-the-docs/issues/1018)] - Updated: README (focus: new features, conciseness, deduplication) by \[[@​pdmosses](https://togithub.com/pdmosses)] in \[[#​1019](https://togithub.com/just-the-docs/just-the-docs/issues/1019)] - Updated: `README` demo video by \[[@​codewithfan](https://togithub.com/codewithfan)] in \[[#​1097](https://togithub.com/just-the-docs/just-the-docs/issues/1097)] ##### New Contributors - \[[@​AdityaTiwari2102](https://togithub.com/AdityaTiwari2102)] made their first contribution in \[[#​477](https://togithub.com/just-the-docs/just-the-docs/issues/477)] - \[[@​svrooij](https://togithub.com/svrooij)] made their first contribution in \[[#​544](https://togithub.com/just-the-docs/just-the-docs/issues/544)] - \[[@​alexsegura](https://togithub.com/alexsegura)] made their first contribution in \[[#​519](https://togithub.com/just-the-docs/just-the-docs/issues/519)] - \[[@​burner1024](https://togithub.com/burner1024)] made their first contribution in \[[#​364](https://togithub.com/just-the-docs/just-the-docs/issues/364)] - \[[@​JeffGuKang](https://togithub.com/JeffGuKang)] made their first contribution in \[[#​221](https://togithub.com/just-the-docs/just-the-docs/issues/221)] - \[[@​dougaitken](https://togithub.com/dougaitken)] made their first contribution in \[[#​782](https://togithub.com/just-the-docs/just-the-docs/issues/782)] - \[[@​max06](https://togithub.com/max06)] made their first contribution in \[[#​783](https://togithub.com/just-the-docs/just-the-docs/issues/783)] - \[[@​sehilyi](https://togithub.com/sehilyi)] made their first contribution in \[[#​499](https://togithub.com/just-the-docs/just-the-docs/issues/499)] - \[[@​nathanjessen](https://togithub.com/nathanjessen)] made their first contribution in \[[#​473](https://togithub.com/just-the-docs/just-the-docs/issues/473)] - \[[@​waldyrious](https://togithub.com/waldyrious)] made their first contribution in \[[#​549](https://togithub.com/just-the-docs/just-the-docs/issues/549)] - \[[@​MichelleBlanchette](https://togithub.com/MichelleBlanchette)] made their first contribution in \[[#​554](https://togithub.com/just-the-docs/just-the-docs/issues/554)] - \[[@​henryiii](https://togithub.com/henryiii)] made their first contribution in \[[#​835](https://togithub.com/just-the-docs/just-the-docs/issues/835)] - \[[@​jmertic](https://togithub.com/jmertic)] made their first contribution in \[[#​726](https://togithub.com/just-the-docs/just-the-docs/issues/726)] - \[[@​jacobhq](https://togithub.com/jacobhq)] made their first contribution in \[[#​846](https://togithub.com/just-the-docs/just-the-docs/issues/846)] - \[[@​UnclassedPenguin](https://togithub.com/UnclassedPenguin)] made their first contribution in \[[#​814](https://togithub.com/just-the-docs/just-the-docs/issues/814)] - \[[@​alyssais](https://togithub.com/alyssais)] made their first contribution in \[[#​829](https://togithub.com/just-the-docs/just-the-docs/issues/829)] - \[[@​nascosto](https://togithub.com/nascosto)] made their first contribution in \[[#​857](https://togithub.com/just-the-docs/just-the-docs/issues/857)] - \[[@​SPGoding](https://togithub.com/SPGoding)] made their first contribution in \[[#​876](https://togithub.com/just-the-docs/just-the-docs/issues/876)] - \[[@​iridazzle](https://togithub.com/iridazzle)] made their first contribution in \[[#​727](https://togithub.com/just-the-docs/just-the-docs/issues/727)] - \[[@​ivanskodje](https://togithub.com/ivanskodje)] made their first contribution in \[[#​891](https://togithub.com/just-the-docs/just-the-docs/issues/891)] - \[[@​Eisverygoodletter](https://togithub.com/Eisverygoodletter)] made their first contribution in \[[#​893](https://togithub.com/just-the-docs/just-the-docs/issues/893)] - \[[@​robinpokorny](https://togithub.com/robinpokorny)] made their first contribution in \[[#​940](https://togithub.com/just-the-docs/just-the-docs/issues/940)] - \[[@​olgarithms](https://togithub.com/olgarithms)] made their first contribution in \[[#​951](https://togithub.com/just-the-docs/just-the-docs/issues/951)] - \[[@​manuelhenke](https://togithub.com/manuelhenke)] made their first contribution in \[[#​941](https://togithub.com/just-the-docs/just-the-docs/issues/941)] - \[[@​JPrevost](https://togithub.com/JPrevost)] made their first contribution in \[[#​950](https://togithub.com/just-the-docs/just-the-docs/issues/950)] - \[[@​koppor](https://togithub.com/koppor)] made their first contribution in \[[#​1000](https://togithub.com/just-the-docs/just-the-docs/issues/1000)] - \[[@​deseo](https://togithub.com/deseo)] made their first contribution in \[[#​1010](https://togithub.com/just-the-docs/just-the-docs/issues/1010)] - \[[@​Tom-Brouwer](https://togithub.com/Tom-Brouwer)] made their first contribution in \[[#​1040](https://togithub.com/just-the-docs/just-the-docs/issues/1040)] - \[[@​simonebortolin](https://togithub.com/simonebortolin)] made their first contribution in \[[#​945](https://togithub.com/just-the-docs/just-the-docs/issues/945)] - \[[@​SConaway](https://togithub.com/SConaway)] made their first contribution in \[[#​1104](https://togithub.com/just-the-docs/just-the-docs/issues/1104)] - \[[@​captn3m0](https://togithub.com/captn3m0)] made their first contribution in \[[#​1110](https://togithub.com/just-the-docs/just-the-docs/issues/1110)] - \[[@​kevinlin1](https://togithub.com/kevinlin1)] made their first contribution in \[[#​1123](https://togithub.com/just-the-docs/just-the-docs/issues/1123)] - \[[@​codewithfan](https://togithub.com/codewithfan)] made their first contribution in \[[#​1097](https://togithub.com/just-the-docs/just-the-docs/issues/1097)] - \[[@​agabrys](https://togithub.com/agabrys)] made their first contribution in \[[#​1130](https://togithub.com/just-the-docs/just-the-docs/issues/1130)] - \[[@​diablodale](https://togithub.com/diablodale)] made their first contribution in \[[#​1068](https://togithub.com/just-the-docs/just-the-docs/issues/1068)] - \[[@​m-r-mccormick](https://togithub.com/m-r-mccormick)] made their first contribution in \[[#​1142](https://togithub.com/just-the-docs/just-the-docs/issues/1142)] - \[[@​fabrik42](https://togithub.com/fabrik42)] made their first contribution in \[[#​1153](https://togithub.com/just-the-docs/just-the-docs/issues/1153)] ### [`v0.4.0.rc5`](https://togithub.com/just-the-docs/just-the-docs/blob/HEAD/CHANGELOG.md#Pre-release-v040rc5) [Compare Source](https://togithub.com/just-the-docs/just-the-docs/compare/v0.4.0.rc4...v0.4.0.rc5) Hi everyone, we're so excited to finally release `v0.4.0`! For posterity's sake, we're going to release `v0.4.0.rc5` and then immediately re-release it as `v0.4.0`; this should make it more clear what changes were introduced in the lead up to the minor release. This RC does not introduce any major user-facing features. It adds more customizability for custom SCSS variables (fixing a bug with callout introduction order), `lunr` indexing, and loading `mermaid` locally. In addition, it fixes bugs introduced in `.rc4`: incorrect CSS, inconsistencies with code block backgrounds in dark theme, and the copy code button. It also adds a migration guide for users coming from `v0.3.3`. ##### Trying out pre-release `v0.4.0.rc5` Simlar to the prior release, `v0.4.0.rc5` is a **release candidate** for the theme (i.e., a pre-release) with release `v0.4.0` following immediately after. While we don't anticipate many users using this RC, it is still possible to opt-in. To use this RC explicitly as a remote theme: ```yml remote_theme: just-the-docs/just-the-docs@v0.4.0.rc5 ``` To use this RC explicitly as a gem-based theme, pin the version in your `Gemfile` and re-run `bundle install` or `bundle update just-the-docs`: ```ruby gem "just-the-docs", "0.4.0.rc5" ``` By default, **users will not be upgraded to `0.4.0.rc5`**. To enforce that explicitly, either: 1. pin your gem version in your `Gemfile`, like so ```ruby gem "just-the-docs", "0.3.3" ``` 2. freeze the `remote_theme`, like so ```yml remote_theme: just-the-docs/just-the-docs@v0.3.3 ``` ##### New Features - Added: includes for custom `lunr` Liquid and JS code by [@​diablodale] in [#​1068] - Added: new `_sass/custom/setup.scss` for variable definition by \[[@​mattxwang](https://togithub.com/mattxwang)] in [#​1135] - Added: configuration key to load a local version of mermaid by [@​fabrik42] in [#​1153] ##### Bugfixes and Maintenance - Fixed: incorrect `padding` property value pair in `search.scss` by [@​kevinlin1] in [#​1123] - Fixed: minor spacing and comment nits by [@​EricFromCanada] in [#​1128] - Fixed: exclude images from being bundled with gem by [@​m-r-mccormick] in [#​1142] - Fixed: dark theme code block background, line number colors by [@​m-r-mccormick] in [#​1124] - Fixed: copy code button interaction with kramdown line numbers by \[[@​mattxwang](https://togithub.com/mattxwang)] in [#​1143] ##### Docs - Docs: add a migration guide by \[[@​pdmosses](https://togithub.com/pdmosses)] in [#​1059] - Docs: update `README` demo video by [@​codewithfan] in [#​1097] - Docs: update "View Typography Utilities" link by [@​agabrys] in [#​1130] - Docs: fix broken relative page links by \[[@​mattxwang](https://togithub.com/mattxwang)] in [#​1106] - Docs: clarify steps to add custom `lunr` index code by [@​diablodale] in [#​1139] - Docs: label new features introduced in `v0.4` by \[[@​mattxwang](https://togithub.com/mattxwang)] in [#​1138] ##### New Contributors - [@​kevinlin1] made their first contribution in [#​1123] - [@​codewithfan] made their first contribution in [#​1097] - [@​agabrys] made their first contribution in [#​1130] - [@​diablodale] made their first contribution in [#​1068] - [@​m-r-mccormick] made their first contribution in [#​1142] - [@​fabrik42] made their first contribution in [#​1153] [#​1059]: https://togithub.com/just-the-docs/just-the-docs/pull/1059 [#​1068]: https://togithub.com/just-the-docs/just-the-docs/pull/1068 [#​1097]: https://togithub.com/just-the-docs/just-the-docs/pull/1097 [#​1106]: https://togithub.com/just-the-docs/just-the-docs/pull/1106 [#​1123]: https://togithub.com/just-the-docs/just-the-docs/pull/1123 [#​1124]: https://togithub.com/just-the-docs/just-the-docs/pull/1124 [#​1128]: https://togithub.com/just-the-docs/just-the-docs/pull/1128 [#​1130]: https://togithub.com/just-the-docs/just-the-docs/pull/1130 [#​1135]: https://togithub.com/just-the-docs/just-the-docs/pull/1135 [#​1138]: https://togithub.com/just-the-docs/just-the-docs/pull/1138 [#​1139]: https://togithub.com/just-the-docs/just-the-docs/pull/1139 [#​1142]: https://togithub.com/just-the-docs/just-the-docs/pull/1142 [#​1143]: https://togithub.com/just-the-docs/just-the-docs/pull/1143 [#​1153]: https://togithub.com/just-the-docs/just-the-docs/pull/1153 [@​agabrys]: https://togithub.com/agabrys [@​codewithfan]: https://togithub.com/codewithfan [@​diablodale]: https://togithub.com/diablodale [@​fabrik42]: https://togithub.com/fabrik42 [@​kevinlin1]: https://togithub.com/kevinlin1 [@​EricFromCanada]: https://togithub.com/EricFromCanada [@​m-r-mccormick]: https://togithub.com/m-r-mccormick
--- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/UCL-ARC/python-template). Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Patrick Roddy --- docs/Gemfile | 2 +- docs/Gemfile.lock | 19 ++++++++----------- 2 files changed, 9 insertions(+), 12 deletions(-) diff --git a/docs/Gemfile b/docs/Gemfile index 54cc5954..d640200d 100644 --- a/docs/Gemfile +++ b/docs/Gemfile @@ -3,5 +3,5 @@ source 'https://rubygems.org' gem "jekyll", "~> 4.3" # installed by `gem jekyll` # gem "webrick" # required when using Ruby >= 3 and Jekyll <= 4.2.2 -gem "just-the-docs", "0.4.0.rc4" # currently the latest pre-release +gem "just-the-docs", "0.5.4" # currently the latest pre-release # gem "just-the-docs" # the latest release - currently 0.3.3 diff --git a/docs/Gemfile.lock b/docs/Gemfile.lock index 5bc2b347..5e93cce9 100644 --- a/docs/Gemfile.lock +++ b/docs/Gemfile.lock @@ -4,7 +4,7 @@ GEM addressable (2.8.4) public_suffix (>= 2.0.2, < 6.0) colorator (1.1.0) - concurrent-ruby (1.1.10) + concurrent-ruby (1.2.2) em-websocket (0.5.3) eventmachine (>= 0.12.9) http_parser.rb (~> 0) @@ -12,7 +12,7 @@ GEM ffi (1.15.5) forwardable-extended (2.6.0) http_parser.rb (0.8.0) - i18n (1.12.0) + i18n (1.14.1) concurrent-ruby (~> 1.0) jekyll (4.3.2) addressable (~> 2.4) @@ -36,7 +36,7 @@ GEM jekyll (>= 3.8, < 5.0) jekyll-watch (2.2.1) listen (~> 3.0) - just-the-docs (0.4.0.rc4) + just-the-docs (0.5.4) jekyll (>= 3.8.5) jekyll-seo-tag (>= 2.0) rake (>= 12.3.1) @@ -45,7 +45,7 @@ GEM kramdown-parser-gfm (1.1.0) kramdown (~> 2.0) liquid (4.0.4) - listen (3.7.1) + listen (3.8.0) rb-fsevent (~> 0.10, >= 0.10.3) rb-inotify (~> 0.9, >= 0.9.10) mercenary (0.4.0) @@ -57,25 +57,22 @@ GEM rb-inotify (0.10.1) ffi (~> 1.0) rexml (3.2.5) - rouge (4.0.1) + rouge (4.1.2) safe_yaml (1.0.5) sassc (2.4.0) ffi (~> 1.9) terminal-table (3.0.2) unicode-display_width (>= 1.1.1, < 3) - unicode-display_width (2.3.0) - webrick (1.7.0) + unicode-display_width (2.4.2) + webrick (1.8.1) PLATFORMS - arm64-darwin-20 - arm64-darwin-21 arm64-darwin-22 - x86_64-darwin-19 x86_64-linux DEPENDENCIES jekyll (~> 4.3) - just-the-docs (= 0.4.0.rc4) + just-the-docs (= 0.5.4) BUNDLED WITH 2.3.9