steve/just-the-docs
1
0
Fork 0
mirror of https://github.com/snachodog/just-the-docs.git synced 2025-04-08 04:51:23 -06:00
Code Issues Packages Projects Releases Wiki Activity

v0.5.2

Browse Source
This commit is contained in:
Matthew Wang 2023-06-06 21:48:55 -07:00
parent 790a8b5c06
commit ea0d5d8ec7
No known key found for this signature in database
GPG Key ID: 0C8DB42BF157DEAB
2 changed files with 36 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
CHANGELOG.md
View File

@ -16,17 +16,49 @@ The project underwent a major maintenance shift in March 2022.
This website is built from the `HEAD` of the `main` branch of the theme repository.
{: .warning }
This website includes docs for some new features that are not available in `v0.5.0`!
This website includes docs for some new features that are not available in `v0.5.2`!
Code changes to `main` that are *not* in the latest release:
- N/A
Docs changes in `main` that are *not* in the latest release:
- N/A
## Release 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: <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!
### 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] 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] in [#1262]
Docs changes in `main` that are *not* in the latest release:
### New Contributors
- N/A
- [@joelhawksley] made their first contribution in [#1259]
[@joelhawksley]: https://github.com/joelhawksley
@ -34,8 +66,6 @@ Docs changes in `main` that are *not* in the latest release:
[#1259]: https://github.com/just-the-docs/just-the-docs/pull/1259
[#1262]: https://github.com/just-the-docs/just-the-docs/pull/1262
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/>.
## Release 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.

2
just-the-docs.gemspec
View File

@ -2,7 +2,7 @@
Gem::Specification.new do |spec|
spec.name = "just-the-docs"
spec.version = "0.5.1"
spec.version = "0.5.2"
spec.authors = ["Patrick Marsceill", "Matthew Wang"]
spec.email = ["patrick.marsceill@gmail.com", "matt@matthewwang.me"]