just-the-docs 0.4.0.rc5 → 0.4.1

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 27c3121b1ff1760f720e64458a1943246f988a45381717153e659e7d54c700e9
4
- data.tar.gz: 8d39c390841bd78261b1f7f9dd72576b708f3475676229b5627f83973c018f60
3
+ metadata.gz: 440d312f6c68a86a993a1fddc2b61d1641e5fe36effd6f955d83b336028c8451
4
+ data.tar.gz: e3ad4e055424dbeee4bb32155d6bb6d6d651a81085d5af0260dd413baaaaebf3
5
5
  SHA512:
6
- metadata.gz: 592cb6dd8830ef25db17c2f33ff2c3b0b48c3af397de959e58c64c84119d57da350ca05af2cdce8ca38ca684e60454e3a87a5b8eba934c2ba5cee0cd7da692ec
7
- data.tar.gz: d8ebad34781d09fa15af1c5291b40a6f2c6077525ea7428af13c0230805bb98ea783335fa8e0d017b27dc97d3c2c9852435b333d472027383d9026b4326e6487
6
+ metadata.gz: cc347172d6be7593580c7976001ab4246c1b5b7220257b941693317b55b751c84b4df560a0c51643b02446723f34e06c94e86d33bca9b826f2f05862ff8f6a00
7
+ data.tar.gz: 7121dda31f7ca398995f52b9e8808b5949c32788bcb5fbc71863d34cc1027b2b36bfc7cd0aae94d41c22e1c9bdfa0da1334cb66bbc7ebf487cb8c0775759f407
data/CHANGELOG.md CHANGED
@@ -16,11 +16,317 @@ The project underwent a major maintenance shift in March 2022.
16
16
  This website is built from the `HEAD` of the `main` branch of the theme repository.
17
17
 
18
18
  {: .warning }
19
- This website includes docs for some new features that are not available in `v0.4.0.rc5` and `v0.3.3`!
19
+ This website includes docs for some new features that are not available in `v0.4.1`!
20
20
 
21
- Changes to `main` that are *not* in the latest pre-release:
21
+ Code changes to `main` that are *not* in the latest release:
22
22
 
23
- - n/a
23
+ - N/A
24
+
25
+ Docs changes in `main` that are *not* in the latest release:
26
+
27
+ - N/A
28
+
29
+ ## Release v0.4.1
30
+
31
+ 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.
32
+
33
+ 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!
34
+
35
+ ### Using Release `v0.4.1`
36
+
37
+ Users who have not pinned the theme version will be **automatically upgraded to `v0.4.1` the next time they build their site**.
38
+
39
+ To use this release explicitly as a remote theme:
40
+
41
+ ```yml
42
+ remote_theme: just-the-docs/just-the-docs@v0.4.1
43
+ ```
44
+
45
+ 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`:
46
+
47
+ ```ruby
48
+ gem "just-the-docs", "0.4.1"
49
+ ```
50
+
51
+ To use and pin a previous version of the theme, replace the `0.4.1` with the desired release tag.
52
+
53
+ ### Bugfixes
54
+
55
+ - Fixed: allow later versions of `bundler` by [@mattxwang] in [#1165]
56
+ - Fixed: AsciiDoc code block styling by [@flyx] in [#1168]
57
+ - Fixed: main content negative margin for viewports in `[$md, $nav-width + $content-width]` by [@Dima-369] in [#1177]
58
+ - Removed: unused `OneDarkJekyll` files by [@mattxwang] in [#1167]
59
+
60
+ ### Documentation
61
+
62
+ - Fixed: re-add `jekyll-github-metadata` to docs site by [@mattxwang] in [#1108]
63
+
64
+ ### New Contributors
65
+
66
+ - [@flyx] made their first contribution in [#1168]
67
+ - [@Dima-369] made their first contribution in [#1177]
68
+
69
+ [#1108]: https://github.com/just-the-docs/just-the-docs/pull/1108
70
+ [#1165]: https://github.com/just-the-docs/just-the-docs/pull/1165
71
+ [#1167]: https://github.com/just-the-docs/just-the-docs/pull/1167
72
+ [#1168]: https://github.com/just-the-docs/just-the-docs/pull/1168
73
+ [#1177]: https://github.com/just-the-docs/just-the-docs/pull/1177
74
+
75
+ [@flyx]: https://github.com/flyx
76
+ [@Dima-369]: https://github.com/Dima-369
77
+
78
+ **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)
79
+
80
+ ## Release v0.4.0
81
+
82
+ 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.
83
+
84
+ ### Brief Overview - Highlighted Changes
85
+
86
+ `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:
87
+
88
+ - better support for dark theme: dark highlighting, search input color
89
+ - [callouts](https://just-the-docs.github.io/just-the-docs/docs/ui-components/callouts/), a new design component to highlight content
90
+ - [configuring mermaid.js](https://just-the-docs.github.io/just-the-docs/docs/ui-components/code/#mermaid-diagram-code-blocks), a markdown-native diagram visualization library
91
+ - [copy code button](https://just-the-docs.github.io/just-the-docs/docs/ui-components/code/#copy-button) for code snippets
92
+ - [external navigation links](https://just-the-docs.github.io/just-the-docs/docs/navigation-structure/#external-navigation-links)
93
+ - major improvements to nav generation efficiency and robustness
94
+ - minor improvements to built-in accessibility (SVG icons, nav titles, skip to main content)
95
+ - [modularized site components](https://just-the-docs.github.io/just-the-docs/docs/customization/#custom-layouts-and-includes) (advanced feature)
96
+ - [new custom includes](https://just-the-docs.github.io/just-the-docs/docs/customization/#override-includes): table of contents heading, navigation panel footer, search placeholder, lunr search indices
97
+ - 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!
98
+ - more documentation for [custom includes](https://just-the-docs.github.io/just-the-docs/docs/customization/#override-includes), this changelog, and the [migration guide](https://just-the-docs.github.io/just-the-docs/MIGRATION/)
99
+
100
+ *After usage instructions and the roadmap, we enumerate all changes from `v0.3.3`.*
101
+
102
+ ### Using Release `v0.4.0`
103
+
104
+ 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**.
105
+
106
+ To use this release explicitly as a remote theme:
107
+
108
+ ```yml
109
+ remote_theme: just-the-docs/just-the-docs@v0.4.0
110
+ ```
111
+
112
+ 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`:
113
+
114
+ ```ruby
115
+ gem "just-the-docs", "0.4.0"
116
+ ```
117
+
118
+ If you would prefer to not upgrade, you can enforce that explicitly:
119
+
120
+ 1. pin your gem version in your `Gemfile`, like so
121
+ ```ruby
122
+ gem "just-the-docs", "0.3.3"
123
+ ```
124
+ 2. freeze the `remote_theme`, like so
125
+ ```yml
126
+ remote_theme: just-the-docs/just-the-docs@v0.3.3
127
+ ```
128
+
129
+ ### Migration Guide and Strategies
130
+
131
+ We've developed a new [migration guide](https://just-the-docs.github.io/just-the-docs/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.
132
+
133
+ **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.
134
+
135
+ 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.
136
+
137
+ 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!
138
+
139
+ ### Roadmap (What's Next?)
140
+
141
+ 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!
142
+
143
+ Broadly, many features are still on the radar. We anticipate the rest of `v0.4.x` to be bugfixes surrounding this new release.
144
+
145
+ For version `v0.5`, our roadmap includes:
146
+
147
+ - a theme toggle (light/dark mode), with automatic theme switching based on browser preferences
148
+ - better GDPR compliance for analytics
149
+ - multi-level/recursive navigation (unlimited hierarchy of child pages)
150
+
151
+ In future versions, we also plan on:
152
+
153
+ - adding better dark theme defaults
154
+ - adding better internationalization support
155
+ - exploring offline PDF generation
156
+ - improving accessibility within the theme
157
+ - improving search functionality
158
+ - refactoring and improving the robustness of our codebase
159
+
160
+ 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.
161
+
162
+ ### New Features
163
+
164
+ - Added: Combination by [@pdmosses] in [#578]
165
+ - Added: dark highlighting in [#463]
166
+ - Added: pages and collections in [#448]
167
+ - Added: callouts in [#466]
168
+ - Fixed: breadcrumb behaviour … by [@AdityaTiwari2102] in [#477]
169
+ - Fixed: prevent rake command corrupting search data in [#495] (also listed below)
170
+ - Fixed: nested lists in [#496]
171
+ - Fixed: set color for search input in [#498] (also listed below)
172
+ - Fixed: sites with no child pages (no PR)
173
+ - Fixed: TOC/breadcrumbs for multiple collections in [#494]
174
+ - Added: collection configuration option `nav_fold` (no PR)
175
+ - Fixed: indentation and color for folded collection navigation (no PR)
176
+ - Fixed: scroll navigation to show the link to the current page in [#639]
177
+ - Fixed: Replace all uses of `absolute_url` by `relative_url`, by [@svrooij] in [#544]
178
+ - Added: custom favicon `_includes` by [@burner1024] in [#364]
179
+ - Added: set color for search input by [@pdmosses] in [#498]
180
+ - Added: search placeholder configuration by [@mattxwang] in [#613]
181
+ - Added: 'child_nav_order' front matter to be able to sort navigation pages in reverse by [@jmertic] in [#726]
182
+ - Added: `nav_footer_custom` include by [@nathanjessen] in [#474]
183
+ - Added: style fixes for jekyll-asciidoc by [@alyssais] in [#829]
184
+ - Added: mermaid.js support by [@nascosto] in [#857]
185
+ - Added: support for external navigation links by [@SPGoding] in [#876]
186
+ - Added: refactor `mermaid` config to use `mermaid_config.js` include, only require `mermaid.version` in `_config.yml` by [@mattxwang] in [#909]
187
+ - Added: accessible titles to nested page nav toggle by [@JPrevost] in [#950]
188
+ - Added: better title styling for AsciiDoc examples by [@alyssais] in [#944]
189
+ - Added: docs for custom search placeholder by [@mattxwang] in [#939]
190
+ - Added: provide ability to skip to main content by [@JPrevost] in [#949]
191
+ - Added: styling for `<blockquote>` by [@mattxwang] in [#965]
192
+ - Added: custom include for TOC heading by [@pdmosses] in [#980]
193
+ - Added: experimental nav optimization for simple cases by [@pdmosses] in [#992]
194
+ - Added: support multiple Google Analytics tracking IDs, document UA -> GA4 switch by [@MichelleBlanchette] in [#1029]
195
+ - Added: copy code button to code snippets by [@simonebortolin] in [#945]
196
+ - Added: restore simple configuration of `favicon.ico` via `site.static_files` by [@pdmosses] in [#1095]
197
+ - Added: modularize site components by [@mattxwang] in [#1058]
198
+ - Added: includes for custom `lunr` Liquid and JS code by [@diablodale] in [#1068]
199
+ - Added: new `_sass/custom/setup.scss` for variable definition by [@mattxwang] in [#1135]
200
+ - Added: configuration key to load a local version of mermaid by [@fabrik42] in [#1153]
201
+
202
+ ### Bugfixes
203
+
204
+ - Fixed: prepend `site.collections_dir` if exists by [@alexsegura] in [#519]
205
+ - Fixed: nested task lists (#517) by [@pdmosses] in [#855]
206
+ - Fixed: suppress Liquid processing in CSS comments by [@pdmosses] in [#686]
207
+ - Fixed: prevent rake command from corrupting search data by [@pdmosses] in [#495]
208
+ - Fixed: anchor heading links should be visible on focus by [@jacobhq] in [#846]
209
+ - Fixed: add `overflow-x: auto` to `figure.highlight` by [@iridazzle] in [#727]
210
+ - Fixed: add `overflow-wrap: word-break` to `body` by [@iridazzle] in [#889]
211
+ - Fixed: vertical alignment for consecutive labels by [@Eisverygoodletter] in [#893]
212
+ - Fixed: allow links to wrap by [@pdmosses] in [#905]
213
+ - Fixed: nav scroll feature and absolute/relative URLs by [@pdmosses] in [#898]
214
+ - Fixed: exclude `vendor/` in Jekyll config by [@manuelhenke] in [#941]
215
+ - Fixed: improve build time of navigation panel by [@pdmosses] in [#956]
216
+ - Fixed: spacing issue when search is disabled by [@henryiii] in [#960]
217
+ - Fixed: active grandchild link class by [@pdmosses] in [#962]
218
+ - Fixed: HTML validation issues (W3C validator) by [@mattxwang] in [#964]
219
+ - Fixed: link styling now uses `text-decoration` values by [@mattxwang] in [#967]
220
+ - Fixed: cleaning up Jekyll excludes by [@pdmosses] in [#985]
221
+ - Fixed: docs, narrow styling for code highlighting with line numbers by [@pdmosses] in [#974]
222
+ - Fixed: default syntax highlighting in custom color schemes [@pdmosses] in [#986]
223
+ - Fixed: incorrect disambiguation in generated TOCs by [@pdmosses] in [#999]
224
+ - Fixed: duplicated external links in collections by [@pdmosses] in [#1001]
225
+ - Fixed: import order of `custom.scss`; puts at end by [@deseo] in [#1010]
226
+ - Fixed: top-level active link styling by [@pdmosses] in [#1015]
227
+ - Fixed: external links for sites with no pages by [@pdmosses] in [#1021]
228
+ - Fixed: duplicate `title` if `jekyll-seo-tag` not in users's plugins by [@Tom-Brouwer] in [#1040]
229
+ - Fixed: removes (duplicate) `favicon.html`, shifts content to `head_custom.html` by [@mattxwang] in [#1027]
230
+ - Fixed: add `reversed`, deprecate `desc` for nav `child_nav_order` by [@jmertic] in [#1061]
231
+ - Fixed: `child.child_nav_order` to `node.child_nav_order` by [@mattxwang] in [#1065]
232
+ - Fixed: remove all uses of `/` as SASS division by [@mattxwang] in [#1074]
233
+ - note: this was originally merged as [#1074] with a bug; it was reverted in [#1076], and then reimplemented in [#1077]
234
+ - Fixed: skip nav collection generation when site has no pages by [@pdmosses] in [#1092]
235
+ - Fixed: standardize SCSS with `declaration-block-no-redundant-longhand-properties` by [@simonebortolin] in [#1102]
236
+ - Fixed: incorrect `padding` property value pair in `labels.scss` by [@SConaway] in [#1104]
237
+ - Fixed: various bugs with copy code button by [@simonebortolin] in [#1096]
238
+ - Fixed: replace inline styling for `<svg>` icons by [@captn3m0] in [#1110]
239
+ - Fixed: incorrect `padding` property value pair in `search.scss` by [@kevinlin1] in [#1123]
240
+ - Fixed: minor spacing and comment nits by [@EricFromCanada] in [#1128]
241
+ - Fixed: exclude images from being bundled with gem by [@m-r-mccormick] in [#1142]
242
+ - Fixed: dark theme code block background, line number colors by [@m-r-mccormick] in [#1124]
243
+ - Fixed: copy code button interaction with kramdown line numbers by [@mattxwang] in [#1143]
244
+
245
+ ### Maintenance
246
+
247
+ - Added: VScode devcontainer by [@max06] in [#783]
248
+ - Added: `webrick` to `Gemfile` by [@mattxwang] in [#799]
249
+ - Added: 'This site is powered by Netlify.' to the footer by [@mattxwang] in [#797]
250
+ - Updated: new repo path by [@pmarsceill] in [#775]
251
+ - Updated: rename `master` -> `main` by [@pmarsceill] in [#776]
252
+ - Updated: README by [@pmarsceill] in [#777]
253
+ - Updated: Code of Conduct to Contributor Covenant v2.1 by [@mattxwang] in [#790]
254
+ - Updated: CI files, Ruby & Node Versions by [@mattxwang] in [#820]
255
+ - Updated: Stylelint to v14, extend SCSS plugins, remove primer-* configs, resolve issues by [@mattxwang] in [#821]
256
+ - Deleted: unused script directory by [@mattxwang] in [#937]
257
+ - Vendor: update `jekyll-anchor-headings`, `lunr.js` by [@mattxwang] in [#1071]
258
+
259
+ ### Documentation
260
+
261
+ - Added: docs on how to break an `ol` by [@pdmosses] in [#856]
262
+ - Added: docs for custom includes by [@nathanjessen] in [#806]
263
+ - Added: document caveat about variable dependencies by [@waldyrious] in [#555]
264
+ - Added: docs on how to use `custom_head` to add a custom favicon by [@UnclassedPenguin] in [#814]
265
+ - Added: docs load mermaid.js by default by [@mattxwang] in [#935]
266
+ - Added: warning about mandatory `_`-prefix for collections by [@max06] in [#1091]
267
+ - Added: migration guide by [@pdmosses] in [#1059]
268
+ - Added: label new features introduced in `v0.4` by [@mattxwang] in [#1138]
269
+ - Fixed: `ol` on `index.md` by [@pmarsceill] in [#778]
270
+ - Fixed: image link in Markdown kitchen sink by [@JeffGuKang] in [#221]
271
+ - Fixed: images in Markdown kitchen sink by [@dougaitken] in [#782]
272
+ - Fixed: clearer label of link to Jekyll quickstart by [@waldyrious] in [#549]
273
+ - Fixed: remove extra spaces in component docs by [@MichelleBlanchette] in [#554]
274
+ - Fixed: double "your" typo in `index.md` by [@sehilyi] in [#499]
275
+ - Fixed: "you" -> "your" typo in `index.md` by [@nathanjessen] in [#473]
276
+ - Fixed: spacing in toc example by [@henryiii] in [#835]
277
+ - Fixed: typo in `README` on `_config.yml` by [@ivanskodje] in [#891]
278
+ - Fixed: missing code fence in navigation structure docs by [@mattxwang] in [#906]
279
+ - Fixed: table of contents on search docs by [@robinpokorny] in [#940]
280
+ - Fixed: broken docs link (custom footer) by [@olgarithms] in [#951]
281
+ - Fixed: clarify version docs by [@pdmosses] in [#955]
282
+ - Fixed: typo in changelog links [@koppor] in [#1000]
283
+ - Fixed: two bugs in "Customization" (custom favicon, new annotation) by [@mattxwang] in [#1090]
284
+ - Fixed: "View Typography Utilities" link by [@agabrys] in [#1130]
285
+ - Fixed: broken relative page links by [@mattxwang] in [#1106]
286
+ - Fixed: clarify steps to add custom `lunr` index code by [@diablodale] in [#1139]
287
+ - Updated: homepage (focus: new features, conciseness, deduplication) by [@pdmosses] in [#1018]
288
+ - Updated: README (focus: new features, conciseness, deduplication) by [@pdmosses] in [#1019]
289
+ - Updated: `README` demo video by [@codewithfan] in [#1097]
290
+
291
+ ### New Contributors
292
+
293
+ - [@AdityaTiwari2102] made their first contribution in [#477]
294
+ - [@svrooij] made their first contribution in [#544]
295
+ - [@alexsegura] made their first contribution in [#519]
296
+ - [@burner1024] made their first contribution in [#364]
297
+ - [@JeffGuKang] made their first contribution in [#221]
298
+ - [@dougaitken] made their first contribution in [#782]
299
+ - [@max06] made their first contribution in [#783]
300
+ - [@sehilyi] made their first contribution in [#499]
301
+ - [@nathanjessen] made their first contribution in [#473]
302
+ - [@waldyrious] made their first contribution in [#549]
303
+ - [@MichelleBlanchette] made their first contribution in [#554]
304
+ - [@henryiii] made their first contribution in [#835]
305
+ - [@jmertic] made their first contribution in [#726]
306
+ - [@jacobhq] made their first contribution in [#846]
307
+ - [@UnclassedPenguin] made their first contribution in [#814]
308
+ - [@alyssais] made their first contribution in [#829]
309
+ - [@nascosto] made their first contribution in [#857]
310
+ - [@SPGoding] made their first contribution in [#876]
311
+ - [@iridazzle] made their first contribution in [#727]
312
+ - [@ivanskodje] made their first contribution in [#891]
313
+ - [@Eisverygoodletter] made their first contribution in [#893]
314
+ - [@robinpokorny] made their first contribution in [#940]
315
+ - [@olgarithms] made their first contribution in [#951]
316
+ - [@manuelhenke] made their first contribution in [#941]
317
+ - [@JPrevost] made their first contribution in [#950]
318
+ - [@koppor] made their first contribution in [#1000]
319
+ - [@deseo] made their first contribution in [#1010]
320
+ - [@Tom-Brouwer] made their first contribution in [#1040]
321
+ - [@simonebortolin] made their first contribution in [#945]
322
+ - [@SConaway] made their first contribution in [#1104]
323
+ - [@captn3m0] made their first contribution in [#1110]
324
+ - [@kevinlin1] made their first contribution in [#1123]
325
+ - [@codewithfan] made their first contribution in [#1097]
326
+ - [@agabrys] made their first contribution in [#1130]
327
+ - [@diablodale] made their first contribution in [#1068]
328
+ - [@m-r-mccormick] made their first contribution in [#1142]
329
+ - [@fabrik42] made their first contribution in [#1153]
24
330
 
25
331
  ## Pre-release v0.4.0.rc5
26
332
 
@@ -40,14 +346,14 @@ remote_theme: just-the-docs/just-the-docs@v0.4.0.rc5
40
346
 
41
347
  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`:
42
348
 
43
- ```Ruby
349
+ ```ruby
44
350
  gem "just-the-docs", "0.4.0.rc5"
45
351
  ```
46
352
 
47
353
  By default, **users will not be upgraded to `0.4.0.rc5`**. To enforce that explicitly, either:
48
354
 
49
355
  1. pin your gem version in your `Gemfile`, like so
50
- ```Ruby
356
+ ```ruby
51
357
  gem "just-the-docs", "0.3.3"
52
358
  ```
53
359
  2. freeze the `remote_theme`, like so
@@ -141,14 +447,14 @@ remote_theme: just-the-docs/just-the-docs@v0.4.0.rc4
141
447
 
142
448
  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`:
143
449
 
144
- ```Ruby
450
+ ```ruby
145
451
  gem "just-the-docs", "0.4.0.rc4"
146
452
  ```
147
453
 
148
454
  By default, **users will not be upgraded to `0.4.0.rc4`**. To enforce that explicitly, either:
149
455
 
150
456
  1. pin your gem version in your `Gemfile`, like so
151
- ```Ruby
457
+ ```ruby
152
458
  gem "just-the-docs", "0.3.3"
153
459
  ```
154
460
  2. freeze the `remote_theme`, like so
@@ -262,14 +568,14 @@ remote_theme: just-the-docs/just-the-docs@v0.4.0.rc3
262
568
 
263
569
  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`:
264
570
 
265
- ```Ruby
571
+ ```ruby
266
572
  gem "just-the-docs", "0.4.0.rc3"
267
573
  ```
268
574
 
269
575
  By default, **users will not be upgraded to `0.4.0.rc3`**. To enforce that explicitly, either:
270
576
 
271
577
  1. pin your gem version in your `Gemfile`, like so
272
- ```Ruby
578
+ ```ruby
273
579
  gem "just-the-docs", "0.3.3"
274
580
  ```
275
581
  2. freeze the `remote_theme`, like so
@@ -338,14 +644,14 @@ remote_theme: just-the-docs/just-the-docs@v0.4.0.rc2
338
644
 
339
645
  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`:
340
646
 
341
- ```Ruby
647
+ ```ruby
342
648
  gem "just-the-docs", "0.4.0.rc2"
343
649
  ```
344
650
 
345
651
  By default, **users will not be upgraded to `0.4.0.rc2`**. To enforce that explicitly, either:
346
652
 
347
653
  1. pin your gem version in your `Gemfile`, like so
348
- ```Ruby
654
+ ```ruby
349
655
  gem "just-the-docs", "0.3.3"
350
656
  ```
351
657
  2. freeze the `remote_theme`, like so
@@ -426,7 +732,7 @@ remote_theme: just-the-docs/just-the-docs@v0.4.0.rc1
426
732
 
427
733
  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`:
428
734
 
429
- ```Ruby
735
+ ```ruby
430
736
  gem "just-the-docs", "0.4.0.rc1"
431
737
  ```
432
738
 
@@ -437,7 +743,7 @@ If you're not ready to make the switch, that's alright! If your version of just-
437
743
  If you have not pinned your theme version, you should either:
438
744
 
439
745
  1. pin your gem version in your `Gemfile`, like so
440
- ```Ruby
746
+ ```ruby
441
747
  gem "just-the-docs", "0.3.3"
442
748
  ```
443
749
  2. freeze the `remote_theme`, like so
data/_sass/code.scss CHANGED
@@ -50,6 +50,11 @@ a:visited code {
50
50
  // Kramdown line_numbers = true: fences have a wider gutter than with Liquid?
51
51
 
52
52
  // ```[LANG]...```
53
+ // or in AsciiDoc:
54
+ //
55
+ // ----
56
+ // ...
57
+ // ----
53
58
 
54
59
  // the code may appear with 3 different types:
55
60
  // container \ case: default case, code with line number, code with html rendering
@@ -59,6 +64,7 @@ a:visited code {
59
64
  // last level: code, pre, code (optionality)
60
65
  // highlighter level: span, span, span
61
66
  // the spacing are only in the second level for case 1, 3 and in the third level for case 2
67
+ // in AsciiDoc, there is a parent container that contains optionally a title and the content.
62
68
 
63
69
  // select top level container
64
70
  div.highlighter-rouge,
@@ -111,17 +117,17 @@ figure.highlight {
111
117
  }
112
118
 
113
119
  // setting the spacing and scrollbar on the second level for the first case
114
- // remove all space on the second and thirt level
115
- div.highlighter-rouge,
116
- div.listingblock {
117
- div.highlight {
120
+ // remove all space on the second and third level
121
+ // this is a mixin to accommodate for the slightly different structures generated via Markdown vs AsciiDoc
122
+ @mixin scroll-and-spacing($code-div, $pre-select) {
123
+ #{$code-div} {
118
124
  overflow-x: auto;
119
125
  padding: $sp-3;
120
126
  margin: 0;
121
127
  border: 0;
122
128
  }
123
129
 
124
- pre.highlight,
130
+ #{$pre-select},
125
131
  code {
126
132
  padding: 0;
127
133
  margin: 0;
@@ -129,6 +135,19 @@ div.listingblock {
129
135
  }
130
136
  }
131
137
 
138
+ // for Markdown
139
+ div.highlighter-rouge {
140
+ @include scroll-and-spacing("div.highlight", "pre.highlight");
141
+ }
142
+
143
+ // for AsciiDoc. we also need to fix the margins for its parent container.
144
+ div.listingblock {
145
+ @include scroll-and-spacing("div.content", "div.content > pre");
146
+
147
+ margin-top: 0;
148
+ margin-bottom: $sp-3;
149
+ }
150
+
132
151
  // {% highlight LANG %}...{% endhighlight %},
133
152
  // {% highlight LANG linenos %}...{% endhighlight %}:
134
153
 
data/_sass/layout.scss CHANGED
@@ -29,9 +29,13 @@
29
29
  }
30
30
 
31
31
  @include mq(lg) {
32
- margin-left: calc(
33
- (100% - #{$nav-width + $content-width}) / 2 + #{$nav-width}
32
+ // stylelint-disable function-name-case
33
+ // disable for Max(), we want to use the CSS max() function
34
+ margin-left: Max(
35
+ #{$nav-width},
36
+ calc((100% - #{$nav-width + $content-width}) / 2 + #{$nav-width})
34
37
  );
38
+ // stylelint-enable function-name-case
35
39
  }
36
40
  }
37
41
 
@@ -488,7 +488,7 @@ jtd.onReady(function(){
488
488
 
489
489
  jtd.onReady(function(){
490
490
 
491
- var codeBlocks = document.querySelectorAll('div.highlighter-rouge, div.listingblock, figure.highlight');
491
+ var codeBlocks = document.querySelectorAll('div.highlighter-rouge, div.listingblock > div.content, figure.highlight');
492
492
 
493
493
  // note: the SVG svg-copied and svg-copy is only loaded as a Jekyll include if site.enable_copy_code_button is true; see _includes/icons/icons.html
494
494
  var svgCopied = '<svg viewBox="0 0 24 24" class="copy-icon"><use xlink:href="#svg-copied"></use></svg>';
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: just-the-docs
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.4.0.rc5
4
+ version: 0.4.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Patrick Marsceill
@@ -9,20 +9,20 @@ authors:
9
9
  autorequire:
10
10
  bindir: bin
11
11
  cert_chain: []
12
- date: 2023-02-05 00:00:00.000000000 Z
12
+ date: 2023-02-23 00:00:00.000000000 Z
13
13
  dependencies:
14
14
  - !ruby/object:Gem::Dependency
15
15
  name: bundler
16
16
  requirement: !ruby/object:Gem::Requirement
17
17
  requirements:
18
- - - "~>"
18
+ - - ">="
19
19
  - !ruby/object:Gem::Version
20
20
  version: 2.3.5
21
21
  type: :development
22
22
  prerelease: false
23
23
  version_requirements: !ruby/object:Gem::Requirement
24
24
  requirements:
25
- - - "~>"
25
+ - - ">="
26
26
  - !ruby/object:Gem::Version
27
27
  version: 2.3.5
28
28
  - !ruby/object:Gem::Dependency
@@ -154,14 +154,10 @@ files:
154
154
  - _sass/utilities/_typography.scss
155
155
  - _sass/utilities/utilities.scss
156
156
  - _sass/vendor/OneDarkJekyll/LICENSE
157
- - _sass/vendor/OneDarkJekyll/README.md
158
- - _sass/vendor/OneDarkJekyll/colors.less
159
157
  - _sass/vendor/OneDarkJekyll/syntax-firewatch-green.scss
160
158
  - _sass/vendor/OneDarkJekyll/syntax-firewatch.scss
161
159
  - _sass/vendor/OneDarkJekyll/syntax-one-dark-vivid.scss
162
160
  - _sass/vendor/OneDarkJekyll/syntax-one-dark.scss
163
- - _sass/vendor/OneDarkJekyll/syntax-variables.less
164
- - _sass/vendor/OneDarkJekyll/syntax.less
165
161
  - _sass/vendor/normalize.scss/README.md
166
162
  - _sass/vendor/normalize.scss/normalize.scss
167
163
  - assets/css/just-the-docs-dark.scss
@@ -193,9 +189,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
193
189
  version: '0'
194
190
  required_rubygems_version: !ruby/object:Gem::Requirement
195
191
  requirements:
196
- - - ">"
192
+ - - ">="
197
193
  - !ruby/object:Gem::Version
198
- version: 1.3.1
194
+ version: '0'
199
195
  requirements: []
200
196
  rubygems_version: 3.3.7
201
197
  signing_key:
@@ -1,25 +0,0 @@
1
- # OneDarkJekyll
2
-
3
- *Use Atom's One Dark syntax colors in your Jekyll powered blog!*
4
-
5
- It's LESS file which can be compiled to a - Pygments, Rouge compatible - stylesheet from Atom editor's One Dark syntax theme (and any theme based on it, for example One Dark Vivid, Firewatch, etc.).
6
-
7
- Download the stylesheet files or compile a new one from any Atom syntax theme which based on One Dark (the variable names in `colors.less` must match with One Dark's)
8
-
9
- ## Create a new syntax stylesheet
10
-
11
- 1. `npm install -g less less-plugin-clean-css`
12
- 2. Clone this repository
13
- 3. Download the `colors.css` file from the syntax theme's repository (for example https://github.com/atom/one-dark-syntax/blob/master/styles/colors.less in case of One-Dark)
14
- 4. Put the previously downloaded file next to `syntax.less`
15
- 5. Run `lessc syntax.less syntax.css --clean-css`
16
- 6. Use the `syntax.css`
17
-
18
- It's not final and in case you find any error/improvement feel free to create a PR. :)
19
-
20
- ----
21
-
22
- # UPDATES FOR USE IN JUST-THE-DOCS:
23
-
24
- 1. Layout added in `*.css`
25
- 2. Renamed `*.css` to `*.scss`
@@ -1,30 +0,0 @@
1
- // Config -----------------------------------
2
- @syntax-hue: 220;
3
- @syntax-saturation: 13%;
4
- @syntax-brightness: 18%;
5
-
6
-
7
- // Monochrome -----------------------------------
8
- @mono-1: hsl(@syntax-hue, 14%, 71%); // default text
9
- @mono-2: hsl(@syntax-hue, 9%, 55%);
10
- @mono-3: hsl(@syntax-hue, 10%, 40%);
11
-
12
- // Colors -----------------------------------
13
- @hue-1: hsl(187, 47%, 55%); // <-cyan
14
- @hue-2: hsl(207, 82%, 66%); // <-blue
15
- @hue-3: hsl(286, 60%, 67%); // <-purple
16
- @hue-4: hsl( 95, 38%, 62%); // <-green
17
-
18
- @hue-5: hsl(355, 65%, 65%); // <-red 1
19
- @hue-5-2: hsl( 5, 48%, 51%); // <-red 2
20
-
21
- @hue-6: hsl( 29, 54%, 61%); // <-orange 1
22
- @hue-6-2: hsl( 39, 67%, 69%); // <-orange 2
23
-
24
-
25
- // Base colors -----------------------------------
26
- @syntax-fg: @mono-1;
27
- @syntax-bg: hsl(@syntax-hue, @syntax-saturation, @syntax-brightness);
28
- @syntax-gutter: darken(@syntax-fg, 26%);
29
- @syntax-guide: fade(@syntax-fg, 15%);
30
- @syntax-accent: hsl(@syntax-hue, 100%, 66% );
@@ -1,56 +0,0 @@
1
- @import "colors.less";
2
-
3
- // Official Syntax Variables -----------------------------------
4
-
5
- // General colors
6
- @syntax-text-color: @syntax-fg;
7
- @syntax-cursor-color: @syntax-accent;
8
- @syntax-selection-color: lighten(@syntax-background-color, 10%);
9
- @syntax-selection-flash-color: @syntax-accent;
10
- @syntax-background-color: @syntax-bg;
11
-
12
- // Guide colors
13
- @syntax-wrap-guide-color: @syntax-guide;
14
- @syntax-indent-guide-color: @syntax-guide;
15
- @syntax-invisible-character-color: @syntax-guide;
16
-
17
- // For find and replace markers
18
- @syntax-result-marker-color: fade(@syntax-accent, 24%);
19
- @syntax-result-marker-color-selected: @syntax-accent;
20
-
21
- // Gutter colors
22
- @syntax-gutter-text-color: @syntax-gutter;
23
- @syntax-gutter-text-color-selected: @syntax-fg;
24
- @syntax-gutter-background-color: @syntax-bg; // unused
25
- @syntax-gutter-background-color-selected: lighten(@syntax-bg, 2%);
26
-
27
- // Git colors - For git diff info. i.e. in the gutter
28
- @syntax-color-renamed: hsl(208, 100%, 60%);
29
- @syntax-color-added: hsl(150, 60%, 54%);
30
- @syntax-color-modified: hsl(40, 60%, 70%);
31
- @syntax-color-removed: hsl(0, 70%, 60%);
32
-
33
- // For language entity colors
34
- @syntax-color-variable: @hue-5;
35
- @syntax-color-constant: @hue-6;
36
- @syntax-color-property: @syntax-fg;
37
- @syntax-color-value: @syntax-fg;
38
- @syntax-color-function: @hue-2;
39
- @syntax-color-method: @hue-2;
40
- @syntax-color-class: @hue-6-2;
41
- @syntax-color-keyword: @hue-3;
42
- @syntax-color-tag: @hue-5;
43
- @syntax-color-attribute: @hue-6;
44
- @syntax-color-import: @hue-3;
45
- @syntax-color-snippet: @hue-4;
46
-
47
-
48
- // Custom Syntax Variables -----------------------------------
49
- // Don't use in packages
50
-
51
- @syntax-cursor-line: hsla(@syntax-hue, 100%, 80%, .04); // needs to be semi-transparent to show search results
52
-
53
- @syntax-deprecated-fg: darken(@syntax-color-modified, 50%);
54
- @syntax-deprecated-bg: @syntax-color-modified;
55
- @syntax-illegal-fg: white;
56
- @syntax-illegal-bg: @syntax-color-removed;
@@ -1,93 +0,0 @@
1
- /*
2
- LESS for Pygments
3
- */
4
-
5
- @import "syntax-variables.less";
6
-
7
- pre.highlight,
8
- .highlight {
9
- background: @syntax-bg;
10
- color: @mono-1;
11
- }
12
- .highlight {
13
- pre { background: @syntax-bg; }
14
- .hll { background: @syntax-bg; }
15
- .c { color: @mono-3; font-style: italic; } /* Comment */
16
- .err { color: @syntax-illegal-fg; background-color: @syntax-illegal-bg; } /* Error */
17
- .k { color: @hue-3; } /* Keyword */
18
- .l { color: @hue-4; } /* Literal */
19
- .n { color: @mono-1; } /* Name */
20
- .o { color: @mono-1; } /* Operator */
21
- .p { color: @mono-1; } /* Punctuation */
22
- .cm { color: @mono-3; font-style: italic; } /* Comment.Multiline */
23
- .cp { color: @mono-3; font-style: italic; } /* Comment.Preproc */
24
- .c1 { color: @mono-3; font-style: italic; } /* Comment.Single */
25
- .cs { color: @mono-3; font-style: italic; } /* Comment.Special */
26
- .ge { font-style: italic } /* Generic.Emph */
27
- .gs { font-weight: bold } /* Generic.Strong */
28
- .kc { color: @hue-3; } /* Keyword.Constant */
29
- .kd { color: @hue-3; } /* Keyword.Declaration */
30
- .kn { color: @hue-3; } /* Keyword.Namespace */
31
- .kp { color: @hue-3; } /* Keyword.Pseudo */
32
- .kr { color: @hue-3; } /* Keyword.Reserved */
33
- .kt { color: @hue-3; } /* Keyword.Type */
34
- .ld { color: @hue-4; } /* Literal.Date */
35
- .m { color: @hue-6; } /* Literal.Number */
36
- .s { color: @hue-4; } /* Literal.String */
37
- .na { color: @hue-6; } /* Name.Attribute */
38
- .nb { color: @hue-6-2; } /* Name.Builtin */
39
- .nc { color: @hue-6-2; } /* Name.Class */
40
- .no { color: @hue-6-2; } /* Name.Constant */
41
- .nd { color: @hue-6-2; } /* Name.Decorator */
42
- .ni { color: @hue-6-2; } /* Name.Entity */
43
- .ne { color: @hue-6-2; } /* Name.Exception */
44
- .nf { color: @mono-1; } /* Name.Function */
45
- .nl { color: @hue-6-2; } /* Name.Label */
46
- .nn { color: @mono-1; } /* Name.Namespace */
47
- .nx { color: @mono-1; } /* Name.Other */
48
- .py { color: @hue-6-2; } /* Name.Property */
49
- .nt { color: @hue-5; } /* Name.Tag */
50
- .nv { color: @hue-6-2; } /* Name.Variable */
51
- .ow { font-weight: bold; } /* Operator.Word */
52
- .w { color: #f8f8f2 } /* Text.Whitespace */
53
- .mf { color: @hue-6; } /* Literal.Number.Float */
54
- .mh { color: @hue-6; } /* Literal.Number.Hex */
55
- .mi { color: @hue-6; } /* Literal.Number.Integer */
56
- .mo { color: @hue-6; } /* Literal.Number.Oct */
57
- .sb { color: @hue-4; } /* Literal.String.Backtick */
58
- .sc { color: @hue-4; } /* Literal.String.Char */
59
- .sd { color: @hue-4; } /* Literal.String.Doc */
60
- .s2 { color: @hue-4; } /* Literal.String.Double */
61
- .se { color: @hue-4; } /* Literal.String.Escape */
62
- .sh { color: @hue-4; } /* Literal.String.Heredoc */
63
- .si { color: @hue-4; } /* Literal.String.Interpol */
64
- .sx { color: @hue-4; } /* Literal.String.Other */
65
- .sr { color: @hue-1; } /* Literal.String.Regex */
66
- .s1 { color: @hue-4; } /* Literal.String.Single */
67
- .ss { color: @hue-1; } /* Literal.String.Symbol */
68
- .bp { color: @hue-6-2; } /* Name.Builtin.Pseudo */
69
- .vc { color: @hue-6-2; } /* Name.Variable.Class */
70
- .vg { color: @hue-6-2; } /* Name.Variable.Global */
71
- .vi { color: @hue-5; } /* Name.Variable.Instance */
72
- .il { color: @hue-6; } /* Literal.Number.Integer.Long */
73
-
74
- .gh { } /* Generic Heading & Diff Header */
75
- .gu { color: #75715e; } /* Generic.Subheading & Diff Unified/Comment? */
76
- .gd { color: @syntax-color-removed; } /* Generic.Deleted & Diff Deleted */
77
- .gi { color: @syntax-color-added; } /* Generic.Inserted & Diff Inserted */
78
-
79
- ::selection { background-color: @syntax-selection-color; }
80
-
81
- .language-json {
82
- .w + .s2 { color: @hue-5; }
83
- .kc { color: @hue-1; }
84
- }
85
-
86
- .language-python {
87
- // python related modifications
88
- }
89
-
90
- .language-csharp {
91
- // csharp related modifications
92
- }
93
- }