just-the-docs 0.4.0.rc5 → 0.4.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +263 -12
- metadata +4 -4
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: f6dee6001e16aa8ad53cb0e3c9129ad2297d9a3af6a602958a17de1063c17f1c
|
|
4
|
+
data.tar.gz: b528c7f6c8940474e80607b9645077d8877d701f3d359bcbed3befd3814b17fe
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 9eec6b599ca82cfb750d99f703789059275730b4fd9b9775a02a5be4ba049165127ffc70832b316accdf85af8e76dfe4165257c9b26988ed0408a44720199a66
|
|
7
|
+
data.tar.gz: ee4145089f1d1798eecf42e74ea391be7295d1b0c27e91de0a1fb61fe89bd7bdfcddc2903b60b2b3553b866dbbb0e346319bbf6e34aaeb6bdd92d6295c7303a9
|
data/CHANGELOG.md
CHANGED
|
@@ -16,12 +16,263 @@ 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
|
|
19
|
+
This website includes docs for some new features that are not available in `v0.4.0`!
|
|
20
20
|
|
|
21
|
-
Changes to `main` that are *not* in the latest
|
|
21
|
+
Changes to `main` that are *not* in the latest release:
|
|
22
22
|
|
|
23
23
|
- n/a
|
|
24
24
|
|
|
25
|
+
## Release v0.4.0
|
|
26
|
+
|
|
27
|
+
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.
|
|
28
|
+
|
|
29
|
+
### Brief Overview - Highlighted Changes
|
|
30
|
+
|
|
31
|
+
`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:
|
|
32
|
+
|
|
33
|
+
- better support for dark theme: dark highlighting, search input color
|
|
34
|
+
- [callouts](https://just-the-docs.github.io/just-the-docs/docs/ui-components/callouts/), a new design component to highlight content
|
|
35
|
+
- [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
|
|
36
|
+
- [copy code button](https://just-the-docs.github.io/just-the-docs/docs/ui-components/code/#copy-button) for code snippets
|
|
37
|
+
- [external navigation links](https://just-the-docs.github.io/just-the-docs/docs/navigation-structure/#external-navigation-links)
|
|
38
|
+
- major improvements to nav generation efficiency and robustness
|
|
39
|
+
- minor improvements to built-in accessibility (SVG icons, nav titles, skip to main content)
|
|
40
|
+
- [modularized site components](https://just-the-docs.github.io/just-the-docs/docs/customization/#custom-layouts-and-includes) (advanced feature)
|
|
41
|
+
- [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
|
|
42
|
+
- 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!
|
|
43
|
+
- 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/)
|
|
44
|
+
|
|
45
|
+
*After usage instructions and the roadmap, we enumerate all changes from `v0.3.3`.*
|
|
46
|
+
|
|
47
|
+
### Using Release `v0.4.0`
|
|
48
|
+
|
|
49
|
+
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**.
|
|
50
|
+
|
|
51
|
+
To use this release explicitly as a remote theme:
|
|
52
|
+
|
|
53
|
+
```yml
|
|
54
|
+
remote_theme: just-the-docs/just-the-docs@v0.4.0
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
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`:
|
|
58
|
+
|
|
59
|
+
```ruby
|
|
60
|
+
gem "just-the-docs", "0.4.0"
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
If you would prefer to not upgrade, you can enforce that explicitly:
|
|
64
|
+
|
|
65
|
+
1. pin your gem version in your `Gemfile`, like so
|
|
66
|
+
```ruby
|
|
67
|
+
gem "just-the-docs", "0.3.3"
|
|
68
|
+
```
|
|
69
|
+
2. freeze the `remote_theme`, like so
|
|
70
|
+
```yml
|
|
71
|
+
remote_theme: just-the-docs/just-the-docs@v0.3.3
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
### Migration Guide and Strategies
|
|
75
|
+
|
|
76
|
+
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.
|
|
77
|
+
|
|
78
|
+
**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.
|
|
79
|
+
|
|
80
|
+
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.
|
|
81
|
+
|
|
82
|
+
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!
|
|
83
|
+
|
|
84
|
+
### Roadmap (What's Next?)
|
|
85
|
+
|
|
86
|
+
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!
|
|
87
|
+
|
|
88
|
+
Broadly, many features are still on the radar. We anticipate the rest of `v0.4.x` to be bugfixes surrounding this new release.
|
|
89
|
+
|
|
90
|
+
For version `v0.5`, our roadmap includes:
|
|
91
|
+
|
|
92
|
+
- a theme toggle (light/dark mode), with automatic theme switching based on browser preferences
|
|
93
|
+
- better GDPR compliance for analytics
|
|
94
|
+
- multi-level/recursive navigation (unlimited hierarchy of child pages)
|
|
95
|
+
|
|
96
|
+
In future versions, we also plan on:
|
|
97
|
+
|
|
98
|
+
- adding better dark theme defaults
|
|
99
|
+
- adding better internationalization support
|
|
100
|
+
- exploring offline PDF generation
|
|
101
|
+
- improving accessibility within the theme
|
|
102
|
+
- improving search functionality
|
|
103
|
+
- refactoring and improving the robustness of our codebase
|
|
104
|
+
|
|
105
|
+
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.
|
|
106
|
+
|
|
107
|
+
### New Features
|
|
108
|
+
|
|
109
|
+
- Added: Combination by [@pdmosses] in [#578]
|
|
110
|
+
- Added: dark highlighting in [#463]
|
|
111
|
+
- Added: pages and collections in [#448]
|
|
112
|
+
- Added: callouts in [#466]
|
|
113
|
+
- Fixed: breadcrumb behaviour … by [@AdityaTiwari2102] in [#477]
|
|
114
|
+
- Fixed: prevent rake command corrupting search data in [#495] (also listed below)
|
|
115
|
+
- Fixed: nested lists in [#496]
|
|
116
|
+
- Fixed: set color for search input in [#498] (also listed below)
|
|
117
|
+
- Fixed: sites with no child pages (no PR)
|
|
118
|
+
- Fixed: TOC/breadcrumbs for multiple collections in [#494]
|
|
119
|
+
- Added: collection configuration option `nav_fold` (no PR)
|
|
120
|
+
- Fixed: indentation and color for folded collection navigation (no PR)
|
|
121
|
+
- Fixed: scroll navigation to show the link to the current page in [#639]
|
|
122
|
+
- Fixed: Replace all uses of `absolute_url` by `relative_url`, by [@svrooij] in [#544]
|
|
123
|
+
- Added: custom favicon `_includes` by [@burner1024] in [#364]
|
|
124
|
+
- Added: set color for search input by [@pdmosses] in [#498]
|
|
125
|
+
- Added: search placeholder configuration by [@mattxwang] in [#613]
|
|
126
|
+
- Added: 'child_nav_order' front matter to be able to sort navigation pages in reverse by [@jmertic] in [#726]
|
|
127
|
+
- Added: `nav_footer_custom` include by [@nathanjessen] in [#474]
|
|
128
|
+
- Added: style fixes for jekyll-asciidoc by [@alyssais] in [#829]
|
|
129
|
+
- Added: mermaid.js support by [@nascosto] in [#857]
|
|
130
|
+
- Added: support for external navigation links by [@SPGoding] in [#876]
|
|
131
|
+
- Added: refactor `mermaid` config to use `mermaid_config.js` include, only require `mermaid.version` in `_config.yml` by [@mattxwang] in [#909]
|
|
132
|
+
- Added: accessible titles to nested page nav toggle by [@JPrevost] in [#950]
|
|
133
|
+
- Added: better title styling for AsciiDoc examples by [@alyssais] in [#944]
|
|
134
|
+
- Added: docs for custom search placeholder by [@mattxwang] in [#939]
|
|
135
|
+
- Added: provide ability to skip to main content by [@JPrevost] in [#949]
|
|
136
|
+
- Added: styling for `<blockquote>` by [@mattxwang] in [#965]
|
|
137
|
+
- Added: custom include for TOC heading by [@pdmosses] in [#980]
|
|
138
|
+
- Added: experimental nav optimization for simple cases by [@pdmosses] in [#992]
|
|
139
|
+
- Added: support multiple Google Analytics tracking IDs, document UA -> GA4 switch by [@MichelleBlanchette] in [#1029]
|
|
140
|
+
- Added: copy code button to code snippets by [@simonebortolin] in [#945]
|
|
141
|
+
- Added: restore simple configuration of `favicon.ico` via `site.static_files` by [@pdmosses] in [#1095]
|
|
142
|
+
- Added: modularize site components by [@mattxwang] in [#1058]
|
|
143
|
+
- Added: includes for custom `lunr` Liquid and JS code by [@diablodale] in [#1068]
|
|
144
|
+
- Added: new `_sass/custom/setup.scss` for variable definition by [@mattxwang] in [#1135]
|
|
145
|
+
- Added: configuration key to load a local version of mermaid by [@fabrik42] in [#1153]
|
|
146
|
+
|
|
147
|
+
### Bugfixes
|
|
148
|
+
|
|
149
|
+
- Fixed: prepend `site.collections_dir` if exists by [@alexsegura] in [#519]
|
|
150
|
+
- Fixed: nested task lists (#517) by [@pdmosses] in [#855]
|
|
151
|
+
- Fixed: suppress Liquid processing in CSS comments by [@pdmosses] in [#686]
|
|
152
|
+
- Fixed: prevent rake command from corrupting search data by [@pdmosses] in [#495]
|
|
153
|
+
- Fixed: anchor heading links should be visible on focus by [@jacobhq] in [#846]
|
|
154
|
+
- Fixed: add `overflow-x: auto` to `figure.highlight` by [@iridazzle] in [#727]
|
|
155
|
+
- Fixed: add `overflow-wrap: word-break` to `body` by [@iridazzle] in [#889]
|
|
156
|
+
- Fixed: vertical alignment for consecutive labels by [@Eisverygoodletter] in [#893]
|
|
157
|
+
- Fixed: allow links to wrap by [@pdmosses] in [#905]
|
|
158
|
+
- Fixed: nav scroll feature and absolute/relative URLs by [@pdmosses] in [#898]
|
|
159
|
+
- Fixed: exclude `vendor/` in Jekyll config by [@manuelhenke] in [#941]
|
|
160
|
+
- Fixed: improve build time of navigation panel by [@pdmosses] in [#956]
|
|
161
|
+
- Fixed: spacing issue when search is disabled by [@henryiii] in [#960]
|
|
162
|
+
- Fixed: active grandchild link class by [@pdmosses] in [#962]
|
|
163
|
+
- Fixed: HTML validation issues (W3C validator) by [@mattxwang] in [#964]
|
|
164
|
+
- Fixed: link styling now uses `text-decoration` values by [@mattxwang] in [#967]
|
|
165
|
+
- Fixed: cleaning up Jekyll excludes by [@pdmosses] in [#985]
|
|
166
|
+
- Fixed: docs, narrow styling for code highlighting with line numbers by [@pdmosses] in [#974]
|
|
167
|
+
- Fixed: default syntax highlighting in custom color schemes [@pdmosses] in [#986]
|
|
168
|
+
- Fixed: incorrect disambiguation in generated TOCs by [@pdmosses] in [#999]
|
|
169
|
+
- Fixed: duplicated external links in collections by [@pdmosses] in [#1001]
|
|
170
|
+
- Fixed: import order of `custom.scss`; puts at end by [@deseo] in [#1010]
|
|
171
|
+
- Fixed: top-level active link styling by [@pdmosses] in [#1015]
|
|
172
|
+
- Fixed: external links for sites with no pages by [@pdmosses] in [#1021]
|
|
173
|
+
- Fixed: duplicate `title` if `jekyll-seo-tag` not in users's plugins by [@Tom-Brouwer] in [#1040]
|
|
174
|
+
- Fixed: removes (duplicate) `favicon.html`, shifts content to `head_custom.html` by [@mattxwang] in [#1027]
|
|
175
|
+
- Fixed: add `reversed`, deprecate `desc` for nav `child_nav_order` by [@jmertic] in [#1061]
|
|
176
|
+
- Fixed: `child.child_nav_order` to `node.child_nav_order` by [@mattxwang] in [#1065]
|
|
177
|
+
- Fixed: remove all uses of `/` as SASS division by [@mattxwang] in [#1074]
|
|
178
|
+
- note: this was originally merged as [#1074] with a bug; it was reverted in [#1076], and then reimplemented in [#1077]
|
|
179
|
+
- Fixed: skip nav collection generation when site has no pages by [@pdmosses] in [#1092]
|
|
180
|
+
- Fixed: standardize SCSS with `declaration-block-no-redundant-longhand-properties` by [@simonebortolin] in [#1102]
|
|
181
|
+
- Fixed: incorrect `padding` property value pair in `labels.scss` by [@SConaway] in [#1104]
|
|
182
|
+
- Fixed: various bugs with copy code button by [@simonebortolin] in [#1096]
|
|
183
|
+
- Fixed: replace inline styling for `<svg>` icons by [@captn3m0] in [#1110]
|
|
184
|
+
- Fixed: incorrect `padding` property value pair in `search.scss` by [@kevinlin1] in [#1123]
|
|
185
|
+
- Fixed: minor spacing and comment nits by [@EricFromCanada] in [#1128]
|
|
186
|
+
- Fixed: exclude images from being bundled with gem by [@m-r-mccormick] in [#1142]
|
|
187
|
+
- Fixed: dark theme code block background, line number colors by [@m-r-mccormick] in [#1124]
|
|
188
|
+
- Fixed: copy code button interaction with kramdown line numbers by [@mattxwang] in [#1143]
|
|
189
|
+
|
|
190
|
+
### Maintenance
|
|
191
|
+
|
|
192
|
+
- Added: VScode devcontainer by [@max06] in [#783]
|
|
193
|
+
- Added: `webrick` to `Gemfile` by [@mattxwang] in [#799]
|
|
194
|
+
- Added: 'This site is powered by Netlify.' to the footer by [@mattxwang] in [#797]
|
|
195
|
+
- Updated: new repo path by [@pmarsceill] in [#775]
|
|
196
|
+
- Updated: rename `master` -> `main` by [@pmarsceill] in [#776]
|
|
197
|
+
- Updated: README by [@pmarsceill] in [#777]
|
|
198
|
+
- Updated: Code of Conduct to Contributor Covenant v2.1 by [@mattxwang] in [#790]
|
|
199
|
+
- Updated: CI files, Ruby & Node Versions by [@mattxwang] in [#820]
|
|
200
|
+
- Updated: Stylelint to v14, extend SCSS plugins, remove primer-* configs, resolve issues by [@mattxwang] in [#821]
|
|
201
|
+
- Deleted: unused script directory by [@mattxwang] in [#937]
|
|
202
|
+
- Vendor: update `jekyll-anchor-headings`, `lunr.js` by [@mattxwang] in [#1071]
|
|
203
|
+
|
|
204
|
+
### Documentation
|
|
205
|
+
|
|
206
|
+
- Added: docs on how to break an `ol` by [@pdmosses] in [#856]
|
|
207
|
+
- Added: docs for custom includes by [@nathanjessen] in [#806]
|
|
208
|
+
- Added: document caveat about variable dependencies by [@waldyrious] in [#555]
|
|
209
|
+
- Added: docs on how to use `custom_head` to add a custom favicon by [@UnclassedPenguin] in [#814]
|
|
210
|
+
- Added: docs load mermaid.js by default by [@mattxwang] in [#935]
|
|
211
|
+
- Added: warning about mandatory `_`-prefix for collections by [@max06] in [#1091]
|
|
212
|
+
- Added: migration guide by [@pdmosses] in [#1059]
|
|
213
|
+
- Added: label new features introduced in `v0.4` by [@mattxwang] in [#1138]
|
|
214
|
+
- Fixed: `ol` on `index.md` by [@pmarsceill] in [#778]
|
|
215
|
+
- Fixed: image link in Markdown kitchen sink by [@JeffGuKang] in [#221]
|
|
216
|
+
- Fixed: images in Markdown kitchen sink by [@dougaitken] in [#782]
|
|
217
|
+
- Fixed: clearer label of link to Jekyll quickstart by [@waldyrious] in [#549]
|
|
218
|
+
- Fixed: remove extra spaces in component docs by [@MichelleBlanchette] in [#554]
|
|
219
|
+
- Fixed: double "your" typo in `index.md` by [@sehilyi] in [#499]
|
|
220
|
+
- Fixed: "you" -> "your" typo in `index.md` by [@nathanjessen] in [#473]
|
|
221
|
+
- Fixed: spacing in toc example by [@henryiii] in [#835]
|
|
222
|
+
- Fixed: typo in `README` on `_config.yml` by [@ivanskodje] in [#891]
|
|
223
|
+
- Fixed: missing code fence in navigation structure docs by [@mattxwang] in [#906]
|
|
224
|
+
- Fixed: table of contents on search docs by [@robinpokorny] in [#940]
|
|
225
|
+
- Fixed: broken docs link (custom footer) by [@olgarithms] in [#951]
|
|
226
|
+
- Fixed: clarify version docs by [@pdmosses] in [#955]
|
|
227
|
+
- Fixed: typo in changelog links [@koppor] in [#1000]
|
|
228
|
+
- Fixed: two bugs in "Customization" (custom favicon, new annotation) by [@mattxwang] in [#1090]
|
|
229
|
+
- Fixed: "View Typography Utilities" link by [@agabrys] in [#1130]
|
|
230
|
+
- Fixed: broken relative page links by [@mattxwang] in [#1106]
|
|
231
|
+
- Fixed: clarify steps to add custom `lunr` index code by [@diablodale] in [#1139]
|
|
232
|
+
- Updated: homepage (focus: new features, conciseness, deduplication) by [@pdmosses] in [#1018]
|
|
233
|
+
- Updated: README (focus: new features, conciseness, deduplication) by [@pdmosses] in [#1019]
|
|
234
|
+
- Updated: `README` demo video by [@codewithfan] in [#1097]
|
|
235
|
+
|
|
236
|
+
### New Contributors
|
|
237
|
+
|
|
238
|
+
- [@AdityaTiwari2102] made their first contribution in [#477]
|
|
239
|
+
- [@svrooij] made their first contribution in [#544]
|
|
240
|
+
- [@alexsegura] made their first contribution in [#519]
|
|
241
|
+
- [@burner1024] made their first contribution in [#364]
|
|
242
|
+
- [@JeffGuKang] made their first contribution in [#221]
|
|
243
|
+
- [@dougaitken] made their first contribution in [#782]
|
|
244
|
+
- [@max06] made their first contribution in [#783]
|
|
245
|
+
- [@sehilyi] made their first contribution in [#499]
|
|
246
|
+
- [@nathanjessen] made their first contribution in [#473]
|
|
247
|
+
- [@waldyrious] made their first contribution in [#549]
|
|
248
|
+
- [@MichelleBlanchette] made their first contribution in [#554]
|
|
249
|
+
- [@henryiii] made their first contribution in [#835]
|
|
250
|
+
- [@jmertic] made their first contribution in [#726]
|
|
251
|
+
- [@jacobhq] made their first contribution in [#846]
|
|
252
|
+
- [@UnclassedPenguin] made their first contribution in [#814]
|
|
253
|
+
- [@alyssais] made their first contribution in [#829]
|
|
254
|
+
- [@nascosto] made their first contribution in [#857]
|
|
255
|
+
- [@SPGoding] made their first contribution in [#876]
|
|
256
|
+
- [@iridazzle] made their first contribution in [#727]
|
|
257
|
+
- [@ivanskodje] made their first contribution in [#891]
|
|
258
|
+
- [@Eisverygoodletter] made their first contribution in [#893]
|
|
259
|
+
- [@robinpokorny] made their first contribution in [#940]
|
|
260
|
+
- [@olgarithms] made their first contribution in [#951]
|
|
261
|
+
- [@manuelhenke] made their first contribution in [#941]
|
|
262
|
+
- [@JPrevost] made their first contribution in [#950]
|
|
263
|
+
- [@koppor] made their first contribution in [#1000]
|
|
264
|
+
- [@deseo] made their first contribution in [#1010]
|
|
265
|
+
- [@Tom-Brouwer] made their first contribution in [#1040]
|
|
266
|
+
- [@simonebortolin] made their first contribution in [#945]
|
|
267
|
+
- [@SConaway] made their first contribution in [#1104]
|
|
268
|
+
- [@captn3m0] made their first contribution in [#1110]
|
|
269
|
+
- [@kevinlin1] made their first contribution in [#1123]
|
|
270
|
+
- [@codewithfan] made their first contribution in [#1097]
|
|
271
|
+
- [@agabrys] made their first contribution in [#1130]
|
|
272
|
+
- [@diablodale] made their first contribution in [#1068]
|
|
273
|
+
- [@m-r-mccormick] made their first contribution in [#1142]
|
|
274
|
+
- [@fabrik42] made their first contribution in [#1153]
|
|
275
|
+
|
|
25
276
|
## Pre-release v0.4.0.rc5
|
|
26
277
|
|
|
27
278
|
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.
|
|
@@ -40,14 +291,14 @@ remote_theme: just-the-docs/just-the-docs@v0.4.0.rc5
|
|
|
40
291
|
|
|
41
292
|
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
293
|
|
|
43
|
-
```
|
|
294
|
+
```ruby
|
|
44
295
|
gem "just-the-docs", "0.4.0.rc5"
|
|
45
296
|
```
|
|
46
297
|
|
|
47
298
|
By default, **users will not be upgraded to `0.4.0.rc5`**. To enforce that explicitly, either:
|
|
48
299
|
|
|
49
300
|
1. pin your gem version in your `Gemfile`, like so
|
|
50
|
-
```
|
|
301
|
+
```ruby
|
|
51
302
|
gem "just-the-docs", "0.3.3"
|
|
52
303
|
```
|
|
53
304
|
2. freeze the `remote_theme`, like so
|
|
@@ -141,14 +392,14 @@ remote_theme: just-the-docs/just-the-docs@v0.4.0.rc4
|
|
|
141
392
|
|
|
142
393
|
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
394
|
|
|
144
|
-
```
|
|
395
|
+
```ruby
|
|
145
396
|
gem "just-the-docs", "0.4.0.rc4"
|
|
146
397
|
```
|
|
147
398
|
|
|
148
399
|
By default, **users will not be upgraded to `0.4.0.rc4`**. To enforce that explicitly, either:
|
|
149
400
|
|
|
150
401
|
1. pin your gem version in your `Gemfile`, like so
|
|
151
|
-
```
|
|
402
|
+
```ruby
|
|
152
403
|
gem "just-the-docs", "0.3.3"
|
|
153
404
|
```
|
|
154
405
|
2. freeze the `remote_theme`, like so
|
|
@@ -262,14 +513,14 @@ remote_theme: just-the-docs/just-the-docs@v0.4.0.rc3
|
|
|
262
513
|
|
|
263
514
|
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
515
|
|
|
265
|
-
```
|
|
516
|
+
```ruby
|
|
266
517
|
gem "just-the-docs", "0.4.0.rc3"
|
|
267
518
|
```
|
|
268
519
|
|
|
269
520
|
By default, **users will not be upgraded to `0.4.0.rc3`**. To enforce that explicitly, either:
|
|
270
521
|
|
|
271
522
|
1. pin your gem version in your `Gemfile`, like so
|
|
272
|
-
```
|
|
523
|
+
```ruby
|
|
273
524
|
gem "just-the-docs", "0.3.3"
|
|
274
525
|
```
|
|
275
526
|
2. freeze the `remote_theme`, like so
|
|
@@ -338,14 +589,14 @@ remote_theme: just-the-docs/just-the-docs@v0.4.0.rc2
|
|
|
338
589
|
|
|
339
590
|
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
591
|
|
|
341
|
-
```
|
|
592
|
+
```ruby
|
|
342
593
|
gem "just-the-docs", "0.4.0.rc2"
|
|
343
594
|
```
|
|
344
595
|
|
|
345
596
|
By default, **users will not be upgraded to `0.4.0.rc2`**. To enforce that explicitly, either:
|
|
346
597
|
|
|
347
598
|
1. pin your gem version in your `Gemfile`, like so
|
|
348
|
-
```
|
|
599
|
+
```ruby
|
|
349
600
|
gem "just-the-docs", "0.3.3"
|
|
350
601
|
```
|
|
351
602
|
2. freeze the `remote_theme`, like so
|
|
@@ -426,7 +677,7 @@ remote_theme: just-the-docs/just-the-docs@v0.4.0.rc1
|
|
|
426
677
|
|
|
427
678
|
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
679
|
|
|
429
|
-
```
|
|
680
|
+
```ruby
|
|
430
681
|
gem "just-the-docs", "0.4.0.rc1"
|
|
431
682
|
```
|
|
432
683
|
|
|
@@ -437,7 +688,7 @@ If you're not ready to make the switch, that's alright! If your version of just-
|
|
|
437
688
|
If you have not pinned your theme version, you should either:
|
|
438
689
|
|
|
439
690
|
1. pin your gem version in your `Gemfile`, like so
|
|
440
|
-
```
|
|
691
|
+
```ruby
|
|
441
692
|
gem "just-the-docs", "0.3.3"
|
|
442
693
|
```
|
|
443
694
|
2. freeze the `remote_theme`, like so
|
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
|
|
4
|
+
version: 0.4.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Patrick Marsceill
|
|
@@ -9,7 +9,7 @@ authors:
|
|
|
9
9
|
autorequire:
|
|
10
10
|
bindir: bin
|
|
11
11
|
cert_chain: []
|
|
12
|
-
date: 2023-02-
|
|
12
|
+
date: 2023-02-06 00:00:00.000000000 Z
|
|
13
13
|
dependencies:
|
|
14
14
|
- !ruby/object:Gem::Dependency
|
|
15
15
|
name: bundler
|
|
@@ -193,9 +193,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
|
193
193
|
version: '0'
|
|
194
194
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
|
195
195
|
requirements:
|
|
196
|
-
- - "
|
|
196
|
+
- - ">="
|
|
197
197
|
- !ruby/object:Gem::Version
|
|
198
|
-
version:
|
|
198
|
+
version: '0'
|
|
199
199
|
requirements: []
|
|
200
200
|
rubygems_version: 3.3.7
|
|
201
201
|
signing_key:
|