just-the-docs 0.4.0.rc2 → 0.4.0.rc3
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +330 -112
- data/README.md +0 -1
- data/_includes/css/just-the-docs.scss.liquid +1 -0
- data/_includes/head.html +2 -2
- data/_includes/nav.html +154 -108
- data/_includes/toc_heading_custom.html +1 -0
- data/_layouts/default.html +8 -5
- data/_sass/base.scss +15 -10
- data/_sass/code.scss +1 -0
- metadata +3 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 4ea3b0ea21a727723756d2d947483604eba31765e1cf40aecec9370cc87a3f90
|
|
4
|
+
data.tar.gz: 1aa63df6cd1a17be4f37d2c3f7a6058f57c7c462ac857dc087c7aa41db406a1f
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: defb8f100d04b9d497e20fd6c8fd5e29ef092a95362f85d453eafdffc17177d3e7b602c785da6e11106bbe5a4abee8ef242d6ff63251cdd7502c02a106c5c178
|
|
7
|
+
data.tar.gz: 0ad188da9252379f41175089cbd53da0b10075c5e5057cbc2ebc26dfa8a7072e4d7f467b963eca03696b4f86ff40f3cb180149c63101fa4e0515611d50605d13
|
data/CHANGELOG.md
CHANGED
|
@@ -1,27 +1,116 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: CHANGELOG
|
|
3
|
+
layout: default
|
|
4
|
+
---
|
|
5
|
+
|
|
1
6
|
# CHANGELOG
|
|
2
7
|
|
|
3
8
|
All notable changes to this project are documented in this file.
|
|
4
9
|
|
|
5
|
-
|
|
10
|
+
{: .highlight }
|
|
11
|
+
The project underwent a major maintenance shift in March 2022.
|
|
6
12
|
|
|
7
13
|
## HEAD
|
|
8
14
|
|
|
9
|
-
|
|
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.4.0.rc2` and `v0.3.3`!
|
|
20
|
+
|
|
21
|
+
Changes to `main` that are *not* in the latest pre-release:
|
|
22
|
+
|
|
23
|
+
- N/A
|
|
24
|
+
|
|
25
|
+
## Pre-release v0.4.0.rc3
|
|
26
|
+
|
|
27
|
+
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`.
|
|
28
|
+
|
|
29
|
+
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.
|
|
30
|
+
|
|
31
|
+
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!
|
|
32
|
+
|
|
33
|
+
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!
|
|
34
|
+
|
|
35
|
+
### Trying out pre-release `v0.4.0.rc3`
|
|
36
|
+
|
|
37
|
+
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`.
|
|
38
|
+
|
|
39
|
+
To use this RC explicitly as a remote theme:
|
|
40
|
+
|
|
41
|
+
```yml
|
|
42
|
+
remote_theme: just-the-docs/just-the-docs@v0.4.0.rc3
|
|
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.0.rc3"
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
By default, **users will not be upgraded to `0.4.0.rc3`**. To enforce that explicitly, either:
|
|
52
|
+
|
|
53
|
+
1. pin your gem version in your `Gemfile`, like so
|
|
54
|
+
```Ruby
|
|
55
|
+
gem "just-the-docs", "0.3.3"
|
|
56
|
+
```
|
|
57
|
+
2. freeze the `remote_theme`, like so
|
|
58
|
+
```yml
|
|
59
|
+
remote_theme: just-the-docs/just-the-docs@v0.3.3
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
### Features
|
|
63
|
+
|
|
64
|
+
Broadly, this prerelease is feature-light!
|
|
65
|
+
|
|
66
|
+
- Added: styling for `<blockquote>` by [@mattxwang] in [#965]
|
|
67
|
+
- Added: custom include for TOC heading by [@pdmosses] in [#980]
|
|
68
|
+
|
|
69
|
+
### Bugfixes and Experimental Features
|
|
70
|
+
|
|
71
|
+
*Note*: experimental nav optimization may be unstable. Please give us feedback!
|
|
72
|
+
|
|
73
|
+
- Added: experimental nav optimization for simple cases by [@pdmosses] in [#992]
|
|
74
|
+
- Fixed: spacing issue when search is disabled by [@henryiii] in [#960]
|
|
75
|
+
- Fixed: active grandchild link class by [@pdmosses] in [#962]
|
|
76
|
+
- Fixed: HTML validation issues (W3C validator) by [@mattxwang] in [#964]
|
|
77
|
+
- Fixed: link styling now uses `text-decoration` values by [@mattxwang] in [#967]
|
|
78
|
+
- Fixed: cleaning up Jekyll excludes by [@pdmosses] in [#985]
|
|
79
|
+
- Fixed: docs, narrow styling for code highlighting with line numbers by [@pdmosses] in [#974]
|
|
80
|
+
- Fixed: default syntax highlighting in custom color schemes [@pdmosses] in [#986]
|
|
81
|
+
|
|
82
|
+
[#965]: https://github.com/just-the-docs/just-the-docs/pull/965
|
|
83
|
+
[#960]: https://github.com/just-the-docs/just-the-docs/pull/960
|
|
84
|
+
[#962]: https://github.com/just-the-docs/just-the-docs/pull/962
|
|
85
|
+
[#964]: https://github.com/just-the-docs/just-the-docs/pull/964
|
|
86
|
+
[#967]: https://github.com/just-the-docs/just-the-docs/pull/967
|
|
87
|
+
[#974]: https://github.com/just-the-docs/just-the-docs/pull/974
|
|
88
|
+
[#980]: https://github.com/just-the-docs/just-the-docs/pull/980
|
|
89
|
+
[#985]: https://github.com/just-the-docs/just-the-docs/pull/985
|
|
90
|
+
[#986]: https://github.com/just-the-docs/just-the-docs/pull/986
|
|
91
|
+
[#992]: https://github.com/just-the-docs/just-the-docs/pull/992
|
|
92
|
+
|
|
93
|
+
[@henryiii]: https://github.com/henryiii
|
|
94
|
+
|
|
95
|
+
**Full Changelog**: https://github.com/just-the-docs/just-the-docs/compare/v0.4.0.rc2...v0.4.0.rc3
|
|
10
96
|
|
|
11
97
|
## Pre-release v0.4.0.rc2
|
|
12
98
|
|
|
99
|
+
{: .warning }
|
|
100
|
+
This website includes docs for some new features that are not available in `v0.4.0.rc1` and `v0.3.3`!
|
|
101
|
+
|
|
13
102
|
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:
|
|
14
103
|
|
|
15
|
-
- significant improvement on build time of navigation panel by @pdmosses
|
|
104
|
+
- significant improvement on build time of navigation panel by [@pdmosses]
|
|
16
105
|
- this is big: for a community member with over 300 pages, we shortened the build time from 3 minutes to 30 seconds!
|
|
17
|
-
- improved accessibility features led by @JPrevost
|
|
106
|
+
- improved accessibility features led by [@JPrevost]
|
|
18
107
|
- more docs!
|
|
19
108
|
|
|
20
|
-
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
|
|
109
|
+
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!
|
|
21
110
|
|
|
22
111
|
### Trying out pre-release `v0.4.0.rc2`
|
|
23
112
|
|
|
24
|
-
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
|
|
113
|
+
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`.
|
|
25
114
|
|
|
26
115
|
To use this RC explicitly as a remote theme:
|
|
27
116
|
|
|
@@ -48,27 +137,47 @@ remote_theme: just-the-docs/just-the-docs@v0.3.3
|
|
|
48
137
|
|
|
49
138
|
### Features
|
|
50
139
|
|
|
51
|
-
- Added: accessible titles to nested page nav toggle by @JPrevost in
|
|
52
|
-
- Added: better title styling for AsciiDoc examples by @alyssais in
|
|
53
|
-
- Added: docs for custom search placeholder by @mattxwang in
|
|
54
|
-
- Added: provide ability to skip to main content by @JPrevost in
|
|
55
|
-
- Fixed: exclude `vendor/` in Jekyll config by @manuelhenke in
|
|
56
|
-
- Fixed: improve build time of navigation panel by @pdmosses in
|
|
140
|
+
- Added: accessible titles to nested page nav toggle by [@JPrevost] in [#950]
|
|
141
|
+
- Added: better title styling for AsciiDoc examples by [@alyssais] in [#944]
|
|
142
|
+
- Added: docs for custom search placeholder by [@mattxwang] in [#939]
|
|
143
|
+
- Added: provide ability to skip to main content by [@JPrevost] in [#949]
|
|
144
|
+
- Fixed: exclude `vendor/` in Jekyll config by [@manuelhenke] in [#941]
|
|
145
|
+
- Fixed: improve build time of navigation panel by [@pdmosses] in [#956]
|
|
146
|
+
|
|
147
|
+
[#950]: https://github.com/just-the-docs/just-the-docs/pull/950
|
|
148
|
+
[#944]: https://github.com/just-the-docs/just-the-docs/pull/944
|
|
149
|
+
[#939]: https://github.com/just-the-docs/just-the-docs/pull/939
|
|
150
|
+
[#949]: https://github.com/just-the-docs/just-the-docs/pull/949
|
|
151
|
+
[#941]: https://github.com/just-the-docs/just-the-docs/pull/941
|
|
152
|
+
[#956]: https://github.com/just-the-docs/just-the-docs/pull/956
|
|
153
|
+
|
|
154
|
+
[@alyssais]: https://github.com/alyssais
|
|
57
155
|
|
|
58
156
|
### Documentation and Maintenance
|
|
59
157
|
|
|
60
|
-
- Added: docs load mermaid.js by default by @mattxwang in
|
|
61
|
-
- Fixed: table of contents on search docs by @robinpokorny in
|
|
62
|
-
- Fixed: broken docs link (custom footer) by @olgarithms in
|
|
63
|
-
- Fixed: clarify version docs by @pdmosses in
|
|
64
|
-
- Deleted: unused script directory by @mattxwang in
|
|
158
|
+
- Added: docs load mermaid.js by default by [@mattxwang] in [#935]
|
|
159
|
+
- Fixed: table of contents on search docs by [@robinpokorny] in [#940]
|
|
160
|
+
- Fixed: broken docs link (custom footer) by [@olgarithms] in [#951]
|
|
161
|
+
- Fixed: clarify version docs by [@pdmosses] in [#955]
|
|
162
|
+
- Deleted: unused script directory by [@mattxwang] in [#937]
|
|
163
|
+
|
|
164
|
+
[#935]: https://github.com/just-the-docs/just-the-docs/pull/935
|
|
165
|
+
[#940]: https://github.com/just-the-docs/just-the-docs/pull/940
|
|
166
|
+
[#951]: https://github.com/just-the-docs/just-the-docs/pull/951
|
|
167
|
+
[#955]: https://github.com/just-the-docs/just-the-docs/pull/955
|
|
168
|
+
[#937]: https://github.com/just-the-docs/just-the-docs/pull/937
|
|
65
169
|
|
|
66
170
|
### New Contributors
|
|
67
171
|
|
|
68
|
-
* @robinpokorny made their first contribution in
|
|
69
|
-
* @olgarithms made their first contribution in
|
|
70
|
-
* @manuelhenke made their first contribution in
|
|
71
|
-
* @JPrevost made their first contribution in
|
|
172
|
+
* [@robinpokorny] made their first contribution in [#940]
|
|
173
|
+
* [@olgarithms] made their first contribution in [#951]
|
|
174
|
+
* [@manuelhenke] made their first contribution in [#941]
|
|
175
|
+
* [@JPrevost] made their first contribution in [#950]
|
|
176
|
+
|
|
177
|
+
[@robinpokorny]: https://github.com/robinpokorny
|
|
178
|
+
[@olgarithms]: https://github.com/olgarithms
|
|
179
|
+
[@manuelhenke]: https://github.com/manuelhenke
|
|
180
|
+
[@JPrevost]: https://github.com/JPrevost
|
|
72
181
|
|
|
73
182
|
## Pre-release v0.4.0.rc1
|
|
74
183
|
|
|
@@ -89,7 +198,7 @@ We want your feedback! Are these changes helpful? Are our docs easy to understan
|
|
|
89
198
|
|
|
90
199
|
### Trying out pre-release `v0.4.0.rc1`
|
|
91
200
|
|
|
92
|
-
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
|
|
201
|
+
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`.
|
|
93
202
|
|
|
94
203
|
To use this RC explicitly as a remote theme:
|
|
95
204
|
|
|
@@ -118,13 +227,20 @@ gem "just-the-docs", "0.3.3"
|
|
|
118
227
|
remote_theme: just-the-docs/just-the-docs@v0.3.3
|
|
119
228
|
```
|
|
120
229
|
|
|
121
|
-
|
|
230
|
+
{: .warning }
|
|
231
|
+
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`.
|
|
122
232
|
|
|
123
233
|
### Maintenance
|
|
124
234
|
|
|
125
|
-
Internally, our maintainer team has expanded: [Patrick Marsceill]
|
|
235
|
+
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!
|
|
236
|
+
|
|
237
|
+
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!
|
|
126
238
|
|
|
127
|
-
|
|
239
|
+
[@mattxwang]: https://github.com/mattxwang
|
|
240
|
+
[@pdmosses]: https://github.com/pdmosses
|
|
241
|
+
[@skullface]: https://github.com/skullface
|
|
242
|
+
[@dougaitken]: https://github.com/dougaitken
|
|
243
|
+
[@max06]: https://github.com/max06
|
|
128
244
|
|
|
129
245
|
### Roadmap
|
|
130
246
|
|
|
@@ -133,114 +249,216 @@ In the short-term, we're committed to tidying up everything for a `v0.4.0` relea
|
|
|
133
249
|
We're also scoping out medium and long-term projects, and want to keep you in the loop. These include:
|
|
134
250
|
|
|
135
251
|
- upgrading to Jekyll 4, and stopping support for Jekyll 3
|
|
136
|
-
- versioned docs - issue [#728]
|
|
137
|
-
- improved accessibility - issues [#566]
|
|
138
|
-
- internationalization (i18n) - issue [#59]
|
|
139
|
-
- recursive/multi-level navigation - PR [#462]
|
|
140
|
-
- toggleable dark mode - issue [#234]
|
|
252
|
+
- versioned docs - issue [#728]
|
|
253
|
+
- improved accessibility - issues [#566], [#870]
|
|
254
|
+
- internationalization (i18n) - issue [#59]
|
|
255
|
+
- recursive/multi-level navigation - PR [#462]
|
|
256
|
+
- toggleable dark mode - issue [#234]
|
|
141
257
|
|
|
142
258
|
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!
|
|
143
259
|
|
|
260
|
+
[#728]: https://github.com/just-the-docs/just-the-docs/issues/728
|
|
261
|
+
[#566]: https://github.com/just-the-docs/just-the-docs/issues/566
|
|
262
|
+
[#870]: https://github.com/just-the-docs/just-the-docs/issues/870
|
|
263
|
+
[#59]: https://github.com/just-the-docs/just-the-docs/issues/59
|
|
264
|
+
[#462]: https://github.com/just-the-docs/just-the-docs/pull/462
|
|
265
|
+
[#234]: https://github.com/just-the-docs/just-the-docs/issues/234
|
|
266
|
+
|
|
144
267
|
### Features
|
|
145
268
|
|
|
146
|
-
* Added: Combination by @pdmosses in
|
|
147
|
-
- Added: dark highlighting in
|
|
148
|
-
- Added: pages and collections in
|
|
149
|
-
- Added: callouts in
|
|
150
|
-
- Fixed: breadcrumb behaviour … by @AdityaTiwari2102 in
|
|
151
|
-
- Fixed: prevent rake command corrupting search data in
|
|
152
|
-
- Fixed: nested lists in
|
|
153
|
-
- Fixed: set color for search input in
|
|
269
|
+
* Added: Combination by [@pdmosses] in [#578]
|
|
270
|
+
- Added: dark highlighting in [#463]
|
|
271
|
+
- Added: pages and collections in [#448]
|
|
272
|
+
- Added: callouts in [#466]
|
|
273
|
+
- Fixed: breadcrumb behaviour … by [@AdityaTiwari2102] in [#477]
|
|
274
|
+
- Fixed: prevent rake command corrupting search data in [#495] (also listed below)
|
|
275
|
+
- Fixed: nested lists in [#496]
|
|
276
|
+
- Fixed: set color for search input in [#498] (also listed below)
|
|
154
277
|
- Fixed: sites with no child pages (no PR)
|
|
155
|
-
- Fixed: TOC/breadcrumbs for multiple collections in
|
|
278
|
+
- Fixed: TOC/breadcrumbs for multiple collections in [#494]
|
|
156
279
|
- Added: collection configuration option `nav_fold` (no PR)
|
|
157
280
|
- Fixed: indentation and color for folded collection navigation (no PR)
|
|
158
|
-
- Fixed: scroll navigation to show the link to the current page in
|
|
159
|
-
- Fixed: Replace all uses of `absolute_url` by `relative_url`, by @svrooij in
|
|
160
|
-
* Added: custom favicon `_includes` by @burner1024 in
|
|
161
|
-
* Added: set color for search input by @pdmosses in
|
|
162
|
-
* Added: search placeholder configuration by @mattxwang in
|
|
163
|
-
* Added: 'child_nav_order' front matter to be able to sort navigation pages in reverse by @jmertic in
|
|
164
|
-
* Added: `nav_footer_custom` include by @nathanjessen in
|
|
165
|
-
* Added: style fixes for jekyll-asciidoc by @alyssais in
|
|
166
|
-
* Added: mermaid.js support by @nascosto in
|
|
167
|
-
* Added: support for external navigation links by @SPGoding in
|
|
168
|
-
* Added: refactor `mermaid` config to use `mermaid_config.js` include, only require `mermaid.version` in `_config.yml` by @mattxwang in
|
|
169
|
-
* Fixed: prepend `site.collections_dir` if exists by @alexsegura in
|
|
170
|
-
* Fixed: nested task lists (#517) by @pdmosses in
|
|
171
|
-
* Fixed: suppress Liquid processing in CSS comments by @pdmosses in
|
|
172
|
-
* Fixed: prevent rake command from corrupting search data by @pdmosses in
|
|
173
|
-
* Fixed: anchor heading links should be visible on focus by @jacobhq in
|
|
174
|
-
* Fixed: add `overflow-x: auto` to `figure.highlight` by @iridazzle in
|
|
175
|
-
* Fixed: add `overflow-wrap: word-break` to `body` by @iridazzle in
|
|
176
|
-
* Fixed: vertical alignment for consecutive labels by @Eisverygoodletter in
|
|
177
|
-
* Fixed: allow links to wrap by @pdmosses in
|
|
178
|
-
* Fixed: nav scroll feature and absolute/relative URLs by @pdmosses in
|
|
281
|
+
- Fixed: scroll navigation to show the link to the current page in [#639]
|
|
282
|
+
- Fixed: Replace all uses of `absolute_url` by `relative_url`, by [@svrooij] in [#544]
|
|
283
|
+
* Added: custom favicon `_includes` by [@burner1024] in [#364]
|
|
284
|
+
* Added: set color for search input by [@pdmosses] in [#498]
|
|
285
|
+
* Added: search placeholder configuration by [@mattxwang] in [#613]
|
|
286
|
+
* Added: 'child_nav_order' front matter to be able to sort navigation pages in reverse by [@jmertic] in [#726]
|
|
287
|
+
* Added: `nav_footer_custom` include by [@nathanjessen] in [#474]
|
|
288
|
+
* Added: style fixes for jekyll-asciidoc by [@alyssais] in [#829]
|
|
289
|
+
* Added: mermaid.js support by [@nascosto] in [#857]
|
|
290
|
+
* Added: support for external navigation links by [@SPGoding] in [#876]
|
|
291
|
+
* Added: refactor `mermaid` config to use `mermaid_config.js` include, only require `mermaid.version` in `_config.yml` by [@mattxwang] in [#909]
|
|
292
|
+
* Fixed: prepend `site.collections_dir` if exists by [@alexsegura] in [#519]
|
|
293
|
+
* Fixed: nested task lists (#517) by [@pdmosses] in [#855]
|
|
294
|
+
* Fixed: suppress Liquid processing in CSS comments by [@pdmosses] in [#686]
|
|
295
|
+
* Fixed: prevent rake command from corrupting search data by [@pdmosses] in [#495]
|
|
296
|
+
* Fixed: anchor heading links should be visible on focus by [@jacobhq] in [#846]
|
|
297
|
+
* Fixed: add `overflow-x: auto` to `figure.highlight` by [@iridazzle] in [#727]
|
|
298
|
+
* Fixed: add `overflow-wrap: word-break` to `body` by [@iridazzle] in [#889]
|
|
299
|
+
* Fixed: vertical alignment for consecutive labels by [@Eisverygoodletter] in [#893]
|
|
300
|
+
* Fixed: allow links to wrap by [@pdmosses] in [#905]
|
|
301
|
+
* Fixed: nav scroll feature and absolute/relative URLs by [@pdmosses] in [#898]
|
|
302
|
+
|
|
303
|
+
[#578]: https://github.com/just-the-docs/just-the-docs/pull/578
|
|
304
|
+
[#463]: https://github.com/just-the-docs/just-the-docs/pull/463
|
|
305
|
+
[#448]: https://github.com/just-the-docs/just-the-docs/pull/448
|
|
306
|
+
[#466]: https://github.com/just-the-docs/just-the-docs/pull/466
|
|
307
|
+
[#477]: https://github.com/just-the-docs/just-the-docs/pull/477
|
|
308
|
+
[#495]: https://github.com/just-the-docs/just-the-docs/pull/495
|
|
309
|
+
[#496]: https://github.com/just-the-docs/just-the-docs/pull/496
|
|
310
|
+
[#498]: https://github.com/just-the-docs/just-the-docs/pull/498
|
|
311
|
+
[#494]: https://github.com/just-the-docs/just-the-docs/pull/494
|
|
312
|
+
[#639]: https://github.com/just-the-docs/just-the-docs/pull/639
|
|
313
|
+
[#544]: https://github.com/just-the-docs/just-the-docs/pull/544
|
|
314
|
+
[#364]: https://github.com/just-the-docs/just-the-docs/pull/364
|
|
315
|
+
[#498]: https://github.com/just-the-docs/just-the-docs/pull/498
|
|
316
|
+
[#613]: https://github.com/just-the-docs/just-the-docs/pull/613
|
|
317
|
+
[#726]: https://github.com/just-the-docs/just-the-docs/pull/726
|
|
318
|
+
[#474]: https://github.com/just-the-docs/just-the-docs/pull/474
|
|
319
|
+
[#829]: https://github.com/just-the-docs/just-the-docs/pull/829
|
|
320
|
+
[#857]: https://github.com/just-the-docs/just-the-docs/pull/857
|
|
321
|
+
[#876]: https://github.com/just-the-docs/just-the-docs/pull/876
|
|
322
|
+
[#909]: https://github.com/just-the-docs/just-the-docs/pull/909
|
|
323
|
+
[#519]: https://github.com/just-the-docs/just-the-docs/pull/519
|
|
324
|
+
[#855]: https://github.com/just-the-docs/just-the-docs/pull/855
|
|
325
|
+
[#686]: https://github.com/just-the-docs/just-the-docs/pull/686
|
|
326
|
+
[#495]: https://github.com/just-the-docs/just-the-docs/pull/495
|
|
327
|
+
[#846]: https://github.com/just-the-docs/just-the-docs/pull/846
|
|
328
|
+
[#727]: https://github.com/just-the-docs/just-the-docs/pull/727
|
|
329
|
+
[#889]: https://github.com/just-the-docs/just-the-docs/pull/889
|
|
330
|
+
[#893]: https://github.com/just-the-docs/just-the-docs/pull/893
|
|
331
|
+
[#905]: https://github.com/just-the-docs/just-the-docs/pull/905
|
|
332
|
+
[#898]: https://github.com/just-the-docs/just-the-docs/pull/898
|
|
179
333
|
|
|
180
334
|
### Documentation
|
|
181
335
|
|
|
182
|
-
* Added: docs on how to break an `ol` by @pdmosses in
|
|
183
|
-
* Added: docs for custom includes by @nathanjessen in
|
|
184
|
-
* Added: document caveat about variable dependencies by @waldyrious in
|
|
185
|
-
* Added: docs on how to use `custom_head` to add a custom favicon by @UnclassedPenguin in
|
|
186
|
-
* Fixed: `ol` on `index.md` by @pmarsceill in
|
|
187
|
-
* Fixed: image link in Markdown kitchen sink by @JeffGuKang in
|
|
188
|
-
* Fixed: images in Markdown kitchen sink by @dougaitken in
|
|
189
|
-
* Fixed: clearer label of link to Jekyll quickstart by @waldyrious in
|
|
190
|
-
* Fixed: remove extra spaces in component docs by @MichelleBlanchette in
|
|
191
|
-
* Fixed: double "your" typo in `index.md` by @sehilyi in
|
|
192
|
-
* Fixed: "you" -> "your" typo in `index.md` by @nathanjessen in
|
|
193
|
-
* Fixed: spacing in toc example by @henryiii in
|
|
194
|
-
* Fixed: typo in `README` on `_config.yml` by @ivanskodje in
|
|
195
|
-
* Fixed: missing code fence in navigation structure docs by @mattxwang in
|
|
336
|
+
* Added: docs on how to break an `ol` by [@pdmosses] in [#856]
|
|
337
|
+
* Added: docs for custom includes by [@nathanjessen] in [#806]
|
|
338
|
+
* Added: document caveat about variable dependencies by [@waldyrious] in [#555]
|
|
339
|
+
* Added: docs on how to use `custom_head` to add a custom favicon by [@UnclassedPenguin] in [#814]
|
|
340
|
+
* Fixed: `ol` on `index.md` by [@pmarsceill] in [#778]
|
|
341
|
+
* Fixed: image link in Markdown kitchen sink by [@JeffGuKang] in [#221]
|
|
342
|
+
* Fixed: images in Markdown kitchen sink by [@dougaitken] in [#782]
|
|
343
|
+
* Fixed: clearer label of link to Jekyll quickstart by [@waldyrious] in [#549]
|
|
344
|
+
* Fixed: remove extra spaces in component docs by [@MichelleBlanchette] in [#554]
|
|
345
|
+
* Fixed: double "your" typo in `index.md` by [@sehilyi] in [#499]
|
|
346
|
+
* Fixed: "you" -> "your" typo in `index.md` by [@nathanjessen] in [#473]
|
|
347
|
+
* Fixed: spacing in toc example by [@henryiii] in [#835]
|
|
348
|
+
* Fixed: typo in `README` on `_config.yml` by [@ivanskodje] in [#891]
|
|
349
|
+
* Fixed: missing code fence in navigation structure docs by [@mattxwang] in [#906]
|
|
350
|
+
|
|
351
|
+
[#856]: https://github.com/just-the-docs/just-the-docs/pull/856
|
|
352
|
+
[#806]: https://github.com/just-the-docs/just-the-docs/pull/806
|
|
353
|
+
[#555]: https://github.com/just-the-docs/just-the-docs/pull/555
|
|
354
|
+
[#814]: https://github.com/just-the-docs/just-the-docs/pull/814
|
|
355
|
+
[#778]: https://github.com/just-the-docs/just-the-docs/pull/778
|
|
356
|
+
[#221]: https://github.com/just-the-docs/just-the-docs/pull/221
|
|
357
|
+
[#782]: https://github.com/just-the-docs/just-the-docs/pull/782
|
|
358
|
+
[#549]: https://github.com/just-the-docs/just-the-docs/pull/549
|
|
359
|
+
[#554]: https://github.com/just-the-docs/just-the-docs/pull/554
|
|
360
|
+
[#499]: https://github.com/just-the-docs/just-the-docs/pull/499
|
|
361
|
+
[#473]: https://github.com/just-the-docs/just-the-docs/pull/473
|
|
362
|
+
[#835]: https://github.com/just-the-docs/just-the-docs/pull/835
|
|
363
|
+
[#891]: https://github.com/just-the-docs/just-the-docs/pull/891
|
|
364
|
+
[#906]: https://github.com/just-the-docs/just-the-docs/pull/906
|
|
196
365
|
|
|
197
366
|
### Maintenance
|
|
198
367
|
|
|
199
|
-
* Added: VScode devcontainer by @max06 in
|
|
200
|
-
* Added: `webrick` to `Gemfile` by @mattxwang in
|
|
201
|
-
* Added: 'This site is powered by Netlify.' to the footer by @mattxwang in
|
|
202
|
-
* Updated: new repo path by @pmarsceill in
|
|
203
|
-
* Updated: rename `master` -> `main` by @pmarsceill in
|
|
204
|
-
* Updated: README by @pmarsceill in
|
|
205
|
-
* Updated: Code of Conduct to Contributor Covenant v2.1 by @mattxwang in
|
|
206
|
-
* Updated: CI files, Ruby & Node Versions by @mattxwang in
|
|
207
|
-
* Updated: Stylelint to v14, extend SCSS plugins, remove primer-* configs, resolve issues by @mattxwang in
|
|
368
|
+
* Added: VScode devcontainer by [@max06] in [#783]
|
|
369
|
+
* Added: `webrick` to `Gemfile` by [@mattxwang] in [#799]
|
|
370
|
+
* Added: 'This site is powered by Netlify.' to the footer by [@mattxwang] in [#797]
|
|
371
|
+
* Updated: new repo path by [@pmarsceill] in [#775]
|
|
372
|
+
* Updated: rename `master` -> `main` by [@pmarsceill] in [#776]
|
|
373
|
+
* Updated: README by [@pmarsceill] in [#777]
|
|
374
|
+
* Updated: Code of Conduct to Contributor Covenant v2.1 by [@mattxwang] in [#790]
|
|
375
|
+
* Updated: CI files, Ruby & Node Versions by [@mattxwang] in [#820]
|
|
376
|
+
* Updated: Stylelint to v14, extend SCSS plugins, remove primer-* configs, resolve issues by [@mattxwang] in [#821]
|
|
377
|
+
|
|
378
|
+
[#783]: https://github.com/just-the-docs/just-the-docs/pull/783
|
|
379
|
+
[#799]: https://github.com/just-the-docs/just-the-docs/pull/799
|
|
380
|
+
[#797]: https://github.com/just-the-docs/just-the-docs/pull/797
|
|
381
|
+
[#775]: https://github.com/just-the-docs/just-the-docs/pull/775
|
|
382
|
+
[#776]: https://github.com/just-the-docs/just-the-docs/pull/776
|
|
383
|
+
[#777]: https://github.com/just-the-docs/just-the-docs/pull/777
|
|
384
|
+
[#790]: https://github.com/just-the-docs/just-the-docs/pull/790
|
|
385
|
+
[#820]: https://github.com/just-the-docs/just-the-docs/pull/820
|
|
386
|
+
[#821]: https://github.com/just-the-docs/just-the-docs/pull/821
|
|
208
387
|
|
|
209
388
|
### Dependencies
|
|
210
|
-
|
|
211
|
-
*
|
|
212
|
-
* [Security] Bump
|
|
213
|
-
* [Security] Bump
|
|
214
|
-
* [Security] Bump
|
|
215
|
-
* Bump
|
|
216
|
-
* Bump
|
|
217
|
-
* Bump
|
|
218
|
-
* Bump prettier from 2.
|
|
219
|
-
* Bump prettier from 2.
|
|
389
|
+
|
|
390
|
+
* Upgrade to GitHub-native Dependabot by @dependabot-preview in [#627]
|
|
391
|
+
* [Security] Bump y18n from 3.2.1 to 3.2.2 by @dependabot-preview in [#606]
|
|
392
|
+
* [Security] Bump hosted-git-info from 2.7.1 to 2.8.9 by @dependabot-preview in [#641]
|
|
393
|
+
* [Security] Bump lodash from 4.17.19 to 4.17.21 by @dependabot-preview in [#640]
|
|
394
|
+
* [Security] Bump ini from 1.3.5 to 1.3.8 by @dependabot-preview in [#511]
|
|
395
|
+
* Bump path-parse from 1.0.6 to 1.0.7 by @dependabot in [#699]
|
|
396
|
+
* Bump ajv from 6.10.0 to 6.12.6 by @dependabot in [#766]
|
|
397
|
+
* Bump prettier from 2.1.2 to 2.5.1 by @dependabot in [#787]
|
|
398
|
+
* Bump prettier from 2.5.1 to 2.6.2 by @dependabot in [#809]
|
|
399
|
+
* Bump prettier from 2.6.2 to 2.7.1 by @dependabot in [#864]
|
|
400
|
+
|
|
401
|
+
[#627]: https://github.com/just-the-docs/just-the-docs/pull/627
|
|
402
|
+
[#606]: https://github.com/just-the-docs/just-the-docs/pull/606
|
|
403
|
+
[#641]: https://github.com/just-the-docs/just-the-docs/pull/641
|
|
404
|
+
[#640]: https://github.com/just-the-docs/just-the-docs/pull/640
|
|
405
|
+
[#511]: https://github.com/just-the-docs/just-the-docs/pull/511
|
|
406
|
+
[#699]: https://github.com/just-the-docs/just-the-docs/pull/699
|
|
407
|
+
[#766]: https://github.com/just-the-docs/just-the-docs/pull/766
|
|
408
|
+
[#787]: https://github.com/just-the-docs/just-the-docs/pull/787
|
|
409
|
+
[#809]: https://github.com/just-the-docs/just-the-docs/pull/809
|
|
410
|
+
[#864]: https://github.com/just-the-docs/just-the-docs/pull/864
|
|
220
411
|
|
|
221
412
|
### New Contributors
|
|
222
|
-
|
|
223
|
-
* @
|
|
224
|
-
* @
|
|
225
|
-
* @
|
|
226
|
-
* @
|
|
227
|
-
* @
|
|
228
|
-
* @
|
|
229
|
-
* @
|
|
230
|
-
* @
|
|
231
|
-
* @
|
|
232
|
-
* @
|
|
233
|
-
* @
|
|
234
|
-
* @
|
|
235
|
-
* @
|
|
236
|
-
* @
|
|
237
|
-
* @
|
|
238
|
-
* @
|
|
239
|
-
* @
|
|
240
|
-
* @
|
|
413
|
+
|
|
414
|
+
* [@AdityaTiwari2102] made their first contribution in [#477]
|
|
415
|
+
* [@svrooij] made their first contribution in [#544]
|
|
416
|
+
* [@alexsegura] made their first contribution in [#519]
|
|
417
|
+
* [@burner1024] made their first contribution in [#364]
|
|
418
|
+
* [@JeffGuKang] made their first contribution in [#221]
|
|
419
|
+
* [@dougaitken] made their first contribution in [#782]
|
|
420
|
+
* [@max06] made their first contribution in [#783]
|
|
421
|
+
* [@sehilyi] made their first contribution in [#499]
|
|
422
|
+
* [@nathanjessen] made their first contribution in [#473]
|
|
423
|
+
* [@waldyrious] made their first contribution in [#549]
|
|
424
|
+
* [@MichelleBlanchette] made their first contribution in [#554]
|
|
425
|
+
* [@henryiii] made their first contribution in [#835]
|
|
426
|
+
* [@jmertic] made their first contribution in [#726]
|
|
427
|
+
* [@jacobhq] made their first contribution in [#846]
|
|
428
|
+
* [@UnclassedPenguin] made their first contribution in [#814]
|
|
429
|
+
* [@alyssais] made their first contribution in [#829]
|
|
430
|
+
* [@nascosto] made their first contribution in [#857]
|
|
431
|
+
* [@SPGoding] made their first contribution in [#876]
|
|
432
|
+
* [@iridazzle] made their first contribution in [#727]
|
|
433
|
+
* [@ivanskodje] made their first contribution in [#891]
|
|
434
|
+
* [@Eisverygoodletter] made their first contribution in [#893]
|
|
435
|
+
|
|
436
|
+
[@AdityaTiwari2102]: https://githhub.com/AdityaTiwari2102
|
|
437
|
+
[@svrooij]: https://githhub.com/svrooij
|
|
438
|
+
[@alexsegura]: https://githhub.com/alexsegura
|
|
439
|
+
[@burner1024]: https://githhub.com/burner1024
|
|
440
|
+
[@JeffGuKang]: https://githhub.com/JeffGuKang
|
|
441
|
+
[@dougaitken]: https://githhub.com/dougaitken
|
|
442
|
+
[@max06]: https://githhub.com/max06
|
|
443
|
+
[@sehilyi]: https://githhub.com/sehilyi
|
|
444
|
+
[@nathanjessen]: https://githhub.com/nathanjessen
|
|
445
|
+
[@waldyrious]: https://githhub.com/waldyrious
|
|
446
|
+
[@MichelleBlanchette]: https://githhub.com/MichelleBlanchette
|
|
447
|
+
[@henryiii]: https://githhub.com/henryiii
|
|
448
|
+
[@jmertic]: https://githhub.com/jmertic
|
|
449
|
+
[@jacobhq]: https://githhub.com/jacobhq
|
|
450
|
+
[@UnclassedPenguin]: https://githhub.com/UnclassedPenguin
|
|
451
|
+
[@alyssais]: https://githhub.com/alyssais
|
|
452
|
+
[@nascosto]: https://githhub.com/nascosto
|
|
453
|
+
[@SPGoding]: https://githhub.com/SPGoding
|
|
454
|
+
[@iridazzle]: https://githhub.com/iridazzle
|
|
455
|
+
[@ivanskodje]: https://githhub.com/ivanskodje
|
|
456
|
+
[@Eisverygoodletter]: https://githhub.com/Eisverygoodletter
|
|
241
457
|
|
|
242
458
|
**Full Changelog**: https://github.com/just-the-docs/just-the-docs/compare/v0.3.3...v0.4.0.rc1
|
|
243
459
|
|
|
460
|
+
[@pmarsceill]: https://githhub.com/pmarsceill
|
|
461
|
+
|
|
244
462
|
## v0.3.3
|
|
245
463
|
|
|
246
464
|
### 🚀 Features
|
data/README.md
CHANGED
|
@@ -61,7 +61,6 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/just-t
|
|
|
61
61
|
- Open a [Pull Request](https://github.com/just-the-docs/just-the-docs/pulls)
|
|
62
62
|
- Ensure all CI tests pass
|
|
63
63
|
- Await code review
|
|
64
|
-
- Bump the version number in `just-the-docs.gemspec` and `package.json` according to [semantic versioning](https://semver.org/).
|
|
65
64
|
|
|
66
65
|
### Design and development principles of this theme:
|
|
67
66
|
|
data/_includes/head.html
CHANGED
|
@@ -27,14 +27,14 @@
|
|
|
27
27
|
{% endif %}
|
|
28
28
|
|
|
29
29
|
{% if site.search_enabled != false %}
|
|
30
|
-
<script
|
|
30
|
+
<script src="{{ '/assets/js/vendor/lunr.min.js' | relative_url }}"></script>
|
|
31
31
|
{% endif %}
|
|
32
32
|
|
|
33
33
|
{% if site.mermaid %}
|
|
34
34
|
<script src="https://cdn.jsdelivr.net/npm/mermaid@{{ site.mermaid.version }}/dist/mermaid.min.js"></script>
|
|
35
35
|
{% endif %}
|
|
36
36
|
|
|
37
|
-
<script
|
|
37
|
+
<script src="{{ '/assets/js/just-the-docs.js' | relative_url }}"></script>
|
|
38
38
|
|
|
39
39
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
40
40
|
|
data/_includes/nav.html
CHANGED
|
@@ -1,73 +1,140 @@
|
|
|
1
1
|
{%- comment -%}
|
|
2
|
-
|
|
2
|
+
The `nav_order` values of pages affect the order in which they are shown in
|
|
3
|
+
the navigation panel and in the automatically generated tables of contents.
|
|
4
|
+
Sibling pages with the same `nav_order` value may be shown in any order.
|
|
5
|
+
Sibling pages with no `nav_order` value are shown after all pages that have
|
|
6
|
+
explicit `nav_order` values, ordered by their `title` values.
|
|
3
7
|
|
|
4
|
-
The
|
|
5
|
-
|
|
6
|
-
|
|
8
|
+
The `nav_order` and `title` values can be numbers or strings. To avoid build
|
|
9
|
+
failures, we sort numbers and strings separately. We sort numbers by their
|
|
10
|
+
values, and strings lexicographically. The case-sensitivity of string sorting
|
|
11
|
+
is determined by the configuration setting of `nav_sort`. Pages with no `title`
|
|
12
|
+
value are excluded from the navigation.
|
|
13
|
+
|
|
14
|
+
Note: Numbers used as `title` or `nav_order` values should not be in quotes,
|
|
15
|
+
unless you intend them to be lexicographically ordered. Numbers are written
|
|
16
|
+
without spaces or thousands-separators. Negative numbers are preceded by `-`.
|
|
17
|
+
Floats are written with the integral and fractional parts separated by `.`.
|
|
18
|
+
(Bounds on the magnitude and precision are presumably the same as in Liquid.)
|
|
19
|
+
{%- endcomment -%}
|
|
7
20
|
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
(except that a numerical `title` value is treated as a string).
|
|
21
|
+
{%- assign title_pages = include.pages
|
|
22
|
+
| where_exp: "item", "item.title != nil" -%}
|
|
11
23
|
|
|
12
|
-
|
|
24
|
+
{%- comment -%}
|
|
25
|
+
A page with `nav_exclude: true` does not appear in the main navigation.
|
|
26
|
+
If it has a `parent`, it may appear in the parent's table of contents.
|
|
27
|
+
If it specifies `has_children: true`, it should appear in the breadcrumbs
|
|
28
|
+
of the child pages, but its order in relation to other pages is irrelevant.
|
|
29
|
+
Pages that never appear can be removed from the pages that need to be sorted.
|
|
30
|
+
This optimisation can be significant on a site with many pages.
|
|
31
|
+
|
|
32
|
+
In Jekyll 4, the pages to be sorted can be filtered by:
|
|
33
|
+
|
|
34
|
+
{%- assign title_pages = title_pages
|
|
35
|
+
| where_exp: "item", "item.nav_exclude != true or item.parent != nil" -%}
|
|
36
|
+
|
|
37
|
+
That filter is not allowed in Jekyll 3. The following iterative code gives the
|
|
38
|
+
same effect, but it is activated only when it will filter more than 50% of the
|
|
39
|
+
pages.
|
|
13
40
|
{%- endcomment -%}
|
|
14
41
|
|
|
15
|
-
{%- assign
|
|
16
|
-
| where_exp: "item", "item.
|
|
42
|
+
{%- assign unsorted_pages = title_pages
|
|
43
|
+
| where_exp: "item", "item.parent == nil"
|
|
44
|
+
| where_exp: "item", "item.nav_exclude == true"-%}
|
|
45
|
+
{%- assign title_pages_size = title_pages.size -%}
|
|
46
|
+
{%- assign unsorted_pages_percent = unsorted_pages.size
|
|
47
|
+
| times: 100 | divided_by: title_pages_size -%}
|
|
48
|
+
{%- if unsorted_pages_percent > 50 -%}
|
|
49
|
+
{%- assign sorted_pages = "" | split: "" -%}
|
|
50
|
+
{%- for item in title_pages -%}
|
|
51
|
+
{%- if item.nav_exclude != true or item.parent -%}
|
|
52
|
+
{%- assign sorted_pages = sorted_pages | push: item -%}
|
|
53
|
+
{%- endif -%}
|
|
54
|
+
{%- endfor -%}
|
|
55
|
+
{%- assign title_pages = sorted_pages -%}
|
|
56
|
+
{%- endif -%}
|
|
17
57
|
|
|
18
|
-
{%- assign
|
|
58
|
+
{%- assign nav_order_pages = title_pages
|
|
59
|
+
| where_exp: "item", "item.nav_order != nil" -%}
|
|
60
|
+
{%- assign title_order_pages = title_pages
|
|
19
61
|
| where_exp: "item", "item.nav_order == nil" -%}
|
|
20
|
-
{%- assign nav_ordered_pages = titled_pages
|
|
21
|
-
| where_exp: "item", "item.nav_order != nil" -%}
|
|
22
62
|
|
|
23
63
|
{%- comment -%}
|
|
24
|
-
|
|
25
|
-
|
|
64
|
+
Divide the arrays of `nav_order_pages` and `title_order_pages` according to
|
|
65
|
+
the type of value.
|
|
26
66
|
|
|
27
|
-
The first character of the `jsonify`
|
|
67
|
+
The first character of the result of `jsonify` is `"` only for strings.
|
|
68
|
+
Grouping by a single character also ensures the number of groups is small.
|
|
28
69
|
{%- endcomment -%}
|
|
29
70
|
|
|
30
|
-
{%- assign
|
|
71
|
+
{%- assign nav_number_pages = "" | split: "" -%}
|
|
72
|
+
{%- assign nav_string_pages = "" | split: "" -%}
|
|
73
|
+
{%- assign nav_order_groups = nav_order_pages
|
|
31
74
|
| group_by_exp: "item", "item.nav_order | jsonify | slice: 0" -%}
|
|
75
|
+
{%- for group in nav_order_groups -%}
|
|
76
|
+
{%- if group.name == '"' -%}
|
|
77
|
+
{%- assign nav_string_pages = group.items -%}
|
|
78
|
+
{%- else -%}
|
|
79
|
+
{%- assign nav_number_pages = nav_number_pages | concat: group.items -%}
|
|
80
|
+
{%- endif -%}
|
|
81
|
+
{%- endfor -%}
|
|
82
|
+
|
|
83
|
+
{%- unless nav_number_pages == empty -%}
|
|
84
|
+
{%- assign nav_number_pages = nav_number_pages | sort: "nav_order" -%}
|
|
85
|
+
{%- endunless -%}
|
|
86
|
+
|
|
87
|
+
{%- unless nav_string_pages == empty -%}
|
|
88
|
+
{%- if site.nav_sort == 'case_insensitive' -%}
|
|
89
|
+
{%- assign nav_string_pages = nav_string_pages | sort_natural: "nav_order" -%}
|
|
90
|
+
{%- else -%}
|
|
91
|
+
{%- assign nav_string_pages = nav_string_pages | sort: "nav_order" -%}
|
|
92
|
+
{%- endif -%}
|
|
93
|
+
{%- endunless -%}
|
|
32
94
|
|
|
33
|
-
{%- assign
|
|
34
|
-
{%-
|
|
95
|
+
{%- assign title_number_pages = "" | split: "" -%}
|
|
96
|
+
{%- assign title_string_pages = "" | split: "" -%}
|
|
97
|
+
{%- assign title_order_groups = title_order_pages
|
|
98
|
+
| group_by_exp: "item", "item.title | jsonify | slice: 0" -%}
|
|
99
|
+
{%- for group in title_order_groups -%}
|
|
35
100
|
{%- if group.name == '"' -%}
|
|
36
|
-
{%- assign
|
|
101
|
+
{%- assign title_string_pages = group.items -%}
|
|
37
102
|
{%- else -%}
|
|
38
|
-
{%- assign
|
|
103
|
+
{%- assign title_number_pages = title_number_pages | concat: group.items -%}
|
|
39
104
|
{%- endif -%}
|
|
40
105
|
{%- endfor -%}
|
|
41
106
|
|
|
42
|
-
{%-
|
|
43
|
-
|
|
107
|
+
{%- unless title_number_pages == empty -%}
|
|
108
|
+
{%- assign title_number_pages = title_number_pages | sort: "title" -%}
|
|
109
|
+
{%- endunless -%}
|
|
44
110
|
|
|
45
|
-
{%-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
{%-
|
|
111
|
+
{%- unless title_string_pages == empty -%}
|
|
112
|
+
{%- if site.nav_sort == 'case_insensitive' -%}
|
|
113
|
+
{%- assign title_string_pages = title_string_pages | sort_natural: "title" -%}
|
|
114
|
+
{%- else -%}
|
|
115
|
+
{%- assign title_string_pages = title_string_pages | sort: "title" -%}
|
|
116
|
+
{%- endif -%}
|
|
117
|
+
{%- endunless -%}
|
|
51
118
|
|
|
52
|
-
{%- assign
|
|
53
|
-
|
|
|
119
|
+
{%- assign pages_list = nav_number_pages | concat: nav_string_pages
|
|
120
|
+
| concat: title_number_pages | concat: title_string_pages -%}
|
|
54
121
|
|
|
55
|
-
{%-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
122
|
+
{%- assign first_level_pages = pages_list
|
|
123
|
+
| where_exp: "item", "item.parent == nil" -%}
|
|
124
|
+
{%- assign second_level_pages = pages_list
|
|
125
|
+
| where_exp: "item", "item.parent != nil"
|
|
126
|
+
| where_exp: "item", "item.grand_parent == nil" -%}
|
|
127
|
+
{%- assign third_level_pages = pages_list
|
|
128
|
+
| where_exp: "item", "item.grand_parent != nil" -%}
|
|
62
129
|
|
|
63
|
-
{%-
|
|
64
|
-
|
|
130
|
+
{%- comment -%}
|
|
131
|
+
The order of sibling pages in `pages_list` determines the order of display of
|
|
132
|
+
links to them in lists of navigation links and in auto-generated TOCs.
|
|
133
|
+
{%- endcomment -%}
|
|
65
134
|
|
|
66
135
|
<ul class="nav-list">
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
{%- if node.parent == nil -%}
|
|
70
|
-
{%- unless node.nav_exclude -%}
|
|
136
|
+
{%- for node in first_level_pages -%}
|
|
137
|
+
{%- unless node.nav_exclude -%}
|
|
71
138
|
<li class="nav-list-item{% if page.collection == include.key and page.url == node.url or page.parent == node.title or page.grand_parent == node.title %} active{% endif %}">
|
|
72
139
|
{%- if node.has_children -%}
|
|
73
140
|
<a href="#" class="nav-list-expander" aria-label="toggle links in {{ node.title }} category">
|
|
@@ -76,13 +143,8 @@
|
|
|
76
143
|
{%- endif -%}
|
|
77
144
|
<a href="{{ node.url | relative_url }}" class="nav-list-link{% if page.url == node.url %} active{% endif %}">{{ node.title }}</a>
|
|
78
145
|
{%- if node.has_children -%}
|
|
79
|
-
{%- assign children_list =
|
|
80
|
-
|
|
81
|
-
{%- assign children_list = children_list
|
|
82
|
-
| concat: parent_group.items
|
|
83
|
-
| where: "parent", node.title
|
|
84
|
-
| where_exp:"item", "item.grand_parent == nil" -%}
|
|
85
|
-
{%- endfor -%}
|
|
146
|
+
{%- assign children_list = second_level_pages
|
|
147
|
+
| where: "parent", node.title -%}
|
|
86
148
|
{%- if node.child_nav_order == 'desc' -%}
|
|
87
149
|
{%- assign children_list = children_list | reverse -%}
|
|
88
150
|
{%- endif -%}
|
|
@@ -97,21 +159,17 @@
|
|
|
97
159
|
{%- endif -%}
|
|
98
160
|
<a href="{{ child.url | relative_url }}" class="nav-list-link{% if page.url == child.url %} active{% endif %}">{{ child.title }}</a>
|
|
99
161
|
{%- if child.has_children -%}
|
|
100
|
-
{%- assign
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
| where: "grand_parent", node.title -%}
|
|
106
|
-
{%- endfor -%}
|
|
107
|
-
{%- if node.child_nav_order == 'desc' -%}
|
|
108
|
-
{%- assign grandchildren_list = grandchildren_list | reverse -%}
|
|
162
|
+
{%- assign grand_children_list = third_level_pages
|
|
163
|
+
| where: "parent", child.title
|
|
164
|
+
| where: "grand_parent", node.title -%}
|
|
165
|
+
{%- if child.child_nav_order == 'desc' -%}
|
|
166
|
+
{%- assign grand_children_list = grand_children_list | reverse -%}
|
|
109
167
|
{%- endif -%}
|
|
110
168
|
<ul class="nav-list">
|
|
111
|
-
{%- for
|
|
112
|
-
{%- unless
|
|
113
|
-
<li class="nav-list-item {% if page.url ==
|
|
114
|
-
<a href="{{
|
|
169
|
+
{%- for grand_child in grand_children_list -%}
|
|
170
|
+
{%- unless grand_child.nav_exclude -%}
|
|
171
|
+
<li class="nav-list-item {% if page.url == grand_child.url %} active{% endif %}">
|
|
172
|
+
<a href="{{ grand_child.url | relative_url }}" class="nav-list-link{% if page.url == grand_child.url %} active{% endif %}">{{ grand_child.title }}</a>
|
|
115
173
|
</li>
|
|
116
174
|
{%- endunless -%}
|
|
117
175
|
{%- endfor -%}
|
|
@@ -123,65 +181,53 @@
|
|
|
123
181
|
</ul>
|
|
124
182
|
{%- endif -%}
|
|
125
183
|
</li>
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
</li>
|
|
138
|
-
{%- endfor -%}
|
|
184
|
+
{%- endunless -%}
|
|
185
|
+
{%- endfor -%}
|
|
186
|
+
{%- assign nav_external_links = site.nav_external_links -%}
|
|
187
|
+
{%- for node in nav_external_links -%}
|
|
188
|
+
<li class="nav-list-item external">
|
|
189
|
+
<a href="{{ node.url | absolute_url }}" class="nav-list-link external">
|
|
190
|
+
{{ node.title }}
|
|
191
|
+
{% unless node.hide_icon %}<svg viewBox="0 0 24 24" aria-labelledby="svg-external-link-title"><use xlink:href="#svg-external-link"></use></svg>{% endunless %}
|
|
192
|
+
</a>
|
|
193
|
+
</li>
|
|
194
|
+
{%- endfor -%}
|
|
139
195
|
</ul>
|
|
140
196
|
|
|
141
|
-
{%-
|
|
197
|
+
{%- comment -%}
|
|
198
|
+
`page.collection` is the name of the Jekyll collection that contains the page,
|
|
199
|
+
if any, and otherwise nil. Similarly for `include.key`.
|
|
200
|
+
|
|
201
|
+
If the current page is in the collection (if any) whose navigation is currently
|
|
202
|
+
being generated, the following code sets `first_level_url` to the URL used in
|
|
203
|
+
the page's top-level breadcrumb (if any), and `second_level_url` to that used
|
|
204
|
+
in the page's second-level breadcrumb (if any).
|
|
205
|
+
|
|
206
|
+
For pages with children, the code also sets `toc_list` to the list of child pages.
|
|
207
|
+
{%- endcomment -%}
|
|
142
208
|
|
|
143
|
-
|
|
144
|
-
{%- for node in
|
|
145
|
-
|
|
146
|
-
{%- if page.grand_parent == node.title
|
|
147
|
-
or page.parent == node.title
|
|
148
|
-
and page.grand_parent == nil -%}
|
|
209
|
+
{%- if page.collection == include.key -%}
|
|
210
|
+
{%- for node in first_level_pages -%}
|
|
211
|
+
{%- if page.grand_parent == node.title or page.parent == node.title and page.grand_parent == nil -%}
|
|
149
212
|
{%- assign first_level_url = node.url | relative_url -%}
|
|
150
213
|
{%- endif -%}
|
|
151
214
|
{%- if node.has_children -%}
|
|
152
|
-
{%- assign children_list =
|
|
153
|
-
{%- for parent_group in groups_list -%}
|
|
154
|
-
{%- assign children_list = children_list | concat:
|
|
155
|
-
parent_group.items | where: "parent", node.title -%}
|
|
156
|
-
{%- endfor -%}
|
|
157
|
-
{%- if node.child_nav_order == 'desc' -%}
|
|
158
|
-
{%- assign children_list = children_list | reverse -%}
|
|
159
|
-
{%- endif -%}
|
|
215
|
+
{%- assign children_list = second_level_pages | where: "parent", node.title -%}
|
|
160
216
|
{%- for child in children_list -%}
|
|
161
217
|
{%- if child.has_children -%}
|
|
162
|
-
{%- if page.url == child.url
|
|
163
|
-
or page.parent == child.title
|
|
164
|
-
and page.grand_parent == child.parent -%}
|
|
218
|
+
{%- if page.url == child.url or page.parent == child.title and page.grand_parent == child.parent -%}
|
|
165
219
|
{%- assign second_level_url = child.url | relative_url -%}
|
|
166
220
|
{%- endif -%}
|
|
167
221
|
{%- endif -%}
|
|
168
222
|
{%- endfor -%}
|
|
169
223
|
{%- endif -%}
|
|
170
|
-
{%- endif -%}
|
|
171
|
-
{%- endfor -%}
|
|
172
224
|
{%- endfor -%}
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
| concat: parent_group.items
|
|
179
|
-
| where: "parent", page.title
|
|
180
|
-
| where: "grand_parent", page.parent -%}
|
|
181
|
-
{%- endfor -%}
|
|
182
|
-
{%- if node.child_nav_order == 'desc' -%}
|
|
225
|
+
{%- if page.has_children == true and page.has_toc != false -%}
|
|
226
|
+
{%- assign toc_list = pages_list
|
|
227
|
+
| where: "parent", page.title
|
|
228
|
+
| where: "grand_parent", page.parent -%}
|
|
229
|
+
{%- if page.child_nav_order == "desc" -%}
|
|
183
230
|
{%- assign toc_list = toc_list | reverse -%}
|
|
184
231
|
{%- endif -%}
|
|
185
232
|
{%- endif -%}
|
|
186
|
-
|
|
187
233
|
{%- endif -%}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
<h2 class="text-delta">Table of contents</h2>
|
data/_layouts/default.html
CHANGED
|
@@ -49,7 +49,7 @@ layout: table_wrappers
|
|
|
49
49
|
<svg viewBox="0 0 24 24" class="icon"><use xlink:href="#svg-menu"></use></svg>
|
|
50
50
|
</a>
|
|
51
51
|
</div>
|
|
52
|
-
<nav
|
|
52
|
+
<nav aria-label="Main" id="site-nav" class="site-nav">
|
|
53
53
|
{% assign pages_top_size = site.html_pages
|
|
54
54
|
| where_exp:"item", "item.title != nil"
|
|
55
55
|
| where_exp:"item", "item.parent == nil"
|
|
@@ -112,6 +112,8 @@ layout: table_wrappers
|
|
|
112
112
|
</div>
|
|
113
113
|
<div id="search-results" class="search-results"></div>
|
|
114
114
|
</div>
|
|
115
|
+
{% else %}
|
|
116
|
+
<div></div>
|
|
115
117
|
{% endif %}
|
|
116
118
|
{% include header_custom.html %}
|
|
117
119
|
{% if site.aux_links %}
|
|
@@ -157,7 +159,7 @@ layout: table_wrappers
|
|
|
157
159
|
|
|
158
160
|
{% if page.has_children == true and page.has_toc != false %}
|
|
159
161
|
<hr>
|
|
160
|
-
|
|
162
|
+
{% include toc_heading_custom.html %}
|
|
161
163
|
<ul>
|
|
162
164
|
{% for child in toc_list %}
|
|
163
165
|
<li>
|
|
@@ -215,12 +217,13 @@ layout: table_wrappers
|
|
|
215
217
|
<div class="search-overlay"></div>
|
|
216
218
|
{% endif %}
|
|
217
219
|
</div>
|
|
218
|
-
|
|
219
|
-
{% if site.mermaid %}
|
|
220
|
+
|
|
221
|
+
{% if site.mermaid %}
|
|
220
222
|
<script>
|
|
221
223
|
var config = {% include mermaid_config.js %};
|
|
222
224
|
mermaid.initialize(config);
|
|
223
225
|
window.mermaid.init(undefined, document.querySelectorAll('.language-mermaid'));
|
|
224
226
|
</script>
|
|
225
|
-
{% endif %}
|
|
227
|
+
{% endif %}
|
|
228
|
+
</body>
|
|
226
229
|
</html>
|
data/_sass/base.scss
CHANGED
|
@@ -65,18 +65,12 @@ a {
|
|
|
65
65
|
}
|
|
66
66
|
|
|
67
67
|
a:not([class]) {
|
|
68
|
-
text-decoration:
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
background-position: 0 100%;
|
|
72
|
-
background-size: 1px 1px;
|
|
68
|
+
text-decoration: underline;
|
|
69
|
+
text-decoration-color: $border-color;
|
|
70
|
+
text-underline-offset: 2px;
|
|
73
71
|
|
|
74
72
|
&:hover {
|
|
75
|
-
|
|
76
|
-
rgba($link-color, 0.45) 0%,
|
|
77
|
-
rgba($link-color, 0.45) 100%
|
|
78
|
-
);
|
|
79
|
-
background-size: 1px 1px;
|
|
73
|
+
text-decoration-color: rgba($link-color, 0.45);
|
|
80
74
|
}
|
|
81
75
|
}
|
|
82
76
|
|
|
@@ -107,3 +101,14 @@ hr {
|
|
|
107
101
|
background-color: $border-color;
|
|
108
102
|
border: 0;
|
|
109
103
|
}
|
|
104
|
+
|
|
105
|
+
// adds a GitHub-style sidebar to blockquotes
|
|
106
|
+
blockquote {
|
|
107
|
+
margin: 10px 0;
|
|
108
|
+
|
|
109
|
+
// resets user-agent stylesheets for blockquotes
|
|
110
|
+
margin-block-start: 0;
|
|
111
|
+
margin-inline-start: 0;
|
|
112
|
+
padding-left: 15px;
|
|
113
|
+
border-left: 3px solid $border-color;
|
|
114
|
+
}
|
data/_sass/code.scss
CHANGED
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.rc3
|
|
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: 2022-
|
|
12
|
+
date: 2022-10-10 00:00:00.000000000 Z
|
|
13
13
|
dependencies:
|
|
14
14
|
- !ruby/object:Gem::Dependency
|
|
15
15
|
name: bundler
|
|
@@ -96,6 +96,7 @@ files:
|
|
|
96
96
|
- _includes/nav_footer_custom.html
|
|
97
97
|
- _includes/search_placeholder_custom.html
|
|
98
98
|
- _includes/title.html
|
|
99
|
+
- _includes/toc_heading_custom.html
|
|
99
100
|
- _includes/vendor/anchor_headings.html
|
|
100
101
|
- _layouts/about.html
|
|
101
102
|
- _layouts/default.html
|