From 3974fb87e20ed534ff98992fcc015b1112342736 Mon Sep 17 00:00:00 2001 From: Matt Wang Date: Mon, 12 Aug 2024 12:21:46 -0700 Subject: [PATCH] Prep: 0.9.0 --- CHANGELOG.md | 45 +++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 43 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 0b9ddb5..e4f998c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -17,17 +17,58 @@ This website is built from the `HEAD` of the `main` branch of the theme reposito Code changes to `main` that are *not* in the latest release: -- Added: `nav_enabled` site, layout, and page-level variable to selectively show or hide the side/mobile menu by [@kevinlin1] in [#1441]. The minimal layout was reimplemented using this feature, and now has support for the site-wide search bar and auxiliary links. +- N/A + +Docs changes made since the latest release: + +- N/A + +## 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.8.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.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`: + +```ruby +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] -Docs changes made since the latest release: +### 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] + [@bobvandevijver]: https://github.com/bobvandevijver +[#1441]: https://github.com/just-the-docs/just-the-docs/pull/1441 [#1468]: https://github.com/just-the-docs/just-the-docs/pull/1468 [#1495]: https://github.com/just-the-docs/just-the-docs/pull/1495 [#1508]: https://github.com/just-the-docs/just-the-docs/pull/1508