CHANGELOG.md in just-the-docs-0.6.2 vs CHANGELOG.md in just-the-docs-0.7.0

- old
+ new

@@ -17,10 +17,79 @@ Code changes to `main` that are *not* in the latest release: - N/A +## 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](https://just-the-docs.com/MIGRATION/). + +### 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: + +```yml +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`: + +```ruby +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] + +[@CarbonNeuron]: https://github.com/CarbonNeuron +[@thapasusheel]: https://github.com/thapasusheel + +[#1356]: https://github.com/just-the-docs/just-the-docs/pull/1356 +[#1358]: https://github.com/just-the-docs/just-the-docs/pull/1358 +[#1360]: https://github.com/just-the-docs/just-the-docs/pull/1360 +[#1366]: https://github.com/just-the-docs/just-the-docs/pull/1366 +[#1367]: https://github.com/just-the-docs/just-the-docs/pull/1367 +[#1368]: https://github.com/just-the-docs/just-the-docs/pull/1368 +[#1373]: https://github.com/just-the-docs/just-the-docs/pull/1373 +[#1377]: https://github.com/just-the-docs/just-the-docs/pull/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 @@ -642,11 +711,11 @@ 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. +Similar 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 @@ -743,11 +812,11 @@ Have any questions, thoughts, or concerns? We'd love to hear from you! Please [open an issue](https://github.com/just-the-docs/just-the-docs/issues) or [start a discussion](https://github.com/just-the-docs/just-the-docs/discussions) and let us know! ### Trying out pre-release `v0.4.0.rc4` -Simlar to the prior release, `v0.4.0.rc4` is a **release candidate** for the theme (i.e., a pre-release) with release `v0.4.0` coming soon. We want your help in testing the changes! As of now, the gem on RubyGems and the repository are updated to `v0.4.0.rc4`. +Similar to the prior release, `v0.4.0.rc4` is a **release candidate** for the theme (i.e., a pre-release) with release `v0.4.0` coming soon. We want your help in testing the changes! As of now, the gem on RubyGems and the repository are updated to `v0.4.0.rc4`. To use this RC explicitly as a remote theme: ```yml remote_theme: just-the-docs/just-the-docs@v0.4.0.rc4 @@ -864,11 +933,11 @@ As soon as we get stable test results from major downstream users, we'll push out a `v0.4.0` ASAP - closing out almost 2 years of backlogged work! ### Trying out pre-release `v0.4.0.rc3` -Simlar to the prior release, `v0.4.0.rc3` is a **release candidate** for the theme (i.e., a pre-release) with release `v0.4.0` coming soon. We want your help in testing the changes! As of now, the gem on RubyGems and the repository are updated to `v0.4.0.rc3`. +Similar to the prior release, `v0.4.0.rc3` is a **release candidate** for the theme (i.e., a pre-release) with release `v0.4.0` coming soon. We want your help in testing the changes! As of now, the gem on RubyGems and the repository are updated to `v0.4.0.rc3`. To use this RC explicitly as a remote theme: ```yml remote_theme: just-the-docs/just-the-docs@v0.4.0.rc3 @@ -940,11 +1009,11 @@ The intention of this release candidate is to gather even more feedback on a potential `v0.4.0`. As it stands, we have not encountered any breaking changes with early adopters of `v0.4.0.rc1`. If you encounter any - for either of our pre-releases - please let us know! ### Trying out pre-release `v0.4.0.rc2` -Simlar to the prior release, `v0.4.0.rc2` is a **release candidate** for the theme (i.e., a pre-release) with release `v0.4.0` coming soon. We want your help in testing the changes! As of now, the gem on RubyGems and the repository are updated to `v0.4.0.rc2`. +Similar to the prior release, `v0.4.0.rc2` is a **release candidate** for the theme (i.e., a pre-release) with release `v0.4.0` coming soon. We want your help in testing the changes! As of now, the gem on RubyGems and the repository are updated to `v0.4.0.rc2`. To use this RC explicitly as a remote theme: ```yml remote_theme: just-the-docs/just-the-docs@v0.4.0.rc2 @@ -1028,11 +1097,11 @@ We want your feedback! Are these changes helpful? Are our docs easy to understand? Should new features like `mermaid` be opt-in or opt-out? Please [open an issue](https://github.com/just-the-docs/just-the-docs/issues) or [start a discussion](https://github.com/just-the-docs/just-the-docs/discussions) and let us know! ### Trying out pre-release `v0.4.0.rc1` -Due to the massive scope of these changes, we're making `v0.4.0.rc1` avaialble as a **release candidate** for the theme (i.e., a pre-release) with release `v0.4.0` coming soon. We want your help in testing the changes! As of now, the gem on RubyGems and the repository are updated to `v0.4.0.rc1`. +Due to the massive scope of these changes, we're making `v0.4.0.rc1` available as a **release candidate** for the theme (i.e., a pre-release) with release `v0.4.0` coming soon. We want your help in testing the changes! As of now, the gem on RubyGems and the repository are updated to `v0.4.0.rc1`. To use this RC explicitly as a remote theme: ```yml remote_theme: just-the-docs/just-the-docs@v0.4.0.rc1 @@ -1540,10 +1609,10 @@ - Option to hide TOC on parent pages if turned off in page's YAML front matter #30 - Option to suppress an item from being indexed by search if present in page's YAML front matter #32 ## v0.2.1 -This update fixes security vulnerablities in the lodash sub-dependency and bumps other dev dependencies to their latest version. +This update fixes security vulnerabilities in the lodash sub-dependency and bumps other dev dependencies to their latest version. ## v0.2.0 Adds: - Dark mode via `color_scheme` parameter