mirror of
https://github.com/snachodog/just-the-docs.git
synced 2025-09-16 06:13:32 -06:00
Compare commits
902 Commits
0.2.5
...
v0.4.0.rc5
Author | SHA1 | Date | |
---|---|---|---|
|
86dbc2d4d7 | ||
|
c7c99992f9 | ||
|
8894630659 | ||
|
4a7fbbca92 | ||
|
b2bbdb7040 | ||
|
cf72c436d9 | ||
|
6cdd4f76b5 | ||
|
c13a5d2cdf | ||
|
5f91e326c7 | ||
|
975aec0791 | ||
|
3ce3dc74e0 | ||
|
c7bdfe5456 | ||
|
81d7e13277 | ||
|
3de6c589aa | ||
|
3335b9791d | ||
|
73a7e7cb33 | ||
|
d423c96d7a | ||
|
eeb89e56f0 | ||
|
1de6260d57 | ||
|
70e55f1d7b | ||
|
7a01ef1a59 | ||
|
5e7a481258 | ||
|
a789198b20 | ||
|
ee178d7bdf | ||
|
0df627058b | ||
|
49d004f271 | ||
|
c296f914af | ||
|
c1b944bc3a | ||
|
f84e524400 | ||
|
52b43417b4 | ||
|
2691ff8a25 | ||
|
7b29f62b49 | ||
|
91c4b7e3d1 | ||
|
dd4d489f29 | ||
|
ed20aed824 | ||
|
c4bae1efb8 | ||
|
56448e86f0 | ||
|
ad490360ba | ||
|
2495d3e6bb | ||
|
4469f45cbd | ||
|
b909e083fe | ||
|
4d6cb767a9 | ||
|
89b5f4987b | ||
|
3d1f926a68 | ||
|
3ba32c5cba | ||
|
5471214cda | ||
|
9e553b3486 | ||
|
551398f92f | ||
|
8e81e21470 | ||
|
eb121804af | ||
|
7cabda2983 | ||
|
5c213c2d77 | ||
|
0bfa011b47 | ||
|
0279757ff4 | ||
|
91449f1aee | ||
|
0b44f5ba7f | ||
|
c1c44e88cf | ||
|
ce3f34bbc7 | ||
|
56bda83528 | ||
|
b6d725d42e | ||
|
f4979fa6e9 | ||
|
5921e345a5 | ||
|
fff8fef18a | ||
|
8f972e59fa | ||
|
197d18d8b4 | ||
|
253a65c04d | ||
|
12ea042bf2 | ||
|
e26bdd366b | ||
|
002387bc65 | ||
|
b050b13d01 | ||
|
c4d246f83d | ||
|
059eaee8ed | ||
|
1007fd5192 | ||
|
9bccf07faa | ||
|
b799ea8eaf | ||
|
7c3936a55d | ||
|
9996d66940 | ||
|
845cd763f3 | ||
|
cf5aa7334f | ||
|
548ddb3381 | ||
|
9f8b88b0d8 | ||
|
1ca8ac0c4d | ||
|
fb0377bae2 | ||
|
38e7566732 | ||
|
7267b0513e | ||
|
22ed2394b7 | ||
|
c498a5690a | ||
|
b09fd44d70 | ||
|
29b5d14789 | ||
|
bf6f5028af | ||
|
c278005d44 | ||
|
a1bac2d5f0 | ||
|
7a98e51adb | ||
|
ee2e324567 | ||
|
063acaca15 | ||
|
5a0bbcda2f | ||
|
945cb866f4 | ||
|
53edd7868d | ||
|
223feac30b | ||
|
8f64392424 | ||
|
6b9cc5afdf | ||
|
7c124a210a | ||
|
e269960fa8 | ||
|
6d9d41359c | ||
|
e72181e09f | ||
|
e701ce140e | ||
|
c3164b0102 | ||
|
55aa714b26 | ||
|
b4b951fe5d | ||
|
48f729541e | ||
|
33a7b2ac28 | ||
|
f1fd81dd01 | ||
|
2e48a7e6b1 | ||
|
93857587dd | ||
|
ce820828dc | ||
|
58ca9394e5 | ||
|
13a1ac2a42 | ||
|
42c81a9261 | ||
|
a7ebb450d2 | ||
|
6061dd27e1 | ||
|
e91df1e4bf | ||
|
dbe157461b | ||
|
7c82b57aa3 | ||
|
4c2d50965c | ||
|
3a77f95280 | ||
|
b99642697f | ||
|
9107f2e81e | ||
|
8a6d26ac53 | ||
|
855427186b | ||
|
4f8a3e75b2 | ||
|
b3e3eaf9dc | ||
|
1b4aef358c | ||
|
1043a34104 | ||
|
7cda88dfa3 | ||
|
e484ad03dc | ||
|
e88f7f325f | ||
|
d9594fb7d5 | ||
|
7e646caa75 | ||
|
457dce3651 | ||
|
03e1db9506 | ||
|
8333eceb0d | ||
|
9d720eb092 | ||
|
bd2af37865 | ||
|
3f89145543 | ||
|
91a894c0d4 | ||
|
e03483d8ed | ||
|
fb5161ff65 | ||
|
9454cdce68 | ||
|
84179b0a33 | ||
|
c3344441aa | ||
|
b95a717662 | ||
|
47d9c92c3a | ||
|
4bdec0bb3a | ||
|
adbc25dec5 | ||
|
4fbc960548 | ||
|
977349ceb3 | ||
|
1d7b9bf35d | ||
|
c0807be052 | ||
|
494716d8fc | ||
|
6934b63860 | ||
|
011f783fc7 | ||
|
4d790e877b | ||
|
12de167384 | ||
|
2cc1a26a0d | ||
|
ffa4ec1994 | ||
|
daa86968bb | ||
|
d364a8152e | ||
|
e2f1546c61 | ||
|
1d15ea3b84 | ||
|
d3c73eb525 | ||
|
1bef041a01 | ||
|
672c284b6f | ||
|
528141d30c | ||
|
64c909aeb3 | ||
|
b00867a831 | ||
|
a12f53b1f1 | ||
|
3ab276ba1e | ||
|
6a380039a0 | ||
|
3c14eeef2e | ||
|
9e725fc746 | ||
|
b2581c19a6 | ||
|
0a7be65c32 | ||
|
c2ec3d89c2 | ||
|
f6b22804bc | ||
|
a6f0452115 | ||
|
146ab184d8 | ||
|
2049ebc394 | ||
|
cc2110d743 | ||
|
5d4de413c0 | ||
|
ba472b9aef | ||
|
7422c87605 | ||
|
38e3ed6881 | ||
|
2e23f7b7ed | ||
|
009a0f9c5a | ||
|
6907f06977 | ||
|
3ca57e3b0d | ||
|
764dbb35a9 | ||
|
7a3c37052f | ||
|
2bfe85658b | ||
|
0ff0a4bbab | ||
|
ff3771968b | ||
|
6287d8a6da | ||
|
26fad7dd0f | ||
|
c980fd4a64 | ||
|
312f1bceac | ||
|
d083aeb3fd | ||
|
c68a19b906 | ||
|
5fd9c3b32c | ||
|
1ecc3d08e0 | ||
|
70b34f01f7 | ||
|
10388ed8b0 | ||
|
a45b328c7a | ||
|
2b4f399336 | ||
|
3a834d24ab | ||
|
6afa220a39 | ||
|
e892a261fb | ||
|
68b7c8a534 | ||
|
aac87fad27 | ||
|
260d98d825 | ||
|
4e0e3ab3d8 | ||
|
9fe92419da | ||
|
e513fd6fdb | ||
|
a14f32ceed | ||
|
e2150256f2 | ||
|
b0ed390a9f | ||
|
00d3b4fe5a | ||
|
45120c8742 | ||
|
2136b55a52 | ||
|
25de2c03a3 | ||
|
c589be462e | ||
|
4dfe5273f2 | ||
|
351a0b7ff4 | ||
|
e8ba44167c | ||
|
444512c06a | ||
|
ac91b2dd1c | ||
|
89fb42dc66 | ||
|
9fa3a0fc5f | ||
|
577b9c5862 | ||
|
0f3d0e8285 | ||
|
37e90d2676 | ||
|
655335d552 | ||
|
ee47119f31 | ||
|
4dedfe0b50 | ||
|
7e111fa8c2 | ||
|
1032a0aae3 | ||
|
3eb4ceb59a | ||
|
0519013521 | ||
|
aae3d0309f | ||
|
6f8ae3e97e | ||
|
7f354d47a3 | ||
|
f8331f1c26 | ||
|
25aa612617 | ||
|
2692e6714c | ||
|
bc4a91c61a | ||
|
fbf125d525 | ||
|
265e88ed7a | ||
|
501c007da1 | ||
|
79f30a22bc | ||
|
13298d20c0 | ||
|
7631aaa309 | ||
|
fac7af13c1 | ||
|
2aa9815064 | ||
|
978846f704 | ||
|
c2f78516b4 | ||
|
04ae951436 | ||
|
404059ab03 | ||
|
e842498637 | ||
|
7f5ebee9b8 | ||
|
cb7df09c8f | ||
|
8bc53f8f45 | ||
|
4ab61105b9 | ||
|
5a78a7d39b | ||
|
5665097fc2 | ||
|
9d4a0a56b7 | ||
|
9e52e712ae | ||
|
487a5a680a | ||
|
e7ff383397 | ||
|
4de9962c72 | ||
|
85af5b81c5 | ||
|
bd1f741d6d | ||
|
fdb93755d1 | ||
|
58aea7a29b | ||
|
bb1cd2aaac | ||
|
863d13fc8e | ||
|
37bbacbaa9 | ||
|
ce0da9e848 | ||
|
7d35ccb333 | ||
|
f67b4ca2a1 | ||
|
9f4968fcb4 | ||
|
bdbbf56b36 | ||
|
1e468b4bff | ||
|
215655187f | ||
|
59d3981580 | ||
|
32afb2a983 | ||
|
80e05938c7 | ||
|
59f757a790 | ||
|
2e377e45ac | ||
|
5d1609b888 | ||
|
641fa6ac5c | ||
|
09ab1c3131 | ||
|
682dcf4ec1 | ||
|
405180c863 | ||
|
aa247408e4 | ||
|
39ee88299a | ||
|
516a660149 | ||
|
fd6c999920 | ||
|
b89ab93a88 | ||
|
76f8f064ac | ||
|
0513c1930a | ||
|
1f30d6bf78 | ||
|
916a9256b1 | ||
|
84e67c34b7 | ||
|
1b0a313c16 | ||
|
c587c0b217 | ||
|
e4246b35b0 | ||
|
68d5c56cf3 | ||
|
f76b891038 | ||
|
9260e59255 | ||
|
e0f7dea67f | ||
|
575b9237f9 | ||
|
d4da8e7e46 | ||
|
ada962d917 | ||
|
f518ff3caa | ||
|
020a50acff | ||
|
985bdc02ca | ||
|
000da77ba2 | ||
|
f774596f5e | ||
|
5cc5ae5edf | ||
|
1c654bad4b | ||
|
d59887cc2b | ||
|
fea9ae2b07 | ||
|
ddccec7bb7 | ||
|
cd8d173935 | ||
|
02763e69d9 | ||
|
d07589a9ee | ||
|
2abf8662b6 | ||
|
d0a9cd38dd | ||
|
322026633f | ||
|
a9842d2846 | ||
|
db32b66ce9 | ||
|
3726697fab | ||
|
793a7247db | ||
|
cdfad69c5b | ||
|
55f80acb4f | ||
|
ca367e09d5 | ||
|
591a3c2351 | ||
|
cfbdee1168 | ||
|
cff0254d93 | ||
|
e4759daecf | ||
|
a7be52df3b | ||
|
4fc59a578f | ||
|
bb8c387899 | ||
|
74da664c0a | ||
|
6ac67d2228 | ||
|
7883789d94 | ||
|
101dd2efdc | ||
|
6be8a2e38a | ||
|
54c921cbcd | ||
|
169fa727a3 | ||
|
c11814bb7e | ||
|
264c99b311 | ||
|
5be5d629ff | ||
|
83ec553348 | ||
|
98b22be66b | ||
|
f1475cf012 | ||
|
d2d3609dea | ||
|
eb98fe0eeb | ||
|
9fca3861ce | ||
|
d4adef025e | ||
|
5258835588 | ||
|
ff40b7881a | ||
|
86061c80a4 | ||
|
2c4304c125 | ||
|
cd192aa4e2 | ||
|
19d6bcf5d3 | ||
|
248328670b | ||
|
721f322e41 | ||
|
e358b8d914 | ||
|
f91a33e43f | ||
|
c54be05b8a | ||
|
31b99a2a9b | ||
|
96fffcc59d | ||
|
584506785b | ||
|
12985168cf | ||
|
9dd1cde227 | ||
|
0a26b95749 | ||
|
8ff2e57796 | ||
|
35ddf7c694 | ||
|
923f021381 | ||
|
46aa1134a8 | ||
|
9edd8d5c50 | ||
|
5dd6324f61 | ||
|
a086954c51 | ||
|
b32c00a701 | ||
|
6b27beaf58 | ||
|
9faba6cd91 | ||
|
7dec48433b | ||
|
b4b74f7e1d | ||
|
d1c3e08337 | ||
|
d476ce5748 | ||
|
93f93f48a7 | ||
|
a855af3db3 | ||
|
8a9a8a345d | ||
|
029ba12559 | ||
|
d13ac2fe5b | ||
|
61053f677b | ||
|
a4b862aa4b | ||
|
305bed7cd5 | ||
|
654da0a6ef | ||
|
a8f8f8445a | ||
|
49ef043ebb | ||
|
b5cd532435 | ||
|
b73300595b | ||
|
fdaf5a276b | ||
|
bf31b8b9a0 | ||
|
74845b4a0e | ||
|
7df7572d91 | ||
|
b41f28dade | ||
|
5a96a218b3 | ||
|
50d727871e | ||
|
1bdd849d86 | ||
|
5277d14547 | ||
|
2101701aad | ||
|
845261205f | ||
|
c8bbcc2d9b | ||
|
e8d60818ed | ||
|
d24b06ad73 | ||
|
d90482d719 | ||
|
72b6de8862 | ||
|
1f492b68f3 | ||
|
fb0faee220 | ||
|
d3d17c0460 | ||
|
972da61cf9 | ||
|
ab9fd6453b | ||
|
2ef11e3701 | ||
|
3382a954d2 | ||
|
848b090d06 | ||
|
8700916a93 | ||
|
13d01a6561 | ||
|
2efc206d02 | ||
|
20222fe0a7 | ||
|
c4d5f4f6b0 | ||
|
12536de881 | ||
|
c895d5ecd9 | ||
|
b8602eb05d | ||
|
8715224655 | ||
|
87a59ef8ef | ||
|
cba7303660 | ||
|
5def3aee43 | ||
|
53a5feb11b | ||
|
17c140da35 | ||
|
e29a540a59 | ||
|
45af827e0a | ||
|
040bef90bb | ||
|
160cc42e4e | ||
|
e181626b66 | ||
|
88759c1cf7 | ||
|
d7050b3f04 | ||
|
597c534279 | ||
|
3f0b7254a2 | ||
|
868bb0e3ac | ||
|
1e73c69700 | ||
|
5ec0044b72 | ||
|
15f9f52a77 | ||
|
f2aa3c9a4d | ||
|
397e4a6933 | ||
|
171ff71a2b | ||
|
e4a29e54ec | ||
|
eadd46c6e4 | ||
|
d3c389ccc5 | ||
|
16c18c1020 | ||
|
b31355691f | ||
|
3eaa0155d1 | ||
|
6c4d47cae4 | ||
|
8102af2cd4 | ||
|
8c77c24959 | ||
|
f2ac995815 | ||
|
1cf7d5aba9 | ||
|
ed618caf70 | ||
|
51f15965f2 | ||
|
16628f2b8e | ||
|
0421ab7f82 | ||
|
b7a5458375 | ||
|
da9276121a | ||
|
18f3a41600 | ||
|
e216623ed3 | ||
|
c7466e88a8 | ||
|
7cfc63e138 | ||
|
85fa222f49 | ||
|
798c14b46a | ||
|
5fbfe09ce9 | ||
|
439d1d6769 | ||
|
ddf0095a3e | ||
|
2d9b17070a | ||
|
992b38f7de | ||
|
7fdf886d15 | ||
|
5c2087c61b | ||
|
34ed214ef6 | ||
|
09ea2e5ae8 | ||
|
5ea1b339ce | ||
|
6345c61aae | ||
|
e40ba9c6c5 | ||
|
bf031eb68b | ||
|
d9b2822448 | ||
|
0033934409 | ||
|
beb88adf5f | ||
|
f664d410d7 | ||
|
411c508806 | ||
|
2f13db1f01 | ||
|
ff5047e523 | ||
|
d7e57de985 | ||
|
d39c922806 | ||
|
611a4c51a9 | ||
|
10d6abd356 | ||
|
9428b93c3d | ||
|
5915b2fef5 | ||
|
424f9a8ee9 | ||
|
484563b297 | ||
|
e97b718f5d | ||
|
561f930e83 | ||
|
73ad860f8e | ||
|
41a74d247d | ||
|
30e1ddcdae | ||
|
b4c278cb8f | ||
|
6d487845a4 | ||
|
7fd8f6379a | ||
|
431b6cb4a2 | ||
|
0ea28edc71 | ||
|
3dd97d29c2 | ||
|
16e83704d0 | ||
|
12900d8ed1 | ||
|
b7fe6e0318 | ||
|
b9f89fcd9f | ||
|
70c36d8aad | ||
|
ee44f699ec | ||
|
30b5da451c | ||
|
6066d22c82 | ||
|
176ffc8e60 | ||
|
b51decd020 | ||
|
fad434bc74 | ||
|
d00aadeee7 | ||
|
c46ccd3484 | ||
|
7e959f4b69 | ||
|
c071901629 | ||
|
0a81a86447 | ||
|
ec75fa4f02 | ||
|
91808528c9 | ||
|
2539ed54a8 | ||
|
bbd559e11d | ||
|
37fe8ca412 | ||
|
d02f668309 | ||
|
955ac23149 | ||
|
59d4802ce3 | ||
|
bc08659f50 | ||
|
6edea8eb54 | ||
|
d56b22a3ec | ||
|
3ff76320ce | ||
|
02d3d3d825 | ||
|
7e28608e9d | ||
|
6501990a44 | ||
|
252e69f5cf | ||
|
94f5d6b018 | ||
|
d07d465005 | ||
|
0ba819bb2d | ||
|
8340f9acd0 | ||
|
0716ea77d6 | ||
|
c06eae8fa3 | ||
|
5152912e5c | ||
|
17cf72bd33 | ||
|
c818624363 | ||
|
9cf4451ea1 | ||
|
4197c26a36 | ||
|
cf748e7ef5 | ||
|
ec64bc1dce | ||
|
f3f3179644 | ||
|
db17dbac36 | ||
|
0c6d96abc3 | ||
|
bb36aac6bc | ||
|
d26bb0fa8f | ||
|
3bd33abe5d | ||
|
73e658c34e | ||
|
3cd3fc8fe0 | ||
|
bc04ce25e6 | ||
|
3407f6c995 | ||
|
4da45d677c | ||
|
7f1ffd393e | ||
|
25ffab718a | ||
|
a586e2b8d1 | ||
|
0ba4685ee1 | ||
|
4c022bd9ac | ||
|
b27f5162c8 | ||
|
835526b901 | ||
|
2ec9e67ec9 | ||
|
1819d29c5b | ||
|
15674dae97 | ||
|
9f6a700d6e | ||
|
0507f77f4e | ||
|
3b2a55fd10 | ||
|
2faa91f235 | ||
|
60756a592d | ||
|
eecc51062b | ||
|
5d3b88a1e1 | ||
|
17153f001f | ||
|
8d54896986 | ||
|
0680935092 | ||
|
a11eaff97e | ||
|
8fd6eddcfd | ||
|
463678623f | ||
|
0ff319b2ba | ||
|
e0032e07a5 | ||
|
eb6bba7fda | ||
|
fd50bb31a3 | ||
|
db2b790a69 | ||
|
48b1ab47b6 | ||
|
3c584e2d8a | ||
|
81aad708f3 | ||
|
ec3bfecc1f | ||
|
fbbf6a5d01 | ||
|
b4711bfdf7 | ||
|
74459588c9 | ||
|
4a209f7f80 | ||
|
e5f53a8bfd | ||
|
1a0758dc13 | ||
|
71afb627d3 | ||
|
0892c32a1b | ||
|
7a7ce5ef7e | ||
|
cf78195f16 | ||
|
a04f45dadd | ||
|
d70aa54ba7 | ||
|
ac259f90d8 | ||
|
f5e6573e16 | ||
|
aa8ca74883 | ||
|
6f2065aa57 | ||
|
672de29f2e | ||
|
da79e3e214 | ||
|
9b86e292fa | ||
|
e2e01effa6 | ||
|
b13b44f18b | ||
|
d357532b4e | ||
|
157e3ff945 | ||
|
19e35329d2 | ||
|
757742e79c | ||
|
538591dddb | ||
|
a3d8c14609 | ||
|
f1c306c814 | ||
|
74681aeb21 | ||
|
c907e79251 | ||
|
82b3f15443 | ||
|
2ef0029068 | ||
|
ff30552748 | ||
|
7f5b1f14f1 | ||
|
38689d07b1 | ||
|
0b4ed96f58 | ||
|
b5c13965a7 | ||
|
3576cb4a89 | ||
|
a6f2ed8c6c | ||
|
8310df593c | ||
|
1d1564e5c0 | ||
|
9d24b14ba1 | ||
|
ab7e53b63f | ||
|
abb7f55794 | ||
|
c057771cca | ||
|
804cad6c4d | ||
|
d66ebdec4b | ||
|
5d87f3a9df | ||
|
0c9678c2e6 | ||
|
09944de128 | ||
|
73047a078f | ||
|
cf64965554 | ||
|
4bb8d7612d | ||
|
078696415e | ||
|
03979bf8fc | ||
|
301a4ab644 | ||
|
fd91140923 | ||
|
bb0e5222ca | ||
|
33d1e0f8d7 | ||
|
5f50531cce | ||
|
f978770956 | ||
|
367db86fff | ||
|
94c1dc3736 | ||
|
2c94928917 | ||
|
25331a5ffa | ||
|
65e2759910 | ||
|
c09f86cd1d | ||
|
102d74c782 | ||
|
06853e895a | ||
|
210e060f18 | ||
|
6660f442b0 | ||
|
5549a15df9 | ||
|
a371a79f41 | ||
|
06e61cb2bb | ||
|
9c4622d75f | ||
|
d3e97d31fa | ||
|
e917ea1f10 | ||
|
4ff38dbe9c | ||
|
97efc81fa9 | ||
|
5fdb8f2e10 | ||
|
8bd2da55fe | ||
|
4ca741b1ce | ||
|
e6896e1997 | ||
|
492471b15f | ||
|
efe5918871 | ||
|
56e8119665 | ||
|
8dbe7209b9 | ||
|
72741e9498 | ||
|
5391eb0a13 | ||
|
20c7b97b3e | ||
|
1476259d9b | ||
|
00c96ac2de | ||
|
f2ce1b33c1 | ||
|
afbb385042 | ||
|
35da800e88 | ||
|
54d9738dd1 | ||
|
c5e53d90c9 | ||
|
01a3c35c98 | ||
|
b49829c784 | ||
|
95bdc51a0a | ||
|
1cca7a8e88 | ||
|
2c73d71c1b | ||
|
722717a0d1 | ||
|
be5822cb86 | ||
|
7c8ead0bff | ||
|
41187ed9b6 | ||
|
3ae06cd59b | ||
|
7804642c50 | ||
|
b44ebe6cb3 | ||
|
423b8c9f46 | ||
|
a7285b9e30 | ||
|
119a0b241e | ||
|
ff106641b0 | ||
|
900639b02c | ||
|
dbac62127a | ||
|
850a8fe256 | ||
|
44d689b994 | ||
|
9616dcf761 | ||
|
1564ca4511 | ||
|
e124e10914 | ||
|
757be1631c | ||
|
3b42ec2762 | ||
|
a98bba778c | ||
|
3ecdb59b48 | ||
|
843233c6b2 | ||
|
d3cbc83285 | ||
|
f960695bb7 | ||
|
34eaf8b16d | ||
|
ea9affe25f | ||
|
d3f6e5907b | ||
|
3d0240ff0b | ||
|
1aee233e1f | ||
|
47b7991805 | ||
|
7220197a1f | ||
|
4e65041849 | ||
|
50cdf076b4 | ||
|
ed492bf40e | ||
|
690d0b5e8a | ||
|
5b74b44230 | ||
|
8a1e09ec5a | ||
|
cfbc7f41df | ||
|
5e72b7db67 | ||
|
3af59176f4 | ||
|
13ef185010 | ||
|
7382a9a379 | ||
|
209ac7be7d | ||
|
89f79138c3 | ||
|
5d58a66301 | ||
|
c282e4b0a7 | ||
|
8ac545a5eb | ||
|
3ed2d586fd | ||
|
95498ccaf8 | ||
|
91760ee8c9 | ||
|
132cecfea3 | ||
|
0cfc0f0357 | ||
|
bc1cbc1ae4 | ||
|
887a18daa0 | ||
|
7c93bcc48f | ||
|
936a1e63be | ||
|
cc0b57727d | ||
|
52bcb26ddd | ||
|
e13a62b7b5 | ||
|
a5842c0d7b | ||
|
6bd43a1332 | ||
|
8e6e3dddd3 | ||
|
bf86c33fe1 | ||
|
8a3458bafd | ||
|
0ebbe4bb4e | ||
|
0a8138a6e0 | ||
|
ec420a385b | ||
|
721ca36d85 | ||
|
183778067b | ||
|
ee8b901bcb | ||
|
6a46a4797e | ||
|
89a331ee85 | ||
|
d4b79e2eac | ||
|
d549d37e6f | ||
|
2febd256db | ||
|
3995fbfc35 | ||
|
6c569cbdc2 | ||
|
9e0bc86dbe | ||
|
5f0de692be | ||
|
da50250f47 | ||
|
f61b836f6e | ||
|
cba53a6914 | ||
|
fdf4726320 | ||
|
de37d60720 | ||
|
418cf1d640 | ||
|
13427409aa | ||
|
26c16ce57e | ||
|
d01f0e29db | ||
|
dfc5d112e5 | ||
|
c5cb03d0ca | ||
|
61a5a3b334 | ||
|
2b3da2f75c | ||
|
e17ae1fc54 | ||
|
d37387d408 | ||
|
8726625133 | ||
|
03a89b761a | ||
|
f6a3126543 | ||
|
f4bd41a27d | ||
|
2db3f97395 | ||
|
385e26a2d0 | ||
|
5ad439b53c | ||
|
c4586e1725 | ||
|
15172af270 | ||
|
f2cec110ff | ||
|
1a2636350f | ||
|
225604723a | ||
|
fe41e18994 | ||
|
3eadd49ee7 | ||
|
b1072a3fca | ||
|
c227db4406 | ||
|
4a574a2ec2 | ||
|
8e5b0f23e6 | ||
|
5867dc078f | ||
|
e370654237 | ||
|
d0325e948e | ||
|
2b2ebf6033 | ||
|
7fa6307640 | ||
|
9e45626337 | ||
|
15f1faae8a | ||
|
8d60dda67e | ||
|
da9c187acc | ||
|
8dbe56fe1f | ||
|
1bf2ed0cde | ||
|
30590fd6c9 | ||
|
15a9b310b3 | ||
|
4f5930dbbe | ||
|
3ad99afb02 | ||
|
efbc5c2a19 | ||
|
14a3ff5fc8 | ||
|
529c789739 | ||
|
b89b683f90 | ||
|
aa0d8f1d40 | ||
|
b6bfd436b9 | ||
|
07982f681a | ||
|
2d1babc452 | ||
|
eabe7b2585 | ||
|
0108a9b254 | ||
|
9682368eaf | ||
|
761245d487 | ||
|
4821abeec4 | ||
|
c8a8ce3314 | ||
|
044281db38 | ||
|
008809e00b | ||
|
96653f6d36 | ||
|
9495640378 | ||
|
447ba4f20c | ||
|
48a4a37977 | ||
|
6f225b0d28 | ||
|
e64a6aa239 | ||
|
e9f016ac0f | ||
|
8c603aac1e | ||
|
0142d2874b | ||
|
94f2aaf964 | ||
|
03e2345833 | ||
|
f4ee29d0c3 | ||
|
b3f52fedad | ||
|
721484a26e | ||
|
3d01578c7d | ||
|
9663d4cba3 | ||
|
552bf46bc9 | ||
|
6c5d550fa5 | ||
|
0f2de675b6 | ||
|
38521bd845 | ||
|
a4da666d2a | ||
|
f1dcbec0a9 | ||
|
e6f6001960 | ||
|
501bd0169c | ||
|
f06cf593ff | ||
|
460e9ae236 | ||
|
4d3375a834 | ||
|
3a3c4a83fa | ||
|
0254d9961a | ||
|
d2b3d57eb9 | ||
|
32401d05a3 | ||
|
9fb4bcfdc2 | ||
|
2328407405 | ||
|
b82b1a86d3 | ||
|
c520591234 | ||
|
0b0b2e8555 | ||
|
26766a5984 | ||
|
eec213daa1 | ||
|
c796485d92 |
14
.devcontainer/Dockerfile
Normal file
14
.devcontainer/Dockerfile
Normal file
@@ -0,0 +1,14 @@
|
|||||||
|
# [Choice] Debian OS version (use bullseye on local arm64/Apple Silicon): bullseye, buster
|
||||||
|
ARG VARIANT=bullseye
|
||||||
|
FROM mcr.microsoft.com/vscode/devcontainers/jekyll:0-${VARIANT}
|
||||||
|
|
||||||
|
# [Choice] Node.js version: none, lts/*, 16, 14, 12, 10
|
||||||
|
ARG NODE_VERSION="none"
|
||||||
|
RUN if [ "${NODE_VERSION}" != "none" ]; then su vscode -c "umask 0002 && . /usr/local/share/nvm/nvm.sh && nvm install ${NODE_VERSION} 2>&1"; fi
|
||||||
|
|
||||||
|
# [Optional] Uncomment this section to install additional OS packages.
|
||||||
|
# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
|
||||||
|
# && apt-get -y install --no-install-recommends <your-package-list-here>
|
||||||
|
|
||||||
|
# [Optional] Uncomment this line to install global node packages.
|
||||||
|
# RUN su vscode -c "source /usr/local/share/nvm/nvm.sh && npm install -g <your-package-here>" 2>&1
|
26
.devcontainer/base.Dockerfile
Normal file
26
.devcontainer/base.Dockerfile
Normal file
@@ -0,0 +1,26 @@
|
|||||||
|
# [Choice] Debian OS version (use 2.7-bullseye on local arm64/Apple Silicon): 2.7-bullseye, 2.7-buster
|
||||||
|
ARG VARIANT=2.7-bullseye
|
||||||
|
FROM mcr.microsoft.com/vscode/devcontainers/ruby:${VARIANT}
|
||||||
|
COPY library-scripts/meta.env /usr/local/etc/vscode-dev-containers
|
||||||
|
|
||||||
|
# ENV Variables required by Jekyll
|
||||||
|
ENV LANG=en_US.UTF-8 \
|
||||||
|
LANGUAGE=en_US:en \
|
||||||
|
TZ=Etc/UTC \
|
||||||
|
LC_ALL=en_US.UTF-8 \
|
||||||
|
LANG=en_US.UTF-8 \
|
||||||
|
LANGUAGE=en_US
|
||||||
|
|
||||||
|
# Install bundler, latest jekyll, and github-pages for older jekyll
|
||||||
|
RUN gem install bundler jekyll github-pages
|
||||||
|
|
||||||
|
# [Choice] Node.js version: none, lts/*, 16, 14, 12, 10
|
||||||
|
ARG NODE_VERSION="none"
|
||||||
|
RUN if [ "${NODE_VERSION}" != "none" ]; then su vscode -c "umask 0002 && . /usr/local/share/nvm/nvm.sh && nvm install ${NODE_VERSION} 2>&1"; fi
|
||||||
|
|
||||||
|
# [Optional] Uncomment this section to install additional OS packages.
|
||||||
|
# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
|
||||||
|
# && apt-get -y install --no-install-recommends <your-package-list-here>
|
||||||
|
|
||||||
|
# [Optional] Uncomment this line to install global node packages.
|
||||||
|
# RUN su vscode -c "source /usr/local/share/nvm/nvm.sh && npm install -g <your-package-here>" 2>&1
|
35
.devcontainer/devcontainer.json
Normal file
35
.devcontainer/devcontainer.json
Normal file
@@ -0,0 +1,35 @@
|
|||||||
|
// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at:
|
||||||
|
// https://github.com/microsoft/vscode-dev-containers/tree/v0.224.2/containers/jekyll
|
||||||
|
{
|
||||||
|
"name": "Just the docs",
|
||||||
|
"build": {
|
||||||
|
"dockerfile": "Dockerfile",
|
||||||
|
"args": {
|
||||||
|
// Update 'VARIANT' to pick a Debian OS version: bullseye, buster
|
||||||
|
// Use bullseye when on local arm64/Apple Silicon.
|
||||||
|
"VARIANT": "bullseye",
|
||||||
|
// Enable Node.js: pick the latest LTS version
|
||||||
|
"NODE_VERSION": "lts/*"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
|
||||||
|
// Set *default* container specific settings.json values on container create.
|
||||||
|
"settings": {},
|
||||||
|
|
||||||
|
// Add the IDs of extensions you want installed when the container is created.
|
||||||
|
"extensions": ["GitHub.vscode-pull-request-github"],
|
||||||
|
|
||||||
|
// Use 'forwardPorts' to make a list of ports inside the container available locally.
|
||||||
|
"forwardPorts": [
|
||||||
|
// Jekyll server
|
||||||
|
4000,
|
||||||
|
// Live reload server
|
||||||
|
35729
|
||||||
|
],
|
||||||
|
|
||||||
|
// Use 'postCreateCommand' to run commands after the container is created.
|
||||||
|
"postCreateCommand": "sh .devcontainer/post-create.sh",
|
||||||
|
|
||||||
|
// Comment out to connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
|
||||||
|
"remoteUser": "vscode"
|
||||||
|
}
|
12
.devcontainer/post-create.sh
Normal file
12
.devcontainer/post-create.sh
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
#!/bin/sh
|
||||||
|
|
||||||
|
# Install the version of Bundler.
|
||||||
|
if [ -f Gemfile.lock ] && grep "BUNDLED WITH" Gemfile.lock > /dev/null; then
|
||||||
|
cat Gemfile.lock | tail -n 2 | grep -C2 "BUNDLED WITH" | tail -n 1 | xargs gem install bundler -v
|
||||||
|
fi
|
||||||
|
|
||||||
|
# If there's a Gemfile, then run `bundle install`
|
||||||
|
# It's assumed that the Gemfile will install Jekyll too
|
||||||
|
if [ -f Gemfile ]; then
|
||||||
|
bundle install
|
||||||
|
fi
|
5
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
5
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
@@ -0,0 +1,5 @@
|
|||||||
|
blank_issues_enabled: false
|
||||||
|
contact_links:
|
||||||
|
- name: Ask a question
|
||||||
|
url: https://github.com/just-the-docs/just-the-docs/discussions
|
||||||
|
about: Ask questions and discuss with other community members
|
14
.github/dependabot.yml
vendored
Normal file
14
.github/dependabot.yml
vendored
Normal file
@@ -0,0 +1,14 @@
|
|||||||
|
version: 2
|
||||||
|
updates:
|
||||||
|
- package-ecosystem: npm
|
||||||
|
directory: "/"
|
||||||
|
schedule:
|
||||||
|
interval: daily
|
||||||
|
time: "10:00"
|
||||||
|
open-pull-requests-limit: 10
|
||||||
|
- package-ecosystem: bundler
|
||||||
|
directory: "/"
|
||||||
|
schedule:
|
||||||
|
interval: daily
|
||||||
|
time: "10:00"
|
||||||
|
open-pull-requests-limit: 10
|
16
.github/main.workflow
vendored
16
.github/main.workflow
vendored
@@ -1,16 +0,0 @@
|
|||||||
workflow "Publish to RubyGems" {
|
|
||||||
on = "release"
|
|
||||||
resolves = ["scarhand/actions-ruby@master"]
|
|
||||||
}
|
|
||||||
|
|
||||||
action "Build from Gemspec" {
|
|
||||||
uses = "scarhand/actions-ruby@master"
|
|
||||||
runs = "build *.gemspec"
|
|
||||||
}
|
|
||||||
|
|
||||||
action "scarhand/actions-ruby@master" {
|
|
||||||
uses = "scarhand/actions-ruby@master"
|
|
||||||
needs = ["Build from Gemspec"]
|
|
||||||
runs = "push *.gem"
|
|
||||||
secrets = ["RUBYGEMS_AUTH_TOKEN"]
|
|
||||||
}
|
|
35
.github/release-drafter.yml
vendored
Normal file
35
.github/release-drafter.yml
vendored
Normal file
@@ -0,0 +1,35 @@
|
|||||||
|
references:
|
||||||
|
- v+
|
||||||
|
- main
|
||||||
|
name-template: "v$RESOLVED_VERSION 🌈"
|
||||||
|
tag-template: "v$RESOLVED_VERSION"
|
||||||
|
categories:
|
||||||
|
- title: "🚀 Features"
|
||||||
|
labels:
|
||||||
|
- "feature"
|
||||||
|
- "enhancement"
|
||||||
|
- title: "🐛 Bug Fixes"
|
||||||
|
labels:
|
||||||
|
- "fix"
|
||||||
|
- "bugfix"
|
||||||
|
- "bug"
|
||||||
|
- title: "🧰 Maintenance"
|
||||||
|
label:
|
||||||
|
- "chore"
|
||||||
|
- "dependencies"
|
||||||
|
change-template: "- $TITLE @$AUTHOR (#$NUMBER)"
|
||||||
|
version-resolver:
|
||||||
|
major:
|
||||||
|
labels:
|
||||||
|
- "next-major-release"
|
||||||
|
minor:
|
||||||
|
labels:
|
||||||
|
- "next-minor-release"
|
||||||
|
patch:
|
||||||
|
labels:
|
||||||
|
- "patch"
|
||||||
|
default: minor
|
||||||
|
template: |
|
||||||
|
## Changes
|
||||||
|
|
||||||
|
$CHANGES
|
50
.github/workflows/ci.yml
vendored
Normal file
50
.github/workflows/ci.yml
vendored
Normal file
@@ -0,0 +1,50 @@
|
|||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- main
|
||||||
|
pull_request:
|
||||||
|
branches:
|
||||||
|
- main
|
||||||
|
- 'v**'
|
||||||
|
|
||||||
|
name: CI
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
jekyll-build:
|
||||||
|
name: Build Jekyll site
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
strategy:
|
||||||
|
matrix:
|
||||||
|
jekyll-version: [3.9, 4.3]
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v3
|
||||||
|
- name: Setup Ruby
|
||||||
|
uses: ruby/setup-ruby@v1
|
||||||
|
with:
|
||||||
|
ruby-version: '3.1' # Not needed with a .ruby-version file
|
||||||
|
bundler-cache: false
|
||||||
|
- name: Bundle Install
|
||||||
|
run: bundle install
|
||||||
|
- name: Install Jekyll ${{ matrix.jekyll-version }}
|
||||||
|
run: gem install jekyll -v ${{ matrix.jekyll-version }}
|
||||||
|
- name: Init Search
|
||||||
|
run: bundle exec rake search:init
|
||||||
|
- name: Build Site
|
||||||
|
run: bundle exec jekyll build
|
||||||
|
|
||||||
|
assets:
|
||||||
|
name: Test CSS and JS
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
|
||||||
|
strategy:
|
||||||
|
matrix:
|
||||||
|
node-version: [18.x]
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v3
|
||||||
|
- name: Use Node.js ${{ matrix.node-version }}
|
||||||
|
uses: actions/setup-node@v1
|
||||||
|
with:
|
||||||
|
node-version: ${{ matrix.node-version }}
|
||||||
|
- run: npm install
|
||||||
|
- run: npm test
|
62
.github/workflows/deploy.yml
vendored
Normal file
62
.github/workflows/deploy.yml
vendored
Normal file
@@ -0,0 +1,62 @@
|
|||||||
|
# This workflow uses actions that are not certified by GitHub.
|
||||||
|
# They are provided by a third-party and are governed by
|
||||||
|
# separate terms of service, privacy policy, and support
|
||||||
|
# documentation.
|
||||||
|
|
||||||
|
# Sample workflow for building and deploying a Jekyll site to GitHub Pages
|
||||||
|
name: Deploy Jekyll site to Pages
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches: ["main"]
|
||||||
|
|
||||||
|
# Allows you to run this workflow manually from the Actions tab
|
||||||
|
workflow_dispatch:
|
||||||
|
|
||||||
|
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
|
||||||
|
permissions:
|
||||||
|
contents: read
|
||||||
|
pages: write
|
||||||
|
id-token: write
|
||||||
|
|
||||||
|
# Allow one concurrent deployment
|
||||||
|
concurrency:
|
||||||
|
group: "pages"
|
||||||
|
cancel-in-progress: true
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
# Build job
|
||||||
|
build:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- name: Checkout
|
||||||
|
uses: actions/checkout@v3
|
||||||
|
- name: Setup Ruby
|
||||||
|
uses: ruby/setup-ruby@v1
|
||||||
|
with:
|
||||||
|
ruby-version: '3.1' # Not needed with a .ruby-version file
|
||||||
|
bundler-cache: true # runs 'bundle install' and caches installed gems automatically
|
||||||
|
cache-version: 0 # Increment this number if you need to re-download cached gems
|
||||||
|
- name: Setup Pages
|
||||||
|
id: pages
|
||||||
|
uses: actions/configure-pages@v2
|
||||||
|
- name: Build with Jekyll
|
||||||
|
# Outputs to the './_site' directory by default
|
||||||
|
run: bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}"
|
||||||
|
env:
|
||||||
|
JEKYLL_ENV: production
|
||||||
|
- name: Upload artifact
|
||||||
|
# Automatically uploads an artifact from the './_site' directory by default
|
||||||
|
uses: actions/upload-pages-artifact@v1
|
||||||
|
|
||||||
|
# Deployment job
|
||||||
|
deploy:
|
||||||
|
environment:
|
||||||
|
name: github-pages
|
||||||
|
url: ${{ steps.deployment.outputs.page_url }}
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
needs: build
|
||||||
|
steps:
|
||||||
|
- name: Deploy to GitHub Pages
|
||||||
|
id: deployment
|
||||||
|
uses: actions/deploy-pages@v1
|
39
.github/workflows/publish-gem.yml
vendored
Normal file
39
.github/workflows/publish-gem.yml
vendored
Normal file
@@ -0,0 +1,39 @@
|
|||||||
|
name: Publish Ruby Gem
|
||||||
|
|
||||||
|
on:
|
||||||
|
workflow_dispatch
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
build:
|
||||||
|
name: Publish
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v3
|
||||||
|
- name: Set up Ruby 3.1
|
||||||
|
uses: actions/setup-ruby@v1
|
||||||
|
with:
|
||||||
|
ruby-version: 3.1
|
||||||
|
|
||||||
|
- name: Publish to GPR
|
||||||
|
run: |
|
||||||
|
mkdir -p $HOME/.gem
|
||||||
|
touch $HOME/.gem/credentials
|
||||||
|
chmod 0600 $HOME/.gem/credentials
|
||||||
|
printf -- "---\n:github: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
|
||||||
|
gem build *.gemspec
|
||||||
|
gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} *.gem
|
||||||
|
env:
|
||||||
|
GEM_HOST_API_KEY: "Bearer ${{secrets.GITHUB_TOKEN}}"
|
||||||
|
OWNER: ${{ github.repository_owner }}
|
||||||
|
|
||||||
|
- name: Publish to RubyGems
|
||||||
|
run: |
|
||||||
|
mkdir -p $HOME/.gem
|
||||||
|
touch $HOME/.gem/credentials
|
||||||
|
chmod 0600 $HOME/.gem/credentials
|
||||||
|
printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
|
||||||
|
gem build *.gemspec
|
||||||
|
gem push *.gem
|
||||||
|
env:
|
||||||
|
GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"
|
43
.github/workflows/update_jekyll-anchor-heading.yml
vendored
Normal file
43
.github/workflows/update_jekyll-anchor-heading.yml
vendored
Normal file
@@ -0,0 +1,43 @@
|
|||||||
|
name: Update Vendor plugin - jekyll-anchor-headings
|
||||||
|
on:
|
||||||
|
# schedule:
|
||||||
|
# # once per week
|
||||||
|
# - cron: "0 15 * * 0"
|
||||||
|
workflow_dispatch:
|
||||||
|
jobs:
|
||||||
|
update-deps:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v2
|
||||||
|
|
||||||
|
- name: Get latest release information
|
||||||
|
id: latest-release
|
||||||
|
uses: pozetroninc/github-action-get-latest-release@master
|
||||||
|
with:
|
||||||
|
owner: allejo
|
||||||
|
repo: jekyll-anchor-headings
|
||||||
|
excludes: prerelease, draft
|
||||||
|
|
||||||
|
- name: Update jekyll-anchor-headings
|
||||||
|
id: update
|
||||||
|
uses: suisei-cn/actions-download-file@v1.3.0
|
||||||
|
with:
|
||||||
|
url: "https://github.com/allejo/jekyll-anchor-headings/releases/download/${{ steps.latest-release.outputs.release }}/anchor_headings.html"
|
||||||
|
target: _includes/vendor/
|
||||||
|
|
||||||
|
- name: Create PR
|
||||||
|
uses: peter-evans/create-pull-request@v4
|
||||||
|
with:
|
||||||
|
commit-message: "chore[dependency]: Update `jekyll-anchor-headings` to `${{ steps.latest-release.outputs.release }}`"
|
||||||
|
title: "auto: Update `jekyll-anchor-headings` to `${{ steps.latest-release.outputs.release }}`"
|
||||||
|
body: |
|
||||||
|
Update `jekyll-anchor-headings` to `${{ steps.latest-release.outputs.release }}`
|
||||||
|
This is an automated pull request.
|
||||||
|
branch: update/vendor/jekyll-anchor-headings
|
||||||
|
delete-branch: true
|
||||||
|
labels: |
|
||||||
|
kind/update
|
||||||
|
area/dependency
|
||||||
|
add-paths: |
|
||||||
|
_includes/vendor/anchor_headings.html
|
||||||
|
token: ${{ secrets.GITHUB_TOKEN }}
|
3
.gitignore
vendored
3
.gitignore
vendored
@@ -1,6 +1,9 @@
|
|||||||
*.gem
|
*.gem
|
||||||
.bundle
|
.bundle
|
||||||
|
.ruby-version
|
||||||
|
.jekyll-cache
|
||||||
.sass-cache
|
.sass-cache
|
||||||
_site
|
_site
|
||||||
Gemfile.lock
|
Gemfile.lock
|
||||||
node_modules
|
node_modules
|
||||||
|
.DS_Store
|
||||||
|
10
.prettierignore
Normal file
10
.prettierignore
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
package.json
|
||||||
|
package-lock.json
|
||||||
|
_site
|
||||||
|
assets/css/just-the-docs-default.scss
|
||||||
|
assets/css/just-the-docs-light.scss
|
||||||
|
assets/css/just-the-docs-dark.scss
|
||||||
|
assets/js/vendor/lunr.min.js
|
||||||
|
assets/js/search-data.json
|
||||||
|
assets/js/just-the-docs.js
|
||||||
|
*.md
|
7
.prettierrc
Normal file
7
.prettierrc
Normal file
@@ -0,0 +1,7 @@
|
|||||||
|
{
|
||||||
|
"endOfLine": "lf",
|
||||||
|
"semi": false,
|
||||||
|
"singleQuote": false,
|
||||||
|
"tabWidth": 2,
|
||||||
|
"trailingComma": "es5"
|
||||||
|
}
|
@@ -1,10 +1,20 @@
|
|||||||
{
|
{
|
||||||
"ignoreFiles" : [
|
"ignoreFiles": [
|
||||||
"assets/css/just-the-docs.scss",
|
"assets/css/just-the-docs-default.scss",
|
||||||
"assets/css/dark-mode-preview.scss",
|
"assets/css/just-the-docs-light.scss",
|
||||||
|
"assets/css/just-the-docs-dark.scss",
|
||||||
"_sass/vendor/**/*.scss"
|
"_sass/vendor/**/*.scss"
|
||||||
],
|
],
|
||||||
"extends": [
|
"extends": [
|
||||||
"stylelint-config-primer"
|
"stylelint-config-standard-scss",
|
||||||
]
|
"stylelint-config-prettier-scss"
|
||||||
|
],
|
||||||
|
"plugins": ["stylelint-prettier"],
|
||||||
|
"rules": {
|
||||||
|
"prettier/prettier": true,
|
||||||
|
"alpha-value-notation": null,
|
||||||
|
"color-function-notation": null,
|
||||||
|
"no-descending-specificity": null,
|
||||||
|
"scss/no-global-function-names": null
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
14
.travis.yml
14
.travis.yml
@@ -1,14 +0,0 @@
|
|||||||
language: ruby
|
|
||||||
rvm:
|
|
||||||
- 2.3.0
|
|
||||||
env:
|
|
||||||
- TRAVIS_NODE_VERSION="9.3.0"
|
|
||||||
|
|
||||||
install:
|
|
||||||
- npm install
|
|
||||||
- gem install bundler --version '>=1.17.1'
|
|
||||||
- bundle install
|
|
||||||
|
|
||||||
script:
|
|
||||||
- npm run test
|
|
||||||
- bundle exec jekyll build
|
|
26
.vscode/tasks.json
vendored
Normal file
26
.vscode/tasks.json
vendored
Normal file
@@ -0,0 +1,26 @@
|
|||||||
|
{
|
||||||
|
// See https://go.microsoft.com/fwlink/?LinkId=733558
|
||||||
|
// for the documentation about the tasks.json format
|
||||||
|
"version": "2.0.0",
|
||||||
|
"tasks": [
|
||||||
|
{
|
||||||
|
"label": "Serve",
|
||||||
|
"type": "shell",
|
||||||
|
"command": "bundle exec jekyll serve --livereload",
|
||||||
|
"group": {
|
||||||
|
"kind": "test",
|
||||||
|
"isDefault": true
|
||||||
|
},
|
||||||
|
"isBackground": true
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"label": "Build",
|
||||||
|
"type": "shell",
|
||||||
|
"command": "bundle exec jekyll build",
|
||||||
|
"group": {
|
||||||
|
"kind": "build",
|
||||||
|
"isDefault": true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
4
404.html
4
404.html
@@ -1,6 +1,6 @@
|
|||||||
---
|
---
|
||||||
layout: default
|
layout: default
|
||||||
title: Page not found
|
title: 404
|
||||||
permalink: /404
|
permalink: /404
|
||||||
nav_exclude: true
|
nav_exclude: true
|
||||||
search_exclude: true
|
search_exclude: true
|
||||||
@@ -8,4 +8,4 @@ search_exclude: true
|
|||||||
|
|
||||||
<h1>Page not found</h1>
|
<h1>Page not found</h1>
|
||||||
|
|
||||||
<p>The page you requested could not be found. Try using the navigation {% if site.search_enabled %}or search {% endif %}to find what you're looking for or go to this <a href="{{ site.url }}{{ site.baseurl }}">site's home page</a>.</p>
|
<p>The page you requested could not be found. Try using the navigation {% if site.search_enabled != false %}or search {% endif %}to find what you're looking for or go to this <a href="{{ '/' | relative_url }}">site's home page</a>.</p>
|
||||||
|
987
CHANGELOG.md
Normal file
987
CHANGELOG.md
Normal file
@@ -0,0 +1,987 @@
|
|||||||
|
---
|
||||||
|
title: CHANGELOG
|
||||||
|
layout: default
|
||||||
|
---
|
||||||
|
|
||||||
|
# CHANGELOG
|
||||||
|
|
||||||
|
All notable user-facing changes to this project are documented in this file.
|
||||||
|
|
||||||
|
{: .highlight }
|
||||||
|
The project underwent a major maintenance shift in March 2022.
|
||||||
|
|
||||||
|
## HEAD
|
||||||
|
|
||||||
|
{: .note }
|
||||||
|
This website is built from the `HEAD` of the `main` branch of the theme repository.
|
||||||
|
|
||||||
|
{: .warning }
|
||||||
|
This website includes docs for some new features that are not available in `v0.4.0.rc5` and `v0.3.3`!
|
||||||
|
|
||||||
|
Changes to `main` that are *not* in the latest pre-release:
|
||||||
|
|
||||||
|
- n/a
|
||||||
|
|
||||||
|
## Pre-release v0.4.0.rc5
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
This RC does not introduce any major user-facing features. It adds more customizability for custom SCSS variables (fixing a bug with callout introduction order), `lunr` indexing, and loading `mermaid` locally. In addition, it fixes bugs introduced in `.rc4`: incorrect CSS, inconsistencies with code block backgrounds in dark theme, and the copy code button. It also adds a migration guide for users coming from `v0.3.3`.
|
||||||
|
|
||||||
|
### Trying out pre-release `v0.4.0.rc5`
|
||||||
|
|
||||||
|
Simlar to the prior release, `v0.4.0.rc5` is a **release candidate** for the theme (i.e., a pre-release) with release `v0.4.0` following immediately after. While we don't anticipate many users using this RC, it is still possible to opt-in.
|
||||||
|
|
||||||
|
To use this RC explicitly as a remote theme:
|
||||||
|
|
||||||
|
```yml
|
||||||
|
remote_theme: just-the-docs/just-the-docs@v0.4.0.rc5
|
||||||
|
```
|
||||||
|
|
||||||
|
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`:
|
||||||
|
|
||||||
|
```Ruby
|
||||||
|
gem "just-the-docs", "0.4.0.rc5"
|
||||||
|
```
|
||||||
|
|
||||||
|
By default, **users will not be upgraded to `0.4.0.rc5`**. To enforce that explicitly, either:
|
||||||
|
|
||||||
|
1. pin your gem version in your `Gemfile`, like so
|
||||||
|
```Ruby
|
||||||
|
gem "just-the-docs", "0.3.3"
|
||||||
|
```
|
||||||
|
2. freeze the `remote_theme`, like so
|
||||||
|
```yml
|
||||||
|
remote_theme: just-the-docs/just-the-docs@v0.3.3
|
||||||
|
```
|
||||||
|
|
||||||
|
### New Features
|
||||||
|
|
||||||
|
- Added: includes for custom `lunr` Liquid and JS code by [@diablodale] in [#1068]
|
||||||
|
- Added: new `_sass/custom/setup.scss` for variable definition by [@mattxwang] in [#1135]
|
||||||
|
- Added: configuration key to load a local version of mermaid by [@fabrik42] in [#1153]
|
||||||
|
|
||||||
|
### Bugfixes and Maintenance
|
||||||
|
|
||||||
|
- Fixed: incorrect `padding` property value pair in `search.scss` by [@kevinlin1] in [#1123]
|
||||||
|
- Fixed: minor spacing and comment nits by [@EricFromCanada] in [#1128]
|
||||||
|
- Fixed: exclude images from being bundled with gem by [@m-r-mccormick] in [#1142]
|
||||||
|
- Fixed: dark theme code block background, line number colors by [@m-r-mccormick] in [#1124]
|
||||||
|
- Fixed: copy code button interaction with kramdown line numbers by [@mattxwang] in [#1143]
|
||||||
|
|
||||||
|
### Docs
|
||||||
|
|
||||||
|
- Docs: add a migration guide by [@pdmosses] in [#1059]
|
||||||
|
- Docs: update `README` demo video by [@codewithfan] in [#1097]
|
||||||
|
- Docs: update "View Typography Utilities" link by [@agabrys] in [#1130]
|
||||||
|
- Docs: fix broken relative page links by [@mattxwang] in [#1106]
|
||||||
|
- Docs: clarify steps to add custom `lunr` index code by [@diablodale] in [#1139]
|
||||||
|
- Docs: label new features introduced in `v0.4` by [@mattxwang] in [#1138]
|
||||||
|
|
||||||
|
### New Contributors
|
||||||
|
|
||||||
|
- [@kevinlin1] made their first contribution in [#1123]
|
||||||
|
- [@codewithfan] made their first contribution in [#1097]
|
||||||
|
- [@agabrys] made their first contribution in [#1130]
|
||||||
|
- [@diablodale] made their first contribution in [#1068]
|
||||||
|
- [@m-r-mccormick] made their first contribution in [#1142]
|
||||||
|
- [@fabrik42] made their first contribution in [#1153]
|
||||||
|
|
||||||
|
[#1059]: https://github.com/just-the-docs/just-the-docs/pull/1059
|
||||||
|
[#1068]: https://github.com/just-the-docs/just-the-docs/pull/1068
|
||||||
|
[#1097]: https://github.com/just-the-docs/just-the-docs/pull/1097
|
||||||
|
[#1106]: https://github.com/just-the-docs/just-the-docs/pull/1106
|
||||||
|
[#1123]: https://github.com/just-the-docs/just-the-docs/pull/1123
|
||||||
|
[#1124]: https://github.com/just-the-docs/just-the-docs/pull/1124
|
||||||
|
[#1128]: https://github.com/just-the-docs/just-the-docs/pull/1128
|
||||||
|
[#1130]: https://github.com/just-the-docs/just-the-docs/pull/1130
|
||||||
|
[#1135]: https://github.com/just-the-docs/just-the-docs/pull/1135
|
||||||
|
[#1138]: https://github.com/just-the-docs/just-the-docs/pull/1138
|
||||||
|
[#1139]: https://github.com/just-the-docs/just-the-docs/pull/1139
|
||||||
|
[#1142]: https://github.com/just-the-docs/just-the-docs/pull/1142
|
||||||
|
[#1143]: https://github.com/just-the-docs/just-the-docs/pull/1143
|
||||||
|
[#1153]: https://github.com/just-the-docs/just-the-docs/pull/1153
|
||||||
|
|
||||||
|
[@agabrys]: https://github.com/agabrys
|
||||||
|
[@codewithfan]: https://github.com/codewithfan
|
||||||
|
[@diablodale]: https://github.com/diablodale
|
||||||
|
[@fabrik42]: https://github.com/fabrik42
|
||||||
|
[@kevinlin1]: https://github.com/kevinlin1
|
||||||
|
[@EricFromCanada]: https://github.com/EricFromCanada
|
||||||
|
[@m-r-mccormick]: https://github.com/m-r-mccormick
|
||||||
|
|
||||||
|
## Pre-release v0.4.0.rc4
|
||||||
|
|
||||||
|
Happy new year! We're celebrating with another pre-release, with features that should help theme users better adapt to changes moving forward. **We aim to re-release this as `v0.4.0`, with only few changes**.
|
||||||
|
|
||||||
|
Notable new additions include:
|
||||||
|
|
||||||
|
- modular site components, which split up the site into smaller reusable components; advanced theme users can then remix layouts quickly without duplication
|
||||||
|
- a "copy code" button to code blocks
|
||||||
|
- fixing bugs in generated TOCs and navigation from previous prereleases
|
||||||
|
- various cleanups of CSS and HTML markup
|
||||||
|
|
||||||
|
The roadmap to `v0.4.0` is small. We are only looking to:
|
||||||
|
|
||||||
|
- finish a migration guide, so users can easily upgrade from `v0.3.3` to `v0.4.0`
|
||||||
|
- fix one last bug relating to callouts and custom colors
|
||||||
|
- fix any new bugs introduced by this pre-release
|
||||||
|
|
||||||
|
Have any questions, thoughts, or concerns? We'd love to hear from you! Please [open an issue](https://github.com/just-the-docs/just-the-docs/issues) or [start a discussion](https://github.com/just-the-docs/just-the-docs/discussions) and let us know!
|
||||||
|
|
||||||
|
### Trying out pre-release `v0.4.0.rc4`
|
||||||
|
|
||||||
|
Simlar to the prior release, `v0.4.0.rc4` is a **release candidate** for the theme (i.e., a pre-release) with release `v0.4.0` coming soon. We want your help in testing the changes! As of now, the gem on RubyGems and the repository are updated to `v0.4.0.rc4`.
|
||||||
|
|
||||||
|
To use this RC explicitly as a remote theme:
|
||||||
|
|
||||||
|
```yml
|
||||||
|
remote_theme: just-the-docs/just-the-docs@v0.4.0.rc4
|
||||||
|
```
|
||||||
|
|
||||||
|
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`:
|
||||||
|
|
||||||
|
```Ruby
|
||||||
|
gem "just-the-docs", "0.4.0.rc4"
|
||||||
|
```
|
||||||
|
|
||||||
|
By default, **users will not be upgraded to `0.4.0.rc4`**. To enforce that explicitly, either:
|
||||||
|
|
||||||
|
1. pin your gem version in your `Gemfile`, like so
|
||||||
|
```Ruby
|
||||||
|
gem "just-the-docs", "0.3.3"
|
||||||
|
```
|
||||||
|
2. freeze the `remote_theme`, like so
|
||||||
|
```yml
|
||||||
|
remote_theme: just-the-docs/just-the-docs@v0.3.3
|
||||||
|
```
|
||||||
|
|
||||||
|
### New Features
|
||||||
|
|
||||||
|
- Added: support multiple Google Analytics tracking IDs, document UA -> GA4 switch by [@MichelleBlanchette] in [#1029]
|
||||||
|
- Added: copy code button to code snippets by [@simonebortolin] in [#945]
|
||||||
|
- Added: restore simple configuration of `favicon.ico` via `site.static_files` by [@pdmosses] in [#1095]
|
||||||
|
- Added: modularize site components by [@mattxwang] in [#1058]
|
||||||
|
|
||||||
|
### Bugfixes and Maintenance
|
||||||
|
|
||||||
|
- Fixed: incorrect disambiguation in generated TOCs by [@pdmosses] in [#999]
|
||||||
|
- Fixed: duplicated external links in collections by [@pdmosses] in [#1001]
|
||||||
|
- Fixed: import order of `custom.scss`; puts at end by [@deseo] in [#1010]
|
||||||
|
- Fixed: top-level active link styling by [@pdmosses] in [#1015]
|
||||||
|
- Fixed: external links for sites with no pages by [@pdmosses] in [#1021]
|
||||||
|
- Fixed: duplicate `title` if `jekyll-seo-tag` not in users's plugins by [@Tom-Brouwer] in [#1040]
|
||||||
|
- Fixed: removes (duplicate) `favicon.html`, shifts content to `head_custom.html` by [@mattxwang] in [#1027]
|
||||||
|
- Fixed: add `reversed`, deprecate `desc` for nav `child_nav_order` by [@jmertic] in [#1061]
|
||||||
|
- Fixed: `child.child_nav_order` to `node.child_nav_order` by [@mattxwang] in [#1065]
|
||||||
|
- Fixed: remove all uses of `/` as SASS division by [@mattxwang] in [#1074]
|
||||||
|
- note: this was originally merged as [#1074] with a bug; it was reverted in [#1076], and then reimplemented in [#1077]
|
||||||
|
- Fixed: skip nav collection generation when site has no pages by [@pdmosses] in [#1092]
|
||||||
|
- Fixed: standardize SCSS with `declaration-block-no-redundant-longhand-properties` by [@simonebortolin] in [#1102]
|
||||||
|
- Fixed: incorrect `padding` property value pair in `labels.scss` by [@SConaway] in [#1104]
|
||||||
|
- Fixed: various bugs with copy code button by [@simonebortolin] in [#1096]
|
||||||
|
- Fixed: replace inline styling for `<svg>` icons by [@captn3m0] in [#1110]
|
||||||
|
- Vendor: update `jekyll-anchor-headings`, `lunr.js` by [@mattxwang] in [#1071]
|
||||||
|
|
||||||
|
### Docs
|
||||||
|
|
||||||
|
- Docs: fix typo in changelog links [@koppor] in [#1000]
|
||||||
|
- Docs: update homepage (focus: new features, conciseness, deduplication) by [@pdmosses] in [#1018]
|
||||||
|
- Docs: update README (focus: new features, conciseness, deduplication) by [@pdmosses] in [#1019]
|
||||||
|
- Docs: fix two bugs in "Customization" (custom favicon, new annotation) by [@mattxwang] in [#1090]
|
||||||
|
- Docs: Add warning about mandatory `_`-prefix for collections by [@max06] in [#1091]
|
||||||
|
- Docs: remove Google Analytics on main site by [@mattxwang] in [#1113]
|
||||||
|
|
||||||
|
### New Contributors
|
||||||
|
|
||||||
|
- [@koppor] made their first contribution in [#1000]
|
||||||
|
- [@deseo] made their first contribution in [#1010]
|
||||||
|
- [@Tom-Brouwer] made their first contribution in [#1040]
|
||||||
|
- [@simonebortolin] made their first contribution in [#945]
|
||||||
|
- [@SConaway] made their first contribution in [#1104]
|
||||||
|
- [@captn3m0] made their first contribution in [#1110]
|
||||||
|
|
||||||
|
**Full Changelog**: https://github.com/just-the-docs/just-the-docs/compare/v0.4.0.rc3...v0.4.0.rc4
|
||||||
|
|
||||||
|
[#945]: https://github.com/just-the-docs/just-the-docs/pull/945
|
||||||
|
[#999]: https://github.com/just-the-docs/just-the-docs/pull/999
|
||||||
|
[#1000]: https://github.com/just-the-docs/just-the-docs/pull/1000
|
||||||
|
[#1001]: https://github.com/just-the-docs/just-the-docs/pull/1001
|
||||||
|
[#1010]: https://github.com/just-the-docs/just-the-docs/pull/1010
|
||||||
|
[#1015]: https://github.com/just-the-docs/just-the-docs/pull/1015
|
||||||
|
[#1018]: https://github.com/just-the-docs/just-the-docs/pull/1018
|
||||||
|
[#1019]: https://github.com/just-the-docs/just-the-docs/pull/1019
|
||||||
|
[#1021]: https://github.com/just-the-docs/just-the-docs/pull/1021
|
||||||
|
[#1027]: https://github.com/just-the-docs/just-the-docs/pull/1027
|
||||||
|
[#1029]: https://github.com/just-the-docs/just-the-docs/pull/1029
|
||||||
|
[#1040]: https://github.com/just-the-docs/just-the-docs/pull/1040
|
||||||
|
[#1058]: https://github.com/just-the-docs/just-the-docs/pull/1058
|
||||||
|
[#1061]: https://github.com/just-the-docs/just-the-docs/pull/1061
|
||||||
|
[#1065]: https://github.com/just-the-docs/just-the-docs/pull/1065
|
||||||
|
[#1071]: https://github.com/just-the-docs/just-the-docs/pull/1071
|
||||||
|
[#1074]: https://github.com/just-the-docs/just-the-docs/pull/1074
|
||||||
|
[#1076]: https://github.com/just-the-docs/just-the-docs/pull/1076
|
||||||
|
[#1077]: https://github.com/just-the-docs/just-the-docs/pull/1077
|
||||||
|
[#1090]: https://github.com/just-the-docs/just-the-docs/pull/1090
|
||||||
|
[#1091]: https://github.com/just-the-docs/just-the-docs/pull/1091
|
||||||
|
[#1092]: https://github.com/just-the-docs/just-the-docs/pull/1092
|
||||||
|
[#1095]: https://github.com/just-the-docs/just-the-docs/pull/1095
|
||||||
|
[#1096]: https://github.com/just-the-docs/just-the-docs/pull/1096
|
||||||
|
[#1102]: https://github.com/just-the-docs/just-the-docs/pull/1102
|
||||||
|
[#1104]: https://github.com/just-the-docs/just-the-docs/pull/1104
|
||||||
|
[#1110]: https://github.com/just-the-docs/just-the-docs/pull/1110
|
||||||
|
[#1113]: https://github.com/just-the-docs/just-the-docs/pull/1113
|
||||||
|
|
||||||
|
[@captn3m0]: https://github.com/captn3m0
|
||||||
|
[@deseo]: https://github.com/deseo
|
||||||
|
[@koppor]: https://github.com/koppor
|
||||||
|
[@MichelleBlanchette]: https://github.com/MichelleBlanchette
|
||||||
|
[@simonebortolin]: https://github.com/simonebortolin
|
||||||
|
[@SConaway]: https://github.com/SConaway
|
||||||
|
[@Tom-Brouwer]: https://github.com/Tom-Brouwer
|
||||||
|
|
||||||
|
## Pre-release v0.4.0.rc3
|
||||||
|
|
||||||
|
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`.
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
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!
|
||||||
|
|
||||||
|
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!
|
||||||
|
|
||||||
|
### Trying out pre-release `v0.4.0.rc3`
|
||||||
|
|
||||||
|
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`.
|
||||||
|
|
||||||
|
To use this RC explicitly as a remote theme:
|
||||||
|
|
||||||
|
```yml
|
||||||
|
remote_theme: just-the-docs/just-the-docs@v0.4.0.rc3
|
||||||
|
```
|
||||||
|
|
||||||
|
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`:
|
||||||
|
|
||||||
|
```Ruby
|
||||||
|
gem "just-the-docs", "0.4.0.rc3"
|
||||||
|
```
|
||||||
|
|
||||||
|
By default, **users will not be upgraded to `0.4.0.rc3`**. To enforce that explicitly, either:
|
||||||
|
|
||||||
|
1. pin your gem version in your `Gemfile`, like so
|
||||||
|
```Ruby
|
||||||
|
gem "just-the-docs", "0.3.3"
|
||||||
|
```
|
||||||
|
2. freeze the `remote_theme`, like so
|
||||||
|
```yml
|
||||||
|
remote_theme: just-the-docs/just-the-docs@v0.3.3
|
||||||
|
```
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
Broadly, this prerelease is feature-light!
|
||||||
|
|
||||||
|
- Added: styling for `<blockquote>` by [@mattxwang] in [#965]
|
||||||
|
- Added: custom include for TOC heading by [@pdmosses] in [#980]
|
||||||
|
|
||||||
|
### Bugfixes and Experimental Features
|
||||||
|
|
||||||
|
*Note*: experimental nav optimization may be unstable. Please give us feedback!
|
||||||
|
|
||||||
|
- Added: experimental nav optimization for simple cases by [@pdmosses] in [#992]
|
||||||
|
- Fixed: spacing issue when search is disabled by [@henryiii] in [#960]
|
||||||
|
- Fixed: active grandchild link class by [@pdmosses] in [#962]
|
||||||
|
- Fixed: HTML validation issues (W3C validator) by [@mattxwang] in [#964]
|
||||||
|
- Fixed: link styling now uses `text-decoration` values by [@mattxwang] in [#967]
|
||||||
|
- Fixed: cleaning up Jekyll excludes by [@pdmosses] in [#985]
|
||||||
|
- Fixed: docs, narrow styling for code highlighting with line numbers by [@pdmosses] in [#974]
|
||||||
|
- Fixed: default syntax highlighting in custom color schemes [@pdmosses] in [#986]
|
||||||
|
|
||||||
|
[#965]: https://github.com/just-the-docs/just-the-docs/pull/965
|
||||||
|
[#960]: https://github.com/just-the-docs/just-the-docs/pull/960
|
||||||
|
[#962]: https://github.com/just-the-docs/just-the-docs/pull/962
|
||||||
|
[#964]: https://github.com/just-the-docs/just-the-docs/pull/964
|
||||||
|
[#967]: https://github.com/just-the-docs/just-the-docs/pull/967
|
||||||
|
[#974]: https://github.com/just-the-docs/just-the-docs/pull/974
|
||||||
|
[#980]: https://github.com/just-the-docs/just-the-docs/pull/980
|
||||||
|
[#985]: https://github.com/just-the-docs/just-the-docs/pull/985
|
||||||
|
[#986]: https://github.com/just-the-docs/just-the-docs/pull/986
|
||||||
|
[#992]: https://github.com/just-the-docs/just-the-docs/pull/992
|
||||||
|
|
||||||
|
[@henryiii]: https://github.com/henryiii
|
||||||
|
|
||||||
|
**Full Changelog**: https://github.com/just-the-docs/just-the-docs/compare/v0.4.0.rc2...v0.4.0.rc3
|
||||||
|
|
||||||
|
## Pre-release v0.4.0.rc2
|
||||||
|
|
||||||
|
{: .warning }
|
||||||
|
This website includes docs for some new features that are not available in `v0.4.0.rc1` and `v0.3.3`!
|
||||||
|
|
||||||
|
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:
|
||||||
|
|
||||||
|
- significant improvement on build time of navigation panel by [@pdmosses]
|
||||||
|
- this is big: for a community member with over 300 pages, we shortened the build time from 3 minutes to 30 seconds!
|
||||||
|
- improved accessibility features led by [@JPrevost]
|
||||||
|
- more docs!
|
||||||
|
|
||||||
|
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!
|
||||||
|
|
||||||
|
### Trying out pre-release `v0.4.0.rc2`
|
||||||
|
|
||||||
|
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`.
|
||||||
|
|
||||||
|
To use this RC explicitly as a remote theme:
|
||||||
|
|
||||||
|
```yml
|
||||||
|
remote_theme: just-the-docs/just-the-docs@v0.4.0.rc2
|
||||||
|
```
|
||||||
|
|
||||||
|
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`:
|
||||||
|
|
||||||
|
```Ruby
|
||||||
|
gem "just-the-docs", "0.4.0.rc2"
|
||||||
|
```
|
||||||
|
|
||||||
|
By default, **users will not be upgraded to `0.4.0.rc2`**. To enforce that explicitly, either:
|
||||||
|
|
||||||
|
1. pin your gem version in your `Gemfile`, like so
|
||||||
|
```Ruby
|
||||||
|
gem "just-the-docs", "0.3.3"
|
||||||
|
```
|
||||||
|
2. freeze the `remote_theme`, like so
|
||||||
|
```yml
|
||||||
|
remote_theme: just-the-docs/just-the-docs@v0.3.3
|
||||||
|
```
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
- Added: accessible titles to nested page nav toggle by [@JPrevost] in [#950]
|
||||||
|
- Added: better title styling for AsciiDoc examples by [@alyssais] in [#944]
|
||||||
|
- Added: docs for custom search placeholder by [@mattxwang] in [#939]
|
||||||
|
- Added: provide ability to skip to main content by [@JPrevost] in [#949]
|
||||||
|
- Fixed: exclude `vendor/` in Jekyll config by [@manuelhenke] in [#941]
|
||||||
|
- Fixed: improve build time of navigation panel by [@pdmosses] in [#956]
|
||||||
|
|
||||||
|
[#950]: https://github.com/just-the-docs/just-the-docs/pull/950
|
||||||
|
[#944]: https://github.com/just-the-docs/just-the-docs/pull/944
|
||||||
|
[#939]: https://github.com/just-the-docs/just-the-docs/pull/939
|
||||||
|
[#949]: https://github.com/just-the-docs/just-the-docs/pull/949
|
||||||
|
[#941]: https://github.com/just-the-docs/just-the-docs/pull/941
|
||||||
|
[#956]: https://github.com/just-the-docs/just-the-docs/pull/956
|
||||||
|
|
||||||
|
[@alyssais]: https://github.com/alyssais
|
||||||
|
|
||||||
|
### Documentation and Maintenance
|
||||||
|
|
||||||
|
- Added: docs load mermaid.js by default by [@mattxwang] in [#935]
|
||||||
|
- Fixed: table of contents on search docs by [@robinpokorny] in [#940]
|
||||||
|
- Fixed: broken docs link (custom footer) by [@olgarithms] in [#951]
|
||||||
|
- Fixed: clarify version docs by [@pdmosses] in [#955]
|
||||||
|
- Deleted: unused script directory by [@mattxwang] in [#937]
|
||||||
|
|
||||||
|
[#935]: https://github.com/just-the-docs/just-the-docs/pull/935
|
||||||
|
[#940]: https://github.com/just-the-docs/just-the-docs/pull/940
|
||||||
|
[#951]: https://github.com/just-the-docs/just-the-docs/pull/951
|
||||||
|
[#955]: https://github.com/just-the-docs/just-the-docs/pull/955
|
||||||
|
[#937]: https://github.com/just-the-docs/just-the-docs/pull/937
|
||||||
|
|
||||||
|
### New Contributors
|
||||||
|
|
||||||
|
* [@robinpokorny] made their first contribution in [#940]
|
||||||
|
* [@olgarithms] made their first contribution in [#951]
|
||||||
|
* [@manuelhenke] made their first contribution in [#941]
|
||||||
|
* [@JPrevost] made their first contribution in [#950]
|
||||||
|
|
||||||
|
[@robinpokorny]: https://github.com/robinpokorny
|
||||||
|
[@olgarithms]: https://github.com/olgarithms
|
||||||
|
[@manuelhenke]: https://github.com/manuelhenke
|
||||||
|
[@JPrevost]: https://github.com/JPrevost
|
||||||
|
|
||||||
|
## Pre-release v0.4.0.rc1
|
||||||
|
|
||||||
|
### We're back!
|
||||||
|
|
||||||
|
Hi all! The Just the Docs team is excited to have our first pre-release in over two years! It is jam-packed with features and bugfixes that have been requested by the community since 2020. They include:
|
||||||
|
|
||||||
|
- The new callouts component
|
||||||
|
- Allowing pages and collections to coexist on the navigation pane
|
||||||
|
- New styling: dark syntax highlighting, support for jekyll-asciidoc, word-wrapping instead of overflow for various elements
|
||||||
|
- More customization: external nav links, custom nav footers, favicon includes, search color and placeholder configuration, mermaid.js support, and nav sorting
|
||||||
|
- Over 20 bugfixes! Big ones include fixing the `rake` command, using `relative_url`, and search input color
|
||||||
|
- More documentation, especially on using custom includes
|
||||||
|
- Updating core dependencies to stable Ruby versions
|
||||||
|
- A WIP [template repository](https://github.com/just-the-docs/just-the-docs-template) that allows you to setup your own repository using Just the Docs and GitHub Pages with one click - give it a shot! More documentation, etc. is on the way!
|
||||||
|
|
||||||
|
We want your feedback! Are these changes helpful? Are our docs easy to understand? Should new features like `mermaid` be opt-in or opt-out? Please [open an issue](https://github.com/just-the-docs/just-the-docs/issues) or [start a discussion](https://github.com/just-the-docs/just-the-docs/discussions) and let us know!
|
||||||
|
|
||||||
|
### Trying out pre-release `v0.4.0.rc1`
|
||||||
|
|
||||||
|
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`.
|
||||||
|
|
||||||
|
To use this RC explicitly as a remote theme:
|
||||||
|
|
||||||
|
```yml
|
||||||
|
remote_theme: just-the-docs/just-the-docs@v0.4.0.rc1
|
||||||
|
```
|
||||||
|
|
||||||
|
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`:
|
||||||
|
|
||||||
|
```Ruby
|
||||||
|
gem "just-the-docs", "0.4.0.rc1"
|
||||||
|
```
|
||||||
|
|
||||||
|
### Staying on `v0.3.3`
|
||||||
|
|
||||||
|
If you're not ready to make the switch, that's alright! If your version of just-the-docs is pinned to `v0.3.3` (i.e. by a `Gemfile.lock` or in `remote_theme`, then there's nothing you need to do.
|
||||||
|
|
||||||
|
If you have not pinned your theme version, you should either:
|
||||||
|
|
||||||
|
1. pin your gem version in your `Gemfile`, like so
|
||||||
|
```Ruby
|
||||||
|
gem "just-the-docs", "0.3.3"
|
||||||
|
```
|
||||||
|
2. freeze the `remote_theme`, like so
|
||||||
|
```yml
|
||||||
|
remote_theme: just-the-docs/just-the-docs@v0.3.3
|
||||||
|
```
|
||||||
|
|
||||||
|
{: .warning }
|
||||||
|
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`.
|
||||||
|
|
||||||
|
### Maintenance
|
||||||
|
|
||||||
|
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!
|
||||||
|
|
||||||
|
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!
|
||||||
|
|
||||||
|
[@mattxwang]: https://github.com/mattxwang
|
||||||
|
[@pdmosses]: https://github.com/pdmosses
|
||||||
|
[@skullface]: https://github.com/skullface
|
||||||
|
[@dougaitken]: https://github.com/dougaitken
|
||||||
|
[@max06]: https://github.com/max06
|
||||||
|
|
||||||
|
### Roadmap
|
||||||
|
|
||||||
|
In the short-term, we're committed to tidying up everything for a `v0.4.0` release. This involves fixing bugs reported from the community in this pre-release, as well as continually merging in minor PRs.
|
||||||
|
|
||||||
|
We're also scoping out medium and long-term projects, and want to keep you in the loop. These include:
|
||||||
|
|
||||||
|
- upgrading to Jekyll 4, and stopping support for Jekyll 3
|
||||||
|
- versioned docs - issue [#728]
|
||||||
|
- improved accessibility - issues [#566], [#870]
|
||||||
|
- internationalization (i18n) - issue [#59]
|
||||||
|
- recursive/multi-level navigation - PR [#462]
|
||||||
|
- toggleable dark mode - issue [#234]
|
||||||
|
|
||||||
|
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!
|
||||||
|
|
||||||
|
[#728]: https://github.com/just-the-docs/just-the-docs/issues/728
|
||||||
|
[#566]: https://github.com/just-the-docs/just-the-docs/issues/566
|
||||||
|
[#870]: https://github.com/just-the-docs/just-the-docs/issues/870
|
||||||
|
[#59]: https://github.com/just-the-docs/just-the-docs/issues/59
|
||||||
|
[#462]: https://github.com/just-the-docs/just-the-docs/pull/462
|
||||||
|
[#234]: https://github.com/just-the-docs/just-the-docs/issues/234
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
* Added: Combination by [@pdmosses] in [#578]
|
||||||
|
- Added: dark highlighting in [#463]
|
||||||
|
- Added: pages and collections in [#448]
|
||||||
|
- Added: callouts in [#466]
|
||||||
|
- Fixed: breadcrumb behaviour … by [@AdityaTiwari2102] in [#477]
|
||||||
|
- Fixed: prevent rake command corrupting search data in [#495] (also listed below)
|
||||||
|
- Fixed: nested lists in [#496]
|
||||||
|
- Fixed: set color for search input in [#498] (also listed below)
|
||||||
|
- Fixed: sites with no child pages (no PR)
|
||||||
|
- Fixed: TOC/breadcrumbs for multiple collections in [#494]
|
||||||
|
- Added: collection configuration option `nav_fold` (no PR)
|
||||||
|
- Fixed: indentation and color for folded collection navigation (no PR)
|
||||||
|
- Fixed: scroll navigation to show the link to the current page in [#639]
|
||||||
|
- Fixed: Replace all uses of `absolute_url` by `relative_url`, by [@svrooij] in [#544]
|
||||||
|
* Added: custom favicon `_includes` by [@burner1024] in [#364]
|
||||||
|
* Added: set color for search input by [@pdmosses] in [#498]
|
||||||
|
* Added: search placeholder configuration by [@mattxwang] in [#613]
|
||||||
|
* Added: 'child_nav_order' front matter to be able to sort navigation pages in reverse by [@jmertic] in [#726]
|
||||||
|
* Added: `nav_footer_custom` include by [@nathanjessen] in [#474]
|
||||||
|
* Added: style fixes for jekyll-asciidoc by [@alyssais] in [#829]
|
||||||
|
* Added: mermaid.js support by [@nascosto] in [#857]
|
||||||
|
* Added: support for external navigation links by [@SPGoding] in [#876]
|
||||||
|
* Added: refactor `mermaid` config to use `mermaid_config.js` include, only require `mermaid.version` in `_config.yml` by [@mattxwang] in [#909]
|
||||||
|
* Fixed: prepend `site.collections_dir` if exists by [@alexsegura] in [#519]
|
||||||
|
* Fixed: nested task lists (#517) by [@pdmosses] in [#855]
|
||||||
|
* Fixed: suppress Liquid processing in CSS comments by [@pdmosses] in [#686]
|
||||||
|
* Fixed: prevent rake command from corrupting search data by [@pdmosses] in [#495]
|
||||||
|
* Fixed: anchor heading links should be visible on focus by [@jacobhq] in [#846]
|
||||||
|
* Fixed: add `overflow-x: auto` to `figure.highlight` by [@iridazzle] in [#727]
|
||||||
|
* Fixed: add `overflow-wrap: word-break` to `body` by [@iridazzle] in [#889]
|
||||||
|
* Fixed: vertical alignment for consecutive labels by [@Eisverygoodletter] in [#893]
|
||||||
|
* Fixed: allow links to wrap by [@pdmosses] in [#905]
|
||||||
|
* Fixed: nav scroll feature and absolute/relative URLs by [@pdmosses] in [#898]
|
||||||
|
|
||||||
|
[#578]: https://github.com/just-the-docs/just-the-docs/pull/578
|
||||||
|
[#463]: https://github.com/just-the-docs/just-the-docs/pull/463
|
||||||
|
[#448]: https://github.com/just-the-docs/just-the-docs/pull/448
|
||||||
|
[#466]: https://github.com/just-the-docs/just-the-docs/pull/466
|
||||||
|
[#477]: https://github.com/just-the-docs/just-the-docs/pull/477
|
||||||
|
[#495]: https://github.com/just-the-docs/just-the-docs/pull/495
|
||||||
|
[#496]: https://github.com/just-the-docs/just-the-docs/pull/496
|
||||||
|
[#498]: https://github.com/just-the-docs/just-the-docs/pull/498
|
||||||
|
[#494]: https://github.com/just-the-docs/just-the-docs/pull/494
|
||||||
|
[#639]: https://github.com/just-the-docs/just-the-docs/pull/639
|
||||||
|
[#544]: https://github.com/just-the-docs/just-the-docs/pull/544
|
||||||
|
[#364]: https://github.com/just-the-docs/just-the-docs/pull/364
|
||||||
|
[#498]: https://github.com/just-the-docs/just-the-docs/pull/498
|
||||||
|
[#613]: https://github.com/just-the-docs/just-the-docs/pull/613
|
||||||
|
[#726]: https://github.com/just-the-docs/just-the-docs/pull/726
|
||||||
|
[#474]: https://github.com/just-the-docs/just-the-docs/pull/474
|
||||||
|
[#829]: https://github.com/just-the-docs/just-the-docs/pull/829
|
||||||
|
[#857]: https://github.com/just-the-docs/just-the-docs/pull/857
|
||||||
|
[#876]: https://github.com/just-the-docs/just-the-docs/pull/876
|
||||||
|
[#909]: https://github.com/just-the-docs/just-the-docs/pull/909
|
||||||
|
[#519]: https://github.com/just-the-docs/just-the-docs/pull/519
|
||||||
|
[#855]: https://github.com/just-the-docs/just-the-docs/pull/855
|
||||||
|
[#686]: https://github.com/just-the-docs/just-the-docs/pull/686
|
||||||
|
[#495]: https://github.com/just-the-docs/just-the-docs/pull/495
|
||||||
|
[#846]: https://github.com/just-the-docs/just-the-docs/pull/846
|
||||||
|
[#727]: https://github.com/just-the-docs/just-the-docs/pull/727
|
||||||
|
[#889]: https://github.com/just-the-docs/just-the-docs/pull/889
|
||||||
|
[#893]: https://github.com/just-the-docs/just-the-docs/pull/893
|
||||||
|
[#905]: https://github.com/just-the-docs/just-the-docs/pull/905
|
||||||
|
[#898]: https://github.com/just-the-docs/just-the-docs/pull/898
|
||||||
|
|
||||||
|
### Documentation
|
||||||
|
|
||||||
|
* Added: docs on how to break an `ol` by [@pdmosses] in [#856]
|
||||||
|
* Added: docs for custom includes by [@nathanjessen] in [#806]
|
||||||
|
* Added: document caveat about variable dependencies by [@waldyrious] in [#555]
|
||||||
|
* Added: docs on how to use `custom_head` to add a custom favicon by [@UnclassedPenguin] in [#814]
|
||||||
|
* Fixed: `ol` on `index.md` by [@pmarsceill] in [#778]
|
||||||
|
* Fixed: image link in Markdown kitchen sink by [@JeffGuKang] in [#221]
|
||||||
|
* Fixed: images in Markdown kitchen sink by [@dougaitken] in [#782]
|
||||||
|
* Fixed: clearer label of link to Jekyll quickstart by [@waldyrious] in [#549]
|
||||||
|
* Fixed: remove extra spaces in component docs by [@MichelleBlanchette] in [#554]
|
||||||
|
* Fixed: double "your" typo in `index.md` by [@sehilyi] in [#499]
|
||||||
|
* Fixed: "you" -> "your" typo in `index.md` by [@nathanjessen] in [#473]
|
||||||
|
* Fixed: spacing in toc example by [@henryiii] in [#835]
|
||||||
|
* Fixed: typo in `README` on `_config.yml` by [@ivanskodje] in [#891]
|
||||||
|
* Fixed: missing code fence in navigation structure docs by [@mattxwang] in [#906]
|
||||||
|
|
||||||
|
[#856]: https://github.com/just-the-docs/just-the-docs/pull/856
|
||||||
|
[#806]: https://github.com/just-the-docs/just-the-docs/pull/806
|
||||||
|
[#555]: https://github.com/just-the-docs/just-the-docs/pull/555
|
||||||
|
[#814]: https://github.com/just-the-docs/just-the-docs/pull/814
|
||||||
|
[#778]: https://github.com/just-the-docs/just-the-docs/pull/778
|
||||||
|
[#221]: https://github.com/just-the-docs/just-the-docs/pull/221
|
||||||
|
[#782]: https://github.com/just-the-docs/just-the-docs/pull/782
|
||||||
|
[#549]: https://github.com/just-the-docs/just-the-docs/pull/549
|
||||||
|
[#554]: https://github.com/just-the-docs/just-the-docs/pull/554
|
||||||
|
[#499]: https://github.com/just-the-docs/just-the-docs/pull/499
|
||||||
|
[#473]: https://github.com/just-the-docs/just-the-docs/pull/473
|
||||||
|
[#835]: https://github.com/just-the-docs/just-the-docs/pull/835
|
||||||
|
[#891]: https://github.com/just-the-docs/just-the-docs/pull/891
|
||||||
|
[#906]: https://github.com/just-the-docs/just-the-docs/pull/906
|
||||||
|
|
||||||
|
### Maintenance
|
||||||
|
|
||||||
|
* Added: VScode devcontainer by [@max06] in [#783]
|
||||||
|
* Added: `webrick` to `Gemfile` by [@mattxwang] in [#799]
|
||||||
|
* Added: 'This site is powered by Netlify.' to the footer by [@mattxwang] in [#797]
|
||||||
|
* Updated: new repo path by [@pmarsceill] in [#775]
|
||||||
|
* Updated: rename `master` -> `main` by [@pmarsceill] in [#776]
|
||||||
|
* Updated: README by [@pmarsceill] in [#777]
|
||||||
|
* Updated: Code of Conduct to Contributor Covenant v2.1 by [@mattxwang] in [#790]
|
||||||
|
* Updated: CI files, Ruby & Node Versions by [@mattxwang] in [#820]
|
||||||
|
* Updated: Stylelint to v14, extend SCSS plugins, remove primer-* configs, resolve issues by [@mattxwang] in [#821]
|
||||||
|
|
||||||
|
[#783]: https://github.com/just-the-docs/just-the-docs/pull/783
|
||||||
|
[#799]: https://github.com/just-the-docs/just-the-docs/pull/799
|
||||||
|
[#797]: https://github.com/just-the-docs/just-the-docs/pull/797
|
||||||
|
[#775]: https://github.com/just-the-docs/just-the-docs/pull/775
|
||||||
|
[#776]: https://github.com/just-the-docs/just-the-docs/pull/776
|
||||||
|
[#777]: https://github.com/just-the-docs/just-the-docs/pull/777
|
||||||
|
[#790]: https://github.com/just-the-docs/just-the-docs/pull/790
|
||||||
|
[#820]: https://github.com/just-the-docs/just-the-docs/pull/820
|
||||||
|
[#821]: https://github.com/just-the-docs/just-the-docs/pull/821
|
||||||
|
|
||||||
|
### Dependencies
|
||||||
|
|
||||||
|
* Upgrade to GitHub-native Dependabot by @dependabot-preview in [#627]
|
||||||
|
* [Security] Bump y18n from 3.2.1 to 3.2.2 by @dependabot-preview in [#606]
|
||||||
|
* [Security] Bump hosted-git-info from 2.7.1 to 2.8.9 by @dependabot-preview in [#641]
|
||||||
|
* [Security] Bump lodash from 4.17.19 to 4.17.21 by @dependabot-preview in [#640]
|
||||||
|
* [Security] Bump ini from 1.3.5 to 1.3.8 by @dependabot-preview in [#511]
|
||||||
|
* Bump path-parse from 1.0.6 to 1.0.7 by @dependabot in [#699]
|
||||||
|
* Bump ajv from 6.10.0 to 6.12.6 by @dependabot in [#766]
|
||||||
|
* Bump prettier from 2.1.2 to 2.5.1 by @dependabot in [#787]
|
||||||
|
* Bump prettier from 2.5.1 to 2.6.2 by @dependabot in [#809]
|
||||||
|
* Bump prettier from 2.6.2 to 2.7.1 by @dependabot in [#864]
|
||||||
|
|
||||||
|
[#627]: https://github.com/just-the-docs/just-the-docs/pull/627
|
||||||
|
[#606]: https://github.com/just-the-docs/just-the-docs/pull/606
|
||||||
|
[#641]: https://github.com/just-the-docs/just-the-docs/pull/641
|
||||||
|
[#640]: https://github.com/just-the-docs/just-the-docs/pull/640
|
||||||
|
[#511]: https://github.com/just-the-docs/just-the-docs/pull/511
|
||||||
|
[#699]: https://github.com/just-the-docs/just-the-docs/pull/699
|
||||||
|
[#766]: https://github.com/just-the-docs/just-the-docs/pull/766
|
||||||
|
[#787]: https://github.com/just-the-docs/just-the-docs/pull/787
|
||||||
|
[#809]: https://github.com/just-the-docs/just-the-docs/pull/809
|
||||||
|
[#864]: https://github.com/just-the-docs/just-the-docs/pull/864
|
||||||
|
|
||||||
|
### New Contributors
|
||||||
|
|
||||||
|
* [@AdityaTiwari2102] made their first contribution in [#477]
|
||||||
|
* [@svrooij] made their first contribution in [#544]
|
||||||
|
* [@alexsegura] made their first contribution in [#519]
|
||||||
|
* [@burner1024] made their first contribution in [#364]
|
||||||
|
* [@JeffGuKang] made their first contribution in [#221]
|
||||||
|
* [@dougaitken] made their first contribution in [#782]
|
||||||
|
* [@max06] made their first contribution in [#783]
|
||||||
|
* [@sehilyi] made their first contribution in [#499]
|
||||||
|
* [@nathanjessen] made their first contribution in [#473]
|
||||||
|
* [@waldyrious] made their first contribution in [#549]
|
||||||
|
* [@MichelleBlanchette] made their first contribution in [#554]
|
||||||
|
* [@henryiii] made their first contribution in [#835]
|
||||||
|
* [@jmertic] made their first contribution in [#726]
|
||||||
|
* [@jacobhq] made their first contribution in [#846]
|
||||||
|
* [@UnclassedPenguin] made their first contribution in [#814]
|
||||||
|
* [@alyssais] made their first contribution in [#829]
|
||||||
|
* [@nascosto] made their first contribution in [#857]
|
||||||
|
* [@SPGoding] made their first contribution in [#876]
|
||||||
|
* [@iridazzle] made their first contribution in [#727]
|
||||||
|
* [@ivanskodje] made their first contribution in [#891]
|
||||||
|
* [@Eisverygoodletter] made their first contribution in [#893]
|
||||||
|
|
||||||
|
[@AdityaTiwari2102]: https://github.com/AdityaTiwari2102
|
||||||
|
[@svrooij]: https://github.com/svrooij
|
||||||
|
[@alexsegura]: https://github.com/alexsegura
|
||||||
|
[@burner1024]: https://github.com/burner1024
|
||||||
|
[@JeffGuKang]: https://github.com/JeffGuKang
|
||||||
|
[@dougaitken]: https://github.com/dougaitken
|
||||||
|
[@max06]: https://github.com/max06
|
||||||
|
[@sehilyi]: https://github.com/sehilyi
|
||||||
|
[@nathanjessen]: https://github.com/nathanjessen
|
||||||
|
[@waldyrious]: https://github.com/waldyrious
|
||||||
|
[@MichelleBlanchette]: https://github.com/MichelleBlanchette
|
||||||
|
[@henryiii]: https://github.com/henryiii
|
||||||
|
[@jmertic]: https://github.com/jmertic
|
||||||
|
[@jacobhq]: https://github.com/jacobhq
|
||||||
|
[@UnclassedPenguin]: https://github.com/UnclassedPenguin
|
||||||
|
[@alyssais]: https://github.com/alyssais
|
||||||
|
[@nascosto]: https://github.com/nascosto
|
||||||
|
[@SPGoding]: https://github.com/SPGoding
|
||||||
|
[@iridazzle]: https://github.com/iridazzle
|
||||||
|
[@ivanskodje]: https://github.com/ivanskodje
|
||||||
|
[@Eisverygoodletter]: https://github.com/Eisverygoodletter
|
||||||
|
|
||||||
|
**Full Changelog**: https://github.com/just-the-docs/just-the-docs/compare/v0.3.3...v0.4.0.rc1
|
||||||
|
|
||||||
|
[@pmarsceill]: https://github.com/pmarsceill
|
||||||
|
|
||||||
|
## v0.3.3
|
||||||
|
|
||||||
|
### 🚀 Features
|
||||||
|
|
||||||
|
- Add custom header and footer include files @CodeSandwich (#334)
|
||||||
|
|
||||||
|
### 🐛 Bug Fixes
|
||||||
|
|
||||||
|
- Limit the effect of `nav_exclude` to the main navigation @pdmosses (#443)
|
||||||
|
- Update normalize.scss @pdmosses (#444)
|
||||||
|
- Update code.scss @pdmosses (#445)
|
||||||
|
- Fix list alignment @pdmosses (#446)
|
||||||
|
|
||||||
|
### 🧰 Maintenance
|
||||||
|
|
||||||
|
- Bump stylelint-config-primer from 9.0.0 to 9.2.1 @dependabot-preview (#451)
|
||||||
|
- Bump stylelint from 13.6.1 to 13.7.2 @dependabot-preview (#440)
|
||||||
|
- Bump @primer/css from 15.1.0 to 15.2.0 @dependabot-preview (#436)
|
||||||
|
- Bump prettier from 2.1.1 to 2.1.2 @dependabot-preview (#429)
|
||||||
|
|
||||||
|
## v0.3.2
|
||||||
|
|
||||||
|
### Changes
|
||||||
|
|
||||||
|
- Safe page sorting @pdmosses (#411)
|
||||||
|
- v0.3.2 @pmarsceill (#388)
|
||||||
|
|
||||||
|
### 🚀 Features
|
||||||
|
|
||||||
|
- make font-sizes sass variables so they can be changed @pdebruic (#361)
|
||||||
|
- run the site locally inside docker container @fogfish (#398)
|
||||||
|
- Feature/doc collections @SgtSilvio (#379)
|
||||||
|
- Adjust dl layout @pdmosses (#401)
|
||||||
|
|
||||||
|
### 🐛 Bug Fixes
|
||||||
|
|
||||||
|
- Add site.gh_edit_source to "Edit this page on GitHub" link @mrfleap (#418)
|
||||||
|
- Inhibit text-transform for code in h4 @pdmosses (#404)
|
||||||
|
- Fix native font stack precedence issue on Windows systems. @hvianna (#331)
|
||||||
|
- Support for the linenos option on highlighted code @pdmosses (#375)
|
||||||
|
- Update anchor_headings.html @pdmosses (#399)
|
||||||
|
- Fix https @marksie1988 (#359)
|
||||||
|
|
||||||
|
### 🧰 Maintenance
|
||||||
|
|
||||||
|
- Bump prettier from 2.0.5 to 2.1.1 @dependabot-preview (#427)
|
||||||
|
- Bump prettier from 2.0.5 to 2.1.1 @dependabot-preview (#419)
|
||||||
|
- [Security] Bump lodash from 4.17.15 to 4.17.19 @dependabot-preview (#389)
|
||||||
|
- Bump @primer/css from 14.4.0 to 15.1.0 @dependabot-preview (#402)
|
||||||
|
- Bump lodash from 4.17.15 to 4.17.19 @dependabot (#384)
|
||||||
|
- Bump @primer/css from 14.4.0 to 15.0.0 @dependabot-preview (#371)
|
||||||
|
|
||||||
|
|
||||||
|
## v0.3.1
|
||||||
|
|
||||||
|
### Changes
|
||||||
|
|
||||||
|
### 🐛 Bug Fixes
|
||||||
|
|
||||||
|
- Improve accessibility by adding label to Anchor links. @mscoutermarsh (#376)
|
||||||
|
|
||||||
|
### 🧰 Maintenance
|
||||||
|
|
||||||
|
- Remove collapsible TOC on nav doc @pmarsceill (#368)
|
||||||
|
- Pdmosses collapsible toc @pmarsceill (#367)
|
||||||
|
|
||||||
|
|
||||||
|
## v0.3.0
|
||||||
|
|
||||||
|
### Changes
|
||||||
|
|
||||||
|
- v0.2.9 @pmarsceill (#306)
|
||||||
|
|
||||||
|
### 🚀 Features
|
||||||
|
|
||||||
|
- Add print styles @pmarsceill (#362)
|
||||||
|
- Navigation improvements and search sections @SgtSilvio (#352)
|
||||||
|
|
||||||
|
### 🐛 Bug Fixes
|
||||||
|
|
||||||
|
- Remove constraint with jekyll 4.1.0 @PierrickMartos (#348)
|
||||||
|
|
||||||
|
### 🧰 Maintenance
|
||||||
|
|
||||||
|
- Bump version numbers @pmarsceill (#360)
|
||||||
|
- Bump stylelint from 13.3.3 to 13.6.1 @dependabot-preview (#343)
|
||||||
|
- Bump stylelint-config-prettier from 8.0.1 to 8.0.2 @dependabot-preview (#349)
|
||||||
|
|
||||||
|
|
||||||
|
## v0.2.9
|
||||||
|
|
||||||
|
### Bug fixes
|
||||||
|
- Horizontal Alignment #103 @pmarsceill
|
||||||
|
- Code snippet in headers do not inherit font size #140 @pmarsceill
|
||||||
|
- Fix duplicated title and description tags #294 @iefserge
|
||||||
|
- Update nav.html for handling nav_exclude #282 @blawqchain
|
||||||
|
- Fix duplicate entries in nav.html and default.html #239 @KasparEtter
|
||||||
|
- Don't show pages with no title (e.g. redirects in nav) https://github.com/pmarsceill/just-the-docs/pull/295/commits/672de29f2e332a9350af7237e4fb6693c848989e @SgtSilvio
|
||||||
|
- [SEARCH RAKE] Fix search generator #319 @RoiArthurB
|
||||||
|
|
||||||
|
### Enhancements
|
||||||
|
- Improvement/custom themes #186 @SgtSilvio
|
||||||
|
- feat: adds "edit this page" and "page last modified" to footer #217 @malsf21
|
||||||
|
- feat: adds option to open aux links in new tab #229 @malsf21
|
||||||
|
- Default nav order #236 @pdmosses
|
||||||
|
- Enable IP anonymization in Google Analytics (GDPR) #250 @r-brown
|
||||||
|
|
||||||
|
closes #240 #308 #266 #140 #103
|
||||||
|
|
||||||
|
## v0.2.8
|
||||||
|
|
||||||
|
### Bugfixes
|
||||||
|
- bugfix in search.rake #218 @tiaitsch85
|
||||||
|
|
||||||
|
### Dependency and security updates:
|
||||||
|
|
||||||
|
- Update jekyll requirement from ~> 3.8.5 to >= 3.8.5, < 4.1.0 #197 @dependabot-preview
|
||||||
|
- Update rake requirement from ~> 12.3.1 to >= 12.3.1, < 13.1.0 #227 @dependabot-preview
|
||||||
|
- Bump stylelint-config-primer from 8.0.0 to 9.0.0 #247 @dependabot-preview
|
||||||
|
- Update bundler requirement from ~> 2.0.1 to ~> 2.1.4 #268 @dependabot-preview
|
||||||
|
- Bump @primer/css from 12.7.0 to 14.3.0 #296 @dependabot-preview
|
||||||
|
|
||||||
|
### Operations
|
||||||
|
|
||||||
|
- Update CI to test multiple versions of Jekyll
|
||||||
|
- Update CI to check the rake command that builds the search file
|
||||||
|
|
||||||
|
fixes #291 #256 #293 #177
|
||||||
|
|
||||||
|
## v0.2.7
|
||||||
|
|
||||||
|
### Bugs fixed
|
||||||
|
- Anchor headings are now displayed on hover, not only on heading hover
|
||||||
|
- Deduplicated anchor heading svg
|
||||||
|
- If last page of `site.html_pages` was excluded from search, search json breaks
|
||||||
|
- Config variable should be `blanklines` not `blank_lines` for html compression
|
||||||
|
- `list-style-none` does not hide bullets on `ul`
|
||||||
|
|
||||||
|
### Enhancements
|
||||||
|
- Summary for child pages appears in generated TOC
|
||||||
|
- Site logo configuration supported replacing title text with image
|
||||||
|
- Allow custom CSS overrides (new scss partial at the end of the cascade) separate from variable overrides.
|
||||||
|
- Configuration around search strings added to allow search for hyphenated words
|
||||||
|
|
||||||
|
### Maintenance
|
||||||
|
- Update docs to suggest using index.md as section page filename
|
||||||
|
- Bump @primer/css from 12.6.0 to 12.7.0
|
||||||
|
- Bump mixin-deep from 1.3.1 to 1.3.2
|
||||||
|
- Bump stylelint-config-primer from 7.0.1 to 8.0.0
|
||||||
|
|
||||||
|
### PR included
|
||||||
|
- #98 by @stefanoborini Introduces the possibility for a summary in the table of contents
|
||||||
|
- #141 by @ghabs Fix trailing comma bug in search-data.json
|
||||||
|
- #153 by @jacobherrington Change button copy on theme preview
|
||||||
|
- #181 by @m3nu Recommend using index.md as parent page for sections
|
||||||
|
- #183 by @SgtSilvio Improve heading anchors
|
||||||
|
- #187 by @SgtSilvio Improvement/site logo
|
||||||
|
- #200 Bump mixin-deep from 1.3.1 to 1.3.2
|
||||||
|
- #203 by @pdmosses Search config
|
||||||
|
- #205 by @pdmosses Fix blank_lines var to blanklines in config.yml
|
||||||
|
- #206 by @iamcarrico Allow for custom overrides by the user
|
||||||
|
- #208 Bump @primer/css from 12.6.0 to 12.7.0
|
||||||
|
- #213 Bump mixin-deep from 1.3.1 to 1.3.2
|
||||||
|
- #214 Bump stylelint-config-primer from 7.0.1 to 8.0.0
|
||||||
|
- #215 Bump @primer/css from 12.6.0 to 12.7.0
|
||||||
|
|
||||||
|
## v0.2.6
|
||||||
|
|
||||||
|
### Bugs fixed
|
||||||
|
- Google Analytics tag has been updated #162
|
||||||
|
- ~BaseURL has been modified #109~ Reverted -- seems the existing implementation worked
|
||||||
|
- Titles can now wrap fixes #106
|
||||||
|
|
||||||
|
### Enhancements
|
||||||
|
- Search now displays content preview #135
|
||||||
|
- Custom footer content added #179
|
||||||
|
- Now using GitHub Actions for CI #170
|
||||||
|
|
||||||
|
### Maintenance
|
||||||
|
- lunrjs upgraded #135
|
||||||
|
- Nav generation is optimized #159
|
||||||
|
- Stylelint upgrade #143
|
||||||
|
- Stylelint config primer upgrade #149
|
||||||
|
- Lodash upgrade #160
|
||||||
|
|
||||||
|
### PR included
|
||||||
|
~#109 by @daviddarnes - Fix baseurl link~ Reverted
|
||||||
|
#135 by @SgtSilvio - Upgrades lunr.js, improves search UI, adds heading anchors
|
||||||
|
#152 by @yavorg - Improves syntax highlighting for js readablity
|
||||||
|
#159 by @julienduchesne - Optimizes nav generation
|
||||||
|
#162 by @nergmada - Modifies the google analytics code to match the new tags used by GA
|
||||||
|
|
||||||
|
|
||||||
|
## v0.2.5
|
||||||
|
|
||||||
|
### Bugs fixed
|
||||||
|
|
||||||
|
- Duplicate title tag when Jekyll SEO Plugin gem is used #125 #126
|
||||||
|
|
||||||
|
### Enhancements
|
||||||
|
|
||||||
|
- Favicon support added #118
|
||||||
|
|
||||||
|
### Maintenance
|
||||||
|
- Bump stylelint-config-primer from 6.0.0 to 7.0.0 #123
|
||||||
|
- Bump @primer/css from 12.2.3 to 12.3.1 #129
|
||||||
|
- Add workflow to publish to GPR
|
||||||
|
- Fix workflow to publish to Ruby Gems
|
||||||
|
|
||||||
|
## v0.2.4
|
||||||
|
|
||||||
|
### Bugs
|
||||||
|
|
||||||
|
- #102 Remove unnecessary console.log() @JoeNyland
|
||||||
|
- #97 Import custom Sass variable overrides before default variables are defined @montchr and @ptvandi
|
||||||
|
|
||||||
|
### Additions
|
||||||
|
- #117 Add links to docs for setting up GH pages locally @gnarea
|
||||||
|
- #95 Add SEO and 'lang' param for `_config` @gebeto
|
||||||
|
|
||||||
|
## v0.2.3
|
||||||
|
|
||||||
|
### Enhancements
|
||||||
|
- Adds ability to use Google Analytics tracking by @pmarsceill
|
||||||
|
|
||||||
|
### Bug fixes
|
||||||
|
- Fixes 404 error for "/assets/js//search-data.json" by @stephenedmondson
|
||||||
|
- Fixes #80 Single quotes in the string were unescaped and ruby attempted variable substitution of amp within it (which failed) by @novelistparty
|
||||||
|
- Fixes bug that would only show 2 or more search results (not one) by @ilivewithian
|
||||||
|
- Fixes a typo on the layout example by @woernfl
|
||||||
|
- Fixes #78 Page scroll position too far down on load by @pmarsceill
|
||||||
|
- Fixds ability to nest ul in ol without breaking style or counters
|
||||||
|
|
||||||
|
### Dependency updates
|
||||||
|
- Bumps stylelint dependency from 9.9.0 to 9.10.1
|
||||||
|
|
||||||
|
## v0.2.2
|
||||||
|
|
||||||
|
- Bumps stylelint-config-primer to 3.0.1 #44
|
||||||
|
- Bumps bundler req to 2.0.1 #61
|
||||||
|
- Adds custom 404 page
|
||||||
|
- Excludes package-lock.json from jekyll build #47
|
||||||
|
- Fixes keyboard scrolling / focus #48
|
||||||
|
- Adds ARIA roles to navigation elements
|
||||||
|
- Adds support for optional page description metadata (if present in yaml front matter)
|
||||||
|
- Addresses some issues with search in #46
|
||||||
|
- Option to hide TOC on parent pages if turned off in page's YAML front matter #30
|
||||||
|
- Option to suppress an item from being indexed by search if present in page's YAML front matter #32
|
||||||
|
|
||||||
|
## v0.2.1
|
||||||
|
|
||||||
|
This update fixes security vulnerablities in the lodash sub-dependency and bumps other dev dependencies to their latest version.
|
||||||
|
|
||||||
|
## v0.2.0
|
||||||
|
|
||||||
|
Adds:
|
||||||
|
- Dark mode via `color_scheme` parameter
|
||||||
|
- Ability to exclude a page from the main nav with `nav_exclude` parameter closes #21
|
||||||
|
- Ability for create children of children pages (3 nav levels) closes #25
|
||||||
|
|
||||||
|
Changes:
|
||||||
|
- Permalink structure for tiered navigation has been updated
|
||||||
|
- Some colors have been updated for consistency / accessibility
|
||||||
|
|
||||||
|
## v0.1.6
|
||||||
|
|
||||||
|
### Added
|
||||||
|
|
||||||
|
- Support for task list styles #19
|
||||||
|
- Configuration docs
|
||||||
|
- Configuration option to enable / disable search
|
||||||
|
- Normalize.scss dependency pulled into project #16 #
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
|
||||||
|
- Layout bug in navigation #17
|
||||||
|
|
||||||
|
## v0.1.5
|
||||||
|
|
||||||
|
Major changes:
|
||||||
|
|
||||||
|
- Fixed bug where the rake task would fail when the assets/js directory didn't exist
|
||||||
|
|
||||||
|
## v0.1.4
|
||||||
|
|
||||||
|
Major changes:
|
||||||
|
- Adds Rake as a runtime dependency
|
||||||
|
- Definition list styled
|
||||||
|
- Sidebar and support cleaned up for smaller screen support
|
||||||
|
- Updated some stale docs
|
||||||
|
|
||||||
|
## v0.1.3
|
||||||
|
|
||||||
|
Major changes:
|
||||||
|
- Fix path problems, typos, and general clean-up for OSS.
|
||||||
|
|
||||||
|
## v0.1.2
|
||||||
|
|
||||||
|
Fix paths when deployed to gh-pages
|
||||||
|
|
||||||
|
## v0.1.1
|
||||||
|
|
||||||
|
Major updates:
|
||||||
|
- Adds search to mobile nav
|
||||||
|
- Pulls footer to bottom of the page on mobile (not hidden in nav)
|
||||||
|
|
||||||
|
Minor updates:
|
||||||
|
- Cleans up h1 typography spacing
|
@@ -2,45 +2,131 @@
|
|||||||
|
|
||||||
## Our Pledge
|
## Our Pledge
|
||||||
|
|
||||||
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
|
We as members, contributors, and leaders pledge to make participation in our
|
||||||
|
community a harassment-free experience for everyone, regardless of age, body
|
||||||
|
size, visible or invisible disability, ethnicity, sex characteristics, gender
|
||||||
|
identity and expression, level of experience, education, socio-economic status,
|
||||||
|
nationality, personal appearance, race, caste, color, religion, or sexual
|
||||||
|
identity and orientation.
|
||||||
|
|
||||||
|
We pledge to act and interact in ways that contribute to an open, welcoming,
|
||||||
|
diverse, inclusive, and healthy community.
|
||||||
|
|
||||||
## Our Standards
|
## Our Standards
|
||||||
|
|
||||||
Examples of behavior that contributes to creating a positive environment include:
|
Examples of behavior that contributes to a positive environment for our
|
||||||
|
community include:
|
||||||
|
|
||||||
* Using welcoming and inclusive language
|
* Demonstrating empathy and kindness toward other people
|
||||||
* Being respectful of differing viewpoints and experiences
|
* Being respectful of differing opinions, viewpoints, and experiences
|
||||||
* Gracefully accepting constructive criticism
|
* Giving and gracefully accepting constructive feedback
|
||||||
* Focusing on what is best for the community
|
* Accepting responsibility and apologizing to those affected by our mistakes,
|
||||||
* Showing empathy towards other community members
|
and learning from the experience
|
||||||
|
* Focusing on what is best not just for us as individuals, but for the overall
|
||||||
|
community
|
||||||
|
|
||||||
Examples of unacceptable behavior by participants include:
|
Examples of unacceptable behavior include:
|
||||||
|
|
||||||
* The use of sexualized language or imagery and unwelcome sexual attention or advances
|
* The use of sexualized language or imagery, and sexual attention or advances of
|
||||||
* Trolling, insulting/derogatory comments, and personal or political attacks
|
any kind
|
||||||
|
* Trolling, insulting or derogatory comments, and personal or political attacks
|
||||||
* Public or private harassment
|
* Public or private harassment
|
||||||
* Publishing others' private information, such as a physical or electronic address, without explicit permission
|
* Publishing others' private information, such as a physical or email address,
|
||||||
* Other conduct which could reasonably be considered inappropriate in a professional setting
|
without their explicit permission
|
||||||
|
* Other conduct which could reasonably be considered inappropriate in a
|
||||||
|
professional setting
|
||||||
|
|
||||||
## Our Responsibilities
|
## Enforcement Responsibilities
|
||||||
|
|
||||||
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
|
Community leaders are responsible for clarifying and enforcing our standards of
|
||||||
|
acceptable behavior and will take appropriate and fair corrective action in
|
||||||
|
response to any behavior that they deem inappropriate, threatening, offensive,
|
||||||
|
or harmful.
|
||||||
|
|
||||||
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
|
Community leaders have the right and responsibility to remove, edit, or reject
|
||||||
|
comments, commits, code, wiki edits, issues, and other contributions that are
|
||||||
|
not aligned to this Code of Conduct, and will communicate reasons for moderation
|
||||||
|
decisions when appropriate.
|
||||||
|
|
||||||
## Scope
|
## Scope
|
||||||
|
|
||||||
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
|
This Code of Conduct applies within all community spaces, and also applies when
|
||||||
|
an individual is officially representing the community in public spaces.
|
||||||
|
Examples of representing our community include using an official e-mail address,
|
||||||
|
posting via an official social media account, or acting as an appointed
|
||||||
|
representative at an online or offline event.
|
||||||
|
|
||||||
## Enforcement
|
## Enforcement
|
||||||
|
|
||||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at patrick.marsceill@gmail.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
|
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
||||||
|
reported to the community leaders responsible for enforcement at
|
||||||
|
patrick.marsceill@gmail.com.
|
||||||
|
All complaints will be reviewed and investigated promptly and fairly.
|
||||||
|
|
||||||
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
|
All community leaders are obligated to respect the privacy and security of the
|
||||||
|
reporter of any incident.
|
||||||
|
|
||||||
|
## Enforcement Guidelines
|
||||||
|
|
||||||
|
Community leaders will follow these Community Impact Guidelines in determining
|
||||||
|
the consequences for any action they deem in violation of this Code of Conduct:
|
||||||
|
|
||||||
|
### 1. Correction
|
||||||
|
|
||||||
|
**Community Impact**: Use of inappropriate language or other behavior deemed
|
||||||
|
unprofessional or unwelcome in the community.
|
||||||
|
|
||||||
|
**Consequence**: A private, written warning from community leaders, providing
|
||||||
|
clarity around the nature of the violation and an explanation of why the
|
||||||
|
behavior was inappropriate. A public apology may be requested.
|
||||||
|
|
||||||
|
### 2. Warning
|
||||||
|
|
||||||
|
**Community Impact**: A violation through a single incident or series of
|
||||||
|
actions.
|
||||||
|
|
||||||
|
**Consequence**: A warning with consequences for continued behavior. No
|
||||||
|
interaction with the people involved, including unsolicited interaction with
|
||||||
|
those enforcing the Code of Conduct, for a specified period of time. This
|
||||||
|
includes avoiding interactions in community spaces as well as external channels
|
||||||
|
like social media. Violating these terms may lead to a temporary or permanent
|
||||||
|
ban.
|
||||||
|
|
||||||
|
### 3. Temporary Ban
|
||||||
|
|
||||||
|
**Community Impact**: A serious violation of community standards, including
|
||||||
|
sustained inappropriate behavior.
|
||||||
|
|
||||||
|
**Consequence**: A temporary ban from any sort of interaction or public
|
||||||
|
communication with the community for a specified period of time. No public or
|
||||||
|
private interaction with the people involved, including unsolicited interaction
|
||||||
|
with those enforcing the Code of Conduct, is allowed during this period.
|
||||||
|
Violating these terms may lead to a permanent ban.
|
||||||
|
|
||||||
|
### 4. Permanent Ban
|
||||||
|
|
||||||
|
**Community Impact**: Demonstrating a pattern of violation of community
|
||||||
|
standards, including sustained inappropriate behavior, harassment of an
|
||||||
|
individual, or aggression toward or disparagement of classes of individuals.
|
||||||
|
|
||||||
|
**Consequence**: A permanent ban from any sort of public interaction within the
|
||||||
|
community.
|
||||||
|
|
||||||
## Attribution
|
## Attribution
|
||||||
|
|
||||||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
|
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
||||||
|
version 2.1, available at
|
||||||
|
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
|
||||||
|
|
||||||
[homepage]: http://contributor-covenant.org
|
Community Impact Guidelines were inspired by
|
||||||
[version]: http://contributor-covenant.org/version/1/4/
|
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
|
||||||
|
|
||||||
|
For answers to common questions about this code of conduct, see the FAQ at
|
||||||
|
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
|
||||||
|
[https://www.contributor-covenant.org/translations][translations].
|
||||||
|
|
||||||
|
[homepage]: https://www.contributor-covenant.org
|
||||||
|
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
|
||||||
|
[Mozilla CoC]: https://github.com/mozilla/diversity
|
||||||
|
[FAQ]: https://www.contributor-covenant.org/faq
|
||||||
|
[translations]: https://www.contributor-covenant.org/translations
|
||||||
|
12
Dockerfile
Normal file
12
Dockerfile
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
FROM ruby:2.7
|
||||||
|
|
||||||
|
ENV LC_ALL C.UTF-8
|
||||||
|
ENV LANG en_US.UTF-8
|
||||||
|
ENV LANGUAGE en_US.UTF-8
|
||||||
|
|
||||||
|
WORKDIR /usr/src/app
|
||||||
|
|
||||||
|
COPY Gemfile just-the-docs.gemspec ./
|
||||||
|
RUN gem install bundler && bundle install
|
||||||
|
|
||||||
|
EXPOSE 4000
|
2
Gemfile
2
Gemfile
@@ -1,2 +1,4 @@
|
|||||||
source "https://rubygems.org"
|
source "https://rubygems.org"
|
||||||
gemspec
|
gemspec
|
||||||
|
|
||||||
|
gem "webrick", "~> 1.7"
|
||||||
|
404
MIGRATION.md
Normal file
404
MIGRATION.md
Normal file
@@ -0,0 +1,404 @@
|
|||||||
|
---
|
||||||
|
title: Migration and Upgrading
|
||||||
|
layout: default
|
||||||
|
---
|
||||||
|
|
||||||
|
# Migrating and Upgrading
|
||||||
|
|
||||||
|
Summary
|
||||||
|
: A site that uses `just-the-docs` (as a theme or as a remote them) automatically
|
||||||
|
switches to a new release, unless it is pinned to a previous version.
|
||||||
|
|
||||||
|
This migration guide draws attention to:
|
||||||
|
|
||||||
|
- changes that might break your site,
|
||||||
|
- features added in the latest release, and
|
||||||
|
- features that have become deprecated (and are likely to be removed in a future release).
|
||||||
|
|
||||||
|
This document contains instructions on how to migrate and upgrade Just the Docs sites from every minor or major version bump, starting from `v0.3.3` to `v0.4.0`.
|
||||||
|
|
||||||
|
<details open markdown="block">
|
||||||
|
<summary>
|
||||||
|
Table of contents
|
||||||
|
</summary>
|
||||||
|
{: .text-delta }
|
||||||
|
- TOC
|
||||||
|
{:toc}
|
||||||
|
</details>
|
||||||
|
|
||||||
|
{::options toc_levels="2..4" /}
|
||||||
|
|
||||||
|
{: .warning }
|
||||||
|
> If your configuration states `remote_theme: just-the-docs/just-the-docs`, your
|
||||||
|
> website is built using the current `main` branch of the theme, which may include
|
||||||
|
> changes made after the latest release; see the [CHANGELOG].
|
||||||
|
>
|
||||||
|
> If your configuration states `theme: just the docs` and your `Gemfile` specifies
|
||||||
|
> `gem "just-the-docs"`, your website is always built using the latest release.
|
||||||
|
|
||||||
|
{: .note }
|
||||||
|
> If you have cloned/forked and customised the theme repo,
|
||||||
|
> and pull the changes of a new release to your clone,
|
||||||
|
> you may need to resolve merge conflicts.
|
||||||
|
|
||||||
|
[CHANGELOG]: {{ site.baseurl }}{% link CHANGELOG.md %}
|
||||||
|
|
||||||
|
## v0.3.3 … v0.4.x
|
||||||
|
|
||||||
|
### REPOSITORY CHANGES
|
||||||
|
|
||||||
|
#### Just the Docs
|
||||||
|
|
||||||
|
The theme repo is now at <https://github.com/just-the-docs/just-the-docs>.
|
||||||
|
The name of its default branch is now `main`.
|
||||||
|
|
||||||
|
The theme docs website is now published at <https://just-the-docs.github.io/just-the-docs>.
|
||||||
|
|
||||||
|
GitHub provides access to previous versions of the theme repo.
|
||||||
|
You can browse [previous versions of the theme docs website] on the [Internet Archive].
|
||||||
|
|
||||||
|
[previous versions of the theme docs website]: https://web.archive.org/web/20220000000000*/https://just-the-docs.github.io/just-the-docs
|
||||||
|
[Internet Archive]: https://web.archive.org/
|
||||||
|
|
||||||
|
The [README] page on the theme repo repeats much of the information from the [home page],
|
||||||
|
formatted for browsing on GitHub.
|
||||||
|
It also explains how to install the theme as a Ruby Gem, without creating a new site.
|
||||||
|
|
||||||
|
[README]: https://github.com/just-the-docs/just-the-docs/blob/main/README.md
|
||||||
|
[home page]: https://just-the-docs.github.io/just-the-docs
|
||||||
|
|
||||||
|
#### Deploy previews
|
||||||
|
|
||||||
|
When a PR builds successfully, Netlify provides a preview of how the theme docs website will look if the PR is merged.
|
||||||
|
You can find links to the preview near the bottom of the Conversation tab of the PR.
|
||||||
|
|
||||||
|
#### Just the Docs Template
|
||||||
|
|
||||||
|
The template at <https://github.com/just-the-docs/just-the-docs-template>
|
||||||
|
creates a repo with the minimal source files for a Just the Docs website.
|
||||||
|
After configuring the relevant parameters, you can build and serve the website
|
||||||
|
both locally and on GitHub Pages – using either Jekyll 3 or Jekyll 4!
|
||||||
|
|
||||||
|
#### Just the Docs Tests
|
||||||
|
|
||||||
|
The tests website at <https://just-the-docs.github.io/just-the-docs-tests>
|
||||||
|
consists mainly of regression tests for bug fixes and new features.
|
||||||
|
|
||||||
|
The test source files at <https://github.com/just-the-docs/just-the-docs-tests>
|
||||||
|
illustrate the use of many Markdown and Jekyll features,
|
||||||
|
including some that are not included in the theme docs.
|
||||||
|
|
||||||
|
For example, see how to add support for rendering TeX/LaTeX [math formulas] with KaTeX and MathJax.
|
||||||
|
|
||||||
|
[math formulas]: https://just-the-docs.github.io/just-the-docs-tests/components/math/index/
|
||||||
|
|
||||||
|
### POTENTIALLY-BREAKING CHANGES in v0.4.0
|
||||||
|
|
||||||
|
If switching to a new release of the theme breaks your website,
|
||||||
|
check that you don't have any files in the `_includes`, `_layouts`, and `_sass`
|
||||||
|
directories with the same names as files provided by the theme.
|
||||||
|
|
||||||
|
If your repo has a customised copy of `_layouts/default.html` from a previous release,
|
||||||
|
try removing it, or replace it by a fresh copy of the theme file.
|
||||||
|
|
||||||
|
{: .warning }
|
||||||
|
The following changes made in v0.4.0 *might* break or adversely affect your website
|
||||||
|
when you next rebuild it, unless you have pinned it!
|
||||||
|
|
||||||
|
#### New includes and SCSS
|
||||||
|
|
||||||
|
Version 0.4.0 introduces many new `_includes` files. If you already have an existing include with the same name as a new addition, you will need to migrate or update that include. The new files are (relative to the `_includes` folder):
|
||||||
|
|
||||||
|
- `mermaid_config.js`
|
||||||
|
- `nav_footer_custom`
|
||||||
|
- `search_placeholder_custom`
|
||||||
|
- `toc_heading_custom`
|
||||||
|
- the entire `components/` folder:
|
||||||
|
- `aux_nav`, `breadcrumbs`, `children_nav`, `footer`, `header`, `mermaid`, `search_footer`, `search_header`, `sidebar`
|
||||||
|
- the entire `icons/` folder
|
||||||
|
- `code_copy`, `document`, `expand`, `external_link`, `icons`, `link`, `menu`, `search`
|
||||||
|
- the entire `lunr/` folder
|
||||||
|
- `custom-data.json`, `custom-index.js`
|
||||||
|
|
||||||
|
We have removed some code in `_sass/vendor` and added a new file at `_sass/custom/setup.scss`.
|
||||||
|
|
||||||
|
#### favicons
|
||||||
|
|
||||||
|
The file `_includes/favicon.html` is now ignored by the theme.
|
||||||
|
If you're using it, your website's favicon is no longer displayed by browsers.
|
||||||
|
|
||||||
|
To fix: Move the content of `_includes/favicon.html` to `_includes/head_custom.html`.
|
||||||
|
|
||||||
|
#### Custom callout colors
|
||||||
|
|
||||||
|
The file `_sass/custom/custom.scss` is now imported last: _after_ the configuration of callouts.
|
||||||
|
If you've defined custom color variables for callouts in `_sass/custom/custom.scss`
|
||||||
|
(and used them when configuring your callouts in `_config.yml`)
|
||||||
|
you will not be able to rebuild your website.
|
||||||
|
|
||||||
|
To fix: Move custom color variables for callouts in `_sass/custom/custom.scss` to `_sass/custom/variables.scss`.
|
||||||
|
|
||||||
|
#### Pages and collections
|
||||||
|
|
||||||
|
Links to ordinary pages now appear in the navigation on sites that use collections.
|
||||||
|
You might want the navigation of your site to consist entirely of collections.
|
||||||
|
|
||||||
|
To fix: Add the front matter `nav_exclude: true` to pages that the navigation should not display.
|
||||||
|
|
||||||
|
#### Relative URLs
|
||||||
|
|
||||||
|
All generated URLs are now relative.
|
||||||
|
This is a bug fix, and unlikely to break any site.
|
||||||
|
|
||||||
|
Relative links to pages within a website support deployment to different servers.
|
||||||
|
|
||||||
|
#### Navigation order
|
||||||
|
|
||||||
|
The order in which the navigation panel lists pages has been simplified.
|
||||||
|
All pages with `nav_order` values now come before all pages that are ordered by `title`.
|
||||||
|
|
||||||
|
If your website has a group of *sibling* pages where some siblings have `nav_order`
|
||||||
|
string values, and others are ordered by numerical `title` values,
|
||||||
|
the former now come before the latter.
|
||||||
|
|
||||||
|
To fix: Add numerical `nav_order` values to the pages with numerical `title` values.
|
||||||
|
|
||||||
|
### DEPRECATIONS
|
||||||
|
|
||||||
|
{: .warning }
|
||||||
|
The following features are deprecated, and to be removed in a future release.
|
||||||
|
|
||||||
|
#### Jekyll 3
|
||||||
|
|
||||||
|
You can still use Jekyll 3 (3.8.5 or later) to build websites using v0.4.0 of the theme.
|
||||||
|
However, future releases of the theme may require the use of Jekyll 4.
|
||||||
|
|
||||||
|
You can already use Jekyll 4 to build your website *locally*.
|
||||||
|
It should look exactly the same as when built with Jekyll 3.[^Jekyll4]
|
||||||
|
|
||||||
|
[^Jekyll4]:
|
||||||
|
Jekyll 4 depends on more recent versions of other gems than Jekyll 3,
|
||||||
|
and the differences between those versions may affect the files of your built site.
|
||||||
|
|
||||||
|
To use Jekyll 4 when building your website *on GitHub Pages*, you need to run GitHub Actions.
|
||||||
|
The simplest way of setting that up in a new repo is to create the repo using the Just the Docs template.
|
||||||
|
To start running Jekyll 4 to build an existing repo on GitHub Pages,
|
||||||
|
you can create a new repo with the template, then copy its `.github/workflows` directory,
|
||||||
|
and update your repo settings to use Actions.
|
||||||
|
|
||||||
|
#### Footer content configuration
|
||||||
|
|
||||||
|
Currently, if your configuration sets `footer_content` to some text,
|
||||||
|
the theme displays that text at the bottom of the main section of each page.
|
||||||
|
|
||||||
|
The file `_includes/footer_custom.html` provides a more general way of customizing
|
||||||
|
not only the text but also the markup for the page footer area.
|
||||||
|
|
||||||
|
You can replicate the current display of `TEXT` in the footer using the following markup:
|
||||||
|
|
||||||
|
```html
|
||||||
|
<p class="text-small text-grey-dk-100 mb-0">TEXT</p>
|
||||||
|
```
|
||||||
|
|
||||||
|
### THEME WEBSITE CHANGES
|
||||||
|
|
||||||
|
The website now uses *callouts*[^callouts] to draw attention to important information.
|
||||||
|
|
||||||
|
[^callouts]:
|
||||||
|
The theme website configuration defines the callout titles and colors used there.
|
||||||
|
Websites that use the theme have to configure their own callout titles and colors.
|
||||||
|
|
||||||
|
The theme uses [semantic versioning].
|
||||||
|
A normal version number takes the form X.Y.Z,
|
||||||
|
where X is the major version, Y is the minor version, and Z is the patch version.
|
||||||
|
The theme uses version X.Y.Z.rcN for pre-release N of version X.Y.Z.
|
||||||
|
When referring to version numbers on GitHub, we usually prefix them by 'v'.
|
||||||
|
|
||||||
|
[semantic versioning]: https://semver.org
|
||||||
|
|
||||||
|
Major version zero (0.Y.Z) is for initial development, where anything *may* change at any time.
|
||||||
|
In practice, we increment the patch version Z for bug fixes and backwards compatible changes;
|
||||||
|
we increment the minor version Y for changes that could break websites using the theme
|
||||||
|
without pinning it to a specific version.
|
||||||
|
|
||||||
|
The label `NEW` in the theme website indicates a feature that has been changed or added
|
||||||
|
since the release of the previous *minor* version.
|
||||||
|
For example, after the release of v0.4.Z, the theme website should label `NEW` all features that
|
||||||
|
we have changed or added since v0.3.0 – not just since v0.3.3.
|
||||||
|
When we release v0.5.0, we will remove all those labels, and add labels on features since v0.4.0.
|
||||||
|
|
||||||
|
The theme docs website is not itself versioned.
|
||||||
|
It changes incrementally, independently of theme releases.
|
||||||
|
|
||||||
|
#### Home page
|
||||||
|
|
||||||
|
The theme home page now focuses on the simplest ways of using the theme.
|
||||||
|
It also notes the different behaviour of `theme` and `remote_theme` in connection
|
||||||
|
with interim versions of the theme, such as pre-releases.
|
||||||
|
|
||||||
|
#### CHANGELOG
|
||||||
|
|
||||||
|
The CHANGELOG page lists the changes made in all previous releases and pre-releases of new versions of the theme gem.
|
||||||
|
|
||||||
|
It also lists changes made to the `main` branch of the theme since the latest release or pre-release.
|
||||||
|
|
||||||
|
For changes since v0.3.3, the log usually references the merged PR that made the change and its author.
|
||||||
|
|
||||||
|
### NON-BREAKING CHANGES (OUTLINE ONLY)
|
||||||
|
|
||||||
|
Brief descriptions of the following changes are to be added below.
|
||||||
|
|
||||||
|
#### Accessibility
|
||||||
|
|
||||||
|
- Skip to main content: the first keyboard-navigatable item is now a link to skip over the sidebar and header to the main content of the page. PR: [#949].
|
||||||
|
- Aria-labels: improved `aria-label`s have been added to various site elements. PRs: [#950], ...
|
||||||
|
- Other general improvements: gradual changes have improved tab focusability, contrast, and semantic elements. More work still to come. PRs: [#498], [#846]
|
||||||
|
|
||||||
|
#### Configuration
|
||||||
|
|
||||||
|
- Mermaid support: first-class support for [Mermaid](https://mermaid.js.org/) - a JavaScript-based diagram and charting tool supported by GitHub - has been added to the theme. **This feature is opt-in.** See the new doc subsections in [Configuration]({% link docs/configuration.md %}#mermaid-diagrams) and [Code]({% link docs/ui-components/code.md %}#mermaid-diagram-code-blocks) for more.
|
||||||
|
- Multiple Google Analytics tags are now supported. PR: [#1029]
|
||||||
|
|
||||||
|
#### Customization
|
||||||
|
|
||||||
|
- all user-facing text is now customizable; previously, several elements (ex search placeholder) were hardwired into the theme. Now, users can blend custom includes and layouts to internationalize their sites.
|
||||||
|
- we've clarified the role of `custom.scss` to be imported last; to allow users to define custom or override variables, we've added a new file `setup.scss`. PR: [#1135]
|
||||||
|
|
||||||
|
#### Custom Includes
|
||||||
|
|
||||||
|
We've added several custom `_includes` to provide users with more customization options for different site elements. We've also added a section to [Configuration]({% link docs/customization.md %}#override-includes) to outline these.
|
||||||
|
|
||||||
|
All of these are opt-in by default; however, **these may be breaking if you have existing `_includes` with the same name**.
|
||||||
|
|
||||||
|
Each item is listed with the relevant file and PR.
|
||||||
|
|
||||||
|
- TOC heading: `toc_heading_custom.html`, PR: [#980]
|
||||||
|
- Navigation panel footer: `nav_footer_custom.html`, PR: [#474]
|
||||||
|
- Search placeholder: `search_placeholder_custom.html`, PR: [#613]
|
||||||
|
- Modular site components: `components/` and `icons/`, PR: [#1058]
|
||||||
|
- Custom search indices: `lunr/`, PR: [#1068]
|
||||||
|
|
||||||
|
In a future (version 1) release, we may rename the custom include files.
|
||||||
|
|
||||||
|
#### Modular Components
|
||||||
|
|
||||||
|
We've broken up the default layout (`_layouts/default.html`) into multiple reusable components. This should have no impact on most users; however, it should make it easier to implement custom layouts.
|
||||||
|
|
||||||
|
For more, see [Custom layouts and includes]({% link docs/customization.md %}#custom-layouts-and-includes). PR: [#1058].
|
||||||
|
|
||||||
|
#### Navigation
|
||||||
|
|
||||||
|
- Collections: nav panel shows links to ordinary pages before collections
|
||||||
|
- Collection folding; part of "Combination". PR: [#578]
|
||||||
|
- Scrolling to show link to selected page. PR: [#639]
|
||||||
|
- External nav links are now supported. PR: [#876]
|
||||||
|
- Child nav order: sort navigation pages with `child_nav_order`. PR: [#726]
|
||||||
|
- Order when mixing different ways of specifying nav order
|
||||||
|
|
||||||
|
#### Search
|
||||||
|
|
||||||
|
In addition to customizing the search placeholder, we've also added the ability to provide custom content to the search index. for more, see [Custom content for search index]({% link docs/search.md %}#custom-content-for-search-index). PR: [#1068].
|
||||||
|
|
||||||
|
#### Styling
|
||||||
|
|
||||||
|
- Code copying: code blocks now allow users to easily copy their contents. PR: [#945]
|
||||||
|
- Blockquote: shows vertical bar on left. PR: [#965]
|
||||||
|
- Links wrap. PR: [#905]
|
||||||
|
- Callouts: a new component similar to alerts or banners. See [UI Components - Callouts]({% link docs/ui-components/callouts.md %}). PR: [#466]
|
||||||
|
|
||||||
|
----
|
||||||
|
|
||||||
|
[#856]: https://github.com/just-the-docs/just-the-docs/pull/856
|
||||||
|
[#806]: https://github.com/just-the-docs/just-the-docs/pull/806
|
||||||
|
[#555]: https://github.com/just-the-docs/just-the-docs/pull/555
|
||||||
|
[#814]: https://github.com/just-the-docs/just-the-docs/pull/814
|
||||||
|
[#778]: https://github.com/just-the-docs/just-the-docs/pull/778
|
||||||
|
[#221]: https://github.com/just-the-docs/just-the-docs/pull/221
|
||||||
|
[#782]: https://github.com/just-the-docs/just-the-docs/pull/782
|
||||||
|
[#549]: https://github.com/just-the-docs/just-the-docs/pull/549
|
||||||
|
[#554]: https://github.com/just-the-docs/just-the-docs/pull/554
|
||||||
|
[#499]: https://github.com/just-the-docs/just-the-docs/pull/499
|
||||||
|
[#473]: https://github.com/just-the-docs/just-the-docs/pull/473
|
||||||
|
[#835]: https://github.com/just-the-docs/just-the-docs/pull/835
|
||||||
|
[#891]: https://github.com/just-the-docs/just-the-docs/pull/891
|
||||||
|
[#906]: https://github.com/just-the-docs/just-the-docs/pull/906
|
||||||
|
|
||||||
|
[#578]: https://github.com/just-the-docs/just-the-docs/pull/578
|
||||||
|
[#463]: https://github.com/just-the-docs/just-the-docs/pull/463
|
||||||
|
[#448]: https://github.com/just-the-docs/just-the-docs/pull/448
|
||||||
|
[#466]: https://github.com/just-the-docs/just-the-docs/pull/466
|
||||||
|
[#477]: https://github.com/just-the-docs/just-the-docs/pull/477
|
||||||
|
[#495]: https://github.com/just-the-docs/just-the-docs/pull/495
|
||||||
|
[#496]: https://github.com/just-the-docs/just-the-docs/pull/496
|
||||||
|
[#498]: https://github.com/just-the-docs/just-the-docs/pull/498
|
||||||
|
[#494]: https://github.com/just-the-docs/just-the-docs/pull/494
|
||||||
|
[#639]: https://github.com/just-the-docs/just-the-docs/pull/639
|
||||||
|
[#544]: https://github.com/just-the-docs/just-the-docs/pull/544
|
||||||
|
[#364]: https://github.com/just-the-docs/just-the-docs/pull/364
|
||||||
|
[#498]: https://github.com/just-the-docs/just-the-docs/pull/498
|
||||||
|
[#613]: https://github.com/just-the-docs/just-the-docs/pull/613
|
||||||
|
[#726]: https://github.com/just-the-docs/just-the-docs/pull/726
|
||||||
|
[#474]: https://github.com/just-the-docs/just-the-docs/pull/474
|
||||||
|
[#829]: https://github.com/just-the-docs/just-the-docs/pull/829
|
||||||
|
[#857]: https://github.com/just-the-docs/just-the-docs/pull/857
|
||||||
|
[#876]: https://github.com/just-the-docs/just-the-docs/pull/876
|
||||||
|
[#909]: https://github.com/just-the-docs/just-the-docs/pull/909
|
||||||
|
[#519]: https://github.com/just-the-docs/just-the-docs/pull/519
|
||||||
|
[#855]: https://github.com/just-the-docs/just-the-docs/pull/855
|
||||||
|
[#686]: https://github.com/just-the-docs/just-the-docs/pull/686
|
||||||
|
[#495]: https://github.com/just-the-docs/just-the-docs/pull/495
|
||||||
|
[#846]: https://github.com/just-the-docs/just-the-docs/pull/846
|
||||||
|
[#727]: https://github.com/just-the-docs/just-the-docs/pull/727
|
||||||
|
[#889]: https://github.com/just-the-docs/just-the-docs/pull/889
|
||||||
|
[#893]: https://github.com/just-the-docs/just-the-docs/pull/893
|
||||||
|
[#905]: https://github.com/just-the-docs/just-the-docs/pull/905
|
||||||
|
[#898]: https://github.com/just-the-docs/just-the-docs/pull/898
|
||||||
|
|
||||||
|
[#950]: https://github.com/just-the-docs/just-the-docs/pull/950
|
||||||
|
[#944]: https://github.com/just-the-docs/just-the-docs/pull/944
|
||||||
|
[#939]: https://github.com/just-the-docs/just-the-docs/pull/939
|
||||||
|
[#949]: https://github.com/just-the-docs/just-the-docs/pull/949
|
||||||
|
[#941]: https://github.com/just-the-docs/just-the-docs/pull/941
|
||||||
|
[#956]: https://github.com/just-the-docs/just-the-docs/pull/956
|
||||||
|
[#935]: https://github.com/just-the-docs/just-the-docs/pull/935
|
||||||
|
[#940]: https://github.com/just-the-docs/just-the-docs/pull/940
|
||||||
|
[#951]: https://github.com/just-the-docs/just-the-docs/pull/951
|
||||||
|
[#955]: https://github.com/just-the-docs/just-the-docs/pull/955
|
||||||
|
[#937]: https://github.com/just-the-docs/just-the-docs/pull/937
|
||||||
|
|
||||||
|
[#965]: https://github.com/just-the-docs/just-the-docs/pull/965
|
||||||
|
[#960]: https://github.com/just-the-docs/just-the-docs/pull/960
|
||||||
|
[#962]: https://github.com/just-the-docs/just-the-docs/pull/962
|
||||||
|
[#964]: https://github.com/just-the-docs/just-the-docs/pull/964
|
||||||
|
[#967]: https://github.com/just-the-docs/just-the-docs/pull/967
|
||||||
|
[#974]: https://github.com/just-the-docs/just-the-docs/pull/974
|
||||||
|
[#980]: https://github.com/just-the-docs/just-the-docs/pull/980
|
||||||
|
[#985]: https://github.com/just-the-docs/just-the-docs/pull/985
|
||||||
|
[#986]: https://github.com/just-the-docs/just-the-docs/pull/986
|
||||||
|
[#992]: https://github.com/just-the-docs/just-the-docs/pull/992
|
||||||
|
|
||||||
|
[#945]: https://github.com/just-the-docs/just-the-docs/pull/945
|
||||||
|
[#999]: https://github.com/just-the-docs/just-the-docs/pull/999
|
||||||
|
[#1000]: https://github.com/just-the-docs/just-the-docs/pull/1000
|
||||||
|
[#1001]: https://github.com/just-the-docs/just-the-docs/pull/1001
|
||||||
|
[#1010]: https://github.com/just-the-docs/just-the-docs/pull/1010
|
||||||
|
[#1015]: https://github.com/just-the-docs/just-the-docs/pull/1015
|
||||||
|
[#1018]: https://github.com/just-the-docs/just-the-docs/pull/1018
|
||||||
|
[#1019]: https://github.com/just-the-docs/just-the-docs/pull/1019
|
||||||
|
[#1021]: https://github.com/just-the-docs/just-the-docs/pull/1021
|
||||||
|
[#1027]: https://github.com/just-the-docs/just-the-docs/pull/1027
|
||||||
|
[#1029]: https://github.com/just-the-docs/just-the-docs/pull/1029
|
||||||
|
[#1040]: https://github.com/just-the-docs/just-the-docs/pull/1040
|
||||||
|
[#1061]: https://github.com/just-the-docs/just-the-docs/pull/1061
|
||||||
|
[#1065]: https://github.com/just-the-docs/just-the-docs/pull/1065
|
||||||
|
[#1071]: https://github.com/just-the-docs/just-the-docs/pull/1071
|
||||||
|
[#1074]: https://github.com/just-the-docs/just-the-docs/pull/1074
|
||||||
|
[#1076]: https://github.com/just-the-docs/just-the-docs/pull/1076
|
||||||
|
[#1077]: https://github.com/just-the-docs/just-the-docs/pull/1077
|
||||||
|
[#1090]: https://github.com/just-the-docs/just-the-docs/pull/1090
|
||||||
|
[#1091]: https://github.com/just-the-docs/just-the-docs/pull/1091
|
||||||
|
[#1092]: https://github.com/just-the-docs/just-the-docs/pull/1092
|
||||||
|
[#1095]: https://github.com/just-the-docs/just-the-docs/pull/1095
|
||||||
|
|
||||||
|
[#1068]: https://github.com/just-the-docs/just-the-docs/pull/1068
|
||||||
|
[#1135]: https://github.com/just-the-docs/just-the-docs/pull/1135
|
64
README.md
64
README.md
@@ -1,19 +1,42 @@
|
|||||||
<p align="right">
|
<p align="right">
|
||||||
<a href="https://badge.fury.io/rb/just-the-docs"><img src="https://badge.fury.io/rb/just-the-docs.svg" alt="Gem version"></a> <a href="https://travis-ci.com/pmarsceill/just-the-docs"><img src="https://travis-ci.com/pmarsceill/just-the-docs.svg?branch=master" alt="Build status"></a>
|
<a href="https://badge.fury.io/rb/just-the-docs"><img src="https://badge.fury.io/rb/just-the-docs.svg" alt="Gem version"></a> <a href="https://github.com/just-the-docs/just-the-docs/actions/workflows/ci.yml"><img src="https://github.com/just-the-docs/just-the-docs/actions/workflows/ci.yml/badge.svg" alt="CI Build status"></a> <a href="https://app.netlify.com/sites/just-the-docs/deploys"><img src="https://api.netlify.com/api/v1/badges/9dc0386d-c2a4-4077-ad83-f02c33a6c0ca/deploy-status" alt="Netlify Status"></a>
|
||||||
</p>
|
</p>
|
||||||
<br><br>
|
<br><br>
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<h1 align="center">Just the Docs</h1>
|
<h1 align="center">Just the Docs</h1>
|
||||||
<p align="center">A modern, high customizable, responsive Jekyll theme for documentation with built-in search.<br>Easily hosted on GitHub Pages with few dependencies.</p>
|
<p align="center">A modern, highly customizable, and responsive Jekyll theme for documentation with built-in search.<br>Easily hosted on GitHub Pages with few dependencies.</p>
|
||||||
<p align="center"><strong><a href="https://pmarsceill.github.io/just-the-docs/">See it in action!</a></strong></p>
|
<p align="center"><strong><a href="https://just-the-docs.github.io/just-the-docs/">See it in action!</a></strong></p>
|
||||||
<br><br><br>
|
<br><br><br>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||

|
<p align="center">A video walkthrough of various Just the Docs features</p>
|
||||||
|
|
||||||
|
https://user-images.githubusercontent.com/85418632/211225192-7e5d1116-2f4f-4305-bb9b-437fe47df071.mp4
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
Add this line to your Jekyll site's Gemfile:
|
### Use the template
|
||||||
|
|
||||||
|
The [Just the Docs Template] provides the simplest, quickest, and easiest way to create a new website that uses the Just the Docs theme. To get started with creating a site, just click "[use the template]"!
|
||||||
|
|
||||||
|
Note: To use the theme, you do ***not*** need to clone or fork the [Just the Docs repo]! You should do that only if you intend to browse the theme docs locally, contribute to the development of the theme, or develop a new theme based on Just the Docs.
|
||||||
|
|
||||||
|
You can easily set the site created by the template to be published on [GitHub Pages] – the [template README] file explains how to do that, along with other details.
|
||||||
|
|
||||||
|
If [Jekyll] is installed on your computer, you can also build and preview the created site *locally*. This lets you test changes before committing them, and avoids waiting for GitHub Pages.[^2] And you will be able to deploy your local build to a different platform than GitHub Pages.
|
||||||
|
|
||||||
|
More specifically, the created site:
|
||||||
|
|
||||||
|
- uses a gem-based approach, i.e. uses a `Gemfile` and loads the `just-the-docs` gem
|
||||||
|
- uses the [GitHub Pages / Actions workflow] to build and publish the site on GitHub Pages
|
||||||
|
|
||||||
|
Other than that, you're free to customize sites that you create with the template, however you like. You can easily change the versions of `just-the-docs` and Jekyll it uses, as well as adding further plugins.
|
||||||
|
|
||||||
|
### Use RubyGems
|
||||||
|
|
||||||
|
Alternatively, you can install the theme as a Ruby Gem, without creating a new site.
|
||||||
|
|
||||||
|
Add this line to your Jekyll site's `Gemfile`:
|
||||||
|
|
||||||
```ruby
|
```ruby
|
||||||
gem "just-the-docs"
|
gem "just-the-docs"
|
||||||
@@ -33,20 +56,26 @@ Or install it yourself as:
|
|||||||
|
|
||||||
$ gem install just-the-docs
|
$ gem install just-the-docs
|
||||||
|
|
||||||
|
Alternatively, you can run it inside Docker while developing your site
|
||||||
|
|
||||||
|
$ docker-compose up
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
[View the documentation](https://pmarsceill.github.io/just-the-docs/) for usage information.
|
[View the documentation][Just the Docs] for usage information.
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
Bug reports and pull requests are welcome on GitHub at https://github.com/pmarsceill/just-the-docs. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
|
Bug reports, proposals of new features, and pull requests are welcome on GitHub at https://github.com/just-the-docs/just-the-docs. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
|
||||||
|
|
||||||
### Submitting code changes:
|
### Submitting code changes:
|
||||||
|
|
||||||
- Open a [Pull Request](https://github.com/pmarsceill/just-the-docs/pulls)
|
- Submit an [Issue](https://github.com/just-the-docs/just-the-docs/issues) that motivates the changes, using the appropriate template
|
||||||
|
- Discuss the proposed changes with other users and the maintainers
|
||||||
|
- Open a [Pull Request](https://github.com/just-the-docs/just-the-docs/pulls)
|
||||||
- Ensure all CI tests pass
|
- Ensure all CI tests pass
|
||||||
|
- Provide instructions to check the effect of the changes
|
||||||
- Await code review
|
- Await code review
|
||||||
- Bump the version number in `just-the-docs.gemspec` and `package.json` according to [semantic versioning](https://semver.org/).
|
|
||||||
|
|
||||||
### Design and development principles of this theme:
|
### Design and development principles of this theme:
|
||||||
|
|
||||||
@@ -57,12 +86,25 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/pmarsc
|
|||||||
|
|
||||||
## Development
|
## Development
|
||||||
|
|
||||||
To set up your environment to develop this theme, run `bundle install`.
|
To set up your environment to develop this theme: fork this repo, the run `bundle install` from the root directory.
|
||||||
|
|
||||||
|
A modern [devcontainer configuration](https://code.visualstudio.com/docs/remote/containers) for VSCode is included.
|
||||||
|
|
||||||
Your theme is set up just like a normal Jekyll site! To test your theme, run `bundle exec jekyll serve` and open your browser at `http://localhost:4000`. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.
|
Your theme is set up just like a normal Jekyll site! To test your theme, run `bundle exec jekyll serve` and open your browser at `http://localhost:4000`. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.
|
||||||
|
|
||||||
When the theme is released, only the files in `_layouts`, `_includes`, and `_sass` tracked with Git will be released.
|
When this theme is released, only the files in `_layouts`, `_includes`, and `_sass` tracked with Git will be included in the gem.
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
The theme is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
|
The theme is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
|
||||||
|
|
||||||
|
[^2]: [It can take up to 10 minutes for changes to your site to publish after you push the changes to GitHub](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll#creating-your-site).
|
||||||
|
|
||||||
|
[Jekyll]: https://jekyllrb.com
|
||||||
|
[Just the Docs Template]: https://just-the-docs.github.io/just-the-docs-template/
|
||||||
|
[Just the Docs]: https://just-the-docs.github.io/just-the-docs/
|
||||||
|
[Just the Docs repo]: https://github.com/just-the-docs/just-the-docs
|
||||||
|
[GitHub Pages]: https://pages.github.com/
|
||||||
|
[Template README]: https://github.com/just-the-docs/just-the-docs-template/blob/main/README.md
|
||||||
|
[GitHub Pages / Actions workflow]: https://github.blog/changelog/2022-07-27-github-pages-custom-github-actions-workflows-beta/
|
||||||
|
[use the template]: https://github.com/just-the-docs/just-the-docs-template/generate
|
||||||
|
152
_config.yml
152
_config.yml
@@ -15,26 +15,162 @@
|
|||||||
# in the templates via {{ site.myvariable }}.
|
# in the templates via {{ site.myvariable }}.
|
||||||
title: Just the Docs
|
title: Just the Docs
|
||||||
description: A Jekyll theme for documentation
|
description: A Jekyll theme for documentation
|
||||||
baseurl: "/just-the-docs/" # the subpath of your site, e.g. /blog
|
baseurl: "/just-the-docs" # the subpath of your site, e.g. /blog
|
||||||
url: "https://pmarsceill.github.io" # the base hostname & protocol for your site, e.g. http://example.com
|
url: "https://just-the-docs.github.io" # the base hostname & protocol for your site, e.g. http://example.com
|
||||||
|
|
||||||
permalink: pretty
|
permalink: pretty
|
||||||
exclude: ["node_modules/", "*.gemspec", "*.gem", "Gemfile", "Gemfile.lock", "package.json", "package-lock.json", "script/", "LICENSE.txt", "lib/", "bin/", "README.md", "Rakefile"]
|
|
||||||
|
exclude:
|
||||||
|
# from https://github.com/jekyll/jekyll/blob/master/lib/site_template/_config.yml:
|
||||||
|
- .sass-cache/
|
||||||
|
- .jekyll-cache/
|
||||||
|
- gemfiles/
|
||||||
|
- Gemfile
|
||||||
|
- Gemfile.lock
|
||||||
|
- node_modules/
|
||||||
|
- vendor/bundle/
|
||||||
|
- vendor/cache/
|
||||||
|
- vendor/gems/
|
||||||
|
- vendor/ruby/
|
||||||
|
# specific to the theme website:
|
||||||
|
- bin/
|
||||||
|
- lib/
|
||||||
|
- "*.gemspec"
|
||||||
|
- "*.gem"
|
||||||
|
- LICENSE.txt
|
||||||
|
- package.json
|
||||||
|
- package-lock.json
|
||||||
|
- Rakefile
|
||||||
|
- README.md
|
||||||
|
|
||||||
|
# Set a path/url to a logo that will be displayed instead of the title
|
||||||
|
#logo: "/assets/images/just-the-docs.png"
|
||||||
|
|
||||||
# Enable or disable the site search
|
# Enable or disable the site search
|
||||||
|
# Supports true (default) or false
|
||||||
search_enabled: true
|
search_enabled: true
|
||||||
|
search:
|
||||||
|
# Split pages into sections that can be searched individually
|
||||||
|
# Supports 1 - 6, default: 2
|
||||||
|
heading_level: 2
|
||||||
|
# Maximum amount of previews per search result
|
||||||
|
# Default: 3
|
||||||
|
previews: 2
|
||||||
|
# Maximum amount of words to display before a matched word in the preview
|
||||||
|
# Default: 5
|
||||||
|
preview_words_before: 3
|
||||||
|
# Maximum amount of words to display after a matched word in the preview
|
||||||
|
# Default: 10
|
||||||
|
preview_words_after: 3
|
||||||
|
# Set the search token separator
|
||||||
|
# Default: /[\s\-/]+/
|
||||||
|
# Example: enable support for hyphenated search words
|
||||||
|
tokenizer_separator: /[\s/]+/
|
||||||
|
# Display the relative url in search results
|
||||||
|
# Supports true (default) or false
|
||||||
|
rel_url: true
|
||||||
|
# Enable or disable the search button that appears in the bottom right corner of every page
|
||||||
|
# Supports true or false (default)
|
||||||
|
button: false
|
||||||
|
|
||||||
|
# For copy button on code
|
||||||
|
enable_copy_code_button: true
|
||||||
|
|
||||||
|
# To disable support for mermaid diagrams (https://mermaid.js.org),
|
||||||
|
# comment out the `mermaid` and `version` keys below
|
||||||
|
# By default, consuming the theme as a gem leaves mermaid disabled; it is opt-in
|
||||||
|
mermaid:
|
||||||
|
# Version of mermaid library
|
||||||
|
# Pick an available version from https://cdn.jsdelivr.net/npm/mermaid/
|
||||||
|
version: "9.1.6"
|
||||||
|
# Put any additional configuration, such as setting the theme, in _includes/mermaid_config.js
|
||||||
|
# See also docs/ui-components/code
|
||||||
|
# To load mermaid from a local file use the `path` key to specify the location of the library instead; e.g.
|
||||||
|
# path: "/assets/js/mermaid.min.js"
|
||||||
|
|
||||||
|
# Enable or disable heading anchors
|
||||||
|
heading_anchors: true
|
||||||
|
|
||||||
# Aux links for the upper right navigation
|
# Aux links for the upper right navigation
|
||||||
aux_links:
|
aux_links:
|
||||||
"Just the Docs on GitHub":
|
"Just the Docs on GitHub":
|
||||||
- "//github.com/pmarsceill/just-the-docs"
|
- "//github.com/just-the-docs/just-the-docs"
|
||||||
|
|
||||||
# Color scheme currently only supports "dark" or nil (default)
|
# Makes Aux links open in a new tab. Default is false
|
||||||
|
aux_links_new_tab: false
|
||||||
|
|
||||||
|
# Sort order for navigation links
|
||||||
|
# nav_sort: case_insensitive # default, equivalent to nil
|
||||||
|
nav_sort: case_sensitive # Capital letters sorted before lowercase
|
||||||
|
|
||||||
|
# External navigation links
|
||||||
|
nav_external_links:
|
||||||
|
- title: Just the Docs on GitHub
|
||||||
|
url: https://github.com/just-the-docs/just-the-docs
|
||||||
|
|
||||||
|
# Footer content
|
||||||
|
# appears at the bottom of every page's main content
|
||||||
|
|
||||||
|
# Back to top link
|
||||||
|
back_to_top: true
|
||||||
|
back_to_top_text: "Back to top"
|
||||||
|
|
||||||
|
footer_content: "Copyright © 2017-2020 Patrick Marsceill. Distributed by an <a href=\"https://github.com/just-the-docs/just-the-docs/tree/main/LICENSE.txt\">MIT license.</a> <a href=\"https://www.netlify.com/\">This site is powered by Netlify.</a>"
|
||||||
|
|
||||||
|
# Footer last edited timestamp
|
||||||
|
last_edit_timestamp: true # show or hide edit time - page must have `last_modified_date` defined in the frontmatter
|
||||||
|
last_edit_time_format: "%b %e %Y at %I:%M %p" # uses ruby's time format: https://ruby-doc.org/stdlib-2.7.0/libdoc/time/rdoc/Time.html
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
# Footer "Edit this page on GitHub" link text
|
||||||
|
gh_edit_link: true # show or hide edit this page link
|
||||||
|
gh_edit_link_text: "Edit this page on GitHub"
|
||||||
|
gh_edit_repository: "https://github.com/just-the-docs/just-the-docs" # the github URL for your repo
|
||||||
|
gh_edit_branch: "main" # the branch that your docs is served from
|
||||||
|
# gh_edit_source: docs # the source that your files originate from
|
||||||
|
gh_edit_view_mode: "tree" # "tree" or "edit" if you want the user to jump into the editor immediately
|
||||||
|
|
||||||
|
# Color scheme currently only supports "dark", "light"/nil (default), or a custom scheme that you define
|
||||||
color_scheme: nil
|
color_scheme: nil
|
||||||
|
|
||||||
|
callouts_level: quiet # or loud
|
||||||
|
callouts:
|
||||||
|
highlight:
|
||||||
|
color: yellow
|
||||||
|
important:
|
||||||
|
title: Important
|
||||||
|
color: blue
|
||||||
|
new:
|
||||||
|
title: New
|
||||||
|
color: green
|
||||||
|
note:
|
||||||
|
title: Note
|
||||||
|
color: purple
|
||||||
|
warning:
|
||||||
|
title: Warning
|
||||||
|
color: red
|
||||||
|
|
||||||
# Google Analytics Tracking (optional)
|
# Google Analytics Tracking (optional)
|
||||||
# e.g, UA-1234567-89
|
# Supports a CSV of tracking ID strings (eg. "UA-1234567-89,G-1AB234CDE5")
|
||||||
ga_tracking: UA-2709176-10
|
# Note: the main Just the Docs site does *not* use Google Analytics.
|
||||||
|
# ga_tracking: UA-2709176-10,G-5FG1HLH3XQ
|
||||||
|
# ga_tracking_anonymize_ip: true # Use GDPR compliant Google Analytics settings (true/nil by default)
|
||||||
|
|
||||||
plugins:
|
plugins:
|
||||||
- jekyll-seo-tag
|
- jekyll-seo-tag
|
||||||
|
|
||||||
|
kramdown:
|
||||||
|
syntax_highlighter_opts:
|
||||||
|
block:
|
||||||
|
line_numbers: false
|
||||||
|
|
||||||
|
compress_html:
|
||||||
|
clippings: all
|
||||||
|
comments: all
|
||||||
|
endings: all
|
||||||
|
startings: []
|
||||||
|
blanklines: false
|
||||||
|
profile: false
|
||||||
|
# ignore:
|
||||||
|
# envs: all
|
||||||
|
15
_includes/components/aux_nav.html
Normal file
15
_includes/components/aux_nav.html
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
<nav aria-label="Auxiliary" class="aux-nav">
|
||||||
|
<ul class="aux-nav-list">
|
||||||
|
{% for link in site.aux_links %}
|
||||||
|
<li class="aux-nav-list-item">
|
||||||
|
<a href="{{ link.last }}" class="site-button"
|
||||||
|
{% if site.aux_links_new_tab %}
|
||||||
|
target="_blank" rel="noopener noreferrer"
|
||||||
|
{% endif %}
|
||||||
|
>
|
||||||
|
{{ link.first }}
|
||||||
|
</a>
|
||||||
|
</li>
|
||||||
|
{% endfor %}
|
||||||
|
</ul>
|
||||||
|
</nav>
|
15
_includes/components/breadcrumbs.html
Normal file
15
_includes/components/breadcrumbs.html
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
{% unless page.url == "/" %}
|
||||||
|
{% if page.parent %}
|
||||||
|
<nav aria-label="Breadcrumb" class="breadcrumb-nav">
|
||||||
|
<ol class="breadcrumb-nav-list">
|
||||||
|
{% if page.grand_parent %}
|
||||||
|
<li class="breadcrumb-nav-list-item"><a href="{{ first_level_url }}">{{ page.grand_parent }}</a></li>
|
||||||
|
<li class="breadcrumb-nav-list-item"><a href="{{ second_level_url }}">{{ page.parent }}</a></li>
|
||||||
|
{% else %}
|
||||||
|
<li class="breadcrumb-nav-list-item"><a href="{{ first_level_url }}">{{ page.parent }}</a></li>
|
||||||
|
{% endif %}
|
||||||
|
<li class="breadcrumb-nav-list-item"><span>{{ page.title }}</span></li>
|
||||||
|
</ol>
|
||||||
|
</nav>
|
||||||
|
{% endif %}
|
||||||
|
{% endunless %}
|
9
_includes/components/children_nav.html
Normal file
9
_includes/components/children_nav.html
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
<hr>
|
||||||
|
{% include toc_heading_custom.html %}
|
||||||
|
<ul>
|
||||||
|
{% for child in include.toc_list %}
|
||||||
|
<li>
|
||||||
|
<a href="{{ child.url | relative_url }}">{{ child.title }}</a>{% if child.summary %} - {{ child.summary }}{% endif %}
|
||||||
|
</li>
|
||||||
|
{% endfor %}
|
||||||
|
</ul>
|
34
_includes/components/footer.html
Normal file
34
_includes/components/footer.html
Normal file
@@ -0,0 +1,34 @@
|
|||||||
|
{% capture footer_custom %}
|
||||||
|
{%- include footer_custom.html -%}
|
||||||
|
{% endcapture %}
|
||||||
|
{% if footer_custom != "" or site.last_edit_timestamp or site.gh_edit_link %}
|
||||||
|
<hr>
|
||||||
|
<footer>
|
||||||
|
{% if site.back_to_top %}
|
||||||
|
<p><a href="#top" id="back-to-top">{{ site.back_to_top_text }}</a></p>
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
|
{{ footer_custom }}
|
||||||
|
|
||||||
|
{% if site.last_edit_timestamp or site.gh_edit_link %}
|
||||||
|
<div class="d-flex mt-2">
|
||||||
|
{% if site.last_edit_timestamp and site.last_edit_time_format and page.last_modified_date %}
|
||||||
|
<p class="text-small text-grey-dk-000 mb-0 mr-2">
|
||||||
|
Page last modified: <span class="d-inline-block">{{ page.last_modified_date | date: site.last_edit_time_format }}</span>.
|
||||||
|
</p>
|
||||||
|
{% endif %}
|
||||||
|
{% if
|
||||||
|
site.gh_edit_link and
|
||||||
|
site.gh_edit_link_text and
|
||||||
|
site.gh_edit_repository and
|
||||||
|
site.gh_edit_branch and
|
||||||
|
site.gh_edit_view_mode
|
||||||
|
%}
|
||||||
|
<p class="text-small text-grey-dk-000 mb-0">
|
||||||
|
<a href="{{ site.gh_edit_repository }}/{{ site.gh_edit_view_mode }}/{{ site.gh_edit_branch }}{% if site.gh_edit_source %}/{{ site.gh_edit_source }}{% endif %}{% if page.collection and site.collections_dir %}/{{ site.collections_dir }}{% endif %}/{{ page.path }}" id="edit-this-page">{{ site.gh_edit_link_text }}</a>
|
||||||
|
</p>
|
||||||
|
{% endif %}
|
||||||
|
</div>
|
||||||
|
{% endif %}
|
||||||
|
</footer>
|
||||||
|
{% endif %}
|
11
_includes/components/header.html
Normal file
11
_includes/components/header.html
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
<div id="main-header" class="main-header">
|
||||||
|
{% if site.search_enabled != false %}
|
||||||
|
{% include components/search_header.html %}
|
||||||
|
{% else %}
|
||||||
|
<div></div>
|
||||||
|
{% endif %}
|
||||||
|
{% include header_custom.html %}
|
||||||
|
{% if site.aux_links %}
|
||||||
|
{% include components/aux_nav.html %}
|
||||||
|
{% endif %}
|
||||||
|
</div>
|
5
_includes/components/mermaid.html
Normal file
5
_includes/components/mermaid.html
Normal file
@@ -0,0 +1,5 @@
|
|||||||
|
<script>
|
||||||
|
var config = {% include mermaid_config.js %};
|
||||||
|
mermaid.initialize(config);
|
||||||
|
window.mermaid.init(undefined, document.querySelectorAll('.language-mermaid'));
|
||||||
|
</script>
|
7
_includes/components/search_footer.html
Normal file
7
_includes/components/search_footer.html
Normal file
@@ -0,0 +1,7 @@
|
|||||||
|
{% if site.search.button %}
|
||||||
|
<a href="#" id="search-button" class="search-button">
|
||||||
|
<svg viewBox="0 0 24 24" class="icon"><use xlink:href="#svg-search"></use></svg>
|
||||||
|
</a>
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
|
<div class="search-overlay"></div>
|
9
_includes/components/search_header.html
Normal file
9
_includes/components/search_header.html
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
{% capture search_placeholder %}{% include search_placeholder_custom.html %}{% endcapture %}
|
||||||
|
|
||||||
|
<div class="search">
|
||||||
|
<div class="search-input-wrap">
|
||||||
|
<input type="text" id="search-input" class="search-input" tabindex="0" placeholder="{{ search_placeholder | strip_html | strip }}" aria-label="{{ search_placeholder | strip_html| strip }}" autocomplete="off">
|
||||||
|
<label for="search-input" class="search-label"><svg viewBox="0 0 24 24" class="search-icon"><use xlink:href="#svg-search"></use></svg></label>
|
||||||
|
</div>
|
||||||
|
<div id="search-results" class="search-results"></div>
|
||||||
|
</div>
|
69
_includes/components/sidebar.html
Normal file
69
_includes/components/sidebar.html
Normal file
@@ -0,0 +1,69 @@
|
|||||||
|
<div class="side-bar">
|
||||||
|
<div class="site-header">
|
||||||
|
<a href="{{ '/' | relative_url }}" class="site-title lh-tight">{% include title.html %}</a>
|
||||||
|
<a href="#" id="menu-button" class="site-button">
|
||||||
|
<svg viewBox="0 0 24 24" class="icon"><use xlink:href="#svg-menu"></use></svg>
|
||||||
|
</a>
|
||||||
|
</div>
|
||||||
|
<nav aria-label="Main" id="site-nav" class="site-nav">
|
||||||
|
{% assign pages_top_size = site.html_pages
|
||||||
|
| where_exp:"item", "item.title != nil"
|
||||||
|
| where_exp:"item", "item.parent == nil"
|
||||||
|
| where_exp:"item", "item.nav_exclude != true"
|
||||||
|
| size %}
|
||||||
|
{% if pages_top_size > 0 %}
|
||||||
|
{% include nav.html pages=site.html_pages key=nil %}
|
||||||
|
{% endif %}
|
||||||
|
{%- if site.nav_external_links -%}
|
||||||
|
<ul class="nav-list">
|
||||||
|
{%- for node in site.nav_external_links -%}
|
||||||
|
<li class="nav-list-item external">
|
||||||
|
<a href="{{ node.url | absolute_url }}" class="nav-list-link external">
|
||||||
|
{{ node.title }}
|
||||||
|
{% 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 %}
|
||||||
|
</a>
|
||||||
|
</li>
|
||||||
|
{%- endfor -%}
|
||||||
|
</ul>
|
||||||
|
{%- endif -%}
|
||||||
|
{% if site.just_the_docs.collections %}
|
||||||
|
{% assign collections_size = site.just_the_docs.collections | size %}
|
||||||
|
{% for collection_entry in site.just_the_docs.collections %}
|
||||||
|
{% assign collection_key = collection_entry[0] %}
|
||||||
|
{% assign collection_value = collection_entry[1] %}
|
||||||
|
{% assign collection = site[collection_key] %}
|
||||||
|
{% if collection_value.nav_exclude != true %}
|
||||||
|
{% if collections_size > 1 or pages_top_size > 0 %}
|
||||||
|
{% if collection_value.nav_fold == true %}
|
||||||
|
<ul class="nav-list nav-category-list">
|
||||||
|
<li class="nav-list-item{% if page.collection == collection_key %} active{% endif %}">
|
||||||
|
{%- if collection.size > 0 -%}
|
||||||
|
<a href="#" class="nav-list-expander"><svg viewBox="0 0 24 24"><use xlink:href="#svg-arrow-right"></use></svg></a>
|
||||||
|
{%- endif -%}
|
||||||
|
<div class="nav-category">{{ collection_value.name }}</div>
|
||||||
|
{% include nav.html pages=collection key=collection_key %}
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
{% else %}
|
||||||
|
<div class="nav-category">{{ collection_value.name }}</div>
|
||||||
|
{% include nav.html pages=collection key=collection_key %}
|
||||||
|
{% endif %}
|
||||||
|
{% else %}
|
||||||
|
{% include nav.html pages=collection key=collection_key %}
|
||||||
|
{% endif %}
|
||||||
|
{% endif %}
|
||||||
|
{% endfor %}
|
||||||
|
{% endif %}
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
{% capture nav_footer_custom %}
|
||||||
|
{%- include nav_footer_custom.html -%}
|
||||||
|
{% endcapture %}
|
||||||
|
{% if nav_footer_custom != "" %}
|
||||||
|
{{ nav_footer_custom }}
|
||||||
|
{% else %}
|
||||||
|
<footer class="site-footer">
|
||||||
|
This site uses <a href="https://github.com/just-the-docs/just-the-docs">Just the Docs</a>, a documentation theme for Jekyll.
|
||||||
|
</footer>
|
||||||
|
{% endif %}
|
||||||
|
</div>
|
93
_includes/css/callouts.scss.liquid
Normal file
93
_includes/css/callouts.scss.liquid
Normal file
@@ -0,0 +1,93 @@
|
|||||||
|
{%- comment -%}
|
||||||
|
{% include css/callouts.scss.liquid color_scheme = string %}
|
||||||
|
produces SCSS for all the callouts in site.callouts. For the "dark"
|
||||||
|
color scheme, the levels of the text and background colors are reversed.
|
||||||
|
{%- endcomment -%}
|
||||||
|
|
||||||
|
{%- assign callout_background_hue = "000" -%}
|
||||||
|
{%- assign callout_color_hue = "300" -%}
|
||||||
|
{%- if site.callouts_level == "loud" or include.color_scheme == "dark" and site.callouts_level != "quiet" -%}
|
||||||
|
{%- assign callout_background_hue = "300" -%}
|
||||||
|
{%- assign callout_color_hue = "000" -%}
|
||||||
|
{%- endif -%}
|
||||||
|
|
||||||
|
div.opaque {
|
||||||
|
background-color: $body-background-color;
|
||||||
|
}
|
||||||
|
|
||||||
|
{%- for callout in site.callouts %}
|
||||||
|
|
||||||
|
{%- assign callout_opacity = callout[1].opacity | default: site.callouts_opacity | default: 0.2 -%}
|
||||||
|
|
||||||
|
p.{{ callout[0] }}, blockquote.{{ callout[0] }} {
|
||||||
|
background: rgba(${{ callout[1].color }}-{{ callout_background_hue }}, {{ callout_opacity }});
|
||||||
|
border-left: $border-radius solid ${{ callout[1].color }}-{{ callout_color_hue }};
|
||||||
|
border-radius: $border-radius;
|
||||||
|
box-shadow: 0 1px 2px rgba(0, 0, 0, 0.12), 0 3px 10px rgba(0, 0, 0, 0.08);
|
||||||
|
padding: .8rem;
|
||||||
|
{% if callout[1].title %}
|
||||||
|
&::before {
|
||||||
|
color: ${{ callout[1].color }}-{{ callout_color_hue }};
|
||||||
|
content: "{{ callout[1].title }}";
|
||||||
|
display: block;
|
||||||
|
font-weight: bold;
|
||||||
|
text-transform: uppercase;
|
||||||
|
font-size: .75em;
|
||||||
|
padding-bottom: .125rem;
|
||||||
|
}
|
||||||
|
{% endif %}
|
||||||
|
> .{{ callout[0] }}-title {
|
||||||
|
color: ${{ callout[1].color }}-{{ callout_color_hue }};
|
||||||
|
display: block;
|
||||||
|
font-weight: bold;
|
||||||
|
text-transform: uppercase;
|
||||||
|
font-size: .75em;
|
||||||
|
padding-bottom: .125rem;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
p.{{ callout[0] }}-title, blockquote.{{ callout[0] }}-title {
|
||||||
|
background: rgba(${{ callout[1].color }}-{{ callout_background_hue }}, {{ callout_opacity }});
|
||||||
|
border-left: $border-radius solid ${{ callout[1].color }}-{{ callout_color_hue }};
|
||||||
|
border-radius: $border-radius;
|
||||||
|
box-shadow: 0 1px 2px rgba(0, 0, 0, 0.12), 0 3px 10px rgba(0, 0, 0, 0.08);
|
||||||
|
padding: .8rem;
|
||||||
|
> p:first-child {
|
||||||
|
margin-top: 0;
|
||||||
|
margin-bottom: 0;
|
||||||
|
color: ${{ callout[1].color }}-{{ callout_color_hue }};
|
||||||
|
display: block;
|
||||||
|
font-weight: bold;
|
||||||
|
text-transform: uppercase;
|
||||||
|
font-size: .75em;
|
||||||
|
padding-bottom: .125rem;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
blockquote.{{ callout[0] }} {
|
||||||
|
margin-left: 0;
|
||||||
|
margin-right: 0;
|
||||||
|
|
||||||
|
> p:first-child {
|
||||||
|
margin-top: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
> p:last-child {
|
||||||
|
margin-bottom: 0;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
blockquote.{{ callout[0] }}-title {
|
||||||
|
margin-left: 0;
|
||||||
|
margin-right: 0;
|
||||||
|
|
||||||
|
> p:nth-child(2) {
|
||||||
|
margin-top: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
> p:last-child {
|
||||||
|
margin-bottom: 0;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
{% endfor -%}
|
1
_includes/css/custom.scss.liquid
Normal file
1
_includes/css/custom.scss.liquid
Normal file
@@ -0,0 +1 @@
|
|||||||
|
@import "./custom/custom";
|
10
_includes/css/just-the-docs.scss.liquid
Normal file
10
_includes/css/just-the-docs.scss.liquid
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
{% if site.logo %}
|
||||||
|
$logo: "{{ site.logo | relative_url }}";
|
||||||
|
{% endif %}
|
||||||
|
@import "./support/support";
|
||||||
|
@import "./custom/setup";
|
||||||
|
@import "./color_schemes/light";
|
||||||
|
@import "./color_schemes/{{ include.color_scheme }}";
|
||||||
|
@import "./modules";
|
||||||
|
{% include css/callouts.scss.liquid color_scheme = include.color_scheme %}
|
||||||
|
{% include css/custom.scss.liquid %}
|
65
_includes/fix_linenos.html
Normal file
65
_includes/fix_linenos.html
Normal file
@@ -0,0 +1,65 @@
|
|||||||
|
{%- comment -%}
|
||||||
|
This file can be used to fix the HTML produced by Jekyll for highlighted
|
||||||
|
code with line numbers.
|
||||||
|
|
||||||
|
It works with `{% highlight some_language linenos %}...{% endhighlight %}`
|
||||||
|
and with the Kramdown option to add line numbers to fenced code.
|
||||||
|
|
||||||
|
The implementation was derived from the workaround provided by
|
||||||
|
Dmitry Hrabrov (DeXP) at
|
||||||
|
https://github.com/penibelst/jekyll-compress-html/issues/71#issuecomment-188144901
|
||||||
|
|
||||||
|
EXPLANATION
|
||||||
|
|
||||||
|
The HTML produced by Rouge highlighting with lie numbers is of the form
|
||||||
|
`code table`. Jekyll (<= 4.1.1) always wraps the highlighted HTML
|
||||||
|
with `pre`. This wrapping is not only unnecessary, but also transforms
|
||||||
|
the conforming HTML produced by Rouge to non-conforming HTML, which
|
||||||
|
results in HTML validation error reports.
|
||||||
|
|
||||||
|
The fix removes the outer `pre` tags whenever they contain the pattern
|
||||||
|
`<table class="rouge-table">`.
|
||||||
|
|
||||||
|
Apart from avoiding HTML validation errors, the fix allows the use of
|
||||||
|
the [Jekyll layout for compressing HTML](http://jch.penibelst.de),
|
||||||
|
which relies on `pre` tags not being nested, according to
|
||||||
|
https://github.com/penibelst/jekyll-compress-html/issues/71#issuecomment-172069842
|
||||||
|
|
||||||
|
USAGE
|
||||||
|
|
||||||
|
(Any names can be used for `some_var` and `some_language`.)
|
||||||
|
|
||||||
|
{% capture some_var %}
|
||||||
|
{% highlight some_language linenos %}
|
||||||
|
Some code
|
||||||
|
{% endhighlight %}
|
||||||
|
{% endcapture %}
|
||||||
|
{% include fix_linenos.html code=some_var %}
|
||||||
|
|
||||||
|
For code fences:
|
||||||
|
|
||||||
|
{% capture some_var %}
|
||||||
|
```some_language
|
||||||
|
Some code
|
||||||
|
```
|
||||||
|
{% endcapture %}
|
||||||
|
{% assign some_var = some_var | markdownify %}
|
||||||
|
{% include fix_linenos.html code=some_var %}
|
||||||
|
|
||||||
|
CAVEATS
|
||||||
|
|
||||||
|
The above does not work when `Some code` happens to contain the matched string
|
||||||
|
`<table class="rouge-table">`.
|
||||||
|
|
||||||
|
The use of this file overwrites the variable `fix_linenos_code` with `nil`.
|
||||||
|
|
||||||
|
{%- endcomment -%}
|
||||||
|
|
||||||
|
{% assign fix_linenos_code = include.code %}
|
||||||
|
{% if fix_linenos_code contains '<table class="rouge-table">' %}
|
||||||
|
{% assign fix_linenos_code = fix_linenos_code | replace: '<pre class="highlight">', '<pre>' %}
|
||||||
|
{% assign fix_linenos_code = fix_linenos_code | replace: "<pre><code", "<code" %}
|
||||||
|
{% assign fix_linenos_code = fix_linenos_code | replace: "</code></pre>", "</code>" %}
|
||||||
|
{% endif %}
|
||||||
|
{{ fix_linenos_code }}
|
||||||
|
{% assign fix_linenos_code = nil %}
|
3
_includes/footer_custom.html
Normal file
3
_includes/footer_custom.html
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
{%- if site.footer_content -%}
|
||||||
|
<p class="text-small text-grey-dk-100 mb-0">{{ site.footer_content }}</p>
|
||||||
|
{%- endif -%}
|
@@ -1,28 +1,50 @@
|
|||||||
<head>
|
<head>
|
||||||
<meta charset="UTF-8">
|
<meta charset="UTF-8">
|
||||||
<meta http-equiv="X-UA-Compatible" content="IE=Edge">
|
<meta http-equiv="X-UA-Compatible" content="IE=Edge">
|
||||||
{% if page.description %}
|
|
||||||
<meta name="Description" content="{{ page.description }}">
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
<title>{{ page.title }} - {{ site.title }}</title>
|
<link rel="stylesheet" href="{{ '/assets/css/just-the-docs-default.css' | relative_url }}">
|
||||||
<link rel="stylesheet" href="{{ "/assets/css/just-the-docs.css" | absolute_url }}">
|
|
||||||
|
|
||||||
{% if site.ga_tracking != nil %}
|
{% if site.ga_tracking != nil %}
|
||||||
|
{% assign ga_tracking_ids = site.ga_tracking | split: "," %}
|
||||||
|
<script async src="https://www.googletagmanager.com/gtag/js?id={{ ga_tracking_ids.first }}"></script>
|
||||||
<script>
|
<script>
|
||||||
window.ga=window.ga||function(){(ga.q=ga.q||[]).push(arguments)};ga.l=+new Date;
|
window.dataLayer = window.dataLayer || [];
|
||||||
ga('create', '{{ site.ga_tracking }}', '{{ site.url }}');
|
function gtag(){dataLayer.push(arguments);}
|
||||||
ga('send', 'pageview');
|
gtag('js', new Date());
|
||||||
|
|
||||||
|
{% for ga_property in ga_tracking_ids %}
|
||||||
|
gtag('config', '{{ ga_property }}'{% unless site.ga_tracking_anonymize_ip == nil %}, { 'anonymize_ip': true }{% endunless %});
|
||||||
|
{% endfor %}
|
||||||
</script>
|
</script>
|
||||||
<script async src="https://www.google-analytics.com/analytics.js"></script>
|
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
{% if site.search_enabled != nil %}
|
{% if site.search_enabled != false %}
|
||||||
<script type="text/javascript" src="{{ "/assets/js/vendor/lunr.min.js" | absolute_url }}"></script>
|
<script src="{{ '/assets/js/vendor/lunr.min.js' | relative_url }}"></script>
|
||||||
{% endif %}
|
{% endif %}
|
||||||
<script type="text/javascript" src="{{ "/assets/js/just-the-docs.js" | absolute_url }}"></script>
|
|
||||||
|
{% if site.mermaid %}
|
||||||
|
{% if site.mermaid.path %}
|
||||||
|
<script src="{{ site.mermaid.path | relative_url }}"></script>
|
||||||
|
{% else %}
|
||||||
|
<script src="https://cdn.jsdelivr.net/npm/mermaid@{{ site.mermaid.version }}/dist/mermaid.min.js"></script>
|
||||||
|
{% endif %}
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
|
<script src="{{ '/assets/js/just-the-docs.js' | relative_url }}"></script>
|
||||||
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||||
|
|
||||||
{% seo %}
|
{% for file in site.static_files %}
|
||||||
|
{% if file.path == site.favicon_ico or file.path == '/favicon.ico' %}
|
||||||
|
{% assign favicon = true %}
|
||||||
|
{% endif %}
|
||||||
|
{% endfor %}
|
||||||
|
{% if favicon %}
|
||||||
|
<link rel="icon" href="{{ site.favicon_ico | default: '/favicon.ico' | relative_url }}" type="image/x-icon">
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
|
{% seo %}
|
||||||
|
|
||||||
|
{% include head_custom.html %}
|
||||||
|
|
||||||
</head>
|
</head>
|
||||||
|
0
_includes/head_custom.html
Normal file
0
_includes/head_custom.html
Normal file
0
_includes/header_custom.html
Normal file
0
_includes/header_custom.html
Normal file
15
_includes/icons/code_copy.html
Normal file
15
_includes/icons/code_copy.html
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
<!-- Bootstrap Icons. MIT License: https://github.com/twbs/icons/blob/main/LICENSE.md -->
|
||||||
|
<symbol id="svg-copy" viewBox="0 0 16 16">
|
||||||
|
<title>Copy</title>
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-clipboard" viewBox="0 0 16 16">
|
||||||
|
<path d="M4 1.5H3a2 2 0 0 0-2 2V14a2 2 0 0 0 2 2h10a2 2 0 0 0 2-2V3.5a2 2 0 0 0-2-2h-1v1h1a1 1 0 0 1 1 1V14a1 1 0 0 1-1 1H3a1 1 0 0 1-1-1V3.5a1 1 0 0 1 1-1h1v-1z"/>
|
||||||
|
<path d="M9.5 1a.5.5 0 0 1 .5.5v1a.5.5 0 0 1-.5.5h-3a.5.5 0 0 1-.5-.5v-1a.5.5 0 0 1 .5-.5h3zm-3-1A1.5 1.5 0 0 0 5 1.5v1A1.5 1.5 0 0 0 6.5 4h3A1.5 1.5 0 0 0 11 2.5v-1A1.5 1.5 0 0 0 9.5 0h-3z"/>
|
||||||
|
</svg>
|
||||||
|
</symbol>
|
||||||
|
<symbol id="svg-copied" viewBox="0 0 16 16">
|
||||||
|
<title>Copied</title>
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-clipboard-check-fill" viewBox="0 0 16 16">
|
||||||
|
<path d="M6.5 0A1.5 1.5 0 0 0 5 1.5v1A1.5 1.5 0 0 0 6.5 4h3A1.5 1.5 0 0 0 11 2.5v-1A1.5 1.5 0 0 0 9.5 0h-3Zm3 1a.5.5 0 0 1 .5.5v1a.5.5 0 0 1-.5.5h-3a.5.5 0 0 1-.5-.5v-1a.5.5 0 0 1 .5-.5h3Z"/>
|
||||||
|
<path d="M4 1.5H3a2 2 0 0 0-2 2V14a2 2 0 0 0 2 2h10a2 2 0 0 0 2-2V3.5a2 2 0 0 0-2-2h-1v1A2.5 2.5 0 0 1 9.5 5h-3A2.5 2.5 0 0 1 4 2.5v-1Zm6.854 7.354-3 3a.5.5 0 0 1-.708 0l-1.5-1.5a.5.5 0 0 1 .708-.708L7.5 10.793l2.646-2.647a.5.5 0 0 1 .708.708Z"/>
|
||||||
|
</svg>
|
||||||
|
</symbol>
|
6
_includes/icons/document.html
Normal file
6
_includes/icons/document.html
Normal file
@@ -0,0 +1,6 @@
|
|||||||
|
<symbol id="svg-doc" viewBox="0 0 24 24">
|
||||||
|
<title>Document</title>
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-file">
|
||||||
|
<path d="M13 2H6a2 2 0 0 0-2 2v16a2 2 0 0 0 2 2h12a2 2 0 0 0 2-2V9z"></path><polyline points="13 2 13 9 20 9"></polyline>
|
||||||
|
</svg>
|
||||||
|
</symbol>
|
6
_includes/icons/expand.html
Normal file
6
_includes/icons/expand.html
Normal file
@@ -0,0 +1,6 @@
|
|||||||
|
<symbol id="svg-arrow-right" viewBox="0 0 24 24">
|
||||||
|
<title>Expand</title>
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-chevron-right">
|
||||||
|
<polyline points="9 18 15 12 9 6"></polyline>
|
||||||
|
</svg>
|
||||||
|
</symbol>
|
5
_includes/icons/external_link.html
Normal file
5
_includes/icons/external_link.html
Normal file
@@ -0,0 +1,5 @@
|
|||||||
|
<!-- Feather. MIT License: https://github.com/feathericons/feather/blob/master/LICENSE -->
|
||||||
|
<symbol id="svg-external-link" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-external-link">
|
||||||
|
<title id="svg-external-link-title">(external link)</title>
|
||||||
|
<path d="M18 13v6a2 2 0 0 1-2 2H5a2 2 0 0 1-2-2V8a2 2 0 0 1 2-2h6"></path><polyline points="15 3 21 3 21 9"></polyline><line x1="10" y1="14" x2="21" y2="3"></line>
|
||||||
|
</symbol>
|
13
_includes/icons/icons.html
Normal file
13
_includes/icons/icons.html
Normal file
@@ -0,0 +1,13 @@
|
|||||||
|
<svg xmlns="http://www.w3.org/2000/svg" class="d-none">
|
||||||
|
{% include icons/link.html %}
|
||||||
|
{% include icons/menu.html %}
|
||||||
|
{% include icons/expand.html %}
|
||||||
|
{% include icons/external_link.html %}
|
||||||
|
{% if site.search_enabled != false %}
|
||||||
|
{% include icons/document.html %}
|
||||||
|
{% include icons/search.html %}
|
||||||
|
{% endif %}
|
||||||
|
{% if site.enable_copy_code_button != false %}
|
||||||
|
{% include icons/code_copy.html %}
|
||||||
|
{% endif %}
|
||||||
|
</svg>
|
After Width: | Height: | Size: 432 B |
6
_includes/icons/link.html
Normal file
6
_includes/icons/link.html
Normal file
@@ -0,0 +1,6 @@
|
|||||||
|
<symbol id="svg-link" viewBox="0 0 24 24">
|
||||||
|
<title>Link</title>
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-link">
|
||||||
|
<path d="M10 13a5 5 0 0 0 7.54.54l3-3a5 5 0 0 0-7.07-7.07l-1.72 1.71"></path><path d="M14 11a5 5 0 0 0-7.54-.54l-3 3a5 5 0 0 0 7.07 7.07l1.71-1.71"></path>
|
||||||
|
</svg>
|
||||||
|
</symbol>
|
6
_includes/icons/menu.html
Normal file
6
_includes/icons/menu.html
Normal file
@@ -0,0 +1,6 @@
|
|||||||
|
<symbol id="svg-menu" viewBox="0 0 24 24">
|
||||||
|
<title>Menu</title>
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-menu">
|
||||||
|
<line x1="3" y1="12" x2="21" y2="12"></line><line x1="3" y1="6" x2="21" y2="6"></line><line x1="3" y1="18" x2="21" y2="18"></line>
|
||||||
|
</svg>
|
||||||
|
</symbol>
|
6
_includes/icons/search.html
Normal file
6
_includes/icons/search.html
Normal file
@@ -0,0 +1,6 @@
|
|||||||
|
<symbol id="svg-search" viewBox="0 0 24 24">
|
||||||
|
<title>Search</title>
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-search">
|
||||||
|
<circle cx="11" cy="11" r="8"></circle><line x1="21" y1="21" x2="16.65" y2="16.65"></line>
|
||||||
|
</svg>
|
||||||
|
</symbol>
|
0
_includes/js/custom.js
Normal file
0
_includes/js/custom.js
Normal file
0
_includes/lunr/custom-data.json
Normal file
0
_includes/lunr/custom-data.json
Normal file
0
_includes/lunr/custom-index.js
Normal file
0
_includes/lunr/custom-index.js
Normal file
1
_includes/mermaid_config.js
Normal file
1
_includes/mermaid_config.js
Normal file
@@ -0,0 +1 @@
|
|||||||
|
{}
|
@@ -1,44 +1,251 @@
|
|||||||
<nav role="navigation" aria-label="Main navigation">
|
{%- comment -%}
|
||||||
<ul class="navigation-list">
|
The `nav_order` values of pages affect the order in which they are shown in
|
||||||
{% assign pages_list = site.html_pages | sort:"nav_order" %}
|
the navigation panel and in the automatically generated tables of contents.
|
||||||
{% for node in pages_list %}
|
Sibling pages with the same `nav_order` value may be shown in any order.
|
||||||
{% unless node.nav_exclude %}
|
Sibling pages with no `nav_order` value are shown after all pages that have
|
||||||
{% if node.parent == nil %}
|
explicit `nav_order` values, ordered by their `title` values.
|
||||||
<li class="navigation-list-item{% if page.url == node.url or page.parent == node.title or page.grand_parent == node.title %} active{% endif %}">
|
|
||||||
{% if page.parent == node.title or page.grand_parent == node.title %}
|
The `nav_order` and `title` values can be numbers or strings. To avoid build
|
||||||
{% assign first_level_url = node.url | absolute_url %}
|
failures, we sort numbers and strings separately. We sort numbers by their
|
||||||
{% endif %}
|
values, and strings lexicographically. The case-sensitivity of string sorting
|
||||||
<a href="{{ node.url | absolute_url }}" class="navigation-list-link{% if page.url == node.url %} active{% endif %}">{{ node.title }}</a>
|
is determined by the configuration setting of `nav_sort`. Pages with no `title`
|
||||||
{% if node.has_children %}
|
value are excluded from the navigation.
|
||||||
{% assign children_list = site.html_pages | sort:"nav_order" %}
|
|
||||||
<ul class="navigation-list-child-list ">
|
Note: Numbers used as `title` or `nav_order` values should not be in quotes,
|
||||||
{% for child in children_list %}
|
unless you intend them to be lexicographically ordered. Numbers are written
|
||||||
{% if child.parent == node.title %}
|
without spaces or thousands-separators. Negative numbers are preceded by `-`.
|
||||||
<li class="navigation-list-item {% if page.url == child.url or page.parent == child.title %} active{% endif %}">
|
Floats are written with the integral and fractional parts separated by `.`.
|
||||||
{% if page.url == child.url or page.parent == child.title %}
|
(Bounds on the magnitude and precision are presumably the same as in Liquid.)
|
||||||
{% assign second_level_url = child.url | absolute_url %}
|
{%- endcomment -%}
|
||||||
{% endif %}
|
|
||||||
<a href="{{ child.url | absolute_url }}" class="navigation-list-link{% if page.url == child.url %} active{% endif %}">{{ child.title }}</a>
|
{%- assign title_pages = include.pages
|
||||||
{% if child.has_children %}
|
| where_exp: "item", "item.title != nil" -%}
|
||||||
{% assign grand_children_list = site.html_pages | sort:"nav_order" %}
|
|
||||||
<ul class="navigation-list-child-list">
|
{%- comment -%}
|
||||||
{% for grand_child in grand_children_list %}
|
A page with `nav_exclude: true` does not appear in the main navigation.
|
||||||
{% if grand_child.parent == child.title %}
|
If it has a `parent`, it may appear in the parent's table of contents.
|
||||||
<li class="navigation-list-item {% if page.url == grand_child.url %} active{% endif %}">
|
If it specifies `has_children: true`, it should appear in the breadcrumbs
|
||||||
<a href="{{ grand_child.url | absolute_url }}" class="navigation-list-link{% if page.url == grand_child.url %} active{% endif %}">{{ grand_child.title }}</a>
|
of the child pages, but its order in relation to other pages is irrelevant.
|
||||||
</li>
|
Pages that never appear can be removed from the pages that need to be sorted.
|
||||||
{% endif %}
|
This optimisation can be significant on a site with many pages.
|
||||||
{% endfor %}
|
|
||||||
</ul>
|
In Jekyll 4, the pages to be sorted can be filtered by:
|
||||||
{% endif %}
|
|
||||||
</li>
|
{%- assign title_pages = title_pages
|
||||||
{% endif %}
|
| where_exp: "item", "item.nav_exclude != true or item.parent != nil" -%}
|
||||||
{% endfor %}
|
|
||||||
</ul>
|
That filter is not allowed in Jekyll 3. The following iterative code gives the
|
||||||
{% endif %}
|
same effect, but it is activated only when it will filter more than 50% of the
|
||||||
</li>
|
pages.
|
||||||
{% endif %}
|
{%- endcomment -%}
|
||||||
{% endunless %}
|
|
||||||
{% endfor %}
|
{%- unless title_pages == empty -%}
|
||||||
</ul>
|
{%- assign unsorted_pages = title_pages
|
||||||
</nav>
|
| where_exp: "item", "item.parent == nil"
|
||||||
|
| where_exp: "item", "item.nav_exclude == true" -%}
|
||||||
|
{%- assign title_pages_size = title_pages.size -%}
|
||||||
|
{%- assign unsorted_pages_percent = unsorted_pages.size
|
||||||
|
| times: 100 | divided_by: title_pages_size -%}
|
||||||
|
{%- if unsorted_pages_percent > 50 -%}
|
||||||
|
{%- assign sorted_pages = "" | split: "" -%}
|
||||||
|
{%- for item in title_pages -%}
|
||||||
|
{%- if item.nav_exclude != true or item.parent -%}
|
||||||
|
{%- assign sorted_pages = sorted_pages | push: item -%}
|
||||||
|
{%- endif -%}
|
||||||
|
{%- endfor -%}
|
||||||
|
{%- assign title_pages = sorted_pages -%}
|
||||||
|
{%- endif -%}
|
||||||
|
{%- endunless -%}
|
||||||
|
|
||||||
|
{%- assign nav_order_pages = title_pages
|
||||||
|
| where_exp: "item", "item.nav_order != nil" -%}
|
||||||
|
{%- assign title_order_pages = title_pages
|
||||||
|
| where_exp: "item", "item.nav_order == nil" -%}
|
||||||
|
|
||||||
|
{%- comment -%}
|
||||||
|
Divide the arrays of `nav_order_pages` and `title_order_pages` according to
|
||||||
|
the type of value.
|
||||||
|
|
||||||
|
The first character of the result of `jsonify` is `"` only for strings.
|
||||||
|
Grouping by a single character also ensures the number of groups is small.
|
||||||
|
{%- endcomment -%}
|
||||||
|
|
||||||
|
{%- assign nav_number_pages = "" | split: "" -%}
|
||||||
|
{%- assign nav_string_pages = "" | split: "" -%}
|
||||||
|
{%- assign nav_order_groups = nav_order_pages
|
||||||
|
| group_by_exp: "item", "item.nav_order | jsonify | slice: 0" -%}
|
||||||
|
{%- for group in nav_order_groups -%}
|
||||||
|
{%- if group.name == '"' -%}
|
||||||
|
{%- assign nav_string_pages = group.items -%}
|
||||||
|
{%- else -%}
|
||||||
|
{%- assign nav_number_pages = nav_number_pages | concat: group.items -%}
|
||||||
|
{%- endif -%}
|
||||||
|
{%- endfor -%}
|
||||||
|
|
||||||
|
{%- unless nav_number_pages == empty -%}
|
||||||
|
{%- assign nav_number_pages = nav_number_pages | sort: "nav_order" -%}
|
||||||
|
{%- endunless -%}
|
||||||
|
|
||||||
|
{%- unless nav_string_pages == empty -%}
|
||||||
|
{%- if site.nav_sort == 'case_insensitive' -%}
|
||||||
|
{%- assign nav_string_pages = nav_string_pages | sort_natural: "nav_order" -%}
|
||||||
|
{%- else -%}
|
||||||
|
{%- assign nav_string_pages = nav_string_pages | sort: "nav_order" -%}
|
||||||
|
{%- endif -%}
|
||||||
|
{%- endunless -%}
|
||||||
|
|
||||||
|
{%- assign title_number_pages = "" | split: "" -%}
|
||||||
|
{%- assign title_string_pages = "" | split: "" -%}
|
||||||
|
{%- assign title_order_groups = title_order_pages
|
||||||
|
| group_by_exp: "item", "item.title | jsonify | slice: 0" -%}
|
||||||
|
{%- for group in title_order_groups -%}
|
||||||
|
{%- if group.name == '"' -%}
|
||||||
|
{%- assign title_string_pages = group.items -%}
|
||||||
|
{%- else -%}
|
||||||
|
{%- assign title_number_pages = title_number_pages | concat: group.items -%}
|
||||||
|
{%- endif -%}
|
||||||
|
{%- endfor -%}
|
||||||
|
|
||||||
|
{%- unless title_number_pages == empty -%}
|
||||||
|
{%- assign title_number_pages = title_number_pages | sort: "title" -%}
|
||||||
|
{%- endunless -%}
|
||||||
|
|
||||||
|
{%- unless title_string_pages == empty -%}
|
||||||
|
{%- if site.nav_sort == 'case_insensitive' -%}
|
||||||
|
{%- assign title_string_pages = title_string_pages | sort_natural: "title" -%}
|
||||||
|
{%- else -%}
|
||||||
|
{%- assign title_string_pages = title_string_pages | sort: "title" -%}
|
||||||
|
{%- endif -%}
|
||||||
|
{%- endunless -%}
|
||||||
|
|
||||||
|
{%- assign pages_list = nav_number_pages | concat: nav_string_pages
|
||||||
|
| concat: title_number_pages | concat: title_string_pages -%}
|
||||||
|
|
||||||
|
{%- assign first_level_pages = pages_list
|
||||||
|
| where_exp: "item", "item.parent == nil" -%}
|
||||||
|
{%- assign second_level_pages = pages_list
|
||||||
|
| where_exp: "item", "item.parent != nil"
|
||||||
|
| where_exp: "item", "item.grand_parent == nil" -%}
|
||||||
|
{%- assign third_level_pages = pages_list
|
||||||
|
| where_exp: "item", "item.grand_parent != nil" -%}
|
||||||
|
|
||||||
|
{%- comment -%}
|
||||||
|
The order of sibling pages in `pages_list` determines the order of display of
|
||||||
|
links to them in lists of navigation links and in auto-generated TOCs.
|
||||||
|
|
||||||
|
Note that Liquid evaluates conditions from right to left (and it does not allow
|
||||||
|
the use of parentheses). Some conditions are not so easy to express clearly...
|
||||||
|
|
||||||
|
For example, consider the following condition:
|
||||||
|
|
||||||
|
C: page.collection = = include.key and
|
||||||
|
page.url = = node.url or
|
||||||
|
page.grand_parent = = node.title or
|
||||||
|
page.parent = = node.title and
|
||||||
|
page.grand_parent = = nil
|
||||||
|
|
||||||
|
Here, `node` is a first-level page. The last part of the condition
|
||||||
|
-- namely: `page.parent = = node.title and page.grand_parent = = nil` --
|
||||||
|
is evaluated first; it holds if and only if `page` is a child of `node`.
|
||||||
|
|
||||||
|
The condition `page.grand_parent = = node.title or ...` holds when
|
||||||
|
`page` is a grandchild of node, OR `...` holds.
|
||||||
|
|
||||||
|
The condition `page.url = = node.url or ...` holds when
|
||||||
|
`page` is `node`, OR `...` holds.
|
||||||
|
|
||||||
|
The condition C: `page.collection = = include.key and ...` holds when we are
|
||||||
|
generating the nav links for a collection that includes `page`, AND `...` holds.
|
||||||
|
{%- endcomment -%}
|
||||||
|
|
||||||
|
<ul class="nav-list">
|
||||||
|
{%- for node in first_level_pages -%}
|
||||||
|
{%- unless node.nav_exclude -%}
|
||||||
|
<li class="nav-list-item{% if page.collection == include.key and page.url == node.url or page.grand_parent == node.title or page.parent == node.title and page.grand_parent == nil %} active{% endif %}">
|
||||||
|
{%- if node.has_children -%}
|
||||||
|
<a href="#" class="nav-list-expander" aria-label="toggle links in {{ node.title }} category">
|
||||||
|
<svg viewBox="0 0 24 24"><use xlink:href="#svg-arrow-right"></use></svg>
|
||||||
|
</a>
|
||||||
|
{%- endif -%}
|
||||||
|
<a href="{{ node.url | relative_url }}" class="nav-list-link{% if page.url == node.url %} active{% endif %}">{{ node.title }}</a>
|
||||||
|
{%- if node.has_children -%}
|
||||||
|
{%- assign children_list = second_level_pages
|
||||||
|
| where: "parent", node.title -%}
|
||||||
|
{%- if node.child_nav_order == 'desc' or node.child_nav_order == 'reversed' -%}
|
||||||
|
{%- assign children_list = children_list | reverse -%}
|
||||||
|
{%- endif -%}
|
||||||
|
<ul class="nav-list">
|
||||||
|
{%- for child in children_list -%}
|
||||||
|
{%- unless child.nav_exclude -%}
|
||||||
|
<li class="nav-list-item {% if page.url == child.url or page.parent == child.title %} active{% endif %}">
|
||||||
|
{%- if child.has_children -%}
|
||||||
|
<a href="#" class="nav-list-expander" aria-label="toggle links in {{ child.title }} category">
|
||||||
|
<svg viewBox="0 0 24 24"><use xlink:href="#svg-arrow-right"></use></svg>
|
||||||
|
</a>
|
||||||
|
{%- endif -%}
|
||||||
|
<a href="{{ child.url | relative_url }}" class="nav-list-link{% if page.url == child.url %} active{% endif %}">{{ child.title }}</a>
|
||||||
|
{%- if child.has_children -%}
|
||||||
|
{%- assign grand_children_list = third_level_pages
|
||||||
|
| where: "parent", child.title
|
||||||
|
| where: "grand_parent", node.title -%}
|
||||||
|
{%- if child.child_nav_order == 'desc' or child.child_nav_order == 'reversed' -%}
|
||||||
|
{%- assign grand_children_list = grand_children_list | reverse -%}
|
||||||
|
{%- endif -%}
|
||||||
|
<ul class="nav-list">
|
||||||
|
{%- for grand_child in grand_children_list -%}
|
||||||
|
{%- unless grand_child.nav_exclude -%}
|
||||||
|
<li class="nav-list-item {% if page.url == grand_child.url %} active{% endif %}">
|
||||||
|
<a href="{{ grand_child.url | relative_url }}" class="nav-list-link{% if page.url == grand_child.url %} active{% endif %}">{{ grand_child.title }}</a>
|
||||||
|
</li>
|
||||||
|
{%- endunless -%}
|
||||||
|
{%- endfor -%}
|
||||||
|
</ul>
|
||||||
|
{%- endif -%}
|
||||||
|
</li>
|
||||||
|
{%- endunless -%}
|
||||||
|
{%- endfor -%}
|
||||||
|
</ul>
|
||||||
|
{%- endif -%}
|
||||||
|
</li>
|
||||||
|
{%- endunless -%}
|
||||||
|
{%- endfor -%}
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
{%- comment -%}
|
||||||
|
`page.collection` is the name of the Jekyll collection that contains the page,
|
||||||
|
if any, and otherwise nil. Similarly for `include.key`.
|
||||||
|
|
||||||
|
If the current page is in the collection (if any) whose navigation is currently
|
||||||
|
being generated, the following code sets `first_level_url` to the URL used in
|
||||||
|
the page's top-level breadcrumb (if any), and `second_level_url` to that used
|
||||||
|
in the page's second-level breadcrumb (if any).
|
||||||
|
|
||||||
|
For pages with children, the code also sets `toc_list` to the list of child pages,
|
||||||
|
reversing the order if needed.
|
||||||
|
{%- endcomment -%}
|
||||||
|
|
||||||
|
{%- if page.collection == include.key -%}
|
||||||
|
{%- for node in first_level_pages -%}
|
||||||
|
{%- if page.grand_parent == node.title or page.parent == node.title and page.grand_parent == nil -%}
|
||||||
|
{%- assign first_level_url = node.url | relative_url -%}
|
||||||
|
{%- endif -%}
|
||||||
|
{%- if node.has_children -%}
|
||||||
|
{%- assign children_list = second_level_pages | where: "parent", node.title -%}
|
||||||
|
{%- for child in children_list -%}
|
||||||
|
{%- if child.has_children -%}
|
||||||
|
{%- if page.url == child.url or page.parent == child.title and page.grand_parent == child.parent -%}
|
||||||
|
{%- assign second_level_url = child.url | relative_url -%}
|
||||||
|
{%- endif -%}
|
||||||
|
{%- endif -%}
|
||||||
|
{%- endfor -%}
|
||||||
|
{%- endif -%}
|
||||||
|
{%- endfor -%}
|
||||||
|
{%- if page.has_children == true and page.has_toc != false -%}
|
||||||
|
{%- assign toc_list = pages_list
|
||||||
|
| where: "parent", page.title
|
||||||
|
| where_exp: "item", "item.grand_parent == page.parent" -%}
|
||||||
|
{%- if page.child_nav_order == 'desc' or page.child_nav_order == 'reversed' -%}
|
||||||
|
{%- assign toc_list = toc_list | reverse -%}
|
||||||
|
{%- endif -%}
|
||||||
|
{%- endif -%}
|
||||||
|
{%- endif -%}
|
||||||
|
0
_includes/nav_footer_custom.html
Normal file
0
_includes/nav_footer_custom.html
Normal file
1
_includes/search_placeholder_custom.html
Normal file
1
_includes/search_placeholder_custom.html
Normal file
@@ -0,0 +1 @@
|
|||||||
|
Search {{site.title}}
|
5
_includes/title.html
Normal file
5
_includes/title.html
Normal file
@@ -0,0 +1,5 @@
|
|||||||
|
{% if site.logo %}
|
||||||
|
<div class="site-logo"></div>
|
||||||
|
{% else %}
|
||||||
|
{{ site.title }}
|
||||||
|
{% endif %}
|
1
_includes/toc_heading_custom.html
Normal file
1
_includes/toc_heading_custom.html
Normal file
@@ -0,0 +1 @@
|
|||||||
|
<h2 class="text-delta">Table of contents</h2>
|
172
_includes/vendor/anchor_headings.html
vendored
Executable file
172
_includes/vendor/anchor_headings.html
vendored
Executable file
@@ -0,0 +1,172 @@
|
|||||||
|
{% capture headingsWorkspace %}
|
||||||
|
{% comment %}
|
||||||
|
Copyright (c) 2018 Vladimir "allejo" Jimenez
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person
|
||||||
|
obtaining a copy of this software and associated documentation
|
||||||
|
files (the "Software"), to deal in the Software without
|
||||||
|
restriction, including without limitation the rights to use,
|
||||||
|
copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the
|
||||||
|
Software is furnished to do so, subject to the following
|
||||||
|
conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be
|
||||||
|
included in all copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
||||||
|
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
|
||||||
|
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
||||||
|
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
|
||||||
|
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
|
||||||
|
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
||||||
|
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
|
||||||
|
OTHER DEALINGS IN THE SOFTWARE.
|
||||||
|
{% endcomment %}
|
||||||
|
{% comment %}
|
||||||
|
Version 1.0.12
|
||||||
|
https://github.com/allejo/jekyll-anchor-headings
|
||||||
|
|
||||||
|
"Be the pull request you wish to see in the world." ~Ben Balter
|
||||||
|
|
||||||
|
Usage:
|
||||||
|
{% include anchor_headings.html html=content anchorBody="#" %}
|
||||||
|
|
||||||
|
Parameters:
|
||||||
|
* html (string) - the HTML of compiled markdown generated by kramdown in Jekyll
|
||||||
|
|
||||||
|
Optional Parameters:
|
||||||
|
* beforeHeading (bool) : false - Set to true if the anchor should be placed _before_ the heading's content
|
||||||
|
* headerAttrs (string) : '' - Any custom HTML attributes that will be added to the heading tag; you may NOT use `id`;
|
||||||
|
the `%heading%` and `%html_id%` placeholders are available
|
||||||
|
* anchorAttrs (string) : '' - Any custom HTML attributes that will be added to the `<a>` tag; you may NOT use `href`, `class` or `title`;
|
||||||
|
the `%heading%` and `%html_id%` placeholders are available
|
||||||
|
* anchorBody (string) : '' - The content that will be placed inside the anchor; the `%heading%` placeholder is available
|
||||||
|
* anchorClass (string) : '' - The class(es) that will be used for each anchor. Separate multiple classes with a space
|
||||||
|
* anchorTitle (string) : '' - The `title` attribute that will be used for anchors
|
||||||
|
* h_min (int) : 1 - The minimum header level to build an anchor for; any header lower than this value will be ignored
|
||||||
|
* h_max (int) : 6 - The maximum header level to build an anchor for; any header greater than this value will be ignored
|
||||||
|
* bodyPrefix (string) : '' - Anything that should be inserted inside of the heading tag _before_ its anchor and content
|
||||||
|
* bodySuffix (string) : '' - Anything that should be inserted inside of the heading tag _after_ its anchor and content
|
||||||
|
* generateId (true) : false - Set to true if a header without id should generate an id to use.
|
||||||
|
|
||||||
|
Output:
|
||||||
|
The original HTML with the addition of anchors inside of all of the h1-h6 headings.
|
||||||
|
{% endcomment %}
|
||||||
|
|
||||||
|
{% assign minHeader = include.h_min | default: 1 %}
|
||||||
|
{% assign maxHeader = include.h_max | default: 6 %}
|
||||||
|
{% assign beforeHeading = include.beforeHeading %}
|
||||||
|
{% assign headerAttrs = include.headerAttrs %}
|
||||||
|
{% assign nodes = include.html | split: '<h' %}
|
||||||
|
|
||||||
|
{% capture edited_headings %}{% endcapture %}
|
||||||
|
|
||||||
|
{% for _node in nodes %}
|
||||||
|
{% capture node %}{{ _node | strip }}{% endcapture %}
|
||||||
|
|
||||||
|
{% if node == "" %}
|
||||||
|
{% continue %}
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
|
{% assign nextChar = node | replace: '"', '' | strip | slice: 0, 1 %}
|
||||||
|
{% assign headerLevel = nextChar | times: 1 %}
|
||||||
|
|
||||||
|
<!-- If the level is cast to 0, it means it's not a h1-h6 tag, so let's see if we need to fix it -->
|
||||||
|
{% if headerLevel == 0 %}
|
||||||
|
<!-- Split up the node based on closing angle brackets and get the first one. -->
|
||||||
|
{% assign firstChunk = node | split: '>' | first %}
|
||||||
|
|
||||||
|
<!-- If the first chunk does NOT contain a '<', that means we've broken another HTML tag that starts with 'h' -->
|
||||||
|
{% unless firstChunk contains '<' %}
|
||||||
|
{% capture node %}<h{{ node }}{% endcapture %}
|
||||||
|
{% endunless %}
|
||||||
|
|
||||||
|
{% capture edited_headings %}{{ edited_headings }}{{ node }}{% endcapture %}
|
||||||
|
{% continue %}
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
|
{% capture _closingTag %}</h{{ headerLevel }}>{% endcapture %}
|
||||||
|
{% assign _workspace = node | split: _closingTag %}
|
||||||
|
{% capture _hAttrToStrip %}{{ _workspace[0] | split: '>' | first }}>{% endcapture %}
|
||||||
|
{% assign header = _workspace[0] | replace: _hAttrToStrip, '' %}
|
||||||
|
{% assign escaped_header = header | strip_html | strip %}
|
||||||
|
|
||||||
|
{% assign _classWorkspace = _workspace[0] | split: 'class="' %}
|
||||||
|
{% assign _classWorkspace = _classWorkspace[1] | split: '"' %}
|
||||||
|
{% assign _html_class = _classWorkspace[0] %}
|
||||||
|
|
||||||
|
{% if _html_class contains "no_anchor" %}
|
||||||
|
{% assign skip_anchor = true %}
|
||||||
|
{% else %}
|
||||||
|
{% assign skip_anchor = false %}
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
|
{% assign _idWorkspace = _workspace[0] | split: 'id="' %}
|
||||||
|
{% if _idWorkspace[1] %}
|
||||||
|
{% assign _idWorkspace = _idWorkspace[1] | split: '"' %}
|
||||||
|
{% assign html_id = _idWorkspace[0] %}
|
||||||
|
{% elsif include.generateId %}
|
||||||
|
<!-- If the header did not have an id we create one. -->
|
||||||
|
{% assign html_id = escaped_header | slugify %}
|
||||||
|
{% if html_id == "" %}
|
||||||
|
{% assign html_id = false %}
|
||||||
|
{% endif %}
|
||||||
|
{% capture headerAttrs %}{{ headerAttrs }} id="%html_id%"{% endcapture %}
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
|
<!-- Build the anchor to inject for our heading -->
|
||||||
|
{% capture anchor %}{% endcapture %}
|
||||||
|
|
||||||
|
{% if skip_anchor == false and html_id and headerLevel >= minHeader and headerLevel <= maxHeader %}
|
||||||
|
{% if headerAttrs %}
|
||||||
|
{% capture _hAttrToStrip %}{{ _hAttrToStrip | split: '>' | first }} {{ headerAttrs | replace: '%heading%', escaped_header | replace: '%html_id%', html_id }}>{% endcapture %}
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
|
{% capture anchor %}href="#{{ html_id }}"{% endcapture %}
|
||||||
|
|
||||||
|
{% if include.anchorClass %}
|
||||||
|
{% capture anchor %}{{ anchor }} class="{{ include.anchorClass }}"{% endcapture %}
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
|
{% if include.anchorTitle %}
|
||||||
|
{% capture anchor %}{{ anchor }} title="{{ include.anchorTitle | replace: '%heading%', escaped_header }}"{% endcapture %}
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
|
{% if include.anchorAttrs %}
|
||||||
|
{% capture anchor %}{{ anchor }} {{ include.anchorAttrs | replace: '%heading%', escaped_header | replace: '%html_id%', html_id }}{% endcapture %}
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
|
{% capture anchor %}<a {{ anchor }}>{{ include.anchorBody | replace: '%heading%', escaped_header | default: '' }}</a>{% endcapture %}
|
||||||
|
|
||||||
|
<!-- In order to prevent adding extra space after a heading, we'll let the 'anchor' value contain it -->
|
||||||
|
{% if beforeHeading %}
|
||||||
|
{% capture anchor %}{{ anchor }} {% endcapture %}
|
||||||
|
{% else %}
|
||||||
|
{% capture anchor %} {{ anchor }}{% endcapture %}
|
||||||
|
{% endif %}
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
|
{% capture new_heading %}
|
||||||
|
<h{{ _hAttrToStrip }}
|
||||||
|
{{ include.bodyPrefix }}
|
||||||
|
{% if beforeHeading %}
|
||||||
|
{{ anchor }}{{ header }}
|
||||||
|
{% else %}
|
||||||
|
{{ header }}{{ anchor }}
|
||||||
|
{% endif %}
|
||||||
|
{{ include.bodySuffix }}
|
||||||
|
</h{{ headerLevel }}>
|
||||||
|
{% endcapture %}
|
||||||
|
|
||||||
|
<!--
|
||||||
|
If we have content after the `</hX>` tag, then we'll want to append that here so we don't lost any content.
|
||||||
|
-->
|
||||||
|
{% assign chunkCount = _workspace | size %}
|
||||||
|
{% if chunkCount > 1 %}
|
||||||
|
{% capture new_heading %}{{ new_heading }}{{ _workspace | last }}{% endcapture %}
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
|
{% capture edited_headings %}{{ edited_headings }}{{ new_heading }}{% endcapture %}
|
||||||
|
{% endfor %}
|
||||||
|
{% endcapture %}{% assign headingsWorkspace = '' %}{{ edited_headings | strip }}
|
@@ -1,78 +1,41 @@
|
|||||||
|
---
|
||||||
|
layout: table_wrappers
|
||||||
|
---
|
||||||
|
|
||||||
<!DOCTYPE html>
|
<!DOCTYPE html>
|
||||||
|
|
||||||
<html lang="{{ site.lang | default: "en-US" }}">
|
<html lang="{{ site.lang | default: 'en-US' }}">
|
||||||
{% include head.html %}
|
{% include head.html %}
|
||||||
<body>
|
<body>
|
||||||
|
<a class="skip-to-main" href="#main-content">Skip to main content</a>
|
||||||
<div class="page-wrap">
|
{% include icons/icons.html %}
|
||||||
<div class="side-bar">
|
{% include components/sidebar.html %}
|
||||||
<a href="{{ site.url }}{{ site.baseurl }}" class="site-title fs-6 lh-tight">{{ site.title }}</a>
|
<div class="main" id="top">
|
||||||
<span class="fs-3"><button class="js-main-nav-trigger navigation-list-toggle btn btn-outline" type="button" data-text-toggle="Hide">Menu</button></span>
|
{% include components/header.html %}
|
||||||
<div class="navigation main-nav js-main-nav">
|
<div id="main-content-wrap" class="main-content-wrap">
|
||||||
{% include nav.html %}
|
{% include components/breadcrumbs.html %}
|
||||||
</div>
|
<div id="main-content" class="main-content" role="main">
|
||||||
<footer role="contentinfo" class="site-footer">
|
{% if site.heading_anchors != false %}
|
||||||
<p class="text-small text-grey-dk-000 mb-0">This site uses <a href="https://github.com/pmarsceill/just-the-docs">Just the Docs</a>, a documentation theme for Jekyll.</p>
|
{% include vendor/anchor_headings.html html=content beforeHeading="true" anchorBody="<svg viewBox=\"0 0 16 16\" aria-hidden=\"true\"><use xlink:href=\"#svg-link\"></use></svg>" anchorClass="anchor-heading" anchorAttrs="aria-labelledby=\"%html_id%\"" %}
|
||||||
</footer>
|
{% else %}
|
||||||
</div>
|
|
||||||
<div class="main-content-wrap js-main-content" tabindex="0">
|
|
||||||
<div class="page-header">
|
|
||||||
<div class="main-content">
|
|
||||||
{% if site.search_enabled != nil %}
|
|
||||||
<div class="search js-search">
|
|
||||||
<div class="search-input-wrap">
|
|
||||||
<input type="text" class="js-search-input search-input" tabindex="0" placeholder="Search {{ site.title }}" aria-label="Search {{ site.title }}" autocomplete="off">
|
|
||||||
<svg width="14" height="14" viewBox="0 0 28 28" xmlns="http://www.w3.org/2000/svg" class="search-icon"><title>Search</title><g fill-rule="nonzero"><path d="M17.332 20.735c-5.537 0-10-4.6-10-10.247 0-5.646 4.463-10.247 10-10.247 5.536 0 10 4.601 10 10.247s-4.464 10.247-10 10.247zm0-4c3.3 0 6-2.783 6-6.247 0-3.463-2.7-6.247-6-6.247s-6 2.784-6 6.247c0 3.464 2.7 6.247 6 6.247z"/><path d="M11.672 13.791L.192 25.271 3.02 28.1 14.5 16.62z"/></g></svg>
|
|
||||||
</div>
|
|
||||||
<div class="js-search-results search-results-wrap"></div>
|
|
||||||
</div>
|
|
||||||
{% endif %}
|
|
||||||
{% if site.aux_links != nil %}
|
|
||||||
<ul class="list-style-none text-small mt-md-1 mb-md-1 pb-4 pb-md-0 js-aux-nav aux-nav">
|
|
||||||
{% for link in site.aux_links %}
|
|
||||||
<li class="d-inline-block my-0{% unless forloop.last %} mr-2{% endunless %}"><a href="{{ link.last }}">{{ link.first }}</a></li>
|
|
||||||
{% endfor %}
|
|
||||||
</ul>
|
|
||||||
{% endif %}
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div class="main-content">
|
|
||||||
{% unless page.url == "/" %}
|
|
||||||
{% if page.parent %}
|
|
||||||
<nav class="breadcrumb-nav">
|
|
||||||
<ol class="breadcrumb-nav-list">
|
|
||||||
{% if page.grand_parent %}
|
|
||||||
<li class="breadcrumb-nav-list-item"><a href="{{ first_level_url }}">{{ page.grand_parent }}</a></li>
|
|
||||||
<li class="breadcrumb-nav-list-item"><a href="{{ second_level_url }}">{{ page.parent }}</a></li>
|
|
||||||
{% else %}
|
|
||||||
<li class="breadcrumb-nav-list-item"><a href="{{ first_level_url }}">{{ page.parent }}</a></li>
|
|
||||||
{% endif %}
|
|
||||||
<li class="breadcrumb-nav-list-item"><span>{{ page.title }}</span></li>
|
|
||||||
</ol>
|
|
||||||
</nav>
|
|
||||||
{% endif %}
|
|
||||||
{% endunless %}
|
|
||||||
<div id="main-content" class="page-content" role="main">
|
|
||||||
{{ content }}
|
{{ content }}
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
|
{% if page.has_children == true and page.has_toc != false %}
|
||||||
|
{% include components/children_nav.html toc_list=toc_list %}
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
|
{% include components/footer.html %}
|
||||||
|
|
||||||
{% if page.has_children == true and page.has_toc != false %}
|
|
||||||
<hr>
|
|
||||||
<h2 class="text-delta">Table of contents</h2>
|
|
||||||
{% assign children_list = site.pages | sort:"nav_order" %}
|
|
||||||
<ul>
|
|
||||||
{% for child in children_list %}
|
|
||||||
{% if child.parent == page.title and child.title != page.title %}
|
|
||||||
<li>
|
|
||||||
<a href="{{ child.url | absolute_url }}">{{ child.title }}</a>
|
|
||||||
</li>
|
|
||||||
{% endif %}
|
|
||||||
{% endfor %}
|
|
||||||
</ul>
|
|
||||||
{% endif %}
|
|
||||||
</div>
|
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
{% if site.search_enabled != false %}
|
||||||
|
{% include components/search_footer.html %}
|
||||||
|
{% endif %}
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
{% if site.mermaid %}
|
||||||
|
{% include components/mermaid.html %}
|
||||||
|
{% endif %}
|
||||||
</body>
|
</body>
|
||||||
</html>
|
</html>
|
||||||
|
60
_layouts/minimal.html
Normal file
60
_layouts/minimal.html
Normal file
@@ -0,0 +1,60 @@
|
|||||||
|
---
|
||||||
|
layout: table_wrappers
|
||||||
|
---
|
||||||
|
|
||||||
|
<!DOCTYPE html>
|
||||||
|
|
||||||
|
<html lang="{{ site.lang | default: 'en-US' }}">
|
||||||
|
{% include head.html %}
|
||||||
|
<body>
|
||||||
|
<a class="skip-to-main" href="#main-content">Skip to main content</a>
|
||||||
|
{% include icons/icons.html %}
|
||||||
|
{% comment %}
|
||||||
|
This is a bandaid fix to properly render breadcrumbs; as of now, there is some variable leakage between the sidebar component (which computes parents, grandparents) and the breadcrumbs component. We plan to remove this in a future release to deduplicate code.
|
||||||
|
|
||||||
|
For more context, see https://github.com/just-the-docs/just-the-docs/pull/1058#discussion_r1057014053
|
||||||
|
{% endcomment %}
|
||||||
|
{% capture nav %}
|
||||||
|
{% assign pages_top_size = site.html_pages
|
||||||
|
| where_exp:"item", "item.title != nil"
|
||||||
|
| where_exp:"item", "item.parent == nil"
|
||||||
|
| where_exp:"item", "item.nav_exclude != true"
|
||||||
|
| size %}
|
||||||
|
{% if pages_top_size > 0 %}
|
||||||
|
{% include nav.html pages=site.html_pages key=nil %}
|
||||||
|
{% endif %}
|
||||||
|
{% if site.just_the_docs.collections %}
|
||||||
|
{% assign collections_size = site.just_the_docs.collections | size %}
|
||||||
|
{% for collection_entry in site.just_the_docs.collections %}
|
||||||
|
{% assign collection_key = collection_entry[0] %}
|
||||||
|
{% assign collection_value = collection_entry[1] %}
|
||||||
|
{% assign collection = site[collection_key] %}
|
||||||
|
{% if collection_value.nav_exclude != true %}
|
||||||
|
{% include nav.html pages=collection key=collection_key %}
|
||||||
|
{% endif %}
|
||||||
|
{% endfor %}
|
||||||
|
{% endif %}
|
||||||
|
{% endcapture %}
|
||||||
|
<div id="main-content-wrap" class="main-content-wrap" id="top">
|
||||||
|
{% include components/breadcrumbs.html %}
|
||||||
|
<div id="main-content" class="main-content" role="main">
|
||||||
|
{% if site.heading_anchors != false %}
|
||||||
|
{% include vendor/anchor_headings.html html=content beforeHeading="true" anchorBody="<svg viewBox=\"0 0 16 16\" aria-hidden=\"true\"><use xlink:href=\"#svg-link\"></use></svg>" anchorClass="anchor-heading" anchorAttrs="aria-labelledby=\"%html_id%\"" %}
|
||||||
|
{% else %}
|
||||||
|
{{ content }}
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
|
{% if page.has_children == true and page.has_toc != false %}
|
||||||
|
{% include components/children_nav.html toc_list=toc_list %}
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
|
{% include components/footer.html %}
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
{% if site.mermaid %}
|
||||||
|
{% include components/mermaid.html %}
|
||||||
|
{% endif %}
|
||||||
|
</body>
|
||||||
|
</html>
|
7
_layouts/table_wrappers.html
Normal file
7
_layouts/table_wrappers.html
Normal file
@@ -0,0 +1,7 @@
|
|||||||
|
---
|
||||||
|
layout: vendor/compress
|
||||||
|
---
|
||||||
|
|
||||||
|
{% assign content_ = content | replace: '<table', '<div class="table-wrapper"><table' %}
|
||||||
|
{% assign content_ = content_ | replace: '</table>', '</table></div>' %}
|
||||||
|
{{ content_ }}
|
10
_layouts/vendor/compress.html
vendored
Normal file
10
_layouts/vendor/compress.html
vendored
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
---
|
||||||
|
# Jekyll layout that compresses HTML
|
||||||
|
# v3.1.0
|
||||||
|
# http://jch.penibelst.de/
|
||||||
|
# © 2014–2015 Anatol Broder
|
||||||
|
# MIT License
|
||||||
|
---
|
||||||
|
|
||||||
|
{% capture _LINE_FEED %}
|
||||||
|
{% endcapture %}{% if site.compress_html.ignore.envs contains jekyll.environment or site.compress_html.ignore.envs == "all" %}{{ content }}{% else %}{% capture _content %}{{ content }}{% endcapture %}{% assign _profile = site.compress_html.profile %}{% if site.compress_html.endings == "all" %}{% assign _endings = "html head body li dt dd optgroup option colgroup caption thead tbody tfoot tr td th" | split: " " %}{% else %}{% assign _endings = site.compress_html.endings %}{% endif %}{% for _element in _endings %}{% capture _end %}</{{ _element }}>{% endcapture %}{% assign _content = _content | remove: _end %}{% endfor %}{% if _profile and _endings %}{% assign _profile_endings = _content | size | plus: 1 %}{% endif %}{% for _element in site.compress_html.startings %}{% capture _start %}<{{ _element }}>{% endcapture %}{% assign _content = _content | remove: _start %}{% endfor %}{% if _profile and site.compress_html.startings %}{% assign _profile_startings = _content | size | plus: 1 %}{% endif %}{% if site.compress_html.comments == "all" %}{% assign _comments = "<!-- -->" | split: " " %}{% else %}{% assign _comments = site.compress_html.comments %}{% endif %}{% if _comments.size == 2 %}{% capture _comment_befores %}.{{ _content }}{% endcapture %}{% assign _comment_befores = _comment_befores | split: _comments.first %}{% for _comment_before in _comment_befores %}{% if forloop.first %}{% continue %}{% endif %}{% capture _comment_outside %}{% if _carry %}{{ _comments.first }}{% endif %}{{ _comment_before }}{% endcapture %}{% capture _comment %}{% unless _carry %}{{ _comments.first }}{% endunless %}{{ _comment_outside | split: _comments.last | first }}{% if _comment_outside contains _comments.last %}{{ _comments.last }}{% assign _carry = false %}{% else %}{% assign _carry = true %}{% endif %}{% endcapture %}{% assign _content = _content | remove_first: _comment %}{% endfor %}{% if _profile %}{% assign _profile_comments = _content | size | plus: 1 %}{% endif %}{% endif %}{% assign _pre_befores = _content | split: "<pre" %}{% assign _content = "" %}{% for _pre_before in _pre_befores %}{% assign _pres = _pre_before | split: "</pre>" %}{% assign _pres_after = "" %}{% if _pres.size != 0 %}{% if site.compress_html.blanklines %}{% assign _lines = _pres.last | split: _LINE_FEED %}{% capture _pres_after %}{% for _line in _lines %}{% assign _trimmed = _line | split: " " | join: " " %}{% if _trimmed != empty or forloop.last %}{% unless forloop.first %}{{ _LINE_FEED }}{% endunless %}{{ _line }}{% endif %}{% endfor %}{% endcapture %}{% else %}{% assign _pres_after = _pres.last | split: " " | join: " " %}{% endif %}{% endif %}{% capture _content %}{{ _content }}{% if _pre_before contains "</pre>" %}<pre{{ _pres.first }}</pre>{% endif %}{% unless _pre_before contains "</pre>" and _pres.size == 1 %}{{ _pres_after }}{% endunless %}{% endcapture %}{% endfor %}{% if _profile %}{% assign _profile_collapse = _content | size | plus: 1 %}{% endif %}{% if site.compress_html.clippings == "all" %}{% assign _clippings = "html head title base link meta style body article section nav aside h1 h2 h3 h4 h5 h6 hgroup header footer address p hr blockquote ol ul li dl dt dd figure figcaption main div table caption colgroup col tbody thead tfoot tr td th" | split: " " %}{% else %}{% assign _clippings = site.compress_html.clippings %}{% endif %}{% for _element in _clippings %}{% assign _edges = " <e;<e; </e>;</e>;</e> ;</e>" | replace: "e", _element | split: ";" %}{% assign _content = _content | replace: _edges[0], _edges[1] | replace: _edges[2], _edges[3] | replace: _edges[4], _edges[5] %}{% endfor %}{% if _profile and _clippings %}{% assign _profile_clippings = _content | size | plus: 1 %}{% endif %}{{ _content }}{% if _profile %} <table id="compress_html_profile_{{ site.time | date: "%Y%m%d" }}" class="compress_html_profile"> <thead> <tr> <td>Step <td>Bytes <tbody> <tr> <td>raw <td>{{ content | size }}{% if _profile_endings %} <tr> <td>endings <td>{{ _profile_endings }}{% endif %}{% if _profile_startings %} <tr> <td>startings <td>{{ _profile_startings }}{% endif %}{% if _profile_comments %} <tr> <td>comments <td>{{ _profile_comments }}{% endif %}{% if _profile_collapse %} <tr> <td>collapse <td>{{ _profile_collapse }}{% endif %}{% if _profile_clippings %} <tr> <td>clippings <td>{{ _profile_clippings }}{% endif %} </table>{% endif %}{% endif %}
|
@@ -1,7 +1,5 @@
|
|||||||
//
|
|
||||||
// Base element style overrides
|
// Base element style overrides
|
||||||
//
|
// stylelint-disable selector-no-type, selector-max-type, selector-max-specificity, selector-max-id
|
||||||
// stylelint-disable selector-no-type, selector-max-type
|
|
||||||
|
|
||||||
* {
|
* {
|
||||||
box-sizing: border-box;
|
box-sizing: border-box;
|
||||||
@@ -14,6 +12,8 @@
|
|||||||
|
|
||||||
html {
|
html {
|
||||||
@include fs-4;
|
@include fs-4;
|
||||||
|
|
||||||
|
scroll-behavior: smooth;
|
||||||
}
|
}
|
||||||
|
|
||||||
body {
|
body {
|
||||||
@@ -22,27 +22,21 @@ body {
|
|||||||
line-height: $body-line-height;
|
line-height: $body-line-height;
|
||||||
color: $body-text-color;
|
color: $body-text-color;
|
||||||
background-color: $body-background-color;
|
background-color: $body-background-color;
|
||||||
|
overflow-wrap: break-word;
|
||||||
}
|
}
|
||||||
|
|
||||||
p,
|
|
||||||
h1,
|
|
||||||
h2,
|
|
||||||
h3,
|
|
||||||
h4,
|
|
||||||
h5,
|
|
||||||
h6,
|
|
||||||
ol,
|
ol,
|
||||||
ul,
|
ul,
|
||||||
|
dl,
|
||||||
pre,
|
pre,
|
||||||
address,
|
address,
|
||||||
blockquote,
|
blockquote,
|
||||||
dl,
|
table,
|
||||||
div,
|
div,
|
||||||
fieldset,
|
|
||||||
form,
|
|
||||||
hr,
|
hr,
|
||||||
noscript,
|
form,
|
||||||
table {
|
fieldset,
|
||||||
|
noscript .table-wrapper {
|
||||||
margin-top: 0;
|
margin-top: 0;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -51,15 +45,17 @@ h2,
|
|||||||
h3,
|
h3,
|
||||||
h4,
|
h4,
|
||||||
h5,
|
h5,
|
||||||
h6 {
|
h6,
|
||||||
margin-top: 1.2em;
|
#toctitle {
|
||||||
margin-bottom: 0.8em;
|
margin-top: 0;
|
||||||
|
margin-bottom: 1em;
|
||||||
font-weight: 500;
|
font-weight: 500;
|
||||||
line-height: $body-heading-line-height;
|
line-height: $body-heading-line-height;
|
||||||
color: $body-heading-color;
|
color: $body-heading-color;
|
||||||
}
|
}
|
||||||
|
|
||||||
p {
|
p {
|
||||||
|
margin-top: 1em;
|
||||||
margin-bottom: 1em;
|
margin-bottom: 1em;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -69,26 +65,23 @@ a {
|
|||||||
}
|
}
|
||||||
|
|
||||||
a:not([class]) {
|
a:not([class]) {
|
||||||
text-decoration: none;
|
text-decoration: underline;
|
||||||
background-image: linear-gradient($border-color 0%, $border-color 100%);
|
text-decoration-color: $border-color;
|
||||||
background-repeat: repeat-x;
|
text-underline-offset: 2px;
|
||||||
background-position: 0 100%;
|
|
||||||
background-size: 1px 1px;
|
|
||||||
|
|
||||||
&:hover {
|
&:hover {
|
||||||
background-image: linear-gradient(rgba($link-color, 0.45) 0%, rgba($link-color, 0.45) 100%);
|
text-decoration-color: rgba($link-color, 0.45);
|
||||||
background-size: 1px 1px;
|
|
||||||
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
code {
|
code {
|
||||||
font-family: $mono-font-family;
|
font-family: $mono-font-family;
|
||||||
font-size: 12px;
|
font-size: 0.75em;
|
||||||
line-height: $body-line-height;
|
line-height: $body-line-height;
|
||||||
}
|
}
|
||||||
|
|
||||||
figure {
|
figure,
|
||||||
|
pre {
|
||||||
margin: 0;
|
margin: 0;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -108,3 +101,14 @@ hr {
|
|||||||
background-color: $border-color;
|
background-color: $border-color;
|
||||||
border: 0;
|
border: 0;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// adds a GitHub-style sidebar to blockquotes
|
||||||
|
blockquote {
|
||||||
|
margin: 10px 0;
|
||||||
|
|
||||||
|
// resets user-agent stylesheets for blockquotes
|
||||||
|
margin-block-start: 0;
|
||||||
|
margin-inline-start: 0;
|
||||||
|
padding-left: 15px;
|
||||||
|
border-left: 3px solid $border-color;
|
||||||
|
}
|
||||||
|
@@ -1,15 +1,10 @@
|
|||||||
//
|
|
||||||
// Buttons and things that look like buttons
|
// Buttons and things that look like buttons
|
||||||
//
|
|
||||||
// stylelint-disable color-named
|
// stylelint-disable color-named
|
||||||
|
|
||||||
.btn {
|
.btn {
|
||||||
display: inline-block;
|
display: inline-block;
|
||||||
box-sizing: border-box;
|
box-sizing: border-box;
|
||||||
padding-top: 0.3em;
|
padding: 0.3em 1em;
|
||||||
padding-right: 1em;
|
|
||||||
padding-bottom: 0.3em;
|
|
||||||
padding-left: 1em;
|
|
||||||
margin: 0;
|
margin: 0;
|
||||||
font-family: inherit;
|
font-family: inherit;
|
||||||
font-size: inherit;
|
font-size: inherit;
|
||||||
@@ -21,7 +16,7 @@
|
|||||||
cursor: pointer;
|
cursor: pointer;
|
||||||
background-color: $base-button-color;
|
background-color: $base-button-color;
|
||||||
border-width: 0;
|
border-width: 0;
|
||||||
border-radius: 3px;
|
border-radius: $border-radius;
|
||||||
box-shadow: 0 1px 2px rgba(0, 0, 0, 0.12), 0 3px 10px rgba(0, 0, 0, 0.08);
|
box-shadow: 0 1px 2px rgba(0, 0, 0, 0.12), 0 3px 10px rgba(0, 0, 0, 0.08);
|
||||||
appearance: none;
|
appearance: none;
|
||||||
|
|
||||||
|
285
_sass/code.scss
285
_sass/code.scss
@@ -1,108 +1,185 @@
|
|||||||
//
|
|
||||||
// Code and syntax highlighting
|
// Code and syntax highlighting
|
||||||
//
|
// stylelint-disable selector-no-qualifying-type, declaration-block-semicolon-newline-after,declaration-block-single-line-max-declarations, selector-no-type, selector-max-type, scss/comment-no-empty
|
||||||
// stylelint-disable selector-no-qualifying-type, declaration-block-semicolon-newline-after,declaration-block-single-line-max-declarations, selector-no-type, selector-max-type
|
|
||||||
|
|
||||||
code {
|
// {% raw %}
|
||||||
padding: 0.2em 0.15em;
|
|
||||||
font-weight: 400;
|
// This instruction applies to all queues not within 'pre' or 'figure', avoiding 'code' generated by the highlight.
|
||||||
background-color: $code-background-color;
|
:not(pre, figure) {
|
||||||
border: $border $border-color;
|
& > code {
|
||||||
border-radius: $border-radius;
|
padding: 0.2em 0.15em;
|
||||||
|
font-weight: 400;
|
||||||
|
background-color: $code-background-color;
|
||||||
|
border: $border $border-color;
|
||||||
|
border-radius: $border-radius;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
pre.highlight {
|
// Avoid appearance of dark border around visited code links in Safari
|
||||||
padding: $sp-3;
|
a:visited code {
|
||||||
margin-bottom: 0;
|
border-color: $border-color;
|
||||||
-webkit-overflow-scrolling: touch;
|
}
|
||||||
background-color: $code-background-color;
|
|
||||||
|
|
||||||
|
// Content structure for highlighted code blocks using fences or Liquid
|
||||||
|
//
|
||||||
|
// ```[LANG]...```, no kramdown line_numbers:
|
||||||
|
// div.[language-LANG.]highlighter-rouge > div.highlight > pre.highlight > code
|
||||||
|
//
|
||||||
|
// ```[LANG]...```, kramdown line_numbers = true:
|
||||||
|
// div.[language-LANG.]highlighter-rouge > div.highlight > pre.highlight > code
|
||||||
|
// > div.table-wrapper > table.rouge-table > tbody > tr
|
||||||
|
// > td.rouge-gutter.gl > pre.lineno
|
||||||
|
// | td.rouge-code > pre
|
||||||
|
//
|
||||||
|
// {% highlight LANG %}...{% endhighlight %}:
|
||||||
|
// figure.highlight > pre > code.language-LANG
|
||||||
|
//
|
||||||
|
// {% highlight LANG linenos %}...{% endhighlight %}:
|
||||||
|
// figure.highlight > pre > code.language-LANG
|
||||||
|
// > div.table-wrapper > table.rouge-table > tbody > tr
|
||||||
|
// > td.gutter.gl > pre.lineno
|
||||||
|
// | td.code > pre
|
||||||
|
//
|
||||||
|
// ----...---- (AsciiDoc)
|
||||||
|
// div.listingblock > div.content > pre.rouge.highlight
|
||||||
|
//
|
||||||
|
// fix_linenos removes the outermost pre when it encloses table.rouge-table
|
||||||
|
//
|
||||||
|
// See docs/index-test.md for some tests.
|
||||||
|
//
|
||||||
|
// No kramdown line_numbers: fences and Liquid highlighting look the same.
|
||||||
|
// Kramdown line_numbers = true: fences have a wider gutter than with Liquid?
|
||||||
|
|
||||||
|
// ```[LANG]...```
|
||||||
|
|
||||||
|
// the code may appear with 3 different types:
|
||||||
|
// container \ case: default case, code with line number, code with html rendering
|
||||||
|
// top level: div.highlighter-rouge, figure.highlight, figure.highlight
|
||||||
|
// second level: div.highlight, div.table-wrapper, pre.highlight
|
||||||
|
// third level: pre.highlight, td.code, absent
|
||||||
|
// last level: code, pre, code (optionality)
|
||||||
|
// highlighter level: span, span, span
|
||||||
|
// the spacing are only in the second level for case 1, 3 and in the third level for case 2
|
||||||
|
|
||||||
|
// select top level container
|
||||||
|
div.highlighter-rouge,
|
||||||
|
div.listingblock > div.content,
|
||||||
|
figure.highlight {
|
||||||
|
margin-top: 0;
|
||||||
|
margin-bottom: $sp-3;
|
||||||
|
background-color: $code-background-color;
|
||||||
|
border-radius: $border-radius;
|
||||||
|
box-shadow: none;
|
||||||
|
-webkit-overflow-scrolling: touch;
|
||||||
|
position: relative;
|
||||||
|
padding: 0;
|
||||||
|
|
||||||
|
// copy button (or other button)
|
||||||
|
// the button appear only when there is a hover on the code or focus on button
|
||||||
|
> button {
|
||||||
|
width: $sp-3;
|
||||||
|
opacity: 0;
|
||||||
|
position: absolute;
|
||||||
|
top: 0;
|
||||||
|
right: 0;
|
||||||
|
border: $sp-3 solid $code-background-color;
|
||||||
|
background-color: $code-background-color;
|
||||||
|
color: $body-text-color;
|
||||||
|
box-sizing: content-box;
|
||||||
|
|
||||||
|
svg {
|
||||||
|
fill: $body-text-color;
|
||||||
|
}
|
||||||
|
|
||||||
|
&:active {
|
||||||
|
text-decoration: none;
|
||||||
|
outline: none;
|
||||||
|
opacity: 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
&:focus {
|
||||||
|
opacity: 1;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// the button can be seen by doing a simple hover in the code, there is no need to go over the location of the button
|
||||||
|
&:hover {
|
||||||
|
> button {
|
||||||
|
cursor: copy;
|
||||||
|
opacity: 1;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// setting the spacing and scrollbar on the second level for the first case
|
||||||
|
// remove all space on the second and thirt level
|
||||||
|
div.highlighter-rouge,
|
||||||
|
div.listingblock {
|
||||||
|
div.highlight {
|
||||||
|
overflow-x: auto;
|
||||||
|
padding: $sp-3;
|
||||||
|
margin: 0;
|
||||||
|
border: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
pre.highlight,
|
||||||
code {
|
code {
|
||||||
padding: 0;
|
padding: 0;
|
||||||
|
margin: 0;
|
||||||
border: 0;
|
border: 0;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
.highlighter-rouge {
|
// {% highlight LANG %}...{% endhighlight %},
|
||||||
margin-bottom: $sp-3;
|
// {% highlight LANG linenos %}...{% endhighlight %}:
|
||||||
overflow: hidden;
|
|
||||||
border-radius: $border-radius;
|
// setting the spacing and scrollbar on the second level for the thirt case
|
||||||
|
// the css rule are apply only to the last code enviroment
|
||||||
|
// setting the scroolbar
|
||||||
|
figure.highlight {
|
||||||
|
pre,
|
||||||
|
:not(pre) > code {
|
||||||
|
overflow-x: auto;
|
||||||
|
padding: $sp-3;
|
||||||
|
margin: 0;
|
||||||
|
border: 0;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
.highlight .c { color: #586e75; } // comment //
|
// ```[LANG]...```, kramdown line_numbers = true,
|
||||||
.highlight .err { color: #93a1a1; } // error //
|
// {% highlight LANG linenos %}...{% endhighlight %}:
|
||||||
.highlight .g { color: #93a1a1; } // generic //
|
|
||||||
.highlight .k { color: #859900; } // keyword //
|
|
||||||
.highlight .l { color: #93a1a1; } // literal //
|
|
||||||
.highlight .n { color: #93a1a1; } // name //
|
|
||||||
.highlight .o { color: #859900; } // operator //
|
|
||||||
.highlight .x { color: #cb4b16; } // other //
|
|
||||||
.highlight .p { color: #93a1a1; } // punctuation //
|
|
||||||
.highlight .cm { color: #586e75; } // comment.multiline //
|
|
||||||
.highlight .cp { color: #859900; } // comment.preproc //
|
|
||||||
.highlight .c1 { color: #586e75; } // comment.single //
|
|
||||||
.highlight .cs { color: #859900; } // comment.special //
|
|
||||||
.highlight .gd { color: #2aa198; } // generic.deleted //
|
|
||||||
.highlight .ge { font-style: italic; color: #93a1a1; } // generic.emph //
|
|
||||||
.highlight .gr { color: #dc322f; } // generic.error //
|
|
||||||
.highlight .gh { color: #cb4b16; } // generic.heading //
|
|
||||||
.highlight .gi { color: #859900; } // generic.inserted //
|
|
||||||
.highlight .go { color: #93a1a1; } // generic.output //
|
|
||||||
.highlight .gp { color: #93a1a1; } // generic.prompt //
|
|
||||||
.highlight .gs { font-weight: bold; color: #93a1a1; } // generic.strong //
|
|
||||||
.highlight .gu { color: #cb4b16; } // generic.subheading //
|
|
||||||
.highlight .gt { color: #93a1a1; } // generic.traceback //
|
|
||||||
.highlight .kc { color: #cb4b16; } // keyword.constant //
|
|
||||||
.highlight .kd { color: #268bd2; } // keyword.declaration //
|
|
||||||
.highlight .kn { color: #859900; } // keyword.namespace //
|
|
||||||
.highlight .kp { color: #859900; } // keyword.pseudo //
|
|
||||||
.highlight .kr { color: #268bd2; } // keyword.reserved //
|
|
||||||
.highlight .kt { color: #dc322f; } // keyword.type //
|
|
||||||
.highlight .ld { color: #93a1a1; } // literal.date //
|
|
||||||
.highlight .m { color: #2aa198; } // literal.number //
|
|
||||||
.highlight .s { color: #2aa198; } // literal.string //
|
|
||||||
.highlight .na { color: #93a1a1; } // name.attribute //
|
|
||||||
.highlight .nb { color: #b58900; } // name.builtin //
|
|
||||||
.highlight .nc { color: #268bd2; } // name.class //
|
|
||||||
.highlight .no { color: #cb4b16; } // name.constant //
|
|
||||||
.highlight .nd { color: #268bd2; } // name.decorator //
|
|
||||||
.highlight .ni { color: #cb4b16; } // name.entity //
|
|
||||||
.highlight .ne { color: #cb4b16; } // name.exception //
|
|
||||||
.highlight .nf { color: #268bd2; } // name.function //
|
|
||||||
.highlight .nl { color: #93a1a1; } // name.label //
|
|
||||||
.highlight .nn { color: #93a1a1; } // name.namespace //
|
|
||||||
.highlight .nx { color: #555; } // name.other //
|
|
||||||
.highlight .py { color: #93a1a1; } // name.property //
|
|
||||||
.highlight .nt { color: #268bd2; } // name.tag //
|
|
||||||
.highlight .nv { color: #268bd2; } // name.variable //
|
|
||||||
.highlight .ow { color: #859900; } // operator.word //
|
|
||||||
.highlight .w { color: #93a1a1; } // text.whitespace //
|
|
||||||
.highlight .mf { color: #2aa198; } // literal.number.float //
|
|
||||||
.highlight .mh { color: #2aa198; } // literal.number.hex //
|
|
||||||
.highlight .mi { color: #2aa198; } // literal.number.integer //
|
|
||||||
.highlight .mo { color: #2aa198; } // literal.number.oct //
|
|
||||||
.highlight .sb { color: #586e75; } // literal.string.backtick //
|
|
||||||
.highlight .sc { color: #2aa198; } // literal.string.char //
|
|
||||||
.highlight .sd { color: #93a1a1; } // literal.string.doc //
|
|
||||||
.highlight .s2 { color: #2aa198; } // literal.string.double //
|
|
||||||
.highlight .se { color: #cb4b16; } // literal.string.escape //
|
|
||||||
.highlight .sh { color: #93a1a1; } // literal.string.heredoc //
|
|
||||||
.highlight .si { color: #2aa198; } // literal.string.interpol //
|
|
||||||
.highlight .sx { color: #2aa198; } // literal.string.other //
|
|
||||||
.highlight .sr { color: #dc322f; } // literal.string.regex //
|
|
||||||
.highlight .s1 { color: #2aa198; } // literal.string.single //
|
|
||||||
.highlight .ss { color: #2aa198; } // literal.string.symbol //
|
|
||||||
.highlight .bp { color: #268bd2; } // name.builtin.pseudo //
|
|
||||||
.highlight .vc { color: #268bd2; } // name.variable.class //
|
|
||||||
.highlight .vg { color: #268bd2; } // name.variable.global //
|
|
||||||
.highlight .vi { color: #268bd2; } // name.variable.instance //
|
|
||||||
.highlight .il { color: #2aa198; } // literal.number.integer.long //
|
|
||||||
|
|
||||||
//
|
// setting the spacing and scrollbar on the thirt level for the second case
|
||||||
// Code examples (rendered)
|
.highlight .table-wrapper {
|
||||||
//
|
padding: $sp-3 0;
|
||||||
|
margin: 0;
|
||||||
|
border: 0;
|
||||||
|
box-shadow: none;
|
||||||
|
|
||||||
.code-example {
|
td,
|
||||||
|
pre {
|
||||||
|
@include fs-2;
|
||||||
|
|
||||||
|
min-width: 0;
|
||||||
|
padding: 0;
|
||||||
|
background-color: $code-background-color;
|
||||||
|
border: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
td.gl {
|
||||||
|
width: 1em;
|
||||||
|
padding-right: $sp-3;
|
||||||
|
padding-left: $sp-3;
|
||||||
|
}
|
||||||
|
|
||||||
|
pre {
|
||||||
|
margin: 0;
|
||||||
|
line-height: 2;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Code examples: html render of a code
|
||||||
|
.code-example,
|
||||||
|
.listingblock > .title {
|
||||||
padding: $sp-3;
|
padding: $sp-3;
|
||||||
margin-bottom: $sp-3;
|
margin-bottom: $sp-3;
|
||||||
overflow: auto;
|
overflow: auto;
|
||||||
@@ -110,6 +187,8 @@ pre.highlight {
|
|||||||
border-radius: $border-radius;
|
border-radius: $border-radius;
|
||||||
|
|
||||||
+ .highlighter-rouge,
|
+ .highlighter-rouge,
|
||||||
|
+ .sectionbody .listingblock,
|
||||||
|
+ .content,
|
||||||
+ figure.highlight {
|
+ figure.highlight {
|
||||||
position: relative;
|
position: relative;
|
||||||
margin-top: -$sp-4;
|
margin-top: -$sp-4;
|
||||||
@@ -120,3 +199,29 @@ pre.highlight {
|
|||||||
border-top-right-radius: 0;
|
border-top-right-radius: 0;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Mermaid diagram code blocks should be left unstyled.
|
||||||
|
code.language-mermaid {
|
||||||
|
padding: 0;
|
||||||
|
background-color: inherit;
|
||||||
|
border: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Override OneDarkJekyll Colors for Code Blocks
|
||||||
|
.highlight,
|
||||||
|
pre.highlight {
|
||||||
|
background: $code-background-color; // Code Background
|
||||||
|
// For Backwards Compatibility Before $code-linenumber-color was added
|
||||||
|
@if variable-exists(code-linenumber-color) {
|
||||||
|
color: $code-linenumber-color; // Code Line Numbers
|
||||||
|
} @else {
|
||||||
|
color: $body-text-color; // Code Line Numbers
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Override OneDarkJekyll Colors for Code Blocks
|
||||||
|
.highlight pre {
|
||||||
|
background: $code-background-color; // Code Background
|
||||||
|
}
|
||||||
|
|
||||||
|
// {% endraw %}
|
||||||
|
@@ -1,14 +1,32 @@
|
|||||||
|
|
||||||
$body-background-color: $grey-dk-300;
|
$body-background-color: $grey-dk-300;
|
||||||
$sidebar-color: $grey-dk-300;
|
$sidebar-color: $grey-dk-300;
|
||||||
$border-color: $grey-dk-200;
|
$border-color: $grey-dk-200;
|
||||||
|
|
||||||
$body-text-color: $grey-lt-300;
|
$body-text-color: $grey-lt-300;
|
||||||
$body-heading-color: $grey-lt-000;
|
$body-heading-color: $grey-lt-000;
|
||||||
$nav-child-link-color: $grey-dk-000;
|
$nav-child-link-color: $grey-dk-000;
|
||||||
|
$search-result-preview-color: $grey-dk-000;
|
||||||
$link-color: $blue-000;
|
$link-color: $blue-000;
|
||||||
$btn-primary-color: $blue-200;
|
$btn-primary-color: $blue-200;
|
||||||
$base-button-color: $grey-dk-250;
|
$base-button-color: $grey-dk-250;
|
||||||
|
$search-background-color: $grey-dk-250;
|
||||||
|
$table-background-color: $grey-dk-250;
|
||||||
|
$feedback-color: darken($sidebar-color, 3%);
|
||||||
|
|
||||||
$code-background-color: $grey-dk-250;
|
// The following highlight theme is more legible than that used for the light color scheme
|
||||||
|
|
||||||
|
// @import "./vendor/OneDarkJekyll/syntax-one-dark";
|
||||||
|
// $code-background-color: #282c34; // OneDarkJekyll default for syntax-one-dark
|
||||||
|
// $code-linenumber-color: #abb2bf; // OneDarkJekyll .nf for syntax-one-dark
|
||||||
|
|
||||||
|
@import "./vendor/OneDarkJekyll/syntax-one-dark-vivid";
|
||||||
|
|
||||||
|
$code-background-color: #31343f; // OneDarkJekyll default for syntax-one-dark-vivid
|
||||||
|
$code-linenumber-color: #dee2f7; // OneDarkJekyll .nf for syntax-one-dark-vivid
|
||||||
|
|
||||||
|
// @import "./vendor/OneDarkJekyll/syntax-firewatch";
|
||||||
|
// $code-background-color: #282c34; // OneDarkJekyll default for syntax-firewatch
|
||||||
|
// $code-linenumber-color: #abb2bf; // OneDarkJekyll .nf for syntax-firewatch
|
||||||
|
|
||||||
|
// @import "./vendor/OneDarkJekyll/syntax-firewatch-green";
|
||||||
|
// $code-background-color: #282c34; // OneDarkJekyll default for syntax-firewatch-green
|
||||||
|
// $code-linenumber-color: #abb2bf; // OneDarkJekyll .nf for syntax-firewatch-green
|
||||||
|
208
_sass/color_schemes/light.scss
Normal file
208
_sass/color_schemes/light.scss
Normal file
@@ -0,0 +1,208 @@
|
|||||||
|
// Moved from _sass/code.scss
|
||||||
|
|
||||||
|
.highlight .c {
|
||||||
|
color: #586e75;
|
||||||
|
} // comment //
|
||||||
|
.highlight .err {
|
||||||
|
color: #93a1a1;
|
||||||
|
} // error //
|
||||||
|
.highlight .g {
|
||||||
|
color: #93a1a1;
|
||||||
|
} // generic //
|
||||||
|
.highlight .k {
|
||||||
|
color: #859900;
|
||||||
|
} // keyword //
|
||||||
|
.highlight .l {
|
||||||
|
color: #93a1a1;
|
||||||
|
} // literal //
|
||||||
|
.highlight .n {
|
||||||
|
color: #93a1a1;
|
||||||
|
} // name //
|
||||||
|
.highlight .o {
|
||||||
|
color: #859900;
|
||||||
|
} // operator //
|
||||||
|
.highlight .x {
|
||||||
|
color: #cb4b16;
|
||||||
|
} // other //
|
||||||
|
.highlight .p {
|
||||||
|
color: #93a1a1;
|
||||||
|
} // punctuation //
|
||||||
|
.highlight .cm {
|
||||||
|
color: #586e75;
|
||||||
|
} // comment.multiline //
|
||||||
|
.highlight .cp {
|
||||||
|
color: #859900;
|
||||||
|
} // comment.preproc //
|
||||||
|
.highlight .c1 {
|
||||||
|
color: #586e75;
|
||||||
|
} // comment.single //
|
||||||
|
.highlight .cs {
|
||||||
|
color: #859900;
|
||||||
|
} // comment.special //
|
||||||
|
.highlight .gd {
|
||||||
|
color: #2aa198;
|
||||||
|
} // generic.deleted //
|
||||||
|
.highlight .ge {
|
||||||
|
font-style: italic;
|
||||||
|
color: #93a1a1;
|
||||||
|
} // generic.emph //
|
||||||
|
.highlight .gr {
|
||||||
|
color: #dc322f;
|
||||||
|
} // generic.error //
|
||||||
|
.highlight .gh {
|
||||||
|
color: #cb4b16;
|
||||||
|
} // generic.heading //
|
||||||
|
.highlight .gi {
|
||||||
|
color: #859900;
|
||||||
|
} // generic.inserted //
|
||||||
|
.highlight .go {
|
||||||
|
color: #93a1a1;
|
||||||
|
} // generic.output //
|
||||||
|
.highlight .gp {
|
||||||
|
color: #93a1a1;
|
||||||
|
} // generic.prompt //
|
||||||
|
.highlight .gs {
|
||||||
|
font-weight: bold;
|
||||||
|
color: #93a1a1;
|
||||||
|
} // generic.strong //
|
||||||
|
.highlight .gu {
|
||||||
|
color: #cb4b16;
|
||||||
|
} // generic.subheading //
|
||||||
|
.highlight .gt {
|
||||||
|
color: #93a1a1;
|
||||||
|
} // generic.traceback //
|
||||||
|
.highlight .kc {
|
||||||
|
color: #cb4b16;
|
||||||
|
} // keyword.constant //
|
||||||
|
.highlight .kd {
|
||||||
|
color: #268bd2;
|
||||||
|
} // keyword.declaration //
|
||||||
|
.highlight .kn {
|
||||||
|
color: #859900;
|
||||||
|
} // keyword.namespace //
|
||||||
|
.highlight .kp {
|
||||||
|
color: #859900;
|
||||||
|
} // keyword.pseudo //
|
||||||
|
.highlight .kr {
|
||||||
|
color: #268bd2;
|
||||||
|
} // keyword.reserved //
|
||||||
|
.highlight .kt {
|
||||||
|
color: #dc322f;
|
||||||
|
} // keyword.type //
|
||||||
|
.highlight .ld {
|
||||||
|
color: #93a1a1;
|
||||||
|
} // literal.date //
|
||||||
|
.highlight .m {
|
||||||
|
color: #2aa198;
|
||||||
|
} // literal.number //
|
||||||
|
.highlight .s {
|
||||||
|
color: #2aa198;
|
||||||
|
} // literal.string //
|
||||||
|
.highlight .na {
|
||||||
|
color: #555;
|
||||||
|
} // name.attribute //
|
||||||
|
.highlight .nb {
|
||||||
|
color: #b58900;
|
||||||
|
} // name.builtin //
|
||||||
|
.highlight .nc {
|
||||||
|
color: #268bd2;
|
||||||
|
} // name.class //
|
||||||
|
.highlight .no {
|
||||||
|
color: #cb4b16;
|
||||||
|
} // name.constant //
|
||||||
|
.highlight .nd {
|
||||||
|
color: #268bd2;
|
||||||
|
} // name.decorator //
|
||||||
|
.highlight .ni {
|
||||||
|
color: #cb4b16;
|
||||||
|
} // name.entity //
|
||||||
|
.highlight .ne {
|
||||||
|
color: #cb4b16;
|
||||||
|
} // name.exception //
|
||||||
|
.highlight .nf {
|
||||||
|
color: #268bd2;
|
||||||
|
} // name.function //
|
||||||
|
.highlight .nl {
|
||||||
|
color: #555;
|
||||||
|
} // name.label //
|
||||||
|
.highlight .nn {
|
||||||
|
color: #93a1a1;
|
||||||
|
} // name.namespace //
|
||||||
|
.highlight .nx {
|
||||||
|
color: #555;
|
||||||
|
} // name.other //
|
||||||
|
.highlight .py {
|
||||||
|
color: #93a1a1;
|
||||||
|
} // name.property //
|
||||||
|
.highlight .nt {
|
||||||
|
color: #268bd2;
|
||||||
|
} // name.tag //
|
||||||
|
.highlight .nv {
|
||||||
|
color: #268bd2;
|
||||||
|
} // name.variable //
|
||||||
|
.highlight .ow {
|
||||||
|
color: #859900;
|
||||||
|
} // operator.word //
|
||||||
|
.highlight .w {
|
||||||
|
color: #93a1a1;
|
||||||
|
} // text.whitespace //
|
||||||
|
.highlight .mf {
|
||||||
|
color: #2aa198;
|
||||||
|
} // literal.number.float //
|
||||||
|
.highlight .mh {
|
||||||
|
color: #2aa198;
|
||||||
|
} // literal.number.hex //
|
||||||
|
.highlight .mi {
|
||||||
|
color: #2aa198;
|
||||||
|
} // literal.number.integer //
|
||||||
|
.highlight .mo {
|
||||||
|
color: #2aa198;
|
||||||
|
} // literal.number.oct //
|
||||||
|
.highlight .sb {
|
||||||
|
color: #586e75;
|
||||||
|
} // literal.string.backtick //
|
||||||
|
.highlight .sc {
|
||||||
|
color: #2aa198;
|
||||||
|
} // literal.string.char //
|
||||||
|
.highlight .sd {
|
||||||
|
color: #93a1a1;
|
||||||
|
} // literal.string.doc //
|
||||||
|
.highlight .s2 {
|
||||||
|
color: #2aa198;
|
||||||
|
} // literal.string.double //
|
||||||
|
.highlight .se {
|
||||||
|
color: #cb4b16;
|
||||||
|
} // literal.string.escape //
|
||||||
|
.highlight .sh {
|
||||||
|
color: #93a1a1;
|
||||||
|
} // literal.string.heredoc //
|
||||||
|
.highlight .si {
|
||||||
|
color: #2aa198;
|
||||||
|
} // literal.string.interpol //
|
||||||
|
.highlight .sx {
|
||||||
|
color: #2aa198;
|
||||||
|
} // literal.string.other //
|
||||||
|
.highlight .sr {
|
||||||
|
color: #dc322f;
|
||||||
|
} // literal.string.regex //
|
||||||
|
.highlight .s1 {
|
||||||
|
color: #2aa198;
|
||||||
|
} // literal.string.single //
|
||||||
|
.highlight .ss {
|
||||||
|
color: #2aa198;
|
||||||
|
} // literal.string.symbol //
|
||||||
|
.highlight .bp {
|
||||||
|
color: #268bd2;
|
||||||
|
} // name.builtin.pseudo //
|
||||||
|
.highlight .vc {
|
||||||
|
color: #268bd2;
|
||||||
|
} // name.variable.class //
|
||||||
|
.highlight .vg {
|
||||||
|
color: #268bd2;
|
||||||
|
} // name.variable.global //
|
||||||
|
.highlight .vi {
|
||||||
|
color: #268bd2;
|
||||||
|
} // name.variable.instance //
|
||||||
|
.highlight .il {
|
||||||
|
color: #2aa198;
|
||||||
|
} // literal.number.integer.long //
|
@@ -1,15 +1,24 @@
|
|||||||
@charset "UTF-8";
|
@charset "UTF-8";
|
||||||
|
|
||||||
//
|
|
||||||
// Styles for rendered markdown in the .main-content container
|
// Styles for rendered markdown in the .main-content container
|
||||||
//
|
// stylelint-disable selector-no-type, max-nesting-depth, selector-max-compound-selectors, selector-max-type, selector-max-specificity, selector-max-id
|
||||||
// stylelint-disable selector-no-type, max-nesting-depth, selector-max-compound-selectors, selector-max-type
|
|
||||||
|
.main-content {
|
||||||
|
line-height: $content-line-height;
|
||||||
|
|
||||||
|
ol,
|
||||||
|
ul,
|
||||||
|
dl,
|
||||||
|
pre,
|
||||||
|
address,
|
||||||
|
blockquote,
|
||||||
|
.table-wrapper {
|
||||||
|
margin-top: 0.5em;
|
||||||
|
}
|
||||||
|
|
||||||
.page-content {
|
|
||||||
a {
|
a {
|
||||||
overflow: hidden;
|
overflow: hidden;
|
||||||
text-overflow: ellipsis;
|
text-overflow: ellipsis;
|
||||||
white-space: nowrap;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
ul,
|
ul,
|
||||||
@@ -17,6 +26,12 @@
|
|||||||
padding-left: 1.5em;
|
padding-left: 1.5em;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
li {
|
||||||
|
.highlight {
|
||||||
|
margin-top: $sp-1;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
ol {
|
ol {
|
||||||
list-style-type: none;
|
list-style-type: none;
|
||||||
counter-reset: step-counter;
|
counter-reset: step-counter;
|
||||||
@@ -41,7 +56,7 @@
|
|||||||
ol {
|
ol {
|
||||||
counter-reset: sub-counter;
|
counter-reset: sub-counter;
|
||||||
|
|
||||||
li {
|
> li {
|
||||||
&::before {
|
&::before {
|
||||||
content: counter(sub-counter, lower-alpha);
|
content: counter(sub-counter, lower-alpha);
|
||||||
counter-increment: sub-counter;
|
counter-increment: sub-counter;
|
||||||
@@ -64,14 +79,7 @@
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
.task-list {
|
|
||||||
padding-left: 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
.task-list-item {
|
.task-list-item {
|
||||||
display: flex;
|
|
||||||
align-items: center;
|
|
||||||
|
|
||||||
&::before {
|
&::before {
|
||||||
content: "";
|
content: "";
|
||||||
}
|
}
|
||||||
@@ -79,6 +87,9 @@
|
|||||||
|
|
||||||
.task-list-item-checkbox {
|
.task-list-item-checkbox {
|
||||||
margin-right: 0.6em;
|
margin-right: 0.6em;
|
||||||
|
margin-left: -1.4em;
|
||||||
|
|
||||||
|
// The same margin-left is used above for ul > li::before
|
||||||
}
|
}
|
||||||
|
|
||||||
hr + * {
|
hr + * {
|
||||||
@@ -91,7 +102,7 @@
|
|||||||
|
|
||||||
dl {
|
dl {
|
||||||
display: grid;
|
display: grid;
|
||||||
grid-template-columns: max-content 1fr;
|
grid-template: auto / 10em 1fr;
|
||||||
}
|
}
|
||||||
|
|
||||||
dt,
|
dt,
|
||||||
@@ -100,6 +111,8 @@
|
|||||||
}
|
}
|
||||||
|
|
||||||
dt {
|
dt {
|
||||||
|
grid-column: 1;
|
||||||
|
font-weight: 500;
|
||||||
text-align: right;
|
text-align: right;
|
||||||
|
|
||||||
&::after {
|
&::after {
|
||||||
@@ -108,7 +121,119 @@
|
|||||||
}
|
}
|
||||||
|
|
||||||
dd {
|
dd {
|
||||||
|
grid-column: 2;
|
||||||
|
margin-bottom: 0;
|
||||||
margin-left: 1em;
|
margin-left: 1em;
|
||||||
font-weight: 500;
|
|
||||||
|
blockquote,
|
||||||
|
div,
|
||||||
|
dl,
|
||||||
|
dt,
|
||||||
|
h1,
|
||||||
|
h2,
|
||||||
|
h3,
|
||||||
|
h4,
|
||||||
|
h5,
|
||||||
|
h6,
|
||||||
|
li,
|
||||||
|
ol,
|
||||||
|
p,
|
||||||
|
pre,
|
||||||
|
table,
|
||||||
|
ul,
|
||||||
|
.table-wrapper {
|
||||||
|
&:first-child {
|
||||||
|
margin-top: 0;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
dd,
|
||||||
|
ol,
|
||||||
|
ul {
|
||||||
|
dl:first-child {
|
||||||
|
dt:first-child,
|
||||||
|
dd:nth-child(2) {
|
||||||
|
margin-top: 0;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
.anchor-heading {
|
||||||
|
position: absolute;
|
||||||
|
right: -$sp-4;
|
||||||
|
width: $sp-5;
|
||||||
|
height: 100%;
|
||||||
|
padding-right: $sp-1;
|
||||||
|
padding-left: $sp-1;
|
||||||
|
overflow: visible;
|
||||||
|
|
||||||
|
@include mq(md) {
|
||||||
|
right: auto;
|
||||||
|
left: -$sp-5;
|
||||||
|
}
|
||||||
|
|
||||||
|
svg {
|
||||||
|
display: inline-block;
|
||||||
|
width: 100%;
|
||||||
|
height: 100%;
|
||||||
|
color: $link-color;
|
||||||
|
visibility: hidden;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
.anchor-heading:hover,
|
||||||
|
.anchor-heading:focus,
|
||||||
|
h1:hover > .anchor-heading,
|
||||||
|
h2:hover > .anchor-heading,
|
||||||
|
h3:hover > .anchor-heading,
|
||||||
|
h4:hover > .anchor-heading,
|
||||||
|
h5:hover > .anchor-heading,
|
||||||
|
h6:hover > .anchor-heading {
|
||||||
|
svg {
|
||||||
|
visibility: visible;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
summary {
|
||||||
|
cursor: pointer;
|
||||||
|
}
|
||||||
|
|
||||||
|
h1,
|
||||||
|
h2,
|
||||||
|
h3,
|
||||||
|
h4,
|
||||||
|
h5,
|
||||||
|
h6,
|
||||||
|
#toctitle {
|
||||||
|
position: relative;
|
||||||
|
margin-top: 1.5em;
|
||||||
|
margin-bottom: 0.25em;
|
||||||
|
|
||||||
|
+ table,
|
||||||
|
+ .table-wrapper,
|
||||||
|
+ .code-example,
|
||||||
|
+ .highlighter-rouge,
|
||||||
|
+ .sectionbody .listingblock {
|
||||||
|
margin-top: 1em;
|
||||||
|
}
|
||||||
|
|
||||||
|
+ p:not(.label) {
|
||||||
|
margin-top: 0;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
> h1:first-child,
|
||||||
|
> h2:first-child,
|
||||||
|
> h3:first-child,
|
||||||
|
> h4:first-child,
|
||||||
|
> h5:first-child,
|
||||||
|
> h6:first-child,
|
||||||
|
> .sect1:first-child > h2,
|
||||||
|
> .sect2:first-child > h3,
|
||||||
|
> .sect3:first-child > h4,
|
||||||
|
> .sect4:first-child > h5,
|
||||||
|
> .sect5:first-child > h6 {
|
||||||
|
margin-top: $sp-2;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@@ -1,120 +1 @@
|
|||||||
// //
|
// custom SCSS (or CSS) goes here
|
||||||
// // Typography
|
|
||||||
// //
|
|
||||||
//
|
|
||||||
// $body-font-family: -apple-system, BlinkMacSystemFont, "helvetica neue", helvetica, roboto, noto, "segoe ui", arial, sans-serif;
|
|
||||||
// $mono-font-family: "SFMono-Regular", Menlo, Consolas, Monospace;
|
|
||||||
// $root-font-size: 16px; // Base font-size for rems
|
|
||||||
// $body-line-height: 1.4;
|
|
||||||
// $body-heading-line-height: 1.15;
|
|
||||||
//
|
|
||||||
// //
|
|
||||||
// // Colors
|
|
||||||
// //
|
|
||||||
//
|
|
||||||
// $white: #fff;
|
|
||||||
//
|
|
||||||
// $grey-dk-000: #959396;
|
|
||||||
// $grey-dk-100: #5c5962;
|
|
||||||
// $grey-dk-200: #44434d;
|
|
||||||
// $grey-dk-250: #302d36 !default;
|
|
||||||
// $grey-dk-300: #27262b;
|
|
||||||
//
|
|
||||||
// $grey-lt-000: #f5f6fa;
|
|
||||||
// $grey-lt-100: #eeebee;
|
|
||||||
// $grey-lt-200: #ecebed;
|
|
||||||
// $grey-lt-300: #e6e1e8;
|
|
||||||
//
|
|
||||||
// $purple-000: #7253ed;
|
|
||||||
// $purple-100: #5e41d0;
|
|
||||||
// $purple-200: #4e26af;
|
|
||||||
// $purple-300: #381885;
|
|
||||||
//
|
|
||||||
// $blue-000: #2c84fa;
|
|
||||||
// $blue-100: #2869e6;
|
|
||||||
// $blue-200: #264caf;
|
|
||||||
// $blue-300: #183385;
|
|
||||||
//
|
|
||||||
// $green-000: #41d693;
|
|
||||||
// $green-100: #11b584;
|
|
||||||
// $green-200: #009c7b;
|
|
||||||
// $green-300: #026e57;
|
|
||||||
//
|
|
||||||
// $body-background-color: $white !default;
|
|
||||||
// $sidebar-color: $grey-lt-000 !default;
|
|
||||||
// $code-background-color: $grey-lt-000 !default;
|
|
||||||
|
|
||||||
// $body-text-color: $grey-dk-100 !default;
|
|
||||||
// $body-heading-color: $grey-dk-300 !default;
|
|
||||||
// $nav-child-link-color: $grey-dk-100 !default;
|
|
||||||
// $link-color: $purple-000 !default;
|
|
||||||
// $btn-primary-color: $purple-100 !default;
|
|
||||||
// $base-button-color: #f7f7f7 !default;
|
|
||||||
//
|
|
||||||
// //
|
|
||||||
// // Media queries in pixels
|
|
||||||
// //
|
|
||||||
//
|
|
||||||
// $media-queries: (
|
|
||||||
// xs: 320px,
|
|
||||||
// sm: 500px,
|
|
||||||
// md: 740px,
|
|
||||||
// lg: 1120px,
|
|
||||||
// xl: 1400px
|
|
||||||
// );
|
|
||||||
//
|
|
||||||
// //
|
|
||||||
// // Spacing
|
|
||||||
// //
|
|
||||||
//
|
|
||||||
// $spacing-unit: 1rem; // 1rem == 16px
|
|
||||||
//
|
|
||||||
// $spacers: (
|
|
||||||
// sp-0: 0,
|
|
||||||
// sp-1: $spacing-unit * 0.25,
|
|
||||||
// sp-2: $spacing-unit * 0.5,
|
|
||||||
// sp-3: $spacing-unit * 0.75,
|
|
||||||
// sp-4: $spacing-unit,
|
|
||||||
// sp-5: $spacing-unit * 1.5,
|
|
||||||
// sp-6: $spacing-unit * 2,
|
|
||||||
// sp-7: $spacing-unit * 2.5,
|
|
||||||
// sp-8: $spacing-unit * 3,
|
|
||||||
// sp-9: $spacing-unit * 3.5,
|
|
||||||
// sp-10: $spacing-unit * 4
|
|
||||||
// );
|
|
||||||
//
|
|
||||||
// $sp-1: map-get($spacers, sp-1); // 0.25 rem == 4px
|
|
||||||
// $sp-2: map-get($spacers, sp-2); // 0.5 rem == 8px
|
|
||||||
// $sp-3: map-get($spacers, sp-3); // 0.75 rem == 12px
|
|
||||||
// $sp-4: map-get($spacers, sp-4); // 1 rem == 16px
|
|
||||||
// $sp-5: map-get($spacers, sp-5); // 1.5 rem == 24px
|
|
||||||
// $sp-6: map-get($spacers, sp-6); // 2 rem == 32px
|
|
||||||
// $sp-7: map-get($spacers, sp-7); // 2.5 rem == 40px
|
|
||||||
// $sp-8: map-get($spacers, sp-8); // 3 rem == 48px
|
|
||||||
// $sp-9: map-get($spacers, sp-9); // 4 rem == 48px
|
|
||||||
// $sp-10: map-get($spacers, sp-10); // 4.5 rem == 48px
|
|
||||||
//
|
|
||||||
// //
|
|
||||||
// // Borders
|
|
||||||
// //
|
|
||||||
//
|
|
||||||
// $border: 1px solid;
|
|
||||||
// $border-radius: 4px;
|
|
||||||
// $border-color: $grey-lt-100;
|
|
||||||
//
|
|
||||||
// //
|
|
||||||
// // Grid system
|
|
||||||
// //
|
|
||||||
//
|
|
||||||
// $gutter-spacing: $sp-6;
|
|
||||||
// $gutter-spacing-sm: $sp-4;
|
|
||||||
// $nav-width: 232px;
|
|
||||||
// $content-width: 800px;
|
|
||||||
//
|
|
||||||
// $media-queries: (
|
|
||||||
// xs: 320px,
|
|
||||||
// sm: 500px,
|
|
||||||
// md: 740px,
|
|
||||||
// lg: 800px,
|
|
||||||
// xl: 1316px
|
|
||||||
// );
|
|
||||||
|
1
_sass/custom/setup.scss
Normal file
1
_sass/custom/setup.scss
Normal file
@@ -0,0 +1 @@
|
|||||||
|
// custom setup code goes here
|
@@ -1,21 +1,18 @@
|
|||||||
//
|
|
||||||
// Labels (not the form kind)
|
// Labels (not the form kind)
|
||||||
//
|
|
||||||
|
|
||||||
.label,
|
.label,
|
||||||
.label-blue {
|
.label-blue {
|
||||||
display: inline-block;
|
display: inline-block;
|
||||||
padding-top: 0.16em;
|
padding: 0.16em 0.56em;
|
||||||
padding-right: 0.42em;
|
margin-right: $sp-2;
|
||||||
padding-bottom: 0.16em;
|
margin-left: $sp-2;
|
||||||
padding-left: 0.42em;
|
|
||||||
margin-right: $sp-1;
|
|
||||||
margin-left: $sp-1;
|
|
||||||
color: $white;
|
color: $white;
|
||||||
text-transform: uppercase;
|
text-transform: uppercase;
|
||||||
vertical-align: middle;
|
vertical-align: middle;
|
||||||
background-color: $blue-100;
|
background-color: $blue-100;
|
||||||
@include fs-2;
|
@include fs-2;
|
||||||
|
|
||||||
|
border-radius: 12px;
|
||||||
}
|
}
|
||||||
|
|
||||||
.label-green {
|
.label-green {
|
||||||
|
@@ -1,36 +1,16 @@
|
|||||||
//
|
|
||||||
// The basic two column layout
|
// The basic two column layout
|
||||||
//
|
|
||||||
|
|
||||||
.page-wrap {
|
|
||||||
@include mq(md) {
|
|
||||||
position: absolute;
|
|
||||||
top: 0;
|
|
||||||
left: 0;
|
|
||||||
display: flex;
|
|
||||||
width: 100%;
|
|
||||||
height: 100%;
|
|
||||||
overflow-x: hidden;
|
|
||||||
overflow-y: hidden;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
.side-bar {
|
.side-bar {
|
||||||
z-index: 100;
|
z-index: 0;
|
||||||
display: flex;
|
display: flex;
|
||||||
flex-wrap: wrap;
|
flex-wrap: wrap;
|
||||||
padding-top: $gutter-spacing-sm;
|
|
||||||
padding-bottom: $gutter-spacing-sm;
|
|
||||||
background-color: $sidebar-color;
|
background-color: $sidebar-color;
|
||||||
|
|
||||||
@include mq(md) {
|
@include mq(md) {
|
||||||
flex-wrap: nowrap;
|
flex-flow: column nowrap;
|
||||||
position: absolute;
|
position: fixed;
|
||||||
width: $nav-width + 16px;
|
width: $nav-width-md;
|
||||||
height: 100%;
|
height: 100%;
|
||||||
padding-top: $gutter-spacing * 2;
|
|
||||||
padding-bottom: 0;
|
|
||||||
flex-direction: column;
|
|
||||||
border-right: $border $border-color;
|
border-right: $border $border-color;
|
||||||
align-items: flex-end;
|
align-items: flex-end;
|
||||||
}
|
}
|
||||||
@@ -41,90 +21,157 @@
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
.main-content-wrap {
|
.main {
|
||||||
@include mq(md) {
|
|
||||||
position: absolute;
|
|
||||||
top: 0;
|
|
||||||
left: 0;
|
|
||||||
width: 100%;
|
|
||||||
height: 100%;
|
|
||||||
min-height: 600px;
|
|
||||||
-webkit-overflow-scrolling: touch;
|
|
||||||
overflow-x: hidden;
|
|
||||||
overflow-y: scroll;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
.main-content {
|
|
||||||
padding-top: $gutter-spacing-sm;
|
|
||||||
@include container;
|
|
||||||
|
|
||||||
@include mq(md) {
|
@include mq(md) {
|
||||||
position: relative;
|
position: relative;
|
||||||
max-width: $content-width;
|
max-width: $content-width;
|
||||||
padding-top: $gutter-spacing;
|
margin-left: $nav-width-md;
|
||||||
padding-bottom: $gutter-spacing;
|
|
||||||
padding-left: $gutter-spacing * 1.5;
|
|
||||||
margin-left: $nav-width;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
@include mq(lg) {
|
@include mq(lg) {
|
||||||
padding-left: $gutter-spacing;
|
margin-left: calc(
|
||||||
margin-left: calc((100% - #{$nav-width + $content-width}) / 2 + #{$nav-width});
|
(100% - #{$nav-width + $content-width}) / 2 + #{$nav-width}
|
||||||
|
);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
.js-main-content:focus {
|
.main-content-wrap {
|
||||||
outline: none;
|
@include container;
|
||||||
|
|
||||||
|
padding-top: $gutter-spacing-sm;
|
||||||
|
padding-bottom: $gutter-spacing-sm;
|
||||||
|
|
||||||
|
@include mq(md) {
|
||||||
|
padding-top: $gutter-spacing;
|
||||||
|
padding-bottom: $gutter-spacing;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
.page-header {
|
.main-header {
|
||||||
|
z-index: 0;
|
||||||
|
display: none;
|
||||||
background-color: $sidebar-color;
|
background-color: $sidebar-color;
|
||||||
|
|
||||||
@include mq(md) {
|
@include mq(md) {
|
||||||
|
display: flex;
|
||||||
|
justify-content: space-between;
|
||||||
|
height: $header-height;
|
||||||
background-color: $body-background-color;
|
background-color: $body-background-color;
|
||||||
|
border-bottom: $border $border-color;
|
||||||
}
|
}
|
||||||
|
|
||||||
.main-content {
|
&.nav-open {
|
||||||
padding-top: 0;
|
display: block;
|
||||||
|
|
||||||
@include mq(md) {
|
@include mq(md) {
|
||||||
display: flex;
|
display: flex;
|
||||||
justify-content: flex-end;
|
|
||||||
height: 60px;
|
|
||||||
padding-top: $sp-4;
|
|
||||||
padding-bottom: $sp-4;
|
|
||||||
border-bottom: $border $border-color;
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
.navigation,
|
.site-nav,
|
||||||
.site-title,
|
.site-header,
|
||||||
.site-footer {
|
.site-footer {
|
||||||
|
|
||||||
@include container;
|
|
||||||
|
|
||||||
width: 100%;
|
width: 100%;
|
||||||
|
|
||||||
@include mq(lg) {
|
@include mq(lg) {
|
||||||
width: $nav-width + 32px;
|
width: $nav-width;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
.navigation {
|
.site-nav {
|
||||||
|
display: none;
|
||||||
|
|
||||||
|
&.nav-open {
|
||||||
|
display: block;
|
||||||
|
}
|
||||||
|
|
||||||
@include mq(md) {
|
@include mq(md) {
|
||||||
|
display: block;
|
||||||
padding-top: $sp-8;
|
padding-top: $sp-8;
|
||||||
|
padding-bottom: $gutter-spacing-sm;
|
||||||
overflow-y: auto;
|
overflow-y: auto;
|
||||||
flex: 1 1 auto;
|
flex: 1 1 auto;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.site-header {
|
||||||
|
display: flex;
|
||||||
|
min-height: $header-height;
|
||||||
|
align-items: center;
|
||||||
|
|
||||||
|
@include mq(md) {
|
||||||
|
height: $header-height;
|
||||||
|
max-height: $header-height;
|
||||||
|
border-bottom: $border $border-color;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
.site-title {
|
||||||
|
@include container;
|
||||||
|
|
||||||
|
flex-grow: 1;
|
||||||
|
display: flex;
|
||||||
|
height: 100%;
|
||||||
|
align-items: center;
|
||||||
|
padding-top: $sp-3;
|
||||||
|
padding-bottom: $sp-3;
|
||||||
|
color: $body-heading-color;
|
||||||
|
@include fs-6;
|
||||||
|
|
||||||
|
@include mq(md) {
|
||||||
|
padding-top: $sp-2;
|
||||||
|
padding-bottom: $sp-2;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@if variable-exists(logo) {
|
||||||
|
.site-logo {
|
||||||
|
width: 100%;
|
||||||
|
height: 100%;
|
||||||
|
background-image: url($logo);
|
||||||
|
background-repeat: no-repeat;
|
||||||
|
background-position: left center;
|
||||||
|
background-size: contain;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
.site-button {
|
||||||
|
display: flex;
|
||||||
|
height: 100%;
|
||||||
|
padding: $gutter-spacing-sm;
|
||||||
|
align-items: center;
|
||||||
|
}
|
||||||
|
|
||||||
|
@include mq(md) {
|
||||||
|
.site-header .site-button {
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
.site-title:hover {
|
||||||
|
background-image: linear-gradient(
|
||||||
|
-90deg,
|
||||||
|
rgba($feedback-color, 1) 0%,
|
||||||
|
rgba($feedback-color, 0.8) 80%,
|
||||||
|
rgba($feedback-color, 0) 100%
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
.site-button:hover {
|
||||||
|
background-image: linear-gradient(
|
||||||
|
-90deg,
|
||||||
|
rgba($feedback-color, 1) 0%,
|
||||||
|
rgba($feedback-color, 0.8) 100%
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
// stylelint-disable selector-max-type
|
// stylelint-disable selector-max-type
|
||||||
|
|
||||||
body {
|
body {
|
||||||
position: relative;
|
position: relative;
|
||||||
padding-bottom: $sp-10;
|
padding-bottom: $sp-10;
|
||||||
|
overflow-y: scroll;
|
||||||
|
|
||||||
@include mq(md) {
|
@include mq(md) {
|
||||||
position: static;
|
position: static;
|
||||||
@@ -135,15 +182,24 @@ body {
|
|||||||
// stylelint-enable selector-max-type
|
// stylelint-enable selector-max-type
|
||||||
|
|
||||||
.site-footer {
|
.site-footer {
|
||||||
|
@include container;
|
||||||
|
|
||||||
position: absolute;
|
position: absolute;
|
||||||
bottom: 0;
|
bottom: 0;
|
||||||
|
left: 0;
|
||||||
padding-top: $sp-4;
|
padding-top: $sp-4;
|
||||||
padding-bottom: $sp-4;
|
padding-bottom: $sp-4;
|
||||||
|
color: $grey-dk-000;
|
||||||
|
@include fs-2;
|
||||||
|
|
||||||
@include mq(md) {
|
@include mq(md) {
|
||||||
position: static;
|
position: static;
|
||||||
align-self: flex-end;
|
|
||||||
justify-self: end;
|
justify-self: end;
|
||||||
background-color: $sidebar-color;
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.icon {
|
||||||
|
width: $sp-5;
|
||||||
|
height: $sp-5;
|
||||||
|
color: $link-color;
|
||||||
|
}
|
||||||
|
17
_sass/modules.scss
Normal file
17
_sass/modules.scss
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
// Import external dependencies
|
||||||
|
@import "./vendor/normalize.scss/normalize";
|
||||||
|
|
||||||
|
// Modules
|
||||||
|
@import "./base";
|
||||||
|
@import "./layout";
|
||||||
|
@import "./content";
|
||||||
|
@import "./navigation";
|
||||||
|
@import "./typography";
|
||||||
|
@import "./labels";
|
||||||
|
@import "./buttons";
|
||||||
|
@import "./search";
|
||||||
|
@import "./tables";
|
||||||
|
@import "./code";
|
||||||
|
@import "./utilities/utilities";
|
||||||
|
@import "./print";
|
||||||
|
@import "./skiptomain";
|
@@ -1,117 +1,204 @@
|
|||||||
//
|
|
||||||
// Main nav, breadcrumb, etc...
|
// Main nav, breadcrumb, etc...
|
||||||
//
|
// stylelint-disable selector-no-type, max-nesting-depth, selector-max-compound-selectors, selector-max-type, selector-max-specificity
|
||||||
|
|
||||||
.site-title {
|
.nav-list {
|
||||||
display: block;
|
|
||||||
flex: 1 1 auto;
|
|
||||||
color: $body-heading-color;
|
|
||||||
background-color: $sidebar-color;
|
|
||||||
|
|
||||||
@include mq(md) {
|
|
||||||
position: absolute;
|
|
||||||
top: 0;
|
|
||||||
right: 0;
|
|
||||||
z-index: 101;
|
|
||||||
height: 60px;
|
|
||||||
padding-top: $sp-4;
|
|
||||||
border-bottom: $border $border-color;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
.navigation-list {
|
|
||||||
padding: 0;
|
padding: 0;
|
||||||
margin-top: $sp-4;
|
margin-top: 0;
|
||||||
margin-bottom: 0;
|
margin-bottom: 0;
|
||||||
list-style: none;
|
list-style: none;
|
||||||
|
|
||||||
@include mq(md) {
|
.nav-list-item {
|
||||||
margin-top: 0;
|
@include fs-4;
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
.navigation-list-child-list {
|
|
||||||
padding-left: $sp-3;
|
|
||||||
list-style: none;
|
|
||||||
|
|
||||||
.navigation-list-link {
|
|
||||||
color: $nav-child-link-color;
|
|
||||||
}
|
|
||||||
|
|
||||||
.navigation-list-item {
|
|
||||||
position: relative;
|
position: relative;
|
||||||
|
margin: 0;
|
||||||
|
|
||||||
&::before {
|
@include mq(md) {
|
||||||
|
@include fs-3;
|
||||||
|
}
|
||||||
|
|
||||||
|
.nav-list-link {
|
||||||
|
display: block;
|
||||||
|
min-height: $nav-list-item-height-sm;
|
||||||
|
padding-top: $sp-1;
|
||||||
|
padding-bottom: $sp-1;
|
||||||
|
line-height: #{$nav-list-item-height-sm - 2 * $sp-1};
|
||||||
|
@if $nav-list-expander-right {
|
||||||
|
padding-right: $nav-list-item-height-sm;
|
||||||
|
padding-left: $gutter-spacing-sm;
|
||||||
|
} @else {
|
||||||
|
padding-right: $gutter-spacing-sm;
|
||||||
|
padding-left: $nav-list-item-height-sm;
|
||||||
|
}
|
||||||
|
|
||||||
|
@include mq(md) {
|
||||||
|
min-height: $nav-list-item-height;
|
||||||
|
line-height: #{$nav-list-item-height - 2 * $sp-1};
|
||||||
|
@if $nav-list-expander-right {
|
||||||
|
padding-right: $nav-list-item-height;
|
||||||
|
padding-left: $gutter-spacing;
|
||||||
|
} @else {
|
||||||
|
padding-right: $gutter-spacing;
|
||||||
|
padding-left: $nav-list-item-height;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
&.external > svg {
|
||||||
|
width: $sp-4;
|
||||||
|
height: $sp-4;
|
||||||
|
vertical-align: text-bottom;
|
||||||
|
}
|
||||||
|
|
||||||
|
&.active {
|
||||||
|
font-weight: 600;
|
||||||
|
text-decoration: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
&:hover,
|
||||||
|
&.active {
|
||||||
|
background-image: linear-gradient(
|
||||||
|
-90deg,
|
||||||
|
rgba($feedback-color, 1) 0%,
|
||||||
|
rgba($feedback-color, 0.8) 80%,
|
||||||
|
rgba($feedback-color, 0) 100%
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
.nav-list-expander {
|
||||||
position: absolute;
|
position: absolute;
|
||||||
margin-top: 0.3em;
|
@if $nav-list-expander-right {
|
||||||
margin-left: -0.8em;
|
right: 0;
|
||||||
color: rgba($body-text-color, 0.3);
|
}
|
||||||
content: "- ";
|
|
||||||
|
width: $nav-list-item-height-sm;
|
||||||
|
height: $nav-list-item-height-sm;
|
||||||
|
padding: #{$nav-list-item-height-sm * 0.25};
|
||||||
|
color: $link-color;
|
||||||
|
|
||||||
|
@include mq(md) {
|
||||||
|
width: $nav-list-item-height;
|
||||||
|
height: $nav-list-item-height;
|
||||||
|
padding: #{$nav-list-item-height * 0.25};
|
||||||
|
}
|
||||||
|
|
||||||
|
&:hover {
|
||||||
|
background-image: linear-gradient(
|
||||||
|
-90deg,
|
||||||
|
rgba($feedback-color, 1) 0%,
|
||||||
|
rgba($feedback-color, 0.8) 100%
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
@if $nav-list-expander-right {
|
||||||
|
svg {
|
||||||
|
transform: rotate(90deg);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
> .nav-list {
|
||||||
|
display: none;
|
||||||
|
padding-left: $sp-3;
|
||||||
|
list-style: none;
|
||||||
|
|
||||||
|
.nav-list-item {
|
||||||
|
position: relative;
|
||||||
|
|
||||||
|
.nav-list-link {
|
||||||
|
color: $nav-child-link-color;
|
||||||
|
}
|
||||||
|
|
||||||
|
.nav-list-expander {
|
||||||
|
color: $nav-child-link-color;
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
&.active {
|
&.active {
|
||||||
&::before {
|
> .nav-list-expander svg {
|
||||||
color: $body-text-color;
|
@if $nav-list-expander-right {
|
||||||
|
transform: rotate(-90deg);
|
||||||
|
} @else {
|
||||||
|
transform: rotate(90deg);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
> .nav-list {
|
||||||
|
display: block;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
.navigation-list-item {
|
.nav-category {
|
||||||
@include fs-4;
|
padding: $sp-2 $gutter-spacing-sm;
|
||||||
margin: 0;
|
font-weight: 600;
|
||||||
|
text-align: start;
|
||||||
|
text-transform: uppercase;
|
||||||
|
border-bottom: $border $border-color;
|
||||||
|
@include fs-2;
|
||||||
|
|
||||||
@include mq(md) {
|
@include mq(md) {
|
||||||
@include fs-3;
|
padding: $sp-2 $gutter-spacing;
|
||||||
}
|
margin-top: $gutter-spacing-sm;
|
||||||
|
text-align: start;
|
||||||
|
|
||||||
.navigation-list-child-list {
|
&:first-child {
|
||||||
display: none;
|
margin-top: 0;
|
||||||
}
|
|
||||||
|
|
||||||
&.active {
|
|
||||||
.navigation-list-child-list {
|
|
||||||
display: block;
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
.navigation-list-link {
|
.nav-list.nav-category-list {
|
||||||
display: block;
|
> .nav-list-item {
|
||||||
padding-top: $sp-1;
|
margin: 0;
|
||||||
padding-bottom: $sp-1;
|
|
||||||
|
|
||||||
&.active {
|
> .nav-list {
|
||||||
font-weight: 600;
|
padding: 0;
|
||||||
color: $body-heading-color;
|
|
||||||
text-decoration: none;
|
> .nav-list-item {
|
||||||
|
> .nav-list-link {
|
||||||
|
color: $link-color;
|
||||||
|
}
|
||||||
|
|
||||||
|
> .nav-list-expander {
|
||||||
|
color: $link-color;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// Small screen nav
|
// Aux nav
|
||||||
|
|
||||||
.main-nav,
|
|
||||||
.aux-nav {
|
.aux-nav {
|
||||||
display: none;
|
height: 100%;
|
||||||
|
overflow-x: auto;
|
||||||
|
@include fs-2;
|
||||||
|
|
||||||
&.nav-open {
|
.aux-nav-list {
|
||||||
display: block;
|
display: flex;
|
||||||
|
height: 100%;
|
||||||
|
padding: 0;
|
||||||
|
margin: 0;
|
||||||
|
list-style: none;
|
||||||
}
|
}
|
||||||
@include mq(md) {
|
|
||||||
display: block;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
.navigation-list-toggle {
|
.aux-nav-list-item {
|
||||||
position: absolute;
|
display: inline-block;
|
||||||
right: $sp-4;
|
height: 100%;
|
||||||
|
padding: 0;
|
||||||
|
margin: 0;
|
||||||
|
}
|
||||||
|
|
||||||
@include mq(md) {
|
@include mq(md) {
|
||||||
display: none !important;
|
padding-right: $gutter-spacing-sm;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// Breadcrumb nav
|
// Breadcrumb nav
|
||||||
|
|
||||||
.breadcrumb-nav {
|
.breadcrumb-nav {
|
||||||
@include mq(md) {
|
@include mq(md) {
|
||||||
margin-top: -$sp-4;
|
margin-top: -$sp-4;
|
||||||
|
40
_sass/print.scss
Normal file
40
_sass/print.scss
Normal file
@@ -0,0 +1,40 @@
|
|||||||
|
// stylelint-disable selector-max-specificity, selector-max-id, selector-max-type, selector-no-qualifying-type
|
||||||
|
|
||||||
|
@media print {
|
||||||
|
.site-footer,
|
||||||
|
.site-button,
|
||||||
|
#edit-this-page,
|
||||||
|
#back-to-top,
|
||||||
|
.site-nav,
|
||||||
|
.main-header {
|
||||||
|
display: none !important;
|
||||||
|
}
|
||||||
|
|
||||||
|
.side-bar {
|
||||||
|
width: 100%;
|
||||||
|
height: auto;
|
||||||
|
border-right: 0 !important;
|
||||||
|
}
|
||||||
|
|
||||||
|
.site-header {
|
||||||
|
border-bottom: 1px solid $border-color;
|
||||||
|
}
|
||||||
|
|
||||||
|
.site-title {
|
||||||
|
font-size: $root-font-size !important;
|
||||||
|
font-weight: 700 !important;
|
||||||
|
}
|
||||||
|
|
||||||
|
.text-small {
|
||||||
|
font-size: 8pt !important;
|
||||||
|
}
|
||||||
|
|
||||||
|
pre.highlight {
|
||||||
|
border: 1px solid $border-color;
|
||||||
|
}
|
||||||
|
|
||||||
|
.main {
|
||||||
|
max-width: none;
|
||||||
|
margin-left: 0;
|
||||||
|
}
|
||||||
|
}
|
@@ -1,98 +1,119 @@
|
|||||||
//
|
|
||||||
// Search input and autocomplete
|
// Search input and autocomplete
|
||||||
//
|
|
||||||
|
|
||||||
.search {
|
.search {
|
||||||
position: relative;
|
position: relative;
|
||||||
z-index: 99;
|
z-index: 2;
|
||||||
display: none;
|
|
||||||
flex-grow: 1;
|
flex-grow: 1;
|
||||||
|
height: $sp-10;
|
||||||
padding: $sp-2;
|
padding: $sp-2;
|
||||||
margin-bottom: $sp-3;
|
transition: padding linear #{$transition-duration * 0.5};
|
||||||
background-color: $white;
|
|
||||||
border-radius: 3px;
|
|
||||||
box-shadow: 0 1px 2px rgba(0, 0, 0, 0.07), 0 3px 10px rgba(0, 0, 0, 0.05);
|
|
||||||
|
|
||||||
@include mq(md) {
|
@include mq(md) {
|
||||||
display: block;
|
position: relative !important;
|
||||||
padding-top: $sp-1;
|
width: auto !important;
|
||||||
padding-right: 0;
|
height: 100% !important;
|
||||||
padding-bottom: 0;
|
padding: 0;
|
||||||
padding-left: 0;
|
transition: none;
|
||||||
margin-bottom: 0;
|
|
||||||
background-color: transparent;
|
|
||||||
box-shadow: none;
|
|
||||||
}
|
|
||||||
|
|
||||||
&.nav-open {
|
|
||||||
display: block;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
.search-results-wrap {
|
|
||||||
display: none;
|
|
||||||
|
|
||||||
&.active {
|
|
||||||
position: absolute;
|
|
||||||
top: $sp-1;
|
|
||||||
z-index: 100;
|
|
||||||
display: block;
|
|
||||||
width: 300px;
|
|
||||||
margin-top: $gutter-spacing;
|
|
||||||
background: lighten($body-background-color, 1%);
|
|
||||||
box-shadow: 0 1px 3px rgba(0, 0, 0, 0.07), 0 4px 14px rgba(0, 0, 0, 0.05);
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
.search-input-wrap {
|
.search-input-wrap {
|
||||||
display: flex;
|
position: relative;
|
||||||
background-color: $body-background-color;
|
z-index: 1;
|
||||||
|
height: $sp-8;
|
||||||
|
overflow: hidden;
|
||||||
|
border-radius: $border-radius;
|
||||||
|
box-shadow: 0 1px 2px rgba(0, 0, 0, 0.12), 0 3px 10px rgba(0, 0, 0, 0.08);
|
||||||
|
transition: height linear #{$transition-duration * 0.5};
|
||||||
|
|
||||||
|
@include mq(md) {
|
||||||
|
position: absolute;
|
||||||
|
width: 100%;
|
||||||
|
max-width: $search-results-width;
|
||||||
|
height: 100% !important;
|
||||||
|
border-radius: 0;
|
||||||
|
box-shadow: none;
|
||||||
|
transition: width ease $transition-duration;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
.search-input {
|
.search-input {
|
||||||
|
position: absolute;
|
||||||
width: 100%;
|
width: 100%;
|
||||||
padding-top: $sp-1;
|
height: 100%;
|
||||||
padding-bottom: $sp-1;
|
padding: $sp-2 $gutter-spacing-sm $sp-2 #{$gutter-spacing-sm + $sp-5};
|
||||||
background-color: $body-background-color;
|
font-size: 16px;
|
||||||
|
color: $body-text-color;
|
||||||
|
background-color: $search-background-color;
|
||||||
border-top: 0;
|
border-top: 0;
|
||||||
border-right: 0;
|
border-right: 0;
|
||||||
border-bottom: 0;
|
border-bottom: 0;
|
||||||
border-left: 0;
|
border-left: 0;
|
||||||
order: 2;
|
border-radius: 0;
|
||||||
|
|
||||||
|
@include mq(md) {
|
||||||
|
padding: $sp-2 $gutter-spacing-sm $sp-2 #{$gutter-spacing + $sp-5};
|
||||||
|
font-size: 14px;
|
||||||
|
background-color: $body-background-color;
|
||||||
|
transition: padding-left linear #{$transition-duration * 0.5};
|
||||||
|
}
|
||||||
|
|
||||||
&:focus {
|
&:focus {
|
||||||
outline: 0;
|
outline: 0;
|
||||||
box-shadow: none;
|
|
||||||
|
|
||||||
+ .search-icon {
|
+ .search-label .search-icon {
|
||||||
fill: $link-color;
|
color: $link-color;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@include fs-5;
|
|
||||||
|
|
||||||
@include mq(sm) {
|
|
||||||
@include fs-3;
|
|
||||||
}
|
|
||||||
|
|
||||||
@include mq(md) {
|
|
||||||
@include fs-2;
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
.search-icon {
|
.search-label {
|
||||||
align-self: center;
|
position: absolute;
|
||||||
margin-right: $sp-2;
|
display: flex;
|
||||||
fill: $grey-dk-000;
|
height: 100%;
|
||||||
order: 1;
|
padding-left: $gutter-spacing-sm;
|
||||||
|
|
||||||
|
@include mq(md) {
|
||||||
|
padding-left: $gutter-spacing;
|
||||||
|
transition: padding-left linear #{$transition-duration * 0.5};
|
||||||
|
}
|
||||||
|
|
||||||
|
.search-icon {
|
||||||
|
width: #{$sp-4 * 1.2};
|
||||||
|
height: #{$sp-4 * 1.2};
|
||||||
|
align-self: center;
|
||||||
|
color: $grey-dk-000;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
.search-results {
|
||||||
|
position: absolute;
|
||||||
|
left: 0;
|
||||||
|
display: none;
|
||||||
|
width: 100%;
|
||||||
|
max-height: calc(100% - #{$sp-10});
|
||||||
|
overflow-y: auto;
|
||||||
|
background-color: $search-background-color;
|
||||||
|
border-bottom-right-radius: $border-radius;
|
||||||
|
border-bottom-left-radius: $border-radius;
|
||||||
|
box-shadow: 0 1px 2px rgba(0, 0, 0, 0.12), 0 3px 10px rgba(0, 0, 0, 0.08);
|
||||||
|
|
||||||
|
@include mq(md) {
|
||||||
|
top: 100%;
|
||||||
|
width: $search-results-width;
|
||||||
|
max-height: calc(100vh - 200%) !important;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
.search-results-list {
|
.search-results-list {
|
||||||
padding-left: 0;
|
padding-left: 0;
|
||||||
margin-top: $sp-1;
|
|
||||||
margin-bottom: $sp-1;
|
margin-bottom: $sp-1;
|
||||||
list-style: none;
|
list-style: none;
|
||||||
@include fs-3;
|
@include fs-4;
|
||||||
|
|
||||||
|
@include mq(md) {
|
||||||
|
@include fs-3;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
.search-results-list-item {
|
.search-results-list-item {
|
||||||
@@ -100,15 +121,191 @@
|
|||||||
margin: 0;
|
margin: 0;
|
||||||
}
|
}
|
||||||
|
|
||||||
.search-results-link {
|
.search-result {
|
||||||
display: block;
|
display: block;
|
||||||
padding-top: $sp-1;
|
padding: $sp-1 $sp-3;
|
||||||
padding-right: $sp-3;
|
|
||||||
padding-bottom: $sp-1;
|
|
||||||
padding-left: $sp-3;
|
|
||||||
|
|
||||||
&:hover {
|
&:hover,
|
||||||
color: $body-heading-color;
|
&.active {
|
||||||
background-color: darken($body-background-color, 2%);
|
background-color: $feedback-color;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
.search-result-title {
|
||||||
|
display: block;
|
||||||
|
padding-top: $sp-2;
|
||||||
|
padding-bottom: $sp-2;
|
||||||
|
|
||||||
|
@include mq(sm) {
|
||||||
|
display: inline-block;
|
||||||
|
width: 40%;
|
||||||
|
padding-right: $sp-2;
|
||||||
|
vertical-align: top;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
.search-result-doc {
|
||||||
|
display: flex;
|
||||||
|
align-items: center;
|
||||||
|
word-wrap: break-word;
|
||||||
|
|
||||||
|
&.search-result-doc-parent {
|
||||||
|
opacity: 0.5;
|
||||||
|
@include fs-3;
|
||||||
|
|
||||||
|
@include mq(md) {
|
||||||
|
@include fs-2;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
.search-result-icon {
|
||||||
|
width: $sp-4;
|
||||||
|
height: $sp-4;
|
||||||
|
margin-right: $sp-2;
|
||||||
|
color: $link-color;
|
||||||
|
flex-shrink: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
.search-result-doc-title {
|
||||||
|
overflow: auto;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
.search-result-section {
|
||||||
|
margin-left: #{$sp-4 + $sp-2};
|
||||||
|
word-wrap: break-word;
|
||||||
|
}
|
||||||
|
|
||||||
|
.search-result-rel-url {
|
||||||
|
display: block;
|
||||||
|
margin-left: #{$sp-4 + $sp-2};
|
||||||
|
overflow: hidden;
|
||||||
|
color: $search-result-preview-color;
|
||||||
|
text-overflow: ellipsis;
|
||||||
|
white-space: nowrap;
|
||||||
|
@include fs-1;
|
||||||
|
}
|
||||||
|
|
||||||
|
.search-result-previews {
|
||||||
|
display: block;
|
||||||
|
padding-top: $sp-2;
|
||||||
|
padding-bottom: $sp-2;
|
||||||
|
padding-left: $sp-4;
|
||||||
|
margin-left: $sp-2;
|
||||||
|
color: $search-result-preview-color;
|
||||||
|
word-wrap: break-word;
|
||||||
|
border-left: $border;
|
||||||
|
border-left-color: $border-color;
|
||||||
|
@include fs-2;
|
||||||
|
|
||||||
|
@include mq(sm) {
|
||||||
|
display: inline-block;
|
||||||
|
width: 60%;
|
||||||
|
padding-left: $sp-2;
|
||||||
|
margin-left: 0;
|
||||||
|
vertical-align: top;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
.search-result-preview + .search-result-preview {
|
||||||
|
margin-top: $sp-1;
|
||||||
|
}
|
||||||
|
|
||||||
|
.search-result-highlight {
|
||||||
|
font-weight: bold;
|
||||||
|
}
|
||||||
|
|
||||||
|
.search-no-result {
|
||||||
|
padding: $sp-2 $sp-3;
|
||||||
|
@include fs-3;
|
||||||
|
}
|
||||||
|
|
||||||
|
.search-button {
|
||||||
|
position: fixed;
|
||||||
|
right: $sp-4;
|
||||||
|
bottom: $sp-4;
|
||||||
|
display: flex;
|
||||||
|
width: $sp-9;
|
||||||
|
height: $sp-9;
|
||||||
|
background-color: $search-background-color;
|
||||||
|
border: 1px solid rgba($link-color, 0.3);
|
||||||
|
border-radius: #{$sp-9 * 0.5};
|
||||||
|
box-shadow: 0 1px 2px rgba(0, 0, 0, 0.12), 0 3px 10px rgba(0, 0, 0, 0.08);
|
||||||
|
align-items: center;
|
||||||
|
justify-content: center;
|
||||||
|
}
|
||||||
|
|
||||||
|
.search-overlay {
|
||||||
|
position: fixed;
|
||||||
|
top: 0;
|
||||||
|
left: 0;
|
||||||
|
z-index: 1;
|
||||||
|
width: 0;
|
||||||
|
height: 0;
|
||||||
|
background-color: rgba(0, 0, 0, 0.3);
|
||||||
|
opacity: 0;
|
||||||
|
transition: opacity ease $transition-duration, width 0s $transition-duration,
|
||||||
|
height 0s $transition-duration;
|
||||||
|
}
|
||||||
|
|
||||||
|
.search-active {
|
||||||
|
.search {
|
||||||
|
position: fixed;
|
||||||
|
top: 0;
|
||||||
|
left: 0;
|
||||||
|
width: 100%;
|
||||||
|
height: 100%;
|
||||||
|
padding: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
.search-input-wrap {
|
||||||
|
height: $sp-10;
|
||||||
|
border-radius: 0;
|
||||||
|
|
||||||
|
@include mq(md) {
|
||||||
|
width: $search-results-width;
|
||||||
|
box-shadow: 0 1px 2px rgba(0, 0, 0, 0.12), 0 3px 10px rgba(0, 0, 0, 0.08);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
.search-input {
|
||||||
|
background-color: $search-background-color;
|
||||||
|
|
||||||
|
@include mq(md) {
|
||||||
|
padding-left: 2.3rem;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
.search-label {
|
||||||
|
@include mq(md) {
|
||||||
|
padding-left: 0.6rem;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
.search-results {
|
||||||
|
display: block;
|
||||||
|
}
|
||||||
|
|
||||||
|
.search-overlay {
|
||||||
|
width: 100%;
|
||||||
|
height: 100%;
|
||||||
|
opacity: 1;
|
||||||
|
transition: opacity ease $transition-duration, width 0s, height 0s;
|
||||||
|
}
|
||||||
|
|
||||||
|
@include mq(md) {
|
||||||
|
.main {
|
||||||
|
position: fixed;
|
||||||
|
right: 0;
|
||||||
|
left: 0;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
.main-header {
|
||||||
|
padding-top: $sp-10;
|
||||||
|
|
||||||
|
@include mq(md) {
|
||||||
|
padding-top: 0;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
30
_sass/skiptomain.scss
Normal file
30
_sass/skiptomain.scss
Normal file
@@ -0,0 +1,30 @@
|
|||||||
|
// Skipnav
|
||||||
|
// Skip to main content
|
||||||
|
|
||||||
|
a.skip-to-main {
|
||||||
|
left: -999px;
|
||||||
|
position: absolute;
|
||||||
|
top: auto;
|
||||||
|
width: 1px;
|
||||||
|
height: 1px;
|
||||||
|
overflow: hidden;
|
||||||
|
z-index: -999;
|
||||||
|
}
|
||||||
|
|
||||||
|
a.skip-to-main:focus,
|
||||||
|
a.skip-to-main:active {
|
||||||
|
color: $link-color;
|
||||||
|
background-color: $body-background-color;
|
||||||
|
left: auto;
|
||||||
|
top: auto;
|
||||||
|
width: 30%;
|
||||||
|
height: auto;
|
||||||
|
overflow: auto;
|
||||||
|
margin: 10px 35%;
|
||||||
|
padding: 5px;
|
||||||
|
border-radius: 15px;
|
||||||
|
border: 4px solid $btn-primary-color;
|
||||||
|
text-align: center;
|
||||||
|
font-size: 1.2em;
|
||||||
|
z-index: 999;
|
||||||
|
}
|
@@ -1,10 +1,9 @@
|
|||||||
@function rem($size, $unit:"") {
|
@function rem($size, $unit: "") {
|
||||||
$remSize: $size / $root-font-size;
|
$rem-size: $size / $root-font-size;
|
||||||
|
|
||||||
@if ($unit == false) {
|
@if $unit == false {
|
||||||
@return #{$remSize};
|
@return #{$rem-size};
|
||||||
}
|
} @else {
|
||||||
@else {
|
@return #{$rem-size}rem;
|
||||||
@return #{$remSize}rem;
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@@ -1,81 +1,76 @@
|
|||||||
//
|
|
||||||
// Typography
|
// Typography
|
||||||
//
|
|
||||||
|
|
||||||
$body-font-family: -apple-system, BlinkMacSystemFont, "helvetica neue", helvetica, roboto, noto, "segoe ui", arial, sans-serif !default;
|
$body-font-family: system-ui, -apple-system, blinkmacsystemfont, "Segoe UI",
|
||||||
$mono-font-family: "SFMono-Regular", Menlo, Consolas, Monospace !default;
|
roboto, "Helvetica Neue", arial, sans-serif !default;
|
||||||
$root-font-size: 16px !default; // Base font-size for rems
|
$mono-font-family: "SFMono-Regular", menlo, consolas, monospace !default;
|
||||||
|
$root-font-size: 16px !default; // Base font-size for rems
|
||||||
$body-line-height: 1.4 !default;
|
$body-line-height: 1.4 !default;
|
||||||
$body-heading-line-height: 1.15 !default !default;
|
$content-line-height: 1.6 !default;
|
||||||
|
$body-heading-line-height: 1.25 !default;
|
||||||
|
|
||||||
|
// Font size
|
||||||
|
// `-sm` suffix is the size at the small (and above) media query
|
||||||
|
|
||||||
|
$font-size-1: 9px !default;
|
||||||
|
$font-size-1-sm: 10px !default;
|
||||||
|
$font-size-2: 11px !default; // h4 - uppercased!, h6 not uppercased, text-small
|
||||||
|
$font-size-3: 12px !default; // h5
|
||||||
|
$font-size-4: 14px !default;
|
||||||
|
$font-size-5: 16px !default; // h3
|
||||||
|
$font-size-6: 18px !default; // h2
|
||||||
|
$font-size-7: 24px !default;
|
||||||
|
$font-size-8: 32px !default; // h1
|
||||||
|
$font-size-9: 36px !default;
|
||||||
|
$font-size-10: 42px !default;
|
||||||
|
$font-size-10-sm: 48px !default;
|
||||||
|
|
||||||
//
|
|
||||||
// Colors
|
// Colors
|
||||||
//
|
|
||||||
|
|
||||||
$white: #fff !default;
|
$white: #fff !default;
|
||||||
|
|
||||||
$grey-dk-000: #959396 !default;
|
$grey-dk-000: #959396 !default;
|
||||||
$grey-dk-100: #5c5962 !default;
|
$grey-dk-100: #5c5962 !default;
|
||||||
$grey-dk-200: #44434d !default;
|
$grey-dk-200: #44434d !default;
|
||||||
$grey-dk-250: #302d36 !default;
|
$grey-dk-250: #302d36 !default;
|
||||||
$grey-dk-300: #27262b !default;
|
$grey-dk-300: #27262b !default;
|
||||||
|
|
||||||
$grey-lt-000: #f5f6fa !default;
|
$grey-lt-000: #f5f6fa !default;
|
||||||
$grey-lt-100: #eeebee !default;
|
$grey-lt-100: #eeebee !default;
|
||||||
$grey-lt-200: #ecebed !default;
|
$grey-lt-200: #ecebed !default;
|
||||||
$grey-lt-300: #e6e1e8 !default;
|
$grey-lt-300: #e6e1e8 !default;
|
||||||
|
|
||||||
$purple-000: #7253ed !default;
|
$purple-000: #7253ed !default;
|
||||||
$purple-100: #5e41d0 !default;
|
$purple-100: #5e41d0 !default;
|
||||||
$purple-200: #4e26af !default;
|
$purple-200: #4e26af !default;
|
||||||
$purple-300: #381885 !default;
|
$purple-300: #381885 !default;
|
||||||
|
|
||||||
$blue-000: #2c84fa !default;
|
$blue-000: #2c84fa !default;
|
||||||
$blue-100: #2869e6 !default;
|
$blue-100: #2869e6 !default;
|
||||||
$blue-200: #264caf !default;
|
$blue-200: #264caf !default;
|
||||||
$blue-300: #183385 !default;
|
$blue-300: #183385 !default;
|
||||||
|
|
||||||
$green-000: #41d693 !default;
|
$green-000: #41d693 !default;
|
||||||
$green-100: #11b584 !default;
|
$green-100: #11b584 !default;
|
||||||
$green-200: #009c7b !default;
|
$green-200: #009c7b !default;
|
||||||
$green-300: #026e57 !default;
|
$green-300: #026e57 !default;
|
||||||
|
|
||||||
$yellow-000: #ffeb82 !default;
|
$yellow-000: #ffeb82 !default;
|
||||||
$yellow-100: #fadf50 !default;
|
$yellow-100: #fadf50 !default;
|
||||||
$yellow-200: #f7d12e !default;
|
$yellow-200: #f7d12e !default;
|
||||||
$yellow-300: #e7af06 !default;
|
$yellow-300: #e7af06 !default;
|
||||||
|
|
||||||
$red-000: #f77e7e !default;
|
$red-000: #f77e7e !default;
|
||||||
$red-100: #f96e65 !default;
|
$red-100: #f96e65 !default;
|
||||||
$red-200: #e94c4c !default;
|
$red-200: #e94c4c !default;
|
||||||
$red-300: #dd2e2e !default;
|
$red-300: #dd2e2e !default;
|
||||||
|
|
||||||
$body-background-color: $white !default;
|
$body-background-color: $white !default;
|
||||||
$sidebar-color: $grey-lt-000 !default;
|
$sidebar-color: $grey-lt-000 !default;
|
||||||
|
$search-background-color: $white !default;
|
||||||
|
$table-background-color: $white !default;
|
||||||
$code-background-color: $grey-lt-000 !default;
|
$code-background-color: $grey-lt-000 !default;
|
||||||
|
$feedback-color: darken($sidebar-color, 3%) !default;
|
||||||
$body-text-color: $grey-dk-100 !default;
|
$body-text-color: $grey-dk-100 !default;
|
||||||
$body-heading-color: $grey-dk-300 !default;
|
$body-heading-color: $grey-dk-300 !default;
|
||||||
|
$search-result-preview-color: $grey-dk-000 !default;
|
||||||
$nav-child-link-color: $grey-dk-100 !default;
|
$nav-child-link-color: $grey-dk-100 !default;
|
||||||
$link-color: $purple-000 !default;
|
$link-color: $purple-000 !default;
|
||||||
$btn-primary-color: $purple-100 !default;
|
$btn-primary-color: $purple-100 !default;
|
||||||
$base-button-color: #f7f7f7 !default;
|
$base-button-color: #f7f7f7 !default;
|
||||||
|
|
||||||
//
|
|
||||||
// Media queries in pixels
|
|
||||||
//
|
|
||||||
|
|
||||||
$media-queries: (
|
|
||||||
xs: 320px,
|
|
||||||
sm: 500px,
|
|
||||||
md: 740px,
|
|
||||||
lg: 1120px,
|
|
||||||
xl: 1400px
|
|
||||||
) !default;
|
|
||||||
|
|
||||||
//
|
|
||||||
// Spacing
|
// Spacing
|
||||||
//
|
|
||||||
|
|
||||||
$spacing-unit: 1rem; // 1rem == 16px
|
$spacing-unit: 1rem; // 1rem == 16px
|
||||||
|
|
||||||
@@ -90,9 +85,8 @@ $spacers: (
|
|||||||
sp-7: $spacing-unit * 2.5,
|
sp-7: $spacing-unit * 2.5,
|
||||||
sp-8: $spacing-unit * 3,
|
sp-8: $spacing-unit * 3,
|
||||||
sp-9: $spacing-unit * 3.5,
|
sp-9: $spacing-unit * 3.5,
|
||||||
sp-10: $spacing-unit * 4
|
sp-10: $spacing-unit * 4,
|
||||||
) !default;
|
) !default;
|
||||||
|
|
||||||
$sp-1: map-get($spacers, sp-1) !default; // 0.25 rem == 4px
|
$sp-1: map-get($spacers, sp-1) !default; // 0.25 rem == 4px
|
||||||
$sp-2: map-get($spacers, sp-2) !default; // 0.5 rem == 8px
|
$sp-2: map-get($spacers, sp-2) !default; // 0.5 rem == 8px
|
||||||
$sp-3: map-get($spacers, sp-3) !default; // 0.75 rem == 12px
|
$sp-3: map-get($spacers, sp-3) !default; // 0.75 rem == 12px
|
||||||
@@ -101,30 +95,35 @@ $sp-5: map-get($spacers, sp-5) !default; // 1.5 rem == 24px
|
|||||||
$sp-6: map-get($spacers, sp-6) !default; // 2 rem == 32px
|
$sp-6: map-get($spacers, sp-6) !default; // 2 rem == 32px
|
||||||
$sp-7: map-get($spacers, sp-7) !default; // 2.5 rem == 40px
|
$sp-7: map-get($spacers, sp-7) !default; // 2.5 rem == 40px
|
||||||
$sp-8: map-get($spacers, sp-8) !default; // 3 rem == 48px
|
$sp-8: map-get($spacers, sp-8) !default; // 3 rem == 48px
|
||||||
$sp-9: map-get($spacers, sp-9) !default; // 4 rem == 48px
|
$sp-9: map-get($spacers, sp-9) !default; // 3.5 rem == 56px
|
||||||
$sp-10: map-get($spacers, sp-10) !default; // 4.5 rem == 48px
|
$sp-10: map-get($spacers, sp-10) !default; // 4 rem == 64px
|
||||||
|
|
||||||
//
|
|
||||||
// Borders
|
// Borders
|
||||||
//
|
|
||||||
|
|
||||||
$border: 1px solid !default;
|
$border: 1px solid !default;
|
||||||
$border-radius: 4px !default;
|
$border-radius: 4px !default;
|
||||||
$border-color: $grey-lt-100 !default;
|
$border-color: $grey-lt-100 !default;
|
||||||
|
|
||||||
//
|
|
||||||
// Grid system
|
// Grid system
|
||||||
//
|
|
||||||
|
|
||||||
$gutter-spacing: $sp-6 !default;
|
$gutter-spacing: $sp-6 !default;
|
||||||
$gutter-spacing-sm: $sp-4 !default;
|
$gutter-spacing-sm: $sp-4 !default;
|
||||||
$nav-width: 232px !default;
|
$nav-width: 264px !default;
|
||||||
|
$nav-width-md: 248px !default;
|
||||||
|
$nav-list-item-height: $sp-6 !default;
|
||||||
|
$nav-list-item-height-sm: $sp-8 !default;
|
||||||
|
$nav-list-expander-right: true;
|
||||||
$content-width: 800px !default;
|
$content-width: 800px !default;
|
||||||
|
$header-height: 60px !default;
|
||||||
|
$search-results-width: $content-width - $nav-width !default;
|
||||||
|
$transition-duration: 400ms;
|
||||||
|
|
||||||
|
// Media queries in pixels
|
||||||
|
|
||||||
$media-queries: (
|
$media-queries: (
|
||||||
xs: 320px,
|
xs: 320px,
|
||||||
sm: 500px,
|
sm: 500px,
|
||||||
md: 740px,
|
md: $content-width,
|
||||||
lg: 800px,
|
lg: $content-width + $nav-width,
|
||||||
xl: 1316px
|
xl: 1400px,
|
||||||
) !default;
|
) !default;
|
||||||
|
@@ -10,14 +10,12 @@
|
|||||||
$value: map-get($media-queries, $name);
|
$value: map-get($media-queries, $name);
|
||||||
|
|
||||||
// If the key exists in the map
|
// If the key exists in the map
|
||||||
@if $value != null {
|
@if $value {
|
||||||
// Prints a media query based on the value
|
// Prints a media query based on the value
|
||||||
@media (min-width: rem($value)) {
|
@media (min-width: rem($value)) {
|
||||||
@content;
|
@content;
|
||||||
}
|
}
|
||||||
}
|
} @else {
|
||||||
|
|
||||||
@else {
|
|
||||||
@warn "No value could be retrieved from `#{$media-query}`. "
|
@warn "No value could be retrieved from `#{$media-query}`. "
|
||||||
+ "Please make sure it is defined in `$media-queries` map.";
|
+ "Please make sure it is defined in `$media-queries` map.";
|
||||||
}
|
}
|
||||||
|
@@ -1,81 +1,84 @@
|
|||||||
// Font size
|
|
||||||
|
|
||||||
@mixin fs-1 {
|
@mixin fs-1 {
|
||||||
font-size: 9px !important;
|
font-size: $font-size-1 !important;
|
||||||
|
|
||||||
@include mq(sm) {
|
@include mq(sm) {
|
||||||
font-size: 10px !important;
|
font-size: $font-size-1-sm !important;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@mixin fs-2 {
|
@mixin fs-2 {
|
||||||
font-size: 11px !important;
|
font-size: $font-size-2 !important;
|
||||||
|
|
||||||
@include mq(sm) {
|
@include mq(sm) {
|
||||||
font-size: 12px !important;
|
font-size: $font-size-3 !important;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@mixin fs-3 {
|
@mixin fs-3 {
|
||||||
font-size: 12px !important;
|
font-size: $font-size-3 !important;
|
||||||
|
|
||||||
@include mq(sm) {
|
@include mq(sm) {
|
||||||
font-size: 14px !important;
|
font-size: $font-size-4 !important;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@mixin fs-4 {
|
@mixin fs-4 {
|
||||||
font-size: 14px !important;
|
font-size: $font-size-4 !important;
|
||||||
|
|
||||||
@include mq(sm) {
|
@include mq(sm) {
|
||||||
font-size: 16px !important;
|
font-size: $font-size-5 !important;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@mixin fs-5 {
|
@mixin fs-5 {
|
||||||
font-size: 16px !important;
|
font-size: $font-size-5 !important;
|
||||||
|
|
||||||
@include mq(sm) {
|
@include mq(sm) {
|
||||||
font-size: 18px !important;
|
font-size: $font-size-6 !important;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@mixin fs-6 {
|
@mixin fs-6 {
|
||||||
font-size: 18px !important;
|
font-size: $font-size-6 !important;
|
||||||
|
|
||||||
@include mq(sm) {
|
@include mq(sm) {
|
||||||
font-size: 24px !important;
|
font-size: $font-size-7 !important;
|
||||||
|
line-height: $body-heading-line-height;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@mixin fs-7 {
|
@mixin fs-7 {
|
||||||
font-size: 24px !important;
|
font-size: $font-size-7 !important;
|
||||||
|
line-height: $body-heading-line-height;
|
||||||
|
|
||||||
@include mq(sm) {
|
@include mq(sm) {
|
||||||
font-size: 32px !important;
|
font-size: $font-size-8 !important;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@mixin fs-8 {
|
@mixin fs-8 {
|
||||||
font-size: 32px !important;
|
font-size: $font-size-8 !important;
|
||||||
|
line-height: $body-heading-line-height;
|
||||||
|
|
||||||
@include mq(sm) {
|
@include mq(sm) {
|
||||||
font-size: 36px !important;
|
font-size: $font-size-9 !important;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@mixin fs-9 {
|
@mixin fs-9 {
|
||||||
font-size: 36px !important;
|
font-size: $font-size-9 !important;
|
||||||
|
line-height: $body-heading-line-height;
|
||||||
|
|
||||||
@include mq(sm) {
|
@include mq(sm) {
|
||||||
font-size: 42px !important;
|
font-size: $font-size-10 !important;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@mixin fs-10 {
|
@mixin fs-10 {
|
||||||
font-size: 42px !important;
|
font-size: $font-size-10 !important;
|
||||||
|
line-height: $body-heading-line-height;
|
||||||
|
|
||||||
@include mq(sm) {
|
@include mq(sm) {
|
||||||
font-size: 48px !important;
|
font-size: $font-size-10-sm !important;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@@ -1,31 +1,29 @@
|
|||||||
//
|
|
||||||
// Tables
|
// Tables
|
||||||
//
|
|
||||||
// stylelint-disable max-nesting-depth, selector-no-type, selector-max-type
|
// stylelint-disable max-nesting-depth, selector-no-type, selector-max-type
|
||||||
|
|
||||||
table {
|
.table-wrapper {
|
||||||
display: block;
|
display: block;
|
||||||
width: 100%;
|
width: 100%;
|
||||||
max-width: 100%;
|
max-width: 100%;
|
||||||
margin-bottom: $sp-5;
|
margin-bottom: $sp-5;
|
||||||
overflow-x: auto;
|
overflow-x: auto;
|
||||||
border-collapse: separate;
|
border-radius: $border-radius;
|
||||||
box-shadow: 0 1px 3px rgba(0, 0, 0, 0.07), 0 4px 14px rgba(0, 0, 0, 0.05);
|
box-shadow: 0 1px 2px rgba(0, 0, 0, 0.12), 0 3px 10px rgba(0, 0, 0, 0.08);
|
||||||
|
}
|
||||||
|
|
||||||
@include mq(sm) {
|
table {
|
||||||
display: table;
|
display: table;
|
||||||
}
|
min-width: 100%;
|
||||||
|
border-collapse: separate;
|
||||||
}
|
}
|
||||||
|
|
||||||
th,
|
th,
|
||||||
td {
|
td {
|
||||||
@include fs-3;
|
@include fs-3;
|
||||||
|
|
||||||
min-width: 120px;
|
min-width: 120px;
|
||||||
padding-top: $sp-2;
|
padding: $sp-2 $sp-3;
|
||||||
padding-right: $sp-3;
|
background-color: $table-background-color;
|
||||||
padding-bottom: $sp-2;
|
|
||||||
padding-left: $sp-3;
|
|
||||||
background-color: lighten($body-background-color, 2%);
|
|
||||||
border-bottom: $border rgba($border-color, 0.5);
|
border-bottom: $border rgba($border-color, 0.5);
|
||||||
border-left: $border $border-color;
|
border-left: $border $border-color;
|
||||||
|
|
||||||
@@ -34,38 +32,16 @@ td {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
thead,
|
|
||||||
tbody:first-child {
|
|
||||||
tr {
|
|
||||||
&:first-of-type {
|
|
||||||
th,
|
|
||||||
td {
|
|
||||||
&:first-of-type {
|
|
||||||
border-top-left-radius: $border-radius;
|
|
||||||
}
|
|
||||||
|
|
||||||
&:last-of-type {
|
|
||||||
border-top-right-radius: $border-radius;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
tbody {
|
tbody {
|
||||||
tr {
|
tr {
|
||||||
&:last-of-type {
|
&:last-of-type {
|
||||||
th,
|
th,
|
||||||
td {
|
td {
|
||||||
border-bottom: 0;
|
border-bottom: 0;
|
||||||
|
}
|
||||||
|
|
||||||
&:first-of-type {
|
td {
|
||||||
border-bottom-left-radius: $border-radius;
|
padding-bottom: $sp-3;
|
||||||
}
|
|
||||||
|
|
||||||
&:last-of-type {
|
|
||||||
border-bottom-right-radius: $border-radius;
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -73,6 +49,6 @@ tbody {
|
|||||||
|
|
||||||
thead {
|
thead {
|
||||||
th {
|
th {
|
||||||
border-bottom: 1px solid $border-color;
|
border-bottom: $border $border-color;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@@ -1,16 +1,16 @@
|
|||||||
//
|
|
||||||
// Typography
|
// Typography
|
||||||
//
|
// stylelint-disable selector-no-type, selector-max-type, selector-max-specificity, selector-max-id
|
||||||
// stylelint-disable primer/selector-no-utility, selector-no-type, selector-max-type
|
|
||||||
|
|
||||||
h1,
|
h1,
|
||||||
.text-alpha {
|
.text-alpha {
|
||||||
@include fs-8;
|
@include fs-8;
|
||||||
|
|
||||||
font-weight: 300;
|
font-weight: 300;
|
||||||
}
|
}
|
||||||
|
|
||||||
h2,
|
h2,
|
||||||
.text-beta {
|
.text-beta,
|
||||||
|
#toctitle {
|
||||||
@include fs-6;
|
@include fs-6;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -22,27 +22,24 @@ h3,
|
|||||||
h4,
|
h4,
|
||||||
.text-delta {
|
.text-delta {
|
||||||
@include fs-2;
|
@include fs-2;
|
||||||
font-weight: 300;
|
|
||||||
|
font-weight: 400;
|
||||||
text-transform: uppercase;
|
text-transform: uppercase;
|
||||||
letter-spacing: 0.1em;
|
letter-spacing: 0.1em;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
h4 code {
|
||||||
|
text-transform: none;
|
||||||
|
}
|
||||||
|
|
||||||
h5,
|
h5,
|
||||||
.text-epsilon {
|
.text-epsilon {
|
||||||
@include fs-3;
|
@include fs-3;
|
||||||
color: $grey-dk-200;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
h6,
|
h6,
|
||||||
.text-zeta {
|
.text-zeta {
|
||||||
@include fs-2;
|
@include fs-2;
|
||||||
color: $grey-dk-200;
|
|
||||||
}
|
|
||||||
|
|
||||||
li {
|
|
||||||
.highlight {
|
|
||||||
margin-top: $sp-2;
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
.text-small {
|
.text-small {
|
||||||
@@ -53,6 +50,14 @@ li {
|
|||||||
font-family: $mono-font-family !important;
|
font-family: $mono-font-family !important;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.text-left {
|
||||||
|
text-align: left !important;
|
||||||
|
}
|
||||||
|
|
||||||
.text-center {
|
.text-center {
|
||||||
text-align: center !important;
|
text-align: center !important;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.text-right {
|
||||||
|
text-align: right !important;
|
||||||
|
}
|
||||||
|
@@ -1,6 +1,4 @@
|
|||||||
//
|
|
||||||
// Utility classes for colors
|
// Utility classes for colors
|
||||||
//
|
|
||||||
|
|
||||||
// Text colors
|
// Text colors
|
||||||
|
|
||||||
|
@@ -1,15 +1,26 @@
|
|||||||
// stylelint-disable primer/selector-no-utility
|
|
||||||
//
|
|
||||||
// Utility classes for layout
|
// Utility classes for layout
|
||||||
//
|
|
||||||
|
|
||||||
// Display
|
// Display
|
||||||
|
|
||||||
.d-block { display: block !important; }
|
.d-block {
|
||||||
.d-flex { display: flex !important; }
|
display: block !important;
|
||||||
.d-inline { display: inline !important; }
|
}
|
||||||
.d-inline-block { display: inline-block !important; }
|
|
||||||
.d-none { display: none !important; }
|
.d-flex {
|
||||||
|
display: flex !important;
|
||||||
|
}
|
||||||
|
|
||||||
|
.d-inline {
|
||||||
|
display: inline !important;
|
||||||
|
}
|
||||||
|
|
||||||
|
.d-inline-block {
|
||||||
|
display: inline-block !important;
|
||||||
|
}
|
||||||
|
|
||||||
|
.d-none {
|
||||||
|
display: none !important;
|
||||||
|
}
|
||||||
|
|
||||||
@each $media-query in map-keys($media-queries) {
|
@each $media-query in map-keys($media-queries) {
|
||||||
@for $i from 1 through length($spacers) {
|
@for $i from 1 through length($spacers) {
|
||||||
@@ -18,21 +29,73 @@
|
|||||||
$scale: #{$i - 1};
|
$scale: #{$i - 1};
|
||||||
|
|
||||||
// .d-sm-block, .d-md-none, .d-lg-inline
|
// .d-sm-block, .d-md-none, .d-lg-inline
|
||||||
.d-#{$media-query}-block { display: block !important; }
|
.d-#{$media-query}-block {
|
||||||
.d-#{$media-query}-flex { display: flex !important; }
|
display: block !important;
|
||||||
.d-#{$media-query}-inline { display: inline !important; }
|
}
|
||||||
.d-#{$media-query}-inline-block { display: inline-block !important; }
|
.d-#{$media-query}-flex {
|
||||||
.d-#{$media-query}-none { display: none !important; }
|
display: flex !important;
|
||||||
|
}
|
||||||
|
.d-#{$media-query}-inline {
|
||||||
|
display: inline !important;
|
||||||
|
}
|
||||||
|
.d-#{$media-query}-inline-block {
|
||||||
|
display: inline-block !important;
|
||||||
|
}
|
||||||
|
.d-#{$media-query}-none {
|
||||||
|
display: none !important;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Horizontal alignment
|
||||||
|
|
||||||
|
.float-left {
|
||||||
|
float: left !important;
|
||||||
|
}
|
||||||
|
|
||||||
|
.float-right {
|
||||||
|
float: right !important;
|
||||||
|
}
|
||||||
|
|
||||||
|
.flex-justify-start {
|
||||||
|
justify-content: flex-start !important;
|
||||||
|
}
|
||||||
|
|
||||||
|
.flex-justify-end {
|
||||||
|
justify-content: flex-end !important;
|
||||||
|
}
|
||||||
|
|
||||||
|
.flex-justify-between {
|
||||||
|
justify-content: space-between !important;
|
||||||
|
}
|
||||||
|
|
||||||
|
.flex-justify-around {
|
||||||
|
justify-content: space-around !important;
|
||||||
|
}
|
||||||
|
|
||||||
// Vertical alignment
|
// Vertical alignment
|
||||||
|
|
||||||
.v-align-baseline { vertical-align: baseline !important; }
|
.v-align-baseline {
|
||||||
.v-align-bottom { vertical-align: bottom !important; }
|
vertical-align: baseline !important;
|
||||||
.v-align-middle { vertical-align: middle !important; }
|
}
|
||||||
.v-align-text-bottom { vertical-align: text-bottom !important; }
|
|
||||||
.v-align-text-top { vertical-align: text-top !important; }
|
.v-align-bottom {
|
||||||
.v-align-top { vertical-align: top !important; }
|
vertical-align: bottom !important;
|
||||||
|
}
|
||||||
|
|
||||||
|
.v-align-middle {
|
||||||
|
vertical-align: middle !important;
|
||||||
|
}
|
||||||
|
|
||||||
|
.v-align-text-bottom {
|
||||||
|
vertical-align: text-bottom !important;
|
||||||
|
}
|
||||||
|
|
||||||
|
.v-align-text-top {
|
||||||
|
vertical-align: text-top !important;
|
||||||
|
}
|
||||||
|
|
||||||
|
.v-align-top {
|
||||||
|
vertical-align: top !important;
|
||||||
|
}
|
||||||
|
@@ -1,11 +1,15 @@
|
|||||||
//
|
|
||||||
// Utility classes for lists
|
// Utility classes for lists
|
||||||
//
|
|
||||||
|
|
||||||
// stylelint-disable primer/selector-no-utility
|
// stylelint-disable selector-max-type
|
||||||
|
|
||||||
.list-style-none {
|
.list-style-none {
|
||||||
padding: 0 !important;
|
padding: 0 !important;
|
||||||
margin: 0 !important;
|
margin: 0 !important;
|
||||||
list-style: none !important;
|
list-style: none !important;
|
||||||
|
|
||||||
|
li {
|
||||||
|
&::before {
|
||||||
|
display: none !important;
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
@@ -1,22 +1,34 @@
|
|||||||
//
|
|
||||||
// Utility classes for margins and padding
|
// Utility classes for margins and padding
|
||||||
//
|
|
||||||
|
|
||||||
// scss-lint:disable SpaceAfterPropertyName
|
// stylelint-disable block-opening-brace-space-after, block-opening-brace-space-before
|
||||||
// stylelint-disable block-opening-brace-space-after, block-opening-brace-space-before, primer/selector-no-utility
|
|
||||||
|
|
||||||
// Margin spacer utilities
|
// Margin spacer utilities
|
||||||
|
|
||||||
|
.mx-auto {
|
||||||
|
margin-right: auto !important;
|
||||||
|
margin-left: auto !important;
|
||||||
|
}
|
||||||
|
|
||||||
@for $i from 1 through length($spacers) {
|
@for $i from 1 through length($spacers) {
|
||||||
$size: #{map-get($spacers, sp-#{$i - 1})};
|
$size: #{map-get($spacers, sp-#{$i - 1})};
|
||||||
$scale: #{$i - 1};
|
$scale: #{$i - 1};
|
||||||
|
|
||||||
// .m-0, .m-1, .m-2...
|
// .m-0, .m-1, .m-2...
|
||||||
.m-#{$scale} { margin: #{$size} !important; }
|
.m-#{$scale} {
|
||||||
.mt-#{$scale} { margin-top: #{$size} !important; }
|
margin: #{$size} !important;
|
||||||
.mr-#{$scale} { margin-right: #{$size} !important; }
|
}
|
||||||
.mb-#{$scale} { margin-bottom: #{$size} !important; }
|
.mt-#{$scale} {
|
||||||
.ml-#{$scale} { margin-left: #{$size} !important; }
|
margin-top: #{$size} !important;
|
||||||
|
}
|
||||||
|
.mr-#{$scale} {
|
||||||
|
margin-right: #{$size} !important;
|
||||||
|
}
|
||||||
|
.mb-#{$scale} {
|
||||||
|
margin-bottom: #{$size} !important;
|
||||||
|
}
|
||||||
|
.ml-#{$scale} {
|
||||||
|
margin-left: #{$size} !important;
|
||||||
|
}
|
||||||
|
|
||||||
.mx-#{$scale} {
|
.mx-#{$scale} {
|
||||||
margin-right: #{$size} !important;
|
margin-right: #{$size} !important;
|
||||||
@@ -32,11 +44,10 @@
|
|||||||
margin-right: -#{$size} !important;
|
margin-right: -#{$size} !important;
|
||||||
margin-left: -#{$size} !important;
|
margin-left: -#{$size} !important;
|
||||||
}
|
}
|
||||||
}
|
.mx-#{$scale}-auto {
|
||||||
|
margin-right: auto !important;
|
||||||
.mx-auto {
|
margin-left: auto !important;
|
||||||
margin-right: auto !important;
|
}
|
||||||
margin-left: auto !important;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
@each $media-query in map-keys($media-queries) {
|
@each $media-query in map-keys($media-queries) {
|
||||||
@@ -46,11 +57,21 @@
|
|||||||
$scale: #{$i - 1};
|
$scale: #{$i - 1};
|
||||||
|
|
||||||
// .m-sm-0, .m-md-1, .m-lg-2...
|
// .m-sm-0, .m-md-1, .m-lg-2...
|
||||||
.m-#{$media-query}-#{$scale} { margin: #{$size} !important; }
|
.m-#{$media-query}-#{$scale} {
|
||||||
.mt-#{$media-query}-#{$scale} { margin-top: #{$size} !important; }
|
margin: #{$size} !important;
|
||||||
.mr-#{$media-query}-#{$scale} { margin-right: #{$size} !important; }
|
}
|
||||||
.mb-#{$media-query}-#{$scale} { margin-bottom: #{$size} !important; }
|
.mt-#{$media-query}-#{$scale} {
|
||||||
.ml-#{$media-query}-#{$scale} { margin-left: #{$size} !important; }
|
margin-top: #{$size} !important;
|
||||||
|
}
|
||||||
|
.mr-#{$media-query}-#{$scale} {
|
||||||
|
margin-right: #{$size} !important;
|
||||||
|
}
|
||||||
|
.mb-#{$media-query}-#{$scale} {
|
||||||
|
margin-bottom: #{$size} !important;
|
||||||
|
}
|
||||||
|
.ml-#{$media-query}-#{$scale} {
|
||||||
|
margin-left: #{$size} !important;
|
||||||
|
}
|
||||||
|
|
||||||
.mx-#{$media-query}-#{$scale} {
|
.mx-#{$media-query}-#{$scale} {
|
||||||
margin-right: #{$size} !important;
|
margin-right: #{$size} !important;
|
||||||
@@ -77,11 +98,21 @@
|
|||||||
$scale: #{$i - 1};
|
$scale: #{$i - 1};
|
||||||
|
|
||||||
// .p-0, .p-1, .p-2...
|
// .p-0, .p-1, .p-2...
|
||||||
.p-#{$scale} { padding: #{$size} !important; }
|
.p-#{$scale} {
|
||||||
.pt-#{$scale} { padding-top: #{$size} !important; }
|
padding: #{$size} !important;
|
||||||
.pr-#{$scale} { padding-right: #{$size} !important; }
|
}
|
||||||
.pb-#{$scale} { padding-bottom: #{$size} !important; }
|
.pt-#{$scale} {
|
||||||
.pl-#{$scale} { padding-left: #{$size} !important; }
|
padding-top: #{$size} !important;
|
||||||
|
}
|
||||||
|
.pr-#{$scale} {
|
||||||
|
padding-right: #{$size} !important;
|
||||||
|
}
|
||||||
|
.pb-#{$scale} {
|
||||||
|
padding-bottom: #{$size} !important;
|
||||||
|
}
|
||||||
|
.pl-#{$scale} {
|
||||||
|
padding-left: #{$size} !important;
|
||||||
|
}
|
||||||
|
|
||||||
.px-#{$scale} {
|
.px-#{$scale} {
|
||||||
padding-right: #{$size} !important;
|
padding-right: #{$size} !important;
|
||||||
@@ -101,11 +132,21 @@
|
|||||||
$scale: #{$i - 1};
|
$scale: #{$i - 1};
|
||||||
|
|
||||||
// .p-sm-0, .p-md-1, .p-lg-2...
|
// .p-sm-0, .p-md-1, .p-lg-2...
|
||||||
.p-#{$media-query}-#{$scale} { padding: #{$size} !important; }
|
.p-#{$media-query}-#{$scale} {
|
||||||
.pt-#{$media-query}-#{$scale} { padding-top: #{$size} !important; }
|
padding: #{$size} !important;
|
||||||
.pr-#{$media-query}-#{$scale} { padding-right: #{$size} !important; }
|
}
|
||||||
.pb-#{$media-query}-#{$scale} { padding-bottom: #{$size} !important; }
|
.pt-#{$media-query}-#{$scale} {
|
||||||
.pl-#{$media-query}-#{$scale} { padding-left: #{$size} !important; }
|
padding-top: #{$size} !important;
|
||||||
|
}
|
||||||
|
.pr-#{$media-query}-#{$scale} {
|
||||||
|
padding-right: #{$size} !important;
|
||||||
|
}
|
||||||
|
.pb-#{$media-query}-#{$scale} {
|
||||||
|
padding-bottom: #{$size} !important;
|
||||||
|
}
|
||||||
|
.pl-#{$media-query}-#{$scale} {
|
||||||
|
padding-left: #{$size} !important;
|
||||||
|
}
|
||||||
|
|
||||||
.px-#{$media-query}-#{$scale} {
|
.px-#{$media-query}-#{$scale} {
|
||||||
padding-right: #{$size} !important;
|
padding-right: #{$size} !important;
|
||||||
|
@@ -1,8 +1,4 @@
|
|||||||
//
|
|
||||||
// Utility classes for typography
|
// Utility classes for typography
|
||||||
//
|
|
||||||
|
|
||||||
// stylelint-disable primer/selector-no-utility
|
|
||||||
|
|
||||||
.fs-1 {
|
.fs-1 {
|
||||||
@include fs-1;
|
@include fs-1;
|
||||||
@@ -87,5 +83,3 @@
|
|||||||
.text-uppercase {
|
.text-uppercase {
|
||||||
text-transform: uppercase !important;
|
text-transform: uppercase !important;
|
||||||
}
|
}
|
||||||
|
|
||||||
// stylelint-enable primer/selector-no-utility
|
|
||||||
|
21
_sass/vendor/OneDarkJekyll/LICENSE
vendored
Normal file
21
_sass/vendor/OneDarkJekyll/LICENSE
vendored
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
MIT License
|
||||||
|
|
||||||
|
Copyright (c) 2016 Mihály Gyöngyösi
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
in the Software without restriction, including without limitation the rights
|
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is
|
||||||
|
furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
|
SOFTWARE.
|
25
_sass/vendor/OneDarkJekyll/README.md
vendored
Normal file
25
_sass/vendor/OneDarkJekyll/README.md
vendored
Normal file
@@ -0,0 +1,25 @@
|
|||||||
|
# OneDarkJekyll
|
||||||
|
|
||||||
|
*Use Atom's One Dark syntax colors in your Jekyll powered blog!*
|
||||||
|
|
||||||
|
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.).
|
||||||
|
|
||||||
|
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)
|
||||||
|
|
||||||
|
## Create a new syntax stylesheet
|
||||||
|
|
||||||
|
1. `npm install -g less less-plugin-clean-css`
|
||||||
|
2. Clone this repository
|
||||||
|
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)
|
||||||
|
4. Put the previously downloaded file next to `syntax.less`
|
||||||
|
5. Run `lessc syntax.less syntax.css --clean-css`
|
||||||
|
6. Use the `syntax.css`
|
||||||
|
|
||||||
|
It's not final and in case you find any error/improvement feel free to create a PR. :)
|
||||||
|
|
||||||
|
----
|
||||||
|
|
||||||
|
# UPDATES FOR USE IN JUST-THE-DOCS:
|
||||||
|
|
||||||
|
1. Layout added in `*.css`
|
||||||
|
2. Renamed `*.css` to `*.scss`
|
30
_sass/vendor/OneDarkJekyll/colors.less
vendored
Normal file
30
_sass/vendor/OneDarkJekyll/colors.less
vendored
Normal file
@@ -0,0 +1,30 @@
|
|||||||
|
// Config -----------------------------------
|
||||||
|
@syntax-hue: 220;
|
||||||
|
@syntax-saturation: 13%;
|
||||||
|
@syntax-brightness: 18%;
|
||||||
|
|
||||||
|
|
||||||
|
// Monochrome -----------------------------------
|
||||||
|
@mono-1: hsl(@syntax-hue, 14%, 71%); // default text
|
||||||
|
@mono-2: hsl(@syntax-hue, 9%, 55%);
|
||||||
|
@mono-3: hsl(@syntax-hue, 10%, 40%);
|
||||||
|
|
||||||
|
// Colors -----------------------------------
|
||||||
|
@hue-1: hsl(187, 47%, 55%); // <-cyan
|
||||||
|
@hue-2: hsl(207, 82%, 66%); // <-blue
|
||||||
|
@hue-3: hsl(286, 60%, 67%); // <-purple
|
||||||
|
@hue-4: hsl( 95, 38%, 62%); // <-green
|
||||||
|
|
||||||
|
@hue-5: hsl(355, 65%, 65%); // <-red 1
|
||||||
|
@hue-5-2: hsl( 5, 48%, 51%); // <-red 2
|
||||||
|
|
||||||
|
@hue-6: hsl( 29, 54%, 61%); // <-orange 1
|
||||||
|
@hue-6-2: hsl( 39, 67%, 69%); // <-orange 2
|
||||||
|
|
||||||
|
|
||||||
|
// Base colors -----------------------------------
|
||||||
|
@syntax-fg: @mono-1;
|
||||||
|
@syntax-bg: hsl(@syntax-hue, @syntax-saturation, @syntax-brightness);
|
||||||
|
@syntax-gutter: darken(@syntax-fg, 26%);
|
||||||
|
@syntax-guide: fade(@syntax-fg, 15%);
|
||||||
|
@syntax-accent: hsl(@syntax-hue, 100%, 66% );
|
200
_sass/vendor/OneDarkJekyll/syntax-firewatch-green.scss
vendored
Normal file
200
_sass/vendor/OneDarkJekyll/syntax-firewatch-green.scss
vendored
Normal file
@@ -0,0 +1,200 @@
|
|||||||
|
.highlight,
|
||||||
|
pre.highlight {
|
||||||
|
background: #282c34;
|
||||||
|
color: #abb2bf;
|
||||||
|
}
|
||||||
|
.highlight pre {
|
||||||
|
background: #282c34;
|
||||||
|
}
|
||||||
|
.highlight .hll {
|
||||||
|
background: #282c34;
|
||||||
|
}
|
||||||
|
.highlight .c {
|
||||||
|
color: #5c6370;
|
||||||
|
font-style: italic;
|
||||||
|
}
|
||||||
|
.highlight .err {
|
||||||
|
color: #960050;
|
||||||
|
background-color: #1e0010;
|
||||||
|
}
|
||||||
|
.highlight .k {
|
||||||
|
color: #5ba473;
|
||||||
|
}
|
||||||
|
.highlight .l {
|
||||||
|
color: #c8ae9d;
|
||||||
|
}
|
||||||
|
.highlight .n {
|
||||||
|
color: #abb2bf;
|
||||||
|
}
|
||||||
|
.highlight .o {
|
||||||
|
color: #abb2bf;
|
||||||
|
}
|
||||||
|
.highlight .p {
|
||||||
|
color: #abb2bf;
|
||||||
|
}
|
||||||
|
.highlight .cm {
|
||||||
|
color: #5c6370;
|
||||||
|
font-style: italic;
|
||||||
|
}
|
||||||
|
.highlight .cp {
|
||||||
|
color: #5c6370;
|
||||||
|
font-style: italic;
|
||||||
|
}
|
||||||
|
.highlight .c1 {
|
||||||
|
color: #5c6370;
|
||||||
|
font-style: italic;
|
||||||
|
}
|
||||||
|
.highlight .cs {
|
||||||
|
color: #5c6370;
|
||||||
|
font-style: italic;
|
||||||
|
}
|
||||||
|
.highlight .ge {
|
||||||
|
font-style: italic;
|
||||||
|
}
|
||||||
|
.highlight .gs {
|
||||||
|
font-weight: 700;
|
||||||
|
}
|
||||||
|
.highlight .kc {
|
||||||
|
color: #5ba473;
|
||||||
|
}
|
||||||
|
.highlight .kd {
|
||||||
|
color: #5ba473;
|
||||||
|
}
|
||||||
|
.highlight .kn {
|
||||||
|
color: #5ba473;
|
||||||
|
}
|
||||||
|
.highlight .kp {
|
||||||
|
color: #5ba473;
|
||||||
|
}
|
||||||
|
.highlight .kr {
|
||||||
|
color: #5ba473;
|
||||||
|
}
|
||||||
|
.highlight .kt {
|
||||||
|
color: #5ba473;
|
||||||
|
}
|
||||||
|
.highlight .ld {
|
||||||
|
color: #c8ae9d;
|
||||||
|
}
|
||||||
|
.highlight .m {
|
||||||
|
color: #d19a66;
|
||||||
|
}
|
||||||
|
.highlight .s {
|
||||||
|
color: #c8ae9d;
|
||||||
|
}
|
||||||
|
.highlight .na {
|
||||||
|
color: #d19a66;
|
||||||
|
}
|
||||||
|
.highlight .nb {
|
||||||
|
color: #e5c07b;
|
||||||
|
}
|
||||||
|
.highlight .nc {
|
||||||
|
color: #e5c07b;
|
||||||
|
}
|
||||||
|
.highlight .no {
|
||||||
|
color: #e5c07b;
|
||||||
|
}
|
||||||
|
.highlight .nd {
|
||||||
|
color: #e5c07b;
|
||||||
|
}
|
||||||
|
.highlight .ni {
|
||||||
|
color: #e5c07b;
|
||||||
|
}
|
||||||
|
.highlight .ne {
|
||||||
|
color: #e5c07b;
|
||||||
|
}
|
||||||
|
.highlight .nf {
|
||||||
|
color: #abb2bf;
|
||||||
|
}
|
||||||
|
.highlight .nl {
|
||||||
|
color: #e5c07b;
|
||||||
|
}
|
||||||
|
.highlight .nn {
|
||||||
|
color: #abb2bf;
|
||||||
|
}
|
||||||
|
.highlight .nx {
|
||||||
|
color: #abb2bf;
|
||||||
|
}
|
||||||
|
.highlight .py {
|
||||||
|
color: #e5c07b;
|
||||||
|
}
|
||||||
|
.highlight .nt {
|
||||||
|
color: #77b181;
|
||||||
|
}
|
||||||
|
.highlight .nv {
|
||||||
|
color: #e5c07b;
|
||||||
|
}
|
||||||
|
.highlight .ow {
|
||||||
|
font-weight: 700;
|
||||||
|
}
|
||||||
|
.highlight .w {
|
||||||
|
color: #f8f8f2;
|
||||||
|
}
|
||||||
|
.highlight .mf {
|
||||||
|
color: #d19a66;
|
||||||
|
}
|
||||||
|
.highlight .mh {
|
||||||
|
color: #d19a66;
|
||||||
|
}
|
||||||
|
.highlight .mi {
|
||||||
|
color: #d19a66;
|
||||||
|
}
|
||||||
|
.highlight .mo {
|
||||||
|
color: #d19a66;
|
||||||
|
}
|
||||||
|
.highlight .sb {
|
||||||
|
color: #c8ae9d;
|
||||||
|
}
|
||||||
|
.highlight .sc {
|
||||||
|
color: #c8ae9d;
|
||||||
|
}
|
||||||
|
.highlight .sd {
|
||||||
|
color: #c8ae9d;
|
||||||
|
}
|
||||||
|
.highlight .s2 {
|
||||||
|
color: #c8ae9d;
|
||||||
|
}
|
||||||
|
.highlight .se {
|
||||||
|
color: #c8ae9d;
|
||||||
|
}
|
||||||
|
.highlight .sh {
|
||||||
|
color: #c8ae9d;
|
||||||
|
}
|
||||||
|
.highlight .si {
|
||||||
|
color: #c8ae9d;
|
||||||
|
}
|
||||||
|
.highlight .sx {
|
||||||
|
color: #c8ae9d;
|
||||||
|
}
|
||||||
|
.highlight .sr {
|
||||||
|
color: #56b6c2;
|
||||||
|
}
|
||||||
|
.highlight .s1 {
|
||||||
|
color: #c8ae9d;
|
||||||
|
}
|
||||||
|
.highlight .ss {
|
||||||
|
color: #56b6c2;
|
||||||
|
}
|
||||||
|
.highlight .bp {
|
||||||
|
color: #e5c07b;
|
||||||
|
}
|
||||||
|
.highlight .vc {
|
||||||
|
color: #e5c07b;
|
||||||
|
}
|
||||||
|
.highlight .vg {
|
||||||
|
color: #e5c07b;
|
||||||
|
}
|
||||||
|
.highlight .vi {
|
||||||
|
color: #77b181;
|
||||||
|
}
|
||||||
|
.highlight .il {
|
||||||
|
color: #d19a66;
|
||||||
|
}
|
||||||
|
.highlight .gu {
|
||||||
|
color: #75715e;
|
||||||
|
}
|
||||||
|
.highlight .gd {
|
||||||
|
color: #f92672;
|
||||||
|
}
|
||||||
|
.highlight .gi {
|
||||||
|
color: #a6e22e;
|
||||||
|
}
|
200
_sass/vendor/OneDarkJekyll/syntax-firewatch.scss
vendored
Normal file
200
_sass/vendor/OneDarkJekyll/syntax-firewatch.scss
vendored
Normal file
@@ -0,0 +1,200 @@
|
|||||||
|
.highlight,
|
||||||
|
pre.highlight {
|
||||||
|
background: #282c34;
|
||||||
|
color: #abb2bf;
|
||||||
|
}
|
||||||
|
.highlight pre {
|
||||||
|
background: #282c34;
|
||||||
|
}
|
||||||
|
.highlight .hll {
|
||||||
|
background: #282c34;
|
||||||
|
}
|
||||||
|
.highlight .c {
|
||||||
|
color: #5c6370;
|
||||||
|
font-style: italic;
|
||||||
|
}
|
||||||
|
.highlight .err {
|
||||||
|
color: #960050;
|
||||||
|
background-color: #1e0010;
|
||||||
|
}
|
||||||
|
.highlight .k {
|
||||||
|
color: #dd672c;
|
||||||
|
}
|
||||||
|
.highlight .l {
|
||||||
|
color: #c8ae9d;
|
||||||
|
}
|
||||||
|
.highlight .n {
|
||||||
|
color: #abb2bf;
|
||||||
|
}
|
||||||
|
.highlight .o {
|
||||||
|
color: #abb2bf;
|
||||||
|
}
|
||||||
|
.highlight .p {
|
||||||
|
color: #abb2bf;
|
||||||
|
}
|
||||||
|
.highlight .cm {
|
||||||
|
color: #5c6370;
|
||||||
|
font-style: italic;
|
||||||
|
}
|
||||||
|
.highlight .cp {
|
||||||
|
color: #5c6370;
|
||||||
|
font-style: italic;
|
||||||
|
}
|
||||||
|
.highlight .c1 {
|
||||||
|
color: #5c6370;
|
||||||
|
font-style: italic;
|
||||||
|
}
|
||||||
|
.highlight .cs {
|
||||||
|
color: #5c6370;
|
||||||
|
font-style: italic;
|
||||||
|
}
|
||||||
|
.highlight .ge {
|
||||||
|
font-style: italic;
|
||||||
|
}
|
||||||
|
.highlight .gs {
|
||||||
|
font-weight: 700;
|
||||||
|
}
|
||||||
|
.highlight .kc {
|
||||||
|
color: #dd672c;
|
||||||
|
}
|
||||||
|
.highlight .kd {
|
||||||
|
color: #dd672c;
|
||||||
|
}
|
||||||
|
.highlight .kn {
|
||||||
|
color: #dd672c;
|
||||||
|
}
|
||||||
|
.highlight .kp {
|
||||||
|
color: #dd672c;
|
||||||
|
}
|
||||||
|
.highlight .kr {
|
||||||
|
color: #dd672c;
|
||||||
|
}
|
||||||
|
.highlight .kt {
|
||||||
|
color: #dd672c;
|
||||||
|
}
|
||||||
|
.highlight .ld {
|
||||||
|
color: #c8ae9d;
|
||||||
|
}
|
||||||
|
.highlight .m {
|
||||||
|
color: #d19a66;
|
||||||
|
}
|
||||||
|
.highlight .s {
|
||||||
|
color: #c8ae9d;
|
||||||
|
}
|
||||||
|
.highlight .na {
|
||||||
|
color: #d19a66;
|
||||||
|
}
|
||||||
|
.highlight .nb {
|
||||||
|
color: #e5c07b;
|
||||||
|
}
|
||||||
|
.highlight .nc {
|
||||||
|
color: #e5c07b;
|
||||||
|
}
|
||||||
|
.highlight .no {
|
||||||
|
color: #e5c07b;
|
||||||
|
}
|
||||||
|
.highlight .nd {
|
||||||
|
color: #e5c07b;
|
||||||
|
}
|
||||||
|
.highlight .ni {
|
||||||
|
color: #e5c07b;
|
||||||
|
}
|
||||||
|
.highlight .ne {
|
||||||
|
color: #e5c07b;
|
||||||
|
}
|
||||||
|
.highlight .nf {
|
||||||
|
color: #abb2bf;
|
||||||
|
}
|
||||||
|
.highlight .nl {
|
||||||
|
color: #e5c07b;
|
||||||
|
}
|
||||||
|
.highlight .nn {
|
||||||
|
color: #abb2bf;
|
||||||
|
}
|
||||||
|
.highlight .nx {
|
||||||
|
color: #abb2bf;
|
||||||
|
}
|
||||||
|
.highlight .py {
|
||||||
|
color: #e5c07b;
|
||||||
|
}
|
||||||
|
.highlight .nt {
|
||||||
|
color: #e06c75;
|
||||||
|
}
|
||||||
|
.highlight .nv {
|
||||||
|
color: #e5c07b;
|
||||||
|
}
|
||||||
|
.highlight .ow {
|
||||||
|
font-weight: 700;
|
||||||
|
}
|
||||||
|
.highlight .w {
|
||||||
|
color: #f8f8f2;
|
||||||
|
}
|
||||||
|
.highlight .mf {
|
||||||
|
color: #d19a66;
|
||||||
|
}
|
||||||
|
.highlight .mh {
|
||||||
|
color: #d19a66;
|
||||||
|
}
|
||||||
|
.highlight .mi {
|
||||||
|
color: #d19a66;
|
||||||
|
}
|
||||||
|
.highlight .mo {
|
||||||
|
color: #d19a66;
|
||||||
|
}
|
||||||
|
.highlight .sb {
|
||||||
|
color: #c8ae9d;
|
||||||
|
}
|
||||||
|
.highlight .sc {
|
||||||
|
color: #c8ae9d;
|
||||||
|
}
|
||||||
|
.highlight .sd {
|
||||||
|
color: #c8ae9d;
|
||||||
|
}
|
||||||
|
.highlight .s2 {
|
||||||
|
color: #c8ae9d;
|
||||||
|
}
|
||||||
|
.highlight .se {
|
||||||
|
color: #c8ae9d;
|
||||||
|
}
|
||||||
|
.highlight .sh {
|
||||||
|
color: #c8ae9d;
|
||||||
|
}
|
||||||
|
.highlight .si {
|
||||||
|
color: #c8ae9d;
|
||||||
|
}
|
||||||
|
.highlight .sx {
|
||||||
|
color: #c8ae9d;
|
||||||
|
}
|
||||||
|
.highlight .sr {
|
||||||
|
color: #56b6c2;
|
||||||
|
}
|
||||||
|
.highlight .s1 {
|
||||||
|
color: #c8ae9d;
|
||||||
|
}
|
||||||
|
.highlight .ss {
|
||||||
|
color: #56b6c2;
|
||||||
|
}
|
||||||
|
.highlight .bp {
|
||||||
|
color: #e5c07b;
|
||||||
|
}
|
||||||
|
.highlight .vc {
|
||||||
|
color: #e5c07b;
|
||||||
|
}
|
||||||
|
.highlight .vg {
|
||||||
|
color: #e5c07b;
|
||||||
|
}
|
||||||
|
.highlight .vi {
|
||||||
|
color: #e06c75;
|
||||||
|
}
|
||||||
|
.highlight .il {
|
||||||
|
color: #d19a66;
|
||||||
|
}
|
||||||
|
.highlight .gu {
|
||||||
|
color: #75715e;
|
||||||
|
}
|
||||||
|
.highlight .gd {
|
||||||
|
color: #f92672;
|
||||||
|
}
|
||||||
|
.highlight .gi {
|
||||||
|
color: #a6e22e;
|
||||||
|
}
|
200
_sass/vendor/OneDarkJekyll/syntax-one-dark-vivid.scss
vendored
Normal file
200
_sass/vendor/OneDarkJekyll/syntax-one-dark-vivid.scss
vendored
Normal file
@@ -0,0 +1,200 @@
|
|||||||
|
.highlight,
|
||||||
|
pre.highlight {
|
||||||
|
background: #31343f;
|
||||||
|
color: #dee2f7;
|
||||||
|
}
|
||||||
|
.highlight pre {
|
||||||
|
background: #31343f;
|
||||||
|
}
|
||||||
|
.highlight .hll {
|
||||||
|
background: #31343f;
|
||||||
|
}
|
||||||
|
.highlight .c {
|
||||||
|
color: #63677e;
|
||||||
|
font-style: italic;
|
||||||
|
}
|
||||||
|
.highlight .err {
|
||||||
|
color: #960050;
|
||||||
|
background-color: #1e0010;
|
||||||
|
}
|
||||||
|
.highlight .k {
|
||||||
|
color: #e19ef5;
|
||||||
|
}
|
||||||
|
.highlight .l {
|
||||||
|
color: #a3eea0;
|
||||||
|
}
|
||||||
|
.highlight .n {
|
||||||
|
color: #dee2f7;
|
||||||
|
}
|
||||||
|
.highlight .o {
|
||||||
|
color: #dee2f7;
|
||||||
|
}
|
||||||
|
.highlight .p {
|
||||||
|
color: #dee2f7;
|
||||||
|
}
|
||||||
|
.highlight .cm {
|
||||||
|
color: #63677e;
|
||||||
|
font-style: italic;
|
||||||
|
}
|
||||||
|
.highlight .cp {
|
||||||
|
color: #63677e;
|
||||||
|
font-style: italic;
|
||||||
|
}
|
||||||
|
.highlight .c1 {
|
||||||
|
color: #63677e;
|
||||||
|
font-style: italic;
|
||||||
|
}
|
||||||
|
.highlight .cs {
|
||||||
|
color: #63677e;
|
||||||
|
font-style: italic;
|
||||||
|
}
|
||||||
|
.highlight .ge {
|
||||||
|
font-style: italic;
|
||||||
|
}
|
||||||
|
.highlight .gs {
|
||||||
|
font-weight: 700;
|
||||||
|
}
|
||||||
|
.highlight .kc {
|
||||||
|
color: #e19ef5;
|
||||||
|
}
|
||||||
|
.highlight .kd {
|
||||||
|
color: #e19ef5;
|
||||||
|
}
|
||||||
|
.highlight .kn {
|
||||||
|
color: #e19ef5;
|
||||||
|
}
|
||||||
|
.highlight .kp {
|
||||||
|
color: #e19ef5;
|
||||||
|
}
|
||||||
|
.highlight .kr {
|
||||||
|
color: #e19ef5;
|
||||||
|
}
|
||||||
|
.highlight .kt {
|
||||||
|
color: #e19ef5;
|
||||||
|
}
|
||||||
|
.highlight .ld {
|
||||||
|
color: #a3eea0;
|
||||||
|
}
|
||||||
|
.highlight .m {
|
||||||
|
color: #eddc96;
|
||||||
|
}
|
||||||
|
.highlight .s {
|
||||||
|
color: #a3eea0;
|
||||||
|
}
|
||||||
|
.highlight .na {
|
||||||
|
color: #eddc96;
|
||||||
|
}
|
||||||
|
.highlight .nb {
|
||||||
|
color: #fdce68;
|
||||||
|
}
|
||||||
|
.highlight .nc {
|
||||||
|
color: #fdce68;
|
||||||
|
}
|
||||||
|
.highlight .no {
|
||||||
|
color: #fdce68;
|
||||||
|
}
|
||||||
|
.highlight .nd {
|
||||||
|
color: #fdce68;
|
||||||
|
}
|
||||||
|
.highlight .ni {
|
||||||
|
color: #fdce68;
|
||||||
|
}
|
||||||
|
.highlight .ne {
|
||||||
|
color: #fdce68;
|
||||||
|
}
|
||||||
|
.highlight .nf {
|
||||||
|
color: #dee2f7;
|
||||||
|
}
|
||||||
|
.highlight .nl {
|
||||||
|
color: #fdce68;
|
||||||
|
}
|
||||||
|
.highlight .nn {
|
||||||
|
color: #dee2f7;
|
||||||
|
}
|
||||||
|
.highlight .nx {
|
||||||
|
color: #dee2f7;
|
||||||
|
}
|
||||||
|
.highlight .py {
|
||||||
|
color: #fdce68;
|
||||||
|
}
|
||||||
|
.highlight .nt {
|
||||||
|
color: #f9867b;
|
||||||
|
}
|
||||||
|
.highlight .nv {
|
||||||
|
color: #fdce68;
|
||||||
|
}
|
||||||
|
.highlight .ow {
|
||||||
|
font-weight: 700;
|
||||||
|
}
|
||||||
|
.highlight .w {
|
||||||
|
color: #f8f8f2;
|
||||||
|
}
|
||||||
|
.highlight .mf {
|
||||||
|
color: #eddc96;
|
||||||
|
}
|
||||||
|
.highlight .mh {
|
||||||
|
color: #eddc96;
|
||||||
|
}
|
||||||
|
.highlight .mi {
|
||||||
|
color: #eddc96;
|
||||||
|
}
|
||||||
|
.highlight .mo {
|
||||||
|
color: #eddc96;
|
||||||
|
}
|
||||||
|
.highlight .sb {
|
||||||
|
color: #a3eea0;
|
||||||
|
}
|
||||||
|
.highlight .sc {
|
||||||
|
color: #a3eea0;
|
||||||
|
}
|
||||||
|
.highlight .sd {
|
||||||
|
color: #a3eea0;
|
||||||
|
}
|
||||||
|
.highlight .s2 {
|
||||||
|
color: #a3eea0;
|
||||||
|
}
|
||||||
|
.highlight .se {
|
||||||
|
color: #a3eea0;
|
||||||
|
}
|
||||||
|
.highlight .sh {
|
||||||
|
color: #a3eea0;
|
||||||
|
}
|
||||||
|
.highlight .si {
|
||||||
|
color: #a3eea0;
|
||||||
|
}
|
||||||
|
.highlight .sx {
|
||||||
|
color: #a3eea0;
|
||||||
|
}
|
||||||
|
.highlight .sr {
|
||||||
|
color: #7be2f9;
|
||||||
|
}
|
||||||
|
.highlight .s1 {
|
||||||
|
color: #a3eea0;
|
||||||
|
}
|
||||||
|
.highlight .ss {
|
||||||
|
color: #7be2f9;
|
||||||
|
}
|
||||||
|
.highlight .bp {
|
||||||
|
color: #fdce68;
|
||||||
|
}
|
||||||
|
.highlight .vc {
|
||||||
|
color: #fdce68;
|
||||||
|
}
|
||||||
|
.highlight .vg {
|
||||||
|
color: #fdce68;
|
||||||
|
}
|
||||||
|
.highlight .vi {
|
||||||
|
color: #f9867b;
|
||||||
|
}
|
||||||
|
.highlight .il {
|
||||||
|
color: #eddc96;
|
||||||
|
}
|
||||||
|
.highlight .gu {
|
||||||
|
color: #75715e;
|
||||||
|
}
|
||||||
|
.highlight .gd {
|
||||||
|
color: #f92672;
|
||||||
|
}
|
||||||
|
.highlight .gi {
|
||||||
|
color: #a6e22e;
|
||||||
|
}
|
200
_sass/vendor/OneDarkJekyll/syntax-one-dark.scss
vendored
Normal file
200
_sass/vendor/OneDarkJekyll/syntax-one-dark.scss
vendored
Normal file
@@ -0,0 +1,200 @@
|
|||||||
|
.highlight,
|
||||||
|
pre.highlight {
|
||||||
|
background: #282c34;
|
||||||
|
color: #abb2bf;
|
||||||
|
}
|
||||||
|
.highlight pre {
|
||||||
|
background: #282c34;
|
||||||
|
}
|
||||||
|
.highlight .hll {
|
||||||
|
background: #282c34;
|
||||||
|
}
|
||||||
|
.highlight .c {
|
||||||
|
color: #5c6370;
|
||||||
|
font-style: italic;
|
||||||
|
}
|
||||||
|
.highlight .err {
|
||||||
|
color: #960050;
|
||||||
|
background-color: #1e0010;
|
||||||
|
}
|
||||||
|
.highlight .k {
|
||||||
|
color: #c678dd;
|
||||||
|
}
|
||||||
|
.highlight .l {
|
||||||
|
color: #98c379;
|
||||||
|
}
|
||||||
|
.highlight .n {
|
||||||
|
color: #abb2bf;
|
||||||
|
}
|
||||||
|
.highlight .o {
|
||||||
|
color: #abb2bf;
|
||||||
|
}
|
||||||
|
.highlight .p {
|
||||||
|
color: #abb2bf;
|
||||||
|
}
|
||||||
|
.highlight .cm {
|
||||||
|
color: #5c6370;
|
||||||
|
font-style: italic;
|
||||||
|
}
|
||||||
|
.highlight .cp {
|
||||||
|
color: #5c6370;
|
||||||
|
font-style: italic;
|
||||||
|
}
|
||||||
|
.highlight .c1 {
|
||||||
|
color: #5c6370;
|
||||||
|
font-style: italic;
|
||||||
|
}
|
||||||
|
.highlight .cs {
|
||||||
|
color: #5c6370;
|
||||||
|
font-style: italic;
|
||||||
|
}
|
||||||
|
.highlight .ge {
|
||||||
|
font-style: italic;
|
||||||
|
}
|
||||||
|
.highlight .gs {
|
||||||
|
font-weight: 700;
|
||||||
|
}
|
||||||
|
.highlight .kc {
|
||||||
|
color: #c678dd;
|
||||||
|
}
|
||||||
|
.highlight .kd {
|
||||||
|
color: #c678dd;
|
||||||
|
}
|
||||||
|
.highlight .kn {
|
||||||
|
color: #c678dd;
|
||||||
|
}
|
||||||
|
.highlight .kp {
|
||||||
|
color: #c678dd;
|
||||||
|
}
|
||||||
|
.highlight .kr {
|
||||||
|
color: #c678dd;
|
||||||
|
}
|
||||||
|
.highlight .kt {
|
||||||
|
color: #c678dd;
|
||||||
|
}
|
||||||
|
.highlight .ld {
|
||||||
|
color: #98c379;
|
||||||
|
}
|
||||||
|
.highlight .m {
|
||||||
|
color: #d19a66;
|
||||||
|
}
|
||||||
|
.highlight .s {
|
||||||
|
color: #98c379;
|
||||||
|
}
|
||||||
|
.highlight .na {
|
||||||
|
color: #d19a66;
|
||||||
|
}
|
||||||
|
.highlight .nb {
|
||||||
|
color: #e5c07b;
|
||||||
|
}
|
||||||
|
.highlight .nc {
|
||||||
|
color: #e5c07b;
|
||||||
|
}
|
||||||
|
.highlight .no {
|
||||||
|
color: #e5c07b;
|
||||||
|
}
|
||||||
|
.highlight .nd {
|
||||||
|
color: #e5c07b;
|
||||||
|
}
|
||||||
|
.highlight .ni {
|
||||||
|
color: #e5c07b;
|
||||||
|
}
|
||||||
|
.highlight .ne {
|
||||||
|
color: #e5c07b;
|
||||||
|
}
|
||||||
|
.highlight .nf {
|
||||||
|
color: #abb2bf;
|
||||||
|
}
|
||||||
|
.highlight .nl {
|
||||||
|
color: #e5c07b;
|
||||||
|
}
|
||||||
|
.highlight .nn {
|
||||||
|
color: #abb2bf;
|
||||||
|
}
|
||||||
|
.highlight .nx {
|
||||||
|
color: #abb2bf;
|
||||||
|
}
|
||||||
|
.highlight .py {
|
||||||
|
color: #e5c07b;
|
||||||
|
}
|
||||||
|
.highlight .nt {
|
||||||
|
color: #e06c75;
|
||||||
|
}
|
||||||
|
.highlight .nv {
|
||||||
|
color: #e5c07b;
|
||||||
|
}
|
||||||
|
.highlight .ow {
|
||||||
|
font-weight: 700;
|
||||||
|
}
|
||||||
|
.highlight .w {
|
||||||
|
color: #f8f8f2;
|
||||||
|
}
|
||||||
|
.highlight .mf {
|
||||||
|
color: #d19a66;
|
||||||
|
}
|
||||||
|
.highlight .mh {
|
||||||
|
color: #d19a66;
|
||||||
|
}
|
||||||
|
.highlight .mi {
|
||||||
|
color: #d19a66;
|
||||||
|
}
|
||||||
|
.highlight .mo {
|
||||||
|
color: #d19a66;
|
||||||
|
}
|
||||||
|
.highlight .sb {
|
||||||
|
color: #98c379;
|
||||||
|
}
|
||||||
|
.highlight .sc {
|
||||||
|
color: #98c379;
|
||||||
|
}
|
||||||
|
.highlight .sd {
|
||||||
|
color: #98c379;
|
||||||
|
}
|
||||||
|
.highlight .s2 {
|
||||||
|
color: #98c379;
|
||||||
|
}
|
||||||
|
.highlight .se {
|
||||||
|
color: #98c379;
|
||||||
|
}
|
||||||
|
.highlight .sh {
|
||||||
|
color: #98c379;
|
||||||
|
}
|
||||||
|
.highlight .si {
|
||||||
|
color: #98c379;
|
||||||
|
}
|
||||||
|
.highlight .sx {
|
||||||
|
color: #98c379;
|
||||||
|
}
|
||||||
|
.highlight .sr {
|
||||||
|
color: #56b6c2;
|
||||||
|
}
|
||||||
|
.highlight .s1 {
|
||||||
|
color: #98c379;
|
||||||
|
}
|
||||||
|
.highlight .ss {
|
||||||
|
color: #56b6c2;
|
||||||
|
}
|
||||||
|
.highlight .bp {
|
||||||
|
color: #e5c07b;
|
||||||
|
}
|
||||||
|
.highlight .vc {
|
||||||
|
color: #e5c07b;
|
||||||
|
}
|
||||||
|
.highlight .vg {
|
||||||
|
color: #e5c07b;
|
||||||
|
}
|
||||||
|
.highlight .vi {
|
||||||
|
color: #e06c75;
|
||||||
|
}
|
||||||
|
.highlight .il {
|
||||||
|
color: #d19a66;
|
||||||
|
}
|
||||||
|
.highlight .gu {
|
||||||
|
color: #75715e;
|
||||||
|
}
|
||||||
|
.highlight .gd {
|
||||||
|
color: #f92672;
|
||||||
|
}
|
||||||
|
.highlight .gi {
|
||||||
|
color: #a6e22e;
|
||||||
|
}
|
56
_sass/vendor/OneDarkJekyll/syntax-variables.less
vendored
Normal file
56
_sass/vendor/OneDarkJekyll/syntax-variables.less
vendored
Normal file
@@ -0,0 +1,56 @@
|
|||||||
|
@import "colors.less";
|
||||||
|
|
||||||
|
// Official Syntax Variables -----------------------------------
|
||||||
|
|
||||||
|
// General colors
|
||||||
|
@syntax-text-color: @syntax-fg;
|
||||||
|
@syntax-cursor-color: @syntax-accent;
|
||||||
|
@syntax-selection-color: lighten(@syntax-background-color, 10%);
|
||||||
|
@syntax-selection-flash-color: @syntax-accent;
|
||||||
|
@syntax-background-color: @syntax-bg;
|
||||||
|
|
||||||
|
// Guide colors
|
||||||
|
@syntax-wrap-guide-color: @syntax-guide;
|
||||||
|
@syntax-indent-guide-color: @syntax-guide;
|
||||||
|
@syntax-invisible-character-color: @syntax-guide;
|
||||||
|
|
||||||
|
// For find and replace markers
|
||||||
|
@syntax-result-marker-color: fade(@syntax-accent, 24%);
|
||||||
|
@syntax-result-marker-color-selected: @syntax-accent;
|
||||||
|
|
||||||
|
// Gutter colors
|
||||||
|
@syntax-gutter-text-color: @syntax-gutter;
|
||||||
|
@syntax-gutter-text-color-selected: @syntax-fg;
|
||||||
|
@syntax-gutter-background-color: @syntax-bg; // unused
|
||||||
|
@syntax-gutter-background-color-selected: lighten(@syntax-bg, 2%);
|
||||||
|
|
||||||
|
// Git colors - For git diff info. i.e. in the gutter
|
||||||
|
@syntax-color-renamed: hsl(208, 100%, 60%);
|
||||||
|
@syntax-color-added: hsl(150, 60%, 54%);
|
||||||
|
@syntax-color-modified: hsl(40, 60%, 70%);
|
||||||
|
@syntax-color-removed: hsl(0, 70%, 60%);
|
||||||
|
|
||||||
|
// For language entity colors
|
||||||
|
@syntax-color-variable: @hue-5;
|
||||||
|
@syntax-color-constant: @hue-6;
|
||||||
|
@syntax-color-property: @syntax-fg;
|
||||||
|
@syntax-color-value: @syntax-fg;
|
||||||
|
@syntax-color-function: @hue-2;
|
||||||
|
@syntax-color-method: @hue-2;
|
||||||
|
@syntax-color-class: @hue-6-2;
|
||||||
|
@syntax-color-keyword: @hue-3;
|
||||||
|
@syntax-color-tag: @hue-5;
|
||||||
|
@syntax-color-attribute: @hue-6;
|
||||||
|
@syntax-color-import: @hue-3;
|
||||||
|
@syntax-color-snippet: @hue-4;
|
||||||
|
|
||||||
|
|
||||||
|
// Custom Syntax Variables -----------------------------------
|
||||||
|
// Don't use in packages
|
||||||
|
|
||||||
|
@syntax-cursor-line: hsla(@syntax-hue, 100%, 80%, .04); // needs to be semi-transparent to show search results
|
||||||
|
|
||||||
|
@syntax-deprecated-fg: darken(@syntax-color-modified, 50%);
|
||||||
|
@syntax-deprecated-bg: @syntax-color-modified;
|
||||||
|
@syntax-illegal-fg: white;
|
||||||
|
@syntax-illegal-bg: @syntax-color-removed;
|
93
_sass/vendor/OneDarkJekyll/syntax.less
vendored
Normal file
93
_sass/vendor/OneDarkJekyll/syntax.less
vendored
Normal file
@@ -0,0 +1,93 @@
|
|||||||
|
/*
|
||||||
|
LESS for Pygments
|
||||||
|
*/
|
||||||
|
|
||||||
|
@import "syntax-variables.less";
|
||||||
|
|
||||||
|
pre.highlight,
|
||||||
|
.highlight {
|
||||||
|
background: @syntax-bg;
|
||||||
|
color: @mono-1;
|
||||||
|
}
|
||||||
|
.highlight {
|
||||||
|
pre { background: @syntax-bg; }
|
||||||
|
.hll { background: @syntax-bg; }
|
||||||
|
.c { color: @mono-3; font-style: italic; } /* Comment */
|
||||||
|
.err { color: @syntax-illegal-fg; background-color: @syntax-illegal-bg; } /* Error */
|
||||||
|
.k { color: @hue-3; } /* Keyword */
|
||||||
|
.l { color: @hue-4; } /* Literal */
|
||||||
|
.n { color: @mono-1; } /* Name */
|
||||||
|
.o { color: @mono-1; } /* Operator */
|
||||||
|
.p { color: @mono-1; } /* Punctuation */
|
||||||
|
.cm { color: @mono-3; font-style: italic; } /* Comment.Multiline */
|
||||||
|
.cp { color: @mono-3; font-style: italic; } /* Comment.Preproc */
|
||||||
|
.c1 { color: @mono-3; font-style: italic; } /* Comment.Single */
|
||||||
|
.cs { color: @mono-3; font-style: italic; } /* Comment.Special */
|
||||||
|
.ge { font-style: italic } /* Generic.Emph */
|
||||||
|
.gs { font-weight: bold } /* Generic.Strong */
|
||||||
|
.kc { color: @hue-3; } /* Keyword.Constant */
|
||||||
|
.kd { color: @hue-3; } /* Keyword.Declaration */
|
||||||
|
.kn { color: @hue-3; } /* Keyword.Namespace */
|
||||||
|
.kp { color: @hue-3; } /* Keyword.Pseudo */
|
||||||
|
.kr { color: @hue-3; } /* Keyword.Reserved */
|
||||||
|
.kt { color: @hue-3; } /* Keyword.Type */
|
||||||
|
.ld { color: @hue-4; } /* Literal.Date */
|
||||||
|
.m { color: @hue-6; } /* Literal.Number */
|
||||||
|
.s { color: @hue-4; } /* Literal.String */
|
||||||
|
.na { color: @hue-6; } /* Name.Attribute */
|
||||||
|
.nb { color: @hue-6-2; } /* Name.Builtin */
|
||||||
|
.nc { color: @hue-6-2; } /* Name.Class */
|
||||||
|
.no { color: @hue-6-2; } /* Name.Constant */
|
||||||
|
.nd { color: @hue-6-2; } /* Name.Decorator */
|
||||||
|
.ni { color: @hue-6-2; } /* Name.Entity */
|
||||||
|
.ne { color: @hue-6-2; } /* Name.Exception */
|
||||||
|
.nf { color: @mono-1; } /* Name.Function */
|
||||||
|
.nl { color: @hue-6-2; } /* Name.Label */
|
||||||
|
.nn { color: @mono-1; } /* Name.Namespace */
|
||||||
|
.nx { color: @mono-1; } /* Name.Other */
|
||||||
|
.py { color: @hue-6-2; } /* Name.Property */
|
||||||
|
.nt { color: @hue-5; } /* Name.Tag */
|
||||||
|
.nv { color: @hue-6-2; } /* Name.Variable */
|
||||||
|
.ow { font-weight: bold; } /* Operator.Word */
|
||||||
|
.w { color: #f8f8f2 } /* Text.Whitespace */
|
||||||
|
.mf { color: @hue-6; } /* Literal.Number.Float */
|
||||||
|
.mh { color: @hue-6; } /* Literal.Number.Hex */
|
||||||
|
.mi { color: @hue-6; } /* Literal.Number.Integer */
|
||||||
|
.mo { color: @hue-6; } /* Literal.Number.Oct */
|
||||||
|
.sb { color: @hue-4; } /* Literal.String.Backtick */
|
||||||
|
.sc { color: @hue-4; } /* Literal.String.Char */
|
||||||
|
.sd { color: @hue-4; } /* Literal.String.Doc */
|
||||||
|
.s2 { color: @hue-4; } /* Literal.String.Double */
|
||||||
|
.se { color: @hue-4; } /* Literal.String.Escape */
|
||||||
|
.sh { color: @hue-4; } /* Literal.String.Heredoc */
|
||||||
|
.si { color: @hue-4; } /* Literal.String.Interpol */
|
||||||
|
.sx { color: @hue-4; } /* Literal.String.Other */
|
||||||
|
.sr { color: @hue-1; } /* Literal.String.Regex */
|
||||||
|
.s1 { color: @hue-4; } /* Literal.String.Single */
|
||||||
|
.ss { color: @hue-1; } /* Literal.String.Symbol */
|
||||||
|
.bp { color: @hue-6-2; } /* Name.Builtin.Pseudo */
|
||||||
|
.vc { color: @hue-6-2; } /* Name.Variable.Class */
|
||||||
|
.vg { color: @hue-6-2; } /* Name.Variable.Global */
|
||||||
|
.vi { color: @hue-5; } /* Name.Variable.Instance */
|
||||||
|
.il { color: @hue-6; } /* Literal.Number.Integer.Long */
|
||||||
|
|
||||||
|
.gh { } /* Generic Heading & Diff Header */
|
||||||
|
.gu { color: #75715e; } /* Generic.Subheading & Diff Unified/Comment? */
|
||||||
|
.gd { color: @syntax-color-removed; } /* Generic.Deleted & Diff Deleted */
|
||||||
|
.gi { color: @syntax-color-added; } /* Generic.Inserted & Diff Inserted */
|
||||||
|
|
||||||
|
::selection { background-color: @syntax-selection-color; }
|
||||||
|
|
||||||
|
.language-json {
|
||||||
|
.w + .s2 { color: @hue-5; }
|
||||||
|
.kc { color: @hue-1; }
|
||||||
|
}
|
||||||
|
|
||||||
|
.language-python {
|
||||||
|
// python related modifications
|
||||||
|
}
|
||||||
|
|
||||||
|
.language-csharp {
|
||||||
|
// csharp related modifications
|
||||||
|
}
|
||||||
|
}
|
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user