We're so excited to release Just the Docs v0.4.0! This release has been almost a year in the making - after our new maintenance team has taken over the project, we've added two years of backlogged features and bugfixes to modernize the theme. This CHANGELOG will summarize some of the key changes, discuss migrations strategies, and outline broad future plans for this theme.
Brief Overview - Highlighted Changes
v0.4.0 contains many new features and bugfixes. We enumerate all of them in further sections in this changelog; however, we'd like to call out some of the most-requested changes:
better support for dark theme: dark highlighting, search input color
callouts, a new design component to highlight content
After usage instructions and the roadmap, we enumerate all changes from v0.3.3.
Using Release v0.4.0
Unlike pre-releases, v0.4.0 is a new semver minor release for the theme. That means that users who have not pinned the theme version will be automatically upgraded to v0.4.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.4.0
To use this RC 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.4.0"
If you would prefer to not upgrade, you can enforce that explicitly:
We're so excited to release Just the Docs v0.4.0. This release has been almost a year in the making - after our new maintenance team has taken over the project, we've added two years of backlogged features and bugfixes to modernize the theme. This CHANGELOG will summarize some of the key changes, discuss migrations strategies, and outline broad future plans for this theme.
Brief Overview - Highlighted Changes
v0.4.0 contains many new features and bugfixes. We enumerate all of them in further sections in this changelog; however, we'd like to call out some of the most-requested changes:
better support for dark theme: dark highlighting, search input color
callouts, a new design component to highlight content
After usage instructions and the roadmap, we enumerate all changes from v0.3.3.
Using Release v0.4.0
Unlike pre-releases, v0.4.0 is a new semver minor release for the theme. That means that users who have not pinned the theme version will be automatically upgraded to v0.4.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.4.0
To use this RC 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.4.0"
If you would prefer to not upgrade, you can enforce that explicitly:
pin your gem version in your Gemfile, like so
gem "just-the-docs", "0.3.3"
freeze the remote_theme, like so
remote_theme: just-the-docs/just-the-docs@v0.3.3
Migration Guide and Strategies
... (truncated)
Commits
dd1e80a Prep for v0.4.0: changelog, docs, gemspec bump
86dbc2d Prep for v0.4.0.rc5; update gemspec and CHANGELOG
Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.
Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
- `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
Bumps just-the-docs from 0.3.3 to 0.4.0.
Release notes
Sourced from just-the-docs's releases.
... (truncated)
Changelog
Sourced from just-the-docs's changelog.
... (truncated)
Commits
dd1e80a
Prep forv0.4.0
: changelog, docs, gemspec bump86dbc2d
Prep forv0.4.0.rc5
; update gemspec and CHANGELOGc7c9999
Update CHANGELOG.md8894630
Fix copy code button interaction with kramdown line numbers (#1143)4a7fbbc
Update CHANGELOG.mdb2bbdb7
Add configuration key to load a local version of mermaid (#1153)cf72c43
Update CHANGELOG.md6cdd4f7
Fix dark theme's code block background, line number colors (#1124)c13a5d2
Update CHANGELOG.md5f91e32
docs: label new features introduced inv0.4
(#1138)Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting
@dependabot rebase
.Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)