v0.7.0

[mattxwang]

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.

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

• Added: configuration options for opening external links in new tab by [@CarbonNeuron] in [Add configuration options for opening external links in new tab #1360]

Bugfixes

• Fixed: remove href from the navigation link to the current page by [@pdmosses] in [Remove href from the navigation link to the current page #1356]
• Fixed: improve build time by [@pdmosses] in [Fix: improve build time #1358]
• Fixed: erroneous parentheses in site_nav conditional by [@mattxwang] in [Fixes erroneous parentheses in site_nav conditional #1366]
• Fixed: navigation scroll to active link regression by [@pdmosses] in [Fixed: navigation scroll to active link regression #1367]
• Fixed: invalid CSS rules in head elements by [@pdmosses] in [Fix invalid CSS rules in head elements #1368]
• Fixed: accidental disabling of forward-declared stylesheets by [@mattxwang] in [Fix accidental disabling of forward-declared stylesheets #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 [docs: fix typos in CHANGELOG and MIGRATION #1377]

New Contributors

• [@CarbonNeuron] made their first contribution in [Add configuration options for opening external links in new tab #1360]
• [@thapasusheel] made their first contribution in [docs: fix typos in CHANGELOG and MIGRATION #1377]

---

This discussion was created from the release v0.7.0.

[note4]

It took several hours to manually upgrade from just-the-docs-0.4.0.rc3 to 0.7.0. Because some modifications were made, the changed files needed to be compared or merged one by one.
Come take a look at my site: https://1px.run/

Here are some suggestions:

1. The copyright information in some files is still from 2016, can it be updated to 2024?
2. The scroll bar that comes with the system is too ugly. It can be beautified. Would it be better to hide the scroll bar when the content does not exceed the height of one screen?
3. Distinguish the invitation link from the navigation content. Although there is a "jump out" style arrow icon now, it still feels too easy to be confused with the navigation content. Or provide two areas for external links, navigation and the bottom of the page.
4. Can the theme mode provide three options: light, dark, and automatic (follow the system settings)

[mattxwang]

Thanks for commenting @note4! Suggestions 1 & 4 are already in-flight (there are currently open PRs for both); 2 & 3 may need more context, so feel free to file an issue to discuss!

(quickly: the scroll bar may be a user agent item, and could you clarify what an "invitation link" is?)

[note4]

"invitation link"

[pdmosses]

@note4 wrote:

It took several hours to manually upgrade from just-the-docs-0.4.0.rc3 to 0.7.0. Because some modifications were made, the changed files needed to be compared or merged one by one.

That is not surprising when theme code files have been modified, as JtD has developed significantly since the v0.4.0.rc3 pre-release in October 2022!

JtD uses semantic versioning:

Major version zero (0.y.z) is for initial development. Anything MAY change at any time. The public API SHOULD NOT be considered stable.

The theme docs provide detailed advice on migration between releases. New JtD releases aim to be backwards compatible, but only for sites that use the theme without modifying theme files.