The page you requested could not be found. Try using the navigation {% if site.search_enabled != false %}or search {% endif %}to find what you're looking for or go to this site's home page.
diff --git a/CHANGELOG.md b/CHANGELOG.md deleted file mode 100644 index 39e78590..00000000 --- a/CHANGELOG.md +++ /dev/null @@ -1,1990 +0,0 @@ -# CHANGELOG - -{: .highlight } -The project underwent a major maintenance shift in March 2022. - -## HEAD - -{: .note } -This website is built from the `HEAD` of the `main` branch of the theme repository. - -Code changes to `main` that are *not* in the latest release: - -### 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] - -{: .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 - -[#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 - -- Fixed: Windows emoji font fallback by [@flanakin] in [#1337] -- Removed: unused `.passive` toggle in navigation by [@pdmosses] in [#1335] - -[#1335]: https://github.com/just-the-docs/just-the-docs/pull/1335 - -[#1337]: https://github.com/just-the-docs/just-the-docs/pull/1337 - -### New Contributors - -- [@flanakin] made their first contribution in [#1337] - -[@flanakin]: https://github.com/flanakin - -## Release v0.6.1 - -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 - -- Fixed: JS error for pages excluded from navigation by [@pdmosses] in [#1332] - -[#1332]: https://github.com/just-the-docs/just-the-docs/pull/1332 - -## Release v0.6.0 - -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](https://just-the-docs.com/MIGRATION/). - -### 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: - -```yml -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`: - -```ruby -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 - -- Added: `$color-scheme` theme variable to specify `color-scheme` for `:root` by [@sigv] in [#1280] -- Fixed: build times for large sites by [@pdmosses] in [#1244] -- Fixed: missing closing `` tag in `sidebar.html` by [@mattxwang] in [#1304] -- Fixed: removed duplicate `#main-content-wrap` minimal and default layouts by [@mattxwang] in [#1305] - -### 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 - -- [@sigv] made their first contribution in [#1280] - -[@sigv]: https://github.com/sigv - -[#1244]: https://github.com/just-the-docs/just-the-docs/pull/1244 - -[#1280]: https://github.com/just-the-docs/just-the-docs/pull/1280 - -[#1304]: https://github.com/just-the-docs/just-the-docs/pull/1304 - -[#1305]: https://github.com/just-the-docs/just-the-docs/pull/1305 - -## Release v0.5.4 - -Hi all, this is a small patch release that only includes one change: fixing a style clash between Mermaid's labels and -Just the Docs' labels. - -*Note: for subsequent patch releases, we will omit migration instructions (for brevity). In all cases, immediate -migration should be backwards-compatible. Refer to previous major or minor update instructions for more information.* - -### Bugfixes - -- Fixed: Mermaid labels inheriting theme `.label` styling by [@mattxwang] in [#1278] - -[#1278]: https://github.com/just-the-docs/just-the-docs/pull/1278 - -## Release v0.5.3 - -Hi all, this is a minor patch release that only includes one change: changing all text-based CSS properties to use `rem` -instead of hard-coded `px` values. This has two effects: - -1. All deprecation warnings are now fixed on build; you should now get a clean build with `jekyll build`. -2. We have **deprecated the `$root-font-size` SCSS variable**. We will remove it in an upcoming release of the theme. - -If you use the stock Just the Docs theme, this release should have no impact on your final built site. If you change -the `$root-font-size` SCSS variable, you might experience light layout shifts. - -### Using Release `v0.5.3` - -Users who have not pinned the theme version will be **automatically upgraded to `v0.5.3` 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.3 -``` - -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.3" -``` - -To use and pin a previous version of the theme, replace the `0.5.3` with the desired release tag. - -### Bugfixes - -- Fixed: font-size scaling for text-related CSS properties by using `rem` instead of fixed `px` values; - deprecate `$root-font-size` by [@mattxwang] in [#1169] - -[#1169]: https://github.com/just-the-docs/just-the-docs/pull/1169 - -## 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:` by [@mattxwang] in [#965] -- Added: custom include for TOC heading by [@pdmosses] in [#980] -- Added: experimental nav optimization for simple cases by [@pdmosses] in [#992] -- Added: support multiple Google Analytics tracking IDs, document UA -> GA4 switch by [@MichelleBlanchette] in [#1029] -- Added: copy code button to code snippets by [@simonebortolin] in [#945] -- Added: restore simple configuration of `favicon.ico` via `site.static_files` by [@pdmosses] in [#1095] -- Added: modularize site components by [@mattxwang] in [#1058] -- Added: includes for custom `lunr` Liquid and JS code by [@diablodale] in [#1068] -- Added: new `_sass/custom/setup.scss` for variable definition by [@mattxwang] in [#1135] -- Added: configuration key to load a local version of mermaid by [@fabrik42] in [#1153] - -### Bugfixes - -- Fixed: prepend `site.collections_dir` if exists by [@alexsegura] in [#519] -- Fixed: nested task lists (#517) by [@pdmosses] in [#855] -- Fixed: suppress Liquid processing in CSS comments by [@pdmosses] in [#686] -- Fixed: prevent rake command from corrupting search data by [@pdmosses] in [#495] -- Fixed: anchor heading links should be visible on focus by [@jacobhq] in [#846] -- Fixed: add `overflow-x: auto` to `figure.highlight` by [@iridazzle] in [#727] -- Fixed: add `overflow-wrap: word-break` to `body` by [@iridazzle] in [#889] -- Fixed: vertical alignment for consecutive labels by [@Eisverygoodletter] in [#893] -- Fixed: allow links to wrap by [@pdmosses] in [#905] -- Fixed: nav scroll feature and absolute/relative URLs by [@pdmosses] in [#898] -- Fixed: exclude `vendor/` in Jekyll config by [@manuelhenke] in [#941] -- Fixed: improve build time of navigation panel by [@pdmosses] in [#956] -- Fixed: spacing issue when search is disabled by [@henryiii] in [#960] -- Fixed: active grandchild link class by [@pdmosses] in [#962] -- Fixed: HTML validation issues (W3C validator) by [@mattxwang] in [#964] -- Fixed: link styling now uses `text-decoration` values by [@mattxwang] in [#967] -- Fixed: cleaning up Jekyll excludes by [@pdmosses] in [#985] -- Fixed: docs, narrow styling for code highlighting with line numbers by [@pdmosses] in [#974] -- Fixed: default syntax highlighting in custom color schemes [@pdmosses] in [#986] -- Fixed: incorrect disambiguation in generated TOCs by [@pdmosses] in [#999] -- Fixed: duplicated external links in collections by [@pdmosses] in [#1001] -- Fixed: import order of `custom.scss`; puts at end by [@deseo] in [#1010] -- Fixed: top-level active link styling by [@pdmosses] in [#1015] -- Fixed: external links for sites with no pages by [@pdmosses] in [#1021] -- Fixed: duplicate `title` if `jekyll-seo-tag` not in users's plugins by [@Tom-Brouwer] in [#1040] -- Fixed: removes (duplicate) `favicon.html`, shifts content to `head_custom.html` by [@mattxwang] in [#1027] -- Fixed: add `reversed`, deprecate `desc` for nav `child_nav_order` by [@jmertic] in [#1061] -- Fixed: `child.child_nav_order` to `node.child_nav_order` by [@mattxwang] in [#1065] -- Fixed: remove all uses of `/` as SASS division by [@mattxwang] in [#1074] - - note: this was originally merged as [#1074] with a bug; it was reverted in [#1076], and then reimplemented - in [#1077] -- Fixed: skip nav collection generation when site has no pages by [@pdmosses] in [#1092] -- Fixed: standardize SCSS with `declaration-block-no-redundant-longhand-properties` by [@simonebortolin] in [#1102] -- Fixed: incorrect `padding` property value pair in `labels.scss` by [@SConaway] in [#1104] -- Fixed: various bugs with copy code button by [@simonebortolin] in [#1096] -- Fixed: replace inline styling for `