opendevsecops-jekyll 0.1.0

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 (90) hide show
  1. checksums.yaml +7 -0
  2. data/CHANGELOG.md +1755 -0
  3. data/LICENSE.txt +21 -0
  4. data/README.md +110 -0
  5. data/Rakefile +1 -0
  6. data/_includes/components/aux_nav.html +15 -0
  7. data/_includes/components/breadcrumbs.html +144 -0
  8. data/_includes/components/children_nav.html +33 -0
  9. data/_includes/components/footer.html +34 -0
  10. data/_includes/components/header.html +11 -0
  11. data/_includes/components/mermaid.html +45 -0
  12. data/_includes/components/nav.html +75 -0
  13. data/_includes/components/search_footer.html +7 -0
  14. data/_includes/components/search_header.html +9 -0
  15. data/_includes/components/sidebar.html +32 -0
  16. data/_includes/components/site_nav.html +67 -0
  17. data/_includes/css/activation.scss.liquid +332 -0
  18. data/_includes/css/callouts.scss.liquid +93 -0
  19. data/_includes/css/custom.scss.liquid +1 -0
  20. data/_includes/css/just-the-docs.scss.liquid +12 -0
  21. data/_includes/favicon.html +23 -0
  22. data/_includes/fix_linenos.html +73 -0
  23. data/_includes/footer_custom.html +3 -0
  24. data/_includes/head.html +53 -0
  25. data/_includes/head_custom.html +0 -0
  26. data/_includes/header_custom.html +0 -0
  27. data/_includes/icons/code_copy.html +15 -0
  28. data/_includes/icons/document.html +6 -0
  29. data/_includes/icons/expand.html +6 -0
  30. data/_includes/icons/external_link.html +5 -0
  31. data/_includes/icons/icons.html +13 -0
  32. data/_includes/icons/link.html +6 -0
  33. data/_includes/icons/menu.html +6 -0
  34. data/_includes/icons/search.html +6 -0
  35. data/_includes/js/custom.js +0 -0
  36. data/_includes/lunr/custom-data.json +0 -0
  37. data/_includes/lunr/custom-index.js +0 -0
  38. data/_includes/mermaid_config.js +1 -0
  39. data/_includes/nav_footer_custom.html +0 -0
  40. data/_includes/search_placeholder_custom.html +1 -0
  41. data/_includes/sorted_pages.html +109 -0
  42. data/_includes/title.html +5 -0
  43. data/_includes/toc_heading_custom.html +1 -0
  44. data/_layouts/about.html +5 -0
  45. data/_layouts/default.html +41 -0
  46. data/_layouts/home.html +5 -0
  47. data/_layouts/minimal.html +34 -0
  48. data/_layouts/page.html +5 -0
  49. data/_layouts/post.html +5 -0
  50. data/_layouts/table_wrappers.html +7 -0
  51. data/_sass/base.scss +113 -0
  52. data/_sass/buttons.scss +127 -0
  53. data/_sass/code.scss +246 -0
  54. data/_sass/color_schemes/dark.scss +18 -0
  55. data/_sass/color_schemes/legacy_light.scss +208 -0
  56. data/_sass/color_schemes/light.scss +16 -0
  57. data/_sass/content.scss +239 -0
  58. data/_sass/custom/custom.scss +1 -0
  59. data/_sass/custom/setup.scss +1 -0
  60. data/_sass/labels.scss +37 -0
  61. data/_sass/layout.scss +209 -0
  62. data/_sass/modules.scss +17 -0
  63. data/_sass/navigation.scss +235 -0
  64. data/_sass/print.scss +40 -0
  65. data/_sass/search.scss +324 -0
  66. data/_sass/skiptomain.scss +30 -0
  67. data/_sass/support/_variables.scss +117 -0
  68. data/_sass/support/mixins/_buttons.scss +29 -0
  69. data/_sass/support/mixins/_layout.scss +33 -0
  70. data/_sass/support/mixins/_typography.scss +84 -0
  71. data/_sass/support/mixins/mixins.scss +3 -0
  72. data/_sass/support/support.scss +2 -0
  73. data/_sass/tables.scss +56 -0
  74. data/_sass/typography.scss +63 -0
  75. data/_sass/utilities/_colors.scss +237 -0
  76. data/_sass/utilities/_layout.scss +101 -0
  77. data/_sass/utilities/_lists.scss +15 -0
  78. data/_sass/utilities/_spacing.scss +162 -0
  79. data/_sass/utilities/_typography.scss +85 -0
  80. data/_sass/utilities/utilities.scss +5 -0
  81. data/assets/css/just-the-docs-dark.scss +3 -0
  82. data/assets/css/just-the-docs-default.scss +8 -0
  83. data/assets/css/just-the-docs-head-nav.css +24 -0
  84. data/assets/css/just-the-docs-light.scss +3 -0
  85. data/assets/js/just-the-docs.js +616 -0
  86. data/assets/js/zzzz-search-data.json +74 -0
  87. data/bin/just-the-docs +16 -0
  88. data/favicon.ico +0 -0
  89. data/lib/tasks/search.rake +88 -0
  90. metadata +201 -0
data/CHANGELOG.md ADDED
@@ -0,0 +1,1755 @@
1
+ ---
2
+ title: CHANGELOG
3
+ layout: default
4
+ ---
5
+
6
+ # CHANGELOG
7
+
8
+ All notable user-facing changes to this project are documented in this file.
9
+
10
+ {: .highlight }
11
+ The project underwent a major maintenance shift in March 2022.
12
+
13
+ ## HEAD
14
+
15
+ {: .note }
16
+ This website is built from the `HEAD` of the `main` branch of the theme repository.
17
+
18
+ Code changes to `main` that are *not* in the latest release:
19
+
20
+ - N/A
21
+
22
+ Docs changes made since the latest release:
23
+
24
+ - N/A
25
+
26
+ ## Release v0.8.2
27
+
28
+ 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!
29
+
30
+ ### Bugfixes
31
+
32
+ - Fixed: Protect theme JS file from front matter default for layout by [@pdmosses] in [#1447]
33
+
34
+ [#1447]: https://github.com/just-the-docs/just-the-docs/pull/1447
35
+
36
+ ## Release v0.8.1
37
+
38
+ 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!
39
+
40
+ ### Bugfixes
41
+
42
+ - Fixed: Liquid filter typo in breadcrumb component (`strip` instead of `trim`) by [@Zarthus] in [#1434]
43
+
44
+ ### Documentation
45
+
46
+ - Build docs site using strict mode and `strict_filters` by [@Zarthus] in [#1435]
47
+
48
+ ### New Contributors
49
+
50
+ - [@Zarthus] made their first contribution in [#1434]
51
+
52
+ [@Zarthus]: https://github.com/Zarthus
53
+
54
+ [#1434]: https://github.com/just-the-docs/just-the-docs/pull/1434
55
+ [#1435]: https://github.com/just-the-docs/just-the-docs/pull/1435
56
+
57
+ ## Release v0.8.0
58
+
59
+ 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.
60
+
61
+ ### Using Release `v0.8.0`
62
+
63
+ Users who have not pinned the theme version will be **automatically upgraded to `v0.8.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.8.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.8.0"
75
+ ```
76
+
77
+ To use and pin a previous version of the theme, replace the `0.8.0` with the desired release tag.
78
+
79
+ ### New Features
80
+
81
+ - Added: configurable keyboard shortcut to focus search input by [@kcromanpl-bajra] in [#1411]
82
+
83
+ ### Bugfixes
84
+
85
+ - Fixed: quicker build by [@pdmosses] in [#1397]
86
+ - Fixed: incorrect navigation when `.html` omitted from URL by [@pdmosses] in [#1374]
87
+ - Fixed: incorrect positioning of clickable area for navigation links on Safari by [@mattxwang] in [#1403]
88
+
89
+ ### Documentation
90
+
91
+ - Add documentation to "Navigation Structure" on grouping pages with collections by [@mitchnemirov] in [#1390]
92
+
93
+ ### New Contributors
94
+
95
+ - [@mitchnemirov] made their first contribution in [#1390]
96
+ - [@kcromanpl-bajra] made their first contribution in [#1411]
97
+
98
+ [@mitchnemirov]: https://github.com/mitchnemirov
99
+ [@kcromanpl-bajra]: https://github.com/kcromanpl-bajra
100
+
101
+ [#1374]: https://github.com/just-the-docs/just-the-docs/pull/1374
102
+ [#1390]: https://github.com/just-the-docs/just-the-docs/pull/1390
103
+ [#1397]: https://github.com/just-the-docs/just-the-docs/pull/1397
104
+ [#1403]: https://github.com/just-the-docs/just-the-docs/pull/1403
105
+ [#1411]: https://github.com/just-the-docs/just-the-docs/pull/1411
106
+
107
+ ## Release v0.7.0
108
+
109
+ 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.
110
+
111
+ ### Migrating to `v0.7.0`
112
+
113
+ **Migration**: users will need to migrate if:
114
+
115
+ - they overrode `_includes/nav.html`, which has moved to `_includes/components/nav.html`
116
+ - they have an element with the IDs `jtd-nav-activation` or `jtd-head-nav-stylesheet`
117
+
118
+ For more, refer to the [migration guide](https://just-the-docs.com/MIGRATION/).
119
+
120
+ ### Using Release `v0.7.0`
121
+
122
+ Users who have not pinned the theme version will be **automatically upgraded to `v0.7.0` the next time they build their site**.
123
+
124
+ To use this release explicitly as a remote theme:
125
+
126
+ ```yml
127
+ remote_theme: just-the-docs/just-the-docs@v0.7.0
128
+ ```
129
+
130
+ 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`:
131
+
132
+ ```ruby
133
+ gem "just-the-docs", "0.7.0"
134
+ ```
135
+
136
+ To use and pin a previous version of the theme, replace the `0.7.0` with the desired release tag.
137
+
138
+ ### New Features
139
+
140
+ - Added: configuration options for opening external links in new tab by [@CarbonNeuron] in [#1360]
141
+
142
+ ### Bugfixes
143
+
144
+ - Fixed: remove href from the navigation link to the current page by [@pdmosses] in [#1356]
145
+ - Fixed: improve build time by [@pdmosses] in [#1358]
146
+ - Fixed: erroneous parentheses in `site_nav` conditional by [@mattxwang] in [#1366]
147
+ - Fixed: navigation scroll to active link regression by [@pdmosses] in [#1367]
148
+ - Fixed: invalid CSS rules in head elements by [@pdmosses] in [#1368]
149
+ - Fixed: accidental disabling of forward-declared stylesheets by [@mattxwang] in [#1373]
150
+
151
+ {: .warning }
152
+ [#1358] moved `_includes/nav.html` to the `_includes/components` directory,
153
+ Users who were overriding that file will need to adjust their sites accordingly.
154
+
155
+ ### Documentation:
156
+
157
+ - Docs: fix typos in `CHANGELOG` and `MIGRATION` by [@thapasusheel] in [#1377]
158
+
159
+ ### New Contributors
160
+
161
+ - [@CarbonNeuron] made their first contribution in [#1360]
162
+ - [@thapasusheel] made their first contribution in [#1377]
163
+
164
+ [@CarbonNeuron]: https://github.com/CarbonNeuron
165
+ [@thapasusheel]: https://github.com/thapasusheel
166
+
167
+ [#1356]: https://github.com/just-the-docs/just-the-docs/pull/1356
168
+ [#1358]: https://github.com/just-the-docs/just-the-docs/pull/1358
169
+ [#1360]: https://github.com/just-the-docs/just-the-docs/pull/1360
170
+ [#1366]: https://github.com/just-the-docs/just-the-docs/pull/1366
171
+ [#1367]: https://github.com/just-the-docs/just-the-docs/pull/1367
172
+ [#1368]: https://github.com/just-the-docs/just-the-docs/pull/1368
173
+ [#1373]: https://github.com/just-the-docs/just-the-docs/pull/1373
174
+ [#1377]: https://github.com/just-the-docs/just-the-docs/pull/1377
175
+
176
+ ## Release v0.6.2
177
+
178
+ 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.
179
+
180
+ ### Bugfixes
181
+
182
+ - Fixed: Windows emoji font fallback by [@flanakin] in [#1337]
183
+ - Removed: unused `.passive` toggle in navigation by [@pdmosses] in [#1335]
184
+
185
+ [#1335]: https://github.com/just-the-docs/just-the-docs/pull/1335
186
+ [#1337]: https://github.com/just-the-docs/just-the-docs/pull/1337
187
+
188
+ ### New Contributors
189
+
190
+ - [@flanakin] made their first contribution in [#1337]
191
+
192
+ [@flanakin]: https://github.com/flanakin
193
+
194
+ ## Release v0.6.1
195
+
196
+ 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.
197
+
198
+ ### Bugfixes
199
+
200
+ - Fixed: JS error for pages excluded from navigation by [@pdmosses] in [#1332]
201
+
202
+ [#1332]: https://github.com/just-the-docs/just-the-docs/pull/1332
203
+
204
+ ## Release v0.6.0
205
+
206
+ 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.
207
+
208
+ ### Migrating to `v0.6.0`
209
+
210
+ **Migration**: users will need to migrate if:
211
+
212
+ - they have an existing `_includes` file named `favicon.html`, `head_nav.html`, or `css/activation.scss.liquid`
213
+ - they have code that refers to `#main-content-wrap`
214
+ - they override the default `light` theme's code, or the theme-loading logic
215
+ - they have different favicons for different pages
216
+
217
+ For more, refer to the [migration guide](https://just-the-docs.com/MIGRATION/).
218
+
219
+ ### Using Release `v0.6.0`
220
+
221
+ Users who have not pinned the theme version will be **automatically upgraded to `v0.6.0` the next time they build their site**.
222
+
223
+ To use this release explicitly as a remote theme:
224
+
225
+ ```yml
226
+ remote_theme: just-the-docs/just-the-docs@v0.6.0
227
+ ```
228
+
229
+ 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`:
230
+
231
+ ```ruby
232
+ gem "just-the-docs", "0.6.0"
233
+ ```
234
+
235
+ To use and pin a previous version of the theme, replace the `0.6.0` with the desired release tag.
236
+
237
+ ### New Features and Bugfixes
238
+
239
+ - Added: `$color-scheme` theme variable to specify `color-scheme` for `:root` by [@sigv] in [#1280]
240
+ - Fixed: build times for large sites by [@pdmosses] in [#1244]
241
+ - Fixed: missing closing `</button>` tag in `sidebar.html` by [@mattxwang] in [#1304]
242
+ - Fixed: removed duplicate `#main-content-wrap` minimal and default layouts by [@mattxwang] in [#1305]
243
+
244
+ ### Documentation
245
+
246
+ {: .warning }
247
+ The theme docs are unversioned, and already reflect the above changes.
248
+
249
+ Docs changes:
250
+
251
+ - 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.
252
+ - Invalid HTML has been removed from most documentation examples.
253
+
254
+ ### New Contributors
255
+
256
+ - [@sigv] made their first contribution in [#1280]
257
+
258
+ [@sigv]: https://github.com/sigv
259
+ [#1244]: https://github.com/just-the-docs/just-the-docs/pull/1244
260
+ [#1280]: https://github.com/just-the-docs/just-the-docs/pull/1280
261
+ [#1304]: https://github.com/just-the-docs/just-the-docs/pull/1304
262
+ [#1305]: https://github.com/just-the-docs/just-the-docs/pull/1305
263
+
264
+ ## Release v0.5.4
265
+
266
+ 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.
267
+
268
+ *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.*
269
+
270
+ ### Bugfixes
271
+
272
+ - Fixed: Mermaid labels inheriting theme `.label` styling by [@mattxwang] in [#1278]
273
+
274
+ [#1278]: https://github.com/just-the-docs/just-the-docs/pull/1278
275
+
276
+ ## Release v0.5.3
277
+
278
+ 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:
279
+
280
+ 1. All deprecation warnings are now fixed on build; you should now get a clean build with `jekyll build`.
281
+ 2. We have **deprecated the `$root-font-size` SCSS variable**. We will remove it in an upcoming release of the theme.
282
+
283
+ 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.
284
+
285
+ ### Using Release `v0.5.3`
286
+
287
+ Users who have not pinned the theme version will be **automatically upgraded to `v0.5.3` the next time they build their site**.
288
+
289
+ To use this release explicitly as a remote theme:
290
+
291
+ ```yml
292
+ remote_theme: just-the-docs/just-the-docs@v0.5.3
293
+ ```
294
+
295
+ 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`:
296
+
297
+ ```ruby
298
+ gem "just-the-docs", "0.5.3"
299
+ ```
300
+
301
+ To use and pin a previous version of the theme, replace the `0.5.3` with the desired release tag.
302
+
303
+ ### Bugfixes
304
+
305
+ - 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]
306
+
307
+ [#1169]: https://github.com/just-the-docs/just-the-docs/pull/1169
308
+
309
+ ## Release v0.5.2
310
+
311
+ 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.
312
+
313
+ 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!
314
+
315
+ ### Using Release `v0.5.2`
316
+
317
+ Users who have not pinned the theme version will be **automatically upgraded to `v0.5.2` the next time they build their site**.
318
+
319
+ To use this release explicitly as a remote theme:
320
+
321
+ ```yml
322
+ remote_theme: just-the-docs/just-the-docs@v0.5.2
323
+ ```
324
+
325
+ 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`:
326
+
327
+ ```ruby
328
+ gem "just-the-docs", "0.5.2"
329
+ ```
330
+
331
+ To use and pin a previous version of the theme, replace the `0.5.2` with the desired release tag.
332
+
333
+ ### Bugfixes
334
+
335
+ - Fixed: liquid variable leakage in navigation components by [@pdmosses] in [#1243]
336
+ - Fixed: ARIA roles and labels for search, header, logo, mobile menu button, and main content by [@joelhawksley] in [#1259]
337
+ - Fixed: ARIA labels for all anchors with `href="#"`; adds `aria-pressed` information for toggles by [@mattxwang] in [#1262]
338
+
339
+ ### New Contributors
340
+
341
+ - [@joelhawksley] made their first contribution in [#1259]
342
+
343
+ [@joelhawksley]: https://github.com/joelhawksley
344
+
345
+ [#1243]: https://github.com/just-the-docs/just-the-docs/pull/1243
346
+ [#1259]: https://github.com/just-the-docs/just-the-docs/pull/1259
347
+ [#1262]: https://github.com/just-the-docs/just-the-docs/pull/1262
348
+
349
+ ## Release v0.5.1
350
+
351
+ 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.
352
+
353
+ 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!
354
+
355
+ ### Using Release `v0.5.1`
356
+
357
+ Users who have not pinned the theme version will be **automatically upgraded to `v0.5.1` the next time they build their site**.
358
+
359
+ To use this release explicitly as a remote theme:
360
+
361
+ ```yml
362
+ remote_theme: just-the-docs/just-the-docs@v0.5.1
363
+ ```
364
+
365
+ 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`:
366
+
367
+ ```ruby
368
+ gem "just-the-docs", "0.5.1"
369
+ ```
370
+
371
+ To use and pin a previous version of the theme, replace the `0.5.1` with the desired release tag.
372
+
373
+ ### Bugfixes
374
+
375
+
376
+ - Fixed: disable copy code button in insecure contexts [@rmoff] in [#1226]
377
+ - Fixed: context-based media feature not supported by Safari `<16.4` by [@mattxwang] in [#1240]
378
+
379
+ ### Documentation
380
+
381
+ - Added: document copy code button requiring secure context by [@rmoff] in [#1225]
382
+ - Fixed: typo ("them" → "theme") in MIGRATION.md by [@waldyrious] in [#1219]
383
+ - Fixed: `font-weight` typo (Utilities > Typography) by [@mattxwang] in [#1229]
384
+ - Fixed: `just the docs` typo in migration guide by [@mattxwang] in [#1230]
385
+
386
+ ### New Contributors
387
+ - [@rmoff] made their first contribution in [#1225]
388
+
389
+ [#1219]: https://github.com/just-the-docs/just-the-docs/pull/1219
390
+ [#1225]: https://github.com/just-the-docs/just-the-docs/pull/1225
391
+ [#1226]: https://github.com/just-the-docs/just-the-docs/pull/1226
392
+ [#1229]: https://github.com/just-the-docs/just-the-docs/pull/1229
393
+ [#1230]: https://github.com/just-the-docs/just-the-docs/pull/1230
394
+ [#1240]: https://github.com/just-the-docs/just-the-docs/pull/1240
395
+
396
+ [@rmoff]: https://github.com/rmoff
397
+
398
+ ## Release v0.5.0
399
+
400
+ 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`.
401
+
402
+ 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.
403
+
404
+ 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!
405
+
406
+ ### Migrating to `v0.5.0`
407
+
408
+ **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.
409
+
410
+ For more, refer to the [migration guide](https://just-the-docs.com/MIGRATION/).
411
+
412
+ ### Using Release `v0.5.0`
413
+
414
+ Users who have not pinned the theme version will be **automatically upgraded to `v0.5.0` the next time they build their site**.
415
+
416
+ To use this release explicitly as a remote theme:
417
+
418
+ ```yml
419
+ remote_theme: just-the-docs/just-the-docs@v0.5.0
420
+ ```
421
+
422
+ 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`:
423
+
424
+ ```ruby
425
+ gem "just-the-docs", "0.5.0"
426
+ ```
427
+
428
+ To use and pin a previous version of the theme, replace the `0.5.0` with the desired release tag.
429
+
430
+ ### Bugfixes
431
+
432
+ - **Reverted (breaking)**: "Fix import order for `setup.scss` (#1184)" by [@mattxwang] in [#1209]
433
+ - Fixed: color contrast issues with `::selection` (reverting to browser defaults) [@mattxwang] in [#1208]
434
+ - Fixed: mermaid `v10`, bundle all mermaid code in component by [@mattxwang] in [#1190]
435
+ - Removed: unused images (`just-the-docs.png`, `search.svg`) by [@mattxwang] in [#1107]
436
+ - Removed: `CODE_OF_CONDUCT`, `docker-compose`, and `Dockerfile` files from site by [@mattxwang] in [#1187]
437
+
438
+ **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)
439
+
440
+ [#1107]: https://github.com/just-the-docs/just-the-docs/pull/1107
441
+ [#1187]: https://github.com/just-the-docs/just-the-docs/pull/1187
442
+ [#1190]: https://github.com/just-the-docs/just-the-docs/pull/1190
443
+ [#1208]: https://github.com/just-the-docs/just-the-docs/pull/1208
444
+ [#1209]: https://github.com/just-the-docs/just-the-docs/pull/1209
445
+
446
+ ## Release v0.4.2
447
+
448
+ 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.
449
+
450
+ 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`.
451
+
452
+ 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!
453
+
454
+ ### Using Release `v0.4.2`
455
+
456
+ Users who have not pinned the theme version will be **automatically upgraded to `v0.4.2` the next time they build their site**.
457
+
458
+ To use this release explicitly as a remote theme:
459
+
460
+ ```yml
461
+ remote_theme: just-the-docs/just-the-docs@v0.4.2
462
+ ```
463
+
464
+ 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`:
465
+
466
+ ```ruby
467
+ gem "just-the-docs", "0.4.2"
468
+ ```
469
+
470
+ To use and pin a previous version of the theme, replace the `0.4.2` with the desired release tag.
471
+
472
+ ### Bugfixes
473
+
474
+ - Fixed: light scheme code highlighting contrast issues; updated to use Atom's One Light colors, consolidate theme variables by [@mattxwang] in [#1166]
475
+ - Fixed: duplicate import of `color_schemes` by [@mattxwang] in [#1173]
476
+ - Fixed: import order for `setup.scss` by [@mattxwang] in [#1184]
477
+ - Removed: unused dark syntax themes by [@mattxwang] in [#1192]
478
+
479
+ ### Documentation
480
+
481
+ - Added: docs for using mermaid with AsciiDoc by [@flyx] in [#1182]
482
+
483
+ **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)
484
+
485
+ [#1166]: https://github.com/just-the-docs/just-the-docs/pull/1166
486
+ [#1173]: https://github.com/just-the-docs/just-the-docs/pull/1173
487
+ [#1182]: https://github.com/just-the-docs/just-the-docs/pull/1182
488
+ [#1184]: https://github.com/just-the-docs/just-the-docs/pull/1184
489
+ [#1192]: https://github.com/just-the-docs/just-the-docs/pull/1192
490
+
491
+ ## Release v0.4.1
492
+
493
+ 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.
494
+
495
+ 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!
496
+
497
+ ### Using Release `v0.4.1`
498
+
499
+ Users who have not pinned the theme version will be **automatically upgraded to `v0.4.1` the next time they build their site**.
500
+
501
+ To use this release explicitly as a remote theme:
502
+
503
+ ```yml
504
+ remote_theme: just-the-docs/just-the-docs@v0.4.1
505
+ ```
506
+
507
+ 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`:
508
+
509
+ ```ruby
510
+ gem "just-the-docs", "0.4.1"
511
+ ```
512
+
513
+ To use and pin a previous version of the theme, replace the `0.4.1` with the desired release tag.
514
+
515
+ ### Bugfixes
516
+
517
+ - Fixed: allow later versions of `bundler` by [@mattxwang] in [#1165]
518
+ - Fixed: AsciiDoc code block styling by [@flyx] in [#1168]
519
+ - Fixed: main content negative margin for viewports in `[$md, $nav-width + $content-width]` by [@Dima-369] in [#1177]
520
+ - Removed: unused `OneDarkJekyll` files by [@mattxwang] in [#1167]
521
+
522
+ ### Documentation
523
+
524
+ - Fixed: re-add `jekyll-github-metadata` to docs site by [@mattxwang] in [#1108]
525
+
526
+ ### New Contributors
527
+
528
+ - [@flyx] made their first contribution in [#1168]
529
+ - [@Dima-369] made their first contribution in [#1177]
530
+
531
+ [#1108]: https://github.com/just-the-docs/just-the-docs/pull/1108
532
+ [#1165]: https://github.com/just-the-docs/just-the-docs/pull/1165
533
+ [#1167]: https://github.com/just-the-docs/just-the-docs/pull/1167
534
+ [#1168]: https://github.com/just-the-docs/just-the-docs/pull/1168
535
+ [#1177]: https://github.com/just-the-docs/just-the-docs/pull/1177
536
+
537
+ [@flyx]: https://github.com/flyx
538
+ [@Dima-369]: https://github.com/Dima-369
539
+
540
+ **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)
541
+
542
+ ## Release v0.4.0
543
+
544
+ 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.
545
+
546
+ ### Brief Overview - Highlighted Changes
547
+
548
+ `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:
549
+
550
+ - better support for dark theme: dark highlighting, search input color
551
+ - [callouts](https://just-the-docs.com/docs/ui-components/callouts/), a new design component to highlight content
552
+ - [configuring mermaid.js](https://just-the-docs.com/docs/ui-components/code/#mermaid-diagram-code-blocks), a markdown-native diagram visualization library
553
+ - [copy code button](https://just-the-docs.com/docs/ui-components/code/#copy-button) for code snippets
554
+ - [external navigation links](https://just-the-docs.com/docs/navigation-structure/#external-navigation-links)
555
+ - major improvements to nav generation efficiency and robustness
556
+ - minor improvements to built-in accessibility (SVG icons, nav titles, skip to main content)
557
+ - [modularized site components](https://just-the-docs.com/docs/customization/#custom-layouts-and-includes) (advanced feature)
558
+ - [new custom includes](https://just-the-docs.com/docs/customization/#override-includes): table of contents heading, navigation panel footer, search placeholder, lunr search indices
559
+ - 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!
560
+ - 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/)
561
+
562
+ *After usage instructions and the roadmap, we enumerate all changes from `v0.3.3`.*
563
+
564
+ ### Using Release `v0.4.0`
565
+
566
+ 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**.
567
+
568
+ To use this release explicitly as a remote theme:
569
+
570
+ ```yml
571
+ remote_theme: just-the-docs/just-the-docs@v0.4.0
572
+ ```
573
+
574
+ 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`:
575
+
576
+ ```ruby
577
+ gem "just-the-docs", "0.4.0"
578
+ ```
579
+
580
+ If you would prefer to not upgrade, you can enforce that explicitly:
581
+
582
+ 1. pin your gem version in your `Gemfile`, like so
583
+ ```ruby
584
+ gem "just-the-docs", "0.3.3"
585
+ ```
586
+ 2. freeze the `remote_theme`, like so
587
+ ```yml
588
+ remote_theme: just-the-docs/just-the-docs@v0.3.3
589
+ ```
590
+
591
+ ### Migration Guide and Strategies
592
+
593
+ 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.
594
+
595
+ **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.
596
+
597
+ 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.
598
+
599
+ 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!
600
+
601
+ ### Roadmap (What's Next?)
602
+
603
+ 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!
604
+
605
+ Broadly, many features are still on the radar. We anticipate the rest of `v0.4.x` to be bugfixes surrounding this new release.
606
+
607
+ For version `v0.5`, our roadmap includes:
608
+
609
+ - a theme toggle (light/dark mode), with automatic theme switching based on browser preferences
610
+ - better GDPR compliance for analytics
611
+ - multi-level/recursive navigation (unlimited hierarchy of child pages)
612
+
613
+ In future versions, we also plan on:
614
+
615
+ - adding better dark theme defaults
616
+ - adding better internationalization support
617
+ - exploring offline PDF generation
618
+ - improving accessibility within the theme
619
+ - improving search functionality
620
+ - refactoring and improving the robustness of our codebase
621
+
622
+ 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.
623
+
624
+ ### New Features
625
+
626
+ - Added: Combination by [@pdmosses] in [#578]
627
+ - Added: dark highlighting in [#463]
628
+ - Added: pages and collections in [#448]
629
+ - Added: callouts in [#466]
630
+ - Fixed: breadcrumb behaviour … by [@AdityaTiwari2102] in [#477]
631
+ - Fixed: prevent rake command corrupting search data in [#495] (also listed below)
632
+ - Fixed: nested lists in [#496]
633
+ - Fixed: set color for search input in [#498] (also listed below)
634
+ - Fixed: sites with no child pages (no PR)
635
+ - Fixed: TOC/breadcrumbs for multiple collections in [#494]
636
+ - Added: collection configuration option `nav_fold` (no PR)
637
+ - Fixed: indentation and color for folded collection navigation (no PR)
638
+ - Fixed: scroll navigation to show the link to the current page in [#639]
639
+ - Fixed: Replace all uses of `absolute_url` by `relative_url`, by [@svrooij] in [#544]
640
+ - Added: custom favicon `_includes` by [@burner1024] in [#364]
641
+ - Added: set color for search input by [@pdmosses] in [#498]
642
+ - Added: search placeholder configuration by [@mattxwang] in [#613]
643
+ - Added: 'child_nav_order' front matter to be able to sort navigation pages in reverse by [@jmertic] in [#726]
644
+ - Added: `nav_footer_custom` include by [@nathanjessen] in [#474]
645
+ - Added: style fixes for jekyll-asciidoc by [@alyssais] in [#829]
646
+ - Added: mermaid.js support by [@nascosto] in [#857]
647
+ - Added: support for external navigation links by [@SPGoding] in [#876]
648
+ - Added: refactor `mermaid` config to use `mermaid_config.js` include, only require `mermaid.version` in `_config.yml` by [@mattxwang] in [#909]
649
+ - Added: accessible titles to nested page nav toggle by [@JPrevost] in [#950]
650
+ - Added: better title styling for AsciiDoc examples by [@alyssais] in [#944]
651
+ - Added: docs for custom search placeholder by [@mattxwang] in [#939]
652
+ - Added: provide ability to skip to main content by [@JPrevost] in [#949]
653
+ - Added: styling for `<blockquote>` by [@mattxwang] in [#965]
654
+ - Added: custom include for TOC heading by [@pdmosses] in [#980]
655
+ - Added: experimental nav optimization for simple cases by [@pdmosses] in [#992]
656
+ - Added: support multiple Google Analytics tracking IDs, document UA -> GA4 switch by [@MichelleBlanchette] in [#1029]
657
+ - Added: copy code button to code snippets by [@simonebortolin] in [#945]
658
+ - Added: restore simple configuration of `favicon.ico` via `site.static_files` by [@pdmosses] in [#1095]
659
+ - Added: modularize site components by [@mattxwang] in [#1058]
660
+ - Added: includes for custom `lunr` Liquid and JS code by [@diablodale] in [#1068]
661
+ - Added: new `_sass/custom/setup.scss` for variable definition by [@mattxwang] in [#1135]
662
+ - Added: configuration key to load a local version of mermaid by [@fabrik42] in [#1153]
663
+
664
+ ### Bugfixes
665
+
666
+ - Fixed: prepend `site.collections_dir` if exists by [@alexsegura] in [#519]
667
+ - Fixed: nested task lists (#517) by [@pdmosses] in [#855]
668
+ - Fixed: suppress Liquid processing in CSS comments by [@pdmosses] in [#686]
669
+ - Fixed: prevent rake command from corrupting search data by [@pdmosses] in [#495]
670
+ - Fixed: anchor heading links should be visible on focus by [@jacobhq] in [#846]
671
+ - Fixed: add `overflow-x: auto` to `figure.highlight` by [@iridazzle] in [#727]
672
+ - Fixed: add `overflow-wrap: word-break` to `body` by [@iridazzle] in [#889]
673
+ - Fixed: vertical alignment for consecutive labels by [@Eisverygoodletter] in [#893]
674
+ - Fixed: allow links to wrap by [@pdmosses] in [#905]
675
+ - Fixed: nav scroll feature and absolute/relative URLs by [@pdmosses] in [#898]
676
+ - Fixed: exclude `vendor/` in Jekyll config by [@manuelhenke] in [#941]
677
+ - Fixed: improve build time of navigation panel by [@pdmosses] in [#956]
678
+ - Fixed: spacing issue when search is disabled by [@henryiii] in [#960]
679
+ - Fixed: active grandchild link class by [@pdmosses] in [#962]
680
+ - Fixed: HTML validation issues (W3C validator) by [@mattxwang] in [#964]
681
+ - Fixed: link styling now uses `text-decoration` values by [@mattxwang] in [#967]
682
+ - Fixed: cleaning up Jekyll excludes by [@pdmosses] in [#985]
683
+ - Fixed: docs, narrow styling for code highlighting with line numbers by [@pdmosses] in [#974]
684
+ - Fixed: default syntax highlighting in custom color schemes [@pdmosses] in [#986]
685
+ - Fixed: incorrect disambiguation in generated TOCs by [@pdmosses] in [#999]
686
+ - Fixed: duplicated external links in collections by [@pdmosses] in [#1001]
687
+ - Fixed: import order of `custom.scss`; puts at end by [@deseo] in [#1010]
688
+ - Fixed: top-level active link styling by [@pdmosses] in [#1015]
689
+ - Fixed: external links for sites with no pages by [@pdmosses] in [#1021]
690
+ - Fixed: duplicate `title` if `jekyll-seo-tag` not in users's plugins by [@Tom-Brouwer] in [#1040]
691
+ - Fixed: removes (duplicate) `favicon.html`, shifts content to `head_custom.html` by [@mattxwang] in [#1027]
692
+ - Fixed: add `reversed`, deprecate `desc` for nav `child_nav_order` by [@jmertic] in [#1061]
693
+ - Fixed: `child.child_nav_order` to `node.child_nav_order` by [@mattxwang] in [#1065]
694
+ - Fixed: remove all uses of `/` as SASS division by [@mattxwang] in [#1074]
695
+ - note: this was originally merged as [#1074] with a bug; it was reverted in [#1076], and then reimplemented in [#1077]
696
+ - Fixed: skip nav collection generation when site has no pages by [@pdmosses] in [#1092]
697
+ - Fixed: standardize SCSS with `declaration-block-no-redundant-longhand-properties` by [@simonebortolin] in [#1102]
698
+ - Fixed: incorrect `padding` property value pair in `labels.scss` by [@SConaway] in [#1104]
699
+ - Fixed: various bugs with copy code button by [@simonebortolin] in [#1096]
700
+ - Fixed: replace inline styling for `<svg>` icons by [@captn3m0] in [#1110]
701
+ - Fixed: incorrect `padding` property value pair in `search.scss` by [@kevinlin1] in [#1123]
702
+ - Fixed: minor spacing and comment nits by [@EricFromCanada] in [#1128]
703
+ - Fixed: exclude images from being bundled with gem by [@m-r-mccormick] in [#1142]
704
+ - Fixed: dark theme code block background, line number colors by [@m-r-mccormick] in [#1124]
705
+ - Fixed: copy code button interaction with kramdown line numbers by [@mattxwang] in [#1143]
706
+
707
+ ### Maintenance
708
+
709
+ - Added: VScode devcontainer by [@max06] in [#783]
710
+ - Added: `webrick` to `Gemfile` by [@mattxwang] in [#799]
711
+ - Added: 'This site is powered by Netlify.' to the footer by [@mattxwang] in [#797]
712
+ - Updated: new repo path by [@pmarsceill] in [#775]
713
+ - Updated: rename `master` -> `main` by [@pmarsceill] in [#776]
714
+ - Updated: README by [@pmarsceill] in [#777]
715
+ - Updated: Code of Conduct to Contributor Covenant v2.1 by [@mattxwang] in [#790]
716
+ - Updated: CI files, Ruby & Node Versions by [@mattxwang] in [#820]
717
+ - Updated: Stylelint to v14, extend SCSS plugins, remove primer-* configs, resolve issues by [@mattxwang] in [#821]
718
+ - Deleted: unused script directory by [@mattxwang] in [#937]
719
+ - Vendor: update `jekyll-anchor-headings`, `lunr.js` by [@mattxwang] in [#1071]
720
+
721
+ ### Documentation
722
+
723
+ - Added: docs on how to break an `ol` by [@pdmosses] in [#856]
724
+ - Added: docs for custom includes by [@nathanjessen] in [#806]
725
+ - Added: document caveat about variable dependencies by [@waldyrious] in [#555]
726
+ - Added: docs on how to use `custom_head` to add a custom favicon by [@UnclassedPenguin] in [#814]
727
+ - Added: docs load mermaid.js by default by [@mattxwang] in [#935]
728
+ - Added: warning about mandatory `_`-prefix for collections by [@max06] in [#1091]
729
+ - Added: migration guide by [@pdmosses] in [#1059]
730
+ - Added: label new features introduced in `v0.4` by [@mattxwang] in [#1138]
731
+ - Fixed: `ol` on `index.md` by [@pmarsceill] in [#778]
732
+ - Fixed: image link in Markdown kitchen sink by [@JeffGuKang] in [#221]
733
+ - Fixed: images in Markdown kitchen sink by [@dougaitken] in [#782]
734
+ - Fixed: clearer label of link to Jekyll quickstart by [@waldyrious] in [#549]
735
+ - Fixed: remove extra spaces in component docs by [@MichelleBlanchette] in [#554]
736
+ - Fixed: double "your" typo in `index.md` by [@sehilyi] in [#499]
737
+ - Fixed: "you" -> "your" typo in `index.md` by [@nathanjessen] in [#473]
738
+ - Fixed: spacing in toc example by [@henryiii] in [#835]
739
+ - Fixed: typo in `README` on `_config.yml` by [@ivanskodje] in [#891]
740
+ - Fixed: missing code fence in navigation structure docs by [@mattxwang] in [#906]
741
+ - Fixed: table of contents on search docs by [@robinpokorny] in [#940]
742
+ - Fixed: broken docs link (custom footer) by [@olgarithms] in [#951]
743
+ - Fixed: clarify version docs by [@pdmosses] in [#955]
744
+ - Fixed: typo in changelog links [@koppor] in [#1000]
745
+ - Fixed: two bugs in "Customization" (custom favicon, new annotation) by [@mattxwang] in [#1090]
746
+ - Fixed: "View Typography Utilities" link by [@agabrys] in [#1130]
747
+ - Fixed: broken relative page links by [@mattxwang] in [#1106]
748
+ - Fixed: clarify steps to add custom `lunr` index code by [@diablodale] in [#1139]
749
+ - Updated: homepage (focus: new features, conciseness, deduplication) by [@pdmosses] in [#1018]
750
+ - Updated: README (focus: new features, conciseness, deduplication) by [@pdmosses] in [#1019]
751
+ - Updated: `README` demo video by [@codewithfan] in [#1097]
752
+
753
+ ### New Contributors
754
+
755
+ - [@AdityaTiwari2102] made their first contribution in [#477]
756
+ - [@svrooij] made their first contribution in [#544]
757
+ - [@alexsegura] made their first contribution in [#519]
758
+ - [@burner1024] made their first contribution in [#364]
759
+ - [@JeffGuKang] made their first contribution in [#221]
760
+ - [@dougaitken] made their first contribution in [#782]
761
+ - [@max06] made their first contribution in [#783]
762
+ - [@sehilyi] made their first contribution in [#499]
763
+ - [@nathanjessen] made their first contribution in [#473]
764
+ - [@waldyrious] made their first contribution in [#549]
765
+ - [@MichelleBlanchette] made their first contribution in [#554]
766
+ - [@henryiii] made their first contribution in [#835]
767
+ - [@jmertic] made their first contribution in [#726]
768
+ - [@jacobhq] made their first contribution in [#846]
769
+ - [@UnclassedPenguin] made their first contribution in [#814]
770
+ - [@alyssais] made their first contribution in [#829]
771
+ - [@nascosto] made their first contribution in [#857]
772
+ - [@SPGoding] made their first contribution in [#876]
773
+ - [@iridazzle] made their first contribution in [#727]
774
+ - [@ivanskodje] made their first contribution in [#891]
775
+ - [@Eisverygoodletter] made their first contribution in [#893]
776
+ - [@robinpokorny] made their first contribution in [#940]
777
+ - [@olgarithms] made their first contribution in [#951]
778
+ - [@manuelhenke] made their first contribution in [#941]
779
+ - [@JPrevost] made their first contribution in [#950]
780
+ - [@koppor] made their first contribution in [#1000]
781
+ - [@deseo] made their first contribution in [#1010]
782
+ - [@Tom-Brouwer] made their first contribution in [#1040]
783
+ - [@simonebortolin] made their first contribution in [#945]
784
+ - [@SConaway] made their first contribution in [#1104]
785
+ - [@captn3m0] made their first contribution in [#1110]
786
+ - [@kevinlin1] made their first contribution in [#1123]
787
+ - [@codewithfan] made their first contribution in [#1097]
788
+ - [@agabrys] made their first contribution in [#1130]
789
+ - [@diablodale] made their first contribution in [#1068]
790
+ - [@m-r-mccormick] made their first contribution in [#1142]
791
+ - [@fabrik42] made their first contribution in [#1153]
792
+
793
+ ## Pre-release v0.4.0.rc5
794
+
795
+ 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.
796
+
797
+ 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`.
798
+
799
+ ### Trying out pre-release `v0.4.0.rc5`
800
+
801
+ 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.
802
+
803
+ To use this RC explicitly as a remote theme:
804
+
805
+ ```yml
806
+ remote_theme: just-the-docs/just-the-docs@v0.4.0.rc5
807
+ ```
808
+
809
+ 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`:
810
+
811
+ ```ruby
812
+ gem "just-the-docs", "0.4.0.rc5"
813
+ ```
814
+
815
+ By default, **users will not be upgraded to `0.4.0.rc5`**. To enforce that explicitly, either:
816
+
817
+ 1. pin your gem version in your `Gemfile`, like so
818
+ ```ruby
819
+ gem "just-the-docs", "0.3.3"
820
+ ```
821
+ 2. freeze the `remote_theme`, like so
822
+ ```yml
823
+ remote_theme: just-the-docs/just-the-docs@v0.3.3
824
+ ```
825
+
826
+ ### New Features
827
+
828
+ - Added: includes for custom `lunr` Liquid and JS code by [@diablodale] in [#1068]
829
+ - Added: new `_sass/custom/setup.scss` for variable definition by [@mattxwang] in [#1135]
830
+ - Added: configuration key to load a local version of mermaid by [@fabrik42] in [#1153]
831
+
832
+ ### Bugfixes and Maintenance
833
+
834
+ - Fixed: incorrect `padding` property value pair in `search.scss` by [@kevinlin1] in [#1123]
835
+ - Fixed: minor spacing and comment nits by [@EricFromCanada] in [#1128]
836
+ - Fixed: exclude images from being bundled with gem by [@m-r-mccormick] in [#1142]
837
+ - Fixed: dark theme code block background, line number colors by [@m-r-mccormick] in [#1124]
838
+ - Fixed: copy code button interaction with kramdown line numbers by [@mattxwang] in [#1143]
839
+
840
+ ### Docs
841
+
842
+ - Docs: add a migration guide by [@pdmosses] in [#1059]
843
+ - Docs: update `README` demo video by [@codewithfan] in [#1097]
844
+ - Docs: update "View Typography Utilities" link by [@agabrys] in [#1130]
845
+ - Docs: fix broken relative page links by [@mattxwang] in [#1106]
846
+ - Docs: clarify steps to add custom `lunr` index code by [@diablodale] in [#1139]
847
+ - Docs: label new features introduced in `v0.4` by [@mattxwang] in [#1138]
848
+
849
+ ### New Contributors
850
+
851
+ - [@kevinlin1] made their first contribution in [#1123]
852
+ - [@codewithfan] made their first contribution in [#1097]
853
+ - [@agabrys] made their first contribution in [#1130]
854
+ - [@diablodale] made their first contribution in [#1068]
855
+ - [@m-r-mccormick] made their first contribution in [#1142]
856
+ - [@fabrik42] made their first contribution in [#1153]
857
+
858
+ [#1059]: https://github.com/just-the-docs/just-the-docs/pull/1059
859
+ [#1068]: https://github.com/just-the-docs/just-the-docs/pull/1068
860
+ [#1097]: https://github.com/just-the-docs/just-the-docs/pull/1097
861
+ [#1106]: https://github.com/just-the-docs/just-the-docs/pull/1106
862
+ [#1123]: https://github.com/just-the-docs/just-the-docs/pull/1123
863
+ [#1124]: https://github.com/just-the-docs/just-the-docs/pull/1124
864
+ [#1128]: https://github.com/just-the-docs/just-the-docs/pull/1128
865
+ [#1130]: https://github.com/just-the-docs/just-the-docs/pull/1130
866
+ [#1135]: https://github.com/just-the-docs/just-the-docs/pull/1135
867
+ [#1138]: https://github.com/just-the-docs/just-the-docs/pull/1138
868
+ [#1139]: https://github.com/just-the-docs/just-the-docs/pull/1139
869
+ [#1142]: https://github.com/just-the-docs/just-the-docs/pull/1142
870
+ [#1143]: https://github.com/just-the-docs/just-the-docs/pull/1143
871
+ [#1153]: https://github.com/just-the-docs/just-the-docs/pull/1153
872
+
873
+ [@agabrys]: https://github.com/agabrys
874
+ [@codewithfan]: https://github.com/codewithfan
875
+ [@diablodale]: https://github.com/diablodale
876
+ [@fabrik42]: https://github.com/fabrik42
877
+ [@kevinlin1]: https://github.com/kevinlin1
878
+ [@EricFromCanada]: https://github.com/EricFromCanada
879
+ [@m-r-mccormick]: https://github.com/m-r-mccormick
880
+
881
+ ## Pre-release v0.4.0.rc4
882
+
883
+ 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**.
884
+
885
+ Notable new additions include:
886
+
887
+ - modular site components, which split up the site into smaller reusable components; advanced theme users can then remix layouts quickly without duplication
888
+ - a "copy code" button to code blocks
889
+ - fixing bugs in generated TOCs and navigation from previous prereleases
890
+ - various cleanups of CSS and HTML markup
891
+
892
+ The roadmap to `v0.4.0` is small. We are only looking to:
893
+
894
+ - finish a migration guide, so users can easily upgrade from `v0.3.3` to `v0.4.0`
895
+ - fix one last bug relating to callouts and custom colors
896
+ - fix any new bugs introduced by this pre-release
897
+
898
+ 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!
899
+
900
+ ### Trying out pre-release `v0.4.0.rc4`
901
+
902
+ 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`.
903
+
904
+ To use this RC explicitly as a remote theme:
905
+
906
+ ```yml
907
+ remote_theme: just-the-docs/just-the-docs@v0.4.0.rc4
908
+ ```
909
+
910
+ 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`:
911
+
912
+ ```ruby
913
+ gem "just-the-docs", "0.4.0.rc4"
914
+ ```
915
+
916
+ By default, **users will not be upgraded to `0.4.0.rc4`**. To enforce that explicitly, either:
917
+
918
+ 1. pin your gem version in your `Gemfile`, like so
919
+ ```ruby
920
+ gem "just-the-docs", "0.3.3"
921
+ ```
922
+ 2. freeze the `remote_theme`, like so
923
+ ```yml
924
+ remote_theme: just-the-docs/just-the-docs@v0.3.3
925
+ ```
926
+
927
+ ### New Features
928
+
929
+ - Added: support multiple Google Analytics tracking IDs, document UA -> GA4 switch by [@MichelleBlanchette] in [#1029]
930
+ - Added: copy code button to code snippets by [@simonebortolin] in [#945]
931
+ - Added: restore simple configuration of `favicon.ico` via `site.static_files` by [@pdmosses] in [#1095]
932
+ - Added: modularize site components by [@mattxwang] in [#1058]
933
+
934
+ ### Bugfixes and Maintenance
935
+
936
+ - Fixed: incorrect disambiguation in generated TOCs by [@pdmosses] in [#999]
937
+ - Fixed: duplicated external links in collections by [@pdmosses] in [#1001]
938
+ - Fixed: import order of `custom.scss`; puts at end by [@deseo] in [#1010]
939
+ - Fixed: top-level active link styling by [@pdmosses] in [#1015]
940
+ - Fixed: external links for sites with no pages by [@pdmosses] in [#1021]
941
+ - Fixed: duplicate `title` if `jekyll-seo-tag` not in users's plugins by [@Tom-Brouwer] in [#1040]
942
+ - Fixed: removes (duplicate) `favicon.html`, shifts content to `head_custom.html` by [@mattxwang] in [#1027]
943
+ - Fixed: add `reversed`, deprecate `desc` for nav `child_nav_order` by [@jmertic] in [#1061]
944
+ - Fixed: `child.child_nav_order` to `node.child_nav_order` by [@mattxwang] in [#1065]
945
+ - Fixed: remove all uses of `/` as SASS division by [@mattxwang] in [#1074]
946
+ - note: this was originally merged as [#1074] with a bug; it was reverted in [#1076], and then reimplemented in [#1077]
947
+ - Fixed: skip nav collection generation when site has no pages by [@pdmosses] in [#1092]
948
+ - Fixed: standardize SCSS with `declaration-block-no-redundant-longhand-properties` by [@simonebortolin] in [#1102]
949
+ - Fixed: incorrect `padding` property value pair in `labels.scss` by [@SConaway] in [#1104]
950
+ - Fixed: various bugs with copy code button by [@simonebortolin] in [#1096]
951
+ - Fixed: replace inline styling for `<svg>` icons by [@captn3m0] in [#1110]
952
+ - Vendor: update `jekyll-anchor-headings`, `lunr.js` by [@mattxwang] in [#1071]
953
+
954
+ ### Docs
955
+
956
+ - Docs: fix typo in changelog links [@koppor] in [#1000]
957
+ - Docs: update homepage (focus: new features, conciseness, deduplication) by [@pdmosses] in [#1018]
958
+ - Docs: update README (focus: new features, conciseness, deduplication) by [@pdmosses] in [#1019]
959
+ - Docs: fix two bugs in "Customization" (custom favicon, new annotation) by [@mattxwang] in [#1090]
960
+ - Docs: Add warning about mandatory `_`-prefix for collections by [@max06] in [#1091]
961
+ - Docs: remove Google Analytics on main site by [@mattxwang] in [#1113]
962
+
963
+ ### New Contributors
964
+
965
+ - [@koppor] made their first contribution in [#1000]
966
+ - [@deseo] made their first contribution in [#1010]
967
+ - [@Tom-Brouwer] made their first contribution in [#1040]
968
+ - [@simonebortolin] made their first contribution in [#945]
969
+ - [@SConaway] made their first contribution in [#1104]
970
+ - [@captn3m0] made their first contribution in [#1110]
971
+
972
+ **Full Changelog**: https://github.com/just-the-docs/just-the-docs/compare/v0.4.0.rc3...v0.4.0.rc4
973
+
974
+ [#945]: https://github.com/just-the-docs/just-the-docs/pull/945
975
+ [#999]: https://github.com/just-the-docs/just-the-docs/pull/999
976
+ [#1000]: https://github.com/just-the-docs/just-the-docs/pull/1000
977
+ [#1001]: https://github.com/just-the-docs/just-the-docs/pull/1001
978
+ [#1010]: https://github.com/just-the-docs/just-the-docs/pull/1010
979
+ [#1015]: https://github.com/just-the-docs/just-the-docs/pull/1015
980
+ [#1018]: https://github.com/just-the-docs/just-the-docs/pull/1018
981
+ [#1019]: https://github.com/just-the-docs/just-the-docs/pull/1019
982
+ [#1021]: https://github.com/just-the-docs/just-the-docs/pull/1021
983
+ [#1027]: https://github.com/just-the-docs/just-the-docs/pull/1027
984
+ [#1029]: https://github.com/just-the-docs/just-the-docs/pull/1029
985
+ [#1040]: https://github.com/just-the-docs/just-the-docs/pull/1040
986
+ [#1058]: https://github.com/just-the-docs/just-the-docs/pull/1058
987
+ [#1061]: https://github.com/just-the-docs/just-the-docs/pull/1061
988
+ [#1065]: https://github.com/just-the-docs/just-the-docs/pull/1065
989
+ [#1071]: https://github.com/just-the-docs/just-the-docs/pull/1071
990
+ [#1074]: https://github.com/just-the-docs/just-the-docs/pull/1074
991
+ [#1076]: https://github.com/just-the-docs/just-the-docs/pull/1076
992
+ [#1077]: https://github.com/just-the-docs/just-the-docs/pull/1077
993
+ [#1090]: https://github.com/just-the-docs/just-the-docs/pull/1090
994
+ [#1091]: https://github.com/just-the-docs/just-the-docs/pull/1091
995
+ [#1092]: https://github.com/just-the-docs/just-the-docs/pull/1092
996
+ [#1095]: https://github.com/just-the-docs/just-the-docs/pull/1095
997
+ [#1096]: https://github.com/just-the-docs/just-the-docs/pull/1096
998
+ [#1102]: https://github.com/just-the-docs/just-the-docs/pull/1102
999
+ [#1104]: https://github.com/just-the-docs/just-the-docs/pull/1104
1000
+ [#1110]: https://github.com/just-the-docs/just-the-docs/pull/1110
1001
+ [#1113]: https://github.com/just-the-docs/just-the-docs/pull/1113
1002
+
1003
+ [@captn3m0]: https://github.com/captn3m0
1004
+ [@deseo]: https://github.com/deseo
1005
+ [@koppor]: https://github.com/koppor
1006
+ [@MichelleBlanchette]: https://github.com/MichelleBlanchette
1007
+ [@simonebortolin]: https://github.com/simonebortolin
1008
+ [@SConaway]: https://github.com/SConaway
1009
+ [@Tom-Brouwer]: https://github.com/Tom-Brouwer
1010
+
1011
+ ## Pre-release v0.4.0.rc3
1012
+
1013
+ 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`.
1014
+
1015
+ 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.
1016
+
1017
+ 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!
1018
+
1019
+ 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!
1020
+
1021
+ ### Trying out pre-release `v0.4.0.rc3`
1022
+
1023
+ 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`.
1024
+
1025
+ To use this RC explicitly as a remote theme:
1026
+
1027
+ ```yml
1028
+ remote_theme: just-the-docs/just-the-docs@v0.4.0.rc3
1029
+ ```
1030
+
1031
+ 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`:
1032
+
1033
+ ```ruby
1034
+ gem "just-the-docs", "0.4.0.rc3"
1035
+ ```
1036
+
1037
+ By default, **users will not be upgraded to `0.4.0.rc3`**. To enforce that explicitly, either:
1038
+
1039
+ 1. pin your gem version in your `Gemfile`, like so
1040
+ ```ruby
1041
+ gem "just-the-docs", "0.3.3"
1042
+ ```
1043
+ 2. freeze the `remote_theme`, like so
1044
+ ```yml
1045
+ remote_theme: just-the-docs/just-the-docs@v0.3.3
1046
+ ```
1047
+
1048
+ ### Features
1049
+
1050
+ Broadly, this prerelease is feature-light!
1051
+
1052
+ - Added: styling for `<blockquote>` by [@mattxwang] in [#965]
1053
+ - Added: custom include for TOC heading by [@pdmosses] in [#980]
1054
+
1055
+ ### Bugfixes and Experimental Features
1056
+
1057
+ *Note*: experimental nav optimization may be unstable. Please give us feedback!
1058
+
1059
+ - Added: experimental nav optimization for simple cases by [@pdmosses] in [#992]
1060
+ - Fixed: spacing issue when search is disabled by [@henryiii] in [#960]
1061
+ - Fixed: active grandchild link class by [@pdmosses] in [#962]
1062
+ - Fixed: HTML validation issues (W3C validator) by [@mattxwang] in [#964]
1063
+ - Fixed: link styling now uses `text-decoration` values by [@mattxwang] in [#967]
1064
+ - Fixed: cleaning up Jekyll excludes by [@pdmosses] in [#985]
1065
+ - Fixed: docs, narrow styling for code highlighting with line numbers by [@pdmosses] in [#974]
1066
+ - Fixed: default syntax highlighting in custom color schemes [@pdmosses] in [#986]
1067
+
1068
+ [#965]: https://github.com/just-the-docs/just-the-docs/pull/965
1069
+ [#960]: https://github.com/just-the-docs/just-the-docs/pull/960
1070
+ [#962]: https://github.com/just-the-docs/just-the-docs/pull/962
1071
+ [#964]: https://github.com/just-the-docs/just-the-docs/pull/964
1072
+ [#967]: https://github.com/just-the-docs/just-the-docs/pull/967
1073
+ [#974]: https://github.com/just-the-docs/just-the-docs/pull/974
1074
+ [#980]: https://github.com/just-the-docs/just-the-docs/pull/980
1075
+ [#985]: https://github.com/just-the-docs/just-the-docs/pull/985
1076
+ [#986]: https://github.com/just-the-docs/just-the-docs/pull/986
1077
+ [#992]: https://github.com/just-the-docs/just-the-docs/pull/992
1078
+
1079
+ [@henryiii]: https://github.com/henryiii
1080
+
1081
+ **Full Changelog**: https://github.com/just-the-docs/just-the-docs/compare/v0.4.0.rc2...v0.4.0.rc3
1082
+
1083
+ ## Pre-release v0.4.0.rc2
1084
+
1085
+ {: .warning }
1086
+ This website includes docs for some new features that are not available in `v0.4.0.rc1` and `v0.3.3`!
1087
+
1088
+ 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:
1089
+
1090
+ - significant improvement on build time of navigation panel by [@pdmosses]
1091
+ - this is big: for a community member with over 300 pages, we shortened the build time from 3 minutes to 30 seconds!
1092
+ - improved accessibility features led by [@JPrevost]
1093
+ - more docs!
1094
+
1095
+ 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!
1096
+
1097
+ ### Trying out pre-release `v0.4.0.rc2`
1098
+
1099
+ 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`.
1100
+
1101
+ To use this RC explicitly as a remote theme:
1102
+
1103
+ ```yml
1104
+ remote_theme: just-the-docs/just-the-docs@v0.4.0.rc2
1105
+ ```
1106
+
1107
+ 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`:
1108
+
1109
+ ```ruby
1110
+ gem "just-the-docs", "0.4.0.rc2"
1111
+ ```
1112
+
1113
+ By default, **users will not be upgraded to `0.4.0.rc2`**. To enforce that explicitly, either:
1114
+
1115
+ 1. pin your gem version in your `Gemfile`, like so
1116
+ ```ruby
1117
+ gem "just-the-docs", "0.3.3"
1118
+ ```
1119
+ 2. freeze the `remote_theme`, like so
1120
+ ```yml
1121
+ remote_theme: just-the-docs/just-the-docs@v0.3.3
1122
+ ```
1123
+
1124
+ ### Features
1125
+
1126
+ - Added: accessible titles to nested page nav toggle by [@JPrevost] in [#950]
1127
+ - Added: better title styling for AsciiDoc examples by [@alyssais] in [#944]
1128
+ - Added: docs for custom search placeholder by [@mattxwang] in [#939]
1129
+ - Added: provide ability to skip to main content by [@JPrevost] in [#949]
1130
+ - Fixed: exclude `vendor/` in Jekyll config by [@manuelhenke] in [#941]
1131
+ - Fixed: improve build time of navigation panel by [@pdmosses] in [#956]
1132
+
1133
+ [#950]: https://github.com/just-the-docs/just-the-docs/pull/950
1134
+ [#944]: https://github.com/just-the-docs/just-the-docs/pull/944
1135
+ [#939]: https://github.com/just-the-docs/just-the-docs/pull/939
1136
+ [#949]: https://github.com/just-the-docs/just-the-docs/pull/949
1137
+ [#941]: https://github.com/just-the-docs/just-the-docs/pull/941
1138
+ [#956]: https://github.com/just-the-docs/just-the-docs/pull/956
1139
+
1140
+ [@alyssais]: https://github.com/alyssais
1141
+
1142
+ ### Documentation and Maintenance
1143
+
1144
+ - Added: docs load mermaid.js by default by [@mattxwang] in [#935]
1145
+ - Fixed: table of contents on search docs by [@robinpokorny] in [#940]
1146
+ - Fixed: broken docs link (custom footer) by [@olgarithms] in [#951]
1147
+ - Fixed: clarify version docs by [@pdmosses] in [#955]
1148
+ - Deleted: unused script directory by [@mattxwang] in [#937]
1149
+
1150
+ [#935]: https://github.com/just-the-docs/just-the-docs/pull/935
1151
+ [#940]: https://github.com/just-the-docs/just-the-docs/pull/940
1152
+ [#951]: https://github.com/just-the-docs/just-the-docs/pull/951
1153
+ [#955]: https://github.com/just-the-docs/just-the-docs/pull/955
1154
+ [#937]: https://github.com/just-the-docs/just-the-docs/pull/937
1155
+
1156
+ ### New Contributors
1157
+
1158
+ * [@robinpokorny] made their first contribution in [#940]
1159
+ * [@olgarithms] made their first contribution in [#951]
1160
+ * [@manuelhenke] made their first contribution in [#941]
1161
+ * [@JPrevost] made their first contribution in [#950]
1162
+
1163
+ [@robinpokorny]: https://github.com/robinpokorny
1164
+ [@olgarithms]: https://github.com/olgarithms
1165
+ [@manuelhenke]: https://github.com/manuelhenke
1166
+ [@JPrevost]: https://github.com/JPrevost
1167
+
1168
+ ## Pre-release v0.4.0.rc1
1169
+
1170
+ ### We're back!
1171
+
1172
+ 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:
1173
+
1174
+ - The new callouts component
1175
+ - Allowing pages and collections to coexist on the navigation pane
1176
+ - New styling: dark syntax highlighting, support for jekyll-asciidoc, word-wrapping instead of overflow for various elements
1177
+ - More customization: external nav links, custom nav footers, favicon includes, search color and placeholder configuration, mermaid.js support, and nav sorting
1178
+ - Over 20 bugfixes! Big ones include fixing the `rake` command, using `relative_url`, and search input color
1179
+ - More documentation, especially on using custom includes
1180
+ - Updating core dependencies to stable Ruby versions
1181
+ - 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!
1182
+
1183
+ 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!
1184
+
1185
+ ### Trying out pre-release `v0.4.0.rc1`
1186
+
1187
+ 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`.
1188
+
1189
+ To use this RC explicitly as a remote theme:
1190
+
1191
+ ```yml
1192
+ remote_theme: just-the-docs/just-the-docs@v0.4.0.rc1
1193
+ ```
1194
+
1195
+ 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`:
1196
+
1197
+ ```ruby
1198
+ gem "just-the-docs", "0.4.0.rc1"
1199
+ ```
1200
+
1201
+ ### Staying on `v0.3.3`
1202
+
1203
+ 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.
1204
+
1205
+ If you have not pinned your theme version, you should either:
1206
+
1207
+ 1. pin your gem version in your `Gemfile`, like so
1208
+ ```ruby
1209
+ gem "just-the-docs", "0.3.3"
1210
+ ```
1211
+ 2. freeze the `remote_theme`, like so
1212
+ ```yml
1213
+ remote_theme: just-the-docs/just-the-docs@v0.3.3
1214
+ ```
1215
+
1216
+ {: .warning }
1217
+ 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`.
1218
+
1219
+ ### Maintenance
1220
+
1221
+ 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!
1222
+
1223
+ 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!
1224
+
1225
+ [@mattxwang]: https://github.com/mattxwang
1226
+ [@pdmosses]: https://github.com/pdmosses
1227
+ [@skullface]: https://github.com/skullface
1228
+ [@dougaitken]: https://github.com/dougaitken
1229
+ [@max06]: https://github.com/max06
1230
+
1231
+ ### Roadmap
1232
+
1233
+ 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.
1234
+
1235
+ We're also scoping out medium and long-term projects, and want to keep you in the loop. These include:
1236
+
1237
+ - upgrading to Jekyll 4, and stopping support for Jekyll 3
1238
+ - versioned docs - issue [#728]
1239
+ - improved accessibility - issues [#566], [#870]
1240
+ - internationalization (i18n) - issue [#59]
1241
+ - recursive/multi-level navigation - PR [#462]
1242
+ - toggleable dark mode - issue [#234]
1243
+
1244
+ 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!
1245
+
1246
+ [#728]: https://github.com/just-the-docs/just-the-docs/issues/728
1247
+ [#566]: https://github.com/just-the-docs/just-the-docs/issues/566
1248
+ [#870]: https://github.com/just-the-docs/just-the-docs/issues/870
1249
+ [#59]: https://github.com/just-the-docs/just-the-docs/issues/59
1250
+ [#462]: https://github.com/just-the-docs/just-the-docs/pull/462
1251
+ [#234]: https://github.com/just-the-docs/just-the-docs/issues/234
1252
+
1253
+ ### Features
1254
+
1255
+ * Added: Combination by [@pdmosses] in [#578]
1256
+ - Added: dark highlighting in [#463]
1257
+ - Added: pages and collections in [#448]
1258
+ - Added: callouts in [#466]
1259
+ - Fixed: breadcrumb behaviour … by [@AdityaTiwari2102] in [#477]
1260
+ - Fixed: prevent rake command corrupting search data in [#495] (also listed below)
1261
+ - Fixed: nested lists in [#496]
1262
+ - Fixed: set color for search input in [#498] (also listed below)
1263
+ - Fixed: sites with no child pages (no PR)
1264
+ - Fixed: TOC/breadcrumbs for multiple collections in [#494]
1265
+ - Added: collection configuration option `nav_fold` (no PR)
1266
+ - Fixed: indentation and color for folded collection navigation (no PR)
1267
+ - Fixed: scroll navigation to show the link to the current page in [#639]
1268
+ - Fixed: Replace all uses of `absolute_url` by `relative_url`, by [@svrooij] in [#544]
1269
+ * Added: custom favicon `_includes` by [@burner1024] in [#364]
1270
+ * Added: set color for search input by [@pdmosses] in [#498]
1271
+ * Added: search placeholder configuration by [@mattxwang] in [#613]
1272
+ * Added: 'child_nav_order' front matter to be able to sort navigation pages in reverse by [@jmertic] in [#726]
1273
+ * Added: `nav_footer_custom` include by [@nathanjessen] in [#474]
1274
+ * Added: style fixes for jekyll-asciidoc by [@alyssais] in [#829]
1275
+ * Added: mermaid.js support by [@nascosto] in [#857]
1276
+ * Added: support for external navigation links by [@SPGoding] in [#876]
1277
+ * Added: refactor `mermaid` config to use `mermaid_config.js` include, only require `mermaid.version` in `_config.yml` by [@mattxwang] in [#909]
1278
+ * Fixed: prepend `site.collections_dir` if exists by [@alexsegura] in [#519]
1279
+ * Fixed: nested task lists (#517) by [@pdmosses] in [#855]
1280
+ * Fixed: suppress Liquid processing in CSS comments by [@pdmosses] in [#686]
1281
+ * Fixed: prevent rake command from corrupting search data by [@pdmosses] in [#495]
1282
+ * Fixed: anchor heading links should be visible on focus by [@jacobhq] in [#846]
1283
+ * Fixed: add `overflow-x: auto` to `figure.highlight` by [@iridazzle] in [#727]
1284
+ * Fixed: add `overflow-wrap: word-break` to `body` by [@iridazzle] in [#889]
1285
+ * Fixed: vertical alignment for consecutive labels by [@Eisverygoodletter] in [#893]
1286
+ * Fixed: allow links to wrap by [@pdmosses] in [#905]
1287
+ * Fixed: nav scroll feature and absolute/relative URLs by [@pdmosses] in [#898]
1288
+
1289
+ [#578]: https://github.com/just-the-docs/just-the-docs/pull/578
1290
+ [#463]: https://github.com/just-the-docs/just-the-docs/pull/463
1291
+ [#448]: https://github.com/just-the-docs/just-the-docs/pull/448
1292
+ [#466]: https://github.com/just-the-docs/just-the-docs/pull/466
1293
+ [#477]: https://github.com/just-the-docs/just-the-docs/pull/477
1294
+ [#495]: https://github.com/just-the-docs/just-the-docs/pull/495
1295
+ [#496]: https://github.com/just-the-docs/just-the-docs/pull/496
1296
+ [#498]: https://github.com/just-the-docs/just-the-docs/pull/498
1297
+ [#494]: https://github.com/just-the-docs/just-the-docs/pull/494
1298
+ [#639]: https://github.com/just-the-docs/just-the-docs/pull/639
1299
+ [#544]: https://github.com/just-the-docs/just-the-docs/pull/544
1300
+ [#364]: https://github.com/just-the-docs/just-the-docs/pull/364
1301
+ [#498]: https://github.com/just-the-docs/just-the-docs/pull/498
1302
+ [#613]: https://github.com/just-the-docs/just-the-docs/pull/613
1303
+ [#726]: https://github.com/just-the-docs/just-the-docs/pull/726
1304
+ [#474]: https://github.com/just-the-docs/just-the-docs/pull/474
1305
+ [#829]: https://github.com/just-the-docs/just-the-docs/pull/829
1306
+ [#857]: https://github.com/just-the-docs/just-the-docs/pull/857
1307
+ [#876]: https://github.com/just-the-docs/just-the-docs/pull/876
1308
+ [#909]: https://github.com/just-the-docs/just-the-docs/pull/909
1309
+ [#519]: https://github.com/just-the-docs/just-the-docs/pull/519
1310
+ [#855]: https://github.com/just-the-docs/just-the-docs/pull/855
1311
+ [#686]: https://github.com/just-the-docs/just-the-docs/pull/686
1312
+ [#495]: https://github.com/just-the-docs/just-the-docs/pull/495
1313
+ [#846]: https://github.com/just-the-docs/just-the-docs/pull/846
1314
+ [#727]: https://github.com/just-the-docs/just-the-docs/pull/727
1315
+ [#889]: https://github.com/just-the-docs/just-the-docs/pull/889
1316
+ [#893]: https://github.com/just-the-docs/just-the-docs/pull/893
1317
+ [#905]: https://github.com/just-the-docs/just-the-docs/pull/905
1318
+ [#898]: https://github.com/just-the-docs/just-the-docs/pull/898
1319
+
1320
+ ### Documentation
1321
+
1322
+ * Added: docs on how to break an `ol` by [@pdmosses] in [#856]
1323
+ * Added: docs for custom includes by [@nathanjessen] in [#806]
1324
+ * Added: document caveat about variable dependencies by [@waldyrious] in [#555]
1325
+ * Added: docs on how to use `custom_head` to add a custom favicon by [@UnclassedPenguin] in [#814]
1326
+ * Fixed: `ol` on `index.md` by [@pmarsceill] in [#778]
1327
+ * Fixed: image link in Markdown kitchen sink by [@JeffGuKang] in [#221]
1328
+ * Fixed: images in Markdown kitchen sink by [@dougaitken] in [#782]
1329
+ * Fixed: clearer label of link to Jekyll quickstart by [@waldyrious] in [#549]
1330
+ * Fixed: remove extra spaces in component docs by [@MichelleBlanchette] in [#554]
1331
+ * Fixed: double "your" typo in `index.md` by [@sehilyi] in [#499]
1332
+ * Fixed: "you" -> "your" typo in `index.md` by [@nathanjessen] in [#473]
1333
+ * Fixed: spacing in toc example by [@henryiii] in [#835]
1334
+ * Fixed: typo in `README` on `_config.yml` by [@ivanskodje] in [#891]
1335
+ * Fixed: missing code fence in navigation structure docs by [@mattxwang] in [#906]
1336
+
1337
+ [#856]: https://github.com/just-the-docs/just-the-docs/pull/856
1338
+ [#806]: https://github.com/just-the-docs/just-the-docs/pull/806
1339
+ [#555]: https://github.com/just-the-docs/just-the-docs/pull/555
1340
+ [#814]: https://github.com/just-the-docs/just-the-docs/pull/814
1341
+ [#778]: https://github.com/just-the-docs/just-the-docs/pull/778
1342
+ [#221]: https://github.com/just-the-docs/just-the-docs/pull/221
1343
+ [#782]: https://github.com/just-the-docs/just-the-docs/pull/782
1344
+ [#549]: https://github.com/just-the-docs/just-the-docs/pull/549
1345
+ [#554]: https://github.com/just-the-docs/just-the-docs/pull/554
1346
+ [#499]: https://github.com/just-the-docs/just-the-docs/pull/499
1347
+ [#473]: https://github.com/just-the-docs/just-the-docs/pull/473
1348
+ [#835]: https://github.com/just-the-docs/just-the-docs/pull/835
1349
+ [#891]: https://github.com/just-the-docs/just-the-docs/pull/891
1350
+ [#906]: https://github.com/just-the-docs/just-the-docs/pull/906
1351
+
1352
+ ### Maintenance
1353
+
1354
+ * Added: VScode devcontainer by [@max06] in [#783]
1355
+ * Added: `webrick` to `Gemfile` by [@mattxwang] in [#799]
1356
+ * Added: 'This site is powered by Netlify.' to the footer by [@mattxwang] in [#797]
1357
+ * Updated: new repo path by [@pmarsceill] in [#775]
1358
+ * Updated: rename `master` -> `main` by [@pmarsceill] in [#776]
1359
+ * Updated: README by [@pmarsceill] in [#777]
1360
+ * Updated: Code of Conduct to Contributor Covenant v2.1 by [@mattxwang] in [#790]
1361
+ * Updated: CI files, Ruby & Node Versions by [@mattxwang] in [#820]
1362
+ * Updated: Stylelint to v14, extend SCSS plugins, remove primer-* configs, resolve issues by [@mattxwang] in [#821]
1363
+
1364
+ [#783]: https://github.com/just-the-docs/just-the-docs/pull/783
1365
+ [#799]: https://github.com/just-the-docs/just-the-docs/pull/799
1366
+ [#797]: https://github.com/just-the-docs/just-the-docs/pull/797
1367
+ [#775]: https://github.com/just-the-docs/just-the-docs/pull/775
1368
+ [#776]: https://github.com/just-the-docs/just-the-docs/pull/776
1369
+ [#777]: https://github.com/just-the-docs/just-the-docs/pull/777
1370
+ [#790]: https://github.com/just-the-docs/just-the-docs/pull/790
1371
+ [#820]: https://github.com/just-the-docs/just-the-docs/pull/820
1372
+ [#821]: https://github.com/just-the-docs/just-the-docs/pull/821
1373
+
1374
+ ### Dependencies
1375
+
1376
+ * Upgrade to GitHub-native Dependabot by @dependabot-preview in [#627]
1377
+ * [Security] Bump y18n from 3.2.1 to 3.2.2 by @dependabot-preview in [#606]
1378
+ * [Security] Bump hosted-git-info from 2.7.1 to 2.8.9 by @dependabot-preview in [#641]
1379
+ * [Security] Bump lodash from 4.17.19 to 4.17.21 by @dependabot-preview in [#640]
1380
+ * [Security] Bump ini from 1.3.5 to 1.3.8 by @dependabot-preview in [#511]
1381
+ * Bump path-parse from 1.0.6 to 1.0.7 by @dependabot in [#699]
1382
+ * Bump ajv from 6.10.0 to 6.12.6 by @dependabot in [#766]
1383
+ * Bump prettier from 2.1.2 to 2.5.1 by @dependabot in [#787]
1384
+ * Bump prettier from 2.5.1 to 2.6.2 by @dependabot in [#809]
1385
+ * Bump prettier from 2.6.2 to 2.7.1 by @dependabot in [#864]
1386
+
1387
+ [#627]: https://github.com/just-the-docs/just-the-docs/pull/627
1388
+ [#606]: https://github.com/just-the-docs/just-the-docs/pull/606
1389
+ [#641]: https://github.com/just-the-docs/just-the-docs/pull/641
1390
+ [#640]: https://github.com/just-the-docs/just-the-docs/pull/640
1391
+ [#511]: https://github.com/just-the-docs/just-the-docs/pull/511
1392
+ [#699]: https://github.com/just-the-docs/just-the-docs/pull/699
1393
+ [#766]: https://github.com/just-the-docs/just-the-docs/pull/766
1394
+ [#787]: https://github.com/just-the-docs/just-the-docs/pull/787
1395
+ [#809]: https://github.com/just-the-docs/just-the-docs/pull/809
1396
+ [#864]: https://github.com/just-the-docs/just-the-docs/pull/864
1397
+
1398
+ ### New Contributors
1399
+
1400
+ * [@AdityaTiwari2102] made their first contribution in [#477]
1401
+ * [@svrooij] made their first contribution in [#544]
1402
+ * [@alexsegura] made their first contribution in [#519]
1403
+ * [@burner1024] made their first contribution in [#364]
1404
+ * [@JeffGuKang] made their first contribution in [#221]
1405
+ * [@dougaitken] made their first contribution in [#782]
1406
+ * [@max06] made their first contribution in [#783]
1407
+ * [@sehilyi] made their first contribution in [#499]
1408
+ * [@nathanjessen] made their first contribution in [#473]
1409
+ * [@waldyrious] made their first contribution in [#549]
1410
+ * [@MichelleBlanchette] made their first contribution in [#554]
1411
+ * [@henryiii] made their first contribution in [#835]
1412
+ * [@jmertic] made their first contribution in [#726]
1413
+ * [@jacobhq] made their first contribution in [#846]
1414
+ * [@UnclassedPenguin] made their first contribution in [#814]
1415
+ * [@alyssais] made their first contribution in [#829]
1416
+ * [@nascosto] made their first contribution in [#857]
1417
+ * [@SPGoding] made their first contribution in [#876]
1418
+ * [@iridazzle] made their first contribution in [#727]
1419
+ * [@ivanskodje] made their first contribution in [#891]
1420
+ * [@Eisverygoodletter] made their first contribution in [#893]
1421
+
1422
+ [@AdityaTiwari2102]: https://github.com/AdityaTiwari2102
1423
+ [@svrooij]: https://github.com/svrooij
1424
+ [@alexsegura]: https://github.com/alexsegura
1425
+ [@burner1024]: https://github.com/burner1024
1426
+ [@JeffGuKang]: https://github.com/JeffGuKang
1427
+ [@dougaitken]: https://github.com/dougaitken
1428
+ [@max06]: https://github.com/max06
1429
+ [@sehilyi]: https://github.com/sehilyi
1430
+ [@nathanjessen]: https://github.com/nathanjessen
1431
+ [@waldyrious]: https://github.com/waldyrious
1432
+ [@MichelleBlanchette]: https://github.com/MichelleBlanchette
1433
+ [@henryiii]: https://github.com/henryiii
1434
+ [@jmertic]: https://github.com/jmertic
1435
+ [@jacobhq]: https://github.com/jacobhq
1436
+ [@UnclassedPenguin]: https://github.com/UnclassedPenguin
1437
+ [@alyssais]: https://github.com/alyssais
1438
+ [@nascosto]: https://github.com/nascosto
1439
+ [@SPGoding]: https://github.com/SPGoding
1440
+ [@iridazzle]: https://github.com/iridazzle
1441
+ [@ivanskodje]: https://github.com/ivanskodje
1442
+ [@Eisverygoodletter]: https://github.com/Eisverygoodletter
1443
+
1444
+ **Full Changelog**: https://github.com/just-the-docs/just-the-docs/compare/v0.3.3...v0.4.0.rc1
1445
+
1446
+ [@pmarsceill]: https://github.com/pmarsceill
1447
+
1448
+ ## v0.3.3
1449
+
1450
+ ### 🚀 Features
1451
+
1452
+ - Add custom header and footer include files @CodeSandwich (#334)
1453
+
1454
+ ### 🐛 Bug Fixes
1455
+
1456
+ - Limit the effect of `nav_exclude` to the main navigation @pdmosses (#443)
1457
+ - Update normalize.scss @pdmosses (#444)
1458
+ - Update code.scss @pdmosses (#445)
1459
+ - Fix list alignment @pdmosses (#446)
1460
+
1461
+ ### 🧰 Maintenance
1462
+
1463
+ - Bump stylelint-config-primer from 9.0.0 to 9.2.1 @dependabot-preview (#451)
1464
+ - Bump stylelint from 13.6.1 to 13.7.2 @dependabot-preview (#440)
1465
+ - Bump @primer/css from 15.1.0 to 15.2.0 @dependabot-preview (#436)
1466
+ - Bump prettier from 2.1.1 to 2.1.2 @dependabot-preview (#429)
1467
+
1468
+ ## v0.3.2
1469
+
1470
+ ### Changes
1471
+
1472
+ - Safe page sorting @pdmosses (#411)
1473
+ - v0.3.2 @pmarsceill (#388)
1474
+
1475
+ ### 🚀 Features
1476
+
1477
+ - make font-sizes sass variables so they can be changed @pdebruic (#361)
1478
+ - run the site locally inside docker container @fogfish (#398)
1479
+ - Feature/doc collections @SgtSilvio (#379)
1480
+ - Adjust dl layout @pdmosses (#401)
1481
+
1482
+ ### 🐛 Bug Fixes
1483
+
1484
+ - Add site.gh_edit_source to "Edit this page on GitHub" link @mrfleap (#418)
1485
+ - Inhibit text-transform for code in h4 @pdmosses (#404)
1486
+ - Fix native font stack precedence issue on Windows systems. @hvianna (#331)
1487
+ - Support for the linenos option on highlighted code @pdmosses (#375)
1488
+ - Update anchor_headings.html @pdmosses (#399)
1489
+ - Fix https @marksie1988 (#359)
1490
+
1491
+ ### 🧰 Maintenance
1492
+
1493
+ - Bump prettier from 2.0.5 to 2.1.1 @dependabot-preview (#427)
1494
+ - Bump prettier from 2.0.5 to 2.1.1 @dependabot-preview (#419)
1495
+ - [Security] Bump lodash from 4.17.15 to 4.17.19 @dependabot-preview (#389)
1496
+ - Bump @primer/css from 14.4.0 to 15.1.0 @dependabot-preview (#402)
1497
+ - Bump lodash from 4.17.15 to 4.17.19 @dependabot (#384)
1498
+ - Bump @primer/css from 14.4.0 to 15.0.0 @dependabot-preview (#371)
1499
+
1500
+
1501
+ ## v0.3.1
1502
+
1503
+ ### Changes
1504
+
1505
+ ### 🐛 Bug Fixes
1506
+
1507
+ - Improve accessibility by adding label to Anchor links. @mscoutermarsh (#376)
1508
+
1509
+ ### 🧰 Maintenance
1510
+
1511
+ - Remove collapsible TOC on nav doc @pmarsceill (#368)
1512
+ - Pdmosses collapsible toc @pmarsceill (#367)
1513
+
1514
+
1515
+ ## v0.3.0
1516
+
1517
+ ### Changes
1518
+
1519
+ - v0.2.9 @pmarsceill (#306)
1520
+
1521
+ ### 🚀 Features
1522
+
1523
+ - Add print styles @pmarsceill (#362)
1524
+ - Navigation improvements and search sections @SgtSilvio (#352)
1525
+
1526
+ ### 🐛 Bug Fixes
1527
+
1528
+ - Remove constraint with jekyll 4.1.0 @PierrickMartos (#348)
1529
+
1530
+ ### 🧰 Maintenance
1531
+
1532
+ - Bump version numbers @pmarsceill (#360)
1533
+ - Bump stylelint from 13.3.3 to 13.6.1 @dependabot-preview (#343)
1534
+ - Bump stylelint-config-prettier from 8.0.1 to 8.0.2 @dependabot-preview (#349)
1535
+
1536
+
1537
+ ## v0.2.9
1538
+
1539
+ ### Bug fixes
1540
+ - Horizontal Alignment #103 @pmarsceill
1541
+ - Code snippet in headers do not inherit font size #140 @pmarsceill
1542
+ - Fix duplicated title and description tags #294 @iefserge
1543
+ - Update nav.html for handling nav_exclude #282 @blawqchain
1544
+ - Fix duplicate entries in nav.html and default.html #239 @KasparEtter
1545
+ - Don't show pages with no title (e.g. redirects in nav) https://github.com/pmarsceill/just-the-docs/pull/295/commits/672de29f2e332a9350af7237e4fb6693c848989e @SgtSilvio
1546
+ - [SEARCH RAKE] Fix search generator #319 @RoiArthurB
1547
+
1548
+ ### Enhancements
1549
+ - Improvement/custom themes #186 @SgtSilvio
1550
+ - feat: adds "edit this page" and "page last modified" to footer #217 @malsf21
1551
+ - feat: adds option to open aux links in new tab #229 @malsf21
1552
+ - Default nav order #236 @pdmosses
1553
+ - Enable IP anonymization in Google Analytics (GDPR) #250 @r-brown
1554
+
1555
+ closes #240 #308 #266 #140 #103
1556
+
1557
+ ## v0.2.8
1558
+
1559
+ ### Bugfixes
1560
+ - bugfix in search.rake #218 @tiaitsch85
1561
+
1562
+ ### Dependency and security updates:
1563
+
1564
+ - Update jekyll requirement from ~> 3.8.5 to >= 3.8.5, < 4.1.0 #197 @dependabot-preview
1565
+ - Update rake requirement from ~> 12.3.1 to >= 12.3.1, < 13.1.0 #227 @dependabot-preview
1566
+ - Bump stylelint-config-primer from 8.0.0 to 9.0.0 #247 @dependabot-preview
1567
+ - Update bundler requirement from ~> 2.0.1 to ~> 2.1.4 #268 @dependabot-preview
1568
+ - Bump @primer/css from 12.7.0 to 14.3.0 #296 @dependabot-preview
1569
+
1570
+ ### Operations
1571
+
1572
+ - Update CI to test multiple versions of Jekyll
1573
+ - Update CI to check the rake command that builds the search file
1574
+
1575
+ fixes #291 #256 #293 #177
1576
+
1577
+ ## v0.2.7
1578
+
1579
+ ### Bugs fixed
1580
+ - Anchor headings are now displayed on hover, not only on heading hover
1581
+ - Deduplicated anchor heading svg
1582
+ - If last page of `site.html_pages` was excluded from search, search json breaks
1583
+ - Config variable should be `blanklines` not `blank_lines` for html compression
1584
+ - `list-style-none` does not hide bullets on `ul`
1585
+
1586
+ ### Enhancements
1587
+ - Summary for child pages appears in generated TOC
1588
+ - Site logo configuration supported replacing title text with image
1589
+ - Allow custom CSS overrides (new scss partial at the end of the cascade) separate from variable overrides.
1590
+ - Configuration around search strings added to allow search for hyphenated words
1591
+
1592
+ ### Maintenance
1593
+ - Update docs to suggest using index.md as section page filename
1594
+ - Bump @primer/css from 12.6.0 to 12.7.0
1595
+ - Bump mixin-deep from 1.3.1 to 1.3.2
1596
+ - Bump stylelint-config-primer from 7.0.1 to 8.0.0
1597
+
1598
+ ### PR included
1599
+ - #98 by @stefanoborini Introduces the possibility for a summary in the table of contents
1600
+ - #141 by @ghabs Fix trailing comma bug in search-data.json
1601
+ - #153 by @jacobherrington Change button copy on theme preview
1602
+ - #181 by @m3nu Recommend using index.md as parent page for sections
1603
+ - #183 by @SgtSilvio Improve heading anchors
1604
+ - #187 by @SgtSilvio Improvement/site logo
1605
+ - #200 Bump mixin-deep from 1.3.1 to 1.3.2
1606
+ - #203 by @pdmosses Search config
1607
+ - #205 by @pdmosses Fix blank_lines var to blanklines in config.yml
1608
+ - #206 by @iamcarrico Allow for custom overrides by the user
1609
+ - #208 Bump @primer/css from 12.6.0 to 12.7.0
1610
+ - #213 Bump mixin-deep from 1.3.1 to 1.3.2
1611
+ - #214 Bump stylelint-config-primer from 7.0.1 to 8.0.0
1612
+ - #215 Bump @primer/css from 12.6.0 to 12.7.0
1613
+
1614
+ ## v0.2.6
1615
+
1616
+ ### Bugs fixed
1617
+ - Google Analytics tag has been updated #162
1618
+ - ~BaseURL has been modified #109~ Reverted -- seems the existing implementation worked
1619
+ - Titles can now wrap fixes #106
1620
+
1621
+ ### Enhancements
1622
+ - Search now displays content preview #135
1623
+ - Custom footer content added #179
1624
+ - Now using GitHub Actions for CI #170
1625
+
1626
+ ### Maintenance
1627
+ - lunrjs upgraded #135
1628
+ - Nav generation is optimized #159
1629
+ - Stylelint upgrade #143
1630
+ - Stylelint config primer upgrade #149
1631
+ - Lodash upgrade #160
1632
+
1633
+ ### PR included
1634
+ ~#109 by @daviddarnes - Fix baseurl link~ Reverted
1635
+ #135 by @SgtSilvio - Upgrades lunr.js, improves search UI, adds heading anchors
1636
+ #152 by @yavorg - Improves syntax highlighting for js readablity
1637
+ #159 by @julienduchesne - Optimizes nav generation
1638
+ #162 by @nergmada - Modifies the google analytics code to match the new tags used by GA
1639
+
1640
+
1641
+ ## v0.2.5
1642
+
1643
+ ### Bugs fixed
1644
+
1645
+ - Duplicate title tag when Jekyll SEO Plugin gem is used #125 #126
1646
+
1647
+ ### Enhancements
1648
+
1649
+ - Favicon support added #118
1650
+
1651
+ ### Maintenance
1652
+ - Bump stylelint-config-primer from 6.0.0 to 7.0.0 #123
1653
+ - Bump @primer/css from 12.2.3 to 12.3.1 #129
1654
+ - Add workflow to publish to GPR
1655
+ - Fix workflow to publish to Ruby Gems
1656
+
1657
+ ## v0.2.4
1658
+
1659
+ ### Bugs
1660
+
1661
+ - #102 Remove unnecessary console.log() @JoeNyland
1662
+ - #97 Import custom Sass variable overrides before default variables are defined @montchr and @ptvandi
1663
+
1664
+ ### Additions
1665
+ - #117 Add links to docs for setting up GH pages locally @gnarea
1666
+ - #95 Add SEO and 'lang' param for `_config` @gebeto
1667
+
1668
+ ## v0.2.3
1669
+
1670
+ ### Enhancements
1671
+ - Adds ability to use Google Analytics tracking by @pmarsceill
1672
+
1673
+ ### Bug fixes
1674
+ - Fixes 404 error for "/assets/js//search-data.json" by @stephenedmondson
1675
+ - Fixes #80 Single quotes in the string were unescaped and ruby attempted variable substitution of amp within it (which failed) by @novelistparty
1676
+ - Fixes bug that would only show 2 or more search results (not one) by @ilivewithian
1677
+ - Fixes a typo on the layout example by @woernfl
1678
+ - Fixes #78 Page scroll position too far down on load by @pmarsceill
1679
+ - Fixds ability to nest ul in ol without breaking style or counters
1680
+
1681
+ ### Dependency updates
1682
+ - Bumps stylelint dependency from 9.9.0 to 9.10.1
1683
+
1684
+ ## v0.2.2
1685
+
1686
+ - Bumps stylelint-config-primer to 3.0.1 #44
1687
+ - Bumps bundler req to 2.0.1 #61
1688
+ - Adds custom 404 page
1689
+ - Excludes package-lock.json from jekyll build #47
1690
+ - Fixes keyboard scrolling / focus #48
1691
+ - Adds ARIA roles to navigation elements
1692
+ - Adds support for optional page description metadata (if present in yaml front matter)
1693
+ - Addresses some issues with search in #46
1694
+ - Option to hide TOC on parent pages if turned off in page's YAML front matter #30
1695
+ - Option to suppress an item from being indexed by search if present in page's YAML front matter #32
1696
+
1697
+ ## v0.2.1
1698
+
1699
+ This update fixes security vulnerabilities in the lodash sub-dependency and bumps other dev dependencies to their latest version.
1700
+
1701
+ ## v0.2.0
1702
+
1703
+ Adds:
1704
+ - Dark mode via `color_scheme` parameter
1705
+ - Ability to exclude a page from the main nav with `nav_exclude` parameter closes #21
1706
+ - Ability for create children of children pages (3 nav levels) closes #25
1707
+
1708
+ Changes:
1709
+ - Permalink structure for tiered navigation has been updated
1710
+ - Some colors have been updated for consistency / accessibility
1711
+
1712
+ ## v0.1.6
1713
+
1714
+ ### Added
1715
+
1716
+ - Support for task list styles #19
1717
+ - Configuration docs
1718
+ - Configuration option to enable / disable search
1719
+ - Normalize.scss dependency pulled into project #16 #
1720
+
1721
+ ### Fixed
1722
+
1723
+ - Layout bug in navigation #17
1724
+
1725
+ ## v0.1.5
1726
+
1727
+ Major changes:
1728
+
1729
+ - Fixed bug where the rake task would fail when the assets/js directory didn't exist
1730
+
1731
+ ## v0.1.4
1732
+
1733
+ Major changes:
1734
+ - Adds Rake as a runtime dependency
1735
+ - Definition list styled
1736
+ - Sidebar and support cleaned up for smaller screen support
1737
+ - Updated some stale docs
1738
+
1739
+ ## v0.1.3
1740
+
1741
+ Major changes:
1742
+ - Fix path problems, typos, and general clean-up for OSS.
1743
+
1744
+ ## v0.1.2
1745
+
1746
+ Fix paths when deployed to gh-pages
1747
+
1748
+ ## v0.1.1
1749
+
1750
+ Major updates:
1751
+ - Adds search to mobile nav
1752
+ - Pulls footer to bottom of the page on mobile (not hidden in nav)
1753
+
1754
+ Minor updates:
1755
+ - Cleans up h1 typography spacing