just-the-docs 0.10.1 → 0.10.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (15) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +369 -1441
  3. data/README.md +0 -2
  4. data/_includes/components/nav/links.html +5 -5
  5. data/_includes/components/search_header.html +5 -2
  6. data/_includes/components/sidebar.html +1 -1
  7. data/_includes/components/site_nav.html +1 -1
  8. data/_sass/color_schemes/dark.scss +1 -1
  9. data/_sass/color_schemes/light.scss +1 -1
  10. data/_sass/layout.scss +0 -1
  11. data/_sass/print.scss +5 -0
  12. data/_sass/search.scss +2 -1
  13. data/_sass/utilities/_layout.scss +14 -0
  14. data/assets/js/just-the-docs.js +4 -4
  15. metadata +3 -3
data/CHANGELOG.md CHANGED
@@ -7,8 +7,9 @@ layout: default
7
7
 
8
8
  All notable user-facing changes to this project are documented in this file.
9
9
 
10
- {: .highlight }
11
- The project underwent a major maintenance shift in March 2022.
10
+ For information on upgrading to a new version (including resolving breaking changes), see the [Migration and Upgrading Guide](https://just-the-docs.com/MIGRATION).
11
+
12
+ For more detailed explanations for each release, see [the GitHub Releases page](https://github.com/just-the-docs/just-the-docs/releases).
12
13
 
13
14
  ## HEAD
14
15
 
@@ -23,1545 +24,476 @@ Docs changes made since the latest release:
23
24
 
24
25
  - N/A
25
26
 
26
- ## Release v0.10.1
27
-
28
- Hi folks! This patch fixes two bugs related to generated navigation elements and improves our docs.
27
+ ## v0.10.2 - 2025-12-31
29
28
 
30
- This release should be a straightforward upgrade for all users of Just the Docs. Thank you for your continued support!
29
+ ### Theme
31
30
 
32
- ### Bugfixes
33
-
34
- - Fixed: `back_to_top` not displaying when no other footer variables are set by [@mattxwang] in [#1461]
35
- - Fixed: auto-generated child navigation (TOC) by [@pdmosses] in [#1590]
31
+ - Fixed: `margin-top` and `margin-bottom` for `<hr>` elements in print styles by [@jacksonj04](https://github.com/jacksonj04) in [#1677](https://github.com/just-the-docs/just-the-docs/pull/1677)
32
+ - Fixed: sidenav footer (`.site-footer`) color contrast by [@mattxwang](https://github.com/mattxwang) in [#1746](https://github.com/just-the-docs/just-the-docs/pull/1746)
33
+ - Fixed: use `aria-expanded` instead of `aria-pressed` for buttons connected to expandable content by [@rianrietveld](https://github.com/rianrietveld) in [#1679](https://github.com/just-the-docs/just-the-docs/pull/1679)
34
+ - Fixed: accessibility issues with search bar (color contrast, focus indicator, decorative icons) by [@mattxwang](https://github.com/mattxwang) in [#1747](https://github.com/just-the-docs/just-the-docs/pull/1747)
36
35
 
37
36
  ### Documentation
38
37
 
39
- - Fixed: incorrect docs for example with minimal layout parent, default layout child by [@janbrasna] in [#1540]
40
- - Fixed: unclear docs on using in-page table of contents by [@sebjameswml] in [#1551]
41
-
42
- ### New Contributors
43
-
44
- - [@janbrasna] made their first contribution in [#1540]
45
- - [@sebjameswml] made their first contribution in [#1551]
46
-
47
- [@janbrasna]: https://github.com/janbrasna
48
- [@sebjameswml]: https://github.com/sebjameswml
49
-
50
- [#1461]: https://github.com/just-the-docs/just-the-docs/pull/1461
51
- [#1540]: https://github.com/just-the-docs/just-the-docs/pull/1540
52
- [#1551]: https://github.com/just-the-docs/just-the-docs/pull/1551
53
- [#1590]: https://github.com/just-the-docs/just-the-docs/pull/1590
54
-
55
- ## Release v0.10.0
38
+ - Remove non-essential CHANGELOG information by [@mattxwang](https://github.com/mattxwang) in [#1745](https://github.com/just-the-docs/just-the-docs/pull/1745)
56
39
 
57
- Hi folks! This minor release adds one of our most-requested features: unlimited multi-level navigation (also known as recursive navigation). Huge thanks to [@pdmosses] for his wonderful work in implementing this feature!
40
+ ## v0.10.1 - 2025-01-06
58
41
 
59
- This release should be a straightforward upgrade for all users of Just the Docs. Thank you for your continued support!
42
+ ### Theme
60
43
 
61
- ### Using Release `v0.10.0`
62
-
63
- Users who have not pinned the theme version will be **automatically upgraded to `v0.9.0` the next time they build their site**.
64
-
65
- To use this release explicitly as a remote theme:
66
-
67
- ```yml
68
- remote_theme: just-the-docs/just-the-docs@v0.10.0
69
- ```
70
-
71
- 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`:
72
-
73
- ```ruby
74
- gem "just-the-docs", "0.10.0"
75
- ```
76
-
77
- To use and pin a previous version of the theme, replace the `0.10.0` with the desired release tag.
78
-
79
- ### New Features
80
-
81
- - Added: Allow unlimited multi-level navigation by [@pdmosses] in [#1431]
44
+ - Fixed: `back_to_top` not displaying when no other footer variables are set by [@mattxwang](https://github.com/mattxwang) in [#1461](https://github.com/just-the-docs/just-the-docs/pull/1461)
45
+ - Fixed: auto-generated child navigation (TOC) by [@pdmosses](https://github.com/pdmosses) in [#1590](https://github.com/just-the-docs/just-the-docs/pull/1590)
82
46
 
83
47
  ### Documentation
84
48
 
85
- - Added: Allow unlimited multi-level navigation by [@pdmosses] in [#1440]
86
- - Added: sitemap (via `jekyll-sitemap` plugin) by [@mattxwang] in [#1530]
87
- - Fixed: (non-systemic) accessibility issues flagged by aXe by [@mattxwang] in [#1531]
88
-
89
- [#1431]: https://github.com/just-the-docs/just-the-docs/pull/1431
90
- [#1440]: https://github.com/just-the-docs/just-the-docs/pull/1440
91
- [#1530]: https://github.com/just-the-docs/just-the-docs/pull/1530
92
- [#1530]: https://github.com/just-the-docs/just-the-docs/pull/1531
93
-
94
- ## Release v0.9.0
49
+ - Fixed: incorrect docs for example with minimal layout parent, default layout child by [@janbrasna](https://github.com/janbrasna) in [#1540](https://github.com/just-the-docs/just-the-docs/pull/1540)
50
+ - Fixed: unclear docs on using in-page table of contents by [@sebjameswml](https://github.com/sebjameswml) in [#1551](https://github.com/just-the-docs/just-the-docs/pull/1551)
95
51
 
96
- Hi folks! This minor release adds a `nav_enabled` set of variables to enable/disable the navigation at a site, layout, and page level --- and uses that to add search and auxilary links to the `minimal` layout. In addition, it fixes `search-data.json` corruption with default layouts and some minor CSS/SCSS issues.
52
+ ## v0.10.0 - 2024-09-09
97
53
 
98
- This release should be a straightforward upgrade for all users of Just the Docs. Thank you for your continued support!
54
+ ### Theme
99
55
 
100
- ### Using Release `v0.9.0`
101
-
102
- Users who have not pinned the theme version will be **automatically upgraded to `v0.9.0` the next time they build their site**.
103
-
104
- To use this release explicitly as a remote theme:
105
-
106
- ```yml
107
- remote_theme: just-the-docs/just-the-docs@v0.9.0
108
- ```
109
-
110
- 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`:
111
-
112
- ```ruby
113
- gem "just-the-docs", "0.9.0"
114
- ```
115
-
116
- To use and pin a previous version of the theme, replace the `0.9.0` with the desired release tag.
117
-
118
- ### New Features
119
-
120
- - Added: `nav_enabled` site, layout, and page-level variable to selectively show or hide the side/mobile menu by [@kevinlin1] in [#1441]
121
- - Added: site-wide search bar and auxiliary links to the `minimal` layout by [@kevinlin1] in [#1441]
122
-
123
- ### Bugfixes
124
-
125
- - Fixed: protect `search-data.json` file from front matter default for layout by [@mattxwang] in [#1468]
126
- - Fixed: Sass mixed declarations by [@bobvandevijver] in [#1495]
127
- - Fixed: redundant `monospace` in `pre`, `code`, `kbd`, `samp` reset by [@mattxwang] in [#1508]
56
+ - Added: Allow unlimited multi-level navigation by [@pdmosses](https://github.com/pdmosses) in [#1431](https://github.com/just-the-docs/just-the-docs/pull/1431)
128
57
 
129
58
  ### Documentation
130
59
 
131
- - Docs: Explained the `nav_enabled` variables as an alternative to using the minimal layout [@kevinlin1] in [#1441].
132
-
133
- ### New Contributors
134
-
135
- - [@bobvandevijver] made their first contribution in [#1495]
136
-
137
- [@bobvandevijver]: https://github.com/bobvandevijver
138
-
139
- [#1441]: https://github.com/just-the-docs/just-the-docs/pull/1441
140
- [#1468]: https://github.com/just-the-docs/just-the-docs/pull/1468
141
- [#1495]: https://github.com/just-the-docs/just-the-docs/pull/1495
142
- [#1508]: https://github.com/just-the-docs/just-the-docs/pull/1508
143
-
144
- ## Release v0.8.2
145
-
146
- Hi everyone! This patch release fixes a bug where a default layout with unrestricted `scope` (`path: ""`) breaks JavaScript functionality. Users who do not use a default layout with unrestricted `scope` should not be affected. This should be a straightforward upgrade for all users. Thank you to [@pdmosses] for triaging and fixing the bug!
147
-
148
- ### Bugfixes
149
-
150
- - Fixed: Protect theme JS file from front matter default for layout by [@pdmosses] in [#1447]
151
-
152
- [#1447]: https://github.com/just-the-docs/just-the-docs/pull/1447
60
+ - Added: Allow unlimited multi-level navigation by [@pdmosses](https://github.com/pdmosses) in [#1440](https://github.com/just-the-docs/just-the-docs/pull/1440)
61
+ - Added: sitemap (via `jekyll-sitemap` plugin) by [@mattxwang](https://github.com/mattxwang) in [#1530](https://github.com/just-the-docs/just-the-docs/pull/1530)
62
+ - Fixed: (non-systemic) accessibility issues flagged by aXe by [@mattxwang](https://github.com/mattxwang) in [#1531](https://github.com/just-the-docs/just-the-docs/pull/1531)
153
63
 
154
- ## Release v0.8.1
64
+ ## v0.9.0 - 2024-08-12
155
65
 
156
- Hi folks! This patch release fixes a bug introduced in `0.8.0` that affects users who build their sites in strict mode. It is a straightforward upgrade that should require no manual migration changes. Thank you to [@Zarthus] for quickly catching and fixing this bug!
157
-
158
- ### Bugfixes
66
+ ### Theme
159
67
 
160
- - Fixed: Liquid filter typo in breadcrumb component (`strip` instead of `trim`) by [@Zarthus] in [#1434]
68
+ - Added: `nav_enabled` site, layout, and page-level variable to selectively show or hide the side/mobile menu by [@kevinlin1](https://github.com/kevinlin1) in [#1441](https://github.com/just-the-docs/just-the-docs/pull/1441)
69
+ - Added: site-wide search bar and auxiliary links to the `minimal` layout by [@kevinlin1](https://github.com/kevinlin1) in [#1441](https://github.com/just-the-docs/just-the-docs/pull/1441)
70
+ - Fixed: protect `search-data.json` file from front matter default for layout by [@mattxwang](https://github.com/mattxwang) in [#1468](https://github.com/just-the-docs/just-the-docs/pull/1468)
71
+ - Fixed: Sass mixed declarations by [@bobvandevijver](https://github.com/bobvandevijver) in [#1495](https://github.com/just-the-docs/just-the-docs/pull/1495)
72
+ - Fixed: redundant `monospace` in `pre`, `code`, `kbd`, `samp` reset by [@mattxwang](https://github.com/mattxwang) in [#1508](https://github.com/just-the-docs/just-the-docs/pull/1508)
161
73
 
162
74
  ### Documentation
163
75
 
164
- - Build docs site using strict mode and `strict_filters` by [@Zarthus] in [#1435]
165
-
166
- ### New Contributors
167
-
168
- - [@Zarthus] made their first contribution in [#1434]
169
-
170
- [@Zarthus]: https://github.com/Zarthus
171
-
172
- [#1434]: https://github.com/just-the-docs/just-the-docs/pull/1434
173
- [#1435]: https://github.com/just-the-docs/just-the-docs/pull/1435
76
+ - Docs: Explained the `nav_enabled` variables as an alternative to using the minimal layout [@kevinlin1](https://github.com/kevinlin1) in [#1441](https://github.com/just-the-docs/just-the-docs/pull/1441).
174
77
 
175
- ## Release v0.8.0
78
+ ## v0.8.2 - 2024-05-15
176
79
 
177
- Hi folks! This first minor release of 2024 has a short number of changes: a large improvement of build times for large sites, a new keyboard shortcut to focus the search bar, and sidebar navigation bugfixes for "pretty" URLs (with `.html` omitted) and the clickable area on Safari. This release has no explicit breaking changes and should be a straightforward upgrade for most (if not all) users.
80
+ ### Theme
178
81
 
179
- ### Using Release `v0.8.0`
82
+ - Fixed: Protect theme JS file from front matter default for layout by [@pdmosses](https://github.com/pdmosses) in [#1447](https://github.com/just-the-docs/just-the-docs/pull/1447)
180
83
 
181
- Users who have not pinned the theme version will be **automatically upgraded to `v0.8.0` the next time they build their site**.
84
+ ## v0.8.1 - 2024-03-06
182
85
 
183
- To use this release explicitly as a remote theme:
86
+ ### Theme
184
87
 
185
- ```yml
186
- remote_theme: just-the-docs/just-the-docs@v0.8.0
187
- ```
188
-
189
- 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`:
190
-
191
- ```ruby
192
- gem "just-the-docs", "0.8.0"
193
- ```
194
-
195
- To use and pin a previous version of the theme, replace the `0.8.0` with the desired release tag.
196
-
197
- ### New Features
198
-
199
- - Added: configurable keyboard shortcut to focus search input by [@kcromanpl-bajra] in [#1411]
200
-
201
- ### Bugfixes
202
-
203
- - Fixed: quicker build by [@pdmosses] in [#1397]
204
- - Fixed: incorrect navigation when `.html` omitted from URL by [@pdmosses] in [#1374]
205
- - Fixed: incorrect positioning of clickable area for navigation links on Safari by [@mattxwang] in [#1403]
88
+ - Fixed: Liquid filter typo in breadcrumb component (`strip` instead of `trim`) by [@Zarthus](https://github.com/Zarthus) in [#1434](https://github.com/just-the-docs/just-the-docs/pull/1434)
206
89
 
207
90
  ### Documentation
208
91
 
209
- - Add documentation to "Navigation Structure" on grouping pages with collections by [@mitchnemirov] in [#1390]
210
-
211
- ### New Contributors
92
+ - Build docs site using strict mode and `strict_filters` by [@Zarthus](https://github.com/Zarthus) in [#1435](https://github.com/just-the-docs/just-the-docs/pull/1435)
212
93
 
213
- - [@mitchnemirov] made their first contribution in [#1390]
214
- - [@kcromanpl-bajra] made their first contribution in [#1411]
94
+ ## v0.8.0 - 2024-02-22
215
95
 
216
- [@mitchnemirov]: https://github.com/mitchnemirov
217
- [@kcromanpl-bajra]: https://github.com/kcromanpl-bajra
96
+ ### Theme
218
97
 
219
- [#1374]: https://github.com/just-the-docs/just-the-docs/pull/1374
220
- [#1390]: https://github.com/just-the-docs/just-the-docs/pull/1390
221
- [#1397]: https://github.com/just-the-docs/just-the-docs/pull/1397
222
- [#1403]: https://github.com/just-the-docs/just-the-docs/pull/1403
223
- [#1411]: https://github.com/just-the-docs/just-the-docs/pull/1411
98
+ - Added: configurable keyboard shortcut to focus search input by [@kcromanpl-bajra](https://github.com/kcromanpl-bajra) in [#1411](https://github.com/just-the-docs/just-the-docs/pull/1411)
99
+ - Fixed: quicker build by [@pdmosses](https://github.com/pdmosses) in [#1397](https://github.com/just-the-docs/just-the-docs/pull/1397)
100
+ - Fixed: incorrect navigation when `.html` omitted from URL by [@pdmosses](https://github.com/pdmosses) in [#1374](https://github.com/just-the-docs/just-the-docs/pull/1374)
101
+ - Fixed: incorrect positioning of clickable area for navigation links on Safari by [@mattxwang](https://github.com/mattxwang) in [#1403](https://github.com/just-the-docs/just-the-docs/pull/1403)
224
102
 
225
- ## Release v0.7.0
226
-
227
- 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.
228
-
229
- ### Migrating to `v0.7.0`
230
-
231
- **Migration**: users will need to migrate if:
232
-
233
- - they overrode `_includes/nav.html`, which has moved to `_includes/components/nav.html`
234
- - they have an element with the IDs `jtd-nav-activation` or `jtd-head-nav-stylesheet`
235
-
236
- For more, refer to the [migration guide](https://just-the-docs.com/MIGRATION/).
237
-
238
- ### Using Release `v0.7.0`
239
-
240
- Users who have not pinned the theme version will be **automatically upgraded to `v0.7.0` the next time they build their site**.
241
-
242
- To use this release explicitly as a remote theme:
243
-
244
- ```yml
245
- remote_theme: just-the-docs/just-the-docs@v0.7.0
246
- ```
247
-
248
- 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`:
249
-
250
- ```ruby
251
- gem "just-the-docs", "0.7.0"
252
- ```
253
-
254
- To use and pin a previous version of the theme, replace the `0.7.0` with the desired release tag.
255
-
256
- ### New Features
103
+ ### Documentation
257
104
 
258
- - Added: configuration options for opening external links in new tab by [@CarbonNeuron] in [#1360]
105
+ - Add documentation to "Navigation Structure" on grouping pages with collections by [@mitchnemirov](https://github.com/mitchnemirov) in [#1390](https://github.com/just-the-docs/just-the-docs/pull/1390)
259
106
 
260
- ### Bugfixes
261
-
262
- - Fixed: remove href from the navigation link to the current page by [@pdmosses] in [#1356]
263
- - Fixed: improve build time by [@pdmosses] in [#1358]
264
- - Fixed: erroneous parentheses in `site_nav` conditional by [@mattxwang] in [#1366]
265
- - Fixed: navigation scroll to active link regression by [@pdmosses] in [#1367]
266
- - Fixed: invalid CSS rules in head elements by [@pdmosses] in [#1368]
267
- - Fixed: accidental disabling of forward-declared stylesheets by [@mattxwang] in [#1373]
107
+ ## v0.7.0 - 2023-10-25
268
108
 
269
109
  {: .warning }
270
- [#1358] moved `_includes/nav.html` to the `_includes/components` directory,
271
- Users who were overriding that file will need to adjust their sites accordingly.
272
-
273
- ### Documentation:
110
+ **Potentially Breaking Changes**: this version contains **potentially breaking changes** for a small set of users. For more information, refer to the [Migrating to v0.7.0 guide](https://just-the-docs.com/migration/#potentially-breaking-changes-in-v070).
274
111
 
275
- - Docs: fix typos in `CHANGELOG` and `MIGRATION` by [@thapasusheel] in [#1377]
112
+ ### Theme
276
113
 
277
- ### New Contributors
114
+ - Added: configuration options for opening external links in new tab by [@CarbonNeuron](https://github.com/CarbonNeuron) in [#1360](https://github.com/just-the-docs/just-the-docs/pull/1360)
115
+ - Fixed: remove href from the navigation link to the current page by [@pdmosses](https://github.com/pdmosses) in [#1356](https://github.com/just-the-docs/just-the-docs/pull/1356)
116
+ - Fixed: improve build time by [@pdmosses](https://github.com/pdmosses) in [#1358](https://github.com/just-the-docs/just-the-docs/pull/1358)
117
+ - Fixed: erroneous parentheses in `site_nav` conditional by [@mattxwang](https://github.com/mattxwang) in [#1366](https://github.com/just-the-docs/just-the-docs/pull/1366)
118
+ - Fixed: navigation scroll to active link regression by [@pdmosses](https://github.com/pdmosses) in [#1367](https://github.com/just-the-docs/just-the-docs/pull/1367)
119
+ - Fixed: invalid CSS rules in head elements by [@pdmosses](https://github.com/pdmosses) in [#1368](https://github.com/just-the-docs/just-the-docs/pull/1368)
120
+ - Fixed: accidental disabling of forward-declared stylesheets by [@mattxwang](https://github.com/mattxwang) in [#1373](https://github.com/just-the-docs/just-the-docs/pull/1373)
278
121
 
279
- - [@CarbonNeuron] made their first contribution in [#1360]
280
- - [@thapasusheel] made their first contribution in [#1377]
281
-
282
- [@CarbonNeuron]: https://github.com/CarbonNeuron
283
- [@thapasusheel]: https://github.com/thapasusheel
284
-
285
- [#1356]: https://github.com/just-the-docs/just-the-docs/pull/1356
286
- [#1358]: https://github.com/just-the-docs/just-the-docs/pull/1358
287
- [#1360]: https://github.com/just-the-docs/just-the-docs/pull/1360
288
- [#1366]: https://github.com/just-the-docs/just-the-docs/pull/1366
289
- [#1367]: https://github.com/just-the-docs/just-the-docs/pull/1367
290
- [#1368]: https://github.com/just-the-docs/just-the-docs/pull/1368
291
- [#1373]: https://github.com/just-the-docs/just-the-docs/pull/1373
292
- [#1377]: https://github.com/just-the-docs/just-the-docs/pull/1377
293
-
294
- ## Release v0.6.2
122
+ ### Documentation:
295
123
 
296
- 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.
124
+ - Docs: fix typos in `CHANGELOG` and `MIGRATION` by [@thapasusheel](https://github.com/thapasusheel) in [#1377](https://github.com/just-the-docs/just-the-docs/pull/1377)
297
125
 
298
- ### Bugfixes
126
+ ## v0.6.2 - 2023-09-19
299
127
 
300
- - Fixed: Windows emoji font fallback by [@flanakin] in [#1337]
301
- - Removed: unused `.passive` toggle in navigation by [@pdmosses] in [#1335]
128
+ ### Theme
302
129
 
303
- [#1335]: https://github.com/just-the-docs/just-the-docs/pull/1335
304
- [#1337]: https://github.com/just-the-docs/just-the-docs/pull/1337
130
+ - Fixed: Windows emoji font fallback by [@flanakin](https://github.com/flanakin) in [#1337](https://github.com/just-the-docs/just-the-docs/pull/1337)
131
+ - Removed: unused `.passive` toggle in navigation by [@pdmosses](https://github.com/pdmosses) in [#1335](https://github.com/just-the-docs/just-the-docs/pull/1335)
305
132
 
306
133
  ### New Contributors
307
134
 
308
- - [@flanakin] made their first contribution in [#1337]
309
-
310
- [@flanakin]: https://github.com/flanakin
311
-
312
- ## Release v0.6.1
313
-
314
- 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.
315
-
316
- ### Bugfixes
317
-
318
- - Fixed: JS error for pages excluded from navigation by [@pdmosses] in [#1332]
319
-
320
- [#1332]: https://github.com/just-the-docs/just-the-docs/pull/1332
321
-
322
- ## Release v0.6.0
323
-
324
- 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.
325
-
326
- ### Migrating to `v0.6.0`
327
-
328
- **Migration**: users will need to migrate if:
329
-
330
- - they have an existing `_includes` file named `favicon.html`, `head_nav.html`, or `css/activation.scss.liquid`
331
- - they have code that refers to `#main-content-wrap`
332
- - they override the default `light` theme's code, or the theme-loading logic
333
- - they have different favicons for different pages
334
-
335
- For more, refer to the [migration guide](https://just-the-docs.com/MIGRATION/).
336
-
337
- ### Using Release `v0.6.0`
338
-
339
- Users who have not pinned the theme version will be **automatically upgraded to `v0.6.0` the next time they build their site**.
135
+ - [@flanakin](https://github.com/flanakin) made their first contribution in [#1337](https://github.com/just-the-docs/just-the-docs/pull/1337)
340
136
 
341
- To use this release explicitly as a remote theme:
137
+ ## v0.6.1 - 2023-08-26
342
138
 
343
- ```yml
344
- remote_theme: just-the-docs/just-the-docs@v0.6.0
345
- ```
139
+ ### Theme
346
140
 
347
- 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`:
141
+ - Fixed: JS error for pages excluded from navigation by [@pdmosses](https://github.com/pdmosses) in [#1332](https://github.com/just-the-docs/just-the-docs/pull/1332)
348
142
 
349
- ```ruby
350
- gem "just-the-docs", "0.6.0"
351
- ```
143
+ ## v0.6.0 - 2023-08-19
352
144
 
353
- To use and pin a previous version of the theme, replace the `0.6.0` with the desired release tag.
145
+ {: .warning }
146
+ **Potentially Breaking Changes**: this version contains **potentially breaking changes** for a small set of users. For more information, refer to the [Migrating to v0.6.0 guide](https://just-the-docs.com/migration/#potentially-breaking-changes-in-v060).
354
147
 
355
- ### New Features and Bugfixes
148
+ ### Theme
356
149
 
357
- - Added: `$color-scheme` theme variable to specify `color-scheme` for `:root` by [@sigv] in [#1280]
358
- - Fixed: build times for large sites by [@pdmosses] in [#1244]
359
- - Fixed: missing closing `</button>` tag in `sidebar.html` by [@mattxwang] in [#1304]
360
- - Fixed: removed duplicate `#main-content-wrap` minimal and default layouts by [@mattxwang] in [#1305]
150
+ - Added: `$color-scheme` theme variable to specify `color-scheme` for `:root` by [@sigv](https://github.com/sigv) in [#1280](https://github.com/just-the-docs/just-the-docs/pull/1280)
151
+ - Fixed: build times for large sites by [@pdmosses](https://github.com/pdmosses) in [#1244](https://github.com/just-the-docs/just-the-docs/pull/1244)
152
+ - Fixed: missing closing `</button>` tag in `sidebar.html` by [@mattxwang](https://github.com/mattxwang) in [#1304](https://github.com/just-the-docs/just-the-docs/pull/1304)
153
+ - Fixed: removed duplicate `#main-content-wrap` minimal and default layouts by [@mattxwang](https://github.com/mattxwang) in [#1305](https://github.com/just-the-docs/just-the-docs/pull/1305)
361
154
 
362
155
  ### Documentation
363
156
 
364
- {: .warning }
365
- The theme docs are unversioned, and already reflect the above changes.
366
-
367
- Docs changes:
368
-
369
157
  - 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.
370
158
  - Invalid HTML has been removed from most documentation examples.
371
159
 
372
- ### New Contributors
373
-
374
- - [@sigv] made their first contribution in [#1280]
375
-
376
- [@sigv]: https://github.com/sigv
377
- [#1244]: https://github.com/just-the-docs/just-the-docs/pull/1244
378
- [#1280]: https://github.com/just-the-docs/just-the-docs/pull/1280
379
- [#1304]: https://github.com/just-the-docs/just-the-docs/pull/1304
380
- [#1305]: https://github.com/just-the-docs/just-the-docs/pull/1305
381
-
382
- ## Release v0.5.4
160
+ ## v0.5.4 - 2023-07-04
383
161
 
384
- 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.
162
+ ### Theme
385
163
 
386
- *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.*
387
-
388
- ### Bugfixes
164
+ - Fixed: Mermaid labels inheriting theme `.label` styling by [@mattxwang](https://github.com/mattxwang) in [#1278](https://github.com/just-the-docs/just-the-docs/pull/1278)
389
165
 
390
- - Fixed: Mermaid labels inheriting theme `.label` styling by [@mattxwang] in [#1278]
166
+ ## v0.5.3 - 2023-06-17
391
167
 
392
- [#1278]: https://github.com/just-the-docs/just-the-docs/pull/1278
168
+ ### Theme
393
169
 
394
- ## Release v0.5.3
170
+ - Fixed: font-size scaling for text-related CSS properties by using `rem` instead of fixed `px` values; deprecate `$root-font-size` by [@mattxwang](https://github.com/mattxwang) in [#1169](https://github.com/just-the-docs/just-the-docs/pull/1169)
395
171
 
396
- 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:
172
+ ## v0.5.2 - 2023-06-07
397
173
 
398
- 1. All deprecation warnings are now fixed on build; you should now get a clean build with `jekyll build`.
399
- 2. We have **deprecated the `$root-font-size` SCSS variable**. We will remove it in an upcoming release of the theme.
174
+ ### Theme
400
175
 
401
- 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.
402
-
403
- ### Using Release `v0.5.3`
404
-
405
- Users who have not pinned the theme version will be **automatically upgraded to `v0.5.3` the next time they build their site**.
406
-
407
- To use this release explicitly as a remote theme:
408
-
409
- ```yml
410
- remote_theme: just-the-docs/just-the-docs@v0.5.3
411
- ```
412
-
413
- 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`:
414
-
415
- ```ruby
416
- gem "just-the-docs", "0.5.3"
417
- ```
418
-
419
- To use and pin a previous version of the theme, replace the `0.5.3` with the desired release tag.
420
-
421
- ### Bugfixes
176
+ - Fixed: liquid variable leakage in navigation components by [@pdmosses](https://github.com/pdmosses) in [#1243](https://github.com/just-the-docs/just-the-docs/pull/1243)
177
+ - Fixed: ARIA roles and labels for search, header, logo, mobile menu button, and main content by [@joelhawksley](https://github.com/joelhawksley) in [#1259](https://github.com/just-the-docs/just-the-docs/pull/1259)
178
+ - Fixed: ARIA labels for all anchors with `href="#"`; adds `aria-pressed` information for toggles by [@mattxwang](https://github.com/mattxwang) in [#1262](https://github.com/just-the-docs/just-the-docs/pull/1262)
422
179
 
423
- - 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]
180
+ ## v0.5.1 - 2023-04-25
424
181
 
425
- [#1169]: https://github.com/just-the-docs/just-the-docs/pull/1169
182
+ ### Theme
426
183
 
427
- ## Release v0.5.2
428
-
429
- 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.
430
-
431
- 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!
432
-
433
- ### Using Release `v0.5.2`
434
-
435
- Users who have not pinned the theme version will be **automatically upgraded to `v0.5.2` the next time they build their site**.
436
-
437
- To use this release explicitly as a remote theme:
438
-
439
- ```yml
440
- remote_theme: just-the-docs/just-the-docs@v0.5.2
441
- ```
442
-
443
- 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`:
444
-
445
- ```ruby
446
- gem "just-the-docs", "0.5.2"
447
- ```
448
-
449
- To use and pin a previous version of the theme, replace the `0.5.2` with the desired release tag.
450
-
451
- ### Bugfixes
452
-
453
- - Fixed: liquid variable leakage in navigation components by [@pdmosses] in [#1243]
454
- - Fixed: ARIA roles and labels for search, header, logo, mobile menu button, and main content by [@joelhawksley] in [#1259]
455
- - Fixed: ARIA labels for all anchors with `href="#"`; adds `aria-pressed` information for toggles by [@mattxwang] in [#1262]
456
-
457
- ### New Contributors
458
-
459
- - [@joelhawksley] made their first contribution in [#1259]
460
-
461
- [@joelhawksley]: https://github.com/joelhawksley
462
-
463
- [#1243]: https://github.com/just-the-docs/just-the-docs/pull/1243
464
- [#1259]: https://github.com/just-the-docs/just-the-docs/pull/1259
465
- [#1262]: https://github.com/just-the-docs/just-the-docs/pull/1262
466
-
467
- ## Release v0.5.1
468
-
469
- 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.
470
-
471
- As always, we'd love your feedback. [Open an issue](https://github.com/just-the-docs/just-the-docs/issues) or [start a discussion](https://github.com/just-the-docs/just-the-docs/discussions) for bug reports, feature requests, and any other feedback. Thanks for continuing to use Just the Docs!
472
-
473
- ### Using Release `v0.5.1`
474
-
475
- Users who have not pinned the theme version will be **automatically upgraded to `v0.5.1` the next time they build their site**.
476
-
477
- To use this release explicitly as a remote theme:
478
-
479
- ```yml
480
- remote_theme: just-the-docs/just-the-docs@v0.5.1
481
- ```
482
-
483
- 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`:
484
-
485
- ```ruby
486
- gem "just-the-docs", "0.5.1"
487
- ```
488
-
489
- To use and pin a previous version of the theme, replace the `0.5.1` with the desired release tag.
490
-
491
- ### Bugfixes
492
-
493
-
494
- - Fixed: disable copy code button in insecure contexts [@rmoff] in [#1226]
495
- - Fixed: context-based media feature not supported by Safari `<16.4` by [@mattxwang] in [#1240]
184
+ - Fixed: disable copy code button in insecure contexts [@rmoff](https://github.com/rmoff) in [#1226](https://github.com/just-the-docs/just-the-docs/pull/1226)
185
+ - Fixed: context-based media feature not supported by Safari `<16.4` by [@mattxwang](https://github.com/mattxwang) in [#1240](https://github.com/just-the-docs/just-the-docs/pull/1240)
496
186
 
497
187
  ### Documentation
498
188
 
499
- - Added: document copy code button requiring secure context by [@rmoff] in [#1225]
500
- - Fixed: typo ("them" → "theme") in MIGRATION.md by [@waldyrious] in [#1219]
501
- - Fixed: `font-weight` typo (Utilities > Typography) by [@mattxwang] in [#1229]
502
- - Fixed: `just the docs` typo in migration guide by [@mattxwang] in [#1230]
503
-
504
- ### New Contributors
505
- - [@rmoff] made their first contribution in [#1225]
506
-
507
- [#1219]: https://github.com/just-the-docs/just-the-docs/pull/1219
508
- [#1225]: https://github.com/just-the-docs/just-the-docs/pull/1225
509
- [#1226]: https://github.com/just-the-docs/just-the-docs/pull/1226
510
- [#1229]: https://github.com/just-the-docs/just-the-docs/pull/1229
511
- [#1230]: https://github.com/just-the-docs/just-the-docs/pull/1230
512
- [#1240]: https://github.com/just-the-docs/just-the-docs/pull/1240
513
-
514
- [@rmoff]: https://github.com/rmoff
515
-
516
- ## Release v0.5.0
517
-
518
- Hope your April is going well! This new release of Just the Docs is relatively minor. It has one **breaking change**: we've reverted the import order of `setup.scss` to be *before* color schemes. In addition, we include two requested fixes: color contrast issues with `::selection` and using Just the Docs with mermaid versions `>=10`.
519
-
520
- We've marked this as a minor version bump due to the breaking change. In the next section, we briefly outline what migration steps should be. Users who did not migrate to `v0.4.2` or who do not have a custom `setup.scss` are guaranteed no breaking changes.
189
+ - Added: document copy code button requiring secure context by [@rmoff](https://github.com/rmoff) in [#1225](https://github.com/just-the-docs/just-the-docs/pull/1225)
190
+ - Fixed: typo ("them" → "theme") in MIGRATION.md by [@waldyrious](https://github.com/waldyrious) in [#1219](https://github.com/just-the-docs/just-the-docs/pull/1219)
191
+ - Fixed: `font-weight` typo (Utilities > Typography) by [@mattxwang](https://github.com/mattxwang) in [#1229](https://github.com/just-the-docs/just-the-docs/pull/1229)
192
+ - Fixed: `just the docs` typo in migration guide by [@mattxwang](https://github.com/mattxwang) in [#1230](https://github.com/just-the-docs/just-the-docs/pull/1230)
521
193
 
522
- As always, we'd love your feedback. [Open an issue](https://github.com/just-the-docs/just-the-docs/issues) or [start a discussion](https://github.com/just-the-docs/just-the-docs/discussions) for bug reports, feature requests, and any other feedback. Thanks for continuing to use Just the Docs!
194
+ ## v0.5.0 - 2023-04-12
523
195
 
524
- ### Migrating to `v0.5.0`
525
-
526
- **Migration**: users with a custom `setup.scss` cannot rely on variables or functions defined in `color_scheme`. This reverts to the behaviour in `v0.4.1`. Users should instead move those variables or functions to the `color_scheme` files themselves.
527
-
528
- For more, refer to the [migration guide](https://just-the-docs.com/MIGRATION/).
529
-
530
- ### Using Release `v0.5.0`
531
-
532
- Users who have not pinned the theme version will be **automatically upgraded to `v0.5.0` the next time they build their site**.
533
-
534
- To use this release explicitly as a remote theme:
535
-
536
- ```yml
537
- remote_theme: just-the-docs/just-the-docs@v0.5.0
538
- ```
539
-
540
- 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`:
541
-
542
- ```ruby
543
- gem "just-the-docs", "0.5.0"
544
- ```
545
-
546
- To use and pin a previous version of the theme, replace the `0.5.0` with the desired release tag.
547
-
548
- ### Bugfixes
549
-
550
- - **Reverted (breaking)**: "Fix import order for `setup.scss` (#1184)" by [@mattxwang] in [#1209]
551
- - Fixed: color contrast issues with `::selection` (reverting to browser defaults) [@mattxwang] in [#1208]
552
- - Fixed: mermaid `v10`, bundle all mermaid code in component by [@mattxwang] in [#1190]
553
- - Removed: unused images (`just-the-docs.png`, `search.svg`) by [@mattxwang] in [#1107]
554
- - Removed: `CODE_OF_CONDUCT`, `docker-compose`, and `Dockerfile` files from site by [@mattxwang] in [#1187]
555
-
556
- **Full Changelog**: [https://github.com/just-the-docs/just-the-docs/compare/v0.4.2...v0.5.0](https://github.com/just-the-docs/just-the-docs/compare/v0.4.2...v0.5.0)
557
-
558
- [#1107]: https://github.com/just-the-docs/just-the-docs/pull/1107
559
- [#1187]: https://github.com/just-the-docs/just-the-docs/pull/1187
560
- [#1190]: https://github.com/just-the-docs/just-the-docs/pull/1190
561
- [#1208]: https://github.com/just-the-docs/just-the-docs/pull/1208
562
- [#1209]: https://github.com/just-the-docs/just-the-docs/pull/1209
563
-
564
- ## Release v0.4.2
565
-
566
- Hello! We're back again with another small release. Like `v0.4.1`, this release is a [semver patch](https://semver.org/): it only includes bugfixes, and is fully backwards-compatible.
567
-
568
- The big highlight of this theme is fixing our light scheme code highlighting contrast issues; this was one of our most-requested features! This change is fully backwards-compatible; users can [opt-in to our old highlighting theme](https://just-the-docs.com/docs/customization/#deprecated-legacy_light) by using `legacy_light` instead of `light`.
569
-
570
- As always, we'd love your feedback. [Open an issue](https://github.com/just-the-docs/just-the-docs/issues) or [start a discussion](https://github.com/just-the-docs/just-the-docs/discussions) for bug reports, feature requests, and any other feedback. Thanks for continuing to use Just the Docs!
571
-
572
- ### Using Release `v0.4.2`
573
-
574
- Users who have not pinned the theme version will be **automatically upgraded to `v0.4.2` the next time they build their site**.
575
-
576
- To use this release explicitly as a remote theme:
196
+ {: .warning }
197
+ **Potentially Breaking Changes**: this version contains **potentially breaking changes** for a small set of users. For more information, refer to the [Migrating to v0.5.0 guide](https://just-the-docs.com/migration/#potentially-breaking-changes-in-v050).
577
198
 
578
- ```yml
579
- remote_theme: just-the-docs/just-the-docs@v0.4.2
580
- ```
199
+ ### Theme
581
200
 
582
- 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`:
201
+ - **Reverted (breaking)**: "Fix import order for `setup.scss` (#1184)" by [@mattxwang](https://github.com/mattxwang) in [#1209](https://github.com/just-the-docs/just-the-docs/pull/1209)
202
+ - Fixed: color contrast issues with `::selection` (reverting to browser defaults) [@mattxwang](https://github.com/mattxwang) in [#1208](https://github.com/just-the-docs/just-the-docs/pull/1208)
203
+ - Fixed: mermaid `v10`, bundle all mermaid code in component by [@mattxwang](https://github.com/mattxwang) in [#1190](https://github.com/just-the-docs/just-the-docs/pull/1190)
204
+ - Removed: unused images (`just-the-docs.png`, `search.svg`) by [@mattxwang](https://github.com/mattxwang) in [#1107](https://github.com/just-the-docs/just-the-docs/pull/1107)
205
+ - Removed: `CODE_OF_CONDUCT`, `docker-compose`, and `Dockerfile` files from site by [@mattxwang](https://github.com/mattxwang) in [#1187](https://github.com/just-the-docs/just-the-docs/pull/1187)
583
206
 
584
- ```ruby
585
- gem "just-the-docs", "0.4.2"
586
- ```
207
+ ## v0.4.2 - 2023-03-14
587
208
 
588
- To use and pin a previous version of the theme, replace the `0.4.2` with the desired release tag.
209
+ ### Theme
589
210
 
590
- ### Bugfixes
591
-
592
- - Fixed: light scheme code highlighting contrast issues; updated to use Atom's One Light colors, consolidate theme variables by [@mattxwang] in [#1166]
593
- - Fixed: duplicate import of `color_schemes` by [@mattxwang] in [#1173]
594
- - Fixed: import order for `setup.scss` by [@mattxwang] in [#1184]
595
- - Removed: unused dark syntax themes by [@mattxwang] in [#1192]
211
+ - Fixed: light scheme code highlighting contrast issues; updated to use Atom's One Light colors, consolidate theme variables by [@mattxwang](https://github.com/mattxwang) in [#1166](https://github.com/just-the-docs/just-the-docs/pull/1166)
212
+ - Fixed: duplicate import of `color_schemes` by [@mattxwang](https://github.com/mattxwang) in [#1173](https://github.com/just-the-docs/just-the-docs/pull/1173)
213
+ - Fixed: import order for `setup.scss` by [@mattxwang](https://github.com/mattxwang) in [#1184](https://github.com/just-the-docs/just-the-docs/pull/1184)
214
+ - Removed: unused dark syntax themes by [@mattxwang](https://github.com/mattxwang) in [#1192](https://github.com/just-the-docs/just-the-docs/pull/1192)
596
215
 
597
216
  ### Documentation
598
217
 
599
- - Added: docs for using mermaid with AsciiDoc by [@flyx] in [#1182]
600
-
601
- **Full Changelog**: [https://github.com/just-the-docs/just-the-docs/compare/v0.4.1...v0.4.2](https://github.com/just-the-docs/just-the-docs/compare/v0.4.1...v0.4.2)
602
-
603
- [#1166]: https://github.com/just-the-docs/just-the-docs/pull/1166
604
- [#1173]: https://github.com/just-the-docs/just-the-docs/pull/1173
605
- [#1182]: https://github.com/just-the-docs/just-the-docs/pull/1182
606
- [#1184]: https://github.com/just-the-docs/just-the-docs/pull/1184
607
- [#1192]: https://github.com/just-the-docs/just-the-docs/pull/1192
608
-
609
- ## Release v0.4.1
610
-
611
- Hello! We hope you've been enjoying the new `v0.4.0`; we appreciate all the feedback we've gotten already! As promised, future releases will be small with simple steps to upgrade. This is one of them! `v0.4.1` is a [semver patch](https://semver.org/): it only includes bugfixes, and is fully backwards-compatible.
612
-
613
- As always, we'd love your feedback. [Open an issue](https://github.com/just-the-docs/just-the-docs/issues) or [start a discussion](https://github.com/just-the-docs/just-the-docs/discussions) for bug reports, feature requests, and any other feedback. Thanks for continuing to use Just the Docs!
614
-
615
- ### Using Release `v0.4.1`
218
+ - Added: docs for using mermaid with AsciiDoc by [@flyx](https://github.com/flyx) in [#1182](https://github.com/just-the-docs/just-the-docs/pull/1182)
616
219
 
617
- Users who have not pinned the theme version will be **automatically upgraded to `v0.4.1` the next time they build their site**.
220
+ ## v0.4.1 - 2023-02-23
618
221
 
619
- To use this release explicitly as a remote theme:
222
+ ### Theme
620
223
 
621
- ```yml
622
- remote_theme: just-the-docs/just-the-docs@v0.4.1
623
- ```
624
-
625
- 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`:
626
-
627
- ```ruby
628
- gem "just-the-docs", "0.4.1"
629
- ```
630
-
631
- To use and pin a previous version of the theme, replace the `0.4.1` with the desired release tag.
632
-
633
- ### Bugfixes
634
-
635
- - Fixed: allow later versions of `bundler` by [@mattxwang] in [#1165]
636
- - Fixed: AsciiDoc code block styling by [@flyx] in [#1168]
637
- - Fixed: main content negative margin for viewports in `[$md, $nav-width + $content-width]` by [@Dima-369] in [#1177]
638
- - Removed: unused `OneDarkJekyll` files by [@mattxwang] in [#1167]
224
+ - Fixed: allow later versions of `bundler` by [@mattxwang](https://github.com/mattxwang) in [#1165](https://github.com/just-the-docs/just-the-docs/pull/1165)
225
+ - Fixed: AsciiDoc code block styling by [@flyx](https://github.com/flyx) in [#1168](https://github.com/just-the-docs/just-the-docs/pull/1168)
226
+ - Fixed: main content negative margin for viewports in `[$md, $nav-width + $content-width]` by [@Dima-369](https://github.com/Dima-369) in [#1177](https://github.com/just-the-docs/just-the-docs/pull/1177)
227
+ - Removed: unused `OneDarkJekyll` files by [@mattxwang](https://github.com/mattxwang) in [#1167](https://github.com/just-the-docs/just-the-docs/pull/1167)
639
228
 
640
229
  ### Documentation
641
230
 
642
- - Fixed: re-add `jekyll-github-metadata` to docs site by [@mattxwang] in [#1108]
643
-
644
- ### New Contributors
645
-
646
- - [@flyx] made their first contribution in [#1168]
647
- - [@Dima-369] made their first contribution in [#1177]
648
-
649
- [#1108]: https://github.com/just-the-docs/just-the-docs/pull/1108
650
- [#1165]: https://github.com/just-the-docs/just-the-docs/pull/1165
651
- [#1167]: https://github.com/just-the-docs/just-the-docs/pull/1167
652
- [#1168]: https://github.com/just-the-docs/just-the-docs/pull/1168
653
- [#1177]: https://github.com/just-the-docs/just-the-docs/pull/1177
654
-
655
- [@flyx]: https://github.com/flyx
656
- [@Dima-369]: https://github.com/Dima-369
231
+ - Fixed: re-add `jekyll-github-metadata` to docs site by [@mattxwang](https://github.com/mattxwang) in [#1108](https://github.com/just-the-docs/just-the-docs/pull/1108)
657
232
 
658
233
  **Full Changelog**: [https://github.com/just-the-docs/just-the-docs/compare/v0.4.0...v0.4.1](https://github.com/just-the-docs/just-the-docs/compare/v0.4.0...v0.4.1)
659
234
 
660
- ## Release v0.4.0
661
-
662
- 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.
663
-
664
- ### Brief Overview - Highlighted Changes
665
-
666
- `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:
667
-
668
- - better support for dark theme: dark highlighting, search input color
669
- - [callouts](https://just-the-docs.com/docs/ui-components/callouts/), a new design component to highlight content
670
- - [configuring mermaid.js](https://just-the-docs.com/docs/ui-components/code/#mermaid-diagram-code-blocks), a markdown-native diagram visualization library
671
- - [copy code button](https://just-the-docs.com/docs/ui-components/code/#copy-button) for code snippets
672
- - external navigation links
673
- - major improvements to nav generation efficiency and robustness
674
- - minor improvements to built-in accessibility (SVG icons, nav titles, skip to main content)
675
- - [modularized site components](https://just-the-docs.com/docs/customization/#custom-layouts-and-includes) (advanced feature)
676
- - [new custom includes](https://just-the-docs.com/docs/customization/#override-includes): table of contents heading, navigation panel footer, search placeholder, lunr search indices
677
- - bugfixes involving WEBrick and Ruby 3, Liquid processing in CSS comments, nested task lists, relative URLs, scroll navigation, corrupted search data from rake, breadcrumbs, and more!
678
- - more documentation for [custom includes](https://just-the-docs.com/docs/customization/#override-includes), this changelog, and the [migration guide](https://just-the-docs.com/MIGRATION/)
679
-
680
- *After usage instructions and the roadmap, we enumerate all changes from `v0.3.3`.*
681
-
682
- ### Using Release `v0.4.0`
683
-
684
- 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**.
685
-
686
- To use this release explicitly as a remote theme:
687
-
688
- ```yml
689
- remote_theme: just-the-docs/just-the-docs@v0.4.0
690
- ```
691
-
692
- 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`:
693
-
694
- ```ruby
695
- gem "just-the-docs", "0.4.0"
696
- ```
697
-
698
- If you would prefer to not upgrade, you can enforce that explicitly:
699
-
700
- 1. pin your gem version in your `Gemfile`, like so
701
- ```ruby
702
- gem "just-the-docs", "0.3.3"
703
- ```
704
- 2. freeze the `remote_theme`, like so
705
- ```yml
706
- remote_theme: just-the-docs/just-the-docs@v0.3.3
707
- ```
708
-
709
- ### Migration Guide and Strategies
710
-
711
- We've developed a new [migration guide](https://just-the-docs.com/MIGRATION/) for users to migrate from version `v0.3.3` to `v0.4.0`. It outlines major changes in project maintenance (e.g. new repository link, team) as well as breaking changes that may break your site (and potential solutions). We suggest that all users refer to the guide before manually upgrading their site.
712
-
713
- **For the vast majority of users, we do not anticipate that this will be a breaking change.** The major touch points are surrounding new includes, navigation (ordering, pages, and collections), the favicon, and a shift to relative URLs. However, users who heavily customize the theme (primarily by overriding includes) will likely have to make minor changes.
714
-
715
- Given the length of features added in this release, users may want to incrementally upgrade through the pre-releases. To follow this approach, read this changelog from `v0.4.0.rc1` to `v0.4.0.rc5`; this breaks down the release into small chunks, each of which should be easier to upgrade. `v0.4.0.rc5` is identical to this release.
716
-
717
- For support with migrating to `v0.4.0`, [open an issue](https://github.com/just-the-docs/just-the-docs/issues) or [start a discussion](https://github.com/just-the-docs/just-the-docs/discussions) and let us know!
235
+ ## v0.4.0 - 2023-02-05
718
236
 
719
- ### Roadmap (What's Next?)
720
-
721
- Moving forward, we plan to release more frequently with smaller, bite-sized changes. This should make it easier for users to upgrade in the future!
722
-
723
- Broadly, many features are still on the radar. We anticipate the rest of `v0.4.x` to be bugfixes surrounding this new release.
724
-
725
- For version `v0.5`, our roadmap includes:
726
-
727
- - a theme toggle (light/dark mode), with automatic theme switching based on browser preferences
728
- - better GDPR compliance for analytics
729
- - multi-level/recursive navigation (unlimited hierarchy of child pages)
730
-
731
- In future versions, we also plan on:
732
-
733
- - adding better dark theme defaults
734
- - adding better internationalization support
735
- - exploring offline PDF generation
736
- - improving accessibility within the theme
737
- - improving search functionality
738
- - refactoring and improving the robustness of our codebase
739
-
740
- Have ideas for what's next, or want to get involved? [Open an issue](https://github.com/just-the-docs/just-the-docs/issues) or [start a discussion](https://github.com/just-the-docs/just-the-docs/discussions) and let us know! We're looking for more contributors and maintainers to help us develop the theme.
741
-
742
- ### New Features
237
+ {: .note }
238
+ The project underwent a large maintenance shift in 2022; `0.4.0` is the first release from the new team.
743
239
 
744
- - Added: Combination by [@pdmosses] in [#578]
745
- - Added: dark highlighting in [#463]
746
- - Added: pages and collections in [#448]
747
- - Added: callouts in [#466]
748
- - Fixed: breadcrumb behaviour … by [@AdityaTiwari2102] in [#477]
749
- - Fixed: prevent rake command corrupting search data in [#495] (also listed below)
750
- - Fixed: nested lists in [#496]
751
- - Fixed: set color for search input in [#498] (also listed below)
240
+ {: .note }
241
+ This PR combines the last 5 release candidates (from `0.4.0.rc1` to `0.4.0.rc5`).
242
+
243
+ - Added: Combination by [@pdmosses](https://github.com/pdmosses) in [#578](https://github.com/just-the-docs/just-the-docs/pull/578)
244
+ - Added: dark highlighting in [#463](https://github.com/just-the-docs/just-the-docs/pull/463)
245
+ - Added: pages and collections in [#448](https://github.com/just-the-docs/just-the-docs/pull/448)
246
+ - Added: callouts in [#466](https://github.com/just-the-docs/just-the-docs/pull/466)
247
+ - Fixed: breadcrumb behaviour … by [@AdityaTiwari2102](https://github.com/AdityaTiwari2102) in [#477](https://github.com/just-the-docs/just-the-docs/pull/477)
248
+ - Fixed: prevent rake command corrupting search data in [#495](https://github.com/just-the-docs/just-the-docs/pull/495) (also listed below)
249
+ - Fixed: nested lists in [#496](https://github.com/just-the-docs/just-the-docs/pull/496)
250
+ - Fixed: set color for search input in [#498](https://github.com/just-the-docs/just-the-docs/pull/498) (also listed below)
752
251
  - Fixed: sites with no child pages (no PR)
753
- - Fixed: TOC/breadcrumbs for multiple collections in [#494]
252
+ - Fixed: TOC/breadcrumbs for multiple collections in [#494](https://github.com/just-the-docs/just-the-docs/pull/494)
754
253
  - Added: collection configuration option `nav_fold` (no PR)
755
254
  - Fixed: indentation and color for folded collection navigation (no PR)
756
- - Fixed: scroll navigation to show the link to the current page in [#639]
757
- - Fixed: Replace all uses of `absolute_url` by `relative_url`, by [@svrooij] in [#544]
758
- - Added: custom favicon `_includes` by [@burner1024] in [#364]
759
- - Added: set color for search input by [@pdmosses] in [#498]
760
- - Added: search placeholder configuration by [@mattxwang] in [#613]
761
- - Added: 'child_nav_order' front matter to be able to sort navigation pages in reverse by [@jmertic] in [#726]
762
- - Added: `nav_footer_custom` include by [@nathanjessen] in [#474]
763
- - Added: style fixes for jekyll-asciidoc by [@alyssais] in [#829]
764
- - Added: mermaid.js support by [@nascosto] in [#857]
765
- - Added: support for external navigation links by [@SPGoding] in [#876]
766
- - Added: refactor `mermaid` config to use `mermaid_config.js` include, only require `mermaid.version` in `_config.yml` by [@mattxwang] in [#909]
767
- - Added: accessible titles to nested page nav toggle by [@JPrevost] in [#950]
768
- - Added: better title styling for AsciiDoc examples by [@alyssais] in [#944]
769
- - Added: docs for custom search placeholder by [@mattxwang] in [#939]
770
- - Added: provide ability to skip to main content by [@JPrevost] in [#949]
771
- - Added: styling for `<blockquote>` by [@mattxwang] in [#965]
772
- - Added: custom include for TOC heading by [@pdmosses] in [#980]
773
- - Added: experimental nav optimization for simple cases by [@pdmosses] in [#992]
774
- - Added: support multiple Google Analytics tracking IDs, document UA -> GA4 switch by [@MichelleBlanchette] in [#1029]
775
- - Added: copy code button to code snippets by [@simonebortolin] in [#945]
776
- - Added: restore simple configuration of `favicon.ico` via `site.static_files` by [@pdmosses] in [#1095]
777
- - Added: modularize site components by [@mattxwang] in [#1058]
778
- - Added: includes for custom `lunr` Liquid and JS code by [@diablodale] in [#1068]
779
- - Added: new `_sass/custom/setup.scss` for variable definition by [@mattxwang] in [#1135]
780
- - Added: configuration key to load a local version of mermaid by [@fabrik42] in [#1153]
781
-
782
- ### Bugfixes
783
-
784
- - Fixed: prepend `site.collections_dir` if exists by [@alexsegura] in [#519]
785
- - Fixed: nested task lists (#517) by [@pdmosses] in [#855]
786
- - Fixed: suppress Liquid processing in CSS comments by [@pdmosses] in [#686]
787
- - Fixed: prevent rake command from corrupting search data by [@pdmosses] in [#495]
788
- - Fixed: anchor heading links should be visible on focus by [@jacobhq] in [#846]
789
- - Fixed: add `overflow-x: auto` to `figure.highlight` by [@iridazzle] in [#727]
790
- - Fixed: add `overflow-wrap: word-break` to `body` by [@iridazzle] in [#889]
791
- - Fixed: vertical alignment for consecutive labels by [@Eisverygoodletter] in [#893]
792
- - Fixed: allow links to wrap by [@pdmosses] in [#905]
793
- - Fixed: nav scroll feature and absolute/relative URLs by [@pdmosses] in [#898]
794
- - Fixed: exclude `vendor/` in Jekyll config by [@manuelhenke] in [#941]
795
- - Fixed: improve build time of navigation panel by [@pdmosses] in [#956]
796
- - Fixed: spacing issue when search is disabled by [@henryiii] in [#960]
797
- - Fixed: active grandchild link class by [@pdmosses] in [#962]
798
- - Fixed: HTML validation issues (W3C validator) by [@mattxwang] in [#964]
799
- - Fixed: link styling now uses `text-decoration` values by [@mattxwang] in [#967]
800
- - Fixed: cleaning up Jekyll excludes by [@pdmosses] in [#985]
801
- - Fixed: docs, narrow styling for code highlighting with line numbers by [@pdmosses] in [#974]
802
- - Fixed: default syntax highlighting in custom color schemes [@pdmosses] in [#986]
803
- - Fixed: incorrect disambiguation in generated TOCs by [@pdmosses] in [#999]
804
- - Fixed: duplicated external links in collections by [@pdmosses] in [#1001]
805
- - Fixed: import order of `custom.scss`; puts at end by [@deseo] in [#1010]
806
- - Fixed: top-level active link styling by [@pdmosses] in [#1015]
807
- - Fixed: external links for sites with no pages by [@pdmosses] in [#1021]
808
- - Fixed: duplicate `title` if `jekyll-seo-tag` not in users's plugins by [@Tom-Brouwer] in [#1040]
809
- - Fixed: removes (duplicate) `favicon.html`, shifts content to `head_custom.html` by [@mattxwang] in [#1027]
810
- - Fixed: add `reversed`, deprecate `desc` for nav `child_nav_order` by [@jmertic] in [#1061]
811
- - Fixed: `child.child_nav_order` to `node.child_nav_order` by [@mattxwang] in [#1065]
812
- - Fixed: remove all uses of `/` as SASS division by [@mattxwang] in [#1074]
813
- - note: this was originally merged as [#1074] with a bug; it was reverted in [#1076], and then reimplemented in [#1077]
814
- - Fixed: skip nav collection generation when site has no pages by [@pdmosses] in [#1092]
815
- - Fixed: standardize SCSS with `declaration-block-no-redundant-longhand-properties` by [@simonebortolin] in [#1102]
816
- - Fixed: incorrect `padding` property value pair in `labels.scss` by [@SConaway] in [#1104]
817
- - Fixed: various bugs with copy code button by [@simonebortolin] in [#1096]
818
- - Fixed: replace inline styling for `<svg>` icons by [@captn3m0] in [#1110]
819
- - Fixed: incorrect `padding` property value pair in `search.scss` by [@kevinlin1] in [#1123]
820
- - Fixed: minor spacing and comment nits by [@EricFromCanada] in [#1128]
821
- - Fixed: exclude images from being bundled with gem by [@m-r-mccormick] in [#1142]
822
- - Fixed: dark theme code block background, line number colors by [@m-r-mccormick] in [#1124]
823
- - Fixed: copy code button interaction with kramdown line numbers by [@mattxwang] in [#1143]
824
-
825
- ### Maintenance
826
-
827
- - Added: VScode devcontainer by [@max06] in [#783]
828
- - Added: `webrick` to `Gemfile` by [@mattxwang] in [#799]
829
- - Added: 'This site is powered by Netlify.' to the footer by [@mattxwang] in [#797]
830
- - Updated: new repo path by [@pmarsceill] in [#775]
831
- - Updated: rename `master` -> `main` by [@pmarsceill] in [#776]
832
- - Updated: README by [@pmarsceill] in [#777]
833
- - Updated: Code of Conduct to Contributor Covenant v2.1 by [@mattxwang] in [#790]
834
- - Updated: CI files, Ruby & Node Versions by [@mattxwang] in [#820]
835
- - Updated: Stylelint to v14, extend SCSS plugins, remove primer-* configs, resolve issues by [@mattxwang] in [#821]
836
- - Deleted: unused script directory by [@mattxwang] in [#937]
837
- - Vendor: update `jekyll-anchor-headings`, `lunr.js` by [@mattxwang] in [#1071]
838
-
839
- ### Documentation
840
-
841
- - Added: docs on how to break an `ol` by [@pdmosses] in [#856]
842
- - Added: docs for custom includes by [@nathanjessen] in [#806]
843
- - Added: document caveat about variable dependencies by [@waldyrious] in [#555]
844
- - Added: docs on how to use `custom_head` to add a custom favicon by [@UnclassedPenguin] in [#814]
845
- - Added: docs load mermaid.js by default by [@mattxwang] in [#935]
846
- - Added: warning about mandatory `_`-prefix for collections by [@max06] in [#1091]
847
- - Added: migration guide by [@pdmosses] in [#1059]
848
- - Added: label new features introduced in `v0.4` by [@mattxwang] in [#1138]
849
- - Fixed: `ol` on `index.md` by [@pmarsceill] in [#778]
850
- - Fixed: image link in Markdown kitchen sink by [@JeffGuKang] in [#221]
851
- - Fixed: images in Markdown kitchen sink by [@dougaitken] in [#782]
852
- - Fixed: clearer label of link to Jekyll quickstart by [@waldyrious] in [#549]
853
- - Fixed: remove extra spaces in component docs by [@MichelleBlanchette] in [#554]
854
- - Fixed: double "your" typo in `index.md` by [@sehilyi] in [#499]
855
- - Fixed: "you" -> "your" typo in `index.md` by [@nathanjessen] in [#473]
856
- - Fixed: spacing in toc example by [@henryiii] in [#835]
857
- - Fixed: typo in `README` on `_config.yml` by [@ivanskodje] in [#891]
858
- - Fixed: missing code fence in navigation structure docs by [@mattxwang] in [#906]
859
- - Fixed: table of contents on search docs by [@robinpokorny] in [#940]
860
- - Fixed: broken docs link (custom footer) by [@olgarithms] in [#951]
861
- - Fixed: clarify version docs by [@pdmosses] in [#955]
862
- - Fixed: typo in changelog links [@koppor] in [#1000]
863
- - Fixed: two bugs in "Customization" (custom favicon, new annotation) by [@mattxwang] in [#1090]
864
- - Fixed: "View Typography Utilities" link by [@agabrys] in [#1130]
865
- - Fixed: broken relative page links by [@mattxwang] in [#1106]
866
- - Fixed: clarify steps to add custom `lunr` index code by [@diablodale] in [#1139]
867
- - Updated: homepage (focus: new features, conciseness, deduplication) by [@pdmosses] in [#1018]
868
- - Updated: README (focus: new features, conciseness, deduplication) by [@pdmosses] in [#1019]
869
- - Updated: `README` demo video by [@codewithfan] in [#1097]
870
-
871
- ### New Contributors
872
-
873
- - [@AdityaTiwari2102] made their first contribution in [#477]
874
- - [@svrooij] made their first contribution in [#544]
875
- - [@alexsegura] made their first contribution in [#519]
876
- - [@burner1024] made their first contribution in [#364]
877
- - [@JeffGuKang] made their first contribution in [#221]
878
- - [@dougaitken] made their first contribution in [#782]
879
- - [@max06] made their first contribution in [#783]
880
- - [@sehilyi] made their first contribution in [#499]
881
- - [@nathanjessen] made their first contribution in [#473]
882
- - [@waldyrious] made their first contribution in [#549]
883
- - [@MichelleBlanchette] made their first contribution in [#554]
884
- - [@henryiii] made their first contribution in [#835]
885
- - [@jmertic] made their first contribution in [#726]
886
- - [@jacobhq] made their first contribution in [#846]
887
- - [@UnclassedPenguin] made their first contribution in [#814]
888
- - [@alyssais] made their first contribution in [#829]
889
- - [@nascosto] made their first contribution in [#857]
890
- - [@SPGoding] made their first contribution in [#876]
891
- - [@iridazzle] made their first contribution in [#727]
892
- - [@ivanskodje] made their first contribution in [#891]
893
- - [@Eisverygoodletter] made their first contribution in [#893]
894
- - [@robinpokorny] made their first contribution in [#940]
895
- - [@olgarithms] made their first contribution in [#951]
896
- - [@manuelhenke] made their first contribution in [#941]
897
- - [@JPrevost] made their first contribution in [#950]
898
- - [@koppor] made their first contribution in [#1000]
899
- - [@deseo] made their first contribution in [#1010]
900
- - [@Tom-Brouwer] made their first contribution in [#1040]
901
- - [@simonebortolin] made their first contribution in [#945]
902
- - [@SConaway] made their first contribution in [#1104]
903
- - [@captn3m0] made their first contribution in [#1110]
904
- - [@kevinlin1] made their first contribution in [#1123]
905
- - [@codewithfan] made their first contribution in [#1097]
906
- - [@agabrys] made their first contribution in [#1130]
907
- - [@diablodale] made their first contribution in [#1068]
908
- - [@m-r-mccormick] made their first contribution in [#1142]
909
- - [@fabrik42] made their first contribution in [#1153]
910
-
911
- ## Pre-release v0.4.0.rc5
912
-
913
- Hi everyone, we're so excited to finally release `v0.4.0`! For posterity's sake, we're going to release `v0.4.0.rc5` and then immediately re-release it as `v0.4.0`; this should make it more clear what changes were introduced in the lead up to the minor release.
914
-
915
- This RC does not introduce any major user-facing features. It adds more customizability for custom SCSS variables (fixing a bug with callout introduction order), `lunr` indexing, and loading `mermaid` locally. In addition, it fixes bugs introduced in `.rc4`: incorrect CSS, inconsistencies with code block backgrounds in dark theme, and the copy code button. It also adds a migration guide for users coming from `v0.3.3`.
916
-
917
- ### Trying out pre-release `v0.4.0.rc5`
918
-
919
- Similar to the prior release, `v0.4.0.rc5` is a **release candidate** for the theme (i.e., a pre-release) with release `v0.4.0` following immediately after. While we don't anticipate many users using this RC, it is still possible to opt-in.
920
-
921
- To use this RC explicitly as a remote theme:
922
-
923
- ```yml
924
- remote_theme: just-the-docs/just-the-docs@v0.4.0.rc5
925
- ```
926
-
927
- 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`:
928
-
929
- ```ruby
930
- gem "just-the-docs", "0.4.0.rc5"
931
- ```
932
-
933
- By default, **users will not be upgraded to `0.4.0.rc5`**. To enforce that explicitly, either:
934
-
935
- 1. pin your gem version in your `Gemfile`, like so
936
- ```ruby
937
- gem "just-the-docs", "0.3.3"
938
- ```
939
- 2. freeze the `remote_theme`, like so
940
- ```yml
941
- remote_theme: just-the-docs/just-the-docs@v0.3.3
942
- ```
943
-
944
- ### New Features
945
-
946
- - Added: includes for custom `lunr` Liquid and JS code by [@diablodale] in [#1068]
947
- - Added: new `_sass/custom/setup.scss` for variable definition by [@mattxwang] in [#1135]
948
- - Added: configuration key to load a local version of mermaid by [@fabrik42] in [#1153]
949
-
950
- ### Bugfixes and Maintenance
951
-
952
- - Fixed: incorrect `padding` property value pair in `search.scss` by [@kevinlin1] in [#1123]
953
- - Fixed: minor spacing and comment nits by [@EricFromCanada] in [#1128]
954
- - Fixed: exclude images from being bundled with gem by [@m-r-mccormick] in [#1142]
955
- - Fixed: dark theme code block background, line number colors by [@m-r-mccormick] in [#1124]
956
- - Fixed: copy code button interaction with kramdown line numbers by [@mattxwang] in [#1143]
957
-
958
- ### Docs
959
-
960
- - Docs: add a migration guide by [@pdmosses] in [#1059]
961
- - Docs: update `README` demo video by [@codewithfan] in [#1097]
962
- - Docs: update "View Typography Utilities" link by [@agabrys] in [#1130]
963
- - Docs: fix broken relative page links by [@mattxwang] in [#1106]
964
- - Docs: clarify steps to add custom `lunr` index code by [@diablodale] in [#1139]
965
- - Docs: label new features introduced in `v0.4` by [@mattxwang] in [#1138]
966
-
967
- ### New Contributors
968
-
969
- - [@kevinlin1] made their first contribution in [#1123]
970
- - [@codewithfan] made their first contribution in [#1097]
971
- - [@agabrys] made their first contribution in [#1130]
972
- - [@diablodale] made their first contribution in [#1068]
973
- - [@m-r-mccormick] made their first contribution in [#1142]
974
- - [@fabrik42] made their first contribution in [#1153]
975
-
976
- [#1059]: https://github.com/just-the-docs/just-the-docs/pull/1059
977
- [#1068]: https://github.com/just-the-docs/just-the-docs/pull/1068
978
- [#1097]: https://github.com/just-the-docs/just-the-docs/pull/1097
979
- [#1106]: https://github.com/just-the-docs/just-the-docs/pull/1106
980
- [#1123]: https://github.com/just-the-docs/just-the-docs/pull/1123
981
- [#1124]: https://github.com/just-the-docs/just-the-docs/pull/1124
982
- [#1128]: https://github.com/just-the-docs/just-the-docs/pull/1128
983
- [#1130]: https://github.com/just-the-docs/just-the-docs/pull/1130
984
- [#1135]: https://github.com/just-the-docs/just-the-docs/pull/1135
985
- [#1138]: https://github.com/just-the-docs/just-the-docs/pull/1138
986
- [#1139]: https://github.com/just-the-docs/just-the-docs/pull/1139
987
- [#1142]: https://github.com/just-the-docs/just-the-docs/pull/1142
988
- [#1143]: https://github.com/just-the-docs/just-the-docs/pull/1143
989
- [#1153]: https://github.com/just-the-docs/just-the-docs/pull/1153
990
-
991
- [@agabrys]: https://github.com/agabrys
992
- [@codewithfan]: https://github.com/codewithfan
993
- [@diablodale]: https://github.com/diablodale
994
- [@fabrik42]: https://github.com/fabrik42
995
- [@kevinlin1]: https://github.com/kevinlin1
996
- [@EricFromCanada]: https://github.com/EricFromCanada
997
- [@m-r-mccormick]: https://github.com/m-r-mccormick
998
-
999
- ## Pre-release v0.4.0.rc4
1000
-
1001
- Happy new year! We're celebrating with another pre-release, with features that should help theme users better adapt to changes moving forward. **We aim to re-release this as `v0.4.0`, with only few changes**.
1002
-
1003
- Notable new additions include:
1004
-
1005
- - modular site components, which split up the site into smaller reusable components; advanced theme users can then remix layouts quickly without duplication
1006
- - a "copy code" button to code blocks
1007
- - fixing bugs in generated TOCs and navigation from previous prereleases
1008
- - various cleanups of CSS and HTML markup
1009
-
1010
- The roadmap to `v0.4.0` is small. We are only looking to:
1011
-
1012
- - finish a migration guide, so users can easily upgrade from `v0.3.3` to `v0.4.0`
1013
- - fix one last bug relating to callouts and custom colors
1014
- - fix any new bugs introduced by this pre-release
1015
-
1016
- Have any questions, thoughts, or concerns? We'd love to hear from you! Please [open an issue](https://github.com/just-the-docs/just-the-docs/issues) or [start a discussion](https://github.com/just-the-docs/just-the-docs/discussions) and let us know!
1017
-
1018
- ### Trying out pre-release `v0.4.0.rc4`
1019
-
1020
- Similar to the prior release, `v0.4.0.rc4` is a **release candidate** for the theme (i.e., a pre-release) with release `v0.4.0` coming soon. We want your help in testing the changes! As of now, the gem on RubyGems and the repository are updated to `v0.4.0.rc4`.
1021
-
1022
- To use this RC explicitly as a remote theme:
1023
-
1024
- ```yml
1025
- remote_theme: just-the-docs/just-the-docs@v0.4.0.rc4
1026
- ```
1027
-
1028
- 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`:
1029
-
1030
- ```ruby
1031
- gem "just-the-docs", "0.4.0.rc4"
1032
- ```
1033
-
1034
- By default, **users will not be upgraded to `0.4.0.rc4`**. To enforce that explicitly, either:
1035
-
1036
- 1. pin your gem version in your `Gemfile`, like so
1037
- ```ruby
1038
- gem "just-the-docs", "0.3.3"
1039
- ```
1040
- 2. freeze the `remote_theme`, like so
1041
- ```yml
1042
- remote_theme: just-the-docs/just-the-docs@v0.3.3
1043
- ```
1044
-
1045
- ### New Features
1046
-
1047
- - Added: support multiple Google Analytics tracking IDs, document UA -> GA4 switch by [@MichelleBlanchette] in [#1029]
1048
- - Added: copy code button to code snippets by [@simonebortolin] in [#945]
1049
- - Added: restore simple configuration of `favicon.ico` via `site.static_files` by [@pdmosses] in [#1095]
1050
- - Added: modularize site components by [@mattxwang] in [#1058]
1051
-
1052
- ### Bugfixes and Maintenance
1053
-
1054
- - Fixed: incorrect disambiguation in generated TOCs by [@pdmosses] in [#999]
1055
- - Fixed: duplicated external links in collections by [@pdmosses] in [#1001]
1056
- - Fixed: import order of `custom.scss`; puts at end by [@deseo] in [#1010]
1057
- - Fixed: top-level active link styling by [@pdmosses] in [#1015]
1058
- - Fixed: external links for sites with no pages by [@pdmosses] in [#1021]
1059
- - Fixed: duplicate `title` if `jekyll-seo-tag` not in users's plugins by [@Tom-Brouwer] in [#1040]
1060
- - Fixed: removes (duplicate) `favicon.html`, shifts content to `head_custom.html` by [@mattxwang] in [#1027]
1061
- - Fixed: add `reversed`, deprecate `desc` for nav `child_nav_order` by [@jmertic] in [#1061]
1062
- - Fixed: `child.child_nav_order` to `node.child_nav_order` by [@mattxwang] in [#1065]
1063
- - Fixed: remove all uses of `/` as SASS division by [@mattxwang] in [#1074]
1064
- - note: this was originally merged as [#1074] with a bug; it was reverted in [#1076], and then reimplemented in [#1077]
1065
- - Fixed: skip nav collection generation when site has no pages by [@pdmosses] in [#1092]
1066
- - Fixed: standardize SCSS with `declaration-block-no-redundant-longhand-properties` by [@simonebortolin] in [#1102]
1067
- - Fixed: incorrect `padding` property value pair in `labels.scss` by [@SConaway] in [#1104]
1068
- - Fixed: various bugs with copy code button by [@simonebortolin] in [#1096]
1069
- - Fixed: replace inline styling for `<svg>` icons by [@captn3m0] in [#1110]
1070
- - Vendor: update `jekyll-anchor-headings`, `lunr.js` by [@mattxwang] in [#1071]
1071
-
1072
- ### Docs
1073
-
1074
- - Docs: fix typo in changelog links [@koppor] in [#1000]
1075
- - Docs: update homepage (focus: new features, conciseness, deduplication) by [@pdmosses] in [#1018]
1076
- - Docs: update README (focus: new features, conciseness, deduplication) by [@pdmosses] in [#1019]
1077
- - Docs: fix two bugs in "Customization" (custom favicon, new annotation) by [@mattxwang] in [#1090]
1078
- - Docs: Add warning about mandatory `_`-prefix for collections by [@max06] in [#1091]
1079
- - Docs: remove Google Analytics on main site by [@mattxwang] in [#1113]
1080
-
1081
- ### New Contributors
1082
-
1083
- - [@koppor] made their first contribution in [#1000]
1084
- - [@deseo] made their first contribution in [#1010]
1085
- - [@Tom-Brouwer] made their first contribution in [#1040]
1086
- - [@simonebortolin] made their first contribution in [#945]
1087
- - [@SConaway] made their first contribution in [#1104]
1088
- - [@captn3m0] made their first contribution in [#1110]
1089
-
1090
- **Full Changelog**: https://github.com/just-the-docs/just-the-docs/compare/v0.4.0.rc3...v0.4.0.rc4
1091
-
1092
- [#945]: https://github.com/just-the-docs/just-the-docs/pull/945
1093
- [#999]: https://github.com/just-the-docs/just-the-docs/pull/999
1094
- [#1000]: https://github.com/just-the-docs/just-the-docs/pull/1000
1095
- [#1001]: https://github.com/just-the-docs/just-the-docs/pull/1001
1096
- [#1010]: https://github.com/just-the-docs/just-the-docs/pull/1010
1097
- [#1015]: https://github.com/just-the-docs/just-the-docs/pull/1015
1098
- [#1018]: https://github.com/just-the-docs/just-the-docs/pull/1018
1099
- [#1019]: https://github.com/just-the-docs/just-the-docs/pull/1019
1100
- [#1021]: https://github.com/just-the-docs/just-the-docs/pull/1021
1101
- [#1027]: https://github.com/just-the-docs/just-the-docs/pull/1027
1102
- [#1029]: https://github.com/just-the-docs/just-the-docs/pull/1029
1103
- [#1040]: https://github.com/just-the-docs/just-the-docs/pull/1040
1104
- [#1058]: https://github.com/just-the-docs/just-the-docs/pull/1058
1105
- [#1061]: https://github.com/just-the-docs/just-the-docs/pull/1061
1106
- [#1065]: https://github.com/just-the-docs/just-the-docs/pull/1065
1107
- [#1071]: https://github.com/just-the-docs/just-the-docs/pull/1071
1108
- [#1074]: https://github.com/just-the-docs/just-the-docs/pull/1074
1109
- [#1076]: https://github.com/just-the-docs/just-the-docs/pull/1076
1110
- [#1077]: https://github.com/just-the-docs/just-the-docs/pull/1077
1111
- [#1090]: https://github.com/just-the-docs/just-the-docs/pull/1090
1112
- [#1091]: https://github.com/just-the-docs/just-the-docs/pull/1091
1113
- [#1092]: https://github.com/just-the-docs/just-the-docs/pull/1092
1114
- [#1095]: https://github.com/just-the-docs/just-the-docs/pull/1095
1115
- [#1096]: https://github.com/just-the-docs/just-the-docs/pull/1096
1116
- [#1102]: https://github.com/just-the-docs/just-the-docs/pull/1102
1117
- [#1104]: https://github.com/just-the-docs/just-the-docs/pull/1104
1118
- [#1110]: https://github.com/just-the-docs/just-the-docs/pull/1110
1119
- [#1113]: https://github.com/just-the-docs/just-the-docs/pull/1113
1120
-
1121
- [@captn3m0]: https://github.com/captn3m0
1122
- [@deseo]: https://github.com/deseo
1123
- [@koppor]: https://github.com/koppor
1124
- [@MichelleBlanchette]: https://github.com/MichelleBlanchette
1125
- [@simonebortolin]: https://github.com/simonebortolin
1126
- [@SConaway]: https://github.com/SConaway
1127
- [@Tom-Brouwer]: https://github.com/Tom-Brouwer
1128
-
1129
- ## Pre-release v0.4.0.rc3
1130
-
1131
- Hi there! This is (actually) hopefully the last prerelease before `v0.4.0`; in particular, if we find that this prerelease is stable, we'll re-release it as `v0.4.0`.
1132
-
1133
- In general, this is a more mature pre-release; there are few new features. However, we'll highlight [@pdmosses]'s work in [#992] to better optimize nav generation for large sites (ex 100+ pages). We don't expect this to affect most users; however, **it is technically a breaking change**, and we suggest testing your site before upgrading to this prerelease.
1134
-
1135
- We want your feedback! Please [open an issue](https://github.com/just-the-docs/just-the-docs/issues) or [start a discussion](https://github.com/just-the-docs/just-the-docs/discussions) and let us know!
1136
-
1137
- As soon as we get stable test results from major downstream users, we'll push out a `v0.4.0` ASAP - closing out almost 2 years of backlogged work!
1138
-
1139
- ### Trying out pre-release `v0.4.0.rc3`
1140
-
1141
- Similar to the prior release, `v0.4.0.rc3` is a **release candidate** for the theme (i.e., a pre-release) with release `v0.4.0` coming soon. We want your help in testing the changes! As of now, the gem on RubyGems and the repository are updated to `v0.4.0.rc3`.
1142
-
1143
- To use this RC explicitly as a remote theme:
1144
-
1145
- ```yml
1146
- remote_theme: just-the-docs/just-the-docs@v0.4.0.rc3
1147
- ```
1148
-
1149
- 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`:
1150
-
1151
- ```ruby
1152
- gem "just-the-docs", "0.4.0.rc3"
1153
- ```
1154
-
1155
- By default, **users will not be upgraded to `0.4.0.rc3`**. To enforce that explicitly, either:
1156
-
1157
- 1. pin your gem version in your `Gemfile`, like so
1158
- ```ruby
1159
- gem "just-the-docs", "0.3.3"
1160
- ```
1161
- 2. freeze the `remote_theme`, like so
1162
- ```yml
1163
- remote_theme: just-the-docs/just-the-docs@v0.3.3
1164
- ```
1165
-
1166
- ### Features
1167
-
1168
- Broadly, this prerelease is feature-light!
1169
-
1170
- - Added: styling for `<blockquote>` by [@mattxwang] in [#965]
1171
- - Added: custom include for TOC heading by [@pdmosses] in [#980]
1172
-
1173
- ### Bugfixes and Experimental Features
1174
-
1175
- *Note*: experimental nav optimization may be unstable. Please give us feedback!
1176
-
1177
- - Added: experimental nav optimization for simple cases by [@pdmosses] in [#992]
1178
- - Fixed: spacing issue when search is disabled by [@henryiii] in [#960]
1179
- - Fixed: active grandchild link class by [@pdmosses] in [#962]
1180
- - Fixed: HTML validation issues (W3C validator) by [@mattxwang] in [#964]
1181
- - Fixed: link styling now uses `text-decoration` values by [@mattxwang] in [#967]
1182
- - Fixed: cleaning up Jekyll excludes by [@pdmosses] in [#985]
1183
- - Fixed: docs, narrow styling for code highlighting with line numbers by [@pdmosses] in [#974]
1184
- - Fixed: default syntax highlighting in custom color schemes [@pdmosses] in [#986]
1185
-
1186
- [#965]: https://github.com/just-the-docs/just-the-docs/pull/965
1187
- [#960]: https://github.com/just-the-docs/just-the-docs/pull/960
1188
- [#962]: https://github.com/just-the-docs/just-the-docs/pull/962
1189
- [#964]: https://github.com/just-the-docs/just-the-docs/pull/964
1190
- [#967]: https://github.com/just-the-docs/just-the-docs/pull/967
1191
- [#974]: https://github.com/just-the-docs/just-the-docs/pull/974
1192
- [#980]: https://github.com/just-the-docs/just-the-docs/pull/980
1193
- [#985]: https://github.com/just-the-docs/just-the-docs/pull/985
1194
- [#986]: https://github.com/just-the-docs/just-the-docs/pull/986
1195
- [#992]: https://github.com/just-the-docs/just-the-docs/pull/992
1196
-
1197
- [@henryiii]: https://github.com/henryiii
1198
-
1199
- **Full Changelog**: https://github.com/just-the-docs/just-the-docs/compare/v0.4.0.rc2...v0.4.0.rc3
1200
-
1201
- ## Pre-release v0.4.0.rc2
1202
-
1203
- {: .warning }
1204
- This website includes docs for some new features that are not available in `v0.4.0.rc1` and `v0.3.3`!
1205
-
1206
- Hey there! This is likely the last pre-release before releasing `v0.4.0`, which we plan on doing soon (i.e. before the end of the month) - very exciting! Some new additions to highlight:
1207
-
1208
- - significant improvement on build time of navigation panel by [@pdmosses]
1209
- - this is big: for a community member with over 300 pages, we shortened the build time from 3 minutes to 30 seconds!
1210
- - improved accessibility features led by [@JPrevost]
1211
- - more docs!
1212
-
1213
- The intention of this release candidate is to gather even more feedback on a potential `v0.4.0`. As it stands, we have not encountered any breaking changes with early adopters of `v0.4.0.rc1`. If you encounter any - for either of our pre-releases - please let us know!
1214
-
1215
- ### Trying out pre-release `v0.4.0.rc2`
1216
-
1217
- Similar to the prior release, `v0.4.0.rc2` is a **release candidate** for the theme (i.e., a pre-release) with release `v0.4.0` coming soon. We want your help in testing the changes! As of now, the gem on RubyGems and the repository are updated to `v0.4.0.rc2`.
1218
-
1219
- To use this RC explicitly as a remote theme:
1220
-
1221
- ```yml
1222
- remote_theme: just-the-docs/just-the-docs@v0.4.0.rc2
1223
- ```
1224
-
1225
- 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`:
1226
-
1227
- ```ruby
1228
- gem "just-the-docs", "0.4.0.rc2"
1229
- ```
1230
-
1231
- By default, **users will not be upgraded to `0.4.0.rc2`**. To enforce that explicitly, either:
1232
-
1233
- 1. pin your gem version in your `Gemfile`, like so
1234
- ```ruby
1235
- gem "just-the-docs", "0.3.3"
1236
- ```
1237
- 2. freeze the `remote_theme`, like so
1238
- ```yml
1239
- remote_theme: just-the-docs/just-the-docs@v0.3.3
1240
- ```
1241
-
1242
- ### Features
1243
-
1244
- - Added: accessible titles to nested page nav toggle by [@JPrevost] in [#950]
1245
- - Added: better title styling for AsciiDoc examples by [@alyssais] in [#944]
1246
- - Added: docs for custom search placeholder by [@mattxwang] in [#939]
1247
- - Added: provide ability to skip to main content by [@JPrevost] in [#949]
1248
- - Fixed: exclude `vendor/` in Jekyll config by [@manuelhenke] in [#941]
1249
- - Fixed: improve build time of navigation panel by [@pdmosses] in [#956]
1250
-
1251
- [#950]: https://github.com/just-the-docs/just-the-docs/pull/950
1252
- [#944]: https://github.com/just-the-docs/just-the-docs/pull/944
1253
- [#939]: https://github.com/just-the-docs/just-the-docs/pull/939
1254
- [#949]: https://github.com/just-the-docs/just-the-docs/pull/949
1255
- [#941]: https://github.com/just-the-docs/just-the-docs/pull/941
1256
- [#956]: https://github.com/just-the-docs/just-the-docs/pull/956
1257
-
1258
- [@alyssais]: https://github.com/alyssais
1259
-
1260
- ### Documentation and Maintenance
1261
-
1262
- - Added: docs load mermaid.js by default by [@mattxwang] in [#935]
1263
- - Fixed: table of contents on search docs by [@robinpokorny] in [#940]
1264
- - Fixed: broken docs link (custom footer) by [@olgarithms] in [#951]
1265
- - Fixed: clarify version docs by [@pdmosses] in [#955]
1266
- - Deleted: unused script directory by [@mattxwang] in [#937]
1267
-
1268
- [#935]: https://github.com/just-the-docs/just-the-docs/pull/935
1269
- [#940]: https://github.com/just-the-docs/just-the-docs/pull/940
1270
- [#951]: https://github.com/just-the-docs/just-the-docs/pull/951
1271
- [#955]: https://github.com/just-the-docs/just-the-docs/pull/955
1272
- [#937]: https://github.com/just-the-docs/just-the-docs/pull/937
1273
-
1274
- ### New Contributors
1275
-
1276
- * [@robinpokorny] made their first contribution in [#940]
1277
- * [@olgarithms] made their first contribution in [#951]
1278
- * [@manuelhenke] made their first contribution in [#941]
1279
- * [@JPrevost] made their first contribution in [#950]
1280
-
1281
- [@robinpokorny]: https://github.com/robinpokorny
1282
- [@olgarithms]: https://github.com/olgarithms
1283
- [@manuelhenke]: https://github.com/manuelhenke
1284
- [@JPrevost]: https://github.com/JPrevost
1285
-
1286
- ## Pre-release v0.4.0.rc1
1287
-
1288
- ### We're back!
1289
-
1290
- Hi all! The Just the Docs team is excited to have our first pre-release in over two years! It is jam-packed with features and bugfixes that have been requested by the community since 2020. They include:
1291
-
1292
- - The new callouts component
1293
- - Allowing pages and collections to coexist on the navigation pane
1294
- - New styling: dark syntax highlighting, support for jekyll-asciidoc, word-wrapping instead of overflow for various elements
1295
- - More customization: external nav links, custom nav footers, favicon includes, search color and placeholder configuration, mermaid.js support, and nav sorting
1296
- - Over 20 bugfixes! Big ones include fixing the `rake` command, using `relative_url`, and search input color
1297
- - More documentation, especially on using custom includes
1298
- - Updating core dependencies to stable Ruby versions
1299
- - A WIP [template repository](https://github.com/just-the-docs/just-the-docs-template) that allows you to setup your own repository using Just the Docs and GitHub Pages with one click - give it a shot! More documentation, etc. is on the way!
1300
-
1301
- We want your feedback! Are these changes helpful? Are our docs easy to understand? Should new features like `mermaid` be opt-in or opt-out? Please [open an issue](https://github.com/just-the-docs/just-the-docs/issues) or [start a discussion](https://github.com/just-the-docs/just-the-docs/discussions) and let us know!
1302
-
1303
- ### Trying out pre-release `v0.4.0.rc1`
1304
-
1305
- Due to the massive scope of these changes, we're making `v0.4.0.rc1` available as a **release candidate** for the theme (i.e., a pre-release) with release `v0.4.0` coming soon. We want your help in testing the changes! As of now, the gem on RubyGems and the repository are updated to `v0.4.0.rc1`.
1306
-
1307
- To use this RC explicitly as a remote theme:
1308
-
1309
- ```yml
1310
- remote_theme: just-the-docs/just-the-docs@v0.4.0.rc1
1311
- ```
1312
-
1313
- 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`:
1314
-
1315
- ```ruby
1316
- gem "just-the-docs", "0.4.0.rc1"
1317
- ```
1318
-
1319
- ### Staying on `v0.3.3`
1320
-
1321
- If you're not ready to make the switch, that's alright! If your version of just-the-docs is pinned to `v0.3.3` (i.e. by a `Gemfile.lock` or in `remote_theme`, then there's nothing you need to do.
1322
-
1323
- If you have not pinned your theme version, you should either:
1324
-
1325
- 1. pin your gem version in your `Gemfile`, like so
1326
- ```ruby
1327
- gem "just-the-docs", "0.3.3"
1328
- ```
1329
- 2. freeze the `remote_theme`, like so
1330
- ```yml
1331
- remote_theme: just-the-docs/just-the-docs@v0.3.3
1332
- ```
1333
-
1334
- {: .warning }
1335
- Use of branches for closed PRs (e.g., [#466], [#578]) is now deprecated, as those branches have been (directly or indirectly) merged, and they may be deleted after the pre-release of `v0.4.0.rc1`.
1336
-
1337
- ### Maintenance
1338
-
1339
- Internally, our maintainer team has expanded: [Patrick Marsceill][@pmarsceill], the original maintainer, has stepped down from an active role after almost 4 years! We're very thankful for the work that he's done to create and maintain one of the most popular Jekyll themes. Please join us in giving him thanks!
1340
-
1341
- The new core team currently consists of [@mattxwang], [@pdmosses], [@skullface], [@dougaitken], and [@max06]. Over the past six months, we've been triaging and merging in PRs, as well as contributing our own fixes. We'll continue to address open issues, merge in PRs from the community, and plan out the future of Just the Docs. If you'd like to contribute, now is a great time!
1342
-
1343
- [@mattxwang]: https://github.com/mattxwang
1344
- [@pdmosses]: https://github.com/pdmosses
1345
- [@skullface]: https://github.com/skullface
1346
- [@dougaitken]: https://github.com/dougaitken
1347
- [@max06]: https://github.com/max06
1348
-
1349
- ### Roadmap
1350
-
1351
- In the short-term, we're committed to tidying up everything for a `v0.4.0` release. This involves fixing bugs reported from the community in this pre-release, as well as continually merging in minor PRs.
1352
-
1353
- We're also scoping out medium and long-term projects, and want to keep you in the loop. These include:
1354
-
1355
- - upgrading to Jekyll 4, and stopping support for Jekyll 3
1356
- - versioned docs - issue [#728]
1357
- - improved accessibility - issues [#566], [#870]
1358
- - internationalization (i18n) - issue [#59]
1359
- - recursive/multi-level navigation - PR [#462]
1360
- - toggleable dark mode - issue [#234]
1361
-
1362
- as well as DX improvements like better regression tests, CI, and tooling. If you're interested in any of these, please join us [on GitHub](https://github.com/just-the-docs/just-the-docs) - any contribution (raising an issue, writing docs, or submitting a PR) is welcome!
1363
-
1364
- [#728]: https://github.com/just-the-docs/just-the-docs/issues/728
1365
- [#566]: https://github.com/just-the-docs/just-the-docs/issues/566
1366
- [#870]: https://github.com/just-the-docs/just-the-docs/issues/870
1367
- [#59]: https://github.com/just-the-docs/just-the-docs/issues/59
1368
- [#462]: https://github.com/just-the-docs/just-the-docs/pull/462
1369
- [#234]: https://github.com/just-the-docs/just-the-docs/issues/234
1370
-
1371
- ### Features
1372
-
1373
- * Added: Combination by [@pdmosses] in [#578]
1374
- - Added: dark highlighting in [#463]
1375
- - Added: pages and collections in [#448]
1376
- - Added: callouts in [#466]
1377
- - Fixed: breadcrumb behaviour … by [@AdityaTiwari2102] in [#477]
1378
- - Fixed: prevent rake command corrupting search data in [#495] (also listed below)
1379
- - Fixed: nested lists in [#496]
1380
- - Fixed: set color for search input in [#498] (also listed below)
255
+ - Fixed: scroll navigation to show the link to the current page in [#639](https://github.com/just-the-docs/just-the-docs/pull/639)
256
+ - Fixed: Replace all uses of `absolute_url` by `relative_url`, by [@svrooij](https://github.com/svrooij) in [#544](https://github.com/just-the-docs/just-the-docs/pull/544)
257
+ - Added: custom favicon `_includes` by [@burner1024](https://github.com/burner1024) in [#364](https://github.com/just-the-docs/just-the-docs/pull/364)
258
+ - Added: set color for search input by [@pdmosses](https://github.com/pdmosses) in [#498](https://github.com/just-the-docs/just-the-docs/pull/498)
259
+ - Added: search placeholder configuration by [@mattxwang](https://github.com/mattxwang) in [#613](https://github.com/just-the-docs/just-the-docs/pull/613)
260
+ - Added: 'child_nav_order' front matter to be able to sort navigation pages in reverse by [@jmertic](https://github.com/jmertic) in [#726](https://github.com/just-the-docs/just-the-docs/pull/726)
261
+ - Added: `nav_footer_custom` include by [@nathanjessen](https://github.com/nathanjessen) in [#474](https://github.com/just-the-docs/just-the-docs/pull/474)
262
+ - Added: style fixes for jekyll-asciidoc by [@alyssais](https://github.com/alyssais) in [#829](https://github.com/just-the-docs/just-the-docs/pull/829)
263
+ - Added: mermaid.js support by [@nascosto](https://github.com/nascosto) in [#857](https://github.com/just-the-docs/just-the-docs/pull/857)
264
+ - Added: support for external navigation links by [@SPGoding](https://github.com/SPGoding) in [#876](https://github.com/just-the-docs/just-the-docs/pull/876)
265
+ - Added: refactor `mermaid` config to use `mermaid_config.js` include, only require `mermaid.version` in `_config.yml` by [@mattxwang](https://github.com/mattxwang) in [#909](https://github.com/just-the-docs/just-the-docs/pull/909)
266
+ - Added: accessible titles to nested page nav toggle by [@JPrevost](https://github.com/JPrevost) in [#950](https://github.com/just-the-docs/just-the-docs/pull/950)
267
+ - Added: better title styling for AsciiDoc examples by [@alyssais](https://github.com/alyssais) in [#944](https://github.com/just-the-docs/just-the-docs/pull/944)
268
+ - Added: docs for custom search placeholder by [@mattxwang](https://github.com/mattxwang) in [#939](https://github.com/just-the-docs/just-the-docs/pull/939)
269
+ - Added: provide ability to skip to main content by [@JPrevost](https://github.com/JPrevost) in [#949](https://github.com/just-the-docs/just-the-docs/pull/949)
270
+ - Added: styling for `<blockquote>` by [@mattxwang](https://github.com/mattxwang) in [#965](https://github.com/just-the-docs/just-the-docs/pull/965)
271
+ - Added: custom include for TOC heading by [@pdmosses](https://github.com/pdmosses) in [#980](https://github.com/just-the-docs/just-the-docs/pull/980)
272
+ - Added: experimental nav optimization for simple cases by [@pdmosses](https://github.com/pdmosses) in [#992](https://github.com/just-the-docs/just-the-docs/pull/992)
273
+ - Added: support multiple Google Analytics tracking IDs, document UA to GA4 switch by [@MichelleBlanchette](https://github.com/MichelleBlanchette) in [#1029](https://github.com/just-the-docs/just-the-docs/pull/1029)
274
+ - Added: copy code button to code snippets by [@simonebortolin](https://github.com/simonebortolin) in [#945](https://github.com/just-the-docs/just-the-docs/pull/945)
275
+ - Added: restore simple configuration of `favicon.ico` via `site.static_files` by [@pdmosses](https://github.com/pdmosses) in [#1095](https://github.com/just-the-docs/just-the-docs/pull/1095)
276
+ - Added: modularize site components by [@mattxwang](https://github.com/mattxwang) in [#1058](https://github.com/just-the-docs/just-the-docs/pull/1058)
277
+ - Added: includes for custom `lunr` Liquid and JS code by [@diablodale](https://github.com/diablodale) in [#1068](https://github.com/just-the-docs/just-the-docs/pull/1068)
278
+ - Added: new `_sass/custom/setup.scss` for variable definition by [@mattxwang](https://github.com/mattxwang) in [#1135](https://github.com/just-the-docs/just-the-docs/pull/1135)
279
+ - Added: configuration key to load a local version of mermaid by [@fabrik42](https://github.com/fabrik42) in [#1153](https://github.com/just-the-docs/just-the-docs/pull/1153)
280
+ - Fixed: prepend `site.collections_dir` if exists by [@alexsegura](https://github.com/alexsegura) in [#519](https://github.com/just-the-docs/just-the-docs/pull/519)
281
+ - Fixed: nested task lists (#517) by [@pdmosses](https://github.com/pdmosses) in [#855](https://github.com/just-the-docs/just-the-docs/pull/855)
282
+ - Fixed: suppress Liquid processing in CSS comments by [@pdmosses](https://github.com/pdmosses) in [#686](https://github.com/just-the-docs/just-the-docs/pull/686)
283
+ - Fixed: prevent rake command from corrupting search data by [@pdmosses](https://github.com/pdmosses) in [#495](https://github.com/just-the-docs/just-the-docs/pull/495)
284
+ - Fixed: anchor heading links should be visible on focus by [@jacobhq](https://github.com/jacobhq) in [#846](https://github.com/just-the-docs/just-the-docs/pull/846)
285
+ - Fixed: add `overflow-x: auto` to `figure.highlight` by [@iridazzle](https://github.com/iridazzle) in [#727](https://github.com/just-the-docs/just-the-docs/pull/727)
286
+ - Fixed: add `overflow-wrap: word-break` to `body` by [@iridazzle](https://github.com/iridazzle) in [#889](https://github.com/just-the-docs/just-the-docs/pull/889)
287
+ - Fixed: vertical alignment for consecutive labels by [@Eisverygoodletter](https://github.com/Eisverygoodletter) in [#893](https://github.com/just-the-docs/just-the-docs/pull/893)
288
+ - Fixed: allow links to wrap by [@pdmosses](https://github.com/pdmosses) in [#905](https://github.com/just-the-docs/just-the-docs/pull/905)
289
+ - Fixed: nav scroll feature and absolute/relative URLs by [@pdmosses](https://github.com/pdmosses) in [#898](https://github.com/just-the-docs/just-the-docs/pull/898)
290
+ - Fixed: exclude `vendor/` in Jekyll config by [@manuelhenke](https://github.com/manuelhenke) in [#941](https://github.com/just-the-docs/just-the-docs/pull/941)
291
+ - Fixed: improve build time of navigation panel by [@pdmosses](https://github.com/pdmosses) in [#956](https://github.com/just-the-docs/just-the-docs/pull/956)
292
+ - Fixed: spacing issue when search is disabled by [@henryiii](https://github.com/henryiii) in [#960](https://github.com/just-the-docs/just-the-docs/pull/960)
293
+ - Fixed: active grandchild link class by [@pdmosses](https://github.com/pdmosses) in [#962](https://github.com/just-the-docs/just-the-docs/pull/962)
294
+ - Fixed: HTML validation issues (W3C validator) by [@mattxwang](https://github.com/mattxwang) in [#964](https://github.com/just-the-docs/just-the-docs/pull/964)
295
+ - Fixed: link styling now uses `text-decoration` values by [@mattxwang](https://github.com/mattxwang) in [#967](https://github.com/just-the-docs/just-the-docs/pull/967)
296
+ - Fixed: cleaning up Jekyll excludes by [@pdmosses](https://github.com/pdmosses) in [#985](https://github.com/just-the-docs/just-the-docs/pull/985)
297
+ - Fixed: docs, narrow styling for code highlighting with line numbers by [@pdmosses](https://github.com/pdmosses) in [#974](https://github.com/just-the-docs/just-the-docs/pull/974)
298
+ - Fixed: default syntax highlighting in custom color schemes [@pdmosses](https://github.com/pdmosses) in [#986](https://github.com/just-the-docs/just-the-docs/pull/986)
299
+ - Fixed: incorrect disambiguation in generated TOCs by [@pdmosses](https://github.com/pdmosses) in [#999](https://github.com/just-the-docs/just-the-docs/pull/999)
300
+ - Fixed: duplicated external links in collections by [@pdmosses](https://github.com/pdmosses) in [#1001](https://github.com/just-the-docs/just-the-docs/pull/1001)
301
+ - Fixed: import order of `custom.scss`; puts at end by [@deseo](https://github.com/deseo) in [#1010](https://github.com/just-the-docs/just-the-docs/pull/1010)
302
+ - Fixed: top-level active link styling by [@pdmosses](https://github.com/pdmosses) in [#1015](https://github.com/just-the-docs/just-the-docs/pull/1015)
303
+ - Fixed: external links for sites with no pages by [@pdmosses](https://github.com/pdmosses) in [#1021](https://github.com/just-the-docs/just-the-docs/pull/1021)
304
+ - Fixed: duplicate `title` if `jekyll-seo-tag` not in users's plugins by [@Tom-Brouwer](https://github.com/Tom-Brouwer) in [#1040](https://github.com/just-the-docs/just-the-docs/pull/1040)
305
+ - Fixed: removes (duplicate) `favicon.html`, shifts content to `head_custom.html` by [@mattxwang](https://github.com/mattxwang) in [#1027](https://github.com/just-the-docs/just-the-docs/pull/1027)
306
+ - Fixed: add `reversed`, deprecate `desc` for nav `child_nav_order` by [@jmertic](https://github.com/jmertic) in [#1061](https://github.com/just-the-docs/just-the-docs/pull/1061)
307
+ - Fixed: `child.child_nav_order` to `node.child_nav_order` by [@mattxwang](https://github.com/mattxwang) in [#1065](https://github.com/just-the-docs/just-the-docs/pull/1065)
308
+ - Fixed: remove all uses of `/` as SASS division by [@mattxwang](https://github.com/mattxwang) in [#1074](https://github.com/just-the-docs/just-the-docs/pull/1074)
309
+ - note: this was originally merged as [#1074](https://github.com/just-the-docs/just-the-docs/pull/1074) with a bug; it was reverted in [#1076](https://github.com/just-the-docs/just-the-docs/pull/1076), and then reimplemented in [#1077](https://github.com/just-the-docs/just-the-docs/pull/1077)
310
+ - Fixed: skip nav collection generation when site has no pages by [@pdmosses](https://github.com/pdmosses) in [#1092](https://github.com/just-the-docs/just-the-docs/pull/1092)
311
+ - Fixed: standardize SCSS with `declaration-block-no-redundant-longhand-properties` by [@simonebortolin](https://github.com/simonebortolin) in [#1102](https://github.com/just-the-docs/just-the-docs/pull/1102)
312
+ - Fixed: incorrect `padding` property value pair in `labels.scss` by [@SConaway](https://github.com/SConaway) in [#1104](https://github.com/just-the-docs/just-the-docs/pull/1104)
313
+ - Fixed: various bugs with copy code button by [@simonebortolin](https://github.com/simonebortolin) in [#1096](https://github.com/just-the-docs/just-the-docs/pull/1096)
314
+ - Fixed: replace inline styling for `<svg>` icons by [@captn3m0](https://github.com/captn3m0) in [#1110](https://github.com/just-the-docs/just-the-docs/pull/1110)
315
+ - Fixed: incorrect `padding` property value pair in `search.scss` by [@kevinlin1](https://github.com/kevinlin1) in [#1123](https://github.com/just-the-docs/just-the-docs/pull/1123)
316
+ - Fixed: minor spacing and comment nits by [@EricFromCanada](https://github.com/EricFromCanada) in [#1128](https://github.com/just-the-docs/just-the-docs/pull/1128)
317
+ - Fixed: exclude images from being bundled with gem by [@m-r-mccormick](https://github.com/m-r-mccormick) in [#1142](https://github.com/just-the-docs/just-the-docs/pull/1142)
318
+ - Fixed: dark theme code block background, line number colors by [@m-r-mccormick](https://github.com/m-r-mccormick) in [#1124](https://github.com/just-the-docs/just-the-docs/pull/1124)
319
+ - Fixed: copy code button interaction with kramdown line numbers by [@mattxwang](https://github.com/mattxwang) in [#1143](https://github.com/just-the-docs/just-the-docs/pull/1143)
320
+ - Maintenance changes (developer-only)
321
+ - Added: VScode devcontainer by [@max06](https://github.com/max06) in [#783](https://github.com/just-the-docs/just-the-docs/pull/783)
322
+ - Added: `webrick` to `Gemfile` by [@mattxwang](https://github.com/mattxwang) in [#799](https://github.com/just-the-docs/just-the-docs/pull/799)
323
+ - Added: 'This site is powered by Netlify.' to the footer by [@mattxwang](https://github.com/mattxwang) in [#797](https://github.com/just-the-docs/just-the-docs/pull/797)
324
+ - Updated: new repo path by [@pmarsceill](https://github.com/pmarsceill) in [#775](https://github.com/just-the-docs/just-the-docs/pull/775)
325
+ - Updated: rename `master` to `main` by [@pmarsceill](https://github.com/pmarsceill) in [#776](https://github.com/just-the-docs/just-the-docs/pull/776)
326
+ - Updated: README by [@pmarsceill](https://github.com/pmarsceill) in [#777](https://github.com/just-the-docs/just-the-docs/pull/777)
327
+ - Updated: Code of Conduct to Contributor Covenant v2.1 by [@mattxwang](https://github.com/mattxwang) in [#790](https://github.com/just-the-docs/just-the-docs/pull/790)
328
+ - Updated: CI files, Ruby & Node Versions by [@mattxwang](https://github.com/mattxwang) in [#820](https://github.com/just-the-docs/just-the-docs/pull/820)
329
+ - Updated: Stylelint to v14, extend SCSS plugins, remove primer-* configs, resolve issues by [@mattxwang](https://github.com/mattxwang) in [#821](https://github.com/just-the-docs/just-the-docs/pull/821)
330
+ - Deleted: unused script directory by [@mattxwang](https://github.com/mattxwang) in [#937](https://github.com/just-the-docs/just-the-docs/pull/937)
331
+ - Vendor: update `jekyll-anchor-headings`, `lunr.js` by [@mattxwang](https://github.com/mattxwang) in [#1071](https://github.com/just-the-docs/just-the-docs/pull/1071)
332
+ - Documentation changes
333
+ - Added: docs on how to break an `ol` by [@pdmosses](https://github.com/pdmosses) in [#856](https://github.com/just-the-docs/just-the-docs/pull/856)
334
+ - Added: docs for custom includes by [@nathanjessen](https://github.com/nathanjessen) in [#806](https://github.com/just-the-docs/just-the-docs/pull/806)
335
+ - Added: document caveat about variable dependencies by [@waldyrious](https://github.com/waldyrious) in [#555](https://github.com/just-the-docs/just-the-docs/pull/555)
336
+ - Added: docs on how to use `custom_head` to add a custom favicon by [@UnclassedPenguin](https://github.com/UnclassedPenguin) in [#814](https://github.com/just-the-docs/just-the-docs/pull/814)
337
+ - Added: docs load mermaid.js by default by [@mattxwang](https://github.com/mattxwang) in [#935](https://github.com/just-the-docs/just-the-docs/pull/935)
338
+ - Added: warning about mandatory `_`-prefix for collections by [@max06](https://github.com/max06) in [#1091](https://github.com/just-the-docs/just-the-docs/pull/1091)
339
+ - Added: migration guide by [@pdmosses](https://github.com/pdmosses) in [#1059](https://github.com/just-the-docs/just-the-docs/pull/1059)
340
+ - Added: label new features introduced in `v0.4` by [@mattxwang](https://github.com/mattxwang) in [#1138](https://github.com/just-the-docs/just-the-docs/pull/1138)
341
+ - Fixed: `ol` on `index.md` by [@pmarsceill](https://github.com/pmarsceill) in [#778](https://github.com/just-the-docs/just-the-docs/pull/778)
342
+ - Fixed: image link in Markdown kitchen sink by [@JeffGuKang](https://github.com/JeffGuKang) in [#221](https://github.com/just-the-docs/just-the-docs/pull/221)
343
+ - Fixed: images in Markdown kitchen sink by [@dougaitken](https://github.com/dougaitken) in [#782](https://github.com/just-the-docs/just-the-docs/pull/782)
344
+ - Fixed: clearer label of link to Jekyll quickstart by [@waldyrious](https://github.com/waldyrious) in [#549](https://github.com/just-the-docs/just-the-docs/pull/549)
345
+ - Fixed: remove extra spaces in component docs by [@MichelleBlanchette](https://github.com/MichelleBlanchette) in [#554](https://github.com/just-the-docs/just-the-docs/pull/554)
346
+ - Fixed: double "your" typo in `index.md` by [@sehilyi](https://github.com/sehilyi) in [#499](https://github.com/just-the-docs/just-the-docs/pull/499)
347
+ - Fixed: "you" to "your" typo in `index.md` by [@nathanjessen](https://github.com/nathanjessen) in [#473](https://github.com/just-the-docs/just-the-docs/pull/473)
348
+ - Fixed: spacing in toc example by [@henryiii](https://github.com/henryiii) in [#835](https://github.com/just-the-docs/just-the-docs/pull/835)
349
+ - Fixed: typo in `README` on `_config.yml` by [@ivanskodje](https://github.com/ivanskodje) in [#891](https://github.com/just-the-docs/just-the-docs/pull/891)
350
+ - Fixed: missing code fence in navigation structure docs by [@mattxwang](https://github.com/mattxwang) in [#906](https://github.com/just-the-docs/just-the-docs/pull/906)
351
+ - Fixed: table of contents on search docs by [@robinpokorny](https://github.com/robinpokorny) in [#940](https://github.com/just-the-docs/just-the-docs/pull/940)
352
+ - Fixed: broken docs link (custom footer) by [@olgarithms](https://github.com/olgarithms) in [#951](https://github.com/just-the-docs/just-the-docs/pull/951)
353
+ - Fixed: clarify version docs by [@pdmosses](https://github.com/pdmosses) in [#955](https://github.com/just-the-docs/just-the-docs/pull/955)
354
+ - Fixed: typo in changelog links [@koppor](https://github.com/koppor) in [#1000](https://github.com/just-the-docs/just-the-docs/pull/1000)
355
+ - Fixed: two bugs in "Customization" (custom favicon, new annotation) by [@mattxwang](https://github.com/mattxwang) in [#1090](https://github.com/just-the-docs/just-the-docs/pull/1090)
356
+ - Fixed: "View Typography Utilities" link by [@agabrys](https://github.com/agabrys) in [#1130](https://github.com/just-the-docs/just-the-docs/pull/1130)
357
+ - Fixed: broken relative page links by [@mattxwang](https://github.com/mattxwang) in [#1106](https://github.com/just-the-docs/just-the-docs/pull/1106)
358
+ - Fixed: clarify steps to add custom `lunr` index code by [@diablodale](https://github.com/diablodale) in [#1139](https://github.com/just-the-docs/just-the-docs/pull/1139)
359
+ - Updated: homepage (focus: new features, conciseness, deduplication) by [@pdmosses](https://github.com/pdmosses) in [#1018](https://github.com/just-the-docs/just-the-docs/pull/1018)
360
+ - Updated: README (focus: new features, conciseness, deduplication) by [@pdmosses](https://github.com/pdmosses) in [#1019](https://github.com/just-the-docs/just-the-docs/pull/1019)
361
+ - Updated: `README` demo video by [@codewithfan](https://github.com/codewithfan) in [#1097](https://github.com/just-the-docs/just-the-docs/pull/1097)
362
+
363
+ ## v0.4.0.rc5
364
+
365
+ - Added: includes for custom `lunr` Liquid and JS code by [@diablodale](https://github.com/diablodale) in [#1068](https://github.com/just-the-docs/just-the-docs/pull/1068)
366
+ - Added: new `_sass/custom/setup.scss` for variable definition by [@mattxwang](https://github.com/mattxwang) in [#1135](https://github.com/just-the-docs/just-the-docs/pull/1135)
367
+ - Added: configuration key to load a local version of mermaid by [@fabrik42](https://github.com/fabrik42) in [#1153](https://github.com/just-the-docs/just-the-docs/pull/1153)
368
+ - Fixed: incorrect `padding` property value pair in `search.scss` by [@kevinlin1](https://github.com/kevinlin1) in [#1123](https://github.com/just-the-docs/just-the-docs/pull/1123)
369
+ - Fixed: minor spacing and comment nits by [@EricFromCanada](https://github.com/EricFromCanada) in [#1128](https://github.com/just-the-docs/just-the-docs/pull/1128)
370
+ - Fixed: exclude images from being bundled with gem by [@m-r-mccormick](https://github.com/m-r-mccormick) in [#1142](https://github.com/just-the-docs/just-the-docs/pull/1142)
371
+ - Fixed: dark theme code block background, line number colors by [@m-r-mccormick](https://github.com/m-r-mccormick) in [#1124](https://github.com/just-the-docs/just-the-docs/pull/1124)
372
+ - Fixed: copy code button interaction with kramdown line numbers by [@mattxwang](https://github.com/mattxwang) in [#1143](https://github.com/just-the-docs/just-the-docs/pull/1143)
373
+ - Docs: add a migration guide by [@pdmosses](https://github.com/pdmosses) in [#1059](https://github.com/just-the-docs/just-the-docs/pull/1059)
374
+ - Docs: update `README` demo video by [@codewithfan](https://github.com/codewithfan) in [#1097](https://github.com/just-the-docs/just-the-docs/pull/1097)
375
+ - Docs: update "View Typography Utilities" link by [@agabrys](https://github.com/agabrys) in [#1130](https://github.com/just-the-docs/just-the-docs/pull/1130)
376
+ - Docs: fix broken relative page links by [@mattxwang](https://github.com/mattxwang) in [#1106](https://github.com/just-the-docs/just-the-docs/pull/1106)
377
+ - Docs: clarify steps to add custom `lunr` index code by [@diablodale](https://github.com/diablodale) in [#1139](https://github.com/just-the-docs/just-the-docs/pull/1139)
378
+ - Docs: label new features introduced in `v0.4` by [@mattxwang](https://github.com/mattxwang) in [#1138](https://github.com/just-the-docs/just-the-docs/pull/1138)
379
+
380
+ ## v0.4.0.rc4
381
+
382
+ - Added: support multiple Google Analytics tracking IDs, document UA to GA4 switch by [@MichelleBlanchette](https://github.com/MichelleBlanchette) in [#1029](https://github.com/just-the-docs/just-the-docs/pull/1029)
383
+ - Added: copy code button to code snippets by [@simonebortolin](https://github.com/simonebortolin) in [#945](https://github.com/just-the-docs/just-the-docs/pull/945)
384
+ - Added: restore simple configuration of `favicon.ico` via `site.static_files` by [@pdmosses](https://github.com/pdmosses) in [#1095](https://github.com/just-the-docs/just-the-docs/pull/1095)
385
+ - Added: modularize site components by [@mattxwang](https://github.com/mattxwang) in [#1058](https://github.com/just-the-docs/just-the-docs/pull/1058)
386
+ - Fixed: incorrect disambiguation in generated TOCs by [@pdmosses](https://github.com/pdmosses) in [#999](https://github.com/just-the-docs/just-the-docs/pull/999)
387
+ - Fixed: duplicated external links in collections by [@pdmosses](https://github.com/pdmosses) in [#1001](https://github.com/just-the-docs/just-the-docs/pull/1001)
388
+ - Fixed: import order of `custom.scss`; puts at end by [@deseo](https://github.com/deseo) in [#1010](https://github.com/just-the-docs/just-the-docs/pull/1010)
389
+ - Fixed: top-level active link styling by [@pdmosses](https://github.com/pdmosses) in [#1015](https://github.com/just-the-docs/just-the-docs/pull/1015)
390
+ - Fixed: external links for sites with no pages by [@pdmosses](https://github.com/pdmosses) in [#1021](https://github.com/just-the-docs/just-the-docs/pull/1021)
391
+ - Fixed: duplicate `title` if `jekyll-seo-tag` not in users's plugins by [@Tom-Brouwer](https://github.com/Tom-Brouwer) in [#1040](https://github.com/just-the-docs/just-the-docs/pull/1040)
392
+ - Fixed: removes (duplicate) `favicon.html`, shifts content to `head_custom.html` by [@mattxwang](https://github.com/mattxwang) in [#1027](https://github.com/just-the-docs/just-the-docs/pull/1027)
393
+ - Fixed: add `reversed`, deprecate `desc` for nav `child_nav_order` by [@jmertic](https://github.com/jmertic) in [#1061](https://github.com/just-the-docs/just-the-docs/pull/1061)
394
+ - Fixed: `child.child_nav_order` to `node.child_nav_order` by [@mattxwang](https://github.com/mattxwang) in [#1065](https://github.com/just-the-docs/just-the-docs/pull/1065)
395
+ - Fixed: remove all uses of `/` as SASS division by [@mattxwang](https://github.com/mattxwang) in [#1074](https://github.com/just-the-docs/just-the-docs/pull/1074)
396
+ - note: this was originally merged as [#1074](https://github.com/just-the-docs/just-the-docs/pull/1074) with a bug; it was reverted in [#1076](https://github.com/just-the-docs/just-the-docs/pull/1076), and then reimplemented in [#1077](https://github.com/just-the-docs/just-the-docs/pull/1077)
397
+ - Fixed: skip nav collection generation when site has no pages by [@pdmosses](https://github.com/pdmosses) in [#1092](https://github.com/just-the-docs/just-the-docs/pull/1092)
398
+ - Fixed: standardize SCSS with `declaration-block-no-redundant-longhand-properties` by [@simonebortolin](https://github.com/simonebortolin) in [#1102](https://github.com/just-the-docs/just-the-docs/pull/1102)
399
+ - Fixed: incorrect `padding` property value pair in `labels.scss` by [@SConaway](https://github.com/SConaway) in [#1104](https://github.com/just-the-docs/just-the-docs/pull/1104)
400
+ - Fixed: various bugs with copy code button by [@simonebortolin](https://github.com/simonebortolin) in [#1096](https://github.com/just-the-docs/just-the-docs/pull/1096)
401
+ - Fixed: replace inline styling for `<svg>` icons by [@captn3m0](https://github.com/captn3m0) in [#1110](https://github.com/just-the-docs/just-the-docs/pull/1110)
402
+ - Vendor: update `jekyll-anchor-headings`, `lunr.js` by [@mattxwang](https://github.com/mattxwang) in [#1071](https://github.com/just-the-docs/just-the-docs/pull/1071)
403
+ - Docs: fix typo in changelog links [@koppor](https://github.com/koppor) in [#1000](https://github.com/just-the-docs/just-the-docs/pull/1000)
404
+ - Docs: update homepage (focus: new features, conciseness, deduplication) by [@pdmosses](https://github.com/pdmosses) in [#1018](https://github.com/just-the-docs/just-the-docs/pull/1018)
405
+ - Docs: update README (focus: new features, conciseness, deduplication) by [@pdmosses](https://github.com/pdmosses) in [#1019](https://github.com/just-the-docs/just-the-docs/pull/1019)
406
+ - Docs: fix two bugs in "Customization" (custom favicon, new annotation) by [@mattxwang](https://github.com/mattxwang) in [#1090](https://github.com/just-the-docs/just-the-docs/pull/1090)
407
+ - Docs: Add warning about mandatory `_`-prefix for collections by [@max06](https://github.com/max06) in [#1091](https://github.com/just-the-docs/just-the-docs/pull/1091)
408
+ - Docs: remove Google Analytics on main site by [@mattxwang](https://github.com/mattxwang) in [#1113](https://github.com/just-the-docs/just-the-docs/pull/1113)
409
+
410
+ ## v0.4.0.rc3
411
+
412
+ - Added: styling for `<blockquote>` by [@mattxwang](https://github.com/mattxwang) in [#965](https://github.com/just-the-docs/just-the-docs/pull/965)
413
+ - Added: custom include for TOC heading by [@pdmosses](https://github.com/pdmosses) in [#980](https://github.com/just-the-docs/just-the-docs/pull/980)
414
+ - Added: experimental nav optimization for simple cases by [@pdmosses](https://github.com/pdmosses) in [#992](https://github.com/just-the-docs/just-the-docs/pull/992)
415
+ - Fixed: spacing issue when search is disabled by [@henryiii](https://github.com/henryiii) in [#960](https://github.com/just-the-docs/just-the-docs/pull/960)
416
+ - Fixed: active grandchild link class by [@pdmosses](https://github.com/pdmosses) in [#962](https://github.com/just-the-docs/just-the-docs/pull/962)
417
+ - Fixed: HTML validation issues (W3C validator) by [@mattxwang](https://github.com/mattxwang) in [#964](https://github.com/just-the-docs/just-the-docs/pull/964)
418
+ - Fixed: link styling now uses `text-decoration` values by [@mattxwang](https://github.com/mattxwang) in [#967](https://github.com/just-the-docs/just-the-docs/pull/967)
419
+ - Fixed: cleaning up Jekyll excludes by [@pdmosses](https://github.com/pdmosses) in [#985](https://github.com/just-the-docs/just-the-docs/pull/985)
420
+ - Fixed: docs, narrow styling for code highlighting with line numbers by [@pdmosses](https://github.com/pdmosses) in [#974](https://github.com/just-the-docs/just-the-docs/pull/974)
421
+ - Fixed: default syntax highlighting in custom color schemes [@pdmosses](https://github.com/pdmosses) in [#986](https://github.com/just-the-docs/just-the-docs/pull/986)
422
+
423
+ ## v0.4.0.rc2
424
+
425
+ - Added: accessible titles to nested page nav toggle by [@JPrevost](https://github.com/JPrevost) in [#950](https://github.com/just-the-docs/just-the-docs/pull/950)
426
+ - Added: better title styling for AsciiDoc examples by [@alyssais](https://github.com/alyssais) in [#944](https://github.com/just-the-docs/just-the-docs/pull/944)
427
+ - Added: docs for custom search placeholder by [@mattxwang](https://github.com/mattxwang) in [#939](https://github.com/just-the-docs/just-the-docs/pull/939)
428
+ - Added: provide ability to skip to main content by [@JPrevost](https://github.com/JPrevost) in [#949](https://github.com/just-the-docs/just-the-docs/pull/949)
429
+ - Fixed: exclude `vendor/` in Jekyll config by [@manuelhenke](https://github.com/manuelhenke) in [#941](https://github.com/just-the-docs/just-the-docs/pull/941)
430
+ - Fixed: improve build time of navigation panel by [@pdmosses](https://github.com/pdmosses) in [#956](https://github.com/just-the-docs/just-the-docs/pull/956)
431
+ - Added: docs load mermaid.js by default by [@mattxwang](https://github.com/mattxwang) in [#935](https://github.com/just-the-docs/just-the-docs/pull/935)
432
+ - Fixed: table of contents on search docs by [@robinpokorny](https://github.com/robinpokorny) in [#940](https://github.com/just-the-docs/just-the-docs/pull/940)
433
+ - Fixed: broken docs link (custom footer) by [@olgarithms](https://github.com/olgarithms) in [#951](https://github.com/just-the-docs/just-the-docs/pull/951)
434
+ - Fixed: clarify version docs by [@pdmosses](https://github.com/pdmosses) in [#955](https://github.com/just-the-docs/just-the-docs/pull/955)
435
+ - Deleted: unused script directory by [@mattxwang](https://github.com/mattxwang) in [#937](https://github.com/just-the-docs/just-the-docs/pull/937)
436
+
437
+ ## v0.4.0.rc1
438
+
439
+ - Added: Combination by [@pdmosses](https://github.com/pdmosses) in [#578](https://github.com/just-the-docs/just-the-docs/pull/578)
440
+ - Added: dark highlighting in [#463](https://github.com/just-the-docs/just-the-docs/pull/463)
441
+ - Added: pages and collections in [#448](https://github.com/just-the-docs/just-the-docs/pull/448)
442
+ - Added: callouts in [#466](https://github.com/just-the-docs/just-the-docs/pull/466)
443
+ - Fixed: breadcrumb behaviour … by [@AdityaTiwari2102](https://github.com/AdityaTiwari2102) in [#477](https://github.com/just-the-docs/just-the-docs/pull/477)
444
+ - Fixed: prevent rake command corrupting search data in [#495](https://github.com/just-the-docs/just-the-docs/pull/495) (also listed below)
445
+ - Fixed: nested lists in [#496](https://github.com/just-the-docs/just-the-docs/pull/496)
446
+ - Fixed: set color for search input in [#498](https://github.com/just-the-docs/just-the-docs/pull/498) (also listed below)
1381
447
  - Fixed: sites with no child pages (no PR)
1382
- - Fixed: TOC/breadcrumbs for multiple collections in [#494]
448
+ - Fixed: TOC/breadcrumbs for multiple collections in [#494](https://github.com/just-the-docs/just-the-docs/pull/494)
1383
449
  - Added: collection configuration option `nav_fold` (no PR)
1384
450
  - Fixed: indentation and color for folded collection navigation (no PR)
1385
- - Fixed: scroll navigation to show the link to the current page in [#639]
1386
- - Fixed: Replace all uses of `absolute_url` by `relative_url`, by [@svrooij] in [#544]
1387
- * Added: custom favicon `_includes` by [@burner1024] in [#364]
1388
- * Added: set color for search input by [@pdmosses] in [#498]
1389
- * Added: search placeholder configuration by [@mattxwang] in [#613]
1390
- * Added: 'child_nav_order' front matter to be able to sort navigation pages in reverse by [@jmertic] in [#726]
1391
- * Added: `nav_footer_custom` include by [@nathanjessen] in [#474]
1392
- * Added: style fixes for jekyll-asciidoc by [@alyssais] in [#829]
1393
- * Added: mermaid.js support by [@nascosto] in [#857]
1394
- * Added: support for external navigation links by [@SPGoding] in [#876]
1395
- * Added: refactor `mermaid` config to use `mermaid_config.js` include, only require `mermaid.version` in `_config.yml` by [@mattxwang] in [#909]
1396
- * Fixed: prepend `site.collections_dir` if exists by [@alexsegura] in [#519]
1397
- * Fixed: nested task lists (#517) by [@pdmosses] in [#855]
1398
- * Fixed: suppress Liquid processing in CSS comments by [@pdmosses] in [#686]
1399
- * Fixed: prevent rake command from corrupting search data by [@pdmosses] in [#495]
1400
- * Fixed: anchor heading links should be visible on focus by [@jacobhq] in [#846]
1401
- * Fixed: add `overflow-x: auto` to `figure.highlight` by [@iridazzle] in [#727]
1402
- * Fixed: add `overflow-wrap: word-break` to `body` by [@iridazzle] in [#889]
1403
- * Fixed: vertical alignment for consecutive labels by [@Eisverygoodletter] in [#893]
1404
- * Fixed: allow links to wrap by [@pdmosses] in [#905]
1405
- * Fixed: nav scroll feature and absolute/relative URLs by [@pdmosses] in [#898]
1406
-
1407
- [#578]: https://github.com/just-the-docs/just-the-docs/pull/578
1408
- [#463]: https://github.com/just-the-docs/just-the-docs/pull/463
1409
- [#448]: https://github.com/just-the-docs/just-the-docs/pull/448
1410
- [#466]: https://github.com/just-the-docs/just-the-docs/pull/466
1411
- [#477]: https://github.com/just-the-docs/just-the-docs/pull/477
1412
- [#495]: https://github.com/just-the-docs/just-the-docs/pull/495
1413
- [#496]: https://github.com/just-the-docs/just-the-docs/pull/496
1414
- [#498]: https://github.com/just-the-docs/just-the-docs/pull/498
1415
- [#494]: https://github.com/just-the-docs/just-the-docs/pull/494
1416
- [#639]: https://github.com/just-the-docs/just-the-docs/pull/639
1417
- [#544]: https://github.com/just-the-docs/just-the-docs/pull/544
1418
- [#364]: https://github.com/just-the-docs/just-the-docs/pull/364
1419
- [#498]: https://github.com/just-the-docs/just-the-docs/pull/498
1420
- [#613]: https://github.com/just-the-docs/just-the-docs/pull/613
1421
- [#726]: https://github.com/just-the-docs/just-the-docs/pull/726
1422
- [#474]: https://github.com/just-the-docs/just-the-docs/pull/474
1423
- [#829]: https://github.com/just-the-docs/just-the-docs/pull/829
1424
- [#857]: https://github.com/just-the-docs/just-the-docs/pull/857
1425
- [#876]: https://github.com/just-the-docs/just-the-docs/pull/876
1426
- [#909]: https://github.com/just-the-docs/just-the-docs/pull/909
1427
- [#519]: https://github.com/just-the-docs/just-the-docs/pull/519
1428
- [#855]: https://github.com/just-the-docs/just-the-docs/pull/855
1429
- [#686]: https://github.com/just-the-docs/just-the-docs/pull/686
1430
- [#495]: https://github.com/just-the-docs/just-the-docs/pull/495
1431
- [#846]: https://github.com/just-the-docs/just-the-docs/pull/846
1432
- [#727]: https://github.com/just-the-docs/just-the-docs/pull/727
1433
- [#889]: https://github.com/just-the-docs/just-the-docs/pull/889
1434
- [#893]: https://github.com/just-the-docs/just-the-docs/pull/893
1435
- [#905]: https://github.com/just-the-docs/just-the-docs/pull/905
1436
- [#898]: https://github.com/just-the-docs/just-the-docs/pull/898
1437
-
1438
- ### Documentation
1439
-
1440
- * Added: docs on how to break an `ol` by [@pdmosses] in [#856]
1441
- * Added: docs for custom includes by [@nathanjessen] in [#806]
1442
- * Added: document caveat about variable dependencies by [@waldyrious] in [#555]
1443
- * Added: docs on how to use `custom_head` to add a custom favicon by [@UnclassedPenguin] in [#814]
1444
- * Fixed: `ol` on `index.md` by [@pmarsceill] in [#778]
1445
- * Fixed: image link in Markdown kitchen sink by [@JeffGuKang] in [#221]
1446
- * Fixed: images in Markdown kitchen sink by [@dougaitken] in [#782]
1447
- * Fixed: clearer label of link to Jekyll quickstart by [@waldyrious] in [#549]
1448
- * Fixed: remove extra spaces in component docs by [@MichelleBlanchette] in [#554]
1449
- * Fixed: double "your" typo in `index.md` by [@sehilyi] in [#499]
1450
- * Fixed: "you" -> "your" typo in `index.md` by [@nathanjessen] in [#473]
1451
- * Fixed: spacing in toc example by [@henryiii] in [#835]
1452
- * Fixed: typo in `README` on `_config.yml` by [@ivanskodje] in [#891]
1453
- * Fixed: missing code fence in navigation structure docs by [@mattxwang] in [#906]
1454
-
1455
- [#856]: https://github.com/just-the-docs/just-the-docs/pull/856
1456
- [#806]: https://github.com/just-the-docs/just-the-docs/pull/806
1457
- [#555]: https://github.com/just-the-docs/just-the-docs/pull/555
1458
- [#814]: https://github.com/just-the-docs/just-the-docs/pull/814
1459
- [#778]: https://github.com/just-the-docs/just-the-docs/pull/778
1460
- [#221]: https://github.com/just-the-docs/just-the-docs/pull/221
1461
- [#782]: https://github.com/just-the-docs/just-the-docs/pull/782
1462
- [#549]: https://github.com/just-the-docs/just-the-docs/pull/549
1463
- [#554]: https://github.com/just-the-docs/just-the-docs/pull/554
1464
- [#499]: https://github.com/just-the-docs/just-the-docs/pull/499
1465
- [#473]: https://github.com/just-the-docs/just-the-docs/pull/473
1466
- [#835]: https://github.com/just-the-docs/just-the-docs/pull/835
1467
- [#891]: https://github.com/just-the-docs/just-the-docs/pull/891
1468
- [#906]: https://github.com/just-the-docs/just-the-docs/pull/906
1469
-
1470
- ### Maintenance
1471
-
1472
- * Added: VScode devcontainer by [@max06] in [#783]
1473
- * Added: `webrick` to `Gemfile` by [@mattxwang] in [#799]
1474
- * Added: 'This site is powered by Netlify.' to the footer by [@mattxwang] in [#797]
1475
- * Updated: new repo path by [@pmarsceill] in [#775]
1476
- * Updated: rename `master` -> `main` by [@pmarsceill] in [#776]
1477
- * Updated: README by [@pmarsceill] in [#777]
1478
- * Updated: Code of Conduct to Contributor Covenant v2.1 by [@mattxwang] in [#790]
1479
- * Updated: CI files, Ruby & Node Versions by [@mattxwang] in [#820]
1480
- * Updated: Stylelint to v14, extend SCSS plugins, remove primer-* configs, resolve issues by [@mattxwang] in [#821]
1481
-
1482
- [#783]: https://github.com/just-the-docs/just-the-docs/pull/783
1483
- [#799]: https://github.com/just-the-docs/just-the-docs/pull/799
1484
- [#797]: https://github.com/just-the-docs/just-the-docs/pull/797
1485
- [#775]: https://github.com/just-the-docs/just-the-docs/pull/775
1486
- [#776]: https://github.com/just-the-docs/just-the-docs/pull/776
1487
- [#777]: https://github.com/just-the-docs/just-the-docs/pull/777
1488
- [#790]: https://github.com/just-the-docs/just-the-docs/pull/790
1489
- [#820]: https://github.com/just-the-docs/just-the-docs/pull/820
1490
- [#821]: https://github.com/just-the-docs/just-the-docs/pull/821
1491
-
1492
- ### Dependencies
1493
-
1494
- * Upgrade to GitHub-native Dependabot by @dependabot-preview in [#627]
1495
- * [Security] Bump y18n from 3.2.1 to 3.2.2 by @dependabot-preview in [#606]
1496
- * [Security] Bump hosted-git-info from 2.7.1 to 2.8.9 by @dependabot-preview in [#641]
1497
- * [Security] Bump lodash from 4.17.19 to 4.17.21 by @dependabot-preview in [#640]
1498
- * [Security] Bump ini from 1.3.5 to 1.3.8 by @dependabot-preview in [#511]
1499
- * Bump path-parse from 1.0.6 to 1.0.7 by @dependabot in [#699]
1500
- * Bump ajv from 6.10.0 to 6.12.6 by @dependabot in [#766]
1501
- * Bump prettier from 2.1.2 to 2.5.1 by @dependabot in [#787]
1502
- * Bump prettier from 2.5.1 to 2.6.2 by @dependabot in [#809]
1503
- * Bump prettier from 2.6.2 to 2.7.1 by @dependabot in [#864]
1504
-
1505
- [#627]: https://github.com/just-the-docs/just-the-docs/pull/627
1506
- [#606]: https://github.com/just-the-docs/just-the-docs/pull/606
1507
- [#641]: https://github.com/just-the-docs/just-the-docs/pull/641
1508
- [#640]: https://github.com/just-the-docs/just-the-docs/pull/640
1509
- [#511]: https://github.com/just-the-docs/just-the-docs/pull/511
1510
- [#699]: https://github.com/just-the-docs/just-the-docs/pull/699
1511
- [#766]: https://github.com/just-the-docs/just-the-docs/pull/766
1512
- [#787]: https://github.com/just-the-docs/just-the-docs/pull/787
1513
- [#809]: https://github.com/just-the-docs/just-the-docs/pull/809
1514
- [#864]: https://github.com/just-the-docs/just-the-docs/pull/864
1515
-
1516
- ### New Contributors
1517
-
1518
- * [@AdityaTiwari2102] made their first contribution in [#477]
1519
- * [@svrooij] made their first contribution in [#544]
1520
- * [@alexsegura] made their first contribution in [#519]
1521
- * [@burner1024] made their first contribution in [#364]
1522
- * [@JeffGuKang] made their first contribution in [#221]
1523
- * [@dougaitken] made their first contribution in [#782]
1524
- * [@max06] made their first contribution in [#783]
1525
- * [@sehilyi] made their first contribution in [#499]
1526
- * [@nathanjessen] made their first contribution in [#473]
1527
- * [@waldyrious] made their first contribution in [#549]
1528
- * [@MichelleBlanchette] made their first contribution in [#554]
1529
- * [@henryiii] made their first contribution in [#835]
1530
- * [@jmertic] made their first contribution in [#726]
1531
- * [@jacobhq] made their first contribution in [#846]
1532
- * [@UnclassedPenguin] made their first contribution in [#814]
1533
- * [@alyssais] made their first contribution in [#829]
1534
- * [@nascosto] made their first contribution in [#857]
1535
- * [@SPGoding] made their first contribution in [#876]
1536
- * [@iridazzle] made their first contribution in [#727]
1537
- * [@ivanskodje] made their first contribution in [#891]
1538
- * [@Eisverygoodletter] made their first contribution in [#893]
1539
-
1540
- [@AdityaTiwari2102]: https://github.com/AdityaTiwari2102
1541
- [@svrooij]: https://github.com/svrooij
1542
- [@alexsegura]: https://github.com/alexsegura
1543
- [@burner1024]: https://github.com/burner1024
1544
- [@JeffGuKang]: https://github.com/JeffGuKang
1545
- [@dougaitken]: https://github.com/dougaitken
1546
- [@max06]: https://github.com/max06
1547
- [@sehilyi]: https://github.com/sehilyi
1548
- [@nathanjessen]: https://github.com/nathanjessen
1549
- [@waldyrious]: https://github.com/waldyrious
1550
- [@MichelleBlanchette]: https://github.com/MichelleBlanchette
1551
- [@henryiii]: https://github.com/henryiii
1552
- [@jmertic]: https://github.com/jmertic
1553
- [@jacobhq]: https://github.com/jacobhq
1554
- [@UnclassedPenguin]: https://github.com/UnclassedPenguin
1555
- [@alyssais]: https://github.com/alyssais
1556
- [@nascosto]: https://github.com/nascosto
1557
- [@SPGoding]: https://github.com/SPGoding
1558
- [@iridazzle]: https://github.com/iridazzle
1559
- [@ivanskodje]: https://github.com/ivanskodje
1560
- [@Eisverygoodletter]: https://github.com/Eisverygoodletter
1561
-
1562
- **Full Changelog**: https://github.com/just-the-docs/just-the-docs/compare/v0.3.3...v0.4.0.rc1
1563
-
1564
- [@pmarsceill]: https://github.com/pmarsceill
451
+ - Fixed: scroll navigation to show the link to the current page in [#639](https://github.com/just-the-docs/just-the-docs/pull/639)
452
+ - Fixed: Replace all uses of `absolute_url` by `relative_url`, by [@svrooij](https://github.com/svrooij) in [#544](https://github.com/just-the-docs/just-the-docs/pull/544)
453
+ - Added: custom favicon `_includes` by [@burner1024](https://github.com/burner1024) in [#364](https://github.com/just-the-docs/just-the-docs/pull/364)
454
+ - Added: set color for search input by [@pdmosses](https://github.com/pdmosses) in [#498](https://github.com/just-the-docs/just-the-docs/pull/498)
455
+ - Added: search placeholder configuration by [@mattxwang](https://github.com/mattxwang) in [#613](https://github.com/just-the-docs/just-the-docs/pull/613)
456
+ - Added: 'child_nav_order' front matter to be able to sort navigation pages in reverse by [@jmertic](https://github.com/jmertic) in [#726](https://github.com/just-the-docs/just-the-docs/pull/726)
457
+ - Added: `nav_footer_custom` include by [@nathanjessen](https://github.com/nathanjessen) in [#474](https://github.com/just-the-docs/just-the-docs/pull/474)
458
+ - Added: style fixes for jekyll-asciidoc by [@alyssais](https://github.com/alyssais) in [#829](https://github.com/just-the-docs/just-the-docs/pull/829)
459
+ - Added: mermaid.js support by [@nascosto](https://github.com/nascosto) in [#857](https://github.com/just-the-docs/just-the-docs/pull/857)
460
+ - Added: support for external navigation links by [@SPGoding](https://github.com/SPGoding) in [#876](https://github.com/just-the-docs/just-the-docs/pull/876)
461
+ - Added: refactor `mermaid` config to use `mermaid_config.js` include, only require `mermaid.version` in `_config.yml` by [@mattxwang](https://github.com/mattxwang) in [#909](https://github.com/just-the-docs/just-the-docs/pull/909)
462
+ - Fixed: prepend `site.collections_dir` if exists by [@alexsegura](https://github.com/alexsegura) in [#519](https://github.com/just-the-docs/just-the-docs/pull/519)
463
+ - Fixed: nested task lists (#517) by [@pdmosses](https://github.com/pdmosses) in [#855](https://github.com/just-the-docs/just-the-docs/pull/855)
464
+ - Fixed: suppress Liquid processing in CSS comments by [@pdmosses](https://github.com/pdmosses) in [#686](https://github.com/just-the-docs/just-the-docs/pull/686)
465
+ - Fixed: prevent rake command from corrupting search data by [@pdmosses](https://github.com/pdmosses) in [#495](https://github.com/just-the-docs/just-the-docs/pull/495)
466
+ - Fixed: anchor heading links should be visible on focus by [@jacobhq](https://github.com/jacobhq) in [#846](https://github.com/just-the-docs/just-the-docs/pull/846)
467
+ - Fixed: add `overflow-x: auto` to `figure.highlight` by [@iridazzle](https://github.com/iridazzle) in [#727](https://github.com/just-the-docs/just-the-docs/pull/727)
468
+ - Fixed: add `overflow-wrap: word-break` to `body` by [@iridazzle](https://github.com/iridazzle) in [#889](https://github.com/just-the-docs/just-the-docs/pull/889)
469
+ - Fixed: vertical alignment for consecutive labels by [@Eisverygoodletter](https://github.com/Eisverygoodletter) in [#893](https://github.com/just-the-docs/just-the-docs/pull/893)
470
+ - Fixed: allow links to wrap by [@pdmosses](https://github.com/pdmosses) in [#905](https://github.com/just-the-docs/just-the-docs/pull/905)
471
+ - Fixed: nav scroll feature and absolute/relative URLs by [@pdmosses](https://github.com/pdmosses) in [#898](https://github.com/just-the-docs/just-the-docs/pull/898)
472
+ - Documentation changes
473
+ - Added: docs on how to break an `ol` by [@pdmosses](https://github.com/pdmosses) in [#856](https://github.com/just-the-docs/just-the-docs/pull/856)
474
+ - Added: docs for custom includes by [@nathanjessen](https://github.com/nathanjessen) in [#806](https://github.com/just-the-docs/just-the-docs/pull/806)
475
+ - Added: document caveat about variable dependencies by [@waldyrious](https://github.com/waldyrious) in [#555](https://github.com/just-the-docs/just-the-docs/pull/555)
476
+ - Added: docs on how to use `custom_head` to add a custom favicon by [@UnclassedPenguin](https://github.com/UnclassedPenguin) in [#814](https://github.com/just-the-docs/just-the-docs/pull/814)
477
+ - Fixed: `ol` on `index.md` by [@pmarsceill](https://github.com/pmarsceill) in [#778](https://github.com/just-the-docs/just-the-docs/pull/778)
478
+ - Fixed: image link in Markdown kitchen sink by [@JeffGuKang](https://github.com/JeffGuKang) in [#221](https://github.com/just-the-docs/just-the-docs/pull/221)
479
+ - Fixed: images in Markdown kitchen sink by [@dougaitken](https://github.com/dougaitken) in [#782](https://github.com/just-the-docs/just-the-docs/pull/782)
480
+ - Fixed: clearer label of link to Jekyll quickstart by [@waldyrious](https://github.com/waldyrious) in [#549](https://github.com/just-the-docs/just-the-docs/pull/549)
481
+ - Fixed: remove extra spaces in component docs by [@MichelleBlanchette](https://github.com/MichelleBlanchette) in [#554](https://github.com/just-the-docs/just-the-docs/pull/554)
482
+ - Fixed: double "your" typo in `index.md` by [@sehilyi](https://github.com/sehilyi) in [#499](https://github.com/just-the-docs/just-the-docs/pull/499)
483
+ - Fixed: "you" to "your" typo in `index.md` by [@nathanjessen](https://github.com/nathanjessen) in [#473](https://github.com/just-the-docs/just-the-docs/pull/473)
484
+ - Fixed: spacing in toc example by [@henryiii](https://github.com/henryiii) in [#835](https://github.com/just-the-docs/just-the-docs/pull/835)
485
+ - Fixed: typo in `README` on `_config.yml` by [@ivanskodje](https://github.com/ivanskodje) in [#891](https://github.com/just-the-docs/just-the-docs/pull/891)
486
+ - Fixed: missing code fence in navigation structure docs by [@mattxwang](https://github.com/mattxwang) in [#906](https://github.com/just-the-docs/just-the-docs/pull/906)
487
+ - Maintenance changes (developer-only)
488
+ - Added: VScode devcontainer by [@max06](https://github.com/max06) in [#783](https://github.com/just-the-docs/just-the-docs/pull/783)
489
+ - Added: `webrick` to `Gemfile` by [@mattxwang](https://github.com/mattxwang) in [#799](https://github.com/just-the-docs/just-the-docs/pull/799)
490
+ - Added: 'This site is powered by Netlify.' to the footer by [@mattxwang](https://github.com/mattxwang) in [#797](https://github.com/just-the-docs/just-the-docs/pull/797)
491
+ - Updated: new repo path by [@pmarsceill](https://github.com/pmarsceill) in [#775](https://github.com/just-the-docs/just-the-docs/pull/775)
492
+ - Updated: rename `master` to `main` by [@pmarsceill](https://github.com/pmarsceill) in [#776](https://github.com/just-the-docs/just-the-docs/pull/776)
493
+ - Updated: README by [@pmarsceill](https://github.com/pmarsceill) in [#777](https://github.com/just-the-docs/just-the-docs/pull/777)
494
+ - Updated: Code of Conduct to Contributor Covenant v2.1 by [@mattxwang](https://github.com/mattxwang) in [#790](https://github.com/just-the-docs/just-the-docs/pull/790)
495
+ - Updated: CI files, Ruby & Node Versions by [@mattxwang](https://github.com/mattxwang) in [#820](https://github.com/just-the-docs/just-the-docs/pull/820)
496
+ - Updated: Stylelint to v14, extend SCSS plugins, remove primer-* configs, resolve issues by [@mattxwang](https://github.com/mattxwang) in [#821](https://github.com/just-the-docs/just-the-docs/pull/821)
1565
497
 
1566
498
  ## v0.3.3
1567
499
 
@@ -1615,7 +547,6 @@ as well as DX improvements like better regression tests, CI, and tooling. If you
1615
547
  - Bump lodash from 4.17.15 to 4.17.19 @dependabot (#384)
1616
548
  - Bump @primer/css from 14.4.0 to 15.0.0 @dependabot-preview (#371)
1617
549
 
1618
-
1619
550
  ## v0.3.1
1620
551
 
1621
552
  ### Changes
@@ -1629,7 +560,6 @@ as well as DX improvements like better regression tests, CI, and tooling. If you
1629
560
  - Remove collapsible TOC on nav doc @pmarsceill (#368)
1630
561
  - Pdmosses collapsible toc @pmarsceill (#367)
1631
562
 
1632
-
1633
563
  ## v0.3.0
1634
564
 
1635
565
  ### Changes
@@ -1651,7 +581,6 @@ as well as DX improvements like better regression tests, CI, and tooling. If you
1651
581
  - Bump stylelint from 13.3.3 to 13.6.1 @dependabot-preview (#343)
1652
582
  - Bump stylelint-config-prettier from 8.0.1 to 8.0.2 @dependabot-preview (#349)
1653
583
 
1654
-
1655
584
  ## v0.2.9
1656
585
 
1657
586
  ### Bug fixes
@@ -1755,7 +684,6 @@ fixes #291 #256 #293 #177
1755
684
  #159 by @julienduchesne - Optimizes nav generation
1756
685
  #162 by @nergmada - Modifies the google analytics code to match the new tags used by GA
1757
686
 
1758
-
1759
687
  ## v0.2.5
1760
688
 
1761
689
  ### Bugs fixed