CHANGELOG.md in just-the-docs-0.9.0 vs CHANGELOG.md in just-the-docs-0.10.0

- old
+ new

@@ -21,19 +21,58 @@ Docs changes made since the latest release: - N/A +## 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: + +```yml +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`: + +```ruby +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] + +[#1431]: https://github.com/just-the-docs/just-the-docs/pull/1431 +[#1440]: https://github.com/just-the-docs/just-the-docs/pull/1440 +[#1530]: https://github.com/just-the-docs/just-the-docs/pull/1530 +[#1530]: https://github.com/just-the-docs/just-the-docs/pull/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.8.0` the next time they build their site**. +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: ```yml remote_theme: just-the-docs/just-the-docs@v0.9.0 @@ -599,10 +638,10 @@ - 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) +- 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!