just-the-docs-peter 0.1.0 → 0.1.1

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