Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(deps): update just-the-docs (0.5.4 → 0.7.0) #898

Merged
merged 1 commit into from
Jan 16, 2024

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Jan 16, 2024

Mend Renovate

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
just-the-docs (changelog) 0.5.4 -> 0.7.0 age adoption passing confidence

Release Notes

just-the-docs/just-the-docs (just-the-docs)

v0.7.0

Compare Source

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.

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:

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:

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
Bugfixes

{: .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:
New Contributors

v0.6.2

Compare Source

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
New Contributors

v0.6.1

Compare Source

Hi all, this is a small patch release that only includes one change: resolving a bug introduced in 0.6.0 that causes a JS error for pages excluded from navigation.

Bugfixes

v0.6.0

Compare Source

Hi all, this is a minor release that introduces performance improvements for build times on large sites, correctly sets the color-scheme property, and fixes invalid HTML. However, it introduces some potentially-breaking internal changes to undocumented features of the theme.

Migrating to v0.6.0

Migration: users will need to migrate if:

  • they have an existing _includes file named favicon.html, head_nav.html, or css/activation.scss.liquid
  • they have code that refers to #main-content-wrap
  • they override the default light theme's code, or the theme-loading logic
  • they have different favicons for different pages

For more, refer to the migration guide.

Using Release v0.6.0

Users who have not pinned the theme version will be automatically upgraded to v0.6.0 the next time they build their site.

To use this release explicitly as a remote theme:

remote_theme: just-the-docs/just-the-docs@v0.6.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:

gem "just-the-docs", "0.6.0"

To use and pin a previous version of the theme, replace the 0.6.0 with the desired release tag.

New Features and Bugfixes
Documentation

{: .warning }
The theme docs are unversioned, and already reflect the above changes.

Docs changes:

  • A [footnote]({% link docs/configuration.md %}#fn:js-disabled) in the configuration docs explains how disabling JavaScript affects the display of navigation links when browsing folded collections.
  • Invalid HTML has been removed from most documentation examples.
New Contributors

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 is behind base branch, 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. View repository job log here.

@renovate renovate bot added the type/minor label Jan 16, 2024
@renovate renovate bot force-pushed the renovate/just-the-docs-0.x-lockfile branch 3 times, most recently from 795575e to 489a5b5 Compare January 16, 2024 03:46
@renovate renovate bot changed the title feat(deps): update just-the-docs ( 0.5.4 → 0.7.0 ) chore(deps): update just-the-docs (0.5.4 → 0.7.0) Jan 16, 2024
@renovate renovate bot force-pushed the renovate/just-the-docs-0.x-lockfile branch 4 times, most recently from e5bf09d to f4f8322 Compare January 16, 2024 04:25
@renovate renovate bot force-pushed the renovate/just-the-docs-0.x-lockfile branch 2 times, most recently from 4bb9f2d to 22da016 Compare January 16, 2024 04:29
@renovate renovate bot force-pushed the renovate/just-the-docs-0.x-lockfile branch from 22da016 to f64bcd9 Compare January 16, 2024 04:51
@renovate renovate bot force-pushed the renovate/just-the-docs-0.x-lockfile branch 3 times, most recently from 568a96f to a757169 Compare January 16, 2024 05:02
@bpg bpg enabled auto-merge (squash) January 16, 2024 05:19
| datasource | package       | from  | to    |
| ---------- | ------------- | ----- | ----- |
| rubygems   | just-the-docs | 0.5.4 | 0.7.0 |
@renovate renovate bot force-pushed the renovate/just-the-docs-0.x-lockfile branch from a757169 to 4147448 Compare January 16, 2024 05:19
@bpg bpg merged commit 2f074d6 into main Jan 16, 2024
7 checks passed
@bpg bpg deleted the renovate/just-the-docs-0.x-lockfile branch January 16, 2024 05:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant