mirror of
https://github.com/jekyll/jekyll.git
synced 2026-04-28 03:01:03 -04:00
Compare commits
765 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
1898ced3c4 | ||
|
|
5d924f6216 | ||
|
|
9e76d2b496 | ||
|
|
192df096b0 | ||
|
|
694800270a | ||
|
|
2a6ec9788b | ||
|
|
7612056bed | ||
|
|
e0758ba550 | ||
|
|
1d8d6be243 | ||
|
|
41fa9cda36 | ||
|
|
be25b47486 | ||
|
|
f8dfbd2f7b | ||
|
|
acdbf81476 | ||
|
|
7e1afd32a5 | ||
|
|
1eff0214d1 | ||
|
|
bb1889afe4 | ||
|
|
3eb73f2795 | ||
|
|
b95151c4a7 | ||
|
|
c0ae27f068 | ||
|
|
64677e7c36 | ||
|
|
3899bf52f8 | ||
|
|
15f1ed8c4f | ||
|
|
b6201db17f | ||
|
|
ed9e72db9e | ||
|
|
a499018dc8 | ||
|
|
c08b882717 | ||
|
|
b0a1c42222 | ||
|
|
3ed4dbd227 | ||
|
|
da6c4c488a | ||
|
|
a80442ee87 | ||
|
|
9b8f9bba4e | ||
|
|
9ad78ebdeb | ||
|
|
4a45407558 | ||
|
|
305342ffa4 | ||
|
|
b22e281bc5 | ||
|
|
5b37555835 | ||
|
|
95a103b882 | ||
|
|
12fa319ee4 | ||
|
|
9461c900c0 | ||
|
|
43de0b694f | ||
|
|
e00c8c72e9 | ||
|
|
3e8196fc7e | ||
|
|
a89bba3712 | ||
|
|
eea203c77e | ||
|
|
8c8e2db0e5 | ||
|
|
ebce53dd08 | ||
|
|
34b710e133 | ||
|
|
f686b244cf | ||
|
|
739411ff3b | ||
|
|
c8eb0c1950 | ||
|
|
27ca1282fa | ||
|
|
b22915fe22 | ||
|
|
cf6d60b145 | ||
|
|
c60dd66db5 | ||
|
|
c2851766c5 | ||
|
|
c27533c75d | ||
|
|
f81f1e8e1b | ||
|
|
99da7cd940 | ||
|
|
3e32d12c45 | ||
|
|
3af8553c7c | ||
|
|
7f9ac93e4f | ||
|
|
4dd00fd354 | ||
|
|
3ee71c048c | ||
|
|
77fe78eaf7 | ||
|
|
0dede77a4a | ||
|
|
f9f5d5fa57 | ||
|
|
d5c2ebe610 | ||
|
|
f691121d2b | ||
|
|
29787c7eb7 | ||
|
|
83d950a4b7 | ||
|
|
5966e84313 | ||
|
|
66a8a03124 | ||
|
|
40d6ebd85e | ||
|
|
d0b907c2e6 | ||
|
|
a7b1cbe3f8 | ||
|
|
bea275e4c5 | ||
|
|
8941265837 | ||
|
|
24df53be20 | ||
|
|
3a5cd964af | ||
|
|
cd513da07e | ||
|
|
822d020086 | ||
|
|
7a6d0ccca3 | ||
|
|
d14f9aba99 | ||
|
|
4d26d30b6c | ||
|
|
7e72cbddd2 | ||
|
|
6fc2cfea6e | ||
|
|
3f98a743ed | ||
|
|
2a86c00011 | ||
|
|
7dc4d4fd67 | ||
|
|
551037c37b | ||
|
|
ba52e9e7c1 | ||
|
|
5096e8a9ac | ||
|
|
c9346ef522 | ||
|
|
8f78afe92b | ||
|
|
5da2b316eb | ||
|
|
449a874bf7 | ||
|
|
d09db32d10 | ||
|
|
d1aa1cfd5b | ||
|
|
971815cd5c | ||
|
|
5ba6a36b1f | ||
|
|
053b522a82 | ||
|
|
beada92da8 | ||
|
|
29dc190fcb | ||
|
|
bfdd26fdcc | ||
|
|
651b9b5593 | ||
|
|
8fab142750 | ||
|
|
3cbfc48e63 | ||
|
|
2765f0fcb9 | ||
|
|
36fbcaa863 | ||
|
|
ef027be97e | ||
|
|
748051fbc6 | ||
|
|
a27d8faa34 | ||
|
|
d97b3412bc | ||
|
|
925fb6da45 | ||
|
|
2a032a38ec | ||
|
|
7c12ebb28a | ||
|
|
ba94e87978 | ||
|
|
b6e3e739d9 | ||
|
|
37b729fd87 | ||
|
|
568257a192 | ||
|
|
fcb2eb6658 | ||
|
|
744563c188 | ||
|
|
2eee8128b0 | ||
|
|
d3418738ad | ||
|
|
90e9ae308e | ||
|
|
f119d2c921 | ||
|
|
31e64b9fe9 | ||
|
|
e0f5001182 | ||
|
|
bdbad98327 | ||
|
|
9e56c2727b | ||
|
|
688a63e671 | ||
|
|
8b61d7a328 | ||
|
|
70df9c55e5 | ||
|
|
6786970c96 | ||
|
|
69e2c65be6 | ||
|
|
31bdcdbc76 | ||
|
|
33f59aef2c | ||
|
|
7d759f0ff0 | ||
|
|
8f3363e2dc | ||
|
|
f7b5e313c1 | ||
|
|
7317627b97 | ||
|
|
603d513643 | ||
|
|
8c6433bd2d | ||
|
|
e45997fb5b | ||
|
|
8595c67df0 | ||
|
|
78684aa18a | ||
|
|
889c2e069c | ||
|
|
f6a43568d3 | ||
|
|
a275faa586 | ||
|
|
8caa101439 | ||
|
|
af102baecd | ||
|
|
68315cea8a | ||
|
|
6f2a2915f1 | ||
|
|
55d64c7e70 | ||
|
|
6a7a393df5 | ||
|
|
51bdea1303 | ||
|
|
b91ecf3c01 | ||
|
|
86d86258a8 | ||
|
|
13761dbf67 | ||
|
|
5bb12d0099 | ||
|
|
83dc61a54c | ||
|
|
e9ea98678c | ||
|
|
3773827715 | ||
|
|
0aaddbd76b | ||
|
|
a944dd940a | ||
|
|
f8a66ca76c | ||
|
|
7508da11c1 | ||
|
|
e1b64f9afd | ||
|
|
1aae0bcc3a | ||
|
|
297371e6e2 | ||
|
|
c7f007686a | ||
|
|
ebcd830693 | ||
|
|
5b77850dc9 | ||
|
|
ced613c678 | ||
|
|
6130280f8b | ||
|
|
93e16428d8 | ||
|
|
4032c3e286 | ||
|
|
7b2908809c | ||
|
|
16228ae499 | ||
|
|
a9c7ca91fd | ||
|
|
07e49f8d23 | ||
|
|
5748d6ac30 | ||
|
|
23bb50c71c | ||
|
|
767db9417b | ||
|
|
6047927eed | ||
|
|
d2a21fe776 | ||
|
|
ed20cb4f90 | ||
|
|
92d491ea13 | ||
|
|
bc214d28c7 | ||
|
|
82d495aa0c | ||
|
|
a9a77ee7e5 | ||
|
|
dc8a0ee15f | ||
|
|
2ac6397368 | ||
|
|
08b222bdba | ||
|
|
12cbe54650 | ||
|
|
19f6ab70ae | ||
|
|
01bc01cb9d | ||
|
|
ce8f111758 | ||
|
|
017f032b4c | ||
|
|
ce44eb6921 | ||
|
|
5868616810 | ||
|
|
bc2c0c4f80 | ||
|
|
5ebdc184c0 | ||
|
|
da6a697cda | ||
|
|
9262ff7ec4 | ||
|
|
a662bc24aa | ||
|
|
88a3daa978 | ||
|
|
cef66defbd | ||
|
|
2b77ee80e0 | ||
|
|
a5c25ada1e | ||
|
|
3a0d9bbc57 | ||
|
|
216582d703 | ||
|
|
3dd76a1941 | ||
|
|
a59e0e3a14 | ||
|
|
a3aea47459 | ||
|
|
9a1cb9890b | ||
|
|
fc28a3d8d1 | ||
|
|
00639f89bd | ||
|
|
31bd301b28 | ||
|
|
64706465de | ||
|
|
63046dbbf5 | ||
|
|
c5a2c40694 | ||
|
|
e83645d702 | ||
|
|
275a1f4d5d | ||
|
|
28ff8adcc6 | ||
|
|
e99f973b63 | ||
|
|
c038d83fc7 | ||
|
|
7040d26757 | ||
|
|
2da9eaf914 | ||
|
|
93ac88b70f | ||
|
|
28a1399bbd | ||
|
|
5928eeee5b | ||
|
|
03f5610c97 | ||
|
|
0395910391 | ||
|
|
073ac1c406 | ||
|
|
8fae0052c8 | ||
|
|
33017b702d | ||
|
|
8ebe5e3a3e | ||
|
|
0b09c4ad8d | ||
|
|
c0d891b08b | ||
|
|
e6876b288a | ||
|
|
067d1e907f | ||
|
|
8077019fc1 | ||
|
|
49b040c94e | ||
|
|
d343b0345e | ||
|
|
68dee159c5 | ||
|
|
4c9166a9e1 | ||
|
|
1727db8ee5 | ||
|
|
17065444e9 | ||
|
|
64c98ef08b | ||
|
|
0f2c27bcb0 | ||
|
|
19cd07f059 | ||
|
|
6563350ded | ||
|
|
3fb325998d | ||
|
|
bc06e241ea | ||
|
|
23491541f6 | ||
|
|
b4985d1e63 | ||
|
|
138a12c481 | ||
|
|
8b72fa3fbf | ||
|
|
5d12f318b3 | ||
|
|
0978bbe120 | ||
|
|
053acd31ac | ||
|
|
ece1a307c5 | ||
|
|
c04f4e901a | ||
|
|
50dbf1ace7 | ||
|
|
0c4eff0653 | ||
|
|
50b9858d3a | ||
|
|
b2086eb1d4 | ||
|
|
5ca193eed9 | ||
|
|
641545821d | ||
|
|
a6b4ce0928 | ||
|
|
c8d729830c | ||
|
|
cf5c689d94 | ||
|
|
c9d2da8722 | ||
|
|
731960e6e3 | ||
|
|
2ab15486a6 | ||
|
|
07ec68a5d0 | ||
|
|
00cb17d3c4 | ||
|
|
85cd6105df | ||
|
|
4d68304dea | ||
|
|
83a6aebb2d | ||
|
|
8ee052d454 | ||
|
|
3f4bb55e07 | ||
|
|
707dd03fb0 | ||
|
|
4490d2cfbf | ||
|
|
53c00c0a18 | ||
|
|
44ffce977c | ||
|
|
6b98a5c9cf | ||
|
|
009d308f9f | ||
|
|
578ad7695f | ||
|
|
af88add273 | ||
|
|
5923160756 | ||
|
|
7a78da840d | ||
|
|
603f2ea52f | ||
|
|
2cb5375519 | ||
|
|
1dc0702e29 | ||
|
|
4a43a65969 | ||
|
|
8e62993fc8 | ||
|
|
9a88900246 | ||
|
|
9cc6e2a1d1 | ||
|
|
082e0623af | ||
|
|
f77d704a1b | ||
|
|
a8a6230474 | ||
|
|
7895168cff | ||
|
|
6a827547ab | ||
|
|
a84e9e1f6d | ||
|
|
413de6a9b3 | ||
|
|
5ef2debefb | ||
|
|
4dccca27e0 | ||
|
|
7f39de67d6 | ||
|
|
c96289f4ca | ||
|
|
c00054a069 | ||
|
|
401f8fef5b | ||
|
|
a3351cff4f | ||
|
|
c9da3c424a | ||
|
|
32e9522ef1 | ||
|
|
5ba27d1edf | ||
|
|
4d6959ca4c | ||
|
|
abacae55ec | ||
|
|
3d624cd290 | ||
|
|
3c959af8d1 | ||
|
|
9b8db401e7 | ||
|
|
c3026bdf31 | ||
|
|
c07985eca8 | ||
|
|
bf8837e495 | ||
|
|
34694ae6d1 | ||
|
|
a9fe56830b | ||
|
|
f49431ab85 | ||
|
|
9a812a931a | ||
|
|
4ce9f8920b | ||
|
|
b3286e7468 | ||
|
|
53cfa642fb | ||
|
|
60f645eb76 | ||
|
|
96d3b5e986 | ||
|
|
47e9304342 | ||
|
|
14ab1bc9b2 | ||
|
|
aef0e1c252 | ||
|
|
d615257815 | ||
|
|
76a0fc3888 | ||
|
|
16b9ce908e | ||
|
|
94f74ff4ec | ||
|
|
999151dcaa | ||
|
|
ffe8b28c68 | ||
|
|
ff2795f98b | ||
|
|
1971ddd7a3 | ||
|
|
72ccd29edc | ||
|
|
d854b22656 | ||
|
|
d1440b9738 | ||
|
|
e149803e99 | ||
|
|
c471f94347 | ||
|
|
1082a39417 | ||
|
|
3b9ed96c30 | ||
|
|
acb82c92a8 | ||
|
|
71e3bce63d | ||
|
|
bc8fee97c5 | ||
|
|
977837fa3a | ||
|
|
36d70ecb8e | ||
|
|
0801caae8e | ||
|
|
f9044ac5c6 | ||
|
|
fc783cd13c | ||
|
|
ba75c87f63 | ||
|
|
1691685c77 | ||
|
|
713467817a | ||
|
|
64ef79291f | ||
|
|
23c3484660 | ||
|
|
28e20b9334 | ||
|
|
50ff219ba2 | ||
|
|
e3142e4c5a | ||
|
|
e8c8eacf7b | ||
|
|
75ba9366df | ||
|
|
cdb031084c | ||
|
|
760d586de2 | ||
|
|
2fe54170b4 | ||
|
|
0f04f446a7 | ||
|
|
0c4b12e6aa | ||
|
|
7826bfe552 | ||
|
|
65f7deca98 | ||
|
|
e3b8ba33da | ||
|
|
61e53b6b61 | ||
|
|
664b20d375 | ||
|
|
79bf9f2865 | ||
|
|
ff4718d824 | ||
|
|
bd1d44493f | ||
|
|
05bca8128c | ||
|
|
e063ac530c | ||
|
|
8060934f96 | ||
|
|
abeee6fdf6 | ||
|
|
65fd990459 | ||
|
|
7ef3260327 | ||
|
|
f58d5988fa | ||
|
|
ed03ca5c16 | ||
|
|
a25fd72334 | ||
|
|
f906a3cb59 | ||
|
|
398e7d5089 | ||
|
|
6b003a4438 | ||
|
|
c2195b0118 | ||
|
|
0f249eec9f | ||
|
|
f85a039633 | ||
|
|
0f35470480 | ||
|
|
13911961b9 | ||
|
|
0fdb39bbd6 | ||
|
|
68935f1bda | ||
|
|
3f8cd30d4d | ||
|
|
e4888f2e52 | ||
|
|
22cba713dc | ||
|
|
977cfb0ac0 | ||
|
|
7c72e62552 | ||
|
|
c2ee73ef8d | ||
|
|
32d1b43fc0 | ||
|
|
d8d6360107 | ||
|
|
a74853501a | ||
|
|
57ec30d6ef | ||
|
|
2774a1aeb6 | ||
|
|
fcb1b410e3 | ||
|
|
3efb1ad857 | ||
|
|
9d68b1b134 | ||
|
|
8e2c240fa6 | ||
|
|
9ec9273ed9 | ||
|
|
a58629f97d | ||
|
|
0186bdb384 | ||
|
|
2ea970d2b5 | ||
|
|
4c97f5ef22 | ||
|
|
a37bde52b3 | ||
|
|
80f6d7b3fa | ||
|
|
5a10887f86 | ||
|
|
38342006a3 | ||
|
|
f7b45c4440 | ||
|
|
da0df228cd | ||
|
|
64c87c9253 | ||
|
|
a13740839a | ||
|
|
b77593ce74 | ||
|
|
c14b8b5864 | ||
|
|
fce3cbfd81 | ||
|
|
0b4f657039 | ||
|
|
110b473487 | ||
|
|
01806bcec4 | ||
|
|
bd3c395cfc | ||
|
|
368fa1f723 | ||
|
|
c7c31e014c | ||
|
|
46b2501df6 | ||
|
|
cebcff1412 | ||
|
|
1c469eb53a | ||
|
|
f6cf8b934a | ||
|
|
c2586bbae7 | ||
|
|
28f64fb2b3 | ||
|
|
e88b81318c | ||
|
|
5d71314e16 | ||
|
|
b59078ed26 | ||
|
|
73675070f5 | ||
|
|
2c646a304c | ||
|
|
04f4e891f0 | ||
|
|
d63792b4e7 | ||
|
|
f421aa4070 | ||
|
|
dd5685bb78 | ||
|
|
1a398c48b8 | ||
|
|
9431fdb9cd | ||
|
|
621df9db8e | ||
|
|
707a8c7a0e | ||
|
|
5cb8a0e847 | ||
|
|
e86ec7450e | ||
|
|
cb9f227378 | ||
|
|
169ecf91c9 | ||
|
|
77852b8838 | ||
|
|
c812d35249 | ||
|
|
525efbc2f8 | ||
|
|
77dd16a472 | ||
|
|
f07c9daf3a | ||
|
|
9b044b9dfb | ||
|
|
174eb585a0 | ||
|
|
c80e2709d9 | ||
|
|
41312370a3 | ||
|
|
9c7ef8f14e | ||
|
|
5e7152546e | ||
|
|
8dcff01ad7 | ||
|
|
8605f11f86 | ||
|
|
4bfdd28790 | ||
|
|
d104cf02ef | ||
|
|
fd271f5bb2 | ||
|
|
9f2e57a99a | ||
|
|
582165897d | ||
|
|
b26dbaddd2 | ||
|
|
8081f54936 | ||
|
|
b05bb59a4e | ||
|
|
fa22ebf056 | ||
|
|
1f3ce72f6b | ||
|
|
0c2541139b | ||
|
|
47bdfc72ff | ||
|
|
a2e48ebba3 | ||
|
|
4b675aa1ea | ||
|
|
758ee7ed87 | ||
|
|
efd9864df6 | ||
|
|
7690fcb02b | ||
|
|
52482ce88a | ||
|
|
bb42e6251e | ||
|
|
17bd584319 | ||
|
|
0205fb9e79 | ||
|
|
db2fc380a0 | ||
|
|
a66c4780cc | ||
|
|
beed5513e4 | ||
|
|
a559dfaa6e | ||
|
|
94dc9265cb | ||
|
|
42c21aba86 | ||
|
|
3838564d21 | ||
|
|
fc272d4dfb | ||
|
|
93e3eb06d2 | ||
|
|
53d48d52e7 | ||
|
|
8fc463bdce | ||
|
|
7e31e274fb | ||
|
|
f72e2ccaa6 | ||
|
|
2023b44f2e | ||
|
|
aa959cef8a | ||
|
|
cc89a838f5 | ||
|
|
2ecf50f18f | ||
|
|
c52707bc66 | ||
|
|
0feccde80a | ||
|
|
0baf586723 | ||
|
|
e39f9db593 | ||
|
|
c122a3bda4 | ||
|
|
f535218a05 | ||
|
|
49fa2dee0e | ||
|
|
5f37f75d9e | ||
|
|
7de55c6089 | ||
|
|
afcffc7831 | ||
|
|
310bbbe529 | ||
|
|
b71d9b36b6 | ||
|
|
8dbe5de66b | ||
|
|
df6608e11d | ||
|
|
9632733efa | ||
|
|
63255ae2c1 | ||
|
|
1f8704f876 | ||
|
|
d628d438a8 | ||
|
|
39210d00e9 | ||
|
|
e635489c66 | ||
|
|
a4315fac3b | ||
|
|
52c34060e3 | ||
|
|
248bd59f5a | ||
|
|
a1d45f9717 | ||
|
|
08644f1e82 | ||
|
|
e0eff967f3 | ||
|
|
4865b902c1 | ||
|
|
8d88ee997c | ||
|
|
57ab42a8d0 | ||
|
|
3bd808c8b0 | ||
|
|
1c64f65f25 | ||
|
|
e9654c3fea | ||
|
|
c933ec5a57 | ||
|
|
0d8c704921 | ||
|
|
c0e4ce13b5 | ||
|
|
2993f9bc99 | ||
|
|
bfdbcc3984 | ||
|
|
945a24e568 | ||
|
|
280cf98030 | ||
|
|
1790385c31 | ||
|
|
bdef182000 | ||
|
|
48d7dd4305 | ||
|
|
bb9b634a0c | ||
|
|
a674620de6 | ||
|
|
d5c17b9db0 | ||
|
|
4e561a84e4 | ||
|
|
04e40d133f | ||
|
|
32f8e53a93 | ||
|
|
28af8bd85f | ||
|
|
e7f1ce2e2b | ||
|
|
32d38e68ef | ||
|
|
ae326148cc | ||
|
|
c0478e290b | ||
|
|
84c250394e | ||
|
|
3715633aae | ||
|
|
363bd6c7eb | ||
|
|
e0a97b5f12 | ||
|
|
c6b890698c | ||
|
|
640c5137c2 | ||
|
|
5ebfbe042d | ||
|
|
a5f8cb74dc | ||
|
|
72debf854b | ||
|
|
5f1b881c91 | ||
|
|
3f694695e1 | ||
|
|
b3d607f264 | ||
|
|
1bb36ebc9e | ||
|
|
2b9bb2306a | ||
|
|
b13a6161ed | ||
|
|
a78b518f83 | ||
|
|
2606e01d5b | ||
|
|
1a2625443d | ||
|
|
79194b5ad0 | ||
|
|
ffc29618a1 | ||
|
|
a7a7373281 | ||
|
|
d48412401a | ||
|
|
4a2ab9247c | ||
|
|
1d29f505c0 | ||
|
|
7fb10e12bf | ||
|
|
f38cf2efdb | ||
|
|
50de153c69 | ||
|
|
6c6c8b071c | ||
|
|
a20d13d6b5 | ||
|
|
85aebe9b90 | ||
|
|
ac3e6b384f | ||
|
|
fe5fb5beb7 | ||
|
|
ac575a0c50 | ||
|
|
77bb9267ac | ||
|
|
b11ad8ea77 | ||
|
|
b77cc3f070 | ||
|
|
4c0f26c8a1 | ||
|
|
76c52f43f7 | ||
|
|
f8762bd5d5 | ||
|
|
7b1c5dfcce | ||
|
|
816d59129d | ||
|
|
7333baf06d | ||
|
|
5df6e3f865 | ||
|
|
7d36527dfc | ||
|
|
528c03c22f | ||
|
|
eadad9eb7e | ||
|
|
cfec06cdba | ||
|
|
e4b456a2ee | ||
|
|
a9b95e58c6 | ||
|
|
0331fb41ad | ||
|
|
6f3d7a0034 | ||
|
|
5f8ba181f0 | ||
|
|
9113e0aa05 | ||
|
|
e5403396b7 | ||
|
|
023775e4eb | ||
|
|
76014aee2a | ||
|
|
d9770bb283 | ||
|
|
4359df8e65 | ||
|
|
c84aef0619 | ||
|
|
00bad8bfe5 | ||
|
|
e083f93ed8 | ||
|
|
9d7f0c1f85 | ||
|
|
7dccfcf2b5 | ||
|
|
ab31983122 | ||
|
|
dc4acbc66c | ||
|
|
09b849938d | ||
|
|
3feafed56c | ||
|
|
fb9c3b738d | ||
|
|
ec3a7b9078 | ||
|
|
738fc55896 | ||
|
|
211a595329 | ||
|
|
ca3a56b37c | ||
|
|
c9ac5fee94 | ||
|
|
47bcbfb654 | ||
|
|
97d4437179 | ||
|
|
a5fd0c0b26 | ||
|
|
66e2d38d58 | ||
|
|
b802093f15 | ||
|
|
fa49c02335 | ||
|
|
e3ee9ba113 | ||
|
|
e9f2d85767 | ||
|
|
2b6330b686 | ||
|
|
8b47fb1f7a | ||
|
|
1637f29d6c | ||
|
|
22f2724a1f | ||
|
|
579f9ee1dd | ||
|
|
b6853bf938 | ||
|
|
6ce912e957 | ||
|
|
1a4f53de14 | ||
|
|
cb58716310 | ||
|
|
fb27b2e296 | ||
|
|
94f377eed5 | ||
|
|
68d0214c6c | ||
|
|
53500a215a | ||
|
|
6a2a33d09d | ||
|
|
692ce49460 | ||
|
|
e2b3ab85a0 | ||
|
|
06d16504ff | ||
|
|
0aa55dbffb | ||
|
|
1a7bcb09f6 | ||
|
|
709a3444de | ||
|
|
fe0c105ff0 | ||
|
|
88f5af23b1 | ||
|
|
2b5457b9d2 | ||
|
|
f808593fbf | ||
|
|
2989a9a81b | ||
|
|
df25873ed4 | ||
|
|
851c36d828 | ||
|
|
1d3fa81d53 | ||
|
|
5cc2b6affc | ||
|
|
ee23d06507 | ||
|
|
d08256d1ce | ||
|
|
72877a9b07 | ||
|
|
22449496b8 | ||
|
|
2321370119 | ||
|
|
02767d612e | ||
|
|
232ec4679a | ||
|
|
08840946f3 | ||
|
|
b86785dc7c | ||
|
|
f2860047b7 | ||
|
|
f232e1039a | ||
|
|
22cc59905b | ||
|
|
54c1e5515e | ||
|
|
db4ab43bdb | ||
|
|
2ce17697d3 | ||
|
|
9b6e85203a | ||
|
|
62c822e834 | ||
|
|
8e9605a32c | ||
|
|
21fa0d7755 | ||
|
|
4c15b9e5e4 | ||
|
|
6b8de2a757 | ||
|
|
07d4c36652 | ||
|
|
97c0c6cc77 | ||
|
|
48fafd9fc0 | ||
|
|
722c49cd6f | ||
|
|
c810d761f7 | ||
|
|
d4443e43d6 | ||
|
|
a761a7acbc | ||
|
|
c059675bcc | ||
|
|
073d2f1e6a | ||
|
|
3f0c77cfd5 | ||
|
|
dfdefcf367 | ||
|
|
045226f160 | ||
|
|
29b96f4408 | ||
|
|
a4181459b9 | ||
|
|
e39558f837 | ||
|
|
bc962fe7d8 | ||
|
|
fbabb1eb26 | ||
|
|
bd31986ad6 | ||
|
|
3fab69e3c9 | ||
|
|
c8eee7ffcb | ||
|
|
adde25120c | ||
|
|
39631db0bd | ||
|
|
6b1aa4ce01 | ||
|
|
a99186fe0a | ||
|
|
5c2e75823a | ||
|
|
d8dfc33b8b | ||
|
|
305e293d46 | ||
|
|
8cade08de0 | ||
|
|
922fa53401 | ||
|
|
828ee760c2 | ||
|
|
cc1cb8150a | ||
|
|
73419cb374 | ||
|
|
7cf5f51ca2 | ||
|
|
f9f05e3f75 | ||
|
|
eac51ba189 | ||
|
|
56436f46fe | ||
|
|
34967978c2 | ||
|
|
b35c0d8607 | ||
|
|
a6efa48883 | ||
|
|
12832af98e | ||
|
|
f8d06f20aa | ||
|
|
143367c5ca | ||
|
|
592daf4ce2 | ||
|
|
82c219a2e7 | ||
|
|
590dd6cf80 | ||
|
|
8f1959bbc4 | ||
|
|
8a017b5a2a | ||
|
|
96724af03e | ||
|
|
4493f2a58b | ||
|
|
93169f60c3 | ||
|
|
7b255baac2 | ||
|
|
188bc71713 | ||
|
|
897cdbb427 | ||
|
|
ec84bec6d6 | ||
|
|
819491b99c | ||
|
|
00a1d70e8f | ||
|
|
66c39d3bf9 | ||
|
|
e25c4af590 | ||
|
|
1a592c5757 | ||
|
|
a54906c78a | ||
|
|
56546a28fd | ||
|
|
c0c1185c56 | ||
|
|
c2b240e9b5 | ||
|
|
da65e94728 | ||
|
|
2b28f9fd57 | ||
|
|
026f8280e0 | ||
|
|
33cb629079 | ||
|
|
f904a7201e |
@@ -3,6 +3,7 @@ engines:
|
||||
enabled: false
|
||||
rubocop:
|
||||
enabled: true
|
||||
channel: rubocop-0-54
|
||||
|
||||
exclude_paths:
|
||||
- .codeclimate.yml
|
||||
@@ -28,6 +29,8 @@ exclude_paths:
|
||||
- test/**/*
|
||||
- vendor/**/*
|
||||
|
||||
- lib/jekyll/commands/serve/livereload_assets/livereload.js
|
||||
|
||||
ratings:
|
||||
paths:
|
||||
- lib/**/*.rb
|
||||
|
||||
86
.github/CODEOWNERS
vendored
Normal file
86
.github/CODEOWNERS
vendored
Normal file
@@ -0,0 +1,86 @@
|
||||
# The Jekyll project has 6 affinity teams, shown here: https://teams.jekyllrb.com/
|
||||
# They are as follows:
|
||||
#
|
||||
# 1. @jekyll/build
|
||||
# 2. @jekyll/documentation
|
||||
# 3. @jekyll/ecosystem
|
||||
# 4. @jekyll/performance
|
||||
# 5. @jekyll/stability
|
||||
# 6. @jekyll/windows
|
||||
#
|
||||
# Each of these teams has a mission. Wherever possible, GitHub should
|
||||
# automatically require review from these teams on the pieces of the
|
||||
# repository they maintain.
|
||||
|
||||
# @jekyll/documentation
|
||||
/docs/ @jekyll/documentation
|
||||
|
||||
# @jekyll/build
|
||||
/exe/ @jekyll/build
|
||||
/lib/jekyll.rb @jekyll/build
|
||||
/lib/jekyll/cleaner.rb @jekyll/build
|
||||
/lib/jekyll/collection.rb @jekyll/build
|
||||
/lib/jekyll/command.rb @jekyll/build
|
||||
/lib/jekyll/commands/ @jekyll/build
|
||||
/lib/jekyll/converter.rb @jekyll/build
|
||||
/lib/jekyll/converters/ @jekyll/build
|
||||
/lib/jekyll/convertible.rb @jekyll/build
|
||||
/lib/jekyll/document.rb @jekyll/build
|
||||
/lib/jekyll/drops/ @jekyll/build
|
||||
/lib/jekyll/entry_filter.rb @jekyll/build
|
||||
/lib/jekyll/errors.rb @jekyll/build
|
||||
/lib/jekyll/excerpt.rb @jekyll/build
|
||||
/lib/jekyll/filters/ @jekyll/build
|
||||
/lib/jekyll/filters.rb @jekyll/build
|
||||
/lib/jekyll/layout.rb @jekyll/build
|
||||
/lib/jekyll/liquid_extensions.rb @jekyll/build
|
||||
/lib/jekyll/liquid_renderer/ @jekyll/build
|
||||
/lib/jekyll/liquid_renderer.rb @jekyll/build
|
||||
/lib/jekyll/log_adapter.rb @jekyll/build
|
||||
/lib/jekyll/mime.types @jekyll/build
|
||||
/lib/jekyll/page.rb @jekyll/build
|
||||
/lib/jekyll/publisher.rb @jekyll/build
|
||||
/lib/jekyll/reader.rb @jekyll/build
|
||||
/lib/jekyll/readers/ @jekyll/build
|
||||
/lib/jekyll/regenerator.rb @jekyll/build
|
||||
/lib/jekyll/related_posts.rb @jekyll/build
|
||||
/lib/jekyll/renderer.rb @jekyll/build
|
||||
/lib/jekyll/site.rb @jekyll/build
|
||||
/lib/jekyll/static_file.rb @jekyll/build
|
||||
/lib/jekyll/stevenson.rb @jekyll/build
|
||||
/lib/jekyll/tags/ @jekyll/build
|
||||
/lib/jekyll/url.rb @jekyll/build
|
||||
/lib/jekyll/utils/ @jekyll/build
|
||||
/lib/jekyll/utils.rb @jekyll/build
|
||||
|
||||
# @jekyll/ecosystem
|
||||
/lib/jekyll/external.rb @jekyll/ecosystem
|
||||
/lib/jekyll/generator.rb @jekyll/ecosystem
|
||||
/lib/jekyll/hooks.rb @jekyll/ecosystem
|
||||
/lib/jekyll/plugin.rb @jekyll/ecosystem
|
||||
/lib/jekyll/plugin_manager.rb @jekyll/ecosystem
|
||||
/lib/jekyll/theme.rb @jekyll/ecosystem
|
||||
/lib/jekyll/theme_builder.rb @jekyll/ecosystem
|
||||
|
||||
# @jekyll/stability
|
||||
Gemfile @jekyll/stability
|
||||
*.gemspec @jekyll/stability
|
||||
.travis.yml @jekyll/stability
|
||||
appveyor.yml @jekyll/stability
|
||||
/lib/jekyll/configuration.rb @jekyll/stability
|
||||
/lib/jekyll/deprecator.rb @jekyll/stability
|
||||
/lib/jekyll/frontmatter_defaults.rb @jekyll/stability
|
||||
/lib/site_template @jekyll/stability
|
||||
/lib/theme_template @jekyll/stability
|
||||
/features/ @jekyll/stability
|
||||
/test/ @jekyll/stability
|
||||
|
||||
# Special cases
|
||||
.github/ @jekyll/affinity-team-captains
|
||||
CODE_OF_CONDUCT.markdown @jekyll/affinity-team-captains
|
||||
History.markdown @jekyll/affinity-team-captains
|
||||
LICENSE @jekyll/affinity-team-captains # This file should never change.
|
||||
README.markdown @jekyll/affinity-team-captains
|
||||
/lib/jekyll/version.rb @jekyll/affinity-team-captains
|
||||
/rake/ @jekyll/affinity-team-captains
|
||||
/script/ @jekyll/affinity-team-captains
|
||||
25
.github/CONTRIBUTING.markdown
vendored
25
.github/CONTRIBUTING.markdown
vendored
@@ -4,10 +4,7 @@ Hi there! Interested in contributing to Jekyll? We'd love your help. Jekyll is a
|
||||
|
||||
## Where to get help or report a problem
|
||||
|
||||
* If you have a question about using Jekyll, start a discussion on [Jekyll Talk](https://talk.jekyllrb.com).
|
||||
* If you think you've found a bug within a Jekyll plugin, open an issue in that plugin's repository.
|
||||
* If you think you've found a bug within Jekyll itself, [open an issue](https://github.com/jekyll/jekyll/issues/new).
|
||||
* More resources are listed on our [Help page](https://jekyllrb.com/help/).
|
||||
See [the support guidelines](https://jekyllrb.com/docs/support/)
|
||||
|
||||
## Ways to contribute
|
||||
|
||||
@@ -114,25 +111,37 @@ If your contribution changes any Jekyll behavior, make sure to update the docume
|
||||
|
||||
* Don't bump the Gem version in your pull request (if you don't know what that means, you probably didn't).
|
||||
|
||||
* You can use the command `script/console` to start a REPL to explore the result of
|
||||
Jekyll's methods. It also provides you with helpful methods to quickly create a
|
||||
site or configuration. [Feel free to check it out!](https://github.com/jekyll/jekyll/blob/master/script/console)
|
||||
|
||||
## Running tests locally
|
||||
|
||||
### Test Dependencies
|
||||
|
||||
To run the test suite and build the gem you'll need to install Jekyll's dependencies by running the following command:
|
||||
|
||||
<pre class="highlight"><code>$ script/bootstrap</code></pre>
|
||||
```sh
|
||||
script/bootstrap
|
||||
```
|
||||
|
||||
Before you make any changes, run the tests and make sure that they pass (to confirm your environment is configured properly):
|
||||
|
||||
<pre class="highlight"><code>$ script/cibuild</code></pre>
|
||||
```sh
|
||||
script/cibuild
|
||||
```
|
||||
|
||||
If you are only updating a file in `test/`, you can use the command:
|
||||
|
||||
<pre class="highlight"><code>$ script/test test/blah_test.rb</code></pre>
|
||||
```sh
|
||||
script/test test/blah_test.rb
|
||||
```
|
||||
|
||||
If you are only updating a `.feature` file, you can use the command:
|
||||
|
||||
<pre class="highlight"><code>$ script/cucumber features/blah.feature</code></pre>
|
||||
```sh
|
||||
script/cucumber features/blah.feature
|
||||
```
|
||||
|
||||
Both `script/test` and `script/cucumber` can be run without arguments to
|
||||
run its entire respective suite.
|
||||
|
||||
7
.github/ISSUE_TEMPLATE.md
vendored
7
.github/ISSUE_TEMPLATE.md
vendored
@@ -10,9 +10,6 @@
|
||||
a generic usage question, please consider asking your question at
|
||||
https://talk.jekyllrb.com where non-bug questions go.
|
||||
|
||||
Please make sure to mention an affinity team whose responsibilities
|
||||
most closely align with your issue.
|
||||
|
||||
Thanks!
|
||||
-->
|
||||
|
||||
@@ -51,7 +48,7 @@
|
||||
## My Reproduction Steps
|
||||
|
||||
<!--
|
||||
If this error occured on GitHub Pages, please try to provide us with logs,
|
||||
If this error occurred on GitHub Pages, please try to provide us with logs,
|
||||
and look at them yourself, to determine if this is an actual Jekyll bug. In
|
||||
the event you are unsure, file a ticket, however, when you do please provide
|
||||
the logs (strip them of personal information.)
|
||||
@@ -79,5 +76,3 @@
|
||||
The minimum should be personal information. Though we normally don't log
|
||||
anything like that so there should be no need to alter it.
|
||||
-->
|
||||
|
||||
/cc include any Jekyll affinity teams here (see https://teams.jekyllrb.com/ for more info)
|
||||
|
||||
20
.github/SUPPORT.markdown
vendored
Normal file
20
.github/SUPPORT.markdown
vendored
Normal file
@@ -0,0 +1,20 @@
|
||||
# Jekyll Support
|
||||
|
||||
## Getting Help
|
||||
|
||||
**Jekyll's issue tracker is not a support forum.**
|
||||
|
||||
If you're looking for support for Jekyll, there are a lot of options:
|
||||
|
||||
* Read [Jekyll Documentation](https://jekyllrb.com/docs/home/)
|
||||
* If you have a question about using Jekyll, start a discussion on [Jekyll Forum](https://talk.jekyllrb.com/) or [StackOverflow](https://stackoverflow.com/questions/tagged/jekyll)
|
||||
* Chat with Jekyllers — Join [our Gitter channel](https://gitter.im/jekyll/jekyll) or [our IRC channel on Freenode](irc:irc.freenode.net/jekyll)
|
||||
|
||||
There are a bunch of helpful community members on these services that should be willing to point you in the right direction.
|
||||
|
||||
## Report a bug
|
||||
|
||||
* If you think you've found a bug within a Jekyll plugin, open an issue in that plugin's repository — First [look for the plugin on rubygems](https://rubygems.org/) then click on the `Homepage` link to access the plugin repository.
|
||||
* If you think you've found a bug within Jekyll itself, [open an issue](https://github.com/jekyll/jekyll/issues/new).
|
||||
|
||||
Happy Jekyllin'!
|
||||
44
.github/first-timers-issue-template.md
vendored
Normal file
44
.github/first-timers-issue-template.md
vendored
Normal file
@@ -0,0 +1,44 @@
|
||||
### 🆕🐥☝ First Timers Only.
|
||||
|
||||
This issue is reserved for people who never contributed to Open Source before. We know that the process of creating a pull request is the biggest barrier for new contributors. This issue is for you 💝
|
||||
|
||||
[About First Timers Only](http://www.firsttimersonly.com/).
|
||||
|
||||
### 🤔 What you will need to know.
|
||||
|
||||
Nothing. This issue is meant to welcome you to Open Source :) We are happy to walk you through the process.
|
||||
|
||||
### 📋 Step by Step
|
||||
|
||||
- [ ] 👌 **Join the team**: Add yourself to a Jekyll affinity team.
|
||||
|
||||
Go to [teams.jekyllrb.com](https://teams.jekyllrb.com/) and join a team that best fits your interests. Once you click the link to join a team, you will soon receive an email inviting you to join the Jekyll organization.
|
||||
|
||||
- [ ] 🙋 **Claim this issue**: Comment below.
|
||||
|
||||
Leave a comment that you have claimed this issue.
|
||||
|
||||
- [ ] 📝 **Update** the file [$FILENAME]($BRANCH_URL) in the `$REPO` repository (press the little pen Icon) and edit the line as shown below.
|
||||
|
||||
|
||||
```diff
|
||||
$DIFF
|
||||
```
|
||||
|
||||
|
||||
- [ ] 💾 **Commit** your changes
|
||||
|
||||
- [ ] 🔀 **Start a Pull Request**. There are two ways how you can start a pull request:
|
||||
|
||||
1. If you are familiar with the terminal or would like to learn it, [here is a great tutorial](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github) on how to send a pull request using the terminal.
|
||||
|
||||
2. You can [edit files directly in your browser](https://help.github.com/articles/editing-files-in-your-repository/)
|
||||
|
||||
- [ ] 🏁 **Done** Ask in comments for a review :)
|
||||
|
||||
### 🤔❓ Questions
|
||||
|
||||
Leave a comment below!
|
||||
|
||||
|
||||
This issue was created by [First-Timers-Bot](https://github.com/hoodiehq/first-timers-bot).
|
||||
6
.github/first-timers.yml
vendored
Normal file
6
.github/first-timers.yml
vendored
Normal file
@@ -0,0 +1,6 @@
|
||||
repository: jekyll
|
||||
labels:
|
||||
- good first issue
|
||||
- help-wanted
|
||||
- first-time-only
|
||||
template: .github/first-timers-issue-template.md
|
||||
64
.rubocop.yml
64
.rubocop.yml
@@ -1,6 +1,14 @@
|
||||
---
|
||||
|
||||
require:
|
||||
- ./rubocop/jekyll
|
||||
|
||||
Jekyll/NoPutsAllowed:
|
||||
Exclude:
|
||||
- rake/*.rake
|
||||
|
||||
AllCops:
|
||||
TargetRubyVersion: 2.0
|
||||
TargetRubyVersion: 2.3
|
||||
Include:
|
||||
- lib/**/*.rb
|
||||
Exclude:
|
||||
@@ -9,6 +17,7 @@ AllCops:
|
||||
- benchmark/**/*
|
||||
- script/**/*
|
||||
- vendor/**/*
|
||||
- tmp/**/*
|
||||
Layout/AlignArray:
|
||||
Enabled: false
|
||||
Layout/AlignHash:
|
||||
@@ -20,7 +29,7 @@ Layout/EmptyLinesAroundAccessModifier:
|
||||
Layout/EmptyLinesAroundModuleBody:
|
||||
Enabled: false
|
||||
Layout/EndOfLine:
|
||||
EnforcedStyle: lf
|
||||
EnforcedStyle: native
|
||||
Layout/ExtraSpacing:
|
||||
AllowForAlignment: true
|
||||
Layout/FirstParameterIndentation:
|
||||
@@ -37,16 +46,21 @@ Layout/MultilineMethodCallIndentation:
|
||||
EnforcedStyle: indented
|
||||
Layout/MultilineOperationIndentation:
|
||||
EnforcedStyle: indented
|
||||
Layout/SpaceAroundOperators:
|
||||
Enabled: true
|
||||
Layout/SpaceInsideBrackets:
|
||||
Lint/NestedPercentLiteral:
|
||||
Exclude:
|
||||
- test/test_site.rb
|
||||
Layout/EmptyComment:
|
||||
Enabled: false
|
||||
Lint/EndAlignment:
|
||||
Layout/EndAlignment:
|
||||
Severity: error
|
||||
Lint/UnneededRequireStatement:
|
||||
Enabled: false
|
||||
Lint/UnreachableCode:
|
||||
Severity: error
|
||||
Lint/UselessAccessModifier:
|
||||
Enabled: false
|
||||
Lint/Void:
|
||||
Enabled: false
|
||||
Metrics/AbcSize:
|
||||
Max: 21
|
||||
Metrics/BlockLength:
|
||||
@@ -81,6 +95,20 @@ Metrics/ParameterLists:
|
||||
Max: 4
|
||||
Metrics/PerceivedComplexity:
|
||||
Max: 8
|
||||
Naming/FileName:
|
||||
Enabled: false
|
||||
Naming/HeredocDelimiterNaming:
|
||||
Enabled: false
|
||||
Naming/MemoizedInstanceVariableName:
|
||||
Exclude:
|
||||
- lib/jekyll/page_without_a_file.rb
|
||||
- lib/jekyll/drops/unified_payload_drop.rb
|
||||
- lib/jekyll/drops/site_drop.rb
|
||||
Naming/UncommunicativeMethodParamName:
|
||||
AllowedNames:
|
||||
- _
|
||||
Performance/UnfreezeString:
|
||||
Enabled: false
|
||||
Security/MarshalLoad:
|
||||
Exclude:
|
||||
- !ruby/regexp /test\/.*.rb$/
|
||||
@@ -93,20 +121,21 @@ Style/Alias:
|
||||
Enabled: false
|
||||
Style/AndOr:
|
||||
Severity: error
|
||||
Style/Attr:
|
||||
Enabled: false
|
||||
Style/BracesAroundHashParameters:
|
||||
Enabled: false
|
||||
Style/ClassAndModuleChildren:
|
||||
Enabled: false
|
||||
Style/FrozenStringLiteralComment:
|
||||
EnforcedStyle: always
|
||||
Style/Documentation:
|
||||
Enabled: false
|
||||
Exclude:
|
||||
- !ruby/regexp /features\/.*.rb$/
|
||||
Style/DoubleNegation:
|
||||
Enabled: false
|
||||
Style/FileName:
|
||||
Enabled: false
|
||||
Style/FormatStringToken:
|
||||
Exclude:
|
||||
- lib/jekyll/utils/ansi.rb
|
||||
Style/GuardClause:
|
||||
Enabled: false
|
||||
Style/HashSyntax:
|
||||
@@ -116,10 +145,15 @@ Style/IfUnlessModifier:
|
||||
Enabled: false
|
||||
Style/InverseMethods:
|
||||
Enabled: false
|
||||
Style/MixinUsage:
|
||||
Exclude:
|
||||
- test/helper.rb
|
||||
Style/ModuleFunction:
|
||||
Enabled: false
|
||||
Style/MultilineTernaryOperator:
|
||||
Severity: error
|
||||
Style/NumericPredicate:
|
||||
Enabled: false
|
||||
Style/PercentLiteralDelimiters:
|
||||
PreferredDelimiters:
|
||||
"%q": "{}"
|
||||
@@ -129,6 +163,8 @@ Style/PercentLiteralDelimiters:
|
||||
"%w": "()"
|
||||
"%W": "()"
|
||||
"%x": "()"
|
||||
Style/RedundantFreeze:
|
||||
Enabled: false
|
||||
Style/RedundantReturn:
|
||||
Enabled: false
|
||||
Style/RedundantSelf:
|
||||
@@ -137,6 +173,8 @@ Style/RegexpLiteral:
|
||||
EnforcedStyle: percent_r
|
||||
Style/RescueModifier:
|
||||
Enabled: false
|
||||
Style/SafeNavigation:
|
||||
Enabled: false
|
||||
Style/SignalException:
|
||||
EnforcedStyle: only_raise
|
||||
Style/SingleLineMethods:
|
||||
@@ -147,7 +185,7 @@ Style/StringLiteralsInInterpolation:
|
||||
EnforcedStyle: double_quotes
|
||||
Style/SymbolArray:
|
||||
Enabled: false
|
||||
Style/TrailingCommaInLiteral:
|
||||
Style/TrailingCommaInArrayLiteral:
|
||||
EnforcedStyleForMultiline: consistent_comma
|
||||
Style/TrailingCommaInHashLiteral:
|
||||
EnforcedStyleForMultiline: consistent_comma
|
||||
Style/UnneededCapitalW:
|
||||
Enabled: false
|
||||
|
||||
12
.travis.yml
12
.travis.yml
@@ -5,11 +5,10 @@ language: ruby
|
||||
sudo: false
|
||||
|
||||
rvm:
|
||||
- &ruby1 2.4.1
|
||||
- &ruby2 2.3.4
|
||||
- &ruby3 2.2.7
|
||||
- &ruby4 2.1.10
|
||||
- &jruby jruby-9.1.7.0
|
||||
- &ruby1 2.5.1
|
||||
- &ruby2 2.4.4
|
||||
- &ruby3 2.3.7
|
||||
- &jruby jruby-9.1.16.0
|
||||
|
||||
matrix:
|
||||
include:
|
||||
@@ -17,8 +16,6 @@ matrix:
|
||||
env: TEST_SUITE=fmt
|
||||
- rvm: *ruby1
|
||||
env: TEST_SUITE=default-site
|
||||
- rvm: *ruby1
|
||||
env: ROUGE_VERSION=1.11.1 # runs everything with this version
|
||||
exclude:
|
||||
- rvm: *jruby
|
||||
env: TEST_SUITE=cucumber
|
||||
@@ -55,3 +52,4 @@ after_success:
|
||||
|
||||
before_install:
|
||||
- gem update --system
|
||||
- gem install bundler
|
||||
|
||||
33
Gemfile
33
Gemfile
@@ -1,11 +1,10 @@
|
||||
# frozen_string_literal: true
|
||||
|
||||
source "https://rubygems.org"
|
||||
gemspec :name => "jekyll"
|
||||
|
||||
gem "rake", "~> 12.0"
|
||||
|
||||
# Dependency of jekyll-mentions. RubyGems in Ruby 2.1 doesn't shield us from this.
|
||||
gem "activesupport", "~> 4.2", :groups => [:test_legacy, :site] if RUBY_VERSION < "2.2.2"
|
||||
|
||||
group :development do
|
||||
gem "launchy", "~> 2.3"
|
||||
gem "pry"
|
||||
@@ -19,16 +18,16 @@ end
|
||||
|
||||
group :test do
|
||||
gem "codeclimate-test-reporter", "~> 1.0.5"
|
||||
gem "cucumber", "~> 2.1"
|
||||
gem "cucumber", "~> 3.0"
|
||||
gem "httpclient"
|
||||
gem "jekyll_test_plugin"
|
||||
gem "jekyll_test_plugin_malicious"
|
||||
# nokogiri v1.8 does not work with ruby 2.1 and below
|
||||
gem "nokogiri", RUBY_VERSION >= "2.2" ? "~> 1.7" : "~> 1.7.0"
|
||||
gem "nokogiri", "~> 1.7"
|
||||
gem "rspec"
|
||||
gem "rspec-mocks"
|
||||
gem "rubocop", "~> 0.49.1"
|
||||
gem "test-dependency-theme", :path => File.expand_path("./test/fixtures/test-dependency-theme", File.dirname(__FILE__))
|
||||
gem "test-theme", :path => File.expand_path("./test/fixtures/test-theme", File.dirname(__FILE__))
|
||||
gem "rubocop", "~> 0.55.0"
|
||||
gem "test-dependency-theme", :path => File.expand_path("test/fixtures/test-dependency-theme", __dir__)
|
||||
gem "test-theme", :path => File.expand_path("test/fixtures/test-theme", __dir__)
|
||||
|
||||
gem "jruby-openssl" if RUBY_ENGINE == "jruby"
|
||||
end
|
||||
@@ -36,14 +35,13 @@ end
|
||||
#
|
||||
|
||||
group :test_legacy do
|
||||
if RUBY_PLATFORM =~ %r!cygwin! || RUBY_VERSION.start_with?("2.2")
|
||||
if RUBY_PLATFORM =~ %r!cygwin!
|
||||
gem "test-unit"
|
||||
end
|
||||
|
||||
gem "minitest"
|
||||
gem "minitest-profile"
|
||||
gem "minitest-reporters"
|
||||
gem "redgreen"
|
||||
gem "shoulda"
|
||||
gem "simplecov"
|
||||
end
|
||||
@@ -69,18 +67,17 @@ group :jekyll_optional_dependencies do
|
||||
gem "jekyll-gist"
|
||||
gem "jekyll-paginate"
|
||||
gem "jekyll-redirect-from"
|
||||
gem "kramdown", "~> 1.9"
|
||||
gem "kramdown", "~> 1.14"
|
||||
gem "mime-types", "~> 3.0"
|
||||
gem "rdoc", "~> 5.0"
|
||||
gem "toml", "~> 0.1.0"
|
||||
gem "rdoc", "~> 6.0"
|
||||
gem "tomlrb", "~> 1.2"
|
||||
|
||||
platform :ruby, :mswin, :mingw, :x64_mingw do
|
||||
gem "classifier-reborn", "~> 2.1.0"
|
||||
gem "classifier-reborn", "~> 2.2.0"
|
||||
gem "liquid-c", "~> 3.0"
|
||||
gem "pygments.rb", "~> 0.6.0"
|
||||
gem "pygments.rb", "~> 1.0"
|
||||
gem "rdiscount", "~> 2.0"
|
||||
gem "redcarpet", "~> 3.2", ">= 3.2.3"
|
||||
gem "yajl-ruby", "~> 1.2"
|
||||
gem "yajl-ruby", "~> 1.3"
|
||||
end
|
||||
|
||||
# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
|
||||
|
||||
450
History.markdown
450
History.markdown
@@ -1,3 +1,421 @@
|
||||
## HEAD
|
||||
|
||||
### Documentation
|
||||
|
||||
* Release post for v3.8.0 (#6849)
|
||||
* Add Installation Instructions for Ubuntu (#6925)
|
||||
* add liquid tag jekyll-flickr (#6946)
|
||||
* Add 4.0 development post (#6934)
|
||||
* Updated copy - fixed casing of SaaS on resources page. (#6949)
|
||||
* WIP: Do not advise users to install Jekyll outside of Bundler (#6927)
|
||||
* Don't prompt for sudo when installing with Ubuntu WSL (#6781)
|
||||
* Fix typo (#6969)
|
||||
* Add version number for group_by_exp doc (#6956)
|
||||
* Update Windows install docs (#6926)
|
||||
* Remove documentation for using Redcarpet (#6990)
|
||||
|
||||
### Minor Enhancements
|
||||
|
||||
* use jekyll-compose if installed (#6932)
|
||||
* Memoize computing excerpt's relative_path (#6951)
|
||||
* Liquefied link tag (#6269)
|
||||
* Suggest re-running command with --trace on fail (#6551)
|
||||
|
||||
### Major Enhancements
|
||||
|
||||
* Remove unused error class (#6511)
|
||||
* Drop support for Ruby 2.1 and 2.2 (#6560)
|
||||
* Add vendor folder to a newly installed site's .gitignore (#6968)
|
||||
* bump i18n (#6931)
|
||||
* We are not using Ruby 2.2 anymore (#6977)
|
||||
* Drop support for older versions of Rouge (#6978)
|
||||
* Remove support for Redcarpet (#6987)
|
||||
|
||||
### Development Fixes
|
||||
|
||||
* Remove unnecessary Jekyll::Page constant (#6770)
|
||||
* Loggers should accept both numbers and symbols (#6967)
|
||||
* Update instructions for releasing docs Gem (#6975)
|
||||
* yajl-ruby update to v1.4.0 (#6976)
|
||||
|
||||
## 3.8.1 / 2018-05-01
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* Fix rendering Liquid constructs in excerpts (#6945)
|
||||
* Liquify documents unless published == false (#6959)
|
||||
|
||||
## 3.8.0 / 2018-04-19
|
||||
|
||||
### Development Fixes
|
||||
|
||||
* move duplicate code to a single private method (#6593)
|
||||
* Test against Ruby 2.5 on AppVeyor (#6668)
|
||||
* Replace simple regex with a native Ruby method (#6732)
|
||||
* Codeclimate: exclude livereload.js (#6776)
|
||||
* Add a cucumber feature to test link tag (#6777)
|
||||
* Fix theme gem feature (#6784)
|
||||
* Replace simple regex with equivalent Ruby methods (#6736)
|
||||
* Rewrite `script/rubyprof` as a Ruby script (#6813)
|
||||
* Add debug output to theme rendering (#5195)
|
||||
* fix minitest deprecation warning in test (#6839)
|
||||
* Memoize `Site#site_data` (#6809)
|
||||
* Memoize document output extension (#6814)
|
||||
* Access document permalink attribute efficiently (#6740)
|
||||
* Minimize array allocations in the `where` filter (#6860)
|
||||
* Bump JRuby (#6878)
|
||||
* Assert existence of <collection>.files (#6907)
|
||||
* Bump Rubocop to 0.54.x (#6915)
|
||||
* Regenerate unconditionally unless its an incremental build (#6917)
|
||||
* Centralize require statements (#6910)
|
||||
* Bump to Rubocop 0.55 (#6929)
|
||||
* Refactor private method `HighlightBlock#parse_options` (#6822)
|
||||
|
||||
### Minor Enhancements
|
||||
|
||||
* Two massive performance improvements for large sites (#6730)
|
||||
* Cache the list of documents to be written (#6741)
|
||||
* Allow Jekyll Doctor to detect stray posts dir (#6681)
|
||||
* Excerpt relative-path should match its path (#6597)
|
||||
* Remind user to resolve conflict in `jekyll new` with `--force` (#6801)
|
||||
* Memoize helper methods in site-cleaner (#6808)
|
||||
* Compute document's relative_path faster (#6767)
|
||||
* Create a single instance of PostReader per site (#6759)
|
||||
* Allow date filters to output ordinal days (#6773)
|
||||
* Change regex to sanitize and normalize filenames passed to LiquidRenderer (#6610)
|
||||
* Allow passing :strict_variables and :strict_filters options to Liquid's renderer (#6726)
|
||||
* Debug writing files during the build process (#6696)
|
||||
* Improve regex usage in `Tags::IncludeTag` (#6848)
|
||||
* Improve comment included in the starter index.md (#6916)
|
||||
* Store and retrieve converter instances for Jekyll::Filters via a hash (#6856)
|
||||
* Implement a cache within the `where` filter (#6868)
|
||||
* Store regexp in a constant (#6887)
|
||||
* Optimize computing filename in LiquidRenderer (#6841)
|
||||
|
||||
### Documentation
|
||||
|
||||
* Adding the jekyll-algolia plugin to the list of plugins (#6737)
|
||||
* Added Premonition plugin to list of plugins (#6750)
|
||||
* Add document on releasing a new version (#6745)
|
||||
* Mention Talkyard, a new commenting system for Jekyll and others. (#6752)
|
||||
* Add 'jekyll-fontello' to plugins (#6757)
|
||||
* Install dh-autoreconf on Windows (#6765)
|
||||
* Fix common typos (#6764)
|
||||
* Fix documentation for `{{ page.excerpt }}` (#6779)
|
||||
* Update docs on permalink configuration (#6775)
|
||||
* Propose fix some typos (#6785)
|
||||
* Say hello to Jekyll's New Lead Developer (#6790)
|
||||
* Add reference to Liquid to plugin docs (#6794)
|
||||
* Draft a release post for v3.7.3 (#6803)
|
||||
* add missing step for gem-based theme conversion (#6802)
|
||||
* Update windows.md to explain an issue with jekyll new. (#6838)
|
||||
* Add Bundler Installation Instructions (#6828)
|
||||
* Docs: describe difference between tags and categories (#6882)
|
||||
* Add `jekyll-random` plugin to docs (#6833)
|
||||
* Fixed typo in description of categories and tags (#6896)
|
||||
* Add missing ul-tag (#6897)
|
||||
* doc: add liquid tag plugin jekyll-onebox for html previews (#6898)
|
||||
* Add `jekyll-w2m` to plugins (#6855)
|
||||
* Fix tutorials navigation HTML (#6919)
|
||||
* add Arch Linux instalation troubleshoot (#6782)
|
||||
* Docs: Install Jekyll on macOS (#6881)
|
||||
* Fix CodeClimate badges [ci skip] (#6930)
|
||||
* Update index.md (#6933)
|
||||
|
||||
### Site Enhancements
|
||||
|
||||
* Remove links to Gists (#6751)
|
||||
* Always load Google Fonts over HTTPS (#6792)
|
||||
* always load analytics.js over HTTPS (#6807)
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* Append appropriate closing tag to Liquid block in an excerpt ### -minor (#6724)
|
||||
* Bypass rendering via Liquid unless required (#6735)
|
||||
* Delegated methods after `private` keyword are meant to be private (#6819)
|
||||
* Improve handling non-default collection documents rendering and writing (#6795)
|
||||
* Fix passing multiline params to include tag when using the variable syntax (#6858)
|
||||
* `include_relative` tag should find related documents in collections gathered within custom `collections_dir` (#6818)
|
||||
* Handle liquid tags in excerpts robustly (#6891)
|
||||
* Allow front matter defaults to be applied properly to documents gathered under custom `collections_dir` (#6885)
|
||||
|
||||
## 3.7.3 / 2018-02-25
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* Do not hardcode locale unless certainly necessary (#6791)
|
||||
|
||||
## 3.7.2 / 2018-01-25
|
||||
|
||||
### Development Fixes
|
||||
|
||||
* CI: Test against Ruby 2.5.0 (#6664)
|
||||
* Bump rdoc to 6.0 (#6600)
|
||||
* Lint file and bump theme dependencies (#6698)
|
||||
* Write a Rubocop Cop to ensure no `#p` or `#puts` calls get committed to master. (#6615)
|
||||
* Remove redgreen gem (#6720)
|
||||
|
||||
### Site Enhancements
|
||||
|
||||
* Display latest version in header (#6676)
|
||||
* Update version in `config.yml` via YAML load / dump (#6677)
|
||||
|
||||
### Documentation
|
||||
|
||||
* Fix: Add note about posts in context of collections_dir (#6680)
|
||||
* Update deploy-script in documentation (#6666)
|
||||
* Add note about naming of collections_dir (#6703)
|
||||
* Update installation.md (#6694)
|
||||
* Add `jekyll-html` to plugins. (#6654)
|
||||
* Update plugins.md (#6716)
|
||||
* Release v3.7.1 (#6695)
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* inform that symlinks are not allowed in safe mode (#6670)
|
||||
* Glob scope path only if configured with a pattern (#6692)
|
||||
* Add gem "wdm" to all newly generated Gemfiles (#6711)
|
||||
* Fix timezone inconsistencies between different ruby version (#6697)
|
||||
* Refactor collections_dir feature for consistency (#6685)
|
||||
|
||||
### Minor Enhancements
|
||||
|
||||
* Require external library only if necessary (#6596)
|
||||
|
||||
## 3.7.0 / 2018-01-02
|
||||
|
||||
### Minor Enhancements
|
||||
|
||||
* Add LiveReload functionality to Jekyll. (#5142)
|
||||
* Add Utils::Internet.connected? to determine whether host machine has internet connection. (#5870)
|
||||
* Disable default layouts for Pages with a `layout: none` declaration (#6182)
|
||||
* Scope path glob (#6268)
|
||||
* Allow the user to set collections_dir to put all collections under one subdirectory (#6331)
|
||||
* Upgrade to Rouge 3 (#6381)
|
||||
* Allow URL filters to work directly with documents (#6478)
|
||||
* filter relative_url should keep absolute urls with scheme/authority (#6490)
|
||||
* `.sass-cache` doesn't *always* land in `options['source']` (#6500)
|
||||
* Allow plugins to modify the obsolete files. (#6502)
|
||||
* Add latin mode to `slugify` (#6509)
|
||||
* Log Kramdown warnings if log level is WARN (#6522)
|
||||
* Add an option to configure kramdown warning output (#6554)
|
||||
* Add `json` extension to list of directory indices (#6550)
|
||||
* Dependency: Bump jekyll-watch to 2.0 (#6589)
|
||||
* Remove paginate check (#6606)
|
||||
* update classifier-reborn to 2.2.0 (#6631)
|
||||
* Switch to an actively-maintained TOML parser. (#6652)
|
||||
* Do not coerce layout paths in theme-gem to the source directory (#6603)
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* Raise when theme root directory is not available (#6455)
|
||||
* Avoid block parser warning in SmartyPants (#6565)
|
||||
* Fail gracefully if "sass" gem cannot be loaded (#6573)
|
||||
* return correct file in dir if dir has same name as file (#6569)
|
||||
* Register reload hooks in Server#process (#6605)
|
||||
* Memoize path to metadata file (#6602)
|
||||
* Use `require_relative` to load Jekyll classes (#6609)
|
||||
|
||||
### Development Fixes
|
||||
|
||||
* Added direct collection access to future collection item feature test(#6151)
|
||||
* add failing test for non-utf8 encoding (#6339)
|
||||
* Upgrade to Cucumber 3.0 (#6395)
|
||||
* Provide a better default hash for tracking liquid stats (#6417)
|
||||
* Add configuration for first-timers bot (#6431)
|
||||
* Do not linkify escaped characters as PRs in History (#6468)
|
||||
* Rely on jekyll-mentions for linking usernames (#6469)
|
||||
* Update first-timers-issue-template.md (#6472)
|
||||
* Enable `Lint/RescueWithoutErrorClass` Cop (#6482)
|
||||
* Clean up Rubocop config (#6495)
|
||||
* Use Gem to discover the location of bundler (#6499)
|
||||
* Remove unnecessary encoding comment (#6513)
|
||||
* Suggest using Rubocop to automatically fix errors (#6514)
|
||||
* Assert raising Psych::SyntaxError when`"strict_front_matter"=>true` (#6520)
|
||||
* Use Kernel#Array instead of explicit Array check (#6525)
|
||||
* RuboCop: Enable `Style/UnneededCapitalW` cop (#6526)
|
||||
* Refactor method to reduce ABC Metric size (#6529)
|
||||
* Remove parentheses around arguments to raise (#6532)
|
||||
* Use double-quotes around gem name (#6535)
|
||||
* Dependencies: upgrade to toml 0.2.0 (#6541)
|
||||
* Lock to cucumber 3.0.1 on Ruby 2.1 (#6546)
|
||||
* Bump JRuby version in Travis config (#6561)
|
||||
* Rescue from Psych::SyntaxError instead of SyntaxError after parsing YAML(#5828)
|
||||
* Drop forwarding to private methods by exposing those methods as public(#6577)
|
||||
* Upgrade pygments to v1.x (#5937)
|
||||
* Bump yajl-ruby (#6582)
|
||||
* Cleanup test_redcarpet.rb (#6584)
|
||||
* Add PageWithoutAFile class from jekyll plugins (#6556)
|
||||
* Cleanup LiveReloadReactor (#6607)
|
||||
|
||||
### Documentation
|
||||
|
||||
* Add formester to the list of saas form backend (#6059)
|
||||
* GitHub Pages instructions (#6384)
|
||||
* Improve documentation for theme-gem installation (#6387)
|
||||
* Fix diff syntax-highlighting (#6388)
|
||||
* Update instructions (#6396)
|
||||
* Fix code-block highlighting in docs (#6398)
|
||||
* Filtering Posts with categories, tags, or other variables (#6399)
|
||||
* Fixes formatting on pre-formatted text. (#6405)
|
||||
* Added new tutorial to tutorials section on docs (#6406)
|
||||
* Updates (#6407)
|
||||
* Fix `collections_dir` example (#6408)
|
||||
* Renaming duplicate of "Scenario 6" to "Scenario 7" (#6411)
|
||||
* Mark `collection_dir` as unreleased (#6412)
|
||||
* Fix link to SUPPORT (#6415)
|
||||
* Fix list appearance by adding missing `ol` tag (#6421)
|
||||
* Explain how to override output collection index page (#6424)
|
||||
* Added github-cards to the list of plugins (#6425)
|
||||
* CoC violation correspondants (#6429)
|
||||
* Add a note about Liquid and syntax highlighting (#6466)
|
||||
* Remove `sudo` from macOS troubleshooting instructions (#6486)
|
||||
* Add a note on `:jekyll_plugins` group in the docs (#6488)
|
||||
* Updated custom-404-page.md (#6489)
|
||||
* Fix a few minor issues in the docs (#6494)
|
||||
* Add jekyll-pwa-plugin (#6533)
|
||||
* Remove Jekyll-Smartify from plugins directory (#6548)
|
||||
* Updated Jekyll-Pug listing to include official website (#6555)
|
||||
* Remove link to severely outdated asset plugin (#6613)
|
||||
* Default time zone depends upon server (#6617)
|
||||
* Add `disqus-for-jekyll` to plugins. (#6618)
|
||||
* Update "Requirements" for Ruby version (#6623)
|
||||
* Fix: Update link to i18n_filter plugin (#6638)
|
||||
* Correct WordPress capitalization (#6645)
|
||||
* Add Tweetsert, Stickyposts, Paginate::Content (#6651)
|
||||
* Post: Jekyll 3.7.0 released (#6634)
|
||||
|
||||
### Site Enhancements
|
||||
|
||||
* Add special styling for code-blocks run in shell (#6389)
|
||||
* Add post about diversity (#6447)
|
||||
* Update list of files excluded from Docs site (#6457)
|
||||
* Update site History (#6460)
|
||||
* Add default twitter card image (#6476)
|
||||
* Update normalize.css to v7.0.0 (#6491)
|
||||
* Optimize images (#6519)
|
||||
* Back to original main navigation (#6544)
|
||||
* Styles: mobile-docs select element (#6545)
|
||||
* Search with DocSearch by @Algolia (#6557)
|
||||
* Site header redesign (#6567)
|
||||
* Move logo above site navigation on small screens (#6570)
|
||||
* Docs: Include version badge for latest features (#6574)
|
||||
* Use version-badge on an existing feature intro (#6575)
|
||||
* Add jekyll-category-pages plugin (#6632)
|
||||
* Improve docs styling for code to be run in shell (#6641)
|
||||
* Fix permalink icon markup in news-item layout (#6639)
|
||||
|
||||
## 3.6.2 / 2017-10-21
|
||||
|
||||
### Development Fixes
|
||||
|
||||
* Update Rubocop to 0.51.0 (#6444)
|
||||
* Add test for layout as string (#6445)
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* Problematic UTF+bom files (#6322)
|
||||
* Always treat `data.layout` as a string (#6442)
|
||||
|
||||
## 3.6.1 / 2017-10-20
|
||||
|
||||
### Documentation
|
||||
|
||||
* Doc y_day in docs/permalinks (#6244)
|
||||
* Update frontmatter.md (#6371)
|
||||
* Elaborate on excluding items from processing (#6136)
|
||||
* Style lists in tables (#6379)
|
||||
* Remove duplicate "available" (#6380)
|
||||
|
||||
### Development Fixes
|
||||
|
||||
* Bump rubocop to use `v0.50.x` (#6368)
|
||||
|
||||
## 3.6.0 / 2017-09-21
|
||||
|
||||
### Minor Enhancements
|
||||
|
||||
* Ignore final newline in folded YAML string (#6054)
|
||||
* Add URL checks to Doctor (#5760)
|
||||
* Fix serving files that clash with directories (#6222) (#6231)
|
||||
* Bump supported Ruby version to `>= 2.1.0` (#6220)
|
||||
* set `LiquidError#template_name` for errors in included file (#6206)
|
||||
* Access custom config array throughout session (#6200)
|
||||
* Add support for Rouge 2, in addition to Rouge 1 (#5919)
|
||||
* Allow `yield` to logger methods & bail early on no-op messages (#6315)
|
||||
* Update mime-types. (#6336)
|
||||
* Use a Schwartzian transform with custom sorting (#6342)
|
||||
* Alias `Drop#invoke_drop` to `Drop#[]` (#6338)
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* `Deprecator`: fix typo for `--serve` command (#6229)
|
||||
* `Reader#read_directories`: guard against an entry not being a directory (#6226)
|
||||
* kramdown: symbolize keys in-place (#6247)
|
||||
* Call `to_s` on site.url before attempting to concatenate strings (#6253)
|
||||
* Enforce Style/FrozenStringLiteralComment (#6265)
|
||||
* Update theme-template README to note 'assets' directory (#6257)
|
||||
* Memoize the return value of `Document#url` (#6266)
|
||||
* delegate `StaticFile#to_json` to `StaticFile#to_liquid` (#6273)
|
||||
* Fix `Drop#key?` so it can handle a nil argument (#6281)
|
||||
* Guard against type error in absolute url (#6280)
|
||||
* Mutable drops should fallback to their own methods when a mutation isn't present (#6350)
|
||||
* Skip adding binary files as posts (#6344)
|
||||
* Don't break if bundler is not installed (#6377)
|
||||
|
||||
### Documentation
|
||||
|
||||
* Fix a typo in `custom-404-page.md` (#6218)
|
||||
* Docs: fix links to issues in History.markdown (#6255)
|
||||
* Update deprecated gems key to plugins. (#6262)
|
||||
* Fixes minor typo in post text (#6283)
|
||||
* Execute build command using bundle. (#6274)
|
||||
* name unification - buddy details (#6317)
|
||||
* name unification - application index (#6318)
|
||||
* trim and relocate plugin info across docs (#6311)
|
||||
* update Jekyll's README (#6321)
|
||||
* add SUPPORT file for GitHub (#6324)
|
||||
* Rename CODE_OF_CONDUCT to show in banner (#6325)
|
||||
* Docs : illustrate page.id for a collection's document (#6329)
|
||||
* Docs: post's date can be overriden in YAML front matter (#6334)
|
||||
* Docs: `site.url` behavior on development and production environments (#6270)
|
||||
* Fix typo in site.url section of variables.md :-[ (#6337)
|
||||
* Docs: updates (#6343)
|
||||
* Fix precedence docs (#6346)
|
||||
* add note to contributing docs about `script/console` (#6349)
|
||||
* Docs: Fix permalink example (#6375)
|
||||
|
||||
### Site Enhancements
|
||||
|
||||
* Adding DevKit helpers (#6225)
|
||||
* Customizing url in collection elements clarified (#6264)
|
||||
* Plugins is the new gems (#6326)
|
||||
|
||||
### Development Fixes
|
||||
|
||||
* Strip unnecessary leading whitespace in template (#6228)
|
||||
* Users should be installing patch versions. (#6198)
|
||||
* Fix tests (#6240)
|
||||
* Define path with `__dir__` (#6087)
|
||||
* exit site.process sooner (#6239)
|
||||
* make flakey test more robust (#6277)
|
||||
* Add a quick test for DataReader (#6284)
|
||||
* script/backport-pr: commit message no longer includes the `#` (#6289)
|
||||
* Add Add CODEOWNERS file to help automate reviews. (#6320)
|
||||
* Fix builds on codeclimate (#6333)
|
||||
* Bump rubies on Travis (#6366)
|
||||
|
||||
## 3.5.2 / 2017-08-12
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* Backport #6281 for v3.5.x: Fix `Drop#key?` so it can handle a nil argument (#6288)
|
||||
* Backport #6280 for v3.5.x: Guard against type error in `absolute_url` (#6287)
|
||||
* Backport #6266 for v3.5.x: Memoize the return value of `Document#url` (#6301)
|
||||
* Backport #6273 for v3.5.x: delegate `StaticFile#to_json` to `StaticFile#to_liquid` (#6302)
|
||||
* Backport #6226 for v3.5.x: `Reader#read_directories`: guard against an entry not being a directory (#6304)
|
||||
* Backport #6247 for v3.5.x: kramdown: symbolize keys in-place (#6303)
|
||||
|
||||
## 3.5.1 / 2017-07-17
|
||||
|
||||
### Minor Enhancements
|
||||
@@ -17,8 +435,8 @@
|
||||
* added BibSonomy plugin (#6143)
|
||||
* add plugins for multiple page pagination (#6055)
|
||||
* Update minimum Ruby version in installation.md (#6164)
|
||||
* [docs] Add information about finding a collection in `site.collections` (#6165)
|
||||
* Add {%raw%} to Liquid example on site (#6179)
|
||||
* Add information about finding a collection in `site.collections` (#6165)
|
||||
* Add `{% raw %}` to Liquid example on site (#6179)
|
||||
* Added improved Pug plugin - removed 404 Jade plugin (#6174)
|
||||
* Linking the link (#6210)
|
||||
* Small correction in documentation for includes (#6193)
|
||||
@@ -122,7 +540,7 @@
|
||||
|
||||
### Development Fixes
|
||||
|
||||
* [Rubocop] add missing comma (#5835)
|
||||
* Rubocop: add missing comma (#5835)
|
||||
* Appease classifier-reborn (#5934)
|
||||
* Allow releases & development on `*-stable` branches (#5926)
|
||||
* Add script/backport-pr (#5925)
|
||||
@@ -159,7 +577,7 @@
|
||||
### Bug Fixes
|
||||
|
||||
* Exclude Gemfile by default (#5860)
|
||||
* Convertible#validate_permalink!: ensure the return value of data["permalink"] is a string before asking if it is empty (#5878)
|
||||
* Convertible#validate_permalink!: ensure the return value of `data["permalink"]` is a string before asking if it is empty (#5878)
|
||||
* Allow abbreviated post dates (#5920)
|
||||
* Remove dependency on include from default about.md (#5903)
|
||||
* Allow colons in `uri_escape` filter (#5957)
|
||||
@@ -220,7 +638,7 @@
|
||||
* Switch to `https` when possible. (#5611)
|
||||
* Update `_font-awesome.scss` to move .woff file before .ttf (#5614)
|
||||
* Update documentation on updating FontAwesome Iconset (#5655)
|
||||
* [site] Use defaults for docs and news-items (#5744)
|
||||
* Use defaults for docs and news-items (#5744)
|
||||
* Sort gems in `docs/_config.yml` (#5746)
|
||||
* Add missing class (#5791)
|
||||
* Improve template docs (#5694)
|
||||
@@ -281,7 +699,7 @@
|
||||
* Update quickstart.md (#5758)
|
||||
* Correct minor typo (#5764)
|
||||
* Fix a markdown link to look properly on the web (#5769)
|
||||
* [docs] Info about the help command usage (#5312)
|
||||
* Info about the help command usage (#5312)
|
||||
* Add missing merge labels for jekyllbot (#5753)
|
||||
* Fix broken links in documentation (#5736)
|
||||
* Docs: add `match_regex` and `replace_regex` filters (#5799)
|
||||
@@ -413,10 +831,10 @@
|
||||
* Site: exclude README.md and .gitignore (#5304)
|
||||
* Add link to Staticman (#5224)
|
||||
* Update url for OpenShift (#5320)
|
||||
* [docs] add help for missing static_file e.g. on heroku (#5334)
|
||||
* Add help for missing static_file e.g. on heroku (#5334)
|
||||
* Add a line about updating theme-gems in the docs (#5318)
|
||||
* Explain how to copy a theme's files (#5335)
|
||||
* [docs] .md as default extension in examples (#5316)
|
||||
* .md as default extension in examples (#5316)
|
||||
* Fix small typo in docs (#5347)
|
||||
* Add missing period to sentence in first paragraph. (#5372)
|
||||
* added jekyll-spotify plugin (#5369)
|
||||
@@ -425,7 +843,7 @@
|
||||
* Add documentation for `relative_url` and `absolute_url` (#5405)
|
||||
* Bugfix on logo in JSON-LD (#5421)
|
||||
* Fix Travis.ci documentation (#5413)
|
||||
* [docs] Update documentation regarding `bundle install` after `jekyll new` (#5428)
|
||||
* Update documentation regarding `bundle install` after `jekyll new` (#5428)
|
||||
* Replace classic box-sizing reset with inheritance reset (#5411)
|
||||
* Update Wikipedia YAML list link (#5452)
|
||||
* Add Jekyll 3.3 release post (#5442)
|
||||
@@ -435,9 +853,9 @@
|
||||
* Update appveyor.yml and fix optional deps for Ruby x64 (#5180)
|
||||
* Improve tests for Jekyll::PluginManager (#5167)
|
||||
* Update Ruby versions in travis.yml (#5221)
|
||||
* Avoid installing unecessary gems for site testing (#5272)
|
||||
* Avoid installing unnecessary gems for site testing (#5272)
|
||||
* Proposal: Affinity teams and their captains (#5273)
|
||||
* Replace duplicate with postive local test in issue template (#5286)
|
||||
* Replace duplicate with positive local test in issue template (#5286)
|
||||
* Update AppVeyor config. (#5240)
|
||||
* Execute jekyll from clone instead of defined binary when running 'script/default-site' (#5295)
|
||||
* rubocop: lib/jekyll/document.rb complexity fixes (#5045)
|
||||
@@ -481,7 +899,7 @@
|
||||
* Allow collections to have documents that have no file extension (#4545)
|
||||
* Add size property to `group_by` result (#4557)
|
||||
* Site Template: Removed unnecessary nesting from `_base.scss` (#4637)
|
||||
* Adding a debug log statment for skipped future documents. (#4558)
|
||||
* Adding a debug log statement for skipped future documents. (#4558)
|
||||
* Site Template: Changed main `<div>` to `<main>` and added accessibility info (#4636)
|
||||
* Add array support to `where` filter (#4555)
|
||||
* 'jekyll clean': also remove .sass-cache (#4652)
|
||||
@@ -729,7 +1147,7 @@
|
||||
* Fix broken links to the Code of Conduct (#4436)
|
||||
* Upgrade notes: mention trailing slash in permalink; fixes #4440 (#4455)
|
||||
* Add hooks to the plugin categories toc (#4463)
|
||||
* [add note] Jekyll 3 requires newer version of Ruby. (#4461)
|
||||
* Jekyll 3 requires newer version of Ruby. (#4461)
|
||||
* Fix typo in upgrading docs (#4473)
|
||||
* Add note about upgrading documentation on jekyllrb.com/help/ (#4484)
|
||||
* Update Rake link (#4496)
|
||||
@@ -790,14 +1208,14 @@
|
||||
* utils/drops: update Drop to support `Utils.deep_merge_hashes` (#4289)
|
||||
* Make sure jekyll/drops/drop is loaded first. (#4292)
|
||||
* Convertible/Page/Renderer: use payload hash accessor & setter syntax for backwards-compatibility (#4311)
|
||||
* Drop: fix hash setter precendence (#4312)
|
||||
* Drop: fix hash setter precedence (#4312)
|
||||
* utils: `has_yaml_header?` should accept files with extraneous spaces (#4290)
|
||||
* Escape html from site.title and page.title in site template (#4307)
|
||||
* Allow custom file extensions if defined in `permalink` YAML front matter (#4314)
|
||||
* Fix deep_merge_hashes! handling of drops and hashes (#4359)
|
||||
* Page should respect output extension of its permalink (#4373)
|
||||
* Disable auto-regeneration when running server detached (#4376)
|
||||
* Drop#[]: only use public_send for keys in the content_methods array (#4388)
|
||||
* Drop#: only use public_send for keys in the content_methods array (#4388)
|
||||
* Extract title from filename successfully when no date. (#4195)
|
||||
|
||||
### Development Fixes
|
||||
@@ -1199,7 +1617,7 @@
|
||||
|
||||
### Site Enhancements
|
||||
|
||||
* Add `@alfredxing` to the `@jekyll/core` team. :tada: (#3218)
|
||||
* Add @alfredxing to the @jekyll/core team. :tada: (#3218)
|
||||
* Document the `-q` option for the `build` and `serve` commands (#3149)
|
||||
* Fix some minor typos/flow fixes in documentation website content (#3165)
|
||||
* Add `keep_files` to configuration documentation (#3162)
|
||||
|
||||
2
LICENSE
2
LICENSE
@@ -1,6 +1,6 @@
|
||||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) 2008-2017 Tom Preston-Werner and Jekyll contributors
|
||||
Copyright (c) 2008-2018 Tom Preston-Werner and Jekyll contributors
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
|
||||
@@ -3,8 +3,8 @@
|
||||
[][ruby-gems]
|
||||
[][travis]
|
||||
[][appveyor]
|
||||
[][coverage]
|
||||
[][codeclimate]
|
||||
[](codeclimate)
|
||||
[](coverage)
|
||||
[][gemnasium]
|
||||
[][hakiri]
|
||||
|
||||
@@ -22,7 +22,9 @@ Jekyll is a simple, blog-aware, static site generator perfect for personal, proj
|
||||
|
||||
Jekyll does what you tell it to do — no more, no less. It doesn't try to outsmart users by making bold assumptions, nor does it burden them with needless complexity and configuration. Put simply, Jekyll gets out of your way and allows you to concentrate on what truly matters: your content.
|
||||
|
||||
## Having trouble with OS X/macOS?
|
||||
See: https://jekyllrb.com/philosophy
|
||||
|
||||
## Having trouble?
|
||||
|
||||
See: https://jekyllrb.com/docs/troubleshooting/
|
||||
|
||||
@@ -37,13 +39,13 @@ See: https://jekyllrb.com/docs/troubleshooting/
|
||||
## Code of Conduct
|
||||
|
||||
In order to have a more open and welcoming community, Jekyll adheres to a
|
||||
[code of conduct](CONDUCT.markdown) adapted from the Ruby on Rails code of
|
||||
[code of conduct](CODE_OF_CONDUCT.markdown) adapted from the Ruby on Rails code of
|
||||
conduct.
|
||||
|
||||
Please adhere to this code of conduct in any interactions you have in the
|
||||
Jekyll community. It is strictly enforced on all official Jekyll
|
||||
repositories, websites, and resources. If you encounter someone violating
|
||||
these terms, please let a maintainer ([@parkr](https://github.com/parkr), [@envygeeks](https://github.com/envygeeks), [@mattr-](https://github.com/mattr-), or [@alfredxing](https://github.com/alfredxing)) know and we will address it as soon as possible.
|
||||
these terms, please let one of our core team members [Olivia](mailto:olivia@jekyllrb.com?subject=Jekyll%20CoC%20Violation), [Pat](mailto:pat@jekyllrb.com?subject=Jekyll%20CoC%20Violation), [Matt](mailto:matt@jekyllrb.com?subject=Jekyll%20CoC%20Violation) or [Parker](mailto:parker@jekyllrb.com?subject=Jekyll%20CoC%20Violation) know and we will address it as soon as possible.
|
||||
|
||||
## Diving In
|
||||
|
||||
|
||||
20
Rakefile
20
Rakefile
@@ -1,10 +1,12 @@
|
||||
# frozen_string_literal: true
|
||||
|
||||
require "rubygems"
|
||||
require "rake"
|
||||
require "rdoc"
|
||||
require "date"
|
||||
require "yaml"
|
||||
|
||||
$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "lib"))
|
||||
$LOAD_PATH.unshift File.expand_path("lib", __dir__)
|
||||
require "jekyll/version"
|
||||
|
||||
Dir.glob("rake/**.rake").each { |f| import f }
|
||||
@@ -44,19 +46,13 @@ def normalize_bullets(markdown)
|
||||
end
|
||||
|
||||
def linkify_prs(markdown)
|
||||
markdown.gsub(%r!#(\d+)!) do |word|
|
||||
markdown.gsub(%r!(?<\!&)#(\d+)!) do |word|
|
||||
"[#{word}]({{ site.repository }}/issues/#{word.delete("#")})"
|
||||
end
|
||||
end
|
||||
|
||||
def linkify_users(markdown)
|
||||
markdown.gsub(%r!(@\w+)!) do |username|
|
||||
"[#{username}](https://github.com/#{username.delete("@")})"
|
||||
end
|
||||
end
|
||||
|
||||
def linkify(markdown)
|
||||
linkify_users(linkify_prs(markdown))
|
||||
linkify_prs(markdown)
|
||||
end
|
||||
|
||||
def liquid_escape(markdown)
|
||||
@@ -70,11 +66,11 @@ def custom_release_header_anchors(markdown)
|
||||
_, major, minor, patch = *release_notes.match(header_regexp)
|
||||
release_notes
|
||||
.gsub(header_regexp, "\\0\n{: #v\\1-\\2-\\3}")
|
||||
.gsub(section_regexp) { |section| "#{section}\n{: ##{sluffigy(section)}-v#{major}-#{minor}-#{patch}}" }
|
||||
.gsub(section_regexp) { |section| "#{section}\n{: ##{slugify(section)}-v#{major}-#{minor}-#{patch}}" }
|
||||
end.join("\n## ")
|
||||
end
|
||||
|
||||
def sluffigy(header)
|
||||
def slugify(header)
|
||||
header.delete("#").strip.downcase.gsub(%r!\s+!, "-")
|
||||
end
|
||||
|
||||
@@ -99,7 +95,7 @@ def siteify_file(file, overrides_front_matter = {})
|
||||
abort "You seem to have misplaced your #{file} file. I can haz?" unless File.exist?(file)
|
||||
title = begin
|
||||
File.read(file).match(%r!\A# (.*)$!)[1]
|
||||
rescue
|
||||
rescue NoMethodError
|
||||
File.basename(file, ".*").downcase.capitalize
|
||||
end
|
||||
slug = File.basename(file, ".markdown").downcase
|
||||
|
||||
16
appveyor.yml
16
appveyor.yml
@@ -16,20 +16,18 @@ install:
|
||||
environment:
|
||||
BUNDLE_WITHOUT: "benchmark:site:development"
|
||||
matrix:
|
||||
- RUBY_FOLDER_VER: "24"
|
||||
- RUBY_FOLDER_VER: "25"
|
||||
TEST_SUITE: "test"
|
||||
- RUBY_FOLDER_VER: "25"
|
||||
TEST_SUITE: "cucumber"
|
||||
- RUBY_FOLDER_VER: "25"
|
||||
TEST_SUITE: "default-site"
|
||||
- RUBY_FOLDER_VER: "25-x64"
|
||||
TEST_SUITE: "test"
|
||||
- RUBY_FOLDER_VER: "24"
|
||||
TEST_SUITE: "cucumber"
|
||||
- RUBY_FOLDER_VER: "24"
|
||||
TEST_SUITE: "default-site"
|
||||
- RUBY_FOLDER_VER: "24-x64"
|
||||
TEST_SUITE: "test"
|
||||
- RUBY_FOLDER_VER: "23"
|
||||
TEST_SUITE: "test"
|
||||
- RUBY_FOLDER_VER: "22"
|
||||
TEST_SUITE: "test"
|
||||
- RUBY_FOLDER_VER: "21"
|
||||
TEST_SUITE: "test"
|
||||
|
||||
test_script:
|
||||
- ruby --version
|
||||
|
||||
101
benchmark/conditional_liquid.rb
Executable file
101
benchmark/conditional_liquid.rb
Executable file
@@ -0,0 +1,101 @@
|
||||
#!/usr/bin/env ruby
|
||||
# frozen_string_literal: true
|
||||
|
||||
require "liquid"
|
||||
require "benchmark/ips"
|
||||
|
||||
# Test if processing content string without any Liquid constructs, via Liquid,
|
||||
# is slower than checking whether constructs exist ( using `String#include?` )
|
||||
# and return-ing the "plaintext" content string as is..
|
||||
#
|
||||
# Ref: https://github.com/jekyll/jekyll/pull/6735
|
||||
|
||||
# Sample contents
|
||||
WITHOUT_LIQUID = <<-TEXT.freeze
|
||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Fusce auctor libero at
|
||||
pharetra tempus. Etiam bibendum magna et metus fermentum, eu cursus lorem
|
||||
mattis. Curabitur vel dui et lacus rutrum suscipit et eget neque.
|
||||
|
||||
Nullam luctus fermentum est id blandit. Phasellus consectetur ullamcorper
|
||||
ligula, at finibus eros laoreet id. Etiam sit amet est in libero efficitur
|
||||
tristique. Ut nec magna augue. Quisque ut fringilla lacus, ac dictum enim.
|
||||
Aliquam vel ornare mauris. Suspendisse ornare diam tempor nulla facilisis
|
||||
aliquet. Sed ultrices placerat ultricies.
|
||||
TEXT
|
||||
|
||||
WITH_LIQUID = <<-LIQUID.freeze
|
||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Fusce auctor libero at
|
||||
pharetra tempus. {{ author }} et metus fermentum, eu cursus lorem
|
||||
mattis. Curabitur vel dui et lacus rutrum suscipit et eget neque.
|
||||
|
||||
Nullam luctus fermentum est id blandit. Phasellus consectetur ullamcorper
|
||||
ligula, {% if author == "Jane Doe" %} at finibus eros laoreet id. {% else %}
|
||||
Etiam sit amet est in libero efficitur.{% endif %}
|
||||
tristique. Ut nec magna augue. Quisque ut fringilla lacus, ac dictum enim.
|
||||
Aliquam vel ornare mauris. Suspendisse ornare diam tempor nulla facilisis
|
||||
aliquet. Sed ultrices placerat ultricies.
|
||||
LIQUID
|
||||
|
||||
WITH_JUST_LIQUID_VAR = <<-LIQUID.freeze
|
||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Fusce auctor libero at
|
||||
pharetra tempus. et metus fermentum, eu cursus lorem, ac dictum enim.
|
||||
mattis. Curabitur vel dui et lacus rutrum suscipit et {{ title }} neque.
|
||||
|
||||
Nullam luctus fermentum est id blandit. Phasellus consectetur ullamcorper
|
||||
ligula, at finibus eros laoreet id. Etiam sit amet est in libero efficitur.
|
||||
tristique. Ut nec magna augue. {{ author }} Quisque ut fringilla lacus
|
||||
Aliquam vel ornare mauris. Suspendisse ornare diam tempor nulla facilisis
|
||||
aliquet. Sed ultrices placerat ultricies.
|
||||
LIQUID
|
||||
|
||||
SUITE = {
|
||||
:"plain text" => WITHOUT_LIQUID,
|
||||
:"tags n vars" => WITH_LIQUID,
|
||||
:"just vars" => WITH_JUST_LIQUID_VAR,
|
||||
}.freeze
|
||||
|
||||
# Mimic how Jekyll's LiquidRenderer would process a non-static file, with
|
||||
# some dummy payload
|
||||
def always_liquid(content)
|
||||
Liquid::Template.error_mode = :warn
|
||||
Liquid::Template.parse(content, :line_numbers => true).render(
|
||||
"author" => "John Doe",
|
||||
"title" => "FooBar"
|
||||
)
|
||||
end
|
||||
|
||||
# Mimic how the proposed change would first execute a couple of checks and
|
||||
# proceed to process with Liquid if necessary
|
||||
def conditional_liquid(content)
|
||||
return content if content.nil? || content.empty?
|
||||
return content unless content.include?("{%") || content.include?("{{")
|
||||
always_liquid(content)
|
||||
end
|
||||
|
||||
# Test https://github.com/jekyll/jekyll/pull/6735#discussion_r165499868
|
||||
# ------------------------------------------------------------------------
|
||||
def check_with_regex(content)
|
||||
!content.to_s.match?(%r!{[{%]!)
|
||||
end
|
||||
|
||||
def check_with_builtin(content)
|
||||
content.include?("{%") || content.include?("{{")
|
||||
end
|
||||
|
||||
SUITE.each do |key, text|
|
||||
Benchmark.ips do |x|
|
||||
x.report("regex-check - #{key}") { check_with_regex(text) }
|
||||
x.report("builtin-check - #{key}") { check_with_builtin(text) }
|
||||
x.compare!
|
||||
end
|
||||
end
|
||||
# ------------------------------------------------------------------------
|
||||
|
||||
# Let's roll!
|
||||
SUITE.each do |key, text|
|
||||
Benchmark.ips do |x|
|
||||
x.report("always thru liquid - #{key}") { always_liquid(text) }
|
||||
x.report("conditional liquid - #{key}") { conditional_liquid(text) }
|
||||
x.compare!
|
||||
end
|
||||
end
|
||||
29
benchmark/local-require
Executable file
29
benchmark/local-require
Executable file
@@ -0,0 +1,29 @@
|
||||
#!/usr/bin/env ruby
|
||||
# frozen_string_literal: true
|
||||
|
||||
require 'benchmark/ips'
|
||||
require 'jekyll'
|
||||
require 'json'
|
||||
|
||||
DATA = {"foo"=>"bar", "alpha"=>{"beta"=>"gamma"}, "lipsum"=>["lorem", "ipsum", "dolor"]}
|
||||
|
||||
def local_require
|
||||
require 'json'
|
||||
JSON.pretty_generate(DATA)
|
||||
end
|
||||
|
||||
def global_require
|
||||
JSON.pretty_generate(DATA)
|
||||
end
|
||||
|
||||
def graceful_require
|
||||
Jekyll::External.require_with_graceful_fail("json")
|
||||
JSON.pretty_generate(DATA)
|
||||
end
|
||||
|
||||
Benchmark.ips do |x|
|
||||
x.report("local-require") { local_require }
|
||||
x.report("global-require") { global_require }
|
||||
x.report("graceful-require") { graceful_require }
|
||||
x.compare!
|
||||
end
|
||||
33
benchmark/native-vs-pathutil-relative
Executable file
33
benchmark/native-vs-pathutil-relative
Executable file
@@ -0,0 +1,33 @@
|
||||
#!/usr/bin/env ruby
|
||||
|
||||
# -------------------------------------------------------------------
|
||||
# Benchmarking changes in https://github.com/jekyll/jekyll/pull/6767
|
||||
# -------------------------------------------------------------------
|
||||
|
||||
require 'benchmark/ips'
|
||||
require 'pathutil'
|
||||
|
||||
DOC_PATH = File.join(File.expand_path(__dir__), "_puppies", "rover.md")
|
||||
COL_PATH = File.join(File.expand_path(__dir__), "_puppies")
|
||||
|
||||
|
||||
def pathutil_relative
|
||||
Pathutil.new(DOC_PATH).relative_path_from(COL_PATH).to_s
|
||||
end
|
||||
|
||||
def native_relative
|
||||
DOC_PATH.sub("#{COL_PATH}/", "")
|
||||
end
|
||||
|
||||
if pathutil_relative == native_relative
|
||||
Benchmark.ips do |x|
|
||||
x.report("pathutil") { pathutil_relative }
|
||||
x.report("native") { native_relative }
|
||||
x.compare!
|
||||
end
|
||||
else
|
||||
print "PATHUTIL: "
|
||||
puts pathutil_relative
|
||||
print "NATIVE: "
|
||||
puts native_relative
|
||||
end
|
||||
26
benchmark/sanitize-url.rb
Executable file
26
benchmark/sanitize-url.rb
Executable file
@@ -0,0 +1,26 @@
|
||||
#!/usr/bin/env ruby
|
||||
|
||||
require "benchmark/ips"
|
||||
|
||||
PATH = "/../../..../...//.....//lorem/ipsum//dolor///sit.xyz"
|
||||
|
||||
def sanitize_with_regex
|
||||
"/" + PATH.gsub(%r!/{2,}!, "/").gsub(%r!\.+/|\A/+!, "")
|
||||
end
|
||||
|
||||
def sanitize_with_builtin
|
||||
"/#{PATH}".gsub("..", "/").gsub("./", "").squeeze("/")
|
||||
end
|
||||
|
||||
if sanitize_with_regex == sanitize_with_builtin
|
||||
Benchmark.ips do |x|
|
||||
x.report("sanitize w/ regexes") { sanitize_with_regex }
|
||||
x.report("sanitize w/ builtin") { sanitize_with_builtin }
|
||||
x.compare!
|
||||
end
|
||||
else
|
||||
puts "w/ regexes: #{sanitize_with_regex}"
|
||||
puts "w/ builtin: #{sanitize_with_builtin}"
|
||||
puts ""
|
||||
puts "Thank you. Do try again :("
|
||||
end
|
||||
115
benchmark/schwartzian_transform.rb
Normal file
115
benchmark/schwartzian_transform.rb
Normal file
@@ -0,0 +1,115 @@
|
||||
#!/usr/bin/env ruby
|
||||
# frozen_string_literal: true
|
||||
#
|
||||
# The Ruby documentation for #sort_by describes what's called a Schwartzian transform:
|
||||
#
|
||||
# > A more efficient technique is to cache the sort keys (modification times in this case)
|
||||
# > before the sort. Perl users often call this approach a Schwartzian transform, after
|
||||
# > Randal Schwartz. We construct a temporary array, where each element is an array
|
||||
# > containing our sort key along with the filename. We sort this array, and then extract
|
||||
# > the filename from the result.
|
||||
# > This is exactly what sort_by does internally.
|
||||
#
|
||||
# The well-documented efficiency of sort_by is a good reason to use it. However, when a property
|
||||
# does not exist on an item being sorted, it can cause issues (no nil's allowed!)
|
||||
# In Jekyll::Filters#sort_input, we extract the property in each iteration of #sort,
|
||||
# which is quite inefficient! How inefficient? This benchmark will tell you just how, and how much
|
||||
# it can be improved by using the Schwartzian transform. Thanks, Randall!
|
||||
|
||||
require 'benchmark/ips'
|
||||
require 'minitest'
|
||||
require File.expand_path("../lib/jekyll", __dir__)
|
||||
|
||||
def site
|
||||
@site ||= Jekyll::Site.new(
|
||||
Jekyll.configuration("source" => File.expand_path("../docs", __dir__))
|
||||
).tap(&:reset).tap(&:read)
|
||||
end
|
||||
|
||||
def site_docs
|
||||
site.collections["docs"].docs.dup
|
||||
end
|
||||
|
||||
def sort_by_property_directly(docs, meta_key)
|
||||
docs.sort! do |apple, orange|
|
||||
apple_property = apple[meta_key]
|
||||
orange_property = orange[meta_key]
|
||||
|
||||
if !apple_property.nil? && !orange_property.nil?
|
||||
apple_property <=> orange_property
|
||||
elsif !apple_property.nil? && orange_property.nil?
|
||||
-1
|
||||
elsif apple_property.nil? && !orange_property.nil?
|
||||
1
|
||||
else
|
||||
apple <=> orange
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
def schwartzian_transform(docs, meta_key)
|
||||
docs.collect! { |d|
|
||||
[d[meta_key], d]
|
||||
}.sort! { |apple, orange|
|
||||
if !apple[0].nil? && !orange[0].nil?
|
||||
apple.first <=> orange.first
|
||||
elsif !apple[0].nil? && orange[0].nil?
|
||||
-1
|
||||
elsif apple[0].nil? && !orange[0].nil?
|
||||
1
|
||||
else
|
||||
apple[-1] <=> orange[-1]
|
||||
end
|
||||
}.collect! { |d| d[-1] }
|
||||
end
|
||||
|
||||
# Before we test efficiency, do they produce the same output?
|
||||
class Correctness
|
||||
include Minitest::Assertions
|
||||
|
||||
require "pp"
|
||||
define_method :mu_pp, &:pretty_inspect
|
||||
|
||||
attr_accessor :assertions
|
||||
|
||||
def initialize(docs, property)
|
||||
@assertions = 0
|
||||
@docs = docs
|
||||
@property = property
|
||||
end
|
||||
|
||||
def assert!
|
||||
assert sort_by_property_directly(@docs, @property).is_a?(Array), "sort_by_property_directly must return an array"
|
||||
assert schwartzian_transform(@docs, @property).is_a?(Array), "schwartzian_transform must return an array"
|
||||
assert_equal sort_by_property_directly(@docs, @property),
|
||||
schwartzian_transform(@docs, @property)
|
||||
puts "Yeah, ok, correctness all checks out for property #{@property.inspect}"
|
||||
end
|
||||
end
|
||||
|
||||
Correctness.new(site_docs, "redirect_from".freeze).assert!
|
||||
Correctness.new(site_docs, "title".freeze).assert!
|
||||
|
||||
# First, test with a property only a handful of documents have.
|
||||
Benchmark.ips do |x|
|
||||
x.config(time: 10, warmup: 5)
|
||||
x.report('sort_by_property_directly with sparse property') do
|
||||
sort_by_property_directly(site_docs, "redirect_from".freeze)
|
||||
end
|
||||
x.report('schwartzian_transform with sparse property') do
|
||||
schwartzian_transform(site_docs, "redirect_from".freeze)
|
||||
end
|
||||
x.compare!
|
||||
end
|
||||
|
||||
# Next, test with a property they all have.
|
||||
Benchmark.ips do |x|
|
||||
x.config(time: 10, warmup: 5)
|
||||
x.report('sort_by_property_directly with non-sparse property') do
|
||||
sort_by_property_directly(site_docs, "title".freeze)
|
||||
end
|
||||
x.report('schwartzian_transform with non-sparse property') do
|
||||
schwartzian_transform(site_docs, "title".freeze)
|
||||
end
|
||||
x.compare!
|
||||
end
|
||||
@@ -27,9 +27,6 @@ sitemap: false
|
||||
<li>
|
||||
<a href="/news/">News</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/community/">Community</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/help/">Help</a>
|
||||
</li>
|
||||
|
||||
@@ -1,60 +1,48 @@
|
||||
markdown: kramdown
|
||||
highlighter: rouge
|
||||
sass:
|
||||
style: compressed
|
||||
|
||||
gauges_id: 503c5af6613f5d0f19000027
|
||||
google_analytics_id: UA-50755011-1
|
||||
google_site_verification: onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY
|
||||
|
||||
repository: https://github.com/jekyll/jekyll
|
||||
help_url: https://github.com/jekyll/jekyll-help
|
||||
|
||||
timezone: America/Los_Angeles
|
||||
|
||||
defaults:
|
||||
-
|
||||
scope:
|
||||
path: "_docs"
|
||||
type: "docs"
|
||||
values:
|
||||
layout: "docs"
|
||||
-
|
||||
scope:
|
||||
path: "_posts"
|
||||
type: "posts"
|
||||
values:
|
||||
layout: "news_item"
|
||||
|
||||
|
||||
collections:
|
||||
docs:
|
||||
permalink: /:collection/:path/
|
||||
output: true
|
||||
posts:
|
||||
permalink: /news/:year/:month/:day/:title/
|
||||
output: true
|
||||
tutorials:
|
||||
output: true
|
||||
|
||||
---
|
||||
version: 3.8.1
|
||||
name: Jekyll • Simple, blog-aware, static sites
|
||||
description: Transform your plain text into static websites and blogs
|
||||
url: https://jekyllrb.com
|
||||
|
||||
repository: https://github.com/jekyll/jekyll
|
||||
timezone: America/Los_Angeles
|
||||
twitter:
|
||||
username: jekyllrb
|
||||
|
||||
logo: /img/logo-2x.png
|
||||
|
||||
gems:
|
||||
- jekyll-avatar
|
||||
- jekyll-feed
|
||||
- jekyll-mentions
|
||||
- jekyll-redirect-from
|
||||
- jekyll-seo-tag
|
||||
- jekyll-sitemap
|
||||
- jemoji
|
||||
|
||||
logo: "/img/logo-2x.png"
|
||||
google_analytics_id: UA-50755011-1
|
||||
google_site_verification: onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY
|
||||
collections:
|
||||
docs:
|
||||
permalink: "/:collection/:path/"
|
||||
output: true
|
||||
posts:
|
||||
permalink: "/news/:year/:month/:day/:title/"
|
||||
output: true
|
||||
tutorials:
|
||||
output: true
|
||||
defaults:
|
||||
- scope:
|
||||
path: _docs
|
||||
type: docs
|
||||
values:
|
||||
layout: docs
|
||||
- scope:
|
||||
path: _posts
|
||||
type: posts
|
||||
values:
|
||||
layout: news_item
|
||||
image: "/img/twitter-card.png"
|
||||
plugins:
|
||||
- jekyll-avatar
|
||||
- jekyll-feed
|
||||
- jekyll-mentions
|
||||
- jekyll-redirect-from
|
||||
- jekyll-seo-tag
|
||||
- jekyll-sitemap
|
||||
- jemoji
|
||||
sass:
|
||||
style: compressed
|
||||
exclude:
|
||||
- .gitignore
|
||||
- README.md
|
||||
- ".gitignore"
|
||||
- CNAME
|
||||
- icomoon-selection.json
|
||||
- readme.md
|
||||
|
||||
@@ -1,10 +1,12 @@
|
||||
- title: Tutorials
|
||||
tutorials:
|
||||
- home
|
||||
- video-walkthroughs
|
||||
- navigation
|
||||
- orderofinterpretation
|
||||
- custom-404-page
|
||||
- convert-site-to-jekyll
|
||||
- using-jekyll-with-bundler
|
||||
|
||||
#- title: Another section
|
||||
# tutorials:
|
||||
|
||||
@@ -53,7 +53,7 @@ sass:
|
||||
The Sass converter will default the `sass_dir` configuration option to
|
||||
`_sass`.
|
||||
|
||||
[example-sass]: https://github.com/jekyll/jekyll-sass-converter/tree/master/example
|
||||
[example-sass]: https://github.com/jekyll/jekyll-sass-converter/tree/master/docs
|
||||
|
||||
<div class="note info">
|
||||
<h5>The <code>sass_dir</code> is only used by Sass</h5>
|
||||
|
||||
55
docs/_docs/code_of_conduct.md
Normal file
55
docs/_docs/code_of_conduct.md
Normal file
@@ -0,0 +1,55 @@
|
||||
---
|
||||
title: Code of Conduct
|
||||
permalink: "/docs/code_of_conduct/"
|
||||
note: This file is autogenerated. Edit /CODE_OF_CONDUCT.markdown instead.
|
||||
redirect_from: "/conduct/index.html"
|
||||
editable: false
|
||||
---
|
||||
|
||||
As contributors and maintainers of this project, and in the interest of
|
||||
fostering an open and welcoming community, we pledge to respect all people who
|
||||
contribute through reporting issues, posting feature requests, updating
|
||||
documentation, submitting pull requests or patches, and other activities.
|
||||
|
||||
We are committed to making participation in this project a harassment-free
|
||||
experience for everyone, regardless of level of experience, gender, gender
|
||||
identity and expression, sexual orientation, disability, personal appearance,
|
||||
body size, race, ethnicity, age, religion, or nationality.
|
||||
|
||||
Examples of unacceptable behavior by participants include:
|
||||
|
||||
* The use of sexualized language or imagery
|
||||
* Personal attacks
|
||||
* Trolling or insulting/derogatory comments
|
||||
* Public or private harassment
|
||||
* Publishing other's private information, such as physical or electronic
|
||||
addresses, without explicit permission
|
||||
* Other unethical or unprofessional conduct
|
||||
|
||||
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.
|
||||
|
||||
By adopting this Code of Conduct, project maintainers commit themselves to
|
||||
fairly and consistently applying these principles to every aspect of managing
|
||||
this project. Project maintainers who do not follow or enforce the Code of
|
||||
Conduct may be permanently removed from the project team.
|
||||
|
||||
This Code of Conduct applies both within project spaces and in public spaces
|
||||
when an individual is representing the project or its community.
|
||||
|
||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
||||
reported by opening an issue or contacting a project maintainer. All complaints
|
||||
will be reviewed and investigated and will result in a response that is deemed
|
||||
necessary and appropriate to the circumstances. Maintainers are obligated to
|
||||
maintain confidentiality with regard to the reporter of an incident.
|
||||
|
||||
|
||||
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
||||
version 1.3.0, available at
|
||||
[http://contributor-covenant.org/version/1/3/0/][version]
|
||||
|
||||
[homepage]: http://contributor-covenant.org
|
||||
[version]: http://contributor-covenant.org/version/1/3/0/
|
||||
@@ -46,6 +46,21 @@ defaults:
|
||||
layout: page
|
||||
```
|
||||
|
||||
<div class="note">
|
||||
<h5>Gather your collections {%- include docs_version_badge.html version="3.7.0" -%}</h5>
|
||||
|
||||
<p>You can optionally specify a directory to store all your collections in the same place with <code>collections_dir: my_collections</code>.</p>
|
||||
|
||||
<p>Then Jekyll will look in <code>my_collections/_books</code> for the <code>books</code> collection, and
|
||||
in <code>my_collections/_recipes</code> for the <code>recipes</code> collection.</p>
|
||||
</div>
|
||||
|
||||
<div class="note warning">
|
||||
<h5>Be sure to move posts into custom collections directory</h5>
|
||||
|
||||
<p>If you specify a directory to store all your collections in the same place with <code>collections_dir: my_collections</code>, then you will need to move your <code>_posts</code> directory to <code>my_collections/_posts</code>. Note that, the name of your collections directory cannot start with an underscore (`_`).</p>
|
||||
</div>
|
||||
|
||||
### Step 2: Add your content {#step2}
|
||||
|
||||
Create a corresponding folder (e.g. `<source>/_my_collection`) and add
|
||||
@@ -78,6 +93,20 @@ For example, if you have `_my_collection/some_subdir/some_doc.md`,
|
||||
it will be rendered using Liquid and the Markdown converter of your
|
||||
choice and written out to `<dest>/my_collection/some_subdir/some_doc.html`.
|
||||
|
||||
If you wish a specific page to be shown when accessing `/my_collection/`,
|
||||
simply add `permalink: /my_collection/index.html` to a page.
|
||||
To list items from the collection, on that page or any other, you can use:
|
||||
|
||||
{% raw %}
|
||||
```liquid
|
||||
{% for item in site.my_collection %}
|
||||
<h2>{{ item.title }}</h2>
|
||||
<p>{{ item.description }}</p>
|
||||
<p><a href="{{ item.url }}">{{ item.title }}</a></p>
|
||||
{% endfor %}
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
<div class="note info">
|
||||
<h5>Don't forget to add YAML for processing</h5>
|
||||
<p>
|
||||
@@ -111,7 +140,7 @@ _my_collection/
|
||||
|
||||
each of the following `permalink` configurations will produce the document structure shown below it.
|
||||
|
||||
* **Default**
|
||||
* **Default**
|
||||
Same as `permalink: /:collection/:path`.
|
||||
|
||||
```
|
||||
@@ -121,7 +150,7 @@ each of the following `permalink` configurations will produce the document struc
|
||||
│ └── some_doc.html
|
||||
...
|
||||
```
|
||||
* `permalink: pretty`
|
||||
* `permalink: pretty`
|
||||
Same as `permalink: /:collection/:path/`.
|
||||
|
||||
```
|
||||
@@ -198,7 +227,13 @@ each of the following `permalink` configurations will produce the document struc
|
||||
<p><code>:title</code></p>
|
||||
</td>
|
||||
<td>
|
||||
<p>The document's lowercase title (as defined in its <a href="/docs/frontmatter/">front matter</a>), with every sequence of spaces and non-alphanumeric characters replaced by a hyphen. If the document does not define a title in its <a href="/docs/frontmatter/">front matter</a>, this is equivalent to <code>name</code>.</p>
|
||||
<p>
|
||||
The <code>:title</code> template variable will take the
|
||||
<code>slug</code> <a href="/docs/frontmatter/">front matter</a>
|
||||
variable value if any is present in the document; if none is
|
||||
defined then <code>:title</code> will be equivalent to
|
||||
<code>:name</code>, aka the slug generated from the filename.
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -219,7 +254,7 @@ each of the following `permalink` configurations will produce the document struc
|
||||
|
||||
Each collection is accessible as a field on the `site` variable. For example, if
|
||||
you want to access the `albums` collection found in `_albums`, you'd use
|
||||
`site.albums`.
|
||||
`site.albums`.
|
||||
|
||||
Each collection is itself an array of documents (e.g., `site.albums` is an array of documents, much like `site.pages` and
|
||||
`site.posts`). See the table below for how to access attributes of those documents.
|
||||
@@ -304,15 +339,29 @@ you specified in your `_config.yml` (if present) and the following information:
|
||||
|
||||
<div class="note info">
|
||||
<h5>A Hard-Coded Collection</h5>
|
||||
<p>In addition to any collections you create yourself, the
|
||||
<code>posts</code> collection is hard-coded into Jekyll. It exists whether
|
||||
you have a <code>_posts</code> directory or not. This is something to note
|
||||
when iterating through <code>site.collections</code> as you may need to
|
||||
<p>In addition to any collections you create yourself, the
|
||||
<code>posts</code> collection is hard-coded into Jekyll. It exists whether
|
||||
you have a <code>_posts</code> directory or not. This is something to note
|
||||
when iterating through <code>site.collections</code> as you may need to
|
||||
filter it out.</p>
|
||||
<p>You may wish to use filters to find your collection:
|
||||
<code>{% raw %}{{ site.collections | where: "label", "myCollection" | first }}{% endraw %}</code></p>
|
||||
</div>
|
||||
|
||||
<div class="note info">
|
||||
<h5>Collections and Time</h5>
|
||||
<p>Except for documents in hard-coded default collection <code>posts</code>, all documents in collections
|
||||
you create, are accessible via Liquid irrespective of their assigned date, if any, and therefore renderable.
|
||||
</p>
|
||||
<p>However documents are attempted to be written to disk only if the concerned collection
|
||||
metadata has <code>output: true</code>. Additionally, future-dated documents are only written if
|
||||
<code>site.future</code> <em>is also true</em>.
|
||||
</p>
|
||||
<p>More fine-grained control over documents being written to disk can be exercised by setting
|
||||
<code>published: false</code> (<em><code>true</code> by default</em>) in the document's front matter.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
|
||||
### Documents
|
||||
|
||||
@@ -437,7 +486,7 @@ works:
|
||||
|
||||
Every album in the collection could be listed on a single page with a template:
|
||||
|
||||
```html
|
||||
```liquid
|
||||
{% raw %}
|
||||
{% for album in site.albums %}
|
||||
<h2>{{ album.title }}</h2>
|
||||
|
||||
@@ -108,7 +108,7 @@ class="flag">flags</code> (specified on the command-line) that control them.
|
||||
<a href="https://en.wikipedia.org/wiki/Tz_database">IANA Time Zone
|
||||
Database</a> is valid, e.g. <code>America/New_York</code>. A list of all
|
||||
available values can be found <a href="https://en.wikipedia.org/wiki/List_of_tz_database_time_zones">
|
||||
here</a>. The default is the local time zone, as set by your operating system.
|
||||
here</a>. When serving on a local machine, the default time zone is set by your operating system. But when served on a remote host/server, the default time zone depends on the server's setting or location.
|
||||
</p>
|
||||
</td>
|
||||
<td class="align-center">
|
||||
@@ -518,7 +518,7 @@ defaults:
|
||||
-
|
||||
scope:
|
||||
path: ""
|
||||
type: "posts"
|
||||
type: "pages"
|
||||
values:
|
||||
layout: "my-site"
|
||||
-
|
||||
@@ -530,7 +530,7 @@ defaults:
|
||||
author: "Mr. Hyde"
|
||||
```
|
||||
|
||||
With these defaults, all posts would use the `my-site` layout. Any html files that exist in the `projects/` folder will use the `project` layout, if it exists. Those files will also have the `page.author` [liquid variable](../variables/) set to `Mr. Hyde`.
|
||||
With these defaults, all pages would use the `my-site` layout. Any html files that exist in the `projects/` folder will use the `project` layout, if it exists. Those files will also have the `page.author` [liquid variable](../variables/) set to `Mr. Hyde`.
|
||||
|
||||
```yaml
|
||||
collections:
|
||||
@@ -549,11 +549,39 @@ defaults:
|
||||
In this example, the `layout` is set to `default` inside the
|
||||
[collection](../collections/) with the name `my_collection`.
|
||||
|
||||
### Glob patterns in Front Matter defaults
|
||||
|
||||
It is also possible to use glob patterns (currently limited to patterns that contain `*`) when matching defaults. For example, it is possible to set specific layout for each `special-page.html` in any subfolder of `section` folder. {%- include docs_version_badge.html version="3.7.0" -%}
|
||||
|
||||
```yaml
|
||||
collections:
|
||||
my_collection:
|
||||
output: true
|
||||
|
||||
defaults:
|
||||
-
|
||||
scope:
|
||||
path: "section/*/special-page.html"
|
||||
values:
|
||||
layout: "specific-layout"
|
||||
```
|
||||
|
||||
<div class="note warning">
|
||||
<h5>Globbing and Performance</h5>
|
||||
<p>
|
||||
Please note that globbing a path is known to have a negative effect on
|
||||
performance and is currently not optimized, especially on Windows.
|
||||
Globbing a path will increase your build times in proportion to the size
|
||||
of the associated collection directory.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
|
||||
### Precedence
|
||||
|
||||
Jekyll will apply all of the configuration settings you specify in the `defaults` section of your `_config.yml` file. However, you can choose to override settings from other scope/values pair by specifying a more specific path for the scope.
|
||||
|
||||
You can see that in the second to last example above. First, we set the default layout to `my-site`. Then, using a more specific path, we set the default layout for files in the `projects/` path to `project`. This can be done with any value that you would set in the page or post front matter.
|
||||
You can see that in the second to last example above. First, we set the default page layout to `my-site`. Then, using a more specific path, we set the default layout for pages in the `projects/` path to `project`. This can be done with any value that you would set in the page or post front matter.
|
||||
|
||||
Finally, if you set defaults in the site configuration by adding a `defaults` section to your `_config.yml` file, you can override those settings in a post or page file. All you need to do is specify the settings in the post or page front matter. For example:
|
||||
|
||||
@@ -602,23 +630,24 @@ file or on the command-line.
|
||||
|
||||
```yaml
|
||||
# Where things are
|
||||
source: .
|
||||
destination: ./_site
|
||||
plugins_dir: _plugins
|
||||
layouts_dir: _layouts
|
||||
data_dir: _data
|
||||
includes_dir: _includes
|
||||
source: .
|
||||
destination: ./_site
|
||||
collections_dir: .
|
||||
plugins_dir: _plugins
|
||||
layouts_dir: _layouts
|
||||
data_dir: _data
|
||||
includes_dir: _includes
|
||||
collections:
|
||||
posts:
|
||||
output: true
|
||||
|
||||
# Handling Reading
|
||||
safe: false
|
||||
include: [".htaccess"]
|
||||
exclude: ["Gemfile", "Gemfile.lock", "node_modules", "vendor/bundle/", "vendor/cache/", "vendor/gems/", "vendor/ruby/"]
|
||||
keep_files: [".git", ".svn"]
|
||||
encoding: "utf-8"
|
||||
markdown_ext: "markdown,mkdown,mkdn,mkd,md"
|
||||
safe: false
|
||||
include: [".htaccess"]
|
||||
exclude: ["Gemfile", "Gemfile.lock", "node_modules", "vendor/bundle/", "vendor/cache/", "vendor/gems/", "vendor/ruby/"]
|
||||
keep_files: [".git", ".svn"]
|
||||
encoding: "utf-8"
|
||||
markdown_ext: "markdown,mkdown,mkdn,mkd,md"
|
||||
strict_front_matter: false
|
||||
|
||||
# Filtering Content
|
||||
@@ -655,23 +684,21 @@ verbose: false
|
||||
defaults: []
|
||||
|
||||
liquid:
|
||||
error_mode: warn
|
||||
error_mode: warn
|
||||
strict_filters: false
|
||||
strict_variables: false
|
||||
|
||||
# Markdown Processors
|
||||
rdiscount:
|
||||
extensions: []
|
||||
|
||||
redcarpet:
|
||||
extensions: []
|
||||
|
||||
kramdown:
|
||||
auto_ids: true
|
||||
entity_output: as_char
|
||||
toc_levels: 1..6
|
||||
smart_quotes: lsquo,rsquo,ldquo,rdquo
|
||||
input: GFM
|
||||
hard_wrap: false
|
||||
footnote_nr: 1
|
||||
auto_ids: true
|
||||
entity_output: as_char
|
||||
toc_levels: 1..6
|
||||
smart_quotes: lsquo,rsquo,ldquo,rdquo
|
||||
input: GFM
|
||||
hard_wrap: false
|
||||
footnote_nr: 1
|
||||
show_warnings: false
|
||||
```
|
||||
|
||||
## Liquid Options
|
||||
@@ -683,55 +710,19 @@ options are
|
||||
- `warn` --- Output a warning on the console for each error.
|
||||
- `strict` --- Output an error message and stop the build.
|
||||
|
||||
You can also configure Liquid's renderer to catch non-assigned variables and
|
||||
non-existing filters by setting `strict_variables` and / or `strict_filters`
|
||||
to `true` respectively. {% include docs_version_badge.html version="3.8.0" %}
|
||||
|
||||
Do note that while `error_mode` configures Liquid's parser, the `strict_variables`
|
||||
and `strict_filters` options configure Liquid's renderer and are consequently,
|
||||
mutually exclusive.
|
||||
|
||||
## Markdown Options
|
||||
|
||||
The various Markdown renderers supported by Jekyll sometimes have extra options
|
||||
available.
|
||||
|
||||
### Redcarpet
|
||||
|
||||
Redcarpet can be configured by providing an `extensions` sub-setting, whose
|
||||
value should be an array of strings. Each string should be the name of one of
|
||||
the `Redcarpet::Markdown` class's extensions; if present in the array, it will
|
||||
set the corresponding extension to `true`.
|
||||
|
||||
Jekyll handles two special Redcarpet extensions:
|
||||
|
||||
- `no_fenced_code_blocks` --- By default, Jekyll sets the `fenced_code_blocks`
|
||||
extension (for delimiting code blocks with triple tildes or triple backticks)
|
||||
to `true`, probably because GitHub's eager adoption of them is starting to make
|
||||
them inescapable. Redcarpet's normal `fenced_code_blocks` extension is inert
|
||||
when used with Jekyll; instead, you can use this inverted version of the
|
||||
extension for disabling fenced code.
|
||||
|
||||
Note that you can also specify a language for highlighting after the first
|
||||
delimiter:
|
||||
|
||||
```ruby
|
||||
# ...ruby code
|
||||
```
|
||||
|
||||
With both fenced code blocks and highlighter enabled, this will statically
|
||||
highlight the code; without any syntax highlighter, it will add a
|
||||
`class="LANGUAGE"` attribute to the `<code>` element, which can be used as a
|
||||
hint by various JavaScript code highlighting libraries.
|
||||
|
||||
- `smart` --- This pseudo-extension turns on SmartyPants, which converts
|
||||
straight quotes to curly quotes and runs of hyphens to em (`---`) and en (`--`) dashes.
|
||||
|
||||
All other extensions retain their usual names from Redcarpet, and no renderer
|
||||
options aside from `smart` can be specified in Jekyll. [A list of available
|
||||
extensions can be found in the Redcarpet README file.][redcarpet_extensions]
|
||||
Make sure you're looking at the README for the right version of
|
||||
Redcarpet: Jekyll currently uses v3.2.x. The most commonly used
|
||||
extensions are:
|
||||
|
||||
- `tables`
|
||||
- `no_intra_emphasis`
|
||||
- `autolink`
|
||||
|
||||
[redcarpet_extensions]: https://github.com/vmg/redcarpet/blob/v3.2.2/README.markdown#and-its-like-really-simple-to-use
|
||||
|
||||
### Custom Markdown Processors
|
||||
|
||||
If you're interested in creating a custom markdown processor, you're in luck! Create a new class in the `Jekyll::Converters::Markdown` namespace:
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
---
|
||||
title: "BuddyWorks"
|
||||
title: "Buddy"
|
||||
---
|
||||
|
||||
[BuddyWorks][buddyworks-homepage] is a [Docker][docker-homepage]-based CI server that you can set up in 15-20 minutes to build, test, and deploy your Jekyll websites. It supports [GitHub][github-homepage], [Bitbucket][bitbucket-homepage], and [GitLab][gitlab-homepage] repositories, and can be installed on-premises or used in cloud. The following guide will show you how to set up a free environment to build and test your Jekyll project.
|
||||
[Buddy][buddy-homepage] is a [Docker][docker-homepage]-based CI server that you can set up in 15-20 minutes to build, test, and deploy your Jekyll websites. It supports [GitHub][github-homepage], [Bitbucket][bitbucket-homepage], and [GitLab][gitlab-homepage] repositories, and can be installed on-premises or used in cloud. The following guide will show you how to set up a free environment to build and test your Jekyll project.
|
||||
|
||||
[buddyworks-homepage]: https://buddy.works
|
||||
[buddy-homepage]: https://buddy.works
|
||||
[docker-homepage]: https://www.docker.com/
|
||||
[github-homepage]: https://github.com
|
||||
[bitbucket-homepage]: https://bitbucket.org/
|
||||
@@ -12,7 +12,7 @@ title: "BuddyWorks"
|
||||
|
||||
## 1. Getting started
|
||||
|
||||
1. Log in at [https://buddy.works](https://buddy.works) with your GitHub/Bitbucket account or email
|
||||
1. Log in at [https://buddy.works][buddy-homepage] with your GitHub/Bitbucket account or email
|
||||
2. Choose your Git provider and select or push your Jekyll Project
|
||||
3. Create a new pipeline and set the trigger mode to 'On every push'
|
||||
4. Add and configure the Jekyll action and save the pipeline
|
||||
@@ -29,7 +29,7 @@ Whenever you make a push to the selected branch, the Jekyll action runs `jekyll
|
||||
|
||||
If you prefer configuration as code over GUI, you can generate a `buddy.yml` that will create a pipeline with the Jekyll action once you push it to the target branch:
|
||||
|
||||
```ruby
|
||||
```yaml
|
||||
- pipeline: "Build and Deploy Jekyll site"
|
||||
trigger_mode: "ON_EVERY_PUSH"
|
||||
ref_name: "master"
|
||||
@@ -45,7 +45,7 @@ If you prefer configuration as code over GUI, you can generate a `buddy.yml` tha
|
||||
|
||||
## 4. Setting up on-premises server
|
||||
|
||||
The self-hosted version of BuddyWorks can be installed on any type of server supporting Docker, including [Linux][bw-linux], [Mac][bw-mac], [AWS EC2][bw-aws-ec2], [DigitalOcean][bw-digitalocean], and [Microsoft Azure][bw-azure].
|
||||
The self-hosted version of Buddy can be installed on any type of server supporting Docker, including [Linux][bw-linux], [Mac][bw-mac], [AWS EC2][bw-aws-ec2], [DigitalOcean][bw-digitalocean], and [Microsoft Azure][bw-azure].
|
||||
|
||||
[bw-linux]: https://buddy.works/knowledge/standalone/installation-linux
|
||||
[bw-mac]: https://buddy.works/knowledge/standalone/installation-mac-osx
|
||||
@@ -55,8 +55,8 @@ The self-hosted version of BuddyWorks can be installed on any type of server sup
|
||||
|
||||
## 5. Questions?
|
||||
|
||||
This entire guide is open-source. Go ahead and [edit it][jekyll-docs-ci-buddyworks] if you want to expand it or have a fix or [ask for help][jekyll-help] if you run into trouble and need assistance. BuddyWorks also has an [online community][buddyworks-forum] for help.
|
||||
This entire guide is open-source. Go ahead and [edit it][jekyll-docs-ci-buddy] if you want to expand it or have a fix or [ask for help][jekyll-help] if you run into trouble and need assistance. Buddy also has an [online community][buddy-forum] for help.
|
||||
|
||||
[jekyll-docs-ci-buddyworks]: https://github.com/jekyll/jekyll/edit/master/docs/_docs/continuous-integration/buddyworks.md
|
||||
[jekyll-docs-ci-buddy]: https://github.com/jekyll/jekyll/edit/master/docs/_docs/continuous-integration/buddyworks.md
|
||||
[jekyll-help]: https://jekyllrb.com/help/
|
||||
[buddyworks-forum]: http://forum.buddy.works/
|
||||
[buddy-forum]: http://forum.buddy.works/
|
||||
|
||||
@@ -25,7 +25,7 @@ The easiest way to manage dependencies for a Jekyll project (with or without Cir
|
||||
|
||||
[4]: http://bundler.io/gemfile.html
|
||||
|
||||
```yaml
|
||||
```ruby
|
||||
source 'https://rubygems.org'
|
||||
|
||||
ruby '2.4.0'
|
||||
@@ -40,7 +40,7 @@ CircleCI detects when `Gemfile` is present is will automatically run `bundle ins
|
||||
|
||||
The most basic test that can be run is simply seeing if `jekyll build` actually works. This is a blocker, a dependency if you will, for other tests you might run on the generate site. So we'll run Jekyll, via Bundler, in the `dependencies` phase.
|
||||
|
||||
```
|
||||
```yaml
|
||||
dependencies:
|
||||
post:
|
||||
- bundle exec jekyll build
|
||||
@@ -63,7 +63,7 @@ test:
|
||||
|
||||
When you put it all together, here's an example of what that `circle.yml` file could look like:
|
||||
|
||||
```
|
||||
```yaml
|
||||
machine:
|
||||
environment:
|
||||
NOKOGIRI_USE_SYSTEM_LIBRARIES: true # speeds up installation of html-proofer
|
||||
|
||||
@@ -7,4 +7,4 @@ Continuous Integration (CI) enables you to publish your Jekyll generated website
|
||||
|
||||
* [Travis CI](travis-ci)
|
||||
* [CircleCI](circleci)
|
||||
* [BuddyWorks](buddyworks)
|
||||
* [Buddy](buddyworks)
|
||||
|
||||
@@ -49,7 +49,7 @@ Some options can be specified via command-line switches. Check out the
|
||||
For example to avoid testing external sites, use this command:
|
||||
|
||||
```sh
|
||||
$ bundle exec htmlproofer ./_site --disable-external
|
||||
bundle exec htmlproofer ./_site --disable-external
|
||||
```
|
||||
|
||||
### The HTML Proofer Library
|
||||
|
||||
@@ -8,10 +8,7 @@ Hi there! Interested in contributing to Jekyll? We'd love your help. Jekyll is a
|
||||
|
||||
## Where to get help or report a problem
|
||||
|
||||
* If you have a question about using Jekyll, start a discussion on [Jekyll Talk](https://talk.jekyllrb.com).
|
||||
* If you think you've found a bug within a Jekyll plugin, open an issue in that plugin's repository.
|
||||
* If you think you've found a bug within Jekyll itself, [open an issue](https://github.com/jekyll/jekyll/issues/new).
|
||||
* More resources are listed on our [Help page](https://jekyllrb.com/help/).
|
||||
See [the support guidelines](https://jekyllrb.com/docs/support/)
|
||||
|
||||
## Ways to contribute
|
||||
|
||||
@@ -118,25 +115,37 @@ If your contribution changes any Jekyll behavior, make sure to update the docume
|
||||
|
||||
* Don't bump the Gem version in your pull request (if you don't know what that means, you probably didn't).
|
||||
|
||||
* You can use the command `script/console` to start a REPL to explore the result of
|
||||
Jekyll's methods. It also provides you with helpful methods to quickly create a
|
||||
site or configuration. [Feel free to check it out!](https://github.com/jekyll/jekyll/blob/master/script/console)
|
||||
|
||||
## Running tests locally
|
||||
|
||||
### Test Dependencies
|
||||
|
||||
To run the test suite and build the gem you'll need to install Jekyll's dependencies by running the following command:
|
||||
|
||||
<pre class="highlight"><code>$ script/bootstrap</code></pre>
|
||||
```sh
|
||||
script/bootstrap
|
||||
```
|
||||
|
||||
Before you make any changes, run the tests and make sure that they pass (to confirm your environment is configured properly):
|
||||
|
||||
<pre class="highlight"><code>$ script/cibuild</code></pre>
|
||||
```sh
|
||||
script/cibuild
|
||||
```
|
||||
|
||||
If you are only updating a file in `test/`, you can use the command:
|
||||
|
||||
<pre class="highlight"><code>$ script/test test/blah_test.rb</code></pre>
|
||||
```sh
|
||||
script/test test/blah_test.rb
|
||||
```
|
||||
|
||||
If you are only updating a `.feature` file, you can use the command:
|
||||
|
||||
<pre class="highlight"><code>$ script/cucumber features/blah.feature</code></pre>
|
||||
```sh
|
||||
script/cucumber features/blah.feature
|
||||
```
|
||||
|
||||
Both `script/test` and `script/cucumber` can be run without arguments to
|
||||
run its entire respective suite.
|
||||
|
||||
@@ -56,8 +56,8 @@ determines the variable name).
|
||||
|
||||
You can now render the list of members in a template:
|
||||
|
||||
```html
|
||||
{% raw %}
|
||||
```liquid
|
||||
<ul>
|
||||
{% for member in site.data.members %}
|
||||
<li>
|
||||
@@ -67,8 +67,8 @@ You can now render the list of members in a template:
|
||||
</li>
|
||||
{% endfor %}
|
||||
</ul>
|
||||
{% endraw %}
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
{: .note .info }
|
||||
If your Jekyll site has a lot of pages, such as with documentation websites, see the detailed examples in [how to build robust navigation for your site]({% link _tutorials/navigation.md %}).
|
||||
@@ -106,8 +106,8 @@ members:
|
||||
The organizations can then be accessed via `site.data.orgs`, followed by the
|
||||
file name:
|
||||
|
||||
```html
|
||||
{% raw %}
|
||||
```liquid
|
||||
<ul>
|
||||
{% for org_hash in site.data.orgs %}
|
||||
{% assign org = org_hash[1] %}
|
||||
@@ -119,8 +119,8 @@ file name:
|
||||
</li>
|
||||
{% endfor %}
|
||||
</ul>
|
||||
{% endraw %}
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
## Example: Accessing a specific author
|
||||
|
||||
@@ -136,8 +136,8 @@ dave:
|
||||
|
||||
The author can then be specified as a page variable in a post's frontmatter:
|
||||
|
||||
```html
|
||||
{% raw %}
|
||||
```liquid
|
||||
---
|
||||
title: sample post
|
||||
author: dave
|
||||
@@ -149,8 +149,7 @@ author: dave
|
||||
title="{{ author.name }}">
|
||||
{{ author.name }}
|
||||
</a>
|
||||
|
||||
{% endraw %}
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
For information on how to build robust navigation for your site (especially if you have a documentation website or another type of Jekyll site with a lot of pages to organize), see [Navigation](/tutorials/navigation).
|
||||
|
||||
@@ -5,6 +5,31 @@ permalink: /docs/deployment-methods/
|
||||
|
||||
Sites built using Jekyll can be deployed in a large number of ways due to the static nature of the generated output. A few of the most common deployment techniques are described below.
|
||||
|
||||
<div class="note">
|
||||
<h5>ProTip™: Use GitHub Pages for zero-hassle Jekyll hosting</h5>
|
||||
<p>GitHub Pages are powered by Jekyll behind the scenes, so if you’re looking for a zero-hassle, zero-cost solution, GitHub Pages are a great way to <a href="../github-pages/">host your Jekyll-powered website for free</a>.</p>
|
||||
</div>
|
||||
|
||||
## Netlify
|
||||
|
||||
Netlify provides Global CDN, Continuous Deployment, one click HTTPS and [much more](https://www.netlify.com/features/), providing developers the most robust toolset available for modern web projects, without added complexity. Netlify supports custom plugins for Jekyll and has a free plan for open source projects.
|
||||
|
||||
Read this [Jekyll step-by-step guide](https://www.netlify.com/blog/2015/10/28/a-step-by-step-guide-jekyll-3.0-on-netlify/) to setup your Jekyll site on Netlify.
|
||||
|
||||
## Aerobatic
|
||||
|
||||
[Aerobatic](https://www.aerobatic.com) has custom domains, global CDN distribution, basic auth, CORS proxying, and a growing list of plugins all included.
|
||||
|
||||
Automating the deployment of a Jekyll site is simple. See their [Jekyll docs](https://www.aerobatic.com/docs/static-site-generators/#jekyll) for more details. Your built `_site` folder is deployed to their highly-available, globally distributed hosting service.
|
||||
|
||||
## Kickster
|
||||
|
||||
Use [Kickster](http://kickster.nielsenramon.com/) for easy (automated) deploys to GitHub Pages when using unsupported plugins on GitHub Pages.
|
||||
|
||||
Kickster provides a basic Jekyll project setup packed with web best practises and useful optimization tools increasing your overall project quality. Kickster ships with automated and worry-free deployment scripts for GitHub Pages.
|
||||
|
||||
Setting up Kickster is very easy, just install the gem and you are good to go. More documentation can here found [here](https://github.com/nielsenramon/kickster#kickster). If you do not want to use the gem or start a new project you can just copy paste the deployment scripts for [Travis CI](https://github.com/nielsenramon/kickster/tree/master/snippets/travis) or [Circle CI](https://github.com/nielsenramon/kickster#automated-deployment-with-circle-ci).
|
||||
|
||||
## Web hosting providers (FTP)
|
||||
|
||||
Just about any traditional web hosting provider will let you upload files to their servers over FTP. To upload a Jekyll site to a web host using FTP, simply run the `jekyll build` command and copy the contents of the generated `_site` folder to the root folder of your hosting account. This is most likely to be the `httpdocs` or `public_html` folder on most hosting providers.
|
||||
@@ -41,13 +66,15 @@ server$ mkdir /var/www/myrepo
|
||||
Next, add the following lines to hooks/post-receive and be sure Jekyll is
|
||||
installed on the server:
|
||||
|
||||
```sh
|
||||
```bash
|
||||
GIT_REPO=$HOME/myrepo.git
|
||||
TMP_GIT_CLONE=$HOME/tmp/myrepo
|
||||
GEMFILE=$TMP_GIT_CLONE/Gemfile
|
||||
PUBLIC_WWW=/var/www/myrepo
|
||||
|
||||
git clone $GIT_REPO $TMP_GIT_CLONE
|
||||
jekyll build -s $TMP_GIT_CLONE -d $PUBLIC_WWW
|
||||
BUNDLE_GEMFILE=$GEMFILE bundle install
|
||||
BUNDLE_GEMFILE=$GEMFILE bundle exec jekyll build -s $TMP_GIT_CLONE -d $PUBLIC_WWW
|
||||
rm -Rf $TMP_GIT_CLONE
|
||||
exit
|
||||
```
|
||||
@@ -187,22 +214,3 @@ low-volume blogs as you only pay for what you use.
|
||||
|
||||
If you'd like to deploy your site to an OpenShift gear, there's [a cartridge
|
||||
for that](https://github.com/openshift-quickstart/jekyll-openshift).
|
||||
|
||||
<div class="note">
|
||||
<h5>ProTip™: Use GitHub Pages for zero-hassle Jekyll hosting</h5>
|
||||
<p>GitHub Pages are powered by Jekyll behind the scenes, so if you’re looking for a zero-hassle, zero-cost solution, GitHub Pages are a great way to <a href="../github-pages/">host your Jekyll-powered website for free</a>.</p>
|
||||
</div>
|
||||
|
||||
## Kickster
|
||||
|
||||
Use [Kickster](http://kickster.nielsenramon.com/) for easy (automated) deploys to GitHub Pages when using unsupported plugins on GitHub Pages.
|
||||
|
||||
Kickster provides a basic Jekyll project setup packed with web best practises and useful optimization tools increasing your overall project quality. Kickster ships with automated and worry-free deployment scripts for GitHub Pages.
|
||||
|
||||
Setting up Kickster is very easy, just install the gem and you are good to go. More documentation can here found [here](https://github.com/nielsenramon/kickster#kickster). If you do not want to use the gem or start a new project you can just copy paste the deployment scripts for [Travis CI](https://github.com/nielsenramon/kickster/tree/master/snippets/travis) or [Circle CI](https://github.com/nielsenramon/kickster#automated-deployment-with-circle-ci).
|
||||
|
||||
## Aerobatic
|
||||
|
||||
[Aerobatic](https://www.aerobatic.com) has custom domains, global CDN distribution, basic auth, CORS proxying, and a growing list of plugins all included.
|
||||
|
||||
Automating the deployment of a Jekyll site is simple. See our [Jekyll docs](https://www.aerobatic.com/docs/static-site-generators/#jekyll) for more details. Your built `_site` folder is deployed to our highly-available, globally distributed hosting service.
|
||||
|
||||
@@ -68,6 +68,20 @@ front matter of a page or post.
|
||||
<code>_layouts</code> directory.
|
||||
|
||||
</p>
|
||||
<ul>
|
||||
<li>
|
||||
Using <code>null</code> will produce a file without using a layout
|
||||
file. However this is overridden if the file is a post/document and has a
|
||||
layout defined in the <a href="../configuration/#front-matter-defaults">
|
||||
frontmatter defaults</a>.
|
||||
</li>
|
||||
<li>
|
||||
Starting from version 3.5.0, using <code>none</code> in a post/document will
|
||||
produce a file without using a layout file regardless of frontmatter defaults.
|
||||
Using <code>none</code> in a page, however, will cause Jekyll to attempt to
|
||||
use a layout named "none".
|
||||
</li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -115,14 +129,14 @@ data that is sent to the Liquid templating engine during the conversion. For
|
||||
instance, if you set a title, you can use that in your layout to set the page
|
||||
title:
|
||||
|
||||
```html
|
||||
```liquid
|
||||
<!DOCTYPE HTML>
|
||||
<html>
|
||||
<head>
|
||||
<title>{% raw %}{{ page.title }}{% endraw %}</title>
|
||||
</head>
|
||||
<body>
|
||||
...
|
||||
…
|
||||
```
|
||||
|
||||
## Predefined Variables for Posts
|
||||
@@ -153,7 +167,7 @@ These are available out-of-the-box to be used in the front matter for a post.
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<p style="margin-bottom: 5px;"><code>category</code></p>
|
||||
<p><code>category</code></p>
|
||||
<p><code>categories</code></p>
|
||||
</td>
|
||||
<td>
|
||||
|
||||
@@ -4,103 +4,82 @@ permalink: /docs/github-pages/
|
||||
---
|
||||
|
||||
[GitHub Pages](https://pages.github.com) are public web pages for users,
|
||||
organizations, and repositories, that are freely hosted on GitHub's
|
||||
`github.io` domain or on a custom domain name of your choice. GitHub Pages are
|
||||
powered by Jekyll behind the scenes, so in addition to supporting regular HTML
|
||||
content, they’re also a great way to host your Jekyll-powered website for free.
|
||||
organizations, and repositories, that are freely hosted on GitHub's `github.io`
|
||||
domain or on a custom domain name of your choice. GitHub Pages are powered by
|
||||
Jekyll behind the scenes, so they're a great way to host your Jekyll-powered
|
||||
website for free.
|
||||
|
||||
Your site is automatically generated by GitHub Pages when you push your source
|
||||
files. Note that GitHub Pages works equally well for regular HTML content,
|
||||
simply because Jekyll treats files without YAML front matter as static assets.
|
||||
So if you only need to push generated HTML, you're good to go without any
|
||||
further setup.
|
||||
|
||||
Never built a website with GitHub Pages before? [See this marvelous guide by
|
||||
Jonathan McGlone to get you up and running](http://jmcglone.com/guides/github-pages/).
|
||||
This guide will teach you what you need to know about Git, GitHub, and Jekyll to create your very own website on GitHub Pages.
|
||||
Jonathan McGlone](http://jmcglone.com/guides/github-pages/) to get you up and
|
||||
running. This guide will teach you what you need to know about Git, GitHub, and
|
||||
Jekyll to create your very own website on GitHub Pages.
|
||||
|
||||
## The github-pages gem
|
||||
|
||||
Our friends at GitHub have provided the
|
||||
[github-pages](https://github.com/github/pages-gem) gem which is used to manage
|
||||
[Jekyll and its dependencies on GitHub Pages](https://pages.github.com/versions/).
|
||||
Using it in your projects means that when you deploy your site to GitHub Pages,
|
||||
you will not be caught by unexpected differences between various versions of the
|
||||
gems.
|
||||
|
||||
Note that GitHub Pages runs in `safe` mode and only allows [a set of whitelisted
|
||||
plugins](https://help.github.com/articles/configuring-jekyll-plugins/#default-plugins).
|
||||
|
||||
To use the currently-deployed version of the gem in your project, add the
|
||||
following to your `Gemfile`:
|
||||
|
||||
```ruby
|
||||
source "https://rubygems.org"
|
||||
|
||||
gem "github-pages", group: :jekyll_plugins
|
||||
```
|
||||
|
||||
Be sure to run `bundle update` often.
|
||||
|
||||
<div class="note">
|
||||
<h5>GitHub Pages Documentation, Help, and Support</h5>
|
||||
<p>
|
||||
For more information about what you can do with GitHub Pages, as well as for
|
||||
troubleshooting guides, you should check out
|
||||
<a href="https://help.github.com/categories/github-pages-basics/">GitHub’s Pages Help section</a>.
|
||||
If all else fails, you should contact <a href="https://github.com/contact">GitHub Support</a>.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
### Project Page URL Structure
|
||||
|
||||
Sometimes it's nice to preview your Jekyll site before you push your `gh-pages`
|
||||
branch to GitHub. However, the subdirectory-like URL structure GitHub uses for
|
||||
Project Pages complicates the proper resolution of URLs. In order to assure your site builds properly, use `site.github.url` in your URLs.
|
||||
Project Pages complicates the proper resolution of URLs. In order to assure your
|
||||
site builds properly, use the handy [URL filters](../templates/#filters):
|
||||
|
||||
```html
|
||||
{% raw %}
|
||||
<!-- Useful for styles with static names... -->
|
||||
<link href="{{ site.github.url }}/path/to/css.css" rel="stylesheet">
|
||||
<!-- and for documents/pages whose URLs can change... -->
|
||||
[{{ page.title }}]("{{ page.url | prepend: site.github.url }}")
|
||||
{% endraw %}
|
||||
```liquid
|
||||
<!-- For styles with static names... -->
|
||||
<link href="{{ "/assets/css/style.css" | relative_url }}" rel="stylesheet">
|
||||
<!-- For documents/pages whose URLs can change... -->
|
||||
[{{ page.title }}]("{{ page.url | relative_url }}")
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
This way you can preview your site locally from the site root on localhost,
|
||||
but when GitHub generates your pages from the gh-pages branch all the URLs
|
||||
but when GitHub generates your pages from the `gh-pages` branch all the URLs
|
||||
will resolve properly.
|
||||
|
||||
## Deploying Jekyll to GitHub Pages
|
||||
|
||||
GitHub Pages work by looking at certain branches of repositories on GitHub.
|
||||
There are two basic types available: user/organization pages and project pages.
|
||||
There are two basic types available: [user/organization and project pages](https://help.github.com/articles/user-organization-and-project-pages/).
|
||||
The way to deploy these two types of sites are nearly identical, except for a
|
||||
few minor details.
|
||||
|
||||
<div class="note protip" markdown="1">
|
||||
<div markdown="1">
|
||||
</div>
|
||||
|
||||
##### Use the `github-pages` gem
|
||||
|
||||
Our friends at GitHub have provided the
|
||||
[github-pages](https://github.com/github/pages-gem)
|
||||
gem which is used to manage Jekyll and its dependencies on
|
||||
GitHub Pages. Using it in your projects means that when you deploy
|
||||
your site to GitHub Pages, you will not be caught by unexpected
|
||||
differences between various versions of the gems. To use the
|
||||
currently-deployed version of the gem in your project, add the
|
||||
following to your `Gemfile`:
|
||||
|
||||
<div class="code-block" markdown="1">
|
||||
<div markdown="1">
|
||||
</div>
|
||||
|
||||
```ruby
|
||||
source 'https://rubygems.org'
|
||||
|
||||
require 'json'
|
||||
require 'open-uri'
|
||||
versions = JSON.parse(open('https://pages.github.com/versions.json').read)
|
||||
|
||||
gem 'github-pages', versions['github-pages']
|
||||
```
|
||||
</div>
|
||||
|
||||
This will ensure that when you run `bundle install`, you
|
||||
have the correct version of the `github-pages` gem.
|
||||
|
||||
If that fails, simplify it:
|
||||
|
||||
<div class="code-block" markdown="1">
|
||||
<div markdown="1">
|
||||
</div>
|
||||
|
||||
```ruby
|
||||
source 'https://rubygems.org'
|
||||
|
||||
gem 'github-pages'
|
||||
```
|
||||
</div>
|
||||
|
||||
And be sure to run `bundle update` often.
|
||||
|
||||
If you like to install `pages-gem` on Windows you can find instructions by Jens Willmer on
|
||||
[how to install github-pages gem on Windows (x64)](https://jwillmer.de/blog/tutorial/how-to-install-jekyll-and-pages-gem-on-windows-10-x46#github-pages-and-plugins).
|
||||
</div>
|
||||
|
||||
<div class="note info">
|
||||
<h5>Installing <code>github-pages</code> gem on Windows</h5>
|
||||
<p>
|
||||
While Windows is not officially supported, it is possible
|
||||
to install <code>github-pages</code> gem on Windows.
|
||||
Special instructions can be found on our
|
||||
<a href="../windows/#installation">Windows-specific docs page</a>.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
### User and Organization Pages
|
||||
|
||||
User and organization pages live in a special GitHub repository dedicated to
|
||||
@@ -140,7 +119,7 @@ Please refer to GitHub official documentation on
|
||||
to see more detailed examples.
|
||||
|
||||
<div class="note warning">
|
||||
<h5>Source Files Must be in the Root Directory</h5>
|
||||
<h5>Source files must be in the root directory</h5>
|
||||
<p>
|
||||
GitHub Pages <a href="https://help.github.com/articles/troubleshooting-github-pages-build-failures#source-setting">overrides</a>
|
||||
the <a href="/docs/configuration/#global-configuration">“Site Source”</a>
|
||||
@@ -149,12 +128,13 @@ to see more detailed examples.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
<div class="note">
|
||||
<h5>GitHub Pages Documentation, Help, and Support</h5>
|
||||
<div class="note info">
|
||||
<h5>Installing the <code>github-pages</code> gem on Windows</h5>
|
||||
|
||||
<p>
|
||||
For more information about what you can do with GitHub Pages, as well as for
|
||||
troubleshooting guides, you should check out
|
||||
<a href="https://help.github.com/categories/github-pages-basics/">GitHub’s Pages Help section</a>.
|
||||
If all else fails, you should contact <a href="https://github.com/contact">GitHub Support</a>.
|
||||
While Windows is not officially supported, it is possible
|
||||
to install the <code>github-pages</code> gem on Windows.
|
||||
Special instructions can be found on our
|
||||
<a href="../windows/#installation">Windows-specific docs page</a>.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
@@ -4,6 +4,424 @@ permalink: "/docs/history/"
|
||||
note: This file is autogenerated. Edit /History.markdown instead.
|
||||
---
|
||||
|
||||
## 3.8.1 / 2018-05-01
|
||||
{: #v3-8-1}
|
||||
|
||||
### Bug Fixes
|
||||
{: #bug-fixes-v3-8-1}
|
||||
|
||||
- Fix rendering Liquid constructs in excerpts ([#6945]({{ site.repository }}/issues/6945))
|
||||
- Liquify documents unless published == false ([#6959]({{ site.repository }}/issues/6959))
|
||||
|
||||
|
||||
## 3.8.0 / 2018-04-19
|
||||
{: #v3-8-0}
|
||||
|
||||
### Development Fixes
|
||||
{: #development-fixes-v3-8-0}
|
||||
|
||||
- move duplicate code to a single private method ([#6593]({{ site.repository }}/issues/6593))
|
||||
- Test against Ruby 2.5 on AppVeyor ([#6668]({{ site.repository }}/issues/6668))
|
||||
- Replace simple regex with a native Ruby method ([#6732]({{ site.repository }}/issues/6732))
|
||||
- Codeclimate: exclude livereload.js ([#6776]({{ site.repository }}/issues/6776))
|
||||
- Add a cucumber feature to test link tag ([#6777]({{ site.repository }}/issues/6777))
|
||||
- Fix theme gem feature ([#6784]({{ site.repository }}/issues/6784))
|
||||
- Replace simple regex with equivalent Ruby methods ([#6736]({{ site.repository }}/issues/6736))
|
||||
- Rewrite `script/rubyprof` as a Ruby script ([#6813]({{ site.repository }}/issues/6813))
|
||||
- Add debug output to theme rendering ([#5195]({{ site.repository }}/issues/5195))
|
||||
- fix minitest deprecation warning in test ([#6839]({{ site.repository }}/issues/6839))
|
||||
- Memoize `Site#site_data` ([#6809]({{ site.repository }}/issues/6809))
|
||||
- Memoize document output extension ([#6814]({{ site.repository }}/issues/6814))
|
||||
- Access document permalink attribute efficiently ([#6740]({{ site.repository }}/issues/6740))
|
||||
- Minimize array allocations in the `where` filter ([#6860]({{ site.repository }}/issues/6860))
|
||||
- Bump JRuby ([#6878]({{ site.repository }}/issues/6878))
|
||||
- Assert existence of <collection>.files ([#6907]({{ site.repository }}/issues/6907))
|
||||
- Bump Rubocop to 0.54.x ([#6915]({{ site.repository }}/issues/6915))
|
||||
- Regenerate unconditionally unless its an incremental build ([#6917]({{ site.repository }}/issues/6917))
|
||||
- Centralize require statements ([#6910]({{ site.repository }}/issues/6910))
|
||||
- Bump to Rubocop 0.55 ([#6929]({{ site.repository }}/issues/6929))
|
||||
- Refactor private method `HighlightBlock#parse_options` ([#6822]({{ site.repository }}/issues/6822))
|
||||
|
||||
### Minor Enhancements
|
||||
{: #minor-enhancements-v3-8-0}
|
||||
|
||||
- Two massive performance improvements for large sites ([#6730]({{ site.repository }}/issues/6730))
|
||||
- Cache the list of documents to be written ([#6741]({{ site.repository }}/issues/6741))
|
||||
- Allow Jekyll Doctor to detect stray posts dir ([#6681]({{ site.repository }}/issues/6681))
|
||||
- Excerpt relative-path should match its path ([#6597]({{ site.repository }}/issues/6597))
|
||||
- Remind user to resolve conflict in `jekyll new` with `--force` ([#6801]({{ site.repository }}/issues/6801))
|
||||
- Memoize helper methods in site-cleaner ([#6808]({{ site.repository }}/issues/6808))
|
||||
- Compute document's relative_path faster ([#6767]({{ site.repository }}/issues/6767))
|
||||
- Create a single instance of PostReader per site ([#6759]({{ site.repository }}/issues/6759))
|
||||
- Allow date filters to output ordinal days ([#6773]({{ site.repository }}/issues/6773))
|
||||
- Change regex to sanitize and normalize filenames passed to LiquidRenderer ([#6610]({{ site.repository }}/issues/6610))
|
||||
- Allow passing :strict_variables and :strict_filters options to Liquid's renderer ([#6726]({{ site.repository }}/issues/6726))
|
||||
- Debug writing files during the build process ([#6696]({{ site.repository }}/issues/6696))
|
||||
- Improve regex usage in `Tags::IncludeTag` ([#6848]({{ site.repository }}/issues/6848))
|
||||
- Improve comment included in the starter index.md ([#6916]({{ site.repository }}/issues/6916))
|
||||
- Store and retrieve converter instances for Jekyll::Filters via a hash ([#6856]({{ site.repository }}/issues/6856))
|
||||
- Implement a cache within the `where` filter ([#6868]({{ site.repository }}/issues/6868))
|
||||
- Store regexp in a constant ([#6887]({{ site.repository }}/issues/6887))
|
||||
- Optimize computing filename in LiquidRenderer ([#6841]({{ site.repository }}/issues/6841))
|
||||
|
||||
### Documentation
|
||||
|
||||
- Adding the jekyll-algolia plugin to the list of plugins ([#6737]({{ site.repository }}/issues/6737))
|
||||
- Added Premonition plugin to list of plugins ([#6750]({{ site.repository }}/issues/6750))
|
||||
- Add document on releasing a new version ([#6745]({{ site.repository }}/issues/6745))
|
||||
- Mention Talkyard, a new commenting system for Jekyll and others. ([#6752]({{ site.repository }}/issues/6752))
|
||||
- Add 'jekyll-fontello' to plugins ([#6757]({{ site.repository }}/issues/6757))
|
||||
- Install dh-autoreconf on Windows ([#6765]({{ site.repository }}/issues/6765))
|
||||
- Fix common typos ([#6764]({{ site.repository }}/issues/6764))
|
||||
- Fix documentation for {% raw %}`{{ page.excerpt }}`{% endraw %} ([#6779]({{ site.repository }}/issues/6779))
|
||||
- Update docs on permalink configuration ([#6775]({{ site.repository }}/issues/6775))
|
||||
- Propose fix some typos ([#6785]({{ site.repository }}/issues/6785))
|
||||
- Say hello to Jekyll's New Lead Developer ([#6790]({{ site.repository }}/issues/6790))
|
||||
- Add reference to Liquid to plugin docs ([#6794]({{ site.repository }}/issues/6794))
|
||||
- Draft a release post for v3.7.3 ([#6803]({{ site.repository }}/issues/6803))
|
||||
- add missing step for gem-based theme conversion ([#6802]({{ site.repository }}/issues/6802))
|
||||
- Update windows.md to explain an issue with jekyll new. ([#6838]({{ site.repository }}/issues/6838))
|
||||
- Add Bundler Installation Instructions ([#6828]({{ site.repository }}/issues/6828))
|
||||
- Docs: describe difference between tags and categories ([#6882]({{ site.repository }}/issues/6882))
|
||||
- Add `jekyll-random` plugin to docs ([#6833]({{ site.repository }}/issues/6833))
|
||||
- Fixed typo in description of categories and tags ([#6896]({{ site.repository }}/issues/6896))
|
||||
- Add missing ul-tag ([#6897]({{ site.repository }}/issues/6897))
|
||||
- doc: add liquid tag plugin jekyll-onebox for html previews ([#6898]({{ site.repository }}/issues/6898))
|
||||
- Add `jekyll-w2m` to plugins ([#6855]({{ site.repository }}/issues/6855))
|
||||
- Fix tutorials navigation HTML ([#6919]({{ site.repository }}/issues/6919))
|
||||
- add Arch Linux instalation troubleshoot ([#6782]({{ site.repository }}/issues/6782))
|
||||
- Docs: Install Jekyll on macOS ([#6881]({{ site.repository }}/issues/6881))
|
||||
- Fix CodeClimate badges [ci skip] ([#6930]({{ site.repository }}/issues/6930))
|
||||
- Update index.md ([#6933]({{ site.repository }}/issues/6933))
|
||||
|
||||
### Site Enhancements
|
||||
{: #site-enhancements-v3-8-0}
|
||||
|
||||
- Remove links to Gists ([#6751]({{ site.repository }}/issues/6751))
|
||||
- Always load Google Fonts over HTTPS ([#6792]({{ site.repository }}/issues/6792))
|
||||
- always load analytics.js over HTTPS ([#6807]({{ site.repository }}/issues/6807))
|
||||
|
||||
### Bug Fixes
|
||||
{: #bug-fixes-v3-8-0}
|
||||
|
||||
- Append appropriate closing tag to Liquid block in an excerpt ### -minor ([#6724]({{ site.repository }}/issues/6724))
|
||||
- Bypass rendering via Liquid unless required ([#6735]({{ site.repository }}/issues/6735))
|
||||
- Delegated methods after `private` keyword are meant to be private ([#6819]({{ site.repository }}/issues/6819))
|
||||
- Improve handling non-default collection documents rendering and writing ([#6795]({{ site.repository }}/issues/6795))
|
||||
- Fix passing multiline params to include tag when using the variable syntax ([#6858]({{ site.repository }}/issues/6858))
|
||||
- `include_relative` tag should find related documents in collections gathered within custom `collections_dir` ([#6818]({{ site.repository }}/issues/6818))
|
||||
- Handle liquid tags in excerpts robustly ([#6891]({{ site.repository }}/issues/6891))
|
||||
- Allow front matter defaults to be applied properly to documents gathered under custom `collections_dir` ([#6885]({{ site.repository }}/issues/6885))
|
||||
|
||||
|
||||
## 3.7.3 / 2018-02-25
|
||||
{: #v3-7-3}
|
||||
|
||||
### Bug Fixes
|
||||
{: #bug-fixes-v3-7-3}
|
||||
|
||||
- Do not hardcode locale unless certainly necessary ([#6791]({{ site.repository }}/issues/6791))
|
||||
|
||||
|
||||
## 3.7.2 / 2018-01-25
|
||||
{: #v3-7-2}
|
||||
|
||||
### Development Fixes
|
||||
{: #development-fixes-v3-7-2}
|
||||
|
||||
- CI: Test against Ruby 2.5.0 ([#6664]({{ site.repository }}/issues/6664))
|
||||
- Bump rdoc to 6.0 ([#6600]({{ site.repository }}/issues/6600))
|
||||
- Lint file and bump theme dependencies ([#6698]({{ site.repository }}/issues/6698))
|
||||
- Write a Rubocop Cop to ensure no `#p` or `#puts` calls get committed to master. ([#6615]({{ site.repository }}/issues/6615))
|
||||
- Remove redgreen gem ([#6720]({{ site.repository }}/issues/6720))
|
||||
|
||||
### Site Enhancements
|
||||
{: #site-enhancements-v3-7-2}
|
||||
|
||||
- Display latest version in header ([#6676]({{ site.repository }}/issues/6676))
|
||||
- Update version in `config.yml` via YAML load / dump ([#6677]({{ site.repository }}/issues/6677))
|
||||
|
||||
### Documentation
|
||||
|
||||
- Fix: Add note about posts in context of collections_dir ([#6680]({{ site.repository }}/issues/6680))
|
||||
- Update deploy-script in documentation ([#6666]({{ site.repository }}/issues/6666))
|
||||
- Add note about naming of collections_dir ([#6703]({{ site.repository }}/issues/6703))
|
||||
- Update installation.md ([#6694]({{ site.repository }}/issues/6694))
|
||||
- Add `jekyll-html` to plugins. ([#6654]({{ site.repository }}/issues/6654))
|
||||
- Update plugins.md ([#6716]({{ site.repository }}/issues/6716))
|
||||
- Release v3.7.1 ([#6695]({{ site.repository }}/issues/6695))
|
||||
|
||||
### Bug Fixes
|
||||
{: #bug-fixes-v3-7-2}
|
||||
|
||||
- inform that symlinks are not allowed in safe mode ([#6670]({{ site.repository }}/issues/6670))
|
||||
- Glob scope path only if configured with a pattern ([#6692]({{ site.repository }}/issues/6692))
|
||||
- Add gem "wdm" to all newly generated Gemfiles ([#6711]({{ site.repository }}/issues/6711))
|
||||
- Fix timezone inconsistencies between different ruby version ([#6697]({{ site.repository }}/issues/6697))
|
||||
- Refactor collections_dir feature for consistency ([#6685]({{ site.repository }}/issues/6685))
|
||||
|
||||
### Minor Enhancements
|
||||
{: #minor-enhancements-v3-7-2}
|
||||
|
||||
- Require external library only if necessary ([#6596]({{ site.repository }}/issues/6596))
|
||||
|
||||
|
||||
## 3.7.0 / 2018-01-02
|
||||
{: #v3-7-0}
|
||||
|
||||
### Minor Enhancements
|
||||
{: #minor-enhancements-v3-7-0}
|
||||
|
||||
- Add LiveReload functionality to Jekyll. ([#5142]({{ site.repository }}/issues/5142))
|
||||
- Add Utils::Internet.connected? to determine whether host machine has internet connection. ([#5870]({{ site.repository }}/issues/5870))
|
||||
- Disable default layouts for Pages with a `layout: none` declaration ([#6182]({{ site.repository }}/issues/6182))
|
||||
- Scope path glob ([#6268]({{ site.repository }}/issues/6268))
|
||||
- Allow the user to set collections_dir to put all collections under one subdirectory ([#6331]({{ site.repository }}/issues/6331))
|
||||
- Upgrade to Rouge 3 ([#6381]({{ site.repository }}/issues/6381))
|
||||
- Allow URL filters to work directly with documents ([#6478]({{ site.repository }}/issues/6478))
|
||||
- filter relative_url should keep absolute urls with scheme/authority ([#6490]({{ site.repository }}/issues/6490))
|
||||
- `.sass-cache` doesn't *always* land in `options['source']` ([#6500]({{ site.repository }}/issues/6500))
|
||||
- Allow plugins to modify the obsolete files. ([#6502]({{ site.repository }}/issues/6502))
|
||||
- Add latin mode to `slugify` ([#6509]({{ site.repository }}/issues/6509))
|
||||
- Log Kramdown warnings if log level is WARN ([#6522]({{ site.repository }}/issues/6522))
|
||||
- Add an option to configure kramdown warning output ([#6554]({{ site.repository }}/issues/6554))
|
||||
- Add `json` extension to list of directory indices ([#6550]({{ site.repository }}/issues/6550))
|
||||
- Dependency: Bump jekyll-watch to 2.0 ([#6589]({{ site.repository }}/issues/6589))
|
||||
- Remove paginate check ([#6606]({{ site.repository }}/issues/6606))
|
||||
- update classifier-reborn to 2.2.0 ([#6631]({{ site.repository }}/issues/6631))
|
||||
- Switch to an actively-maintained TOML parser. ([#6652]({{ site.repository }}/issues/6652))
|
||||
- Do not coerce layout paths in theme-gem to the source directory ([#6603]({{ site.repository }}/issues/6603))
|
||||
|
||||
### Bug Fixes
|
||||
{: #bug-fixes-v3-7-0}
|
||||
|
||||
- Raise when theme root directory is not available ([#6455]({{ site.repository }}/issues/6455))
|
||||
- Avoid block parser warning in SmartyPants ([#6565]({{ site.repository }}/issues/6565))
|
||||
- Fail gracefully if "sass" gem cannot be loaded ([#6573]({{ site.repository }}/issues/6573))
|
||||
- return correct file in dir if dir has same name as file ([#6569]({{ site.repository }}/issues/6569))
|
||||
- Register reload hooks in Server#process ([#6605]({{ site.repository }}/issues/6605))
|
||||
- Memoize path to metadata file ([#6602]({{ site.repository }}/issues/6602))
|
||||
- Use `require_relative` to load Jekyll classes ([#6609]({{ site.repository }}/issues/6609))
|
||||
|
||||
### Development Fixes
|
||||
{: #development-fixes-v3-7-0}
|
||||
|
||||
- Added direct collection access to future collection item feature test([#6151]({{ site.repository }}/issues/6151))
|
||||
- add failing test for non-utf8 encoding ([#6339]({{ site.repository }}/issues/6339))
|
||||
- Upgrade to Cucumber 3.0 ([#6395]({{ site.repository }}/issues/6395))
|
||||
- Provide a better default hash for tracking liquid stats ([#6417]({{ site.repository }}/issues/6417))
|
||||
- Add configuration for first-timers bot ([#6431]({{ site.repository }}/issues/6431))
|
||||
- Do not linkify escaped characters as PRs in History ([#6468]({{ site.repository }}/issues/6468))
|
||||
- Rely on jekyll-mentions for linking usernames ([#6469]({{ site.repository }}/issues/6469))
|
||||
- Update first-timers-issue-template.md ([#6472]({{ site.repository }}/issues/6472))
|
||||
- Enable `Lint/RescueWithoutErrorClass` Cop ([#6482]({{ site.repository }}/issues/6482))
|
||||
- Clean up Rubocop config ([#6495]({{ site.repository }}/issues/6495))
|
||||
- Use Gem to discover the location of bundler ([#6499]({{ site.repository }}/issues/6499))
|
||||
- Remove unnecessary encoding comment ([#6513]({{ site.repository }}/issues/6513))
|
||||
- Suggest using Rubocop to automatically fix errors ([#6514]({{ site.repository }}/issues/6514))
|
||||
- Assert raising Psych::SyntaxError when`"strict_front_matter"=>true` ([#6520]({{ site.repository }}/issues/6520))
|
||||
- Use Kernel#Array instead of explicit Array check ([#6525]({{ site.repository }}/issues/6525))
|
||||
- RuboCop: Enable `Style/UnneededCapitalW` cop ([#6526]({{ site.repository }}/issues/6526))
|
||||
- Refactor method to reduce ABC Metric size ([#6529]({{ site.repository }}/issues/6529))
|
||||
- Remove parentheses around arguments to raise ([#6532]({{ site.repository }}/issues/6532))
|
||||
- Use double-quotes around gem name ([#6535]({{ site.repository }}/issues/6535))
|
||||
- Dependencies: upgrade to toml 0.2.0 ([#6541]({{ site.repository }}/issues/6541))
|
||||
- Lock to cucumber 3.0.1 on Ruby 2.1 ([#6546]({{ site.repository }}/issues/6546))
|
||||
- Bump JRuby version in Travis config ([#6561]({{ site.repository }}/issues/6561))
|
||||
- Rescue from Psych::SyntaxError instead of SyntaxError after parsing YAML([#5828]({{ site.repository }}/issues/5828))
|
||||
- Drop forwarding to private methods by exposing those methods as public([#6577]({{ site.repository }}/issues/6577))
|
||||
- Upgrade pygments to v1.x ([#5937]({{ site.repository }}/issues/5937))
|
||||
- Bump yajl-ruby ([#6582]({{ site.repository }}/issues/6582))
|
||||
- Cleanup test_redcarpet.rb ([#6584]({{ site.repository }}/issues/6584))
|
||||
- Add PageWithoutAFile class from jekyll plugins ([#6556]({{ site.repository }}/issues/6556))
|
||||
- Cleanup LiveReloadReactor ([#6607]({{ site.repository }}/issues/6607))
|
||||
|
||||
### Documentation
|
||||
|
||||
- Add formester to the list of saas form backend ([#6059]({{ site.repository }}/issues/6059))
|
||||
- GitHub Pages instructions ([#6384]({{ site.repository }}/issues/6384))
|
||||
- Improve documentation for theme-gem installation ([#6387]({{ site.repository }}/issues/6387))
|
||||
- Fix diff syntax-highlighting ([#6388]({{ site.repository }}/issues/6388))
|
||||
- Update instructions ([#6396]({{ site.repository }}/issues/6396))
|
||||
- Fix code-block highlighting in docs ([#6398]({{ site.repository }}/issues/6398))
|
||||
- Filtering Posts with categories, tags, or other variables ([#6399]({{ site.repository }}/issues/6399))
|
||||
- Fixes formatting on pre-formatted text. ([#6405]({{ site.repository }}/issues/6405))
|
||||
- Added new tutorial to tutorials section on docs ([#6406]({{ site.repository }}/issues/6406))
|
||||
- Updates ([#6407]({{ site.repository }}/issues/6407))
|
||||
- Fix `collections_dir` example ([#6408]({{ site.repository }}/issues/6408))
|
||||
- Renaming duplicate of "Scenario 6" to "Scenario 7" ([#6411]({{ site.repository }}/issues/6411))
|
||||
- Mark `collection_dir` as unreleased ([#6412]({{ site.repository }}/issues/6412))
|
||||
- Fix link to SUPPORT ([#6415]({{ site.repository }}/issues/6415))
|
||||
- Fix list appearance by adding missing `ol` tag ([#6421]({{ site.repository }}/issues/6421))
|
||||
- Explain how to override output collection index page ([#6424]({{ site.repository }}/issues/6424))
|
||||
- Added github-cards to the list of plugins ([#6425]({{ site.repository }}/issues/6425))
|
||||
- CoC violation correspondants ([#6429]({{ site.repository }}/issues/6429))
|
||||
- Add a note about Liquid and syntax highlighting ([#6466]({{ site.repository }}/issues/6466))
|
||||
- Remove `sudo` from macOS troubleshooting instructions ([#6486]({{ site.repository }}/issues/6486))
|
||||
- Add a note on `:jekyll_plugins` group in the docs ([#6488]({{ site.repository }}/issues/6488))
|
||||
- Updated custom-404-page.md ([#6489]({{ site.repository }}/issues/6489))
|
||||
- Fix a few minor issues in the docs ([#6494]({{ site.repository }}/issues/6494))
|
||||
- Add jekyll-pwa-plugin ([#6533]({{ site.repository }}/issues/6533))
|
||||
- Remove Jekyll-Smartify from plugins directory ([#6548]({{ site.repository }}/issues/6548))
|
||||
- Updated Jekyll-Pug listing to include official website ([#6555]({{ site.repository }}/issues/6555))
|
||||
- Remove link to severely outdated asset plugin ([#6613]({{ site.repository }}/issues/6613))
|
||||
- Default time zone depends upon server ([#6617]({{ site.repository }}/issues/6617))
|
||||
- Add `disqus-for-jekyll` to plugins. ([#6618]({{ site.repository }}/issues/6618))
|
||||
- Update "Requirements" for Ruby version ([#6623]({{ site.repository }}/issues/6623))
|
||||
- Fix: Update link to i18n_filter plugin ([#6638]({{ site.repository }}/issues/6638))
|
||||
- Correct WordPress capitalization ([#6645]({{ site.repository }}/issues/6645))
|
||||
- Add Tweetsert, Stickyposts, Paginate::Content ([#6651]({{ site.repository }}/issues/6651))
|
||||
- Post: Jekyll 3.7.0 released ([#6634]({{ site.repository }}/issues/6634))
|
||||
|
||||
### Site Enhancements
|
||||
{: #site-enhancements-v3-7-0}
|
||||
|
||||
- Add special styling for code-blocks run in shell ([#6389]({{ site.repository }}/issues/6389))
|
||||
- Add post about diversity ([#6447]({{ site.repository }}/issues/6447))
|
||||
- Update list of files excluded from Docs site ([#6457]({{ site.repository }}/issues/6457))
|
||||
- Update site History ([#6460]({{ site.repository }}/issues/6460))
|
||||
- Add default twitter card image ([#6476]({{ site.repository }}/issues/6476))
|
||||
- Update normalize.css to v7.0.0 ([#6491]({{ site.repository }}/issues/6491))
|
||||
- Optimize images ([#6519]({{ site.repository }}/issues/6519))
|
||||
- Back to original main navigation ([#6544]({{ site.repository }}/issues/6544))
|
||||
- Styles: mobile-docs select element ([#6545]({{ site.repository }}/issues/6545))
|
||||
- Search with DocSearch by @Algolia ([#6557]({{ site.repository }}/issues/6557))
|
||||
- Site header redesign ([#6567]({{ site.repository }}/issues/6567))
|
||||
- Move logo above site navigation on small screens ([#6570]({{ site.repository }}/issues/6570))
|
||||
- Docs: Include version badge for latest features ([#6574]({{ site.repository }}/issues/6574))
|
||||
- Use version-badge on an existing feature intro ([#6575]({{ site.repository }}/issues/6575))
|
||||
- Add jekyll-category-pages plugin ([#6632]({{ site.repository }}/issues/6632))
|
||||
- Improve docs styling for code to be run in shell ([#6641]({{ site.repository }}/issues/6641))
|
||||
- Fix permalink icon markup in news-item layout ([#6639]({{ site.repository }}/issues/6639))
|
||||
|
||||
|
||||
## 3.6.2 / 2017-10-21
|
||||
{: #v3-6-2}
|
||||
|
||||
### Development Fixes
|
||||
{: #development-fixes-v3-6-2}
|
||||
|
||||
- Update Rubocop to 0.51.0 ([#6444]({{ site.repository }}/issues/6444))
|
||||
- Add test for layout as string ([#6445]({{ site.repository }}/issues/6445))
|
||||
|
||||
### Bug Fixes
|
||||
{: #bug-fixes-v3-6-2}
|
||||
|
||||
- Problematic UTF+bom files ([#6322]({{ site.repository }}/issues/6322))
|
||||
- Always treat `data.layout` as a string ([#6442]({{ site.repository }}/issues/6442))
|
||||
|
||||
|
||||
## 3.6.1 / 2017-10-20
|
||||
{: #v3-6-1}
|
||||
|
||||
### Documentation
|
||||
|
||||
- Doc y_day in docs/permalinks ([#6244]({{ site.repository }}/issues/6244))
|
||||
- Update frontmatter.md ([#6371]({{ site.repository }}/issues/6371))
|
||||
- Elaborate on excluding items from processing ([#6136]({{ site.repository }}/issues/6136))
|
||||
- Style lists in tables ([#6379]({{ site.repository }}/issues/6379))
|
||||
- Remove duplicate "available" ([#6380]({{ site.repository }}/issues/6380))
|
||||
|
||||
### Development Fixes
|
||||
{: #development-fixes-v3-6-1}
|
||||
|
||||
- Bump rubocop to use `v0.50.x` ([#6368]({{ site.repository }}/issues/6368))
|
||||
|
||||
|
||||
## 3.6.0 / 2017-09-21
|
||||
{: #v3-6-0}
|
||||
|
||||
### Minor Enhancements
|
||||
{: #minor-enhancements-v3-6-0}
|
||||
|
||||
- Ignore final newline in folded YAML string ([#6054]({{ site.repository }}/issues/6054))
|
||||
- Add URL checks to Doctor ([#5760]({{ site.repository }}/issues/5760))
|
||||
- Fix serving files that clash with directories ([#6222]({{ site.repository }}/issues/6222)) ([#6231]({{ site.repository }}/issues/6231))
|
||||
- Bump supported Ruby version to `>= 2.1.0` ([#6220]({{ site.repository }}/issues/6220))
|
||||
- set `LiquidError#template_name` for errors in included file ([#6206]({{ site.repository }}/issues/6206))
|
||||
- Access custom config array throughout session ([#6200]({{ site.repository }}/issues/6200))
|
||||
- Add support for Rouge 2, in addition to Rouge 1 ([#5919]({{ site.repository }}/issues/5919))
|
||||
- Allow `yield` to logger methods & bail early on no-op messages ([#6315]({{ site.repository }}/issues/6315))
|
||||
- Update mime-types. ([#6336]({{ site.repository }}/issues/6336))
|
||||
- Use a Schwartzian transform with custom sorting ([#6342]({{ site.repository }}/issues/6342))
|
||||
- Alias `Drop#invoke_drop` to `Drop#[]` ([#6338]({{ site.repository }}/issues/6338))
|
||||
|
||||
### Bug Fixes
|
||||
{: #bug-fixes-v3-6-0}
|
||||
|
||||
- `Deprecator`: fix typo for `--serve` command ([#6229]({{ site.repository }}/issues/6229))
|
||||
- `Reader#read_directories`: guard against an entry not being a directory ([#6226]({{ site.repository }}/issues/6226))
|
||||
- kramdown: symbolize keys in-place ([#6247]({{ site.repository }}/issues/6247))
|
||||
- Call `to_s` on site.url before attempting to concatenate strings ([#6253]({{ site.repository }}/issues/6253))
|
||||
- Enforce Style/FrozenStringLiteralComment ([#6265]({{ site.repository }}/issues/6265))
|
||||
- Update theme-template README to note 'assets' directory ([#6257]({{ site.repository }}/issues/6257))
|
||||
- Memoize the return value of `Document#url` ([#6266]({{ site.repository }}/issues/6266))
|
||||
- delegate `StaticFile#to_json` to `StaticFile#to_liquid` ([#6273]({{ site.repository }}/issues/6273))
|
||||
- Fix `Drop#key?` so it can handle a nil argument ([#6281]({{ site.repository }}/issues/6281))
|
||||
- Guard against type error in absolute url ([#6280]({{ site.repository }}/issues/6280))
|
||||
- Mutable drops should fallback to their own methods when a mutation isn't present ([#6350]({{ site.repository }}/issues/6350))
|
||||
- Skip adding binary files as posts ([#6344]({{ site.repository }}/issues/6344))
|
||||
- Don't break if bundler is not installed ([#6377]({{ site.repository }}/issues/6377))
|
||||
|
||||
### Documentation
|
||||
|
||||
- Fix a typo in `custom-404-page.md` ([#6218]({{ site.repository }}/issues/6218))
|
||||
- Docs: fix links to issues in History.markdown ([#6255]({{ site.repository }}/issues/6255))
|
||||
- Update deprecated gems key to plugins. ([#6262]({{ site.repository }}/issues/6262))
|
||||
- Fixes minor typo in post text ([#6283]({{ site.repository }}/issues/6283))
|
||||
- Execute build command using bundle. ([#6274]({{ site.repository }}/issues/6274))
|
||||
- name unification - buddy details ([#6317]({{ site.repository }}/issues/6317))
|
||||
- name unification - application index ([#6318]({{ site.repository }}/issues/6318))
|
||||
- trim and relocate plugin info across docs ([#6311]({{ site.repository }}/issues/6311))
|
||||
- update Jekyll's README ([#6321]({{ site.repository }}/issues/6321))
|
||||
- add SUPPORT file for GitHub ([#6324]({{ site.repository }}/issues/6324))
|
||||
- Rename CODE_OF_CONDUCT to show in banner ([#6325]({{ site.repository }}/issues/6325))
|
||||
- Docs : illustrate page.id for a collection's document ([#6329]({{ site.repository }}/issues/6329))
|
||||
- Docs: post's date can be overriden in YAML front matter ([#6334]({{ site.repository }}/issues/6334))
|
||||
- Docs: `site.url` behavior on development and production environments ([#6270]({{ site.repository }}/issues/6270))
|
||||
- Fix typo in site.url section of variables.md :-[ ([#6337]({{ site.repository }}/issues/6337))
|
||||
- Docs: updates ([#6343]({{ site.repository }}/issues/6343))
|
||||
- Fix precedence docs ([#6346]({{ site.repository }}/issues/6346))
|
||||
- add note to contributing docs about `script/console` ([#6349]({{ site.repository }}/issues/6349))
|
||||
- Docs: Fix permalink example ([#6375]({{ site.repository }}/issues/6375))
|
||||
|
||||
### Site Enhancements
|
||||
{: #site-enhancements-v3-6-0}
|
||||
|
||||
- Adding DevKit helpers ([#6225]({{ site.repository }}/issues/6225))
|
||||
- Customizing url in collection elements clarified ([#6264]({{ site.repository }}/issues/6264))
|
||||
- Plugins is the new gems ([#6326]({{ site.repository }}/issues/6326))
|
||||
|
||||
### Development Fixes
|
||||
{: #development-fixes-v3-6-0}
|
||||
|
||||
- Strip unnecessary leading whitespace in template ([#6228]({{ site.repository }}/issues/6228))
|
||||
- Users should be installing patch versions. ([#6198]({{ site.repository }}/issues/6198))
|
||||
- Fix tests ([#6240]({{ site.repository }}/issues/6240))
|
||||
- Define path with `__dir__` ([#6087]({{ site.repository }}/issues/6087))
|
||||
- exit site.process sooner ([#6239]({{ site.repository }}/issues/6239))
|
||||
- make flakey test more robust ([#6277]({{ site.repository }}/issues/6277))
|
||||
- Add a quick test for DataReader ([#6284]({{ site.repository }}/issues/6284))
|
||||
- script/backport-pr: commit message no longer includes the `#` ([#6289]({{ site.repository }}/issues/6289))
|
||||
- Add Add CODEOWNERS file to help automate reviews. ([#6320]({{ site.repository }}/issues/6320))
|
||||
- Fix builds on codeclimate ([#6333]({{ site.repository }}/issues/6333))
|
||||
- Bump rubies on Travis ([#6366]({{ site.repository }}/issues/6366))
|
||||
|
||||
|
||||
## 3.5.2 / 2017-08-12
|
||||
{: #v3-5-2}
|
||||
|
||||
### Bug Fixes
|
||||
{: #bug-fixes-v3-5-2}
|
||||
|
||||
- Backport [#6281]({{ site.repository }}/issues/6281) for v3.5.x: Fix `Drop#key?` so it can handle a nil argument ([#6288]({{ site.repository }}/issues/6288))
|
||||
- Backport [#6280]({{ site.repository }}/issues/6280) for v3.5.x: Guard against type error in `absolute_url` ([#6287]({{ site.repository }}/issues/6287))
|
||||
- Backport [#6266]({{ site.repository }}/issues/6266) for v3.5.x: Memoize the return value of `Document#url` ([#6301]({{ site.repository }}/issues/6301))
|
||||
- Backport [#6273]({{ site.repository }}/issues/6273) for v3.5.x: delegate `StaticFile#to_json` to `StaticFile#to_liquid` ([#6302]({{ site.repository }}/issues/6302))
|
||||
- Backport [#6226]({{ site.repository }}/issues/6226) for v3.5.x: `Reader#read_directories`: guard against an entry not being a directory ([#6304]({{ site.repository }}/issues/6304))
|
||||
- Backport [#6247]({{ site.repository }}/issues/6247) for v3.5.x: kramdown: symbolize keys in-place ([#6303]({{ site.repository }}/issues/6303))
|
||||
|
||||
|
||||
## 3.5.1 / 2017-07-17
|
||||
{: #v3-5-1}
|
||||
|
||||
@@ -26,8 +444,8 @@ note: This file is autogenerated. Edit /History.markdown instead.
|
||||
- added BibSonomy plugin ([#6143]({{ site.repository }}/issues/6143))
|
||||
- add plugins for multiple page pagination ([#6055]({{ site.repository }}/issues/6055))
|
||||
- Update minimum Ruby version in installation.md ([#6164]({{ site.repository }}/issues/6164))
|
||||
- [docs] Add information about finding a collection in `site.collections` ([#6165]({{ site.repository }}/issues/6165))
|
||||
- Add {%raw%} to Liquid example on site ([#6179]({{ site.repository }}/issues/6179))
|
||||
- Add information about finding a collection in `site.collections` ([#6165]({{ site.repository }}/issues/6165))
|
||||
- Add {% raw %}`{% raw %}`{% endraw %} to Liquid example on site ([#6179]({{ site.repository }}/issues/6179))
|
||||
- Added improved Pug plugin - removed 404 Jade plugin ([#6174]({{ site.repository }}/issues/6174))
|
||||
- Linking the link ([#6210]({{ site.repository }}/issues/6210))
|
||||
- Small correction in documentation for includes ([#6193]({{ site.repository }}/issues/6193))
|
||||
@@ -128,7 +546,7 @@ note: This file is autogenerated. Edit /History.markdown instead.
|
||||
- Be more specific on what to upload ([#6119]({{ site.repository }}/issues/6119))
|
||||
- Remove Blank Newlines from "Jekyll on Windows" Page ([#6126]({{ site.repository }}/issues/6126))
|
||||
- Link the troubleshooting page in the quickstart page ([#6134]({{ site.repository }}/issues/6134))
|
||||
- add documentation about the &[#34]({{ site.repository }}/issues/34);pinned&[#34]({{ site.repository }}/issues/34); label ([#6147]({{ site.repository }}/issues/6147))
|
||||
- add documentation about the "pinned" label ([#6147]({{ site.repository }}/issues/6147))
|
||||
- docs(JekyllOnWindows): Add a new Installation way ([#6141]({{ site.repository }}/issues/6141))
|
||||
- corrected windows.md ([#6149]({{ site.repository }}/issues/6149))
|
||||
- Refine documentation for Windows ([#6153]({{ site.repository }}/issues/6153))
|
||||
@@ -136,7 +554,7 @@ note: This file is autogenerated. Edit /History.markdown instead.
|
||||
### Development Fixes
|
||||
{: #development-fixes-v3-5-0}
|
||||
|
||||
- [Rubocop] add missing comma ([#5835]({{ site.repository }}/issues/5835))
|
||||
- Rubocop: add missing comma ([#5835]({{ site.repository }}/issues/5835))
|
||||
- Appease classifier-reborn ([#5934]({{ site.repository }}/issues/5934))
|
||||
- Allow releases & development on `*-stable` branches ([#5926]({{ site.repository }}/issues/5926))
|
||||
- Add script/backport-pr ([#5925]({{ site.repository }}/issues/5925))
|
||||
@@ -175,7 +593,7 @@ note: This file is autogenerated. Edit /History.markdown instead.
|
||||
{: #bug-fixes-v3-5-0}
|
||||
|
||||
- Exclude Gemfile by default ([#5860]({{ site.repository }}/issues/5860))
|
||||
- Convertible#validate_permalink!: ensure the return value of data["permalink"] is a string before asking if it is empty ([#5878]({{ site.repository }}/issues/5878))
|
||||
- Convertible#validate_permalink!: ensure the return value of `data["permalink"]` is a string before asking if it is empty ([#5878]({{ site.repository }}/issues/5878))
|
||||
- Allow abbreviated post dates ([#5920]({{ site.repository }}/issues/5920))
|
||||
- Remove dependency on include from default about.md ([#5903]({{ site.repository }}/issues/5903))
|
||||
- Allow colons in `uri_escape` filter ([#5957]({{ site.repository }}/issues/5957))
|
||||
@@ -251,7 +669,7 @@ note: This file is autogenerated. Edit /History.markdown instead.
|
||||
- Switch to `https` when possible. ([#5611]({{ site.repository }}/issues/5611))
|
||||
- Update `_font-awesome.scss` to move .woff file before .ttf ([#5614]({{ site.repository }}/issues/5614))
|
||||
- Update documentation on updating FontAwesome Iconset ([#5655]({{ site.repository }}/issues/5655))
|
||||
- [site] Use defaults for docs and news-items ([#5744]({{ site.repository }}/issues/5744))
|
||||
- Use defaults for docs and news-items ([#5744]({{ site.repository }}/issues/5744))
|
||||
- Sort gems in `docs/_config.yml` ([#5746]({{ site.repository }}/issues/5746))
|
||||
- Add missing class ([#5791]({{ site.repository }}/issues/5791))
|
||||
- Improve template docs ([#5694]({{ site.repository }}/issues/5694))
|
||||
@@ -313,7 +731,7 @@ note: This file is autogenerated. Edit /History.markdown instead.
|
||||
- Update quickstart.md ([#5758]({{ site.repository }}/issues/5758))
|
||||
- Correct minor typo ([#5764]({{ site.repository }}/issues/5764))
|
||||
- Fix a markdown link to look properly on the web ([#5769]({{ site.repository }}/issues/5769))
|
||||
- [docs] Info about the help command usage ([#5312]({{ site.repository }}/issues/5312))
|
||||
- Info about the help command usage ([#5312]({{ site.repository }}/issues/5312))
|
||||
- Add missing merge labels for jekyllbot ([#5753]({{ site.repository }}/issues/5753))
|
||||
- Fix broken links in documentation ([#5736]({{ site.repository }}/issues/5736))
|
||||
- Docs: add `match_regex` and `replace_regex` filters ([#5799]({{ site.repository }}/issues/5799))
|
||||
@@ -456,10 +874,10 @@ note: This file is autogenerated. Edit /History.markdown instead.
|
||||
- Site: exclude README.md and .gitignore ([#5304]({{ site.repository }}/issues/5304))
|
||||
- Add link to Staticman ([#5224]({{ site.repository }}/issues/5224))
|
||||
- Update url for OpenShift ([#5320]({{ site.repository }}/issues/5320))
|
||||
- [docs] add help for missing static_file e.g. on heroku ([#5334]({{ site.repository }}/issues/5334))
|
||||
- Add help for missing static_file e.g. on heroku ([#5334]({{ site.repository }}/issues/5334))
|
||||
- Add a line about updating theme-gems in the docs ([#5318]({{ site.repository }}/issues/5318))
|
||||
- Explain how to copy a theme's files ([#5335]({{ site.repository }}/issues/5335))
|
||||
- [docs] .md as default extension in examples ([#5316]({{ site.repository }}/issues/5316))
|
||||
- .md as default extension in examples ([#5316]({{ site.repository }}/issues/5316))
|
||||
- Fix small typo in docs ([#5347]({{ site.repository }}/issues/5347))
|
||||
- Add missing period to sentence in first paragraph. ([#5372]({{ site.repository }}/issues/5372))
|
||||
- added jekyll-spotify plugin ([#5369]({{ site.repository }}/issues/5369))
|
||||
@@ -468,7 +886,7 @@ note: This file is autogenerated. Edit /History.markdown instead.
|
||||
- Add documentation for `relative_url` and `absolute_url` ([#5405]({{ site.repository }}/issues/5405))
|
||||
- Bugfix on logo in JSON-LD ([#5421]({{ site.repository }}/issues/5421))
|
||||
- Fix Travis.ci documentation ([#5413]({{ site.repository }}/issues/5413))
|
||||
- [docs] Update documentation regarding `bundle install` after `jekyll new` ([#5428]({{ site.repository }}/issues/5428))
|
||||
- Update documentation regarding `bundle install` after `jekyll new` ([#5428]({{ site.repository }}/issues/5428))
|
||||
- Replace classic box-sizing reset with inheritance reset ([#5411]({{ site.repository }}/issues/5411))
|
||||
- Update Wikipedia YAML list link ([#5452]({{ site.repository }}/issues/5452))
|
||||
- Add Jekyll 3.3 release post ([#5442]({{ site.repository }}/issues/5442))
|
||||
@@ -479,9 +897,9 @@ note: This file is autogenerated. Edit /History.markdown instead.
|
||||
- Update appveyor.yml and fix optional deps for Ruby x64 ([#5180]({{ site.repository }}/issues/5180))
|
||||
- Improve tests for Jekyll::PluginManager ([#5167]({{ site.repository }}/issues/5167))
|
||||
- Update Ruby versions in travis.yml ([#5221]({{ site.repository }}/issues/5221))
|
||||
- Avoid installing unecessary gems for site testing ([#5272]({{ site.repository }}/issues/5272))
|
||||
- Avoid installing unnecessary gems for site testing ([#5272]({{ site.repository }}/issues/5272))
|
||||
- Proposal: Affinity teams and their captains ([#5273]({{ site.repository }}/issues/5273))
|
||||
- Replace duplicate with postive local test in issue template ([#5286]({{ site.repository }}/issues/5286))
|
||||
- Replace duplicate with positive local test in issue template ([#5286]({{ site.repository }}/issues/5286))
|
||||
- Update AppVeyor config. ([#5240]({{ site.repository }}/issues/5240))
|
||||
- Execute jekyll from clone instead of defined binary when running 'script/default-site' ([#5295]({{ site.repository }}/issues/5295))
|
||||
- rubocop: lib/jekyll/document.rb complexity fixes ([#5045]({{ site.repository }}/issues/5045))
|
||||
@@ -533,7 +951,7 @@ note: This file is autogenerated. Edit /History.markdown instead.
|
||||
- Allow collections to have documents that have no file extension ([#4545]({{ site.repository }}/issues/4545))
|
||||
- Add size property to `group_by` result ([#4557]({{ site.repository }}/issues/4557))
|
||||
- Site Template: Removed unnecessary nesting from `_base.scss` ([#4637]({{ site.repository }}/issues/4637))
|
||||
- Adding a debug log statment for skipped future documents. ([#4558]({{ site.repository }}/issues/4558))
|
||||
- Adding a debug log statement for skipped future documents. ([#4558]({{ site.repository }}/issues/4558))
|
||||
- Site Template: Changed main `<div>` to `<main>` and added accessibility info ([#4636]({{ site.repository }}/issues/4636))
|
||||
- Add array support to `where` filter ([#4555]({{ site.repository }}/issues/4555))
|
||||
- 'jekyll clean': also remove .sass-cache ([#4652]({{ site.repository }}/issues/4652))
|
||||
@@ -784,7 +1202,7 @@ note: This file is autogenerated. Edit /History.markdown instead.
|
||||
### Bug Fixes
|
||||
{: #bug-fixes-v3-1-2}
|
||||
|
||||
- Fix syntax highlighting in kramdown by making `[@config](https://github.com/config)` accessible in the Markdown converter. ([#4428]({{ site.repository }}/issues/4428))
|
||||
- Fix syntax highlighting in kramdown by making `@config` accessible in the Markdown converter. ([#4428]({{ site.repository }}/issues/4428))
|
||||
- `Jekyll.sanitized_path`: sanitizing a questionable path should handle tildes ([#4492]({{ site.repository }}/issues/4492))
|
||||
- Fix `titleize` so already capitalized words are not dropped ([#4525]({{ site.repository }}/issues/4525))
|
||||
- Permalinks which end in a slash should always output HTML ([#4546]({{ site.repository }}/issues/4546))
|
||||
@@ -802,7 +1220,7 @@ note: This file is autogenerated. Edit /History.markdown instead.
|
||||
- Fix broken links to the Code of Conduct ([#4436]({{ site.repository }}/issues/4436))
|
||||
- Upgrade notes: mention trailing slash in permalink; fixes [#4440]({{ site.repository }}/issues/4440) ([#4455]({{ site.repository }}/issues/4455))
|
||||
- Add hooks to the plugin categories toc ([#4463]({{ site.repository }}/issues/4463))
|
||||
- [add note] Jekyll 3 requires newer version of Ruby. ([#4461]({{ site.repository }}/issues/4461))
|
||||
- Jekyll 3 requires newer version of Ruby. ([#4461]({{ site.repository }}/issues/4461))
|
||||
- Fix typo in upgrading docs ([#4473]({{ site.repository }}/issues/4473))
|
||||
- Add note about upgrading documentation on jekyllrb.com/help/ ([#4484]({{ site.repository }}/issues/4484))
|
||||
- Update Rake link ([#4496]({{ site.repository }}/issues/4496))
|
||||
@@ -867,18 +1285,18 @@ note: This file is autogenerated. Edit /History.markdown instead.
|
||||
- Convertible should make layout data accessible via `layout` instead of `page` ([#4205]({{ site.repository }}/issues/4205))
|
||||
- Avoid using `Dir.glob` with absolute path to allow special characters in the path ([#4150]({{ site.repository }}/issues/4150))
|
||||
- Handle empty config files ([#4052]({{ site.repository }}/issues/4052))
|
||||
- Rename `[@options](https://github.com/options)` so that it does not impact Liquid. ([#4173]({{ site.repository }}/issues/4173))
|
||||
- Rename `@options` so that it does not impact Liquid. ([#4173]({{ site.repository }}/issues/4173))
|
||||
- utils/drops: update Drop to support `Utils.deep_merge_hashes` ([#4289]({{ site.repository }}/issues/4289))
|
||||
- Make sure jekyll/drops/drop is loaded first. ([#4292]({{ site.repository }}/issues/4292))
|
||||
- Convertible/Page/Renderer: use payload hash accessor & setter syntax for backwards-compatibility ([#4311]({{ site.repository }}/issues/4311))
|
||||
- Drop: fix hash setter precendence ([#4312]({{ site.repository }}/issues/4312))
|
||||
- Drop: fix hash setter precedence ([#4312]({{ site.repository }}/issues/4312))
|
||||
- utils: `has_yaml_header?` should accept files with extraneous spaces ([#4290]({{ site.repository }}/issues/4290))
|
||||
- Escape html from site.title and page.title in site template ([#4307]({{ site.repository }}/issues/4307))
|
||||
- Allow custom file extensions if defined in `permalink` YAML front matter ([#4314]({{ site.repository }}/issues/4314))
|
||||
- Fix deep_merge_hashes! handling of drops and hashes ([#4359]({{ site.repository }}/issues/4359))
|
||||
- Page should respect output extension of its permalink ([#4373]({{ site.repository }}/issues/4373))
|
||||
- Disable auto-regeneration when running server detached ([#4376]({{ site.repository }}/issues/4376))
|
||||
- Drop#[]: only use public_send for keys in the content_methods array ([#4388]({{ site.repository }}/issues/4388))
|
||||
- Drop#: only use public_send for keys in the content_methods array ([#4388]({{ site.repository }}/issues/4388))
|
||||
- Extract title from filename successfully when no date. ([#4195]({{ site.repository }}/issues/4195))
|
||||
|
||||
### Development Fixes
|
||||
@@ -928,7 +1346,7 @@ note: This file is autogenerated. Edit /History.markdown instead.
|
||||
- Add documentation for smartify Liquid filter ([#4333]({{ site.repository }}/issues/4333))
|
||||
- Fixed broken link to blog on using mathjax with jekyll ([#4344]({{ site.repository }}/issues/4344))
|
||||
- Documentation: correct reference in Precedence section of Configuration docs ([#4355]({{ site.repository }}/issues/4355))
|
||||
- Add [@jmcglone](https://github.com/jmcglone)'s guide to github-pages doc page ([#4364]({{ site.repository }}/issues/4364))
|
||||
- Add @jmcglone's guide to github-pages doc page ([#4364]({{ site.repository }}/issues/4364))
|
||||
- Added the Wordpress2Jekyll Wordpress plugin ([#4377]({{ site.repository }}/issues/4377))
|
||||
- Add Contentful Extension to list of third-party plugins ([#4390]({{ site.repository }}/issues/4390))
|
||||
- Correct Minor spelling error ([#4394]({{ site.repository }}/issues/4394))
|
||||
@@ -1309,7 +1727,7 @@ note: This file is autogenerated. Edit /History.markdown instead.
|
||||
### Site Enhancements
|
||||
{: #site-enhancements-v2-5-3}
|
||||
|
||||
- Add `[@alfredxing](https://github.com/alfredxing)` to the `[@jekyll](https://github.com/jekyll)/core` team. :tada: ([#3218]({{ site.repository }}/issues/3218))
|
||||
- Add @alfredxing to the @jekyll/core team. :tada: ([#3218]({{ site.repository }}/issues/3218))
|
||||
- Document the `-q` option for the `build` and `serve` commands ([#3149]({{ site.repository }}/issues/3149))
|
||||
- Fix some minor typos/flow fixes in documentation website content ([#3165]({{ site.repository }}/issues/3165))
|
||||
- Add `keep_files` to configuration documentation ([#3162]({{ site.repository }}/issues/3162))
|
||||
@@ -1906,7 +2324,7 @@ note: This file is autogenerated. Edit /History.markdown instead.
|
||||
- Fixed typo in datafiles doc page ([#1854]({{ site.repository }}/issues/1854))
|
||||
- Clarify how to access `site` in docs ([#1864]({{ site.repository }}/issues/1864))
|
||||
- Add closing `<code>` tag to `context.registers[:site]` note ([#1867]({{ site.repository }}/issues/1867))
|
||||
- Fix link to [@mojombo](https://github.com/mojombo)'s site source ([#1897]({{ site.repository }}/issues/1897))
|
||||
- Fix link to @mojombo's site source ([#1897]({{ site.repository }}/issues/1897))
|
||||
- Add `paginate: nil` to default configuration in docs ([#1896]({{ site.repository }}/issues/1896))
|
||||
- Add link to our License in the site footer ([#1889]({{ site.repository }}/issues/1889))
|
||||
- Add a charset note in "Writing Posts" doc page ([#1902]({{ site.repository }}/issues/1902))
|
||||
@@ -2373,7 +2791,7 @@ note: This file is autogenerated. Edit /History.markdown instead.
|
||||
- Add documentation about `paginate_path` to "Templates" page in docs ([#1129]({{ site.repository }}/issues/1129))
|
||||
- Give the quick-start guide its own page ([#1191]({{ site.repository }}/issues/1191))
|
||||
- Update ProTip on Installation page in docs to point to all the info about Pygments and the 'highlight' tag. ([#1196]({{ site.repository }}/issues/1196))
|
||||
- Run `site/img` through ImageOptim (thanks [@qrush](https://github.com/qrush)!) ([#1208]({{ site.repository }}/issues/1208))
|
||||
- Run `site/img` through ImageOptim (thanks @qrush!) ([#1208]({{ site.repository }}/issues/1208))
|
||||
- Added Jade Converter to `site/docs/plugins` ([#1210]({{ site.repository }}/issues/1210))
|
||||
- Fix location of docs pages in Contributing pages ([#1214]({{ site.repository }}/issues/1214))
|
||||
- Add ReadInXMinutes plugin to the plugin list ([#1222]({{ site.repository }}/issues/1222))
|
||||
@@ -2855,25 +3273,25 @@ note: This file is autogenerated. Edit /History.markdown instead.
|
||||
{: #v0-5-3}
|
||||
|
||||
- Bug Fixes
|
||||
- Solving the permalink bug where non-html files wouldn't work ([@jeffrydegrande](https://github.com/jeffrydegrande))
|
||||
- Solving the permalink bug where non-html files wouldn't work (@jeffrydegrande)
|
||||
|
||||
|
||||
## 0.5.2 / 2009-06-24
|
||||
{: #v0-5-2}
|
||||
|
||||
- Enhancements
|
||||
- Added --paginate option to the executable along with a paginator object for the payload ([@calavera](https://github.com/calavera))
|
||||
- Added --paginate option to the executable along with a paginator object for the payload (@calavera)
|
||||
- Upgraded RedCloth to 4.2.1, which makes `<notextile>` tags work once again.
|
||||
- Configuration options set in config.yml are now available through the site payload ([@vilcans](https://github.com/vilcans))
|
||||
- Configuration options set in config.yml are now available through the site payload (@vilcans)
|
||||
- Posts can now have an empty YAML front matter or none at all (@ bahuvrihi)
|
||||
- Bug Fixes
|
||||
- Fixing Ruby 1.9 issue that requires `#to_s` on the err object ([@Chrononaut](https://github.com/Chrononaut))
|
||||
- Fixes for pagination and ordering posts on the same day ([@ujh](https://github.com/ujh))
|
||||
- Made pages respect permalinks style and permalinks in yml front matter ([@eugenebolshakov](https://github.com/eugenebolshakov))
|
||||
- Index.html file should always have index.html permalink ([@eugenebolshakov](https://github.com/eugenebolshakov))
|
||||
- Added trailing slash to pretty permalink style so Apache is happy ([@eugenebolshakov](https://github.com/eugenebolshakov))
|
||||
- Fixing Ruby 1.9 issue that requires `#to_s` on the err object (@Chrononaut)
|
||||
- Fixes for pagination and ordering posts on the same day (@ujh)
|
||||
- Made pages respect permalinks style and permalinks in yml front matter (@eugenebolshakov)
|
||||
- Index.html file should always have index.html permalink (@eugenebolshakov)
|
||||
- Added trailing slash to pretty permalink style so Apache is happy (@eugenebolshakov)
|
||||
- Bad markdown processor in config fails sooner and with better message (@ gcnovus)
|
||||
- Allow CRLFs in yaml front matter ([@juretta](https://github.com/juretta))
|
||||
- Allow CRLFs in yaml front matter (@juretta)
|
||||
- Added Date#xmlschema for Ruby versions < 1.9
|
||||
|
||||
|
||||
@@ -2883,15 +3301,15 @@ note: This file is autogenerated. Edit /History.markdown instead.
|
||||
### Major Enhancements
|
||||
{: #major-enhancements-v0-5-1}
|
||||
|
||||
- Next/previous posts in site payload ([@pantulis](https://github.com/pantulis), [@tomo](https://github.com/tomo))
|
||||
- Next/previous posts in site payload (@pantulis, @tomo)
|
||||
- Permalink templating system
|
||||
- Moved most of the README out to the GitHub wiki
|
||||
- Exclude option in configuration so specified files won't be brought over with generated site ([@duritong](https://github.com/duritong))
|
||||
- Exclude option in configuration so specified files won't be brought over with generated site (@duritong)
|
||||
- Bug Fixes
|
||||
- Making sure config.yaml references are all gone, using only config.yml
|
||||
- Fixed syntax highlighting breaking for UTF-8 code ([@henrik](https://github.com/henrik))
|
||||
- Worked around RDiscount bug that prevents Markdown from getting parsed after highlight ([@henrik](https://github.com/henrik))
|
||||
- CGI escaped post titles ([@Chrononaut](https://github.com/Chrononaut))
|
||||
- Fixed syntax highlighting breaking for UTF-8 code (@henrik)
|
||||
- Worked around RDiscount bug that prevents Markdown from getting parsed after highlight (@henrik)
|
||||
- CGI escaped post titles (@Chrononaut)
|
||||
|
||||
|
||||
## 0.5.0 / 2009-04-07
|
||||
@@ -2900,21 +3318,21 @@ note: This file is autogenerated. Edit /History.markdown instead.
|
||||
### Minor Enhancements
|
||||
{: #minor-enhancements-v0-5-0}
|
||||
|
||||
- Ability to set post categories via YAML ([@qrush](https://github.com/qrush))
|
||||
- Ability to set prevent a post from publishing via YAML ([@qrush](https://github.com/qrush))
|
||||
- Add textilize filter ([@willcodeforfoo](https://github.com/willcodeforfoo))
|
||||
- Add 'pretty' permalink style for wordpress-like urls ([@dysinger](https://github.com/dysinger))
|
||||
- Made it possible to enter categories from YAML as an array ([@Chrononaut](https://github.com/Chrononaut))
|
||||
- Ignore Emacs autosave files ([@Chrononaut](https://github.com/Chrononaut))
|
||||
- Ability to set post categories via YAML (@qrush)
|
||||
- Ability to set prevent a post from publishing via YAML (@qrush)
|
||||
- Add textilize filter (@willcodeforfoo)
|
||||
- Add 'pretty' permalink style for wordpress-like urls (@dysinger)
|
||||
- Made it possible to enter categories from YAML as an array (@Chrononaut)
|
||||
- Ignore Emacs autosave files (@Chrononaut)
|
||||
- Bug Fixes
|
||||
- Use block syntax of popen4 to ensure that subprocesses are properly disposed ([@jqr](https://github.com/jqr))
|
||||
- Close open4 streams to prevent zombies ([@rtomayko](https://github.com/rtomayko))
|
||||
- Only query required fields from the WP Database ([@ariejan](https://github.com/ariejan))
|
||||
- Prevent `_posts` from being copied to the destination directory ([@bdimcheff](https://github.com/bdimcheff))
|
||||
- Use block syntax of popen4 to ensure that subprocesses are properly disposed (@jqr)
|
||||
- Close open4 streams to prevent zombies (@rtomayko)
|
||||
- Only query required fields from the WP Database (@ariejan)
|
||||
- Prevent `_posts` from being copied to the destination directory (@bdimcheff)
|
||||
- Refactors
|
||||
- Factored the filtering code into a method ([@Chrononaut](https://github.com/Chrononaut))
|
||||
- Fix tests and convert to Shoulda ([@qrush](https://github.com/qrush), [@technicalpickles](https://github.com/technicalpickles))
|
||||
- Add Cucumber acceptance test suite ([@qrush](https://github.com/qrush), [@technicalpickles](https://github.com/technicalpickles))
|
||||
- Factored the filtering code into a method (@Chrononaut)
|
||||
- Fix tests and convert to Shoulda (@qrush, @technicalpickles)
|
||||
- Add Cucumber acceptance test suite (@qrush, @technicalpickles)
|
||||
|
||||
|
||||
## 0.4.1
|
||||
@@ -2922,9 +3340,9 @@ note: This file is autogenerated. Edit /History.markdown instead.
|
||||
### Minor Enhancements
|
||||
{: #minor-enhancements-v--}
|
||||
|
||||
- Changed date format on wordpress converter (zeropadding) ([@dysinger](https://github.com/dysinger))
|
||||
- Changed date format on wordpress converter (zeropadding) (@dysinger)
|
||||
- Bug Fixes
|
||||
- Add Jekyll binary as executable to gemspec ([@dysinger](https://github.com/dysinger))
|
||||
- Add Jekyll binary as executable to gemspec (@dysinger)
|
||||
|
||||
|
||||
## 0.4.0 / 2009-02-03
|
||||
@@ -2938,20 +3356,20 @@ note: This file is autogenerated. Edit /History.markdown instead.
|
||||
### Minor Enhancements
|
||||
{: #minor-enhancements-v0-4-0}
|
||||
|
||||
- Type importer ([@codeslinger](https://github.com/codeslinger))
|
||||
- `site.topics` accessor ([@baz](https://github.com/baz))
|
||||
- Add `array_to_sentence_string` filter ([@mchung](https://github.com/mchung))
|
||||
- Add a converter for textpattern ([@PerfectlyNormal](https://github.com/PerfectlyNormal))
|
||||
- Add a working Mephisto / MySQL converter ([@ivey](https://github.com/ivey))
|
||||
- Allowing .htaccess files to be copied over into the generated site ([@briandoll](https://github.com/briandoll))
|
||||
- Add option to not put file date in permalink URL ([@mreid](https://github.com/mreid))
|
||||
- Add line number capabilities to highlight blocks ([@jcon](https://github.com/jcon))
|
||||
- Type importer (@codeslinger)
|
||||
- `site.topics` accessor (@baz)
|
||||
- Add `array_to_sentence_string` filter (@mchung)
|
||||
- Add a converter for textpattern (@PerfectlyNormal)
|
||||
- Add a working Mephisto / MySQL converter (@ivey)
|
||||
- Allowing .htaccess files to be copied over into the generated site (@briandoll)
|
||||
- Add option to not put file date in permalink URL (@mreid)
|
||||
- Add line number capabilities to highlight blocks (@jcon)
|
||||
- Bug Fixes
|
||||
- Fix permalink behavior ([@cavalle](https://github.com/cavalle))
|
||||
- Fixed an issue with pygments, markdown, and newlines ([@zpinter](https://github.com/zpinter))
|
||||
- Ampersands need to be escaped ([@pufuwozu](https://github.com/pufuwozu), [@ap](https://github.com/ap))
|
||||
- Test and fix the site.categories hash ([@zzot](https://github.com/zzot))
|
||||
- Fix site payload available to files ([@matrix9180](https://github.com/matrix9180))
|
||||
- Fix permalink behavior (@cavalle)
|
||||
- Fixed an issue with pygments, markdown, and newlines (@zpinter)
|
||||
- Ampersands need to be escaped (@pufuwozu, @ap)
|
||||
- Test and fix the site.categories hash (@zzot)
|
||||
- Fix site payload available to files (@matrix9180)
|
||||
|
||||
|
||||
## 0.3.0 / 2008-12-24
|
||||
@@ -2960,19 +3378,19 @@ note: This file is autogenerated. Edit /History.markdown instead.
|
||||
### Major Enhancements
|
||||
{: #major-enhancements-v0-3-0}
|
||||
|
||||
- Added `--server` option to start a simple WEBrick server on destination directory ([@johnreilly](https://github.com/johnreilly) and [@mchung](https://github.com/mchung))
|
||||
- Added `--server` option to start a simple WEBrick server on destination directory (@johnreilly and @mchung)
|
||||
|
||||
### Minor Enhancements
|
||||
{: #minor-enhancements-v0-3-0}
|
||||
|
||||
- Added post categories based on directories containing `_posts` ([@mreid](https://github.com/mreid))
|
||||
- Added post categories based on directories containing `_posts` (@mreid)
|
||||
- Added post topics based on directories underneath `_posts`
|
||||
- Added new date filter that shows the full month name ([@mreid](https://github.com/mreid))
|
||||
- Merge Post's YAML front matter into its to_liquid payload ([@remi](https://github.com/remi))
|
||||
- Added new date filter that shows the full month name (@mreid)
|
||||
- Merge Post's YAML front matter into its to_liquid payload (@remi)
|
||||
- Restrict includes to regular files underneath `_includes`
|
||||
- Bug Fixes
|
||||
- Change YAML delimiter matcher so as to not chew up 2nd level markdown headers ([@mreid](https://github.com/mreid))
|
||||
- Fix bug that meant page data (such as the date) was not available in templates ([@mreid](https://github.com/mreid))
|
||||
- Change YAML delimiter matcher so as to not chew up 2nd level markdown headers (@mreid)
|
||||
- Fix bug that meant page data (such as the date) was not available in templates (@mreid)
|
||||
- Properly reject directories in `_layouts`
|
||||
|
||||
|
||||
@@ -2980,13 +3398,13 @@ note: This file is autogenerated. Edit /History.markdown instead.
|
||||
{: #v0-2-1}
|
||||
|
||||
- Major Changes
|
||||
- Use Maruku (pure Ruby) for Markdown by default ([@mreid](https://github.com/mreid))
|
||||
- Use Maruku (pure Ruby) for Markdown by default (@mreid)
|
||||
- Allow use of RDiscount with `--rdiscount` flag
|
||||
|
||||
### Minor Enhancements
|
||||
{: #minor-enhancements-v0-2-1}
|
||||
|
||||
- Don't load directory_watcher unless it's needed ([@pjhyett](https://github.com/pjhyett))
|
||||
- Don't load directory_watcher unless it's needed (@pjhyett)
|
||||
|
||||
|
||||
## 0.2.0 / 2008-12-14
|
||||
@@ -3015,10 +3433,10 @@ note: This file is autogenerated. Edit /History.markdown instead.
|
||||
### Minor Enhancements
|
||||
{: #minor-enhancements-v0-1-5}
|
||||
|
||||
- Output informative message if RDiscount is not available ([@JackDanger](https://github.com/JackDanger))
|
||||
- Output informative message if RDiscount is not available (@JackDanger)
|
||||
- Bug Fixes
|
||||
- Prevent Jekyll from picking up the output directory as a source ([@JackDanger](https://github.com/JackDanger))
|
||||
- Skip `related_posts` when there is only one post ([@JackDanger](https://github.com/JackDanger))
|
||||
- Prevent Jekyll from picking up the output directory as a source (@JackDanger)
|
||||
- Skip `related_posts` when there is only one post (@JackDanger)
|
||||
|
||||
|
||||
## 0.1.4 / 2008-12-08
|
||||
@@ -3032,12 +3450,12 @@ note: This file is autogenerated. Edit /History.markdown instead.
|
||||
{: #v0-1-3}
|
||||
|
||||
- Major Features
|
||||
- Markdown support ([@vanpelt](https://github.com/vanpelt))
|
||||
- Mephisto and CSV converters ([@vanpelt](https://github.com/vanpelt))
|
||||
- Code hilighting ([@vanpelt](https://github.com/vanpelt))
|
||||
- Markdown support (@vanpelt)
|
||||
- Mephisto and CSV converters (@vanpelt)
|
||||
- Code hilighting (@vanpelt)
|
||||
- Autobuild
|
||||
- Bug Fixes
|
||||
- Accept both `\r\n` and `\n` in YAML header ([@vanpelt](https://github.com/vanpelt))
|
||||
- Accept both `\r\n` and `\n` in YAML header (@vanpelt)
|
||||
|
||||
|
||||
## 0.1.2 / 2008-11-22
|
||||
|
||||
@@ -5,9 +5,11 @@ permalink: /docs/includes/
|
||||
|
||||
The `include` tag allows you to include the content from another file stored in the `_includes` folder:
|
||||
|
||||
{% raw %}
|
||||
```liquid
|
||||
{% raw %}{% include footer.html %}{% endraw %}
|
||||
{% include footer.html %}
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
Jekyll will look for the referenced file (in this case, `footer.html`) in the `_includes` directory at the root of your source directory and insert its contents.
|
||||
|
||||
@@ -15,9 +17,11 @@ Jekyll will look for the referenced file (in this case, `footer.html`) in the `_
|
||||
|
||||
You can choose to include file fragments relative to the current file by using the `include_relative` tag:
|
||||
|
||||
{% raw %}
|
||||
```liquid
|
||||
{% raw %}{% include_relative somedir/footer.html %}{% endraw %}
|
||||
{% include_relative somedir/footer.html %}
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
You won't need to place your included content within the `_includes` directory. Instead,
|
||||
the inclusion is specifically relative to the file where the tag is being used. For example,
|
||||
@@ -42,9 +46,11 @@ my_variable: footer_company_a.html
|
||||
|
||||
You could then reference that variable in your include:
|
||||
|
||||
{% raw %}
|
||||
```liquid
|
||||
{% raw %}{% include {{ page.my_variable }} %}{% endraw %}
|
||||
{% include {{ page.my_variable }} %}
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
In this example, the include would insert the file `footer_company_a.html` from the `_includes/footer_company_a.html` directory.
|
||||
|
||||
@@ -52,18 +58,22 @@ In this example, the include would insert the file `footer_company_a.html` from
|
||||
|
||||
You can also pass parameters to an include. For example, suppose you have a file called `note.html` in your `_includes` folder that contains this formatting:
|
||||
|
||||
{% raw %}
|
||||
```liquid
|
||||
{% raw %}<div markdown="span" class="alert alert-info" role="alert">
|
||||
<div markdown="span" class="alert alert-info" role="alert">
|
||||
<i class="fa fa-info-circle"></i> <b>Note:</b>
|
||||
{{ include.content }}
|
||||
</div>{% endraw %}
|
||||
</div>
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
The `{% raw %}{{ include.content }}{% endraw %}` is a parameter that gets populated when you call the include and specify a value for that parameter, like this:
|
||||
|
||||
{% raw %}
|
||||
```liquid
|
||||
{% raw %}{% include note.html content="This is my sample note." %} {% endraw %}
|
||||
{% include note.html content="This is my sample note." %}
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
The value of `content` (which is `This is my sample note`) will be inserted into the {% raw %}`{{ include.content }}`{% endraw %} parameter.
|
||||
|
||||
@@ -82,14 +92,16 @@ For example, suppose you have a special image syntax with complex formatting, an
|
||||
|
||||
You could templatize this content in your include and make each value available as a parameter, like this:
|
||||
|
||||
{% raw %}
|
||||
```liquid
|
||||
{% raw %}<figure>
|
||||
<figure>
|
||||
<a href="{{ include.url }}">
|
||||
<img src="{{ include.file }}" style="max-width: {{ include.max-width }};"
|
||||
alt="{{ include.alt }}"/>
|
||||
<figcaption>{{ include.caption }}</figcaption>
|
||||
</figure>{% endraw %}
|
||||
</figure>
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
This include contains 5 parameters:
|
||||
|
||||
@@ -101,15 +113,17 @@ This include contains 5 parameters:
|
||||
|
||||
Here's an example that passes all the parameters to this include (the include file is named `image.html`):
|
||||
|
||||
{% raw %}
|
||||
```liquid
|
||||
{% raw %}{% include image.html url="http://jekyllrb.com"
|
||||
{% include image.html url="http://jekyllrb.com"
|
||||
max-width="200px" file="logo.png" alt="Jekyll logo"
|
||||
caption="This is the Jekyll logo." %} {% endraw %}
|
||||
caption="This is the Jekyll logo." %}
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
The result is the original HTML code shown earlier.
|
||||
|
||||
To safeguard situations where users don't supply a value for the parameter, you can use [Liquid's default filter](https://help.shopify.com/themes/liquid/filters/additional-filters#default).
|
||||
To safeguard situations where users don't supply a value for the parameter, you can use [Liquid's default filter](https://shopify.github.io/liquid/filters/default/).
|
||||
|
||||
Overall, you can create includes that act as templates for a variety of uses — inserting audio or video clips, alerts, special formatting, and more. However, note that you should avoid using too many includes, as this will slow down the build time of your site. For example, don't use includes every time you insert an image. (The above technique shows a use case for special images.)
|
||||
|
||||
@@ -121,16 +135,21 @@ The string you pass to your include parameter can't contain curly braces. For ex
|
||||
|
||||
If you want to include this variable in your parameter that you pass to an include, you need to store the entire parameter as a variable before passing it to the include. You can use `capture` tags to create the variable:
|
||||
|
||||
{% raw %}
|
||||
```liquid
|
||||
{% raw %}{% capture download_note %}The latest version of
|
||||
{{ site.product_name }} is now available.{% endcapture %}{% endraw %}
|
||||
{% capture download_note %}
|
||||
The latest version of {{ site.product_name }} is now available.
|
||||
{% endcapture %}
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
Then pass this captured variable into the parameter for the include. Omit the quotation marks around the parameter content because it's no longer a string (it's a variable):
|
||||
|
||||
{% raw %}
|
||||
```liquid
|
||||
{% raw %}{% include note.html content=download_note %}{% endraw %}
|
||||
{% include note.html content=download_note %}
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
### Passing references to YAML files as parameter values
|
||||
|
||||
@@ -150,18 +169,22 @@ Here's an example. In the `_data` folder, suppose you have a YAML file called `p
|
||||
|
||||
In the `_includes` folder, assume you have a file called `spotlight.html` with this code:
|
||||
|
||||
{% raw %}
|
||||
```liquid
|
||||
{% raw %}{% for person in include.participants %}
|
||||
{% for person in include.participants %}
|
||||
{% if person.login_age == "new" %}
|
||||
{{ person.name }}
|
||||
{% endif %}
|
||||
{% endfor %}{% endraw %}
|
||||
{% endfor %}
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
Now when you insert the `spotlight.html` include file, you can submit the YAML file as a parameter:
|
||||
|
||||
{% raw %}
|
||||
```liquid
|
||||
{% include spotlight.html participants=site.data.profiles %}
|
||||
```
|
||||
{% raw %}{% include spotlight.html participants=site.data.profiles %}{% endraw %}
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
In this instance, `site.data.profiles` gets inserted in place of {% raw %}`include.participants`{% endraw %} in the include file, and the Liquid logic processes. The result will be `Jane Doe`.
|
||||
|
||||
@@ -4,53 +4,38 @@ permalink: /docs/home/
|
||||
redirect_from: /docs/index.html
|
||||
---
|
||||
|
||||
This site aims to be a comprehensive guide to Jekyll. We’ll cover topics such
|
||||
as getting your site up and running, creating and managing your content,
|
||||
customizing the way your site works and looks, deploying to various
|
||||
environments, and give you some advice on participating in the future
|
||||
development of Jekyll itself.
|
||||
This site aims to be a comprehensive guide to Jekyll. We’ll cover topics such as getting your site up and running, creating and managing content, customizing your build, and deploying.
|
||||
|
||||
## So what is Jekyll, exactly?
|
||||
## What is Jekyll, exactly?
|
||||
|
||||
Jekyll is a simple, blog-aware, static site generator. It takes a template
|
||||
directory containing raw text files in various formats, runs it through
|
||||
a converter (like [Markdown](https://daringfireball.net/projects/markdown/))
|
||||
and our [Liquid](https://github.com/Shopify/liquid/wiki) renderer, and
|
||||
spits out a complete, ready-to-publish static website suitable
|
||||
for serving with your favorite web server. Jekyll also happens to be the engine
|
||||
behind [GitHub Pages](https://pages.github.com), which means you can use Jekyll
|
||||
to host your project’s page, blog, or website from GitHub’s servers **for
|
||||
free**.
|
||||
Jekyll is a simple, blog-aware, static site generator.
|
||||
|
||||
## Helpful Hints
|
||||
You create your content as text files ([Markdown](https://daringfireball.net/projects/markdown/)), and organize them into folders. Then, you build the shell of your site using [Liquid](https://shopify.github.io/liquid/)-enhanced HTML templates. Jekyll automatically stitches the content and templates together, generating a website made entirely of static assets, suitable for uploading to any server.
|
||||
|
||||
Throughout this guide there are a number of small-but-handy pieces of
|
||||
information that can make using Jekyll easier, more interesting, and less
|
||||
hazardous. Here’s what to look out for.
|
||||
Jekyll happens to be the engine behind [GitHub Pages](https://pages.github.com), so you can host your project’s Jekyll page/blog/website on GitHub’s servers **for free**.
|
||||
|
||||
## Navigating the Guide
|
||||
|
||||
Throughout this guide, you'll see these special sections that help you get the most out of Jekyll:
|
||||
|
||||
<div class="note">
|
||||
<h5>ProTips™ help you get more from Jekyll</h5>
|
||||
<p>These are tips and tricks that will help you be a Jekyll wizard!</p>
|
||||
<h5>ProTips™</h5>
|
||||
<p>Tips and tricks that'll make you a Jekyll wizard!</p>
|
||||
</div>
|
||||
|
||||
<div class="note info">
|
||||
<h5>Notes are handy pieces of information</h5>
|
||||
<p>These are for the extra tidbits sometimes necessary to understand
|
||||
Jekyll.</p>
|
||||
<h5>Notes</h5>
|
||||
<p>Extra tidbits that are sometimes necessary to understand Jekyll.</p>
|
||||
</div>
|
||||
|
||||
<div class="note warning">
|
||||
<h5>Warnings help you not blow things up</h5>
|
||||
<p>Be aware of these messages if you wish to avoid certain death.</p>
|
||||
<h5>Warnings</h5>
|
||||
<p>Common pitfalls to avoid.</p>
|
||||
</div>
|
||||
|
||||
<div class="note unreleased">
|
||||
<h5>You'll see this by a feature that hasn't been released</h5>
|
||||
<p>Some pieces of this website are for future versions of Jekyll that
|
||||
are not yet released.</p>
|
||||
<h5>Unreleased</h5>
|
||||
<p>Features planned for future versions of Jekyll, but not available yet.</p>
|
||||
</div>
|
||||
|
||||
If you come across anything along the way that we haven’t covered, or if you
|
||||
know of a tip you think others would find handy, please [file an
|
||||
issue]({{ site.repository }}/issues/new) and we’ll see about
|
||||
including it in this guide.
|
||||
If you find anything we haven’t covered, or would like to share a tip that others might find handy, please [file an issue]({{ site.repository }}/issues/new) and we’ll see about adding it to the guide.
|
||||
|
||||
@@ -1,70 +1,176 @@
|
||||
---
|
||||
title: Installation
|
||||
description: Official guide to install Jekyll on macOS, GNU/Linux or Windows.
|
||||
permalink: /docs/installation/
|
||||
---
|
||||
|
||||
Getting Jekyll installed and ready-to-go should only take a few minutes.
|
||||
If it ever becomes a pain, please [file an issue]({{ site.repository }}/issues/new)
|
||||
(or submit a pull request) describing the issue you
|
||||
encountered and how we might make the process easier.
|
||||
Jekyll is a [Ruby Gem](http://guides.rubygems.org/rubygems-basics/), and can be
|
||||
installed on most systems.
|
||||
|
||||
### Requirements
|
||||
- [Requirements](#requirements)
|
||||
- [Install Jekyll on macOS](#macOS)
|
||||
- [Install Jekyll on Ubuntu Linux](#ubuntu)
|
||||
- [Install Jekyll on Windows](../windows/)
|
||||
- [Upgrade Jekyll](#upgrade-jekyll)
|
||||
|
||||
## Requirements
|
||||
|
||||
Installing Jekyll should be straight-forward if all requirements are met.
|
||||
Before you start, make sure your system has the following:
|
||||
|
||||
- GNU/Linux, Unix, or macOS
|
||||
- [Ruby](https://www.ruby-lang.org/en/downloads/) version 2.1 or above, including all development
|
||||
headers
|
||||
- [RubyGems](https://rubygems.org/pages/download)
|
||||
- [GCC](https://gcc.gnu.org/install/) and [Make](https://www.gnu.org/software/make/) (in case your system doesn't have them installed, which you can check by running `gcc -v` and `make -v` in your system's command line interface)
|
||||
- [Ruby](https://www.ruby-lang.org/en/downloads/) version 2.2.5 or above, including all development headers (ruby installation can be checked by running `ruby -v`)
|
||||
- [RubyGems](https://rubygems.org/pages/download) (which you can check by running `gem -v`)
|
||||
- [GCC](https://gcc.gnu.org/install/) and [Make](https://www.gnu.org/software/make/) (in case your system doesn't have them installed, which you can check by running `gcc -v`,`g++ -v` and `make -v` in your system's command line interface)
|
||||
|
||||
#### Only required for Jekyll 2 and earlier
|
||||
## Install on macOS {#macOS}
|
||||
|
||||
- [NodeJS](https://nodejs.org/), or another JavaScript runtime (for CoffeeScript support).
|
||||
- [Python 2.7](https://www.python.org/downloads/)
|
||||
We only cover macOS High Sierra 10.13 here, which comes with Ruby 2.3.3, older systems will need to [install a more recent Ruby version via Homebrew](#homebrew).
|
||||
|
||||
<div class="note info">
|
||||
<h5>Problems installing Jekyll?</h5>
|
||||
<p>
|
||||
Check out the <a href="../troubleshooting/">troubleshooting</a> page or
|
||||
<a href="{{ site.repository }}/issues/new">report an issue</a> so the
|
||||
Jekyll community can improve the experience for everyone.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
<div class="note info">
|
||||
<h5>Running Jekyll on Windows</h5>
|
||||
<p>
|
||||
While Windows is not officially supported, it is possible to get Jekyll running
|
||||
on Windows. Special instructions can be found on our
|
||||
<a href="../windows/#installation">Windows-specific docs page</a>.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
## Install with RubyGems
|
||||
|
||||
The best way to install Jekyll is via
|
||||
[RubyGems](https://rubygems.org/pages/download). At the terminal prompt,
|
||||
simply run the following command to install Jekyll:
|
||||
First, you need to install the command-line tools to be able to compile native extensions, open a terminal and run:
|
||||
|
||||
```sh
|
||||
$ gem install jekyll
|
||||
xcode-select --install
|
||||
```
|
||||
|
||||
All of Jekyll’s gem dependencies are automatically installed by the above
|
||||
command, so you won’t have to worry about them at all.
|
||||
### Set up Ruby included with the OS
|
||||
|
||||
Check your Ruby version meet our requirements:
|
||||
|
||||
```sh
|
||||
ruby -v
|
||||
2.3.3
|
||||
```
|
||||
|
||||
Great, let's install Jekyll. We also need [Bundler](https://bundler.io/) to help us handle [plugins](../plugins) and [themes](../themes):
|
||||
|
||||
```sh
|
||||
gem install bundler jekyll
|
||||
```
|
||||
|
||||
That's it, you're ready to go, either by installing our [default minimal blog theme](https://github.com/jekyll/minima) with `jekyll new jekyll-website` or by starting from scratch:
|
||||
|
||||
```sh
|
||||
mkdir jekyll-website
|
||||
cd jekyll-website
|
||||
|
||||
# Create a Gemfile
|
||||
bundle init
|
||||
|
||||
# Add Jekyll
|
||||
bundle add jekyll
|
||||
|
||||
# Install gems
|
||||
bundle install
|
||||
```
|
||||
|
||||
Great, from there you can now either use a [theme](../themes/) or [create your own layouts](../templates/).
|
||||
|
||||
### Install a newer Ruby version via Homebrew {#homebrew}
|
||||
|
||||
If you wish to install the latest version of Ruby and get faster builds, we recommend to do it via [Homebrew](https://brew.sh) a handy package manager for macOS.
|
||||
|
||||
```sh
|
||||
/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
|
||||
brew install ruby
|
||||
ruby -v
|
||||
ruby 2.5.1p57 (2018-03-29 revision 63029) [x86_64-darwin17]
|
||||
```
|
||||
|
||||
Yay! Now you have a shiny Ruby on your system!
|
||||
|
||||
### Install multiple Ruby versions with rbenv {#rbenv}
|
||||
|
||||
Developers often use [rbenv](https://github.com/rbenv/rbenv) to manage multiple Ruby versions. This can be useful if you want to run the same Ruby version used by [GitHub Pages](https://pages.github.com/versions/) or [Netlify](https://www.netlify.com/docs/#ruby) for instance.
|
||||
|
||||
```sh
|
||||
# Install rbenv and ruby-build
|
||||
brew install rbenv
|
||||
|
||||
# Setup rbenv integration to your shell
|
||||
rbenv init
|
||||
|
||||
# Check your install
|
||||
curl -fsSL https://github.com/rbenv/rbenv-installer/raw/master/bin/rbenv-doctor | bash
|
||||
```
|
||||
|
||||
Restart your terminal for changes to take effect.
|
||||
Now we can install the Ruby version of our choice, let's go with Ruby 2.5.1 here:
|
||||
|
||||
```sh
|
||||
rbenv install 2.5.1
|
||||
rbenv global 2.5.1
|
||||
ruby -v
|
||||
ruby 2.5.1p57 (2018-03-29 revision 63029) [x86_64-darwin17]
|
||||
```
|
||||
|
||||
That's it! Head over [rbenv command references](https://github.com/rbenv/rbenv#command-reference) to learn how to use different versions of Ruby in your projects.
|
||||
|
||||
<div class="note info" markdown="1">
|
||||
|
||||
##### Problems installing Jekyll?
|
||||
|
||||
Check out the [troubleshooting](../troubleshooting/) page or
|
||||
[ask for help on our forum](https://talk.jekyllrb.com).
|
||||
|
||||
<div class="note info">
|
||||
<h5>Installing Xcode Command-Line Tools</h5>
|
||||
<p>
|
||||
If you run into issues installing Jekyll's dependencies which make use of
|
||||
native extensions and are using macOS, you will need to install Xcode
|
||||
and the Command-Line Tools it ships with. Download them in
|
||||
<code>Preferences → Downloads → Components</code>.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
## Install on Ubuntu Linux {#ubuntu}
|
||||
|
||||
Before we install Jekyll, we need to make sure we have all the required
|
||||
dependencies.
|
||||
|
||||
```sh
|
||||
sudo apt-get install ruby ruby-dev build-essential
|
||||
```
|
||||
|
||||
It is best to avoid installing Ruby Gems as the root user. Therefore, we need to
|
||||
set up a gem installation directory for your user account. The following
|
||||
commands will add environment variables to your `~/.bashrc` file to configure
|
||||
the gem installation path. Run them now:
|
||||
|
||||
```sh
|
||||
echo '# Install Ruby Gems to ~/gems' >> ~/.bashrc
|
||||
echo 'export GEM_HOME=$HOME/gems' >> ~/.bashrc
|
||||
echo 'export PATH=$HOME/gems/bin:$PATH' >> ~/.bashrc
|
||||
source ~/.bashrc
|
||||
```
|
||||
|
||||
Finally, install Jekyll:
|
||||
|
||||
```sh
|
||||
gem install jekyll bundler
|
||||
```
|
||||
|
||||
That's it! You're ready to start using Jekyll.
|
||||
|
||||
## Upgrade Jekyll
|
||||
|
||||
Before you start developing with Jekyll, you may want to check that you're up to date with the latest version. To find the currently installed version of Jekyll, run one of these commands:
|
||||
|
||||
```sh
|
||||
jekyll --version
|
||||
gem list jekyll
|
||||
```
|
||||
|
||||
You can use RubyGems to find [the current version of Jekyll](https://rubygems.org/gems/jekyll). Another way to check if you have the latest version is to run the command `gem outdated`. This will provide a list of all the gems on your system that need to be updated. If you aren't running the latest version, run this command:
|
||||
|
||||
```sh
|
||||
bundle update jekyll
|
||||
```
|
||||
|
||||
Alternatively, if you don't have Bundler installed run:
|
||||
|
||||
```sh
|
||||
gem update jekyll
|
||||
```
|
||||
|
||||
To upgrade to latest Rubygems, run:
|
||||
|
||||
```
|
||||
gem update --system
|
||||
```
|
||||
|
||||
Refer to our [upgrading section](../upgrading/) to upgrade from Jekyll 2.x or 1.x.
|
||||
|
||||
## Pre-releases
|
||||
|
||||
In order to install a pre-release, make sure you have all the requirements
|
||||
@@ -86,50 +192,11 @@ more involved. This gives you the advantage of having the latest and greatest,
|
||||
but may be unstable.
|
||||
|
||||
```sh
|
||||
$ git clone git://github.com/jekyll/jekyll.git
|
||||
$ cd jekyll
|
||||
$ script/bootstrap
|
||||
$ bundle exec rake build
|
||||
$ ls pkg/*.gem | head -n 1 | xargs gem install -l
|
||||
```
|
||||
|
||||
## Optional Extras
|
||||
|
||||
There are a number of (optional) extra features that Jekyll supports that you
|
||||
may want to install, depending on how you plan to use Jekyll. These extras
|
||||
include LaTeX support, and the use of alternative content rendering engines.
|
||||
Check out [the extras page](../extras/) for more information.
|
||||
|
||||
<div class="note">
|
||||
<h5>ProTip™: Enable Syntax Highlighting</h5>
|
||||
<p>
|
||||
If you’re the kind of person who is using Jekyll, then chances are you’ll
|
||||
want to enable syntax highlighting using <a href="http://pygments.org/">Pygments</a>
|
||||
or <a href="https://github.com/jayferd/rouge">Rouge</a>. You should really
|
||||
<a href="../templates/#code-snippet-highlighting">check out how to
|
||||
do that</a> before you go any farther.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
## Already Have Jekyll?
|
||||
|
||||
Before you start developing with Jekyll, you may want to check that you're up to date with the latest version. To find your version of Jekyll, run one of these commands:
|
||||
|
||||
```sh
|
||||
$ jekyll --version
|
||||
$ gem list jekyll
|
||||
```
|
||||
|
||||
You can also use [RubyGems](https://rubygems.org/gems/jekyll) to find the current versioning of any gem. But you can also use the `gem` command line tool:
|
||||
|
||||
```sh
|
||||
$ gem search jekyll --remote
|
||||
```
|
||||
|
||||
and you'll search for just the name `jekyll`, and in brackets will be latest version. Another way to check if you have the latest version is to run the command `gem outdated`. This will provide a list of all the gems on your system that need to be updated. If you aren't running the latest version, run this command:
|
||||
|
||||
```sh
|
||||
$ gem update jekyll
|
||||
git clone git://github.com/jekyll/jekyll.git
|
||||
cd jekyll
|
||||
script/bootstrap
|
||||
bundle exec rake build
|
||||
ls pkg/*.gem | head -n 1 | xargs gem install -l
|
||||
```
|
||||
|
||||
Now that you’ve got everything up-to-date and installed, let’s get to work!
|
||||
|
||||
@@ -7,11 +7,11 @@ title: "Avoiding Burnout"
|
||||
|
||||
# 1. Use Jekyll
|
||||
|
||||
Maintainers of Jekyll should be using it regularly. This is partly because you won't be a good maintainer unless you can put yourself in the shoes of our users but also because you may decide to stop using Jekyll and at that point you should also decide not to be a maintainer and find other things to work on.
|
||||
Maintainers of Jekyll should be using it regularly. This is partly because you won't be a good maintainer unless you can put yourself in the shoes of our users, but also because you may at some point decide to stop using Jekyll, and at that point you should also decide to stop being a maintainer and find other things to work on.
|
||||
|
||||
# 2. No Guilt About Leaving
|
||||
|
||||
All maintainers can stop working on Jekyll at any time without any guilt or explanation (like a job). We may still ask for your help with questions after you leave but you are under no obligation to answer them. Like a job, if you create a big mess and then leave you still have no obligations but we may think less of you (or, realistically, probably just revert the problematic work). Like a job, you should probably take a break from Jekyll at least a few times a year.
|
||||
All maintainers can stop working on Jekyll at any time without any guilt or explanation (like at a job). We may still ask for your help with questions after you leave but you are under no obligation to answer them. If you create a big mess and then leave you still have no obligations but we may think less of you (or, realistically, probably just revert the problematic work). Also, you should probably take a break from Jekyll at least a few times a year.
|
||||
|
||||
This also means contributors should be consumers. If a maintainer finds they are not using a project in the real-world, they should reconsider their involvement with the project.
|
||||
|
||||
|
||||
@@ -8,13 +8,14 @@ permalink: /docs/maintaining/
|
||||
|
||||
Hello! This is where we document various processes for maintaining Jekyll. Being a maintainer for any Jekyll project is a big responsibility, so we put together some helpful documentation for various tasks you might do as a maintainer.
|
||||
|
||||
1. [Affinity teams & their captains](affinity-team-captain/)
|
||||
2. [Triaging and issue](triaging-an-issue/)
|
||||
3. [Reviewing a pull request](reviewing-a-pull-request/)
|
||||
4. [Merging a pull request](merging-a-pull-request/)
|
||||
5. [Avoiding burnout](avoiding-burnout/)
|
||||
6. [Special Labels](special-labels/)
|
||||
- [Affinity teams & their captains](affinity-team-captain/)
|
||||
- [Triaging an issue](triaging-an-issue/)
|
||||
- [Reviewing a pull request](reviewing-a-pull-request/)
|
||||
- [Merging a pull request](merging-a-pull-request/)
|
||||
- [Avoiding burnout](avoiding-burnout/)
|
||||
- [Special Labels](special-labels/)
|
||||
- [Releasing a new version](releasing-a-new-version/)
|
||||
|
||||
Interested in becoming a maintainer? Here is some documentation for **contributors**:
|
||||
|
||||
1. [Becoming a maintainer](becoming-a-maintainer/)
|
||||
- [Becoming a maintainer](becoming-a-maintainer/)
|
||||
|
||||
@@ -16,7 +16,7 @@ All pull requests should be subject to code review. Code review is a [foundation
|
||||
We have [a helpful little bot](https://github.com/jekyllbot) which we use to merge pull requests. We don't use the GitHub.com interface for two reasons:
|
||||
|
||||
1. You can't modify anything on mobile (e.g. titles, labels)
|
||||
2. Provide a consistent paper trail in the `History.markdown` file for each release
|
||||
2. We like to provide a consistent paper trail in the `History.markdown` file for each release
|
||||
|
||||
To merge a pull request, leave a comment thanking the contributor, then add the special merge request:
|
||||
|
||||
@@ -30,12 +30,12 @@ The merge request is made up of three things:
|
||||
|
||||
1. `@jekyllbot:` – this is the prefix our bot looks for when processing commands
|
||||
2. `merge` – the command
|
||||
3. `+dev` – the category to which the changes belong
|
||||
3. `+dev` – the category to which the changes belong.
|
||||
|
||||
The categories match the H3's in the history/changelog file, and they are:
|
||||
The categories match the headings in the `History.markdown` file, and they are:
|
||||
|
||||
1. Major Enhancements (`+major`) – major updates or breaking changes to the code which necessitate a major version bump (v3 ~> v4)
|
||||
2. Minor Enhancements (`+minor`) – minor updates (feature, enhancement) which necessitate a minor version bump (v3.1 ~> v3.2)
|
||||
2. Minor Enhancements (`+minor`) – minor updates (with the labels `feature` or `enhancement`) which necessitate a minor version bump (v3.1 ~> v3.2)
|
||||
3. Bug Fixes (`+bug`) – corrections to code which do not change or add functionality, which necessitate a patch version bump (v3.1.0 ~> v3.1.1)
|
||||
4. Documentation (`+doc`) - changes to the documentation found in `docs/_docs/`
|
||||
5. Site Enhancements (`+site`) – changes to the source of [https://jekyllrb.com](https://jekyllrb.com) found in `docs/`
|
||||
|
||||
89
docs/_docs/maintaining/releasing-a-new-version.md
Normal file
89
docs/_docs/maintaining/releasing-a-new-version.md
Normal file
@@ -0,0 +1,89 @@
|
||||
---
|
||||
title: "Releasing a new version"
|
||||
---
|
||||
|
||||
**This guide is for maintainers.** These special people have **write access** to one or more of Jekyll's repositories and help merge the contributions of others. You may find what is written here interesting, but it’s definitely not for everyone.
|
||||
{: .note .info }
|
||||
|
||||
The most important thing to understand before making a release is that there's no need to feel nervous. Most things are revertable, and even if you do publish an incomplete gem version, we can always skip that one. Don't hestitate to contact the other maintainers if you feel unsure or don't know what to do next.
|
||||
|
||||
### Bump the version
|
||||
|
||||
The only important place you need to manually bump the version is in `lib/jekyll/version.rb`. Adjust that, and everything else should work fine.
|
||||
|
||||
### Update the history document
|
||||
|
||||
Replace the first header of the history document with a version milestone. This looks like the following:
|
||||
|
||||
```diff
|
||||
-## HEAD
|
||||
+## 3.7.1 / 2018-01-25
|
||||
```
|
||||
|
||||
Adjust the version number and the date. The `## HEAD` heading will be regenerated next time a pull request is merged.
|
||||
|
||||
Once you've done this, update the website by running the following command:
|
||||
|
||||
```sh
|
||||
bundle exec rake site:generate
|
||||
```
|
||||
|
||||
This updates the website's changelog, and pushes the versions in various other places.
|
||||
|
||||
It's recommended that you go over the `History.markdown` file manually one more time, in case there are any spelling errors or such. Feel free to fix those manually, and after you're done generating the website changelog, commit your changes.
|
||||
|
||||
## Write a release post
|
||||
|
||||
In case this isn't done already, you can generate a new release post using the included `rake` command:
|
||||
|
||||
```sh
|
||||
bundle exec rake site:releases:new[3.8.0]
|
||||
```
|
||||
|
||||
where `3.8.0` should be replaced with the new version. Then, write the post. Be sure to thank all of the collaborators and maintainers who have contributed since the last release. You can generate a log of their names using the following command:
|
||||
|
||||
```sh
|
||||
git shortlog -sn master...v3.7.2
|
||||
```
|
||||
|
||||
where, again `v3.7.2` is the last release. Be sure to open a pull request for your release post.
|
||||
|
||||
### Push the version
|
||||
|
||||
Before you do this step, make sure the following things are done:
|
||||
|
||||
- You have permission to push a new gem version to RubyGems
|
||||
- You're logged into RubyGems on your command line
|
||||
- A release post has been prepared, and is ideally already live
|
||||
- All of the prior steps are done, committed, and pushed to `master`
|
||||
|
||||
Really the only thing left to do is to run this command:
|
||||
|
||||
```sh
|
||||
bundle exec rake release
|
||||
```
|
||||
|
||||
This will automatically build the new gem, make a release commit and tag and then push the new gem to RubyGems. Don't worry about creating a GitHub release, @jekyllbot should take care of that.
|
||||
|
||||
And then, you're done! :tada: Feel free to celebrate!
|
||||
|
||||
If you have access to the [@jekyllrb](https://twitter.com/jekyllrb) Twitter account, you should tweet the release post from there. If not, just ask another maintainer to do it or to give you access.
|
||||
|
||||
### Build the docs
|
||||
|
||||
We package our documentation as a :gem: Gem for offline use.
|
||||
|
||||
This is done with the
|
||||
[**jekyll-docs**](https://github.com/jekyll/jekyll-docs#building) repository,
|
||||
and more detailed instructions are provided there.
|
||||
|
||||
## For non-core gems
|
||||
|
||||
If you're not a maintainer for `jekyll/jekyll`, the procedure is much simpler in a lot of cases. Generally, the procedure still looks like this:
|
||||
|
||||
- Bump the gem version manually, usually in `lib/<plugin_name>/version.rb`
|
||||
- Adjust the history file
|
||||
- Run `bundle exec rake release` or `script/release`, depending on which of the two exists
|
||||
- Rejoice
|
||||
|
||||
Be sure to ask your project's maintainers if you're unsure!
|
||||
@@ -60,7 +60,7 @@ If you have a lot of pages, you can organize those pages into subfolders. The sa
|
||||
|
||||
If you have pages organized into subfolders in your source folder and want to flatten them in the root folder on build, you must add the [permalink]({% link _docs/permalinks.md %}) property directly in your page's front matter like this:
|
||||
|
||||
```
|
||||
```yaml
|
||||
---
|
||||
title: My page
|
||||
permalink: mypageurl.html
|
||||
|
||||
@@ -9,7 +9,7 @@ multiple pages. Jekyll offers a pagination plugin, so you can automatically
|
||||
generate the appropriate files and folders you need for paginated listings.
|
||||
|
||||
For Jekyll 3, include the `jekyll-paginate` plugin in your Gemfile and in
|
||||
your `_config.yml` under `gems`. For Jekyll 2, this is standard.
|
||||
your `_config.yml` under `plugins`. For Jekyll 2, this is standard.
|
||||
|
||||
<div class="note info">
|
||||
<h5>Pagination only works within HTML files</h5>
|
||||
@@ -24,7 +24,7 @@ your `_config.yml` under `gems`. For Jekyll 2, this is standard.
|
||||
|
||||
## Enable pagination
|
||||
|
||||
To enable pagination for your blog, add a line to the `_config.yml` file that
|
||||
To enable pagination for posts on your blog, add a line to the `_config.yml` file that
|
||||
specifies how many items should be displayed per page:
|
||||
|
||||
```yaml
|
||||
@@ -55,6 +55,14 @@ directory.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
<div class="note info">
|
||||
<h5>Pagination for categories, tags and collections</h5>
|
||||
<p>
|
||||
The more recent <a href="https://github.com/sverrirs/jekyll-paginate-v2">jekyll-paginate-v2</a> plugin supports more features. See the <a href="https://github.com/sverrirs/jekyll-paginate-v2/tree/master/examples">pagination examples</a> in the repository.
|
||||
<strong>This plugin is not supported by GitHub Pages</strong>.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
## Liquid Attributes Available
|
||||
|
||||
The pagination plugin exposes the `paginator` liquid object with the following
|
||||
@@ -145,8 +153,8 @@ the `paginator` variable that will now be available to you. You’ll probably
|
||||
want to do this in one of the main pages of your site. Here’s one example of a
|
||||
simple way of rendering paginated Posts in a HTML file:
|
||||
|
||||
```html
|
||||
{% raw %}
|
||||
```liquid
|
||||
---
|
||||
layout: default
|
||||
title: My Blog
|
||||
@@ -177,8 +185,8 @@ title: My Blog
|
||||
<span class="next ">Next</span>
|
||||
{% endif %}
|
||||
</div>
|
||||
{% endraw %}
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
<div class="note warning">
|
||||
<h5>Beware the page one edge-case</h5>
|
||||
@@ -192,8 +200,8 @@ title: My Blog
|
||||
The following HTML snippet should handle page one, and render a list of each
|
||||
page with links to all but the current page.
|
||||
|
||||
```html
|
||||
{% raw %}
|
||||
```liquid
|
||||
{% if paginator.total_pages > 1 %}
|
||||
<div class="pagination">
|
||||
{% if paginator.previous_page %}
|
||||
@@ -219,5 +227,5 @@ page with links to all but the current page.
|
||||
{% endif %}
|
||||
</div>
|
||||
{% endif %}
|
||||
{% endraw %}
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
@@ -6,7 +6,7 @@ permalink: /docs/permalinks/
|
||||
Permalinks refer to the URLs (excluding the domain name or directory folder) for your pages, posts, or collections.
|
||||
Jekyll supports a flexible way to build permalinks, allowing you to leverage various template variables or choose built-in permalink styles (such as `date`) that automatically use a template-variable pattern.
|
||||
|
||||
You construct permalinks by creating a template URL where dynamic elements are represented by colon-prefixed keywords. The default template permalink is `/:categories/:year/:month/:day/:title.html`. Each of the colon-prefixed keywords is a template variable.
|
||||
You construct permalinks by creating a template URL where dynamic elements are represented by colon-prefixed keywords. The default template permalink is `/:categories/:year/:month/:day/:title:output_ext`. Each of the colon-prefixed keywords is a template variable.
|
||||
|
||||
## Where to configure permalinks
|
||||
|
||||
@@ -15,7 +15,7 @@ You can configure your site's permalinks through the [Configuration]({% link _do
|
||||
Setting permalink styles in your configuration file applies the setting globally in your project. You configure permalinks in your `_config.yml` file like this:
|
||||
|
||||
```yaml
|
||||
permalink: /:categories/:year/:month/:day/:title.html
|
||||
permalink: /:categories/:year/:month/:day/:title:output_ext
|
||||
```
|
||||
|
||||
If you don't specify any permalink setting, Jekyll uses the above pattern as the default.
|
||||
@@ -26,7 +26,7 @@ The permalink can also be set using a built-in permalink style:
|
||||
permalink: date
|
||||
```
|
||||
|
||||
`date` is the same as `:categories/:year/:month/:day/:title.html`, the default. See [Built-in Permalink Styles](#builtinpermalinkstyles) below for more options.
|
||||
`date` is the same as `:categories/:year/:month/:day/:title:output_ext`, the default. See [Built-in Permalink Styles](#builtinpermalinkstyles) below for more options.
|
||||
|
||||
Setting the permalink in your post, page, or collection's front matter overrides any global settings. Here's an example:
|
||||
|
||||
@@ -66,7 +66,10 @@ The following table lists the template variables available for permalinks. You c
|
||||
<p><code>year</code></p>
|
||||
</td>
|
||||
<td>
|
||||
<p>Year from the post's filename</p>
|
||||
<p>
|
||||
Year from the post's filename. May be overridden via the document’s
|
||||
<code>date</code> YAML front matter
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -74,7 +77,10 @@ The following table lists the template variables available for permalinks. You c
|
||||
<p><code>month</code></p>
|
||||
</td>
|
||||
<td>
|
||||
<p>Month from the post's filename</p>
|
||||
<p>
|
||||
Month from the post's filename. May be overridden via the document’s
|
||||
<code>date</code> YAML front matter
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -82,7 +88,10 @@ The following table lists the template variables available for permalinks. You c
|
||||
<p><code>i_month</code></p>
|
||||
</td>
|
||||
<td>
|
||||
<p>Month from the post's filename without leading zeros.</p>
|
||||
<p>
|
||||
Month without leading zeros from the post's filename. May be
|
||||
overridden via the document’s <code>date</code> YAML front matter
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -90,7 +99,10 @@ The following table lists the template variables available for permalinks. You c
|
||||
<p><code>day</code></p>
|
||||
</td>
|
||||
<td>
|
||||
<p>Day from the post's filename</p>
|
||||
<p>
|
||||
Day from the post's filename. May be overridden via the document’s
|
||||
<code>date</code> YAML front matter
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -98,7 +110,18 @@ The following table lists the template variables available for permalinks. You c
|
||||
<p><code>i_day</code></p>
|
||||
</td>
|
||||
<td>
|
||||
<p>Day from the post's filename without leading zeros.</p>
|
||||
<p>
|
||||
Day without leading zeros from the post's filename. May be overridden
|
||||
via the document’s <code>date</code> YAML front matter
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<p><code>y_day</code></p>
|
||||
</td>_
|
||||
<td>
|
||||
<p>Day of the year from the post's filename, with leading zeros.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -106,7 +129,10 @@ The following table lists the template variables available for permalinks. You c
|
||||
<p><code>short_year</code></p>
|
||||
</td>
|
||||
<td>
|
||||
<p>Year from the post's filename without the century.</p>
|
||||
<p>
|
||||
Year without the century from the post's filename. May be overridden
|
||||
via the document’s <code>date</code> YAML front matter
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -115,7 +141,8 @@ The following table lists the template variables available for permalinks. You c
|
||||
</td>
|
||||
<td>
|
||||
<p>
|
||||
Hour of the day, 24-hour clock, zero-padded from the post's <code>date</code> front matter. (00..23)
|
||||
Hour of the day, 24-hour clock, zero-padded from the post's
|
||||
<code>date</code> front matter. (00..23)
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
@@ -199,7 +226,7 @@ Although you can specify a custom permalink pattern using [template variables](#
|
||||
<p><code>date</code></p>
|
||||
</td>
|
||||
<td>
|
||||
<p><code>/:categories/:year/:month/:day/:title.html</code></p>
|
||||
<p><code>/:categories/:year/:month/:day/:title:output_ext</code></p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -215,7 +242,7 @@ Although you can specify a custom permalink pattern using [template variables](#
|
||||
<p><code>ordinal</code></p>
|
||||
</td>
|
||||
<td>
|
||||
<p><code>/:categories/:year/:y_day/:title.html</code></p>
|
||||
<p><code>/:categories/:year/:y_day/:title:output_ext</code></p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -223,7 +250,7 @@ Although you can specify a custom permalink pattern using [template variables](#
|
||||
<p><code>none</code></p>
|
||||
</td>
|
||||
<td>
|
||||
<p><code>/:categories/:title.html</code></p>
|
||||
<p><code>/:categories/:title:output_ext</code></p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
@@ -270,7 +297,7 @@ Given a post named: `/2009-04-29-slap-chop.md`
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<p><code>/:month-:day-:year/:title.html</code></p>
|
||||
<p><code>/:month-:day-:year/:title:output_ext</code></p>
|
||||
</td>
|
||||
<td>
|
||||
<p><code>/04-29-2009/slap-chop.html</code></p>
|
||||
@@ -303,7 +330,7 @@ The permalink setting in your configuration file specifies the permalink style u
|
||||
|
||||
For example:
|
||||
|
||||
* A permalink style of `/:categories/:year/:month/:day/:title.html` for posts becomes `/:title.html` for pages and collections.
|
||||
* A permalink style of `/:categories/:year/:month/:day/:title:output_ext` for posts becomes `/:title.html` for pages and collections.
|
||||
* A permalink style of `pretty` (or `/:categories/:year/:month/:day/:title/`), which omits the file extension and contains a trailing slash, will update page and collection permalinks to also omit the file extension and contain a trailing slash: `/:title/`.
|
||||
* A permalink style of `date`, which contains a trailing file extension, will update page permalinks to also contain a trailing file extension: `/:title.html`. But no time or category information will be included.
|
||||
|
||||
@@ -327,13 +354,13 @@ As with posts, if you use a permalink style that omits the `.html` file extensio
|
||||
|
||||
By default, collections follow a similar structure in the `_site` folder as pages, except that the path is prefaced by the collection name. For example: `collectionname/mypage.html`. For permalink settings that omit the file extension, the path would be `collection_name/mypage/index.html`.
|
||||
|
||||
Collections have their own way of setting permalinks. Additionally, collections have unique template variables available available (such as `path` and `output_ext`). See the [Configuring permalinks for collections](../collections/#permalinks) in Collections for more information.
|
||||
Collections have their own way of setting permalinks. Additionally, collections have unique template variables available (such as `path` and `output_ext`). See the [Configuring permalinks for collections](../collections/#permalinks) in Collections for more information.
|
||||
|
||||
## Flattening pages in \_site on build
|
||||
|
||||
If you want to flatten your pages (pull them out of subfolders) in the `_site` directory when your site builds (similar to posts), add the `permalink` property to the front matter of each page, with no path specified:
|
||||
|
||||
```
|
||||
```yaml
|
||||
---
|
||||
title: My page
|
||||
permalink: mypageurl.html
|
||||
|
||||
@@ -25,27 +25,36 @@ having to modify the Jekyll source itself.
|
||||
You have 3 options for installing plugins:
|
||||
|
||||
1. In your site source root, make a `_plugins` directory. Place your plugins
|
||||
here. Any file ending in `*.rb` inside this directory will be loaded before
|
||||
Jekyll generates your site.
|
||||
2. In your `_config.yml` file, add a new array with the key `plugins` and the
|
||||
values of the gem names of the plugins you'd like to use. An example:
|
||||
here. Any file ending in `*.rb` inside this directory will be loaded before
|
||||
Jekyll generates your site.
|
||||
|
||||
2. In your `_config.yml` file, add a new array with the key `plugins` (or `gems` for Jekyll < `3.5.0`) and the
|
||||
values of the gem names of the plugins you'd like to use. An example:
|
||||
|
||||
plugins: [jekyll-coffeescript, jekyll-watch, jekyll-assets]
|
||||
# This will require each of these plugins automatically.
|
||||
```yaml
|
||||
# This will require each of these plugins automatically.
|
||||
plugins:
|
||||
- jekyll-gist
|
||||
- jekyll-coffeescript
|
||||
- jekyll-assets
|
||||
- another-jekyll-plugin
|
||||
```
|
||||
|
||||
Then install your plugins using `gem install jekyll-coffeescript jekyll-watch jekyll-assets`
|
||||
Then install your plugins using `gem install jekyll-gist jekyll-coffeescript jekyll-assets another-jekyll-plugin`
|
||||
|
||||
3. Add the relevant plugins to a Bundler group in your `Gemfile`. An
|
||||
example:
|
||||
example:
|
||||
|
||||
group :jekyll_plugins do
|
||||
gem "my-jekyll-plugin"
|
||||
gem "another-jekyll-plugin"
|
||||
end
|
||||
|
||||
Now you need to install all plugins from your Bundler group by running single command `bundle install`
|
||||
```ruby
|
||||
group :jekyll_plugins do
|
||||
gem "jekyll-gist"
|
||||
gem "jekyll-coffeescript"
|
||||
gem "jekyll-assets"
|
||||
gem "another-jekyll-plugin"
|
||||
end
|
||||
```
|
||||
|
||||
Now you need to install all plugins from your Bundler group by running single command `bundle install`.
|
||||
|
||||
<div class="note info">
|
||||
<h5>
|
||||
@@ -59,7 +68,25 @@ values of the gem names of the plugins you'd like to use. An example:
|
||||
</p>
|
||||
</div>
|
||||
|
||||
In general, plugins you make will fall into one of five categories:
|
||||
### The jekyll_plugins group
|
||||
|
||||
Jekyll gives this particular group of gems in your `Gemfile` a different
|
||||
treatment. Any gem included in this group is loaded before Jekyll starts
|
||||
processing the rest of your source directory.
|
||||
|
||||
A gem included here will be activated even if its not explicitly listed under
|
||||
the `plugins:` key in your site's config file.
|
||||
|
||||
<div class="note warning">
|
||||
<p>
|
||||
Gems included in the <code>:jekyll-plugins</code> group are activated
|
||||
regardless of the <code>--safe</code> mode setting. Be aware of what
|
||||
gems are included under this group!
|
||||
</p>
|
||||
</div>
|
||||
|
||||
|
||||
In general, plugins you make will fall broadly into one of five categories:
|
||||
|
||||
1. [Generators](#generators)
|
||||
2. [Converters](#converters)
|
||||
@@ -67,6 +94,12 @@ In general, plugins you make will fall into one of five categories:
|
||||
4. [Tags](#tags)
|
||||
5. [Hooks](#hooks)
|
||||
|
||||
See the bottom of the page for a [list of available plugins](#available-plugins).
|
||||
|
||||
For further information on how to develop your own plugins, check out the [Liquid documentation](https://github.com/Shopify/liquid/wiki/Liquid-for-Programmers) as well.
|
||||
|
||||
If you never developed a Jekyll plugin [check this useful wrap-up](https://ayastreb.me/writing-a-jekyll-plugin/) by @ayastreb to get started.
|
||||
|
||||
## Generators
|
||||
|
||||
You can create a generator when you need Jekyll to create additional content
|
||||
@@ -110,7 +143,6 @@ This is a more complex generator that generates new pages:
|
||||
|
||||
```ruby
|
||||
module Jekyll
|
||||
|
||||
class CategoryPage < Page
|
||||
def initialize(site, base, dir, category)
|
||||
@site = site
|
||||
@@ -139,7 +171,6 @@ module Jekyll
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
end
|
||||
```
|
||||
|
||||
@@ -378,11 +409,11 @@ Liquid::Template.register_tag('render_time', Jekyll::RenderTimeTag)
|
||||
In the example above, we can place the following tag anywhere in one of our
|
||||
pages:
|
||||
|
||||
```ruby
|
||||
{% raw %}
|
||||
```ruby
|
||||
<p>{% render_time page rendered at: %}</p>
|
||||
{% endraw %}
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
And we would get something like this on the page:
|
||||
|
||||
@@ -726,10 +757,6 @@ You can find a few useful plugins at the following locations:
|
||||
|
||||
#### Generators
|
||||
|
||||
- [ArchiveGenerator by Ilkka Laukkanen](https://gist.github.com/707909): Uses [this archive page](https://gist.github.com/707020) to generate archives.
|
||||
- [LESS.js Generator by Andy Fowler](https://gist.github.com/642739): Renders
|
||||
LESS.js files during generation.
|
||||
- [Version Reporter by Blake Smith](https://gist.github.com/449491): Creates a version.html file containing the Jekyll version.
|
||||
- [Sitemap.xml Generator by Michael Levin](https://github.com/kinnetica/jekyll-plugins): Generates a sitemap.xml file by traversing all of the available posts and pages.
|
||||
- [Full-text search by Pascal Widdershoven](https://github.com/PascalW/jekyll_indextank): Adds full-text search to your Jekyll site with a plugin and a bit of JavaScript.
|
||||
- [AliasGenerator by Thomas Mango](https://github.com/tsmango/jekyll_alias_generator): Generates redirect pages for posts when an alias is specified in the YAML Front Matter.
|
||||
@@ -745,7 +772,6 @@ LESS.js files during generation.
|
||||
- [Typescript Generator by Matt Sheehan](https://github.com/sheehamj13/jekyll_ts): Generate Javascript on build from your Typescript.
|
||||
- [Jekyll::AutolinkEmail by Ivan Tse](https://github.com/ivantsepp/jekyll-autolink_email): Autolink your emails.
|
||||
- [Jekyll::GitMetadata by Ivan Tse](https://github.com/ivantsepp/jekyll-git_metadata): Expose Git metadata for your templates.
|
||||
- [Jekyll Http Basic Auth Plugin](https://gist.github.com/snrbrnjna/422a4b7e017192c284b3): Plugin to manage http basic auth for jekyll generated pages and directories.
|
||||
- [Jekyll Auto Image by Merlos](https://github.com/merlos/jekyll-auto-image): Gets the first image of a post. Useful to list your posts with images or to add [twitter cards](https://dev.twitter.com/cards/overview) to your site.
|
||||
- [Jekyll Portfolio Generator by Shannon Babincsak](https://github.com/codeinpink/jekyll-portfolio-generator): Generates project pages and computes related projects out of project data files.
|
||||
- [Jekyll-Umlauts by Arne Gockeln](https://github.com/webchef/jekyll-umlauts): This generator replaces all german umlauts (äöüß) case sensitive with html.
|
||||
@@ -755,25 +781,21 @@ LESS.js files during generation.
|
||||
- [Jekyll Art Gallery plugin](https://github.com/alexivkin/Jekyll-Art-Gallery-Plugin): An advanced art/photo gallery generation plugin for creating galleries from a set of image folders. Supports image tagging, thumbnails, sorting, image rotation, post-processing (remove EXIF, add watermark), multiple collections and much more.
|
||||
- [jekyll-ga](https://github.com/developmentseed/jekyll-ga): A Jekyll plugin that downloads Google Analytics data and adds it to posts. Useful for making a site that lists "most popular" content. [Read the introduction](https://developmentseed.org/blog/google-analytics-jekyll-plugin/) post on the developmentSEED blog.
|
||||
- [jekyll-multi-paginate](https://github.com/fadhilnapis/jekyll-multi-paginate): Simple Jekyll paginator for multiple page. Ease you to make pagination on multiple page especially like multiple language.
|
||||
- [jekyll-category-pages](https://github.com/field-theory/jekyll-category-pages): Easy-to-use category index pages with and without pagination. Supports non-URL-safe category keywords and has extensive documentation and test coverage.
|
||||
- [Tweetsert](https://github.com/ibrado/jekyll-tweetsert): Imports tweets (Twitter statuses) as new posts. Features multiple timeline support, hashtag import, filtering, automatic category and/or tags, optional retweets and replies.
|
||||
- [Stickyposts](https://github.com/ibrado/jekyll-stickyposts): Moves or copies (pins) posts marked `sticky: true` to the top of the list. Perfect for keeping important announcements on the home page, or giving collections a descriptive entry. Paginator friendly.
|
||||
- [Jekyll::Paginate::Content](https://github.com/ibrado/jekyll-paginate-content): Content paginator in the style of jekyll-paginator-v2 that splits pages, posts, and collection entries into several pages. Specify a separator or use HTML <h1> etc. headers. Automatic splitting, single-page view, pager/trail, self-adjusting links, multipage TOC, SEO support.
|
||||
- [Premonition](https://github.com/amedia/premonition): Adds block-styled side content to your page. For example summary, notes, hints or warning boxes.
|
||||
- [jekyll-fontello](https://github.com/ericcornelissen/jekyll-fontello): A Jekyll plugin that automatically downloads your webfont from Fontello.
|
||||
|
||||
#### Converters
|
||||
|
||||
- [Pug plugin by Doug Beney](https://github.com/DougBeney/jekyll-pug): Pug (previously Jade) converter for Jekyll.
|
||||
- [Pug plugin by Doug Beney](http://jekyll-pug.dougie.io): Use the popular Pug (previously Jade) templating language in Jekyll. Complete with caching, includes support, and much more.
|
||||
- [Textile converter](https://github.com/jekyll/jekyll-textile-converter): Convert `.textile` files into HTML. Also includes the `textilize` Liquid filter.
|
||||
- [Slim plugin](https://github.com/slim-template/jekyll-slim): Slim converter and includes for Jekyll with support for Liquid tags.
|
||||
- [HAML plugin by Sam Z](https://gist.github.com/517556): HAML converter for Jekyll.
|
||||
- [HAML-Sass Converter by Adam Pearson](https://gist.github.com/481456): Simple HAML-Sass converter for Jekyll. [Fork](https://gist.github.com/528642) by Sam X.
|
||||
- [Sass SCSS Converter by Mark Wolfe](https://gist.github.com/960150): Sass converter which uses the new CSS compatible syntax, based Sam X’s fork above.
|
||||
- [LESS Converter by Jason Graham](https://gist.github.com/639920): Convert LESS files to CSS.
|
||||
- [LESS Converter by Josh Brown](https://gist.github.com/760265): Simple LESS converter.
|
||||
- [Upcase Converter by Blake Smith](https://gist.github.com/449463): An example Jekyll converter.
|
||||
- [CoffeeScript Converter by phaer](https://gist.github.com/959938): A [CoffeeScript](http://coffeescript.org) to Javascript converter.
|
||||
- [Markdown References by Olov Lassus](https://github.com/olov/jekyll-references): Keep all your markdown reference-style link definitions in one \_references.md file.
|
||||
- [Stylus Converter](https://gist.github.com/988201): Convert .styl to .css.
|
||||
- [ReStructuredText Converter](https://github.com/xdissent/jekyll-rst): Converts ReST documents to HTML with Pygments syntax highlighting.
|
||||
- [Jekyll-pandoc-multiple-formats](https://github.com/fauno/jekyll-pandoc-multiple-formats) by [edsl](https://github.com/edsl): Use pandoc to generate your site in multiple formats. Supports pandoc’s markdown extensions.
|
||||
- [Transform Layouts](https://gist.github.com/1472645): Allows HAML layouts (you need a HAML Converter plugin for this to work).
|
||||
- [Org-mode Converter](https://gist.github.com/abhiyerra/7377603): Org-mode converter for Jekyll.
|
||||
- [Customized Kramdown Converter](https://github.com/mvdbos/kramdown-with-pygments): Enable Pygments syntax highlighting for Kramdown-parsed fenced code blocks.
|
||||
- [Bigfootnotes Plugin](https://github.com/TheFox/jekyll-bigfootnotes): Enables big footnotes for Kramdown.
|
||||
- [AsciiDoc Plugin](https://github.com/asciidoctor/jekyll-asciidoc): AsciiDoc convertor for Jekyll using [Asciidoctor](http://asciidoctor.org/).
|
||||
@@ -784,10 +806,7 @@ LESS.js files during generation.
|
||||
|
||||
- [Truncate HTML](https://github.com/MattHall/truncatehtml) by [Matt Hall](https://codebeef.com/): A Jekyll filter that truncates HTML while preserving markup structure.
|
||||
- [Domain Name Filter by Lawrence Woodman](https://github.com/LawrenceWoodman/domain_name-liquid_filter): Filters the input text so that just the domain name is left.
|
||||
- [Summarize Filter by Mathieu Arnold](https://gist.github.com/731597): Remove markup after a `<div id="extended">` tag.
|
||||
- [i18n_filter](https://github.com/gacha/gacha.id.lv/blob/master/_plugins/i18n_filter.rb): Liquid filter to use I18n localization.
|
||||
- [Smilify](https://github.com/SaswatPadhi/jekyll_smilify) by [SaswatPadhi](https://github.com/SaswatPadhi): Convert text emoticons in your content to themeable smiley pics.
|
||||
- [Read in X Minutes](https://gist.github.com/zachleat/5792681) by [zachleat](https://github.com/zachleat): Estimates the reading time of a string (for blog post content).
|
||||
- [Jekyll-timeago](https://github.com/markets/jekyll-timeago): Converts a time value to the time ago in words.
|
||||
- [pluralize](https://github.com/bdesham/pluralize): Easily combine a number and a word into a grammatically-correct amount like “1 minute” or “2 minute**s**”.
|
||||
- [reading_time](https://github.com/bdesham/reading_time): Count words and estimate reading time for a piece of text, ignoring HTML elements that are unlikely to contain running text.
|
||||
@@ -798,7 +817,6 @@ LESS.js files during generation.
|
||||
- [Deprecated articles keeper](https://github.com/kzykbys/JekyllPlugins) by [Kazuya Kobayashi](http://blog.kazuya.co/): A simple Jekyll filter which monitor how old an article is.
|
||||
- [Jekyll-jalali](https://github.com/mehdisadeghi/jekyll-jalali) by [Mehdi Sadeghi](http://mehdix.ir): A simple Gregorian to Jalali date converter filter.
|
||||
- [Jekyll Thumbnail Filter](https://github.com/matallo/jekyll-thumbnail-filter): Related posts thumbnail filter.
|
||||
- [Jekyll-Smartify](https://github.com/pathawks/jekyll-smartify): SmartyPants filter. Make "quotes" “curly”
|
||||
- [liquid-md5](https://github.com/pathawks/liquid-md5): Returns an MD5 hash. Helpful for generating Gravatars in templates.
|
||||
- [jekyll-roman](https://github.com/paulrobertlloyd/jekyll-roman): A liquid filter for Jekyll that converts numbers into Roman numerals.
|
||||
- [jekyll-typogrify](https://github.com/myles/jekyll-typogrify): A Jekyll plugin that brings the functions of [typogruby](http://avdgaag.github.io/typogruby/).
|
||||
@@ -807,35 +825,25 @@ LESS.js files during generation.
|
||||
- [match_regex](https://github.com/sparanoid/match_regex): A Liquid filter to perform regex match.
|
||||
- [replace_regex](https://github.com/sparanoid/replace_regex): A Liquid filter to perform regex replace.
|
||||
- [Jekyll Money](https://rubygems.org/gems/jekyll-money): A Jekyll plugin for dealing with money. Because we all have to at some point.
|
||||
- [jekyll-random](https://github.com/codecalm/jekyll-random) by [codecalm](https://nodecalm.net): A Jekyll plugin that generates pseudo-random data. Very useful when you want to generate a large amount of random data.
|
||||
|
||||
#### Tags
|
||||
|
||||
You can find a few useful plugins at the following locations:
|
||||
|
||||
- [Jekyll-gist](https://github.com/jekyll/jekyll-gist): Use the `gist` tag to easily embed a GitHub Gist onto your site. This works with public or secret gists.
|
||||
- [Asset Path Tag](https://github.com/samrayner/jekyll-asset-path-plugin) by [Sam Rayner](http://www.samrayner.com/): Allows organisation of assets into subdirectories by outputting a path for a given file relative to the current post or page.
|
||||
- [Delicious Plugin by Christian Hellsten](https://github.com/christianhellsten/jekyll-plugins): Fetches and renders bookmarks from delicious.com.
|
||||
- [Ultraviolet Plugin by Steve Alex](https://gist.github.com/480380): Jekyll tag for the [Ultraviolet](https://github.com/grosser/ultraviolet) code highligher.
|
||||
- [Tag Cloud Plugin by Ilkka Laukkanen](https://gist.github.com/710577): Generate a tag cloud that links to tag pages.
|
||||
- [GIT Tag by Alexandre Girard](https://gist.github.com/730347): Add Git activity inside a list.
|
||||
- [MathJax Liquid Tags by Jessy Cowan-Sharp](https://gist.github.com/834610): Simple liquid tags for Jekyll that convert inline math and block equations to the appropriate MathJax script tags.
|
||||
- [Non-JS Gist Tag by Brandon Tilley](https://gist.github.com/1027674) A Liquid tag that embeds Gists and shows code for non-JavaScript enabled browsers and readers.
|
||||
- [Render Time Tag by Blake Smith](https://gist.github.com/449509): Displays the time a Jekyll page was generated.
|
||||
- [Status.net/OStatus Tag by phaer](https://gist.github.com/912466): Displays the notices in a given status.net/ostatus feed.
|
||||
- [Embed.ly client by Robert Böhnke](https://github.com/robb/jekyll-embedly-client): Autogenerate embeds from URLs using oEmbed.
|
||||
- [Logarithmic Tag Cloud](https://gist.github.com/2290195): Flexible. Logarithmic distribution. Documentation inline.
|
||||
- [oEmbed Tag by Tammo van Lessen](https://gist.github.com/1455726): Enables easy content embedding (e.g. from YouTube, Flickr, Slideshare) via oEmbed.
|
||||
- [FlickrSetTag by Thomas Mango](https://github.com/tsmango/jekyll_flickr_set_tag): Generates image galleries from Flickr sets.
|
||||
- [Tweet Tag by Scott W. Bradley](https://github.com/scottwb/jekyll-tweet-tag): Liquid tag for [Embedded Tweets](https://dev.twitter.com/docs/embedded-tweets) using Twitter’s shortcodes.
|
||||
- [Jekyll Twitter Plugin](https://github.com/rob-murray/jekyll-twitter-plugin): A Liquid tag plugin that renders Tweets from Twitter API. Currently supports the [oEmbed](https://dev.twitter.com/rest/reference/get/statuses/oembed) API.
|
||||
- [Jekyll-contentblocks](https://github.com/rustygeldmacher/jekyll-contentblocks): Lets you use Rails-like content_for tags in your templates, for passing content from your posts up to your layouts.
|
||||
- [Generate YouTube Embed](https://gist.github.com/1805814) by [joelverhagen](https://github.com/joelverhagen): Jekyll plugin which allows you to embed a YouTube video in your page with the YouTube ID. Optionally specify width and height dimensions. Like “oEmbed Tag” but just for YouTube.
|
||||
- [Jekyll-beastiepress](https://github.com/okeeblow/jekyll-beastiepress): FreeBSD utility tags for Jekyll sites.
|
||||
- [Jsonball](https://gist.github.com/1895282): Reads json files and produces maps for use in Jekyll files.
|
||||
- [Bibjekyll](https://github.com/pablooliveira/bibjekyll): Render BibTeX-formatted bibliographies/citations included in posts and pages using bibtex2html.
|
||||
- [Jekyll-citation](https://github.com/archome/jekyll-citation): Render BibTeX-formatted bibliographies/citations included in posts and pages (pure Ruby).
|
||||
- [Jekyll Dribbble Set Tag](https://github.com/ericdfields/Jekyll-Dribbble-Set-Tag): Builds Dribbble image galleries from any user.
|
||||
- [Debbugs](https://gist.github.com/2218470): Allows posting links to Debian BTS easily.
|
||||
- [Jekyll-devonly_tag](https://gist.github.com/2403522): A block tag for including markup only during development.
|
||||
- [JekyllGalleryTag](https://github.com/redwallhp/JekyllGalleryTag) by [redwallhp](https://github.com/redwallhp): Generates thumbnails from a directory of images and displays them in a grid.
|
||||
- [Youku and Tudou Embed](https://gist.github.com/Yexiaoxing/5891929): Liquid plugin for embedding Youku and Tudou videos.
|
||||
- [Jekyll-swfobject](https://github.com/sectore/jekyll-swfobject): Liquid plugin for embedding Adobe Flash files (.swf) using [SWFObject](https://github.com/swfobject/swfobject).
|
||||
- [Jekyll Picture Tag](https://github.com/robwierzbowski/jekyll-picture-tag): Easy responsive images for Jekyll. Based on the proposed [`<picture>`](https://html.spec.whatwg.org/multipage/embedded-content.html#the-picture-element) element, polyfilled with Scott Jehl’s [Picturefill](https://github.com/scottjehl/picturefill).
|
||||
- [Jekyll Image Tag](https://github.com/robwierzbowski/jekyll-image-tag): Better images for Jekyll. Save image presets, generate resized images, and add classes, alt text, and other attributes.
|
||||
@@ -845,8 +853,6 @@ LESS.js files during generation.
|
||||
- [Jekyll Date Chart](https://github.com/GSI/jekyll_date_chart) by [GSI](https://github.com/GSI): Block that renders date line charts based on textile-formatted tables.
|
||||
- [Jekyll Image Encode](https://github.com/GSI/jekyll_image_encode) by [GSI](https://github.com/GSI): Tag that renders base64 codes of images fetched from the web.
|
||||
- [Jekyll Quick Man](https://github.com/GSI/jekyll_quick_man) by [GSI](https://github.com/GSI): Tag that renders pretty links to man page sources on the internet.
|
||||
- [jekyll-font-awesome](https://gist.github.com/23maverick23/8532525): Quickly and easily add Font Awesome icons to your posts.
|
||||
- [Lychee Gallery Tag](https://gist.github.com/tobru/9171700) by [tobru](https://github.com/tobru): Include [Lychee](https://lychee.electerious.com/) albums into a post. For an introduction, see [Jekyll meets Lychee - A Liquid Tag plugin](https://tobrunet.ch/articles/jekyll-meets-lychee-a-liquid-tag-plugin/)
|
||||
- [Image Set/Gallery Tag](https://github.com/callmeed/jekyll-image-set) by [callmeed](https://github.com/callmeed): Renders HTML for an image gallery from a folder in your Jekyll site. Just pass it a folder name and class/tag options.
|
||||
- [jekyll_figure](https://github.com/lmullen/jekyll_figure): Generate figures and captions with links to the figure in a variety of formats
|
||||
- [Jekyll GitHub Sample Tag](https://github.com/bwillis/jekyll-github-sample): A liquid tag to include a sample of a github repo file in your Jekyll site.
|
||||
@@ -875,7 +881,12 @@ LESS.js files during generation.
|
||||
- [Jekyll If File Exists](https://github.com/k-funk/jekyll-if-file-exists): A Jekyll Plugin that checks if a file exists with an if/else block.
|
||||
- [BibSonomy](https://github.com/rjoberon/bibsonomy-jekyll): Jekyll
|
||||
plugin to generate publication lists from [BibSonomy](https://www.bibsonomy.org/).
|
||||
|
||||
- [github-cards](https://github.com/edward-shen/github-cards): Creates styleable Github cards for your Github projects.
|
||||
- [disqus-for-jekyll](https://github.com/kacperduras/disqus-for-jekyll): A Jekyll plugin to view the comments powered by Disqus.
|
||||
- [jekyll-html](https://github.com/kacperduras/jekyll-html): A Jekyll plugin to use HTML tags in Jekyll pages, posts and collections.
|
||||
- [jekyll-onebox](https://github.com/rriemann/jekyll-onebox): Liquid tag for displaying HTML previews (embeds) for links to popular domains. Plugin is based on [Onebox](https://github.com/discourse/onebox) that powers link previews in [Discourse](http://github.com/discourse/discourse) forums.
|
||||
- [jekyll-w2m](https://github.com/kacperduras/jekyll-w2m): A Jekyll plugin to liberate content from Microsoft Word documents (powered by [word-to-markdown](https://github.com/benbalter/word-to-markdown)).
|
||||
- [jekyll-flickr](https://github.com/rriemann/jekyll-flickr): Liquid tag for responsive Flickr images using HTML5 srcset. Subtitles and automatic license notices are supported.
|
||||
|
||||
#### Collections
|
||||
|
||||
@@ -885,24 +896,18 @@ LESS.js files during generation.
|
||||
|
||||
#### Other
|
||||
|
||||
- [Analytics for Jekyll](https://github.com/hendrikschneider/jekyll-analytics) by Hendrik Schneider: An effortless way to add various trackers like Google Analytics, Piwik, etc. to your site
|
||||
- [Analytics for Jekyll](https://github.com/hendrikschneider/jekyll-analytics) by Hendrik Schneider: An effortless way to add various trackers like Google Analytics, Matomo (formerly Piwik), mPulse, etc. to your site.
|
||||
- [ditaa-ditaa](https://github.com/tmthrgd/ditaa-ditaa) by Tom Thorogood: a drastic revision of jekyll-ditaa that renders diagrams drawn using ASCII art into PNG images.
|
||||
- [Pygments Cache Path by Raimonds Simanovskis](https://github.com/rsim/blog.rayapps.com/blob/master/_plugins/pygments_cache_patch.rb): Plugin to cache syntax-highlighted code from Pygments.
|
||||
- [Draft/Publish Plugin by Michael Ivey](https://gist.github.com/49630): Save posts as drafts.
|
||||
- [Growl Notification Generator by Tate Johnson](https://gist.github.com/490101): Send Jekyll notifications to Growl.
|
||||
- [Growl Notification Hook by Tate Johnson](https://gist.github.com/525267): Better alternative to the above, but requires his “hook” fork.
|
||||
- [Related Posts by Lawrence Woodman](https://github.com/LawrenceWoodman/related_posts-jekyll_plugin): Overrides `site.related_posts` to use categories to assess relationship.
|
||||
- [jekyll-tagging-related_posts](https://github.com/toshimaru/jekyll-tagging-related_posts): Jekyll related_posts function based on tags (works on Jekyll3).
|
||||
- [Tiered Archives by Eli Naeher](https://gist.github.com/88cda643aa7e3b0ca1e5): Create tiered template variable that allows you to group archives by year and month.
|
||||
- [Jekyll-localization](https://github.com/blackwinter/jekyll-localization): Jekyll plugin that adds localization features to the rendering engine.
|
||||
- [Jekyll-rendering](https://github.com/blackwinter/jekyll-rendering): Jekyll plugin to provide alternative rendering engines.
|
||||
- [Jekyll-pagination](https://github.com/blackwinter/jekyll-pagination): Jekyll plugin to extend the pagination generator.
|
||||
- [Jekyll-tagging](https://github.com/pattex/jekyll-tagging): Jekyll plugin to automatically generate a tag cloud and tag pages.
|
||||
- [Jekyll-scholar](https://github.com/inukshuk/jekyll-scholar): Jekyll extensions for the blogging scholar.
|
||||
- [Jekyll-asset_bundler](https://github.com/moshen/jekyll-asset_bundler): Bundles and minifies JavaScript and CSS.
|
||||
- [Jekyll-assets](http://jekyll.github.io/jekyll-assets/) by [ixti](https://github.com/ixti): Rails-alike assets pipeline (write assets in CoffeeScript, Sass, LESS etc; specify dependencies for automatic bundling using simple declarative comments in assets; minify and compress; use JST templates; cache bust; and many-many more).
|
||||
- [JAPR](https://github.com/kitsched/japr): Jekyll Asset Pipeline Reborn - Powerful asset pipeline for Jekyll that collects, converts and compresses JavaScript and CSS assets.
|
||||
- [File compressor](https://gist.github.com/2758691) by [mytharcher](https://github.com/mytharcher): Compress HTML and JavaScript files on site build.
|
||||
- [Jekyll-minibundle](https://github.com/tkareine/jekyll-minibundle): Asset bundling and cache busting using external minification tool of your choice. No gem dependencies.
|
||||
- [Singlepage-jekyll](https://github.com/JCB-K/singlepage-jekyll) by [JCB-K](https://github.com/JCB-K): Turns Jekyll into a dynamic one-page website.
|
||||
- [generator-jekyllrb](https://github.com/robwierzbowski/generator-jekyllrb): A generator that wraps Jekyll in [Yeoman](http://yeoman.io/), a tool collection and workflow for building modern web apps.
|
||||
@@ -929,20 +934,13 @@ LESS.js files during generation.
|
||||
- [Jekyll-Post](https://github.com/robcrocombe/jekyll-post): A CLI tool to easily draft, edit, and publish Jekyll posts.
|
||||
- [jekyll-numbered-headings](https://github.com/muratayusuke/jekyll-numbered-headings): Adds ordered number to headings.
|
||||
- [jekyll-pre-commit](https://github.com/mpchadwick/jekyll-pre-commit): A framework for running checks against your posts using a git pre-commit hook before you publish them.
|
||||
|
||||
#### Editors
|
||||
|
||||
- [sublime-jekyll](https://github.com/23maverick23/sublime-jekyll): A Sublime Text package for Jekyll static sites. This package should help creating Jekyll sites and posts easier by providing access to key template tags and filters, as well as common completions and a current date/datetime command (for dating posts). You can install this package manually via GitHub, or via [Package Control](https://packagecontrol.io/packages/Jekyll).
|
||||
- [vim-jekyll](https://github.com/parkr/vim-jekyll): A vim plugin to generate
|
||||
new posts and run `jekyll build` all without leaving vim.
|
||||
- [markdown-writer](https://atom.io/packages/markdown-writer): An Atom package for Jekyll. It can create new posts/drafts, manage tags/categories, insert link/images and add many useful key mappings.
|
||||
- [Wordpress2Jekyll](https://wordpress.org/plugins/wp2jekyll/): A Wordpress plugin that allows you to use Wordpress as your editor and (automatically) export content in to Jekyll. WordPress2Jekyll attempts to marry these two systems together in order to make a site that can be easily managed from all devices.
|
||||
- [jekyll-pwa-plugin](https://github.com/lavas-project/jekyll-pwa): A plugin provides PWA support for Jekyll. It generates a service worker in Jekyll build process and makes precache and runtime cache available in the runtime with Google Workbox.
|
||||
- [jekyll-algolia](https://community.algolia.com/jekyll-algolia/): Add fast and relevant search to your Jekyll site through the Algolia API.
|
||||
|
||||
<div class="note info">
|
||||
<h5>Jekyll Plugins Wanted</h5>
|
||||
<h5>Submit your gem plugins</h5>
|
||||
<p>
|
||||
If you have a Jekyll plugin that you would like to see added to this list,
|
||||
you should <a href="../contributing/">read the contributing page</a> to find
|
||||
You're encouraged to add your Jekyll gem plugins to this list, <a href="../contributing/">read the contributing page</a> to find
|
||||
out how to make that happen.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
@@ -26,7 +26,7 @@ To create a new post, all you need to do is create a file in the `_posts`
|
||||
directory. How you name files in this folder is important. Jekyll requires blog
|
||||
post files to be named according to the following format:
|
||||
|
||||
```sh
|
||||
```
|
||||
YEAR-MONTH-DAY-title.MARKUP
|
||||
```
|
||||
|
||||
@@ -34,7 +34,7 @@ Where `YEAR` is a four-digit number, `MONTH` and `DAY` are both two-digit
|
||||
numbers, and `MARKUP` is the file extension representing the format used in the
|
||||
file. For example, the following are examples of valid post filenames:
|
||||
|
||||
```sh
|
||||
```
|
||||
2011-12-31-new-years-eve-is-awesome.md
|
||||
2012-09-12-how-to-write-a-blog.md
|
||||
```
|
||||
@@ -78,55 +78,54 @@ digital assets along with your text content. While the syntax for linking to
|
||||
these resources differs between Markdown and Textile, the problem of working
|
||||
out where to store these files in your site is something everyone will face.
|
||||
|
||||
There are a number of ways to include digital assets in Jekyll.
|
||||
There are a number of ways to include digital assets in Jekyll.
|
||||
One common solution is to create a folder in the root of the project directory
|
||||
called something like `assets` or `downloads`, into which any images, downloads
|
||||
called something like `assets`, into which any images, files
|
||||
or other resources are placed. Then, from within any post, they can be linked
|
||||
to using the site’s root as the path for the asset to include. Again, this will
|
||||
depend on the way your site’s (sub)domain and path are configured, but here are
|
||||
some examples (in Markdown) of how you could do this using the `site.url`
|
||||
variable in a post.
|
||||
some examples in Markdown of how you could do this using the `absolute_url`
|
||||
filter in a post.
|
||||
|
||||
Including an image asset in a post:
|
||||
|
||||
```text
|
||||
{% raw %}
|
||||
```markdown
|
||||
... which is shown in the screenshot below:
|
||||

|
||||

|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
Linking to a PDF for readers to download:
|
||||
|
||||
```text
|
||||
... you can [get the PDF]({% raw %}{{ site.url }}{% endraw %}/assets/mydoc.pdf) directly.
|
||||
{% raw %}
|
||||
```markdown
|
||||
... you can [get the PDF]({{ "/assets/mydoc.pdf" | absolute_url }}) directly.
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
<div class="info">
|
||||
|
||||
<div class="note">
|
||||
<h5>ProTip™: Link using just the site root URL</h5>
|
||||
<p>
|
||||
You can skip the <code>{% raw %}{{ site.url }}{% endraw %}</code> variable
|
||||
if you <strong>know</strong> your site will only ever be displayed at the
|
||||
root URL of your domain. In this case you can reference assets directly with
|
||||
just <code>/path/file.jpg</code>.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
## A typical post
|
||||
|
||||
Jekyll can handle many different iterations of the idea you might associate with a "post," however a standard blog style post, including a Title, Layout, Publishing Date, and Categories might look like this:
|
||||
|
||||
```
|
||||
```markdown
|
||||
---
|
||||
layout: post
|
||||
title: "Welcome to Jekyll!"
|
||||
date: 2015-11-17 16:16:01 -0600
|
||||
categories: jekyll update
|
||||
---
|
||||
|
||||
You’ll find this post in your `_posts` directory. Go ahead and edit it and re-build the site to see your changes. You can rebuild the site in many different ways, but the most common way is to run `bundle exec jekyll serve`, which launches a web server and auto-regenerates your site when a file is updated.
|
||||
|
||||
To add new posts, simply add a file in the `_posts` directory that follows the convention `YYYY-MM-DD-name-of-post.ext` and includes the necessary front matter. Take a look at the source for this post to get an idea about how it works.
|
||||
|
||||
```
|
||||
Everything in between the first and second `---` are part of the YAML Front Matter, and everything after the second `---` will be rendered with Markdown and show up as "Content."
|
||||
|
||||
Everything in between the first and second `---` are part of the YAML Front Matter, and everything after the second `---` will be rendered with Markdown and show up as "Content".
|
||||
|
||||
## Displaying an index of posts
|
||||
|
||||
@@ -136,15 +135,17 @@ you have a list of posts somewhere. Creating an index of posts on another page
|
||||
language](https://docs.shopify.com/themes/liquid/basics) and its tags. Here’s a
|
||||
basic example of how to create a list of links to your blog posts:
|
||||
|
||||
{% raw %}
|
||||
```html
|
||||
<ul>
|
||||
{% raw %}{% for post in site.posts %}{% endraw %}
|
||||
{% for post in site.posts %}
|
||||
<li>
|
||||
<a href="{% raw %}{{ post.url }}{% endraw %}">{% raw %}{{ post.title }}{% endraw %}</a>
|
||||
<a href="{{ post.url }}">{{ post.title }}</a>
|
||||
</li>
|
||||
{% raw %}{% endfor %}{% endraw %}
|
||||
{% endfor %}
|
||||
</ul>
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
Of course, you have full control over how (and where) you display your posts,
|
||||
and how you structure your site. You should read more about [how templates
|
||||
@@ -155,39 +156,116 @@ you wish to access the currently-rendering page/posts's variables (the
|
||||
variables of the post/page that has the `for` loop in it), use the `page`
|
||||
variable instead.
|
||||
|
||||
## Displaying post categories or tags
|
||||
|
||||
Hey, that's pretty neat, but what about showing just some of your posts that are
|
||||
related to each other? For that you can use any of the [variables definable in
|
||||
Front Matter](https://jekyllrb.com/docs/frontmatter/). In the "typical post"
|
||||
section you can see how to define categories. Simply add the categories to your
|
||||
Front Matter as a [yaml
|
||||
list](https://en.wikipedia.org/wiki/YAML#Basic_components).
|
||||
|
||||
Now that your posts have a category or multiple categories, you can make a page
|
||||
or a template displaying just the posts in those categories you specify. Here's
|
||||
a basic example of how to create a list of posts from a specific category.
|
||||
|
||||
First, in the `_layouts` directory create a new file called `category.html` - in
|
||||
that file put (at least) the following:
|
||||
|
||||
{% raw %}
|
||||
```liquid
|
||||
---
|
||||
layout: page
|
||||
---
|
||||
|
||||
{% for post in site.categories[page.category] %}
|
||||
<a href="{{ post.url | absolute_url }}">
|
||||
{{ post.title }}
|
||||
</a>
|
||||
{% endfor %}
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
Next, in the root directory of your Jekyll install, create a new directory
|
||||
called `category` and then create a file for each category you want to list. For
|
||||
example, if you have a category `blog` then create a file in the new directory
|
||||
called `blog.html` with at least
|
||||
|
||||
```yaml
|
||||
---
|
||||
layout: category
|
||||
title: Blog
|
||||
category: blog
|
||||
---
|
||||
```
|
||||
|
||||
In this case, the listing pages will be accessible at `{baseurl}/category/blog.html`
|
||||
|
||||
Although categories and tags are very similar, they are used to group posts,
|
||||
there are a few differences between them. Categories and sub-categories create
|
||||
hierarchies that, by default, are reflected in the directory structure of your
|
||||
site. A post with the following header
|
||||
```yaml
|
||||
---
|
||||
layout: post
|
||||
title: A Trip
|
||||
category: [ blog, travel ]
|
||||
---
|
||||
```
|
||||
will be accessible at `{baseurl}/blog/travel/year/month/day/A-Trip.html`. On
|
||||
the other hand, a tagged post
|
||||
```yaml
|
||||
---
|
||||
layout: post
|
||||
title: A Trip
|
||||
tags: [ blog, travel ]
|
||||
---
|
||||
```
|
||||
will be saved as `{baseurl}/year/month/day/A-Trip.html`. It is up to you to
|
||||
create `{baseurl}/tag/blog.html` and `{baseurl}/tag/travel.html` the same way as
|
||||
described above for categories.
|
||||
|
||||
While this example is done with tags and categories, you can easily extend your
|
||||
lists to filter by any other variable created with extensions.
|
||||
|
||||
## Post excerpts
|
||||
|
||||
Each post automatically takes the first block of text, from the beginning of
|
||||
the content to the first occurrence of `excerpt_separator`, and sets it as the `post.excerpt`.
|
||||
the content to the first occurrence of `excerpt_separator`, and sets it in the
|
||||
post's data hash.
|
||||
Take the above example of an index of posts. Perhaps you want to include
|
||||
a little hint about the post's content by adding the first paragraph of each of
|
||||
your posts:
|
||||
|
||||
```html
|
||||
{% raw %}
|
||||
```liquid
|
||||
<ul>
|
||||
{% raw %}{% for post in site.posts %}{% endraw %}
|
||||
{% for post in site.posts %}
|
||||
<li>
|
||||
<a href="{% raw %}{{ post.url }}{% endraw %}">{% raw %}{{ post.title }}{% endraw %}</a>
|
||||
{% raw %}{{ post.excerpt }}{% endraw %}
|
||||
<a href="{{ post.url }}">{{ post.title }}</a>
|
||||
{{ post.excerpt }}
|
||||
</li>
|
||||
{% raw %}{% endfor %}{% endraw %}
|
||||
{% endfor %}
|
||||
</ul>
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
Because Jekyll grabs the first paragraph you will not need to wrap the excerpt
|
||||
in `p` tags, which is already done for you. These tags can be removed with the
|
||||
following if you'd prefer:
|
||||
|
||||
```html
|
||||
{% raw %}{{ post.excerpt | remove: '<p>' | remove: '</p>' }}{% endraw %}
|
||||
{% raw %}
|
||||
```liquid
|
||||
{{ post.excerpt | remove: '<p>' | remove: '</p>' }}
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
If you don't like the automatically-generated post excerpt, it can be
|
||||
explicitly overridden by adding an `excerpt` value to your post's YAML
|
||||
Front Matter. Alternatively, you can choose to define a custom
|
||||
`excerpt_separator` in the post's YAML front matter:
|
||||
|
||||
```text
|
||||
```yaml
|
||||
---
|
||||
excerpt_separator: <!--more-->
|
||||
---
|
||||
@@ -214,8 +292,9 @@ Jekyll also has built-in support for syntax highlighting of code snippets using
|
||||
either Pygments or Rouge, and including a code snippet in any post is easy.
|
||||
Just use the dedicated Liquid tag as follows:
|
||||
|
||||
```text
|
||||
{% raw %}{% highlight ruby %}{% endraw %}
|
||||
{% raw %}
|
||||
```liquid
|
||||
{% highlight ruby %}
|
||||
def show
|
||||
@widget = Widget(params[:id])
|
||||
respond_to do |format|
|
||||
@@ -223,8 +302,9 @@ def show
|
||||
format.json { render json: @widget }
|
||||
end
|
||||
end
|
||||
{% raw %}{% endhighlight %}{% endraw %}
|
||||
{% endhighlight %}
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
And the output will look like this:
|
||||
|
||||
|
||||
@@ -8,16 +8,16 @@ If you already have a full [Ruby](https://www.ruby-lang.org/en/downloads/) devel
|
||||
|
||||
```sh
|
||||
# Install Jekyll and Bundler gems through RubyGems
|
||||
~ $ gem install jekyll bundler
|
||||
gem install jekyll bundler
|
||||
|
||||
# Create a new Jekyll site at ./myblog
|
||||
~ $ jekyll new myblog
|
||||
jekyll new myblog
|
||||
|
||||
# Change into your new directory
|
||||
~ $ cd myblog
|
||||
cd myblog
|
||||
|
||||
# Build the site on the preview server
|
||||
~/myblog $ bundle exec jekyll serve
|
||||
bundle exec jekyll serve
|
||||
|
||||
# Now browse to http://localhost:4000
|
||||
```
|
||||
@@ -26,13 +26,15 @@ If you encounter any unexpected errors during the above, please refer to the [tr
|
||||
|
||||
## About Bundler
|
||||
|
||||
`gem install jekyll bundler` installs the [jekyll](https://rubygems.org/gems/jekyll/) and [bundler](https://rubygems.org/gems/bundler) gems through [RubyGems](https://rubygems.org/). You need only to install the gems one time — not every time you create a new Jekyll project. Here are some additional details:
|
||||
`gem install bundler` installs the [bundler](https://rubygems.org/gems/bundler) gem through [RubyGems](https://rubygems.org/). You only need to install it once — not every time you create a new Jekyll project. Here are some additional details:
|
||||
|
||||
* `bundler` is a gem that manages other Ruby gems. It makes sure your gems and gem versions are compatible, and that you have all necessary dependencies each gem requires.
|
||||
* The `Gemfile` and `Gemfile.lock` files inform Bundler about the gem requirements in your site. If your site doesn't have these Gemfiles, you can omit `bundle exec` and just run `jekyll serve`.
|
||||
|
||||
* When you run `bundle exec jekyll serve`, Bundler uses the gems and versions as specified in `Gemfile.lock` to ensure your Jekyll site builds with no compatibility or dependency conflicts.
|
||||
|
||||
For more information about how to use Bundler in your Jekyll project, this [tutorial](https://jekyllrb.com/tutorials/using-jekyll-with-bundler/) should provide answers to the most common questions and explain how to get up and running quickly.
|
||||
|
||||
## Options for creating a new site with Jekyll
|
||||
|
||||
`jekyll new <PATH>` installs a new Jekyll site at the path specified (relative to current directory). In this case, Jekyll will be installed in a directory called `myblog`. Here are some additional details:
|
||||
|
||||
@@ -3,41 +3,60 @@ title: Resources
|
||||
permalink: /docs/resources/
|
||||
---
|
||||
|
||||
Jekyll’s growing use is producing a wide variety of tutorials, frameworks, extensions, examples, and other resources that can be very helpful. Below is a collection of links to some of the most popular Jekyll resources.
|
||||
Jekyll's growing use is producing a wide variety of tutorials, frameworks, extensions, examples, and other resources that can be very helpful. Below is a collection of links to some of the most popular Jekyll resources.
|
||||
|
||||
### Useful Guides
|
||||
## Editors
|
||||
|
||||
- [Jekyll Tips](http://jekyll.tips) is a set of resources created by [CloudCannon](https://cloudcannon.com) to help folks get up and running with Jekyll. They cover all skill levels, and even include some great video tutorials.
|
||||
- [Jekyll Cheatsheet](http://jekyll.tips/jekyll-cheat-sheet/) is a single-page resource for Jekyll filters, variables, and the like.
|
||||
- [“Creating and Hosting a Personal Site on GitHub”](http://jmcglone.com/guides/github-pages/)
|
||||
- [‘Build A Blog With Jekyll And GitHub Pages’ on Smashing Magazine](https://www.smashingmagazine.com/2014/08/01/build-blog-jekyll-github-pages/)
|
||||
- [jekyll-atom](https://atom.io/packages/jekyll): A collection of snippets and tools for Jekyll in Atom
|
||||
- [markdown-writer](https://atom.io/packages/markdown-writer): An Atom package for Jekyll. It can create new posts/drafts, manage tags/categories, insert link/images and add many useful key mappings.
|
||||
- [sublime-jekyll](https://github.com/23maverick23/sublime-jekyll): A Sublime Text package for Jekyll static sites. This package should help creating Jekyll sites and posts easier by providing access to key template tags and filters, as well as common completions and a current date/datetime command (for dating posts). You can install this package manually via GitHub, or via [Package Control](https://packagecontrol.io/packages/Jekyll).
|
||||
- [vim-jekyll](https://github.com/parkr/vim-jekyll): A vim plugin to generate new posts and run `jekyll build` all without leaving vim.
|
||||
- [WordPress2Jekyll](https://wordpress.org/plugins/wp2jekyll/): A WordPress plugin that allows you to use WordPress as your editor and (automatically) export content in to Jekyll. WordPress2Jekyll attempts to marry these two systems together in order to make a site that can be easily managed from all devices.
|
||||
|
||||
## Useful Guides
|
||||
|
||||
- [CloudCannon Academy](https://learn.cloudcannon.com/) is a set of resources created by [CloudCannon](https://cloudcannon.com/) to help folks get up and running with Jekyll. They cover all skill levels, and even include some great video tutorials.
|
||||
- [Jekyll Cheatsheet](https://learn.cloudcannon.com/jekyll-cheat-sheet/) is a single-page resource for Jekyll filters, variables, and the like.
|
||||
- ["Creating and Hosting a Personal Site on GitHub"](http://jmcglone.com/guides/github-pages/)
|
||||
- ['Build A Blog With Jekyll And GitHub Pages' on Smashing Magazine](https://www.smashingmagazine.com/2014/08/01/build-blog-jekyll-github-pages/)
|
||||
- Publishing to GitHub Pages? [Check out our documentation page for just that purpose](/docs/github-pages/).
|
||||
- [Blogging with Git, Emacs and Jekyll](https://metajack.im/2009/01/23/blogging-with-git-emacs-and-jekyll/)
|
||||
- [Tips for working with GitHub Pages Integration](https://gist.github.com/jedschneider/2890453)
|
||||
|
||||
### Integrations
|
||||
## Integrations
|
||||
|
||||
- Use a saas service as a backend for forms (contact forms, hiring forms, etc.)
|
||||
- [Formspree (also open source)](https://formspree.io/)
|
||||
- Use a SaaS service as a backend for forms (contact forms, hiring forms, etc.)
|
||||
|
||||
- [Formspree (open source)](https://formspree.io/)
|
||||
- [FormKeep](https://formkeep.com/guides/contact-form-jekyll?utm_source=github&utm_medium=jekyll-docs&utm_campaign=contact-form-jekyll)
|
||||
- [Simple Form](https://getsimpleform.com/)
|
||||
- [Formingo](https://www.formingo.co/guides/jekyll?utm_source=github&utm_medium=jekyll-docs&utm_campaign=Jekyll%20Documentation)
|
||||
- [Jekyll Bootstrap](http://jekyllbootstrap.com), 0 to Blog in 3 minutes. Provides detailed explanations, examples, and helper-code to make getting started with Jekyll easier.
|
||||
- [Integrating Twitter with Jekyll](http://www.justkez.com/integrating-twitter-with-jekyll/)
|
||||
> “Having migrated Justkez.com to be based on Jekyll, I was pondering how I might include my recent twitterings on the front page of the site. In the WordPress world, this would have been done via a plugin which may or may not have hung the loading of the page, might have employed caching, but would certainly have had some overheads. … Not in Jekyll.”
|
||||
- [Staticman](https://staticman.net): Add user-generated content to a Jekyll site (free and open source)
|
||||
- [Formester](http://www.formester.com)
|
||||
- [Talkyard](https://www.talkyard.io/blog-comments): Embedded comments for Jekyll and others (free and open source, or hosted serverless)
|
||||
- [Staticman](https://staticman.net): Add user-generated content to a Jekyll site (free and open source)
|
||||
- [Snipcart](https://snipcart.com/blog/static-site-e-commerce-part-2-integrating-snipcart-with-jekyll): Add a shopping cart to a Jekyll site
|
||||
- [Contentful](https://www.contentful.com/ecosystem/jekyll/): use Jekyll together with the API-driven Contentful CMS.
|
||||
- [Algolia](https://blog.algolia.com/instant-search-blog-documentation-jekyll-plugin/): Add a powerful instant search to your Jekyll site
|
||||
|
||||
### Other commentary
|
||||
## Other commentary
|
||||
|
||||
- [‘My Jekyll Fork’, by Mike West](https://mikewest.org/2009/11/my-jekyll-fork)
|
||||
- [How I'm using Jekyll in 2016](https://mademistakes.com/articles/using-jekyll-2016/)
|
||||
|
||||
> “Jekyll is a well-architected throwback to a time before WordPress, when men were men, and HTML was static. I like the ideas it espouses, and have made a few improvements to it’s core. Here, I’ll point out some highlights of my fork in the hopes that they see usage beyond this site.”
|
||||
- [Talkyard comments instructions for Jekyll](https://jekyll-demo.talkyard.io/2018/01/09/installation-instructions.html)
|
||||
|
||||
- [‘About this Website’, by Carter Allen](http://cartera.me/2010/08/12/about-this-website/)
|
||||
- [Static Comments with Jekyll & Staticman](https://mademistakes.com/articles/improving-jekyll-static-comments/)
|
||||
|
||||
> “Jekyll is everything that I ever wanted in a blogging engine. Really. It isn’t perfect, but what’s excellent about it is that if there’s something wrong, I know exactly how it works and how to fix it. It runs on the your machine only, and is essentially an added”build" step between you and the browser. I coded this entire site in TextMate using standard HTML5 and CSS3, and then at the end I added just a few little variables to the markup. Presto-chango, my site is built and I am at peace with the world.”
|
||||
- [Adding Ajax pagination to Jekyll](https://eduardoboucas.com/blog/2014/11/05/adding-ajax-pagination-to-jekyll.html)
|
||||
|
||||
- ['My Jekyll Fork', by Mike West](https://mikewest.org/2009/11/my-jekyll-fork)
|
||||
|
||||
> "Jekyll is a well-architected throwback to a time before WordPress, when men were men, and HTML was static. I like the ideas it espouses, and have made a few improvements to it's core. Here, I'll point out some highlights of my fork in the hopes that they see usage beyond this site."
|
||||
|
||||
- ['About this Website', by Carter Allen](http://cartera.me/2010/08/12/about-this-website/)
|
||||
|
||||
> "Jekyll is everything that I ever wanted in a blogging engine. Really. It isn't perfect, but what's excellent about it is that if there's something wrong, I know exactly how it works and how to fix it. It runs on the your machine only, and is essentially an added"build" step between you and the browser. I coded this entire site in TextMate using standard HTML5 and CSS3, and then at the end I added just a few little variables to the markup. Presto-chango, my site is built and I am at peace with the world."
|
||||
|
||||
- [Generating a Tag Cloud in Jekyll](http://www.justkez.com/generating-a-tag-cloud-in-jekyll/) – A guide to implementing a tag cloud and per-tag content pages using Jekyll.
|
||||
|
||||
- A way to [extend Jekyll](https://github.com/rfelix/jekyll_ext) without forking and modifying the Jekyll gem codebase and some [portable Jekyll extensions](https://wiki.github.com/rfelix/jekyll_ext/extensions) that can be reused and shared.
|
||||
- [Using your Rails layouts in Jekyll](http://numbers.brighterplanet.com/2010/08/09/sharing-rails-views-with-jekyll)
|
||||
- [Adding Ajax pagination to Jekyll](https://eduardoboucas.com/blog/2014/11/05/adding-ajax-pagination-to-jekyll.html)
|
||||
|
||||
@@ -66,13 +66,13 @@ following metadata:
|
||||
</table>
|
||||
</div>
|
||||
|
||||
Note that in the above table, `file` can be anything. It's simply an arbitrarily set variable used in your own logic (such as in a for loop). It isn't a global site or page variable.
|
||||
Note that in the above table, `file` can be anything. It's simply an arbitrarily set variable used in your own logic (such as in a for loop). It isn't a global site or page variable.
|
||||
|
||||
## Add front matter to static files
|
||||
|
||||
Although you can't directly add front matter values to static files, you can set front matter values through the [defaults property](../configuration/#front-matter-defaults) in your configuration file. When Jekyll builds the site, it will use the front matter values you set.
|
||||
Although you can't directly add front matter values to static files, you can set front matter values through the [defaults property](../configuration/#front-matter-defaults) in your configuration file. When Jekyll builds the site, it will use the front matter values you set.
|
||||
|
||||
Here's an example:
|
||||
Here's an example:
|
||||
|
||||
In your `_config.yml` file, add the following values to the `defaults` property:
|
||||
|
||||
@@ -88,11 +88,13 @@ This assumes that your Jekyll site has a folder path of `assets/img` where you
|
||||
|
||||
Suppose you want to list all your image assets as contained in `assets/img`. You could use this for loop to look in the `static_files` object and get all static files that have this front matter property:
|
||||
|
||||
{% raw %}
|
||||
```liquid
|
||||
{% raw %}{% assign image_files = site.static_files | where: "image", true %}
|
||||
{% assign image_files = site.static_files | where: "image", true %}
|
||||
{% for myimage in image_files %}
|
||||
{{ myimage.path }}
|
||||
{% endfor %}{% endraw %}
|
||||
{% endfor %}
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
When you build your site, the output will list the path to each file that meets this front matter condition.
|
||||
|
||||
24
docs/_docs/support.md
Normal file
24
docs/_docs/support.md
Normal file
@@ -0,0 +1,24 @@
|
||||
---
|
||||
title: Support
|
||||
permalink: "/docs/support/"
|
||||
note: This file is autogenerated. Edit /.github/SUPPORT.markdown instead.
|
||||
---
|
||||
|
||||
## Getting Help
|
||||
|
||||
**Jekyll's issue tracker is not a support forum.**
|
||||
|
||||
If you're looking for support for Jekyll, there are a lot of options:
|
||||
|
||||
* Read [Jekyll Documentation](https://jekyllrb.com/docs/home/)
|
||||
* If you have a question about using Jekyll, start a discussion on [Jekyll Forum](https://talk.jekyllrb.com/) or [StackOverflow](https://stackoverflow.com/questions/tagged/jekyll)
|
||||
* Chat with Jekyllers — Join [our Gitter channel](https://gitter.im/jekyll/jekyll) or [our IRC channel on Freenode](irc:irc.freenode.net/jekyll)
|
||||
|
||||
There are a bunch of helpful community members on these services that should be willing to point you in the right direction.
|
||||
|
||||
## Report a bug
|
||||
|
||||
* If you think you've found a bug within a Jekyll plugin, open an issue in that plugin's repository — First [look for the plugin on rubygems](https://rubygems.org/) then click on the `Homepage` link to access the plugin repository.
|
||||
* If you think you've found a bug within Jekyll itself, [open an issue](https://github.com/jekyll/jekyll/issues/new).
|
||||
|
||||
Happy Jekyllin'!
|
||||
@@ -6,8 +6,9 @@ permalink: /docs/templates/
|
||||
Jekyll uses the [Liquid](https://shopify.github.io/liquid/) templating language to
|
||||
process templates. All of the standard Liquid [tags](https://shopify.github.io/liquid/tags/control-flow/) and
|
||||
[filters](https://shopify.github.io/liquid/filters/abs/) are
|
||||
supported. Jekyll even adds a few handy filters and tags of its own to make
|
||||
common tasks easier.
|
||||
supported. To make common tasks easier, Jekyll even adds a few handy filters
|
||||
and tags of its own, all of which you can find on this page. Jekyll even lets
|
||||
you come up with your own tags via plugins.
|
||||
|
||||
## Filters
|
||||
|
||||
@@ -90,6 +91,20 @@ common tasks easier.
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<p class="name"><strong>Date to String in ordinal US style</strong></p>
|
||||
<p>Format a date to ordinal, US, short format.</p>
|
||||
</td>
|
||||
<td class="align-center">
|
||||
<p>
|
||||
<code class="filter">{% raw %}{{ site.time | date_to_string: "ordinal", "US" }}{% endraw %}</code>
|
||||
</p>
|
||||
<p>
|
||||
<code class="output">Nov 7th, 2008</code>
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<p class="name"><strong>Date to Long String</strong></p>
|
||||
@@ -104,6 +119,20 @@ common tasks easier.
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<p class="name"><strong>Date to Long String in ordinal UK style</strong></p>
|
||||
<p>Format a date to ordinal, UK, long format.</p>
|
||||
</td>
|
||||
<td class="align-center">
|
||||
<p>
|
||||
<code class="filter">{% raw %}{{ site.time | date_to_long_string: "ordinal" }}{% endraw %}</code>
|
||||
</p>
|
||||
<p>
|
||||
<code class="output">7th November 2008</code>
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<p class="name"><strong>Where</strong></p>
|
||||
@@ -118,7 +147,8 @@ common tasks easier.
|
||||
<tr>
|
||||
<td>
|
||||
<p class="name"><strong>Where Expression</strong></p>
|
||||
<p>Select all the objects in an array where the expression is true. Jekyll v3.2.0 & later.</p>
|
||||
<p>Select all the objects in an array where the expression is true.
|
||||
{% include docs_version_badge.html version="3.2.0" %}</p>
|
||||
</td>
|
||||
<td class="align-center">
|
||||
<p>
|
||||
@@ -149,7 +179,8 @@ common tasks easier.
|
||||
<tr>
|
||||
<td>
|
||||
<p class="name"><strong>Group By Expression</strong></p>
|
||||
<p>Group an array's items using a Liquid expression.</p>
|
||||
<p>Group an array's items using a Liquid expression.
|
||||
{% include docs_version_badge.html version="3.4.0" %}</p>
|
||||
</td>
|
||||
<td class="align-center">
|
||||
<p>
|
||||
@@ -292,6 +323,18 @@ common tasks easier.
|
||||
<p>
|
||||
<code class="output">the-_config.yml-file</code>
|
||||
</p>
|
||||
<p>
|
||||
<code class="filter">{% raw %}{{ "The _cönfig.yml file" | slugify: 'ascii' }}{% endraw %}</code>
|
||||
</p>
|
||||
<p>
|
||||
<code class="output">the-c-nfig-yml-file</code>
|
||||
</p>
|
||||
<p>
|
||||
<code class="filter">{% raw %}{{ "The cönfig.yml file" | slugify: 'latin' }}{% endraw %}</code>
|
||||
</p>
|
||||
<p>
|
||||
<code class="output">the-config-yml-file</code>
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -415,16 +458,25 @@ The default is `default`. They are as follows (with what they filter):
|
||||
- `raw`: spaces
|
||||
- `default`: spaces and non-alphanumeric characters
|
||||
- `pretty`: spaces and non-alphanumeric characters except for `._~!$&'()+,;=@`
|
||||
- `ascii`: spaces, non-alphanumeric, and non-ASCII characters
|
||||
- `latin`: like `default`, except Latin characters are first transliterated (e.g. `àèïòü` to `aeiou`) {%- include docs_version_badge.html version="3.7.0" -%}
|
||||
|
||||
## Tags
|
||||
|
||||
* [Includes](#includes)
|
||||
* [Code snippet highlighting](#code-snippet-highlighting)
|
||||
* [Linking to pages, collections and posts (the new and improved way)](#links)
|
||||
* [Linking to posts (the old way)](#linking-to-posts)
|
||||
|
||||
### Includes
|
||||
|
||||
If you have small page snippets that you want to include in multiple places on your site, save the snippets as *include files* and insert them where required, by using the `include` tag:
|
||||
|
||||
{% raw %}
|
||||
```liquid
|
||||
{% raw %}{% include footer.html %}{% endraw %}
|
||||
{% include footer.html %}
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
Jekyll expects all *include files* to be placed in an `_includes` directory at the root of your source directory. In the above example, this will embed the contents of `_includes/footer.html` into the calling file.
|
||||
|
||||
@@ -445,15 +497,15 @@ languages](http://pygments.org/languages/)
|
||||
|
||||
To render a code block with syntax highlighting, surround your code as follows:
|
||||
|
||||
```liquid
|
||||
{% raw %}
|
||||
```liquid
|
||||
{% highlight ruby %}
|
||||
def foo
|
||||
puts 'foo'
|
||||
end
|
||||
{% endhighlight %}
|
||||
{% endraw %}
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
The argument to the `highlight` tag (`ruby` in the example above) is the
|
||||
language identifier. To find the appropriate identifier to use for the language
|
||||
@@ -461,6 +513,13 @@ you want to highlight, look for the “short name” on the [Rouge
|
||||
wiki](https://github.com/jayferd/rouge/wiki/List-of-supported-languages-and-lexers)
|
||||
or the [Pygments' Lexers page](http://pygments.org/docs/lexers/).
|
||||
|
||||
<div class="note info">
|
||||
<h5>Jekyll processes all Liquid filters in code blocks</h5>
|
||||
<p>If you are using a language that contains curly braces, you
|
||||
will likely need to place <code>{% raw %}</code> and
|
||||
<code>{% endraw %}</code> tags around your code.</p>
|
||||
</div>
|
||||
|
||||
#### Line numbers
|
||||
|
||||
There is a second argument to `highlight` called `linenos` that is optional.
|
||||
@@ -468,15 +527,15 @@ Including the `linenos` argument will force the highlighted code to include line
|
||||
numbers. For instance, the following code block would include line numbers next
|
||||
to each line:
|
||||
|
||||
```liquid
|
||||
{% raw %}
|
||||
```liquid
|
||||
{% highlight ruby linenos %}
|
||||
def foo
|
||||
puts 'foo'
|
||||
end
|
||||
{% endhighlight %}
|
||||
{% endraw %}
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
#### Stylesheets for syntax highlighting
|
||||
|
||||
@@ -488,27 +547,6 @@ site. If you use `linenos`, you might want to include an additional CSS class
|
||||
definition for the `.lineno` class in `syntax.css` to distinguish the line
|
||||
numbers from the highlighted code.
|
||||
|
||||
### Gist
|
||||
|
||||
Use the `gist` tag to easily embed a GitHub Gist onto your site. This works
|
||||
with public or secret gists:
|
||||
|
||||
```liquid
|
||||
{% raw %}
|
||||
{% gist parkr/931c1c8d465a04042403 %}
|
||||
{% endraw %}
|
||||
```
|
||||
|
||||
You may also optionally specify the filename in the gist to display:
|
||||
|
||||
```liquid
|
||||
{% raw %}
|
||||
{% gist parkr/931c1c8d465a04042403 jekyll-private-gist.markdown %}
|
||||
{% endraw %}
|
||||
```
|
||||
|
||||
To use the `gist` tag, you'll need to add the
|
||||
[jekyll-gist](https://github.com/jekyll/jekyll-gist) gem to your project.
|
||||
|
||||
## Links
|
||||
|
||||
@@ -518,25 +556,25 @@ To link to a post, a page, collection item, or file, the `link` tag will generat
|
||||
|
||||
You must include the file's original extension when using the `link` tag. Here are some examples:
|
||||
|
||||
```liquid
|
||||
{% raw %}
|
||||
```liquid
|
||||
{{ site.baseurl }}{% link _collection/name-of-document.md %}
|
||||
{{ site.baseurl }}{% link _posts/2016-07-26-name-of-post.md %}
|
||||
{{ site.baseurl }}{% link news/index.html %}
|
||||
{{ site.baseurl }}{% link /assets/files/doc.pdf %}
|
||||
{% endraw %}
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
You can also use the `link` tag to create a link in Markdown as follows:
|
||||
|
||||
```liquid
|
||||
{% raw %}
|
||||
```liquid
|
||||
[Link to a document]({{ site.baseurl }}{% link _collection/name-of-document.md %})
|
||||
[Link to a post]({{ site.baseurl }}{% link _posts/2016-07-26-name-of-post.md %})
|
||||
[Link to a page]({{ site.baseurl }}{% link news/index.html %})
|
||||
[Link to a file]({{ site.baseurl }}{% link /assets/files/doc.pdf %})
|
||||
{% endraw %}
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
(Including `{% raw %}{{ site.baseurl }}{% endraw %}` is optional — it depends on whether you want to preface the page URL with the `baseurl` value.)
|
||||
|
||||
@@ -546,34 +584,51 @@ For example, suppose you're creating a link in `page_a.md` (stored in `pages/fol
|
||||
|
||||
If you're unsure of the path, add `{% raw %}{{ page.path }}{% endraw %}` to the page and it will display the path.
|
||||
|
||||
One major benefit of using the `link` tag is link validation. If the link doesn't exist, Jekyll won't build your site. This is a good thing, as it will alert you to a broken link so you can fix it (rather than allowing you to build and deploy a site with broken links).
|
||||
One major benefit of using the `link` or `post_url` tag is link validation. If the link doesn't exist, Jekyll won't build your site. This is a good thing, as it will alert you to a broken link so you can fix it (rather than allowing you to build and deploy a site with broken links).
|
||||
|
||||
Note you cannot add filters to `link` tags. For example, you cannot append a string using Liquid filters, such as `{% raw %}{% link mypage.html | append: "#section1" %} {% endraw %}`. To link to sections on a page, you will need to use regular HTML or Markdown linking techniques.
|
||||
|
||||
The name of the file you want to link can be specified as a variable instead of an actual file name. For example, suppose you defined a variable in your page's front matter like this:
|
||||
|
||||
```yaml
|
||||
---
|
||||
title: My page
|
||||
my_variable: footer_company_a.html
|
||||
---
|
||||
```
|
||||
|
||||
You could then reference that variable in your link:
|
||||
|
||||
```liquid
|
||||
{% raw %}{% link {{ page.my_variable }} %}{% endraw %}
|
||||
```
|
||||
|
||||
In this example, the link would add link to the file `footer_company_a.html`.
|
||||
|
||||
### Linking to posts
|
||||
|
||||
If you want to include a link to a post on your site, the `post_url` tag will generate the correct permalink URL for the post you specify.
|
||||
|
||||
```liquid
|
||||
{% raw %}
|
||||
```liquid
|
||||
{{ site.baseurl }}{% post_url 2010-07-21-name-of-post %}
|
||||
{% endraw %}
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
If you organize your posts in subdirectories, you need to include subdirectory path to the post:
|
||||
|
||||
```liquid
|
||||
{% raw %}
|
||||
```liquid
|
||||
{{ site.baseurl }}{% post_url /subdir/2010-07-21-name-of-post %}
|
||||
{% endraw %}
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
There is no need to include the file extension when using the `post_url` tag.
|
||||
|
||||
You can also use this tag to create a link to a post in Markdown as follows:
|
||||
|
||||
```liquid
|
||||
{% raw %}
|
||||
```liquid
|
||||
[Name of Link]({{ site.baseurl }}{% post_url 2010-07-21-name-of-post %})
|
||||
{% endraw %}
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
@@ -3,7 +3,7 @@ title: Themes
|
||||
permalink: /docs/themes/
|
||||
---
|
||||
|
||||
Jekyll has an extensive theme system that allows you to leverage community-maintained templates and styles to customize your site's presentation. Jekyll themes package up layouts, includes, and stylesheets in a way that can be overridden by your site's content.
|
||||
Jekyll has an extensive theme system that allows you to leverage community-maintained templates and styles to customize your site's presentation. Jekyll themes specify plugins and package up assets, layouts, includes, and stylesheets in a way that can be overridden by your site's content.
|
||||
|
||||
## Understanding gem-based themes
|
||||
|
||||
@@ -47,7 +47,7 @@ To locate a theme's files on your computer:
|
||||
|
||||
2. Open the theme's directory in Finder or Explorer:
|
||||
|
||||
```shell
|
||||
```sh
|
||||
# On MacOS
|
||||
open $(bundle show minima)
|
||||
# On Windows
|
||||
@@ -88,7 +88,7 @@ With a clear understanding of the theme's files, you can now override any theme
|
||||
|
||||
Let's say, for a second example, you want to override Minima's footer. In your Jekyll site, create an `_includes` folder and add a file in it called `footer.html`. Jekyll will now use your site's `footer.html` file instead of the `footer.html` file from the Minima theme gem.
|
||||
|
||||
To modify any stylesheet you must take the extra step of also copying the main sass file (`_sass/minima.scss` in the Minima theme) into the `_sass` directory in your site's source.
|
||||
To modify any stylesheet you must take the extra step of also copying the main sass file (`_sass/minima.scss` in the Minima theme) into the `_sass` directory in your site's source.
|
||||
|
||||
Jekyll will look first to your site's content before looking to the theme's defaults for any requested file in the following folders:
|
||||
|
||||
@@ -108,7 +108,48 @@ Suppose you want to get rid of the gem-based theme and convert it to a regular t
|
||||
|
||||
To do this, copy the files from the theme gem's directory into your Jekyll site directory. (For example, copy them to `/myblog` if you created your Jekyll site at `/myblog`. See the previous section for details.)
|
||||
|
||||
Then remove references to the theme gem in `Gemfile` and configuration. For example, to remove `minima`:
|
||||
Then you must tell Jekyll about the plugins that were referenced by the theme. You can find these plugins in the theme's gemspec file as runtime dependencies. If you were converting the Minima theme, for example, you might see:
|
||||
|
||||
```
|
||||
spec.add_runtime_dependency "jekyll-feed", "~> 0.9"
|
||||
spec.add_runtime_dependency "jekyll-seo-tag", "~> 2.1"
|
||||
```
|
||||
|
||||
You should include these references in the `Gemfile` in one of two ways.
|
||||
|
||||
You could list them individually in both `Gemfile` and `_config.yml`.
|
||||
|
||||
```ruby
|
||||
# ./Gemfile
|
||||
|
||||
gem "jekyll-feed", "~> 0.9"
|
||||
gem "jekyll-seo-tag", "~> 2.1"
|
||||
```
|
||||
|
||||
```yaml
|
||||
# ./_config.yml
|
||||
|
||||
plugins:
|
||||
- jekyll-feed
|
||||
- jekyll-seo-tag
|
||||
```
|
||||
|
||||
Or you could list them explicitly as Jekyll plugins in your Gemfile, and not update `_config.yml`, like this:
|
||||
|
||||
```ruby
|
||||
# ./Gemfile
|
||||
|
||||
group :jekyll_plugins do
|
||||
gem "jekyll-feed", "~> 0.9"
|
||||
gem "jekyll-seo-tag", "~> 2.1"
|
||||
end
|
||||
```
|
||||
|
||||
Either way, don't forget to `bundle update`.
|
||||
|
||||
However, if you're publishing on GitHub Pages you should update only your `_config.yml` as GitHub Pages doesn't load plugins via Bundler.
|
||||
|
||||
Finally, remove references to the theme gem in `Gemfile` and configuration. For example, to remove `minima`:
|
||||
|
||||
- Open `Gemfile` and remove `gem "minima", "~> 2.0"`.
|
||||
- Open `_config.yml` and remove `theme: minima`.
|
||||
@@ -125,9 +166,19 @@ To install a gem-based theme:
|
||||
|
||||
1. Add the theme to your site's `Gemfile`:
|
||||
|
||||
```sh
|
||||
```ruby
|
||||
# ./Gemfile
|
||||
|
||||
gem "jekyll-theme-awesome"
|
||||
```
|
||||
Or if you've started with the `jekyll new` command, replace `gem "minima", "~> 2.0"` with your theme-gem:
|
||||
|
||||
```diff
|
||||
# ./Gemfile
|
||||
|
||||
- gem "minima", "~> 2.0"
|
||||
+ gem "jekyll-theme-awesome"
|
||||
```
|
||||
|
||||
2. Install the theme:
|
||||
|
||||
@@ -137,7 +188,7 @@ To install a gem-based theme:
|
||||
|
||||
3. Add the following to your site's `_config.yml` to activate the theme:
|
||||
|
||||
```sh
|
||||
```yaml
|
||||
theme: jekyll-theme-awesome
|
||||
```
|
||||
|
||||
@@ -208,13 +259,15 @@ _sass
|
||||
|
||||
Your theme's styles can be included in the user's stylesheet using the `@import` directive.
|
||||
|
||||
{% raw %}
|
||||
```css
|
||||
{% raw %}@import "{{ site.theme }}";{% endraw %}
|
||||
@import "{{ site.theme }}";
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
### Theme-gem dependencies
|
||||
### Theme-gem dependencies {%- include docs_version_badge.html version="3.5.0" -%}
|
||||
|
||||
From `v3.5`, Jekyll will automatically require all whitelisted `runtime_dependencies` of your theme-gem even if they're not explicitly included under the `gems` array in the site's config file. (NOTE: whitelisting is only required when building or serving with the `--safe` option.)
|
||||
Jekyll will automatically require all whitelisted `runtime_dependencies` of your theme-gem even if they're not explicitly included under the `plugins` array in the site's config file. (Note: whitelisting is only required when building or serving with the `--safe` option.)
|
||||
|
||||
With this, the end-user need not keep track of the plugins required to be included in their config file for their theme-gem to work as intended.
|
||||
|
||||
@@ -224,7 +277,7 @@ Your theme should include a `/README.md` file, which explains how site authors c
|
||||
|
||||
### Adding a screenshot
|
||||
|
||||
Themes are visual. Show users what your theme looks like by including a screenshot as `/screenshot.png` within your theme's repository where it can be retrieved programatically. You can also include this screenshot within your theme's documentation.
|
||||
Themes are visual. Show users what your theme looks like by including a screenshot as `/screenshot.png` within your theme's repository where it can be retrieved programmatically. You can also include this screenshot within your theme's documentation.
|
||||
|
||||
### Previewing your theme
|
||||
|
||||
|
||||
@@ -36,6 +36,12 @@ If you installed the above - specifically on Fedora 23 - but the extensions woul
|
||||
sudo dnf install redhat-rpm-config
|
||||
```
|
||||
|
||||
On Arch Linux you need to run:
|
||||
|
||||
```sh
|
||||
sudo pacman -S ruby-ffi
|
||||
```
|
||||
|
||||
On Ubuntu if you get stuck after `bundle exec jekyll serve` and see error
|
||||
messages like `Could not locate Gemfile` or `.bundle/ directory`, it's likely
|
||||
because all requirements have not been fully met. Recent stock Ubuntu
|
||||
@@ -65,7 +71,7 @@ sudo emerge -av dev-ruby/rubygems
|
||||
On Windows, you may need to install [RubyInstaller
|
||||
DevKit](https://wiki.github.com/oneclick/rubyinstaller/development-kit).
|
||||
|
||||
On Android (with Termux) you can install all requirements by running:
|
||||
On Android (with Termux) you can install all requirements by running:
|
||||
|
||||
```sh
|
||||
apt update && apt install libffi-dev clang ruby-dev make
|
||||
@@ -74,7 +80,7 @@ apt update && apt install libffi-dev clang ruby-dev make
|
||||
On macOS, you may need to update RubyGems (using `sudo` only if necessary):
|
||||
|
||||
```sh
|
||||
sudo gem update --system
|
||||
gem update --system
|
||||
```
|
||||
|
||||
If you still have issues, you can download and install new Command Line
|
||||
@@ -84,11 +90,11 @@ Tools (such as `gcc`) using the following command:
|
||||
xcode-select --install
|
||||
```
|
||||
|
||||
which may allow you to install native gems using this command (again using
|
||||
which may allow you to install native gems using this command (again, using
|
||||
`sudo` only if necessary):
|
||||
|
||||
```sh
|
||||
sudo gem install jekyll
|
||||
gem install jekyll
|
||||
```
|
||||
|
||||
Note that upgrading macOS does not automatically upgrade Xcode itself
|
||||
@@ -97,16 +103,65 @@ Xcode.app can interfere with the command line tools downloaded above. If
|
||||
you run into this issue, upgrade Xcode and install the upgraded Command
|
||||
Line Tools.
|
||||
|
||||
### Running Jekyll as Non-Superuser (no sudo!)
|
||||
{: #no-sudo}
|
||||
|
||||
On most flavors of Linux, macOS, and Bash on Ubuntu on Windows, it is
|
||||
possible to run Jekyll as a non-superuser and without having to install
|
||||
gems to system-wide locations by adding the following lines to the end
|
||||
of your `.bashrc` file:
|
||||
|
||||
```
|
||||
# Ruby exports
|
||||
|
||||
export GEM_HOME=$HOME/gems
|
||||
export PATH=$HOME/gems/bin:$PATH
|
||||
```
|
||||
|
||||
This tells `gem` to place its gems within the user's home folder,
|
||||
not in a system-wide location, and adds the local `jekyll` command to the
|
||||
user's `PATH` ahead of any system-wide paths.
|
||||
|
||||
This is also useful for many shared webhosting services, where user accounts
|
||||
have only limited privileges. Adding these exports to `.bashrc` before running
|
||||
`gem install jekyll bundler` allows a complete non-`sudo` install of Jekyll.
|
||||
|
||||
To activate the new exports, either close and restart Bash, logout and
|
||||
log back into your shell account, or run `. .bashrc` in the
|
||||
currently-running shell.
|
||||
|
||||
If you see the following error when running the `jekyll new` command,
|
||||
you can solve it by using the above-described procedure:
|
||||
|
||||
```sh
|
||||
jekyll new test
|
||||
|
||||
Running bundle install in /home/user/test...
|
||||
|
||||
Your user account isn't allowed to install to the system RubyGems.
|
||||
You can cancel this installation and run:
|
||||
|
||||
bundle install --path vendor/bundle
|
||||
|
||||
to install the gems into ./vendor/bundle/, or you can enter your password
|
||||
and install the bundled gems to RubyGems using sudo.
|
||||
|
||||
Password:
|
||||
```
|
||||
|
||||
Once this is done, the `jekyll new` command should work properly for
|
||||
your user account.
|
||||
|
||||
### Jekyll & Mac OS X 10.11
|
||||
|
||||
With the introduction of System Integrity Protection, several directories
|
||||
that were previously writable are now considered system locations and are no
|
||||
longer available. Given these changes, there are a couple of simple ways to get
|
||||
up and running. One option is to change the location where the gem will be
|
||||
installed (again using `sudo` only if necessary):
|
||||
installed (again, using `sudo` only if necessary):
|
||||
|
||||
```sh
|
||||
sudo gem install -n /usr/local/bin jekyll
|
||||
gem install -n /usr/local/bin jekyll
|
||||
```
|
||||
|
||||
Alternatively, Homebrew can be installed and used to set up Ruby. This can be
|
||||
@@ -172,13 +227,13 @@ jekyll serve --baseurl '/blog'
|
||||
|
||||
… then make sure that you access the site at:
|
||||
|
||||
```sh
|
||||
```
|
||||
http://localhost:4000/blog/index.html
|
||||
```
|
||||
|
||||
It won’t work to just access:
|
||||
|
||||
```sh
|
||||
```
|
||||
http://localhost:4000/blog
|
||||
```
|
||||
|
||||
@@ -195,10 +250,37 @@ That is: defaults are overridden by options specified in `_config.yml`,
|
||||
and flags specified at the command-line will override all other settings
|
||||
specified elsewhere.
|
||||
|
||||
If you encounter an error in building the site, with the error message
|
||||
"'0000-00-00-welcome-to-jekyll.markdown.erb' does not have a valid date in the
|
||||
YAML front matter." try including the line `exclude: [vendor]`
|
||||
in `_config.yml`.
|
||||
**Note: From v3.3.0 onward, Jekyll does not process `node_modules` and certain subdirectories within `vendor`, by default. But, by having an `exclude:` array defined explicitly in the config file overrides this default setting, which results in some users to encounter an error in building the site, with the following error message:**
|
||||
|
||||
```sh
|
||||
ERROR: YOUR SITE COULD NOT BE BUILT:
|
||||
------------------------------------
|
||||
Invalid date '<%= Time.now.strftime('%Y-%m-%d %H:%M:%S %z') %>':
|
||||
Document 'vendor/bundle/gems/jekyll-3.4.3/lib/site_template/_posts/0000-00-00-welcome-to-jekyll.markdown.erb'
|
||||
does not have a valid date in the YAML front matter.
|
||||
```
|
||||
|
||||
Simply adding `vendor/bundle` to the `exclude:` list will solve this problem but will lead to having other sub-directories under `/vendor/` (and also `/node_modules/`, if present) be processed to the destination folder `_site`.
|
||||
|
||||
|
||||
The proper solution is to incorporate the default setting for `exclude:` rather than override it completely:
|
||||
|
||||
For versions upto `v3.4.3`, the `exclude:` setting must look like following:
|
||||
|
||||
```yaml
|
||||
exclude:
|
||||
- Gemfile
|
||||
- Gemfile.lock
|
||||
- node_modules
|
||||
- vendor/bundle/
|
||||
- vendor/cache/
|
||||
- vendor/gems/
|
||||
- vendor/ruby/
|
||||
- any_additional_item # any user-specific listing goes at the end
|
||||
```
|
||||
|
||||
From `v3.5` onward, `Gemfile` and `Gemfile.lock` are also excluded by default. So, in most cases there is no need to define another `exclude:` array in the config file. So an existing definition can either be modified as above, or removed completely, or simply commented out to enable easy edits in future.
|
||||
|
||||
|
||||
## Markup Problems
|
||||
|
||||
@@ -208,9 +290,8 @@ problems.
|
||||
|
||||
### Liquid
|
||||
|
||||
The latest version, version 2.0, seems to break the use of `{{ "{{" }}` in
|
||||
templates. Unlike previous versions, using `{{ "{{" }}` in 2.0 triggers the
|
||||
following error:
|
||||
Liquid version 2.0 seems to break the use of `{{ "{{" }}` in templates.
|
||||
Unlike previous versions, using `{{ "{{" }}` in 2.0 triggers the following error:
|
||||
|
||||
```sh
|
||||
'{{ "{{" }}' was not properly terminated with regexp: /\}\}/ (Liquid::SyntaxError)
|
||||
@@ -234,7 +315,7 @@ The issue is caused by trying to copy a non-existing symlink.
|
||||
<div class="note">
|
||||
<h5>Please report issues you encounter!</h5>
|
||||
<p>
|
||||
If you come across a bug, please <a href="{{ site.help_url }}/issues/new">create an issue</a>
|
||||
If you come across a bug, please <a href="{{ site.repository }}/issues/new">create an issue</a>
|
||||
on GitHub describing the problem and any work-arounds you find so we can
|
||||
document it here for others.
|
||||
</p>
|
||||
|
||||
@@ -4,10 +4,26 @@ title: Upgrading
|
||||
permalink: /docs/upgrading/
|
||||
---
|
||||
|
||||
Upgrading from an older version of Jekyll? Upgrading to a new major version of Jekyll (e.g. from v2.x to v3.x) may cause some headaches. Take the following guides to aid your upgrade:
|
||||
Upgrading from an older version of Jekyll? Upgrading to a new major version of
|
||||
Jekyll (e.g. from v2.x to v3.x) may cause some headaches. Take the following
|
||||
guides to aid your upgrade:
|
||||
|
||||
- [From 0.x to 1.x and 2.x](/docs/upgrading/0-to-2/)
|
||||
- [From 2.x to 3.x](/docs/upgrading/2-to-3/)
|
||||
|
||||
If you are making a minor update (for example from 3.3.1 to the latest version at the time 3.3.2) run 'bundle update jekyll' when in your site directory.
|
||||
If you would like to update all your gems, run 'bundle update' when in your site directory.
|
||||
## Minor updates
|
||||
|
||||
<div class="note">
|
||||
<h5>Stay Up to Date</h5>
|
||||
<p>We recommend you update Jekyll as often as possible to benefit from
|
||||
the latest bug fixes.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
If you followed our setup recommendations and installed [Bundler](http://bundler.io/), run `bundle update jekyll` or simply `bundle update` and all your gems will
|
||||
update to the latest versions.
|
||||
|
||||
If you don't have Bundler installed, run `gem update jekyll`.
|
||||
|
||||
The procedure is similar [if you use the `github-pages`
|
||||
gem](https://help.github.com/articles/setting-up-your-github-pages-site-locally-with-jekyll/#keeping-your-site-up-to-date-with-the-github-pages-gem).
|
||||
|
||||
@@ -9,7 +9,7 @@ and 2.0 that you'll want to know about.
|
||||
Before we dive in, go ahead and fetch the latest version of Jekyll:
|
||||
|
||||
```sh
|
||||
$ gem update jekyll
|
||||
gem update jekyll
|
||||
```
|
||||
|
||||
<div class="note feature">
|
||||
|
||||
@@ -3,20 +3,21 @@ title: Upgrading from 2.x to 3.x
|
||||
permalink: /docs/upgrading/2-to-3/
|
||||
---
|
||||
|
||||
Upgrading from an older version of Jekyll? A few things have changed in 3.0
|
||||
Upgrading from an older version of Jekyll? A few things have changed in Jekyll 3
|
||||
that you'll want to know about.
|
||||
|
||||
Before we dive in, go ahead and fetch the latest version of Jekyll:
|
||||
|
||||
```sh
|
||||
$ gem update jekyll
|
||||
gem update jekyll
|
||||
```
|
||||
|
||||
Please note: Jekyll 3.2 requires Ruby version >= 2.1
|
||||
Since v3.2 Jekyll requires Ruby version >= 2.1
|
||||
{: .note .warning }
|
||||
|
||||
<div class="note feature">
|
||||
<h5 markdown="1">Diving in</h5>
|
||||
<p markdown="1">Want to get a new Jekyll site up and running quickly? Simply
|
||||
<h5>Diving in</h5>
|
||||
<p>Want to get a new Jekyll site up and running quickly? Simply
|
||||
run <code>jekyll new SITENAME</code> to create a new folder with a bare bones
|
||||
Jekyll site.</p>
|
||||
</div>
|
||||
@@ -68,7 +69,7 @@ generate when running `jekyll build` or `jekyll serve`.
|
||||
<h5>Future Posts on GitHub Pages</h5>
|
||||
<p>
|
||||
An exception to the above rule are GitHub Pages sites, where the <code>--future</code> flag remains <em>enabled</em>
|
||||
by default to maintain historical consistency for those sites.
|
||||
by default to maintain historical consistency for those sites.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
|
||||
@@ -7,22 +7,31 @@ The Jekyll gem makes a `jekyll` executable available to you in your Terminal
|
||||
window. You can use this command in a number of ways:
|
||||
|
||||
```sh
|
||||
$ jekyll build
|
||||
jekyll build
|
||||
# => The current folder will be generated into ./_site
|
||||
|
||||
$ jekyll build --destination <destination>
|
||||
jekyll build --destination <destination>
|
||||
# => The current folder will be generated into <destination>
|
||||
|
||||
$ jekyll build --source <source> --destination <destination>
|
||||
jekyll build --source <source> --destination <destination>
|
||||
# => The <source> folder will be generated into <destination>
|
||||
|
||||
$ jekyll build --watch
|
||||
jekyll build --watch
|
||||
# => The current folder will be generated into ./_site,
|
||||
# watched for changes, and regenerated automatically.
|
||||
```
|
||||
|
||||
## Override default development settings
|
||||
|
||||
Default URL is set to `http://localhost:4000` in development environment. {% include docs_version_badge.html version="3.3.0" %}
|
||||
|
||||
If you want to build for your production environment:
|
||||
|
||||
- Set your production URL in `_config.yml` e.g. `url: https://example.com`.
|
||||
- Run `JEKYLL_ENV=production bundle exec jekyll build`.
|
||||
|
||||
<div class="note info">
|
||||
<h5>Changes to _config.yml are not included during automatic regeneration.</h5>
|
||||
<h5>Changes to <code>_config.yml</code> are not included during automatic regeneration.</h5>
|
||||
<p>
|
||||
The <code>_config.yml</code> master configuration file contains global configurations
|
||||
and variable definitions that are read once at execution time. Changes made to <code>_config.yml</code>
|
||||
@@ -52,25 +61,24 @@ Jekyll also comes with a built-in development server that will allow you to
|
||||
preview what the generated site will look like in your browser locally.
|
||||
|
||||
```sh
|
||||
$ jekyll serve
|
||||
jekyll serve
|
||||
# => A development server will run at http://localhost:4000/
|
||||
# Auto-regeneration: enabled. Use `--no-watch` to disable.
|
||||
|
||||
$ jekyll serve --detach
|
||||
jekyll serve --livereload
|
||||
# LiveReload refreshes your browser after a change.
|
||||
|
||||
jekyll serve --incremental
|
||||
# Incremental will perform a partial build in order to reduce regeneration time.
|
||||
|
||||
jekyll serve --detach
|
||||
# => Same as `jekyll serve` but will detach from the current terminal.
|
||||
# If you need to kill the server, you can `kill -9 1234` where "1234" is the PID.
|
||||
# If you cannot find the PID, then do, `ps aux | grep jekyll` and kill the instance.
|
||||
```
|
||||
|
||||
<div class="note info">
|
||||
<h5>Be aware of default behavior</h5>
|
||||
<p>
|
||||
As of version 2.4, the <code>serve</code> command will watch for changes automatically. To disable this, you can use <code>jekyll serve --no-watch</code>, which preserves the old behavior.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
```sh
|
||||
$ jekyll serve --no-watch
|
||||
jekyll serve --no-watch
|
||||
# => Same as `jekyll serve` but will not watch for changes.
|
||||
```
|
||||
|
||||
@@ -89,8 +97,8 @@ destination: _deploy
|
||||
Then the following two commands will be equivalent:
|
||||
|
||||
```sh
|
||||
$ jekyll build
|
||||
$ jekyll build --source _source --destination _deploy
|
||||
jekyll build
|
||||
jekyll build --source _source --destination _deploy
|
||||
```
|
||||
|
||||
For more about the possible configuration options, see the
|
||||
|
||||
@@ -185,17 +185,32 @@ following is a reference of the available data.
|
||||
|
||||
</p></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><p><code>site.url</code></p></td>
|
||||
<td><p>
|
||||
|
||||
Contains the url of your site as it is configured in the <code>_config.yml</code>.
|
||||
For example, if you have <code>url: http://mysite.com</code>
|
||||
in your configuration file, then it will be accessible in Liquid as
|
||||
<code>site.url</code>. For the development environment there is
|
||||
<a href="/news/#3-siteurl-is-set-by-the-development-server">an exception</a>,
|
||||
if you are running <code>jekyll serve</code> in a development environment
|
||||
<code>site.url</code> will be set to the value of <code>host</code>,
|
||||
<code>port</code>, and SSL-related options. This defaults to
|
||||
<code>url: http://localhost:4000</code>.
|
||||
|
||||
</p></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><p><code>site.[CONFIGURATION_DATA]</code></p></td>
|
||||
<td><p>
|
||||
|
||||
All the variables set via the command line and your
|
||||
<code>_config.yml</code> are available through the <code>site</code>
|
||||
variable. For example, if you have <code>url: http://mysite.com</code>
|
||||
in your configuration file, then in your Posts and Pages it will be
|
||||
stored in <code>site.url</code>. Jekyll does not parse changes to
|
||||
<code>_config.yml</code> in <code>watch</code> mode, you must restart
|
||||
Jekyll to see changes to variables.
|
||||
variable. For example, if you have <code>foo: bar</code>
|
||||
in your configuration file, then it will be accessible in Liquid as <code>site.foo</code>.
|
||||
Jekyll does not parse changes to <code>_config.yml</code> in
|
||||
<code>watch</code> mode, you must restart Jekyll to see changes to variables.
|
||||
|
||||
</p></td>
|
||||
</tr>
|
||||
@@ -235,7 +250,7 @@ following is a reference of the available data.
|
||||
<td><p><code>page.excerpt</code></p></td>
|
||||
<td><p>
|
||||
|
||||
The un-rendered excerpt of the Page.
|
||||
The un-rendered excerpt of a document.
|
||||
|
||||
</p></td>
|
||||
</tr>
|
||||
@@ -265,8 +280,9 @@ following is a reference of the available data.
|
||||
<td><p><code>page.id</code></p></td>
|
||||
<td><p>
|
||||
|
||||
An identifier unique to the Post (useful in RSS feeds). e.g.
|
||||
An identifier unique to a document in a Collection or a Post (useful in RSS feeds). e.g.
|
||||
<code>/2008/12/14/my-post</code>
|
||||
<code>/my-collection/my-document</code>
|
||||
|
||||
</p></td>
|
||||
</tr>
|
||||
|
||||
@@ -7,177 +7,27 @@ While Windows is not an officially-supported platform, it can be used to run Jek
|
||||
|
||||
|
||||
## Installing Jekyll
|
||||
|
||||
If you are using Windows 10 Anniversary Update, the easiest way to run Jekyll is by [installing][WSL-Guide] the new Bash on Ubuntu on Windows.
|
||||
|
||||
|
||||
### Installation via Bash on Windows 10
|
||||
|
||||
*Note:* You must have [Bash on Ubuntu on Windows][BASH-WSL] enabled.
|
||||
|
||||
First let's make sure all our packages / repositories are up to date. Open a new Command Prompt instance, and type the following:
|
||||
|
||||
```
|
||||
bash
|
||||
```
|
||||
Your Command Prompt instance should now be a Bash instance. Now we must update our repo lists and packages.
|
||||
|
||||
```
|
||||
sudo apt-get update -y && sudo apt-get upgrade -y
|
||||
```
|
||||
Now we can install Ruby. To do this we will use a repository from [BrightBox](https://www.brightbox.com/docs/ruby/ubuntu/), which hosts optimized versions of Ruby for Ubuntu.
|
||||
|
||||
```
|
||||
sudo apt-add-repository ppa:brightbox/ruby-ng
|
||||
sudo apt-get update
|
||||
sudo apt-get install ruby2.3 ruby2.3-dev build-essential
|
||||
```
|
||||
|
||||
Next let's update our Ruby gems:
|
||||
|
||||
```
|
||||
sudo gem update
|
||||
```
|
||||
|
||||
Now all that is left to do is install Jekyll.
|
||||
|
||||
```
|
||||
sudo gem install jekyll bundler
|
||||
```
|
||||
|
||||
Check if Jekyll installed properly by running:
|
||||
|
||||
```
|
||||
jekyll -v
|
||||
```
|
||||
|
||||
**And that's it!**
|
||||
|
||||
To start a new project named `my_blog`, just run:
|
||||
|
||||
```
|
||||
jekyll new my_blog
|
||||
```
|
||||
|
||||
You can make sure time management is working properly by inspecting your `_posts` folder. You should see a markdown file with the current date in the filename.
|
||||
|
||||
**Note:** Bash on Ubuntu on Windows is still under development, so you may run into issues.
|
||||
|
||||
|
||||
[WSL-Guide]: https://msdn.microsoft.com/en-us/commandline/wsl/install_guide
|
||||
[BASH-WSL]: https://msdn.microsoft.com/en-us/commandline/wsl/about
|
||||
|
||||
The easiest way to run Jekyll is by using the [RubyInstaller][] for Windows.
|
||||
|
||||
### Installation via RubyInstaller
|
||||
|
||||
[RubyInstaller][] is a self-contained Windows-based installer that includes the Ruby language, an execution environment, important documentation, and more.
|
||||
We only cover RubyInstaller-2.4 and newer here, older versions need to [install the Devkit][Devkit-install] manually.
|
||||
|
||||
1. Download and Install a package manager version from [RubyInstaller Downloads][RubyInstaller-downloads].
|
||||
2. Install Jekyll and Bundler via a command prompt window: `gem install jekyll bundler`
|
||||
1. Download and Install a **Ruby+Devkit** version from [RubyInstaller Downloads][RubyInstaller-downloads].
|
||||
Use default options for installation.
|
||||
2. Open a new command prompt window from the start menu, so that changes to the `PATH` environment variable becomes effective.
|
||||
Install Jekyll and Bundler via: `gem install jekyll bundler`
|
||||
3. Check if Jekyll installed properly: `jekyll -v`
|
||||
|
||||
That's it, you're ready to install our [default minimal blog theme](https://github.com/jekyll/minima) with `jekyll new jekyll-website`.
|
||||
|
||||
[RubyInstaller]: https://rubyinstaller.org/
|
||||
[RubyInstaller-downloads]: https://rubyinstaller.org/downloads/
|
||||
[Devkit-install]: https://github.com/oneclick/rubyinstaller/wiki/Development-Kit
|
||||
|
||||
|
||||
### Installation via Chocolatey
|
||||
|
||||
A quick way to install Jekyll using Chocolatey is to follow the [installation instructions by David Burela](https://davidburela.wordpress.com/2015/11/28/easily-install-jekyll-on-windows-with-3-command-prompt-entries-and-chocolatey/):
|
||||
|
||||
1. Install a package manager for Windows called [Chocolatey][]
|
||||
2. Install Ruby via Chocolatey: `choco install ruby -y`
|
||||
3. Reopen a command prompt and install Jekyll: `gem install jekyll`
|
||||
|
||||
Updates in the infrastructure of Ruby may cause SSL errors when attempting to use `gem install` with versions of the RubyGems package older than 2.6. (The RubyGems package installed via the Chocolatey tool is version 2.3) If you have installed an older version, you can update the RubyGems package using the directions [here][ssl-certificate-update].
|
||||
|
||||
[ssl-certificate-update]: http://guides.rubygems.org/ssl-certificate-update/#installing-using-update-packages
|
||||
|
||||
|
||||
### Installing *github-pages* via Chocolatey
|
||||
|
||||
This section is part of an article written by [Jens Willmer][jwillmerPost]. To follow the instructions you need to have [Chocolatey][] installed on your system. If you already have a version of Ruby installed you need to uninstall it before you can continue.
|
||||
|
||||
|
||||
#### Install Ruby and Ruby development kit
|
||||
|
||||
Open a command prompt and execute the following commands:
|
||||
|
||||
* `choco install ruby -version 2.2.4`
|
||||
* `choco install ruby2.devkit` - _needed for compilation of json gem_
|
||||
|
||||
|
||||
#### Configure Ruby development kit
|
||||
|
||||
The development kit did not set the environment path for Ruby so we need to do it.
|
||||
|
||||
* Open command prompt in `C:\tools\DevKit2`
|
||||
* Execute `ruby dk.rb init` to create a file called `config.yml`
|
||||
* Edit the `config.yml` file and include the path to Ruby `- C:/tools/ruby22`
|
||||
* Execute the following command to set the path: `ruby dk.rb install`
|
||||
|
||||
|
||||
#### Nokogiri gem installation
|
||||
|
||||
This gem is also needed in the github-pages and to get it running on Windows x64 we have to install a few things.
|
||||
|
||||
**Note:** In the current [pre release][nokogiriFails] it works out of the box with Windows x64 but this version is not referenced in the github-pages.
|
||||
|
||||
`choco install libxml2 -Source "https://www.nuget.org/api/v2/"`{:.language-ruby}
|
||||
|
||||
`choco install libxslt -Source "https://www.nuget.org/api/v2/"`{:.language-ruby}
|
||||
|
||||
`choco install libiconv -Source "https://www.nuget.org/api/v2/"`{:.language-ruby}
|
||||
|
||||
```ruby
|
||||
gem install nokogiri --^
|
||||
--with-xml2-include=C:\Chocolatey\lib\libxml2.2.7.8.7\build\native\include^
|
||||
--with-xml2-lib=C:\Chocolatey\lib\libxml2.redist.2.7.8.7\build\native\bin\v110\x64\Release\dynamic\cdecl^
|
||||
--with-iconv-include=C:\Chocolatey\lib\libiconv.1.14.0.11\build\native\include^
|
||||
--with-iconv-lib=C:\Chocolatey\lib\libiconv.redist.1.14.0.11\build\native\bin\v110\x64\Release\dynamic\cdecl^
|
||||
--with-xslt-include=C:\Chocolatey\lib\libxslt.1.1.28.0\build\native\include^
|
||||
--with-xslt-lib=C:\Chocolatey\lib\libxslt.redist.1.1.28.0\build\native\bin\v110\x64\Release\dynamic
|
||||
```
|
||||
|
||||
#### Install github-pages
|
||||
|
||||
* Open command prompt and install [Bundler][]: `gem install bundler`
|
||||
* Create a file called `Gemfile` without any extension in your root directory of your blog
|
||||
* Copy & paste the two lines into the file:
|
||||
|
||||
|
||||
```ruby
|
||||
source 'https://rubygems.org'
|
||||
gem 'github-pages', group: :jekyll_plugins
|
||||
```
|
||||
|
||||
* **Note:** We use an unsecure connection because SSL throws exceptions in the version of Ruby
|
||||
* Open a command prompt, target your local blog repository root, and install github-pages: `bundle install`
|
||||
|
||||
|
||||
After this process you should have github-pages installed on your system and you can host your blog again with `jekyll s`.
|
||||
There will be a warning on startup that you should include `gem 'wdm', '>= 0.1.0' if Gem.win_platform?` to your `Gemfile` but I could not get `jekyll s` working if I include that line so for the moment I ignore that warning.
|
||||
|
||||
In the future the installation process of the github-pages should be as simple as the setup of the blog. But as long as the new version of the Nokogiri ([v1.6.8][nokogiriReleases]) is not stable and referenced, it is work to get it up and running on Windows.
|
||||
|
||||
[jwillmerPost]: https://jwillmer.de/blog/tutorial/how-to-install-jekyll-and-pages-gem-on-windows-10-x46 "Installation instructions by Jens Willmer"
|
||||
[Chocolatey]: https://chocolatey.org/install "Package manager for Windows"
|
||||
[nokogiriFails]: https://github.com/sparklemotion/nokogiri/issues/1456#issuecomment-206481794 "Nokogiri fails to install on Ruby 2.3 for Windows"
|
||||
[Bundler]: http://bundler.io/ "Ruby Dependencie Manager"
|
||||
[nokogiriReleases]: https://github.com/sparklemotion/nokogiri/releases "Nokogiri Releases"
|
||||
|
||||
---
|
||||
|
||||
For a more conventional way of installing Jekyll you can follow this [complete guide to install Jekyll 3 on Windows by Sverrir Sigmundarson][windows-installjekyll3].
|
||||
|
||||
Optionally you can use [Autoinstall Jekyll for Windows][fastjekyll-autoinstall].
|
||||
|
||||
---
|
||||
|
||||
[windows-installjekyll3]: https://labs.sverrirs.com/jekyll/
|
||||
[fastjekyll-autoinstall]: https://github.com/KeJunMao/fastjekyll#autoinstall-jekyll-for-windows
|
||||
|
||||
|
||||
## Encoding
|
||||
### Encoding
|
||||
|
||||
If you use UTF-8 encoding, make sure that no `BOM` header characters exist in your files or very, very bad things will happen to
|
||||
Jekyll. This is especially relevant when you're running Jekyll on Windows.
|
||||
@@ -185,11 +35,11 @@ Jekyll. This is especially relevant when you're running Jekyll on Windows.
|
||||
Additionally, you might need to change the code page of the console window to UTF-8 in case you get a "Liquid Exception: Incompatible character encoding" error during the site generation process. It can be done with the following command:
|
||||
|
||||
```sh
|
||||
$ chcp 65001
|
||||
chcp 65001
|
||||
```
|
||||
|
||||
|
||||
## Time-Zone Management
|
||||
### Time-Zone Management
|
||||
|
||||
Since Windows doesn't have a native source of zoneinfo data, the Ruby Interpreter would not understand IANA Timezones and hence using them had the `TZ` environment variable default to UTC/GMT 00:00.
|
||||
Though Windows users could alternatively define their blog's timezone by setting the key to use POSIX format of defining timezones, it wasn't as user-friendly when it came to having the clock altered to changing DST-rules.
|
||||
@@ -204,13 +54,85 @@ gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]
|
||||
|
||||
[IANA-database]: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
|
||||
|
||||
### Auto Regeneration
|
||||
|
||||
## Auto Regeneration
|
||||
|
||||
As of v1.3.0, Jekyll uses the `listen` gem to watch for changes when the `--watch` switch is specified during a build or serve. While `listen` has built-in support for UNIX systems, it may require an extra gem for compatibility with Windows.
|
||||
Jekyll uses the `listen` gem to watch for changes when the `--watch` switch is specified during a build or serve. While `listen` has built-in support for UNIX systems, it may require an extra gem for compatibility with Windows.
|
||||
|
||||
Add the following to the Gemfile for your site if you have issues with auto-regeneration on Windows alone:
|
||||
|
||||
```ruby
|
||||
gem 'wdm', '~> 0.1.0' if Gem.win_platform?
|
||||
gem 'wdm', '~> 0.1.1' if Gem.win_platform?
|
||||
```
|
||||
|
||||
You have to use a [Ruby+Devkit](https://rubyinstaller.org/downloads/) version of the RubyInstaller.
|
||||
|
||||
|
||||
## Installation via Bash on Windows 10
|
||||
|
||||
If you are using Windows 10 version 1607 or later, another option to run Jekyll is by [installing][WSL-Guide] the Windows Subsystem for Linux.
|
||||
|
||||
|
||||
*Note:* You must have [Windows Subsystem for Linux][BASH-WSL] enabled.
|
||||
|
||||
First let's make sure all our packages / repositories are up to date. Open a new Command Prompt instance, and type the following:
|
||||
|
||||
```sh
|
||||
bash
|
||||
```
|
||||
Your Command Prompt instance should now be a Bash instance. Now we must update our repo lists and packages.
|
||||
|
||||
```sh
|
||||
sudo apt-get update -y && sudo apt-get upgrade -y
|
||||
```
|
||||
Now we can install Ruby. To do this we will use a repository from [BrightBox](https://www.brightbox.com/docs/ruby/ubuntu/), which hosts optimized versions of Ruby for Ubuntu.
|
||||
|
||||
```sh
|
||||
sudo apt-add-repository ppa:brightbox/ruby-ng
|
||||
sudo apt-get update
|
||||
sudo apt-get install ruby2.3 ruby2.3-dev build-essential dh-autoreconf
|
||||
```
|
||||
|
||||
Next let's update our Ruby gems:
|
||||
|
||||
```sh
|
||||
sudo gem update
|
||||
```
|
||||
|
||||
Now all that is left to do is install Jekyll.
|
||||
|
||||
```sh
|
||||
sudo gem install jekyll bundler
|
||||
```
|
||||
|
||||
Check if Jekyll installed properly by running:
|
||||
|
||||
```sh
|
||||
jekyll -v
|
||||
```
|
||||
|
||||
Configure the bundler/gem path so bundle doesn't prompt for sudo
|
||||
|
||||
```sh
|
||||
bundle config path vendor/bundle
|
||||
```
|
||||
|
||||
**And that's it!**
|
||||
|
||||
To start a new project named `my_blog`, just run:
|
||||
|
||||
```sh
|
||||
jekyll new my_blog
|
||||
```
|
||||
|
||||
You can make sure time management is working properly by inspecting your `_posts` folder. You should see a markdown file with the current date in the filename.
|
||||
|
||||
<div class="note info">
|
||||
<h5>Non-superuser account issues</h5>
|
||||
<p>If the `jekyll new` command prints the error "Your user account isn't allowed to install to the system RubyGems", see the "Running Jekyll as Non-Superuser" instructions in <a href="/docs/troubleshooting/#no-sudo">Troubleshooting</a>.</p>
|
||||
</div>
|
||||
|
||||
**Note:** Bash on Ubuntu on Windows is still under development, so you may run into issues.
|
||||
|
||||
[WSL-Guide]: https://msdn.microsoft.com/en-us/commandline/wsl/install_guide
|
||||
[BASH-WSL]: https://msdn.microsoft.com/en-us/commandline/wsl/about
|
||||
|
||||
|
||||
@@ -1,26 +1,9 @@
|
||||
{% if site.gauges_id %}
|
||||
<!-- Gauges (http://get.gaug.es/) -->
|
||||
<script>
|
||||
var _gauges = _gauges || [];
|
||||
(function() {
|
||||
var t = document.createElement('script');
|
||||
t.type = 'text/javascript';
|
||||
t.async = true;
|
||||
t.id = 'gauges-tracker';
|
||||
t.setAttribute('data-site-id', '{{ site.gauges_id }}');
|
||||
t.src = '//secure.gaug.es/track.js';
|
||||
var s = document.getElementsByTagName('script')[0];
|
||||
s.parentNode.insertBefore(t, s);
|
||||
})();
|
||||
</script>
|
||||
{% endif %}
|
||||
|
||||
{% if site.google_analytics_id %}
|
||||
<!-- Google Analytics (https://www.google.com/analytics) -->
|
||||
<script>
|
||||
!function(j,e,k,y,l,L){j.GoogleAnalyticsObject=y,j[y]||(j[y]=function(){
|
||||
(j[y].q=j[y].q||[]).push(arguments)}),j[y].l=+new Date,l=e.createElement(k),
|
||||
L=e.getElementsByTagName(k)[0],l.src='//www.google-analytics.com/analytics.js',
|
||||
L=e.getElementsByTagName(k)[0],l.src='https://www.google-analytics.com/analytics.js',
|
||||
L.parentNode.insertBefore(l,L)}(window,document,'script','ga');
|
||||
|
||||
ga('create', '{{ site.google_analytics_id }}', 'jekyllrb.com');
|
||||
|
||||
1
docs/_includes/docs_version_badge.html
Normal file
1
docs/_includes/docs_version_badge.html
Normal file
@@ -0,0 +1 @@
|
||||
<span class="version-badge" title="This feature is available starting version {{ include.version }}">{{ include.version }}</span>
|
||||
@@ -1,18 +1,31 @@
|
||||
<header>
|
||||
<nav class="mobile-nav show-on-mobiles">
|
||||
{% include primary-nav-items.html %}
|
||||
</nav>
|
||||
<div class="grid">
|
||||
<div class="unit one-third center-on-mobiles">
|
||||
<div class="flexbox">
|
||||
<div class="center-on-mobiles">
|
||||
<h1>
|
||||
<a href="/">
|
||||
<a href="/" class="logo">
|
||||
<span class="sr-only">Jekyll</span>
|
||||
<img src="/img/logo-2x.png" width="249" height="115" alt="Jekyll Logo">
|
||||
<img src="/img/logo-2x.png" width="140" height="65" alt="Jekyll Logo">
|
||||
</a>
|
||||
</h1>
|
||||
</div>
|
||||
<nav class="main-nav unit two-thirds hide-on-mobiles">
|
||||
<nav class="main-nav hide-on-mobiles">
|
||||
{% include primary-nav-items.html %}
|
||||
</nav>
|
||||
<div class="search hide-on-mobiles">
|
||||
{% include search/input.html %}
|
||||
</div>
|
||||
<div class="meta hide-on-mobiles">
|
||||
<ul>
|
||||
<li>
|
||||
<a href="{{ site.repository }}/releases/tag/v{{ site.version }}">v{{ site.version }}</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="{{ site.repository }}">GitHub</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
<nav class="mobile-nav show-on-mobiles">
|
||||
{% include mobile-nav-items.html %}
|
||||
</nav>
|
||||
</header>
|
||||
|
||||
17
docs/_includes/mobile-nav-items.html
Normal file
17
docs/_includes/mobile-nav-items.html
Normal file
@@ -0,0 +1,17 @@
|
||||
<ul>
|
||||
<li class="{% if page.overview %}current{% endif %}">
|
||||
<a href="/">Home</a>
|
||||
</li>
|
||||
<li class="{% if page.url contains '/docs/' %}current{% endif %}">
|
||||
<a href="/docs/home/">Docs</a>
|
||||
</li>
|
||||
<li class="{% if page.author %}current{% endif %}">
|
||||
<a href="/news/">News</a>
|
||||
</li>
|
||||
<li class="{% if page.url contains '/help/' %}current{% endif %}">
|
||||
<a href="/help/">Help</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="{{ site.repository }}">GitHub</a>
|
||||
</li>
|
||||
</ul>
|
||||
@@ -13,10 +13,10 @@
|
||||
<span class="post-date">
|
||||
{{ post.date | date_to_string }}
|
||||
</span>
|
||||
<a href="https://github.com/{{ post.author }}" class="post-author">
|
||||
{% assign author = post.author %}
|
||||
{% assign author = post.author %}
|
||||
<a href="https://github.com/{{ author }}" class="post-author">
|
||||
{% avatar user=author size=24 %}
|
||||
{{ post.author }}
|
||||
{{ author }}
|
||||
</a>
|
||||
</div>
|
||||
<div class="post-content">
|
||||
|
||||
@@ -8,13 +8,7 @@
|
||||
<li class="{% if page.author %}current{% endif %}">
|
||||
<a href="/news/">News</a>
|
||||
</li>
|
||||
<li class="{% if page.url contains '/community/' %}current{% endif %}">
|
||||
<a href="/community/">Community</a>
|
||||
</li>
|
||||
<li class="{% if page.url contains '/help/' %}current{% endif %}">
|
||||
<a href="/help/">Help</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="{{ site.repository }}">GitHub</a>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
1
docs/_includes/search/input.html
Normal file
1
docs/_includes/search/input.html
Normal file
@@ -0,0 +1 @@
|
||||
<input type="text" id="docsearch-input" placeholder="Search the docs…">
|
||||
9
docs/_includes/search/script.html
Normal file
9
docs/_includes/search/script.html
Normal file
@@ -0,0 +1,9 @@
|
||||
<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.js"></script>
|
||||
<script type="text/javascript"> docsearch({
|
||||
apiKey: '50fe39c839958dfad797000f33e2ec17',
|
||||
indexName: 'jekyllrb',
|
||||
inputSelector: '#docsearch-input',
|
||||
enhancedSearchInput: true,
|
||||
debug: false // Set debug to true if you want to inspect the dropdown
|
||||
});
|
||||
</script>
|
||||
@@ -6,7 +6,9 @@
|
||||
<meta name="generator" content="Jekyll v{{ jekyll.version }}">
|
||||
{% feed_meta %}
|
||||
<link rel="alternate" type="application/atom+xml" title="Recent commits to Jekyll’s master branch" href="{{ site.repository }}/commits/master.atom">
|
||||
<link rel="stylesheet" href="//fonts.googleapis.com/css?family=Lato:300,300italic,400,400italic,700,700italic,900">
|
||||
<link rel="preconnect" href="https://fonts.gstatic.com/" crossorigin>
|
||||
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Lato:300,300italic,400,400italic,700,700italic,900">
|
||||
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css" />
|
||||
<link rel="stylesheet" href="/css/screen.css">
|
||||
<link rel="icon" type="image/x-icon" href="/favicon.ico">
|
||||
{% seo %}
|
||||
|
||||
@@ -8,6 +8,6 @@
|
||||
{% include footer.html %}
|
||||
{% include anchor_links.html %}
|
||||
{% include analytics.html %}
|
||||
|
||||
{% include search/script.html %}
|
||||
</body>
|
||||
</html>
|
||||
|
||||
@@ -5,7 +5,10 @@ layout: news
|
||||
<article>
|
||||
<h2>
|
||||
{{ page.title }}
|
||||
<a href="{{ page.url }}" class="permalink" title="Permalink">∞</a>
|
||||
<a href="{{ page.url }}" class="header-link" title="Permalink">
|
||||
<span class="sr-only">Permalink</span>
|
||||
<i class="fa fa-link"></i>
|
||||
</a>
|
||||
</h2>
|
||||
<span class="post-category">
|
||||
<span class="label">
|
||||
@@ -16,9 +19,10 @@ layout: news
|
||||
<span class="post-date">
|
||||
{{ page.date | date_to_string }}
|
||||
</span>
|
||||
<a href="https://github.com/{{ page.author }}" class="post-author">
|
||||
{% avatar {{ page.author}} size=24 %}
|
||||
{{ page.author }}
|
||||
{% assign author = page.author %}
|
||||
<a href="https://github.com/{{ author }}" class="post-author">
|
||||
{% avatar user=author size=24 %}
|
||||
{{ author }}
|
||||
</a>
|
||||
</div>
|
||||
<div class="post-content">
|
||||
|
||||
@@ -6,25 +6,18 @@ version: 1.1.1
|
||||
categories: [release]
|
||||
---
|
||||
|
||||
Coming just 10 days after the release of v1.1.0, v1.1.1 is out with a patch for
|
||||
the nasty excerpt inception bug ([#1339]({{ site.repository }}/issues/1339)) and
|
||||
non-zero exit codes for invalid commands ([#1338]({{ site.repository
|
||||
}}/issues/1338)).
|
||||
|
||||
Coming just 10 days after the release of v1.1.0, v1.1.1 is out with a patch for the nasty
|
||||
excerpt inception bug ([#1339][]) and non-zero exit codes for invalid commands
|
||||
([#1338][]).
|
||||
To all those affected by the [strange excerpt bug in v1.1.0]({{ site.repository
|
||||
}}/issues/1321), I'm sorry. I think we have it all patched up and it should be
|
||||
deployed to [GitHub Pages](https://pages.github.com/) in the next couple weeks.
|
||||
Thank you for your patience!
|
||||
|
||||
To all those affected by the [strange excerpt bug in v1.1.0][#1321], I'm sorry. I think we
|
||||
have it all patched up and it should be deployed to [GitHub Pages][gh_pages] in the next
|
||||
couple weeks. Thank you for your patience!
|
||||
If you're checking out v1.1.x for the first time, definitely check out [what
|
||||
shipped with v1.1.0!]({{ site.repository }}/releases/tag/v1.1.0)
|
||||
|
||||
If you're checking out v1.1.x for the first time, definitely check out [what shipped with
|
||||
v1.1.0!][v1_1_0]
|
||||
|
||||
See the [GitHub Release][] page for more a more detailed changelog for this release.
|
||||
|
||||
{% assign issue_numbers = "1339|1338|1321" | split: "|" %}
|
||||
{% for issue in issue_numbers %}
|
||||
[#{{ issue }}]: {{ site.repository }}/issues/{{ issue }}
|
||||
{% endfor %}
|
||||
|
||||
[GitHub Release]: {{ site.repository }}/releases/tag/v1.1.1
|
||||
[gh_pages]: https://pages.github.com/
|
||||
[v1_1_0]: {{ site.repository }}/releases/tag/v1.1.0
|
||||
See the [GitHub Release]({{ site.repository }}/releases/tag/v1.1.1) page for
|
||||
more a more detailed changelog for this release.
|
||||
|
||||
@@ -5,7 +5,7 @@ author: parkr
|
||||
categories: [partners]
|
||||
---
|
||||
|
||||

|
||||

|
||||
|
||||
You may have heard that [@cobyism](https://github.com/cobyism)'s excellent
|
||||
Jekyll logo has been made into a sticker. You may have sat idly by, wishing
|
||||
|
||||
@@ -10,7 +10,7 @@ Happy Holidays, everyone.
|
||||
|
||||
Jekyll v2.5.3 is a quick patch release, containing some minor fixes. See the
|
||||
[full history](/docs/history/) for more info. If you notice any problems,
|
||||
please [let us know]({{ site.help_url }}).
|
||||
please [let us know]({{ site.repository }}).
|
||||
|
||||
This release also marks the start of Jekyll 3 development. I wrote about it
|
||||
over on my personal blog: [Jekyll 3 — The Road Ahead](https://byparker.com/blog/2014/jekyll-3-the-road-ahead/).
|
||||
|
||||
@@ -9,7 +9,7 @@ categories: [release]
|
||||
Good news! Nearly 400 commits later, Jekyll 3.5.0 has been released into
|
||||
the wild. Some new shiny things you might want to test out:
|
||||
|
||||
- Jekyll now uses Liquid 4, the latest! It comes with whitespace control, new filters `concat` annd `compact`, loop performance improvements and [many fixes](https://github.com/Shopify/liquid/blob/master/History.md#400--2016-12-14--branch-4-0-stable)
|
||||
- Jekyll now uses Liquid 4, the latest! It comes with whitespace control, new filters `concat` and `compact`, loop performance improvements and [many fixes](https://github.com/Shopify/liquid/blob/master/History.md#400--2016-12-14--branch-4-0-stable)
|
||||
- Themes can specify runtime dependencies (in their gemspecs) and we'll require those. This makes it easier for theme writers to use plugins.
|
||||
- Speaking of themes, we'll properly handle the discrepancy between a convertible file in the local site and a static file in the theme. Overriding a file locally now doesn't matter if it's convertible or static.
|
||||
- Pages, posts, and other documents can now access layout variables via `{% raw %}{{ layout }}{% endraw %}`.
|
||||
|
||||
23
docs/_posts/2017-08-12-jekyll-3-5-2-released.markdown
Normal file
23
docs/_posts/2017-08-12-jekyll-3-5-2-released.markdown
Normal file
@@ -0,0 +1,23 @@
|
||||
---
|
||||
title: 'Jekyll 3.5.2 Released'
|
||||
date: 2017-08-12 16:31:40 -0400
|
||||
author: parkr
|
||||
version: 3.5.2
|
||||
categories: [release]
|
||||
---
|
||||
|
||||
3.5.2 is out with 6 great bug fixes, most notably one which should dramatically speed up generation of your site! In testing #6266, jekyllrb.com generation when from 18 seconds down to 8! Here is the full line-up of fixes:
|
||||
|
||||
* Backport #6266 for v3.5.x: Memoize the return value of `Document#url` (#6301)
|
||||
* Backport #6247 for v3.5.x: kramdown: symbolize keys in-place (#6303)
|
||||
* Backport #6281 for v3.5.x: Fix `Drop#key?` so it can handle a nil argument (#6288)
|
||||
* Backport #6280 for v3.5.x: Guard against type error in `absolute_url` (#6287)
|
||||
* Backport #6273 for v3.5.x: delegate `StaticFile#to_json` to `StaticFile#to_liquid` (#6302)
|
||||
* Backport #6226 for v3.5.x: `Reader#read_directories`: guard against an entry not being a directory (#6304
|
||||
|
||||
A [full history](/docs/history/#v3-5-2) is available for your perusal. As always, please file bugs if you encounter them! Opening a pull request with a failing test for your expected behaviour is the easiest way for us to address the issue since we have a reproducible example to test again. Short of that, please fill out our issue template to the best of your ability and we'll try to get to it quickly!
|
||||
|
||||
Many thanks to our contributors without whom this release could not be
|
||||
possible: Ben Balter & Kyle Zhao.
|
||||
|
||||
Happy Jekylling!
|
||||
17
docs/_posts/2017-09-21-jekyll-3-6-0-released.markdown
Normal file
17
docs/_posts/2017-09-21-jekyll-3-6-0-released.markdown
Normal file
@@ -0,0 +1,17 @@
|
||||
---
|
||||
title: 'Jekyll turns 3.6!'
|
||||
date: 2017-09-21 16:38:20 -0400
|
||||
author: parkr
|
||||
version: 3.6.0
|
||||
categories: [release]
|
||||
---
|
||||
|
||||
Another much-anticipated release of Jekyll. This release comes with it Rouge 2 support, but note you can continue to use Rouge 1 if you'd prefer. We also now require Ruby 2.1.0 as 2.0.x is no longer supported by the Ruby team.
|
||||
|
||||
Otherwise, it's a massive bug-fix release! A few bugs were found and squashed with our `Drop` implementation. We're using the Schwartzian transform to speed up our custom sorting (thanks, Perl community!). We now protect against images that are named like posts and we generally worked on guarding our code to enforce requirements, instead of assuming the input was as expected.
|
||||
|
||||
Please let us know if you find any bugs! You can see [the full history here](/docs/history/#v3-6-0).
|
||||
|
||||
Many thanks to our contributors who helped make this release possible: Aleksander Kuś, André Jaenisch, Antonio Argote, ashmaroli, Ben Balter, Bogdan, Bradley Meck, David Zhang, Florian Thomas, Frank Taillandier, Jordon Bedwell, Joshua Byrd, Kyle Zhao, lymaconsulting, Maciej Bembenista, Matt Sturgeon, Natanael Arndt, Ohad Schneider, Pat Hawks, Pedro Lamas, and Sid Verma.
|
||||
|
||||
As always, Happy Jekylling!
|
||||
44
docs/_posts/2017-10-19-diversity-open-source.markdown
Normal file
44
docs/_posts/2017-10-19-diversity-open-source.markdown
Normal file
@@ -0,0 +1,44 @@
|
||||
---
|
||||
title: "Diversity in Open Source, and Jekyll's role in it"
|
||||
date: 2017-10-19 21:33:00 +0200
|
||||
author: oe
|
||||
categories: [community]
|
||||
---
|
||||
|
||||
Open Source has a problem with diversity. GitHub recently conducted a [survey](http://opensourcesurvey.org/2017) which revealed that 95% of the respondents were identifying as male. This is even worse than in the tech industry overall, where the percentage is only about 76%. Every other week, there seems to be another case of a maintainer engaging in targeted harassment against minorities. People somehow deem it completely okay to let these things slide, though.
|
||||
|
||||
Fortunately, there's a couple of things we can do to make it easier and more comfortable for people that have never contributed to any open source project before, to contribute to our projects.
|
||||
|
||||
## Add a Code of Conduct, and enforce it
|
||||
|
||||
This might seem like one of the easiest steps to do, but it actually requires a lot of dedication to pull through with. Basically, a Code of Conduct is a document detailing what is and what isn't acceptable behavior in your project. A good Code of Conduct also details enforcement procedures, that means how the person violating the Code of Conduct gets dealt with. This is the point at which I've seen a looooot of projects fail. It's easy enough to copy-paste a Code of Conduct into your project, but it's more important to be clear on how to enforce it. Inconsistent —or worse, nonexistent— enforcement is just going to scare off newcomers even more!
|
||||
|
||||
The most widely adopted Code of Conduct is the [Contributor Covenant](https://www.contributor-covenant.org/). It's a very good catch-all document, but it is a bit light in the enforcement section, so I'd recommend to flesh it out by yourself, be it by means of adding contact information or expanding the enforcement rules.
|
||||
|
||||
No matter which Code of Conduct you pick, the most important thing is to actually _read it for yourself_. The worst thing in open source is a maintainer that doesn't know when they've violated their own Code of Conduct.
|
||||
|
||||
## Document your contributing workflow
|
||||
|
||||
The problem that puts people off the most is incomplete or missing documentation, as revealed through GitHub's [open source survey](http://opensourcesurvey.org/2017). A very popular myth in programming is that good code explains itself, which might be true, but only for the person writing it. It's important, especially once you put your project out there for the world to see, to document not only your code, but also the process by which you maintain it. Otherwise, it's going to be extremely hard for newcomers to even figure out where to begin contributing to your project.
|
||||
|
||||
Jekyll has [an entire section of its docs](/docs/contributing) dedicated to information on how to contribute for this very reason. Every documentation page has a link to directly edit and improve it on GitHub. It's also important to realize that not all contributions are code. It can be documentation, it can be reviewing pull requests, but it can also just be weighing into issues, and all of this should be recognized in the same way. At Jekyll, out of 397 total merged pull requests in the last year, __204__ were documentation pull requests!
|
||||
|
||||
## Create newcomer-friendly issues
|
||||
|
||||
For most people new to open source, the biggest hurdle is creating their first pull request. That's why initiatives such as [YourFirstPR](https://twitter.com/yourfirstpr) and [First Timers Only](http://www.firsttimersonly.com/) were started. Recently, [a GitHub bot that automatically creates first-timer friendly issues](https://github.com/hoodiehq/first-timers-bot) was launched, which makes it very easy for maintainers to convert otherwise small or trivial changes into viable pull requests that can be taken on by newcomers! So we decided to give it a shot, and we've created a couple of very easy `first timers only` issues:
|
||||
|
||||
- [Issue #6437](https://github.com/jekyll/jekyll/issues/6437)
|
||||
- [Issue #6438](https://github.com/jekyll/jekyll/issues/6438)
|
||||
- [Issue #6439](https://github.com/jekyll/jekyll/issues/6439)
|
||||
|
||||
(There's also an up-to-date listing of all of our `first timers only` issues [here](https://github.com/jekyll/jekyll/issues?q=is%3Aissue+is%3Aopen+label%3Afirst-time-only))
|
||||
|
||||
These issues are designed to be taken on only by someone who has had little to no exposure to contributing to open source before, and additionally, project maintainers offer support in case a question arises.
|
||||
|
||||
Jekyll is a very big and popular open source project, and we hope that with these special issues, we can help people who haven't contributed to open source before to catch a footing in these unsteady waters.
|
||||
|
||||
## Be nice
|
||||
|
||||
I know this is a cliche and a overused phrase, but really, it works if you pull through with it. Come to terms with the fact that some people aren't as fast or reliable as you might want to think. Don't get angry when a contributor takes a day longer than you might like them to. Treat new contributors to your project with respect, but also with hospitality. Think twice before you send that comment with slurs in it.
|
||||
|
||||
I've been contributing to open source for about 4 years now, and I've had my fair share of horrible, horrible experiences. But Jekyll has historically been a project that has always valued the people contributing to it over the code itself, and I hope we can keep it that way. I also hope that other project maintainers read this and take inspiration from this post. Every project should be more diverse.
|
||||
42
docs/_posts/2017-10-21-jekyll-3-6-2-released.markdown
Normal file
42
docs/_posts/2017-10-21-jekyll-3-6-2-released.markdown
Normal file
@@ -0,0 +1,42 @@
|
||||
---
|
||||
title: 'Jekyll 3.6.2 Released'
|
||||
date: 2017-10-21 21:31:40 +0200
|
||||
author: dirtyf
|
||||
version: 3.6.2
|
||||
categories: [release]
|
||||
---
|
||||
|
||||
3.6.2 is out, it's a tiny patch release and we invite you to run `bundle update`
|
||||
if you want to avoid possible build problems with:
|
||||
|
||||
* some UTF-8 and UTF-16 encoded files,
|
||||
* fully numeric layout names (we convert those to string for you now).
|
||||
|
||||
Other changes include updates to our documentation, like this [complete
|
||||
video series by Giraffe Academy](../tutorials/video-walkthroughs/) aimed at
|
||||
complete beginners. A big thanks to Mike for this.
|
||||
|
||||
And if you're wondering what happened to version 3.6.1, it was just our new
|
||||
release maintainer getting familiar with the release process. 😄
|
||||
|
||||
We try to release patch releases as quickly as possible and we're already
|
||||
working on the next minor version 3.7.0 that will allow you to store all your
|
||||
collections in a single directory. Stay tuned.
|
||||
|
||||
Theme developers are invited to test the brand new
|
||||
[`jekyll-remote-theme`](https://github.com/benbalter/jekyll-remote-theme) plugin
|
||||
and give their feedback to @benbalter. This plugin allows you to use any
|
||||
GitHub hosted theme as a remote theme!
|
||||
|
||||
Once again, many thanks to our contributors who helped make this release possible:
|
||||
ashmaroli, bellvat, Frank Taillandier, i-give-up, Jan Piotrowski, Maximiliano
|
||||
Kotvinsky, Oliver Steele and Pat Hawks. For some it was their [first
|
||||
contribution to open-source]({% link
|
||||
_posts/2017-10-19-diversity-open-source.markdown %}) 👏
|
||||
|
||||
As it's been nine years this week that Tom Preston-Werner started this project,
|
||||
I also wanna seize this opportunity to thank [all of the 732 contributors](https://github.com/jekyll/jekyll/graphs/contributors) who
|
||||
helped make it possible for Jekyll to power millions of websites around the world
|
||||
today.
|
||||
|
||||
Happy Birthday Jekyll! 🎂
|
||||
37
docs/_posts/2018-01-02-jekyll-3-7-0-released.md
Normal file
37
docs/_posts/2018-01-02-jekyll-3-7-0-released.md
Normal file
@@ -0,0 +1,37 @@
|
||||
---
|
||||
title: "Jekyll 3.7.0 Released"
|
||||
description: "Jekyll 3.7.0 brings LiveReload, a directory for your collections and much more…"
|
||||
date: 2018-01-02 11:21:40 +0100
|
||||
author: DirtyF
|
||||
version: 3.7.0
|
||||
categories: [release]
|
||||
---
|
||||
|
||||
We're happy to release a new minor for the new year.
|
||||
Here are a few of the latest additions from our contributors:
|
||||
|
||||
* LiveReload is available as an option during development: with `jekyll serve --livereload` no more manual page refresh. A big thanks to @awood for this feature and to @andreyvit, LiveReload author.
|
||||
* New `collections_dir` configuration option allows you to store all your [collections](/docs/collections) in a single folder. Your source root folder should now look cleaner :sparkles: .
|
||||
* If you're using a [gem-based theme](/docs/themes/) in coordination with the `--incremental` option, you should notice some significant speed during the regeneration process, we did see build time went down **from 12s to 2s** with @mmistakes [minimal-mistakes theme](https://github.com/mmistakes/minimal-mistakes) during our tests.
|
||||
* Jekyll will now check to determine whether host machine has internet connection.
|
||||
* A new `latin` option is available to better [handle URLs slugs](/docs/templates/#options-for-the-slugify-filter).
|
||||
* And of course many bug fixes and updates to our documentation — which you can now search thanks to our friends @Algolia.
|
||||
* [Full history is here](/docs/history/#v3-7-0).
|
||||
|
||||
This release wouldn't have been possible without all the following people:
|
||||
|
||||
Aaron Borden, Alex Tsui, Alex Wood, Alexey Pelykh, Andrew Dassonville, Angelika Tyborska, Ankit Singhaniya, Ashwin Maroli, bellvat, Brandon Dusseau, Chris Finazzo, Doug Beney, Dr. Wolfram Schroers, Edward Shen, Florian Thomas, Frank Taillandier, Gert-jan Theunissen, Goulven Champenois, János Rusiczki, Jed Fox, Johannes Müller, Jon Anning, Jonathan Hooper, Jordon Bedwell, Junko Suzuki, Kacper Duras, Kenton Hansen, Kewin Dousse, Matt Rogers, Maximiliano Kotvinsky, mrHoliday, Olivia, Parker Moore, Pat Hawks, Sebastian Kulig, Vishesh Ruparelia, Xiaoiver and Yashu Mittal.
|
||||
|
||||
A big thanks to everyone!
|
||||
|
||||
Oh, one last thing…
|
||||
|
||||
### :pray: upgrade your Ruby
|
||||
|
||||
Prepare for the next major update, as next major version Jekyll 4.0 will drop support for Ruby 2.1 and 2.2.
|
||||
|
||||
> Ruby 2.2 is now under the state of the security maintenance phase, until the end of the March of 2018. After the date, maintenance of Ruby 2.2 will be ended. We recommend you start planning migration to newer versions of Ruby, such as 2.4 or 2.3. — [Ruby Core Team](https://www.ruby-lang.org/en/news/2017/12/14/ruby-2-2-9-released/)
|
||||
|
||||
We strongly encourage you to upgrade to at least Ruby 2.4.x [like our friends at GitHub Pages](https://pages.github.com/versions/) or even go with [Ruby 2.5](https://www.ruby-lang.org/en/news/2017/12/25/ruby-2-5-0-released/).
|
||||
|
||||
Happy new year to all from the Jekyll team!
|
||||
67
docs/_posts/2018-01-25-jekyll-3-7-2-released.md
Normal file
67
docs/_posts/2018-01-25-jekyll-3-7-2-released.md
Normal file
@@ -0,0 +1,67 @@
|
||||
---
|
||||
title: "Jekyll 3.7.2 Released"
|
||||
date: 2018-01-25 22:22:22 +0530
|
||||
author: ashmaroli
|
||||
version: 3.7.2
|
||||
categories: [release]
|
||||
---
|
||||
|
||||
Close on the heels of shipping 3.7.0, we were informed of a couple of
|
||||
regressions due to the changes made in that release. In due time, Team Jekyll
|
||||
set out to address those issues as early as possible.
|
||||
|
||||
Days later here we're, announcing 3.7.2 (sorry for skipping 3.7.1,
|
||||
RubyGems didn't want to play nice) that fixes numerous issues! :tada:
|
||||
The highlights being:
|
||||
|
||||
* A major regression in 3.7.0 was that when a Front Matter Default was
|
||||
configured with a `scope["path"]` set to a directory, Jekyll would scan
|
||||
that directory for any subfolders and files, for each document in that
|
||||
`path`.
|
||||
Though this is intended, it increases build times in proportion to the size
|
||||
of the directory.
|
||||
|
||||
We addressed this by having Jekyll scan the directory path only if the user
|
||||
explicitly configures the `scope["path"]` using wildcards.
|
||||
|
||||
Read our [documentation](/docs/configuration/#glob-patterns-in-front-matter-defaults)
|
||||
for more details.
|
||||
|
||||
A huge shout-out to @mmistakes for bringing this to our notice and
|
||||
additionally providing us with a test repository to aid in resolving the issue.
|
||||
|
||||
* Another regression reported was related to our "Custom collections
|
||||
directory" feature introduced in 3.7.0.
|
||||
|
||||
Users setting `collection_dir` to a certain directory would have *altered*
|
||||
paths to their posts still at the root of their site's source. This
|
||||
roughly translated to 404 errors on URLs to their posts.
|
||||
|
||||
Props to @localheinz for bringing this regression to our notice.
|
||||
|
||||
We decided to resolve this by having Jekyll ignore posts and drafts at the
|
||||
root of the site's source directory if the user customizes the
|
||||
`collection_dir` setting.
|
||||
|
||||
Ergo, if you set a custom location for your collections, please ensure you
|
||||
move all of your collections into that directory. **This includes posts and
|
||||
drafts as well**. Your links generated by
|
||||
`{% raw %}{% post_url %}{% endraw %}` or `{% raw %}{% link %}{% endraw %}`
|
||||
will adapt automatically.
|
||||
|
||||
* We also found out that `gem "wdm"` boosts performance while directories are
|
||||
being watched on Windows. So we recommend having it included in your Gemfile
|
||||
for a better development experience on Windows. (Newly generated Gemfiles
|
||||
will hereafter have that gem listed automatically :wink:)
|
||||
|
||||
In addition to the above, numerous other minor fixes and documentation updates
|
||||
have been made that should improve your Jekyll experience. All of which, would
|
||||
not have been possible without our wonderful contributors:
|
||||
|
||||
Alexandr, Andreas Möller, Ashwin Maroli, Chayoung You, Florian Thomas,
|
||||
Frank Taillandier, Hendrik Schneider, Kacper Duras, Olivia, Parker Moore and
|
||||
Paul Robert Lloyd.
|
||||
|
||||
As always, you can see our full changelog on [the History page](/docs/history/).
|
||||
|
||||
Happy Jekylling! :sparkles:
|
||||
@@ -0,0 +1,43 @@
|
||||
---
|
||||
layout: news_item
|
||||
title: "Meet Jekyll's New Lead Developer"
|
||||
date: "2018-02-19 20:48:09 -0500"
|
||||
author: parkr
|
||||
categories: [team]
|
||||
---
|
||||
|
||||
Jekyll has a new Lead Developer: [Olivia](https://liv.cat/)!
|
||||
|
||||
After over 5 years of leading Jekyll, many releases from 0.12.1 to 3.6.0, and
|
||||
countless conversations in GitHub Issues, Pull Requests, Jekyll Talk, and
|
||||
more, I am passing on the torch as Lead Developer of Jekyll.
|
||||
|
||||
Olivia has been working with the Jekyll community for some time now. You
|
||||
may have seen her around in issues and pull requests on the various Jekyll
|
||||
repositories. She started as a contributor, then joined the Core team as our
|
||||
community lead. Olivia joined the Jekyll Core Team with experience in the
|
||||
Node.js community, both online and as a volunteer organizer with JSConf EU.
|
||||
|
||||
In my conversations with Olivia, it is clear that Jekyll's vision of
|
||||
simplicity for the user ([no magic!](/philosophy#1-no-magic)) and letting
|
||||
users' [content be king](/philosophy#3-content-is-king) will remain a top
|
||||
priority. In just the last few weeks as the transition has been occurring,
|
||||
we have seen some incredible work on performance that will make future
|
||||
versions of Jekyll work better at scale. She will be prioritizing work on
|
||||
innovative improvements to make Jekyll that much better for all of us.
|
||||
Olivia balances an eye for quality with the need for shipping well.
|
||||
|
||||
When Tom Preston-Werner met me at GitHub HQ 2.0 in January 2013 to pass on
|
||||
the torch, I could never have dreamed of all the amazing experiences this
|
||||
community would share with me over the next 5 years. From visiting @qrush
|
||||
in Buffalo, NY for a hack night on Jekyll to attending a Jekyll planning
|
||||
session hosted by @benbalter at GitHub to Google Summer of Code which gave
|
||||
us jekyll-admin, I am eternally grateful to all of you for the opportunity
|
||||
to lead this excellent community. I'm confident Olivia will continue to
|
||||
lead Jekyll to even greater heights.
|
||||
|
||||
As always, Happy Jekylling!
|
||||
|
||||
Parker
|
||||
|
||||
*Curious about who else runs this show? [Check out our excellent team.](/team/)*
|
||||
19
docs/_posts/2018-02-25-jekyll-3-7-3-released.markdown
Normal file
19
docs/_posts/2018-02-25-jekyll-3-7-3-released.markdown
Normal file
@@ -0,0 +1,19 @@
|
||||
---
|
||||
title: 'Jekyll 3.7.3 Released'
|
||||
date: 2018-02-25 13:02:08 +0530
|
||||
author: ashmaroli
|
||||
version: 3.7.3
|
||||
categories: [release]
|
||||
---
|
||||
|
||||
Hello Jekyllers!! :wave:
|
||||
|
||||
We're pleased to announce the release of `v3.7.3` which fixes a bug one might encounter while using `Jekyll - 3.7.x` along with a
|
||||
Jekyll plugin that in turn uses the `I18n` library.
|
||||
|
||||
When [v3.7.0]({% link _posts/2018-01-02-jekyll-3-7-0-released.md %}) enhanced our `slugify` filter with a `latin` option, we also
|
||||
hardcoded a default fallback locale for the `I18n` library to avoid an exception raised in the event the library fails to find
|
||||
any locale. This led to issues with third-party i18n plugins for Jekyll, especially since the default locale got assigned before
|
||||
the plugin was loaded, irrespective of whether the `slugify` filter was used.
|
||||
|
||||
Jekyll will henceforth set the default locale if and only if necessary.
|
||||
28
docs/_posts/2018-03-14-development-update.md
Normal file
28
docs/_posts/2018-03-14-development-update.md
Normal file
@@ -0,0 +1,28 @@
|
||||
---
|
||||
title: "Jekyll 4.0 is on the Horizon!"
|
||||
date: "2018-04-19 16:07:00 +0100"
|
||||
author: oe
|
||||
categories: [community]
|
||||
---
|
||||
|
||||
With the release of Jekyll 3.8.0, it's been 2 and a half years since the last major release. Jekyll 3.0.0 was released in late October of 2015! That's a long time ago, and we've been working towards the next major release of Jekyll for a couple of months now. Here's a small preview of what's to come:
|
||||
|
||||
- Dropping support for Ruby 2.1 and 2.2. Both versions have reached their EOL period.
|
||||
- Dropping Pygments as a dependency. We're already defaulting to Rouge, and this removes the implicit Python dependency. (finally!)
|
||||
- Making the `link` tag use relative URLs. This is a big breaking change, but it's the cleaner solution.
|
||||
|
||||
We're open to more ideas, though. If the development cost isn't too high, or if someone volunteers to take care of the implementation, it's likely that your suggestion might make it into Jekyll 4.0. Head over to this [issue] for more details. Some interesting topics might be improving Internationalization support in Jekyll, creating convenience Liquid tags, et cetera.
|
||||
|
||||
That being said, the development period of version 4.0 begins _now_. This means a couple of things:
|
||||
|
||||
- New features will only be implemented in Jekyll 4.0. There will be no 3.9.0 or the like.
|
||||
- Same with bug fixes, unless they concern something introduced in Jekyll 3.7 or 3.8, in which case we will backport the fixes and release a patch version.
|
||||
- Now is a great time to finally take on the feature you've wanted to see in Jekyll for ages! Just open an issue or experiment with the code to get going!
|
||||
|
||||
As for a release date, we're currently aiming for late summer, around September or so. However, keep in mind that this project is purely volunteer-run, and as such, delays might occur and we might not hit that release date.
|
||||
|
||||
Finally, this is a great time for newcomers to open-source to make their first contribution. We'll be doing our best to mark recommended contributions and create newcomer-friendly issues, as well as to provide mentoring throughout the contribution process (although we'd like to think that we're already pretty proficient at that). So if you've always been hestitant about contributing to a large open-source project, Jekyll is a good place to start!
|
||||
|
||||
Happy Jekylling! :wave:
|
||||
|
||||
[issue]: https://github.com/jekyll/jekyll/issues/6948
|
||||
43
docs/_posts/2018-03-15-jekyll-3-8-0-released.markdown
Normal file
43
docs/_posts/2018-03-15-jekyll-3-8-0-released.markdown
Normal file
@@ -0,0 +1,43 @@
|
||||
---
|
||||
title: 'Jekyll 3.8.0 Released'
|
||||
date: 2018-04-19 19:45:15 +0530
|
||||
author: ashmaroli
|
||||
version: 3.8.0
|
||||
categories: [release]
|
||||
---
|
||||
|
||||
Aloha Jekyllers!! :wave:
|
||||
|
||||
After months of toiling on the codebase and shipping a couple of release-candidates, the Jekyll Team is delighted to finally
|
||||
present `v3.8.0`, packed with optimizations, improvements, some new features and a couple of bug-fixes. Yay!!!
|
||||
|
||||
Under the hood, Jekyll has undergone many minor changes that will allow it to run more performantly in the coming years. :smiley:
|
||||
Rest assured, our users should see minor improvements in their site's build times.
|
||||
|
||||
Speaking of improvements, users running a site containing a huge amount of posts or those who like to use our `where` filter
|
||||
frequently in a single template, are going to see a massive reduction in their total build times!! :tada:
|
||||
|
||||
Hold on, this version is not just about optimizations, there are some new features as well..:
|
||||
* Detect non-existent variables and filters specified in a template by enabling `strict_variables` and `strict_filters` under the
|
||||
`liquid` key in your config file.
|
||||
* Allow *date filters* to output ordinal days.
|
||||
* `jekyll doctor` now warns you if you have opted for custom `collections_dir` but placed `_posts` directory outside that
|
||||
directory.
|
||||
|
||||
..and yes, a couple of bug-fixes, notably:
|
||||
* Jekyll now handles future-dated documents properly.
|
||||
* Jekyll is able to handle Liquid blocks intelligently in excerpts.
|
||||
* A few methods that were *not meant to be publically accessible* have been entombed properly.
|
||||
* A few bugs that still plagued our `collections_dir` feature from `v3.7` got crushed.
|
||||
|
||||
As always, the full list of changes since last release can be viewed [here](/docs/history/#v3-8-0).
|
||||
|
||||
A big thanks to the following people who contributed to our repository with pull-requests that improved our codebase, documentation
|
||||
and tests:
|
||||
|
||||
Ana María Martínez Gómez, Antonio Argote, Ashwin Maroli, Awjin Ahn, Ben Balter, Benjamin Høegh, Christian Oliff, Damien Solodow,
|
||||
David Zhang, Delson Lima, Eric Cornelissen, Florian Thomas, Frank Taillandier, Heinrich Hartmann, Jakob Vad Nielsen, John Eismeier,
|
||||
Kacper Duras, KajMagnus, Mario Cekic, Max Vilimpoc, Michael H, Mike Kasberg, Parker Moore, Pat Hawks, Paweł Kuna, Robert Riemann,
|
||||
Roger Rohrbach, Semen Zhydenko, Stefan Dellmuth, Tim Carry, olivia, and steelman.
|
||||
|
||||
Happy Jekylling!! :sparkles:
|
||||
20
docs/_posts/2018-05-01-jekyll-3-8-1-released.markdown
Normal file
20
docs/_posts/2018-05-01-jekyll-3-8-1-released.markdown
Normal file
@@ -0,0 +1,20 @@
|
||||
---
|
||||
title: 'Jekyll 3.8.1 Released'
|
||||
date: 2018-05-01 11:56:01 -0500
|
||||
author: pathawks
|
||||
version: 3.8.1
|
||||
categories: [release]
|
||||
---
|
||||
|
||||
Happy May Day :tada:
|
||||
|
||||
The Jekyll team is happy to announce the release of `v3.8.1`, which fixes
|
||||
a couple of bugs that were introduced two weeks ago in `v3.8.0`. If you have
|
||||
experienced trouble regarding post excerpts or non-published posts, this release
|
||||
should be the remedy. Thanks to @Chaosed0 and @domLocalHeroes for originally
|
||||
reporting these issues, and to @ashmaroli for fixing them so quickly.
|
||||
|
||||
As a reminder, we have started work on Jekyll 4.0. If there are any
|
||||
features that you would love to see added to Jekyll, or any pain points you
|
||||
would like to see removed, please do add your ideas to the [Jekyll 4.0 idea
|
||||
list](https://github.com/jekyll/jekyll/issues/6948).
|
||||
60
docs/_sass/_docsearch.scss
Normal file
60
docs/_sass/_docsearch.scss
Normal file
@@ -0,0 +1,60 @@
|
||||
.searchbox {
|
||||
padding-top: 1px;
|
||||
.searchbox__input {
|
||||
padding: 6px 5px 5px 29px;
|
||||
font-size: 0.75em;
|
||||
border: none;
|
||||
border-radius: 5px;
|
||||
color: #555;
|
||||
background-color: #333 !important;
|
||||
box-shadow: 0 0 1px 0 #555;
|
||||
|
||||
&::-webkit-input-placeholder {
|
||||
color: #aaa;
|
||||
}
|
||||
&:-ms-input-placeholder {
|
||||
color: #aaa;
|
||||
}
|
||||
&::placeholder {
|
||||
color: #aaa;
|
||||
}
|
||||
|
||||
&:focus, &:active {
|
||||
color: #eaeaea;
|
||||
background-color: #252525 !important;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
.searchbox__submit svg { fill: #fc0 }
|
||||
.searchbox__reset svg { fill: #999 }
|
||||
|
||||
.algolia-autocomplete {
|
||||
.ds-dropdown-menu {
|
||||
font-size: 1rem;
|
||||
text-shadow: none;
|
||||
|
||||
.ds-suggestion.ds-cursor .algolia-docsearch-suggestion:not(.suggestion-layout-simple) .algolia-docsearch-suggestion--content {
|
||||
background-color: rgba(221, 221, 221, 0.5);
|
||||
}
|
||||
}
|
||||
|
||||
.algolia-docsearch-suggestion--category-header {
|
||||
background-color: #444;
|
||||
color: #ddd;
|
||||
padding: 0.35em;
|
||||
}
|
||||
|
||||
.algolia-docsearch-suggestion--subcategory-column {
|
||||
color: #444;
|
||||
}
|
||||
|
||||
.algolia-docsearch-suggestion--highlight {
|
||||
background-color: #fc0;
|
||||
color: #222;
|
||||
}
|
||||
|
||||
.algolia-docsearch-suggestion--text .algolia-docsearch-suggestion--highlight {
|
||||
box-shadow: inset 0 -2px 0 0 #fc0;
|
||||
}
|
||||
}
|
||||
@@ -1,4 +1,4 @@
|
||||
/*! normalize.css v6.0.0 | MIT License | github.com/necolas/normalize.css */
|
||||
/*! normalize.css v7.0.0 | MIT License | github.com/necolas/normalize.css */
|
||||
|
||||
/* Document
|
||||
========================================================================== */
|
||||
@@ -18,6 +18,14 @@ html {
|
||||
/* Sections
|
||||
========================================================================== */
|
||||
|
||||
/**
|
||||
* Remove the margin in all browsers (opinionated).
|
||||
*/
|
||||
|
||||
body {
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
/**
|
||||
* Add the correct display in IE 9-.
|
||||
*/
|
||||
@@ -225,7 +233,8 @@ svg:not(:root) {
|
||||
========================================================================== */
|
||||
|
||||
/**
|
||||
* Remove the margin in Firefox and Safari.
|
||||
* 1. Change the font styles in all browsers (opinionated).
|
||||
* 2. Remove the margin in Firefox and Safari.
|
||||
*/
|
||||
|
||||
button,
|
||||
@@ -233,7 +242,10 @@ input,
|
||||
optgroup,
|
||||
select,
|
||||
textarea {
|
||||
margin: 0;
|
||||
font-family: sans-serif; /* 1 */
|
||||
font-size: 100%; /* 1 */
|
||||
line-height: 1.15; /* 1 */
|
||||
margin: 0; /* 2 */
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -292,6 +304,14 @@ button:-moz-focusring,
|
||||
outline: 1px dotted ButtonText;
|
||||
}
|
||||
|
||||
/**
|
||||
* Correct the padding in Firefox.
|
||||
*/
|
||||
|
||||
fieldset {
|
||||
padding: 0.35em 0.75em 0.625em;
|
||||
}
|
||||
|
||||
/**
|
||||
* 1. Correct the text wrapping in Edge and IE.
|
||||
* 2. Correct the color inheritance from `fieldset` elements in IE.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
.highlight {
|
||||
.hll { background-color: #ffffcc }
|
||||
.c { color: #87ceeb} /* Comment */
|
||||
.c { color: #999; font-style: italic } /* Comment */
|
||||
.err { color: #ffffff} /* Error */
|
||||
.g { color: #ffffff} /* Generic */
|
||||
.k { color: #f0e68c} /* Keyword */
|
||||
@@ -8,16 +8,16 @@
|
||||
.n { color: #ffffff} /* Name */
|
||||
.o { color: #ffffff} /* Operator */
|
||||
.x { color: #ffffff} /* Other */
|
||||
.p { color: #ffffff} /* Punctuation */
|
||||
.p { color: #98b9ef} /* Punctuation */
|
||||
.cm { color: #87ceeb} /* Comment.Multiline */
|
||||
.cp { color: #cd5c5c} /* Comment.Preproc */
|
||||
.c1 { color: #87ceeb} /* Comment.Single */
|
||||
.cs { color: #87ceeb} /* Comment.Special */
|
||||
.gd { color: #0000c0; font-weight: bold; background-color: #008080 } /* Generic.Deleted */
|
||||
.gd { color: #ce342c} /* Generic.Deleted */
|
||||
.ge { color: #c000c0; text-decoration: underline} /* Generic.Emph */
|
||||
.gr { color: #c0c0c0; font-weight: bold; background-color: #c00000 } /* Generic.Error */
|
||||
.gh { color: #cd5c5c} /* Generic.Heading */
|
||||
.gi { color: #ffffff; background-color: #0000c0 } /* Generic.Inserted */
|
||||
.gi { color: #27b42c} /* Generic.Inserted */
|
||||
span.go { color: #add8e6; font-weight: bold; background-color: #4d4d4d } /* Generic.Output, qualified with span to prevent applying this style to the Go language, see #1153. */
|
||||
.gp { color: #ffffff} /* Generic.Prompt */
|
||||
.gs { color: #ffffff} /* Generic.Strong */
|
||||
@@ -45,7 +45,7 @@
|
||||
.nx { color: #ffffff} /* Name.Other */
|
||||
.py { color: #ffffff} /* Name.Property */
|
||||
.nt { color: #f0e68c} /* Name.Tag */
|
||||
.nv { color: #98fb98} /* Name.Variable */
|
||||
.nv { color: #88d472} /* Name.Variable */
|
||||
.ow { color: #ffffff} /* Operator.Word */
|
||||
.w { color: #ffffff} /* Text.Whitespace */
|
||||
.mf { color: #ffffff} /* Literal.Number.Float */
|
||||
@@ -69,10 +69,6 @@
|
||||
.vi { color: #98fb98} /* Name.Variable.Instance */
|
||||
.il { color: #ffffff} /* Literal.Number.Integer.Long */
|
||||
.bash .nv {
|
||||
-webkit-user-select: none;
|
||||
-moz-user-select: none;
|
||||
-ms-user-select: none;
|
||||
-o-user-select: none;
|
||||
user-select: none;
|
||||
user-select: none;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -14,7 +14,6 @@ body {
|
||||
font: 300 21px Lato, 'Helvetica Neue', Helvetica, Arial, sans-serif;
|
||||
color: #ddd;
|
||||
background-color: #333;
|
||||
border-top: 5px solid #fc0;
|
||||
@include box-shadow(inset 0 3px 30px rgba(0,0,0,.3));
|
||||
text-shadow: 0 1px 3px rgba(0,0,0,.5);
|
||||
-webkit-font-feature-settings: "kern" 1;
|
||||
@@ -50,33 +49,53 @@ footer {
|
||||
/* Header */
|
||||
|
||||
header {
|
||||
padding: 15px;
|
||||
background: darken(#333, 3%);
|
||||
|
||||
h1,
|
||||
nav { display: inline-block; }
|
||||
|
||||
.flexbox {
|
||||
display: flex;
|
||||
height: 50px;
|
||||
|
||||
& > * { margin: auto }
|
||||
}
|
||||
|
||||
.logo {
|
||||
display: block;
|
||||
img { margin-top: -7px }
|
||||
}
|
||||
|
||||
.search .svg-icons { display: none }
|
||||
}
|
||||
|
||||
nav {
|
||||
nav, .meta {
|
||||
|
||||
ul {
|
||||
padding: 0;
|
||||
margin: 0;
|
||||
white-space: nowrap;
|
||||
display: inline-block;
|
||||
}
|
||||
|
||||
li { display: inline-block; }
|
||||
}
|
||||
|
||||
.main-nav {
|
||||
margin-top: 52px;
|
||||
.meta ul {
|
||||
margin-left: 10px;
|
||||
|
||||
li { vertical-align: middle; }
|
||||
}
|
||||
|
||||
.main-nav, .meta {
|
||||
|
||||
li {
|
||||
margin-right: 10px;
|
||||
|
||||
a {
|
||||
@include border-radius(5px);
|
||||
font-weight: 900;
|
||||
font-size: 14px;
|
||||
font-size: 0.75em;
|
||||
padding: 0.5em 1em;
|
||||
text-shadow: none;
|
||||
text-transform: uppercase;
|
||||
@@ -100,7 +119,6 @@ nav {
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
.mobile-nav {
|
||||
padding: 0 5px;
|
||||
|
||||
@@ -117,9 +135,9 @@ nav {
|
||||
color: #fc0;
|
||||
text-align: center;
|
||||
text-transform: uppercase;
|
||||
font-size: 14px;
|
||||
font-size: 0.625em;
|
||||
font-weight: 900;
|
||||
padding: 5px;
|
||||
padding: 10px 5px;
|
||||
@include border-radius(5px);
|
||||
}
|
||||
|
||||
@@ -159,17 +177,27 @@ h6:hover .header-link {
|
||||
opacity: 1;
|
||||
}
|
||||
|
||||
@media (max-width: 768px) {
|
||||
.main-nav ul {
|
||||
text-align: right;
|
||||
@media (max-width: 580px) {
|
||||
header {
|
||||
.flexbox { height: auto }
|
||||
.logo img { margin-top: 0 }
|
||||
}
|
||||
}
|
||||
@media (max-width: 699px) {
|
||||
.searchbox { display: none }
|
||||
}
|
||||
@media (max-width: 768px) {
|
||||
.main-nav ul { text-align: right }
|
||||
}
|
||||
@media (max-width: 830px) {
|
||||
.main-nav {
|
||||
.show-on-mobiles { display: inline; }
|
||||
.hide-on-mobiles { display: none; }
|
||||
}
|
||||
}
|
||||
@media (max-width: 890px) {
|
||||
.meta { display: none; }
|
||||
}
|
||||
|
||||
/* Footer */
|
||||
|
||||
@@ -547,8 +575,22 @@ aside {
|
||||
}
|
||||
|
||||
.docs-nav-mobile select {
|
||||
color: #000;
|
||||
padding: 5px;
|
||||
width: 100%;
|
||||
font-size: 0.85em;
|
||||
color: #000;
|
||||
background: #ddd;
|
||||
border-color: transparent;
|
||||
@include border-radius(5px);
|
||||
|
||||
&:focus {
|
||||
outline: none;
|
||||
}
|
||||
|
||||
option {
|
||||
font-size: 0.9em;
|
||||
padding: 3px;
|
||||
}
|
||||
}
|
||||
|
||||
/* News */
|
||||
@@ -682,15 +724,15 @@ h5 > code,
|
||||
|
||||
.highlight {
|
||||
margin: 1em 0;
|
||||
padding: 10px 0;
|
||||
width: 100%;
|
||||
overflow: auto;
|
||||
}
|
||||
|
||||
pre.highlight { padding: 10px 0.5em; }
|
||||
|
||||
.highlighter-rouge .highlight {
|
||||
@extend .highlight;
|
||||
margin: 0;
|
||||
padding: 10px 0.5em;
|
||||
}
|
||||
|
||||
/* HTML Elements */
|
||||
@@ -813,7 +855,12 @@ tbody td {
|
||||
background-image: linear-gradient(to bottom, rgba(255,255,255,0.1) 0%,rgba(255,255,255,0) 100%);
|
||||
filter: progid:DXImageTransform.Microsoft.gradient( startColorstr='#1affffff', endColorstr='#00ffffff',GradientType=0 );
|
||||
|
||||
p {
|
||||
ul {
|
||||
padding-left: 1em;
|
||||
}
|
||||
|
||||
p,
|
||||
ul {
|
||||
font-size: 16px;
|
||||
|
||||
code { font-size: 14px; }
|
||||
@@ -983,6 +1030,30 @@ code.output {
|
||||
text-shadow: 0 1px 0 rgba(255,255,255,.25);
|
||||
}
|
||||
|
||||
/* Version badge */
|
||||
|
||||
.version-badge {
|
||||
margin-left: .25em;
|
||||
padding: 0.2em;
|
||||
font-size: .75em;
|
||||
font-weight: 400;
|
||||
background-color: #fc0;
|
||||
color: #222;
|
||||
text-shadow: none;
|
||||
vertical-align: middle;
|
||||
border-radius: 3.75px;
|
||||
}
|
||||
|
||||
.note {
|
||||
.version-badge {
|
||||
font-size: 0.9rem;
|
||||
padding: 0.1em 0.2em;
|
||||
background-color: rgba(0,0,0,0.2);
|
||||
color: #fff;
|
||||
box-shadow: inset 0 1px 10px rgba(0,0,0,0.3),0 1px 0 rgba(255,255,255,0.1),0 -1px 0 rgba(0,0,0,0.5);
|
||||
}
|
||||
}
|
||||
|
||||
/* Responsive tables */
|
||||
|
||||
@media (max-width: 768px) {
|
||||
@@ -1053,3 +1124,35 @@ code.output {
|
||||
background: #454545;
|
||||
}
|
||||
}
|
||||
|
||||
.language-sh {
|
||||
position: relative;
|
||||
&:before {
|
||||
display: table;
|
||||
padding: 8px;
|
||||
width: 100%;
|
||||
padding: 5px 0;
|
||||
font: 400 16px/24px 'Helvetica Neue', Helvetica, Arial, sans-serif;
|
||||
color: #444;
|
||||
text-shadow: 0 1px 0 rgba(255,255,255,.5);
|
||||
background-color: #f7f7f7;
|
||||
background-image: url(data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiA/Pgo8c3ZnIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgd2lkdGg9IjEwMCUiIGhlaWdodD0iMTAwJSIgdmlld0JveD0iMCAwIDEgMSIgcHJlc2VydmVBc3BlY3RSYXRpbz0ibm9uZSI+CiAgPGxpbmVhckdyYWRpZW50IGlkPSJncmFkLXVjZ2ctZ2VuZXJhdGVkIiBncmFkaWVudFVuaXRzPSJ1c2VyU3BhY2VPblVzZSIgeDE9IjAlIiB5MT0iMCUiIHgyPSIwJSIgeTI9IjEwMCUiPgogICAgPHN0b3Agb2Zmc2V0PSIwJSIgc3RvcC1jb2xvcj0iI2Y3ZjdmNyIgc3RvcC1vcGFjaXR5PSIxIi8+CiAgICA8c3RvcCBvZmZzZXQ9IjclIiBzdG9wLWNvbG9yPSIjY2ZjZmNmIiBzdG9wLW9wYWNpdHk9IjEiLz4KICAgIDxzdG9wIG9mZnNldD0iMTAwJSIgc3RvcC1jb2xvcj0iI2FhYWFhYSIgc3RvcC1vcGFjaXR5PSIxIi8+CiAgPC9saW5lYXJHcmFkaWVudD4KICA8cmVjdCB4PSIwIiB5PSIwIiB3aWR0aD0iMSIgaGVpZ2h0PSIxIiBmaWxsPSJ1cmwoI2dyYWQtdWNnZy1nZW5lcmF0ZWQpIiAvPgo8L3N2Zz4=);
|
||||
background-image: -webkit-gradient(linear, left top, left bottom, from(#f7f7f7), color-stop(7%, #cfcfcf), to(#aaaaaa));
|
||||
background-image: -webkit-linear-gradient(top, #f7f7f7 0%, #cfcfcf 7%, #aaaaaa 100%);
|
||||
background-image: -moz-linear-gradient(top, #f7f7f7 0%, #cfcfcf 7%, #aaaaaa 100%);
|
||||
background-image: -o-linear-gradient(top, #f7f7f7 0%, #cfcfcf 7%, #aaaaaa 100%);
|
||||
background-image: linear-gradient(top, #f7f7f7 0%,#cfcfcf 7%,#aaaaaa 100%);
|
||||
filter: progid:DXImageTransform.Microsoft.gradient( startColorstr='#f7f7f7', endColorstr='#aaaaaa',GradientType=0 );
|
||||
border-bottom: 1px solid #111;
|
||||
text-align: center;
|
||||
content: "terminal";
|
||||
@include border-radius(5px 5px 0 0);
|
||||
@include box-shadow(0 3px 10px rgba(0,0,0,.5));
|
||||
}
|
||||
.highlight {
|
||||
@include border-radius(0 0 5px 5px);
|
||||
}
|
||||
pre.highlight {
|
||||
background: #1c1c1c;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -306,7 +306,7 @@ At minimum, a layout should contain `{% raw %}{{ content }}{% endraw %}`, which
|
||||
|
||||
### For loops
|
||||
|
||||
By the way, let's pause here to look at the `for` loop logic a little more closely. [For loops in Liquid](https://help.shopify.com/themes/liquid/tags/iteration-tags#for) are one of the most commonly used Liquid tags. *For loops* let you iterate through content in your Jekyll site and build out a result. The `for` loop also has [certain properties available](https://help.shopify.com/themes/liquid/objects/for-loops) (like first or last iteration) based on the loop's position in the loop as well.
|
||||
By the way, let's pause here to look at the `for` loop logic a little more closely. [For loops in Liquid](https://shopify.github.io/liquid/tags/iteration/) are one of the most commonly used Liquid tags. *For loops* let you iterate through content in your Jekyll site and build out a result. The `for` loop also has [certain properties available](https://help.shopify.com/themes/liquid/objects/for-loops) (like first or last iteration) based on the loop's position in the loop as well.
|
||||
|
||||
We've only scratched the surface of what you can do with `for` loops in retrieving posts. For example, if you wanted to display posts from a specific category, you could do so by adding a `categories` property to your post's front matter and then look in those categories. Further, you could limit the number of results by adding a `limit` property. Here's an example:
|
||||
|
||||
|
||||
@@ -15,7 +15,7 @@ Simply add a `404.md` or `404.html` at the root of your site's source directory
|
||||
|
||||
If you plan to organize your files under subdirectories, the error page should have the following Front Matter Data, set: `permalink: /404.html`. This is to ensure that the compiled `404.html` resides at the root of your processed site, where it'll be picked by the server.
|
||||
|
||||
```
|
||||
```markdown
|
||||
---
|
||||
# example 404.md
|
||||
|
||||
@@ -34,33 +34,34 @@ Apache Web Servers load a configuration file named [`.htaccess`](http://www.htac
|
||||
|
||||
Simply add the following to your `.htaccess` file.
|
||||
|
||||
```
|
||||
```apache
|
||||
ErrorDocument 404 /404.html
|
||||
```
|
||||
|
||||
With an `.htaccess` file, you have the freedom to place your error page within a subdirectory.
|
||||
|
||||
```
|
||||
```apache
|
||||
ErrorDocument 404 /error_pages/404.html
|
||||
```
|
||||
|
||||
Where the path is relative to your site's domain.
|
||||
|
||||
More info on configuring Apache Error Pages can found in [official documentation](https://httpd.apache.org/docs/current/mod/core.html#errordocument).
|
||||
More info on configuring Apache Error Pages can found in [official documentation](https://httpd.apache.org/docs/current/mod/core.html#errordocument).
|
||||
|
||||
|
||||
## Hosting on Nginx server
|
||||
|
||||
The procedure is just as simple as configuring Apache servers, but slightly different.
|
||||
|
||||
Add the following to the ngnix configuration file, `nginx.conf`, which is usually located inside `/etc/nginx/` or `/etc/nginx/conf/`:
|
||||
Add the following to the nginx configuration file, `nginx.conf`, which is usually located inside `/etc/nginx/` or `/etc/nginx/conf/`:
|
||||
|
||||
```
|
||||
```nginx
|
||||
server {
|
||||
error_page 404 /404.html;
|
||||
location /404.html {
|
||||
location = /404.html {
|
||||
internal;
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
The `location` directive prevents users from directly browsing the 404.html page.
|
||||
|
||||
@@ -91,28 +91,36 @@ Suppose you wanted to sort the list by the `title`. To do this, convert the refe
|
||||
|
||||
**Liquid**
|
||||
|
||||
{% raw %}
|
||||
```liquid
|
||||
{% raw %}{% assign doclist = site.data.samplelist.docs | sort: 'title' %}
|
||||
{% assign doclist = site.data.samplelist.docs | sort: 'title' %}
|
||||
<ol>
|
||||
{% for item in doclist %}
|
||||
<li><a href="{{ item.url }}" alt="{{ item.title }}">{{ item.title }}</a></li>
|
||||
{% endfor %}{% endraw %}
|
||||
{% endfor %}
|
||||
</ol>
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
**Result**
|
||||
|
||||
<div class="highlight result">
|
||||
<li><a href="#" alt="Configuration">Configuration</a></li>
|
||||
<li><a href="#" alt="Deployment">Deployment</a></li>
|
||||
<li><a href="#" alt="Introduction">Introduction</a></li>
|
||||
<ol>
|
||||
<li><a href="#" alt="Configuration">Configuration</a></li>
|
||||
<li><a href="#" alt="Deployment">Deployment</a></li>
|
||||
<li><a href="#" alt="Introduction">Introduction</a></li>
|
||||
</ol>
|
||||
</div>
|
||||
|
||||
The items now appear in alphabetical order. The `sort` property in the Liquid filter applies to the `title`, which is an actual property in the list. If `title` weren't a property, we would need to sort by another property.
|
||||
|
||||
See the [Liquid array filter](https://help.shopify.com/themes/liquid/filters/array-filters) for more filter options. Note that you can't simply use this syntax:
|
||||
|
||||
{% raw %}
|
||||
```liquid
|
||||
{% raw %}{% for item in site.data.samplelist.docs | sort: "title" %}{% endfor %}{% endraw %}
|
||||
{% for item in site.data.samplelist.docs | sort: "title" %}{% endfor %}
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
You have to convert `site.data.samplelist.docs` to a variable first using either `assign` or `capture` tags.
|
||||
|
||||
@@ -152,16 +160,18 @@ toc:
|
||||
|
||||
**Liquid**
|
||||
|
||||
{% raw %}
|
||||
```liquid
|
||||
{% raw %}{% for item in site.data.samplelist.toc %}
|
||||
{% for item in site.data.samplelist.toc %}
|
||||
<h3>{{ item.title }}</h3>
|
||||
<ul>
|
||||
{% for entry in item.subfolderitems %}
|
||||
<li><a href="{{ entry.url }}">{{ entry.page }}</a></li>
|
||||
{% endfor %}
|
||||
</ul>
|
||||
{% endfor %}{% endraw %}
|
||||
{% endfor %}
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
**Result**
|
||||
<div class="highlight result">
|
||||
@@ -242,15 +252,16 @@ toc2:
|
||||
|
||||
**Liquid**
|
||||
|
||||
{% raw %}
|
||||
```liquid
|
||||
{% raw %}<div>
|
||||
<div>
|
||||
{% if site.data.samplelist.toc2[0] %}
|
||||
{% for item in site.data.samplelist.toc2 %}
|
||||
<h3>{{ item.title }}</h3>
|
||||
{% if item.subfolderitems[0] %}
|
||||
<ul>
|
||||
{% for entry in item.subfolderitems %}
|
||||
<li><a href="{{ entry.url }}">{{ entry.page }}</a></li>
|
||||
<li><a href="{{ entry.url }}">{{ entry.page }}</a>
|
||||
{% if entry.subsubfolderitems[0] %}
|
||||
<ul>
|
||||
{% for subentry in entry.subsubfolderitems %}
|
||||
@@ -258,13 +269,15 @@ toc2:
|
||||
{% endfor %}
|
||||
</ul>
|
||||
{% endif %}
|
||||
</li>
|
||||
{% endfor %}
|
||||
</ul>
|
||||
{% endif %}
|
||||
{% endfor %}
|
||||
{% endif %}
|
||||
</div>{% endraw %}
|
||||
</div>
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
**Result**
|
||||
|
||||
@@ -327,13 +340,16 @@ sidebar: toc
|
||||
|
||||
**Liquid**
|
||||
|
||||
{% raw %}
|
||||
```liquid
|
||||
{% raw %}<ul>
|
||||
<ul>
|
||||
{% for item in site.data.samplelist[page.sidebar] %}
|
||||
<li><a href="{{ item.url }}">{{ item.title }}</a></li>
|
||||
{% endfor %}
|
||||
</ul>{% endraw %}
|
||||
</ul>
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
**Result**
|
||||
|
||||
<div class="highlight result">
|
||||
@@ -361,13 +377,15 @@ In addition to inserting items from the YAML data file into your list, you also
|
||||
```
|
||||
**Liquid**
|
||||
|
||||
{% raw %}
|
||||
```liquid
|
||||
{% raw %}{% for item in site.data.samplelist.docs %}
|
||||
{% for item in site.data.samplelist.docs %}
|
||||
<li class="{% if item.url == page.url %}active{% endif %}">
|
||||
<a href="{{ item.url }}">{{ item.title }}</a>
|
||||
</li>
|
||||
{% endfor %}{% endraw %}
|
||||
{% endfor %}
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
**Result**
|
||||
|
||||
@@ -379,16 +397,18 @@ In addition to inserting items from the YAML data file into your list, you also
|
||||
</style>
|
||||
|
||||
<div class="highlight result">
|
||||
<li class=""><a href="#">Introduction</a></li>
|
||||
<li class=""><a href="#">Configuration</a></li>
|
||||
<li class="active"><a href="#">Deployment</a></li>
|
||||
<ul>
|
||||
<li class=""><a href="#">Introduction</a></li>
|
||||
<li class=""><a href="#">Configuration</a></li>
|
||||
<li class="active"><a href="#">Deployment</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
In this case, assume `Deployment` is the current page.
|
||||
|
||||
To make sure the `item.url` (stored in the YAML file) matches the `page.url`, it can be helpful to print the `{% raw %}{{ page.url }}{% endraw %}` to the page.
|
||||
|
||||
## Scenario 6: Including items conditionally
|
||||
## Scenario 7: Including items conditionally
|
||||
|
||||
You might want to include items conditionally in your list. For example, maybe you have multiple site outputs and only want to include the sidebar item for certain outputs. You can add properties in each list item and then use those properties to conditionally include the content.
|
||||
|
||||
@@ -412,15 +432,17 @@ docs2:
|
||||
|
||||
**Liquid**
|
||||
|
||||
{% raw %}
|
||||
```liquid
|
||||
{% raw %}<ul>
|
||||
<ul>
|
||||
{% for item in site.data.samplelist.docs2 %}
|
||||
{% if item.version == 1 %}
|
||||
<li><a href="{{ item.url }}">{{ item.title }}</a></li>
|
||||
{% endif %}
|
||||
{% endfor %}
|
||||
</ul>{% endraw %}
|
||||
</ul>
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
**Result**
|
||||
|
||||
@@ -433,7 +455,7 @@ docs2:
|
||||
|
||||
The `Deployment` page is excluded because its `version` is `2`.
|
||||
|
||||
## Scenario 7: Retrieving items based on front matter properties
|
||||
## Scenario 8: Retrieving items based on front matter properties
|
||||
|
||||
If you don't want to store your navigation items in a YAML file in your `_data` folder, you can use `for` loops to look through the YAML front matter of each page or collection and get the content based on properties in the front matter.
|
||||
|
||||
@@ -491,16 +513,18 @@ Note that even though `category` is used in the doc front matter, `category` is
|
||||
|
||||
If you wanted to simply get all docs in the collection for a specific category, you could use a `for` loop with an `if` condition to check for a specific category:
|
||||
|
||||
{% raw %}
|
||||
```liquid
|
||||
{% raw %}<h3>Getting Started</h3>
|
||||
<h3>Getting Started</h3>
|
||||
<ul>
|
||||
{% for doc in site.docs %}
|
||||
{% if doc.category == "getting-started" %}
|
||||
<li><a href="{{ doc.url }}">{{ doc.title }}</a></li>
|
||||
{% endif %}
|
||||
{% endfor %}
|
||||
</ul>{% endraw %}
|
||||
</ul>
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
The result would be as follows:
|
||||
|
||||
@@ -523,8 +547,9 @@ Here's the code for getting lists of pages grouped under their corresponding cat
|
||||
|
||||
**Liquid**
|
||||
|
||||
{% raw %}
|
||||
```liquid
|
||||
{% raw %}{% assign mydocs = site.docs | group_by: 'category' %}
|
||||
{% assign mydocs = site.docs | group_by: 'category' %}
|
||||
{% for cat in mydocs %}
|
||||
<h2>{{ cat.name | capitalize }}</h2>
|
||||
<ul>
|
||||
@@ -533,8 +558,9 @@ Here's the code for getting lists of pages grouped under their corresponding cat
|
||||
<li><a href="{{ item.url }}">{{ item.title }}</a></li>
|
||||
{% endfor %}
|
||||
</ul>
|
||||
{% endfor %}{% endraw %}
|
||||
{% endfor %}
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
**Result**
|
||||
|
||||
@@ -574,6 +600,6 @@ After getting the category name, we assign the variable `items` for the docs and
|
||||
|
||||
The `for item in items` loop looks through each `item` and gets the `title` and `url` to form the list item link.
|
||||
|
||||
For more details on the `group_by` filter, see [Jekyll's Templates documentation](https://jekyllrb.com/docs/templates/) as well as [this Siteleaf tutorial](https://www.siteleaf.com/blog/advanced-liquid-group-by/). For more details on the `sort` filter, see [sort](https://help.shopify.com/themes/liquid/filters/array-filters#sort) in Liquid's documentation.
|
||||
For more details on the `group_by` filter, see [Jekyll's Templates documentation](https://jekyllrb.com/docs/templates/) as well as [this Siteleaf tutorial](https://www.siteleaf.com/blog/advanced-liquid-group-by/). For more details on the `sort` filter, see [sort](https://shopify.github.io/liquid/filters/sort/) in Liquid's documentation.
|
||||
|
||||
Whether you use properties in your doc's front matter to retrieve your pages or a YAML data file, in both cases you can programmatically build a more robust navigation for your site.
|
||||
|
||||
@@ -37,15 +37,19 @@ The following scenarios highlight potential problems you might encounter. These
|
||||
|
||||
In your layout file (`_layouts/default.html`), suppose you have a variable assigned:
|
||||
|
||||
{% raw %}
|
||||
```liquid
|
||||
{% assign myvar = "joe" %}
|
||||
```
|
||||
{% raw %}{% assign myvar = "joe" %}{% endraw %}
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
On a page that uses the layout, you reference that variable:
|
||||
|
||||
{% raw %}
|
||||
```liquid
|
||||
{{ myvar }}
|
||||
```
|
||||
{% raw %}{{ myvar }}{% endraw %}
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
The variable won't render because the page's order of interpretation is to render Liquid first and later process the Layout. When the Liquid rendering happens, the variable assignment isn't available.
|
||||
|
||||
@@ -63,9 +67,11 @@ This is a list:
|
||||
|
||||
You include the file into an HTML file as follows:
|
||||
|
||||
{% raw %}
|
||||
```liquid
|
||||
{% raw %}{% include mycontent.md %}{% endraw %}
|
||||
{% include mycontent.md %}
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
The Markdown is not processed because first the Liquid (`include` tag) gets processed, inserting `mycontent.md` into the HTML file. *Then* the Markdown would get processed.
|
||||
|
||||
@@ -75,11 +81,13 @@ To make the code work, use HTML formatting in includes that are inserted into HT
|
||||
|
||||
Note that `highlight` tags don't require Markdown to process. Suppose your include contains the following:
|
||||
|
||||
{% raw %}
|
||||
```liquid
|
||||
{% raw %}{% highlight javascript %}
|
||||
{% highlight javascript %}
|
||||
console.log('alert');
|
||||
{% endhighlight %}{% endraw %}
|
||||
{% endhighlight %}
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
The `highlight` tag *is* Liquid. (Liquid passes the content to Rouge or Pygments for syntax highlighting.) As a result, this code will actually convert to HTML with syntax highlighting. Jekyll does not need the Markdown filter to process `highlight` tags.
|
||||
|
||||
@@ -87,8 +95,9 @@ The `highlight` tag *is* Liquid. (Liquid passes the content to Rouge or Pygments
|
||||
|
||||
Suppose you try to mix Liquid's `assign` tag with JavaScript, like this:
|
||||
|
||||
{% raw %}
|
||||
```javascript
|
||||
{% raw %}<button onclick="someFunction()">Click me</button>
|
||||
<button onclick="someFunction()">Click me</button>
|
||||
|
||||
<p id="intro"></p>
|
||||
|
||||
@@ -97,15 +106,17 @@ Suppose you try to mix Liquid's `assign` tag with JavaScript, like this:
|
||||
function someFunction() {
|
||||
document.getElementById("intro").innerHTML = someContent;
|
||||
}
|
||||
</script>{% endraw %}
|
||||
</script>
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
This won't work because the `assign` tag is only available during the Liquid rendering phase of the site. In this JavaScript example, the script executes when a user clicks a button ("Click me") on the HTML page. At that time, the Liquid logic is no longer available, so the `assign` tag wouldn't return anything.
|
||||
|
||||
However, you can use Jekyll's site variables or Liquid to *populate* a script that is executed at a later time. For example, suppose you have the following property in your front matter: `someContent: "This is some content"`. You could do this:
|
||||
|
||||
{% raw %}
|
||||
```js
|
||||
{% raw %}<button onclick="someFunction()">Click me</button>
|
||||
<button onclick="someFunction()">Click me</button>
|
||||
|
||||
<p id="intro"></p>
|
||||
|
||||
@@ -114,8 +125,9 @@ However, you can use Jekyll's site variables or Liquid to *populate* a script th
|
||||
function someFunction() {
|
||||
document.getElementById("intro").innerHTML = "{{ page.someContent }}";
|
||||
}
|
||||
</script>{% endraw %}
|
||||
</script>
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
When Jekyll builds the site, this `someContent` property populates the script's values, converting `{% raw %}{{ page.someContent }}{% endraw %}` to `"This is some content"`.
|
||||
|
||||
@@ -127,17 +139,21 @@ There's one more detail to remember: Liquid does not render when embedded in YAM
|
||||
|
||||
For example, suppose you have a `highlight` tag in your `_data/mydata.yml` file:
|
||||
|
||||
```
|
||||
{% raw %}myvalue: >
|
||||
{% raw %}
|
||||
```liquid
|
||||
myvalue: >
|
||||
{% highlight javascript %}
|
||||
console.log('alert');
|
||||
{% endhighlight %}{% endraw %}
|
||||
{% endhighlight %}
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
On a page, you try to insert the value:
|
||||
|
||||
{% raw %}
|
||||
```liquid
|
||||
{{ site.data.mydata.myvalue }}
|
||||
```
|
||||
{% raw %}{{ site.data.mydata.myvalue }}{% endraw %}
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
This would render only as a string rather than a code sample with syntax highlighting. To make the code render, consider using an include instead.
|
||||
|
||||
106
docs/_tutorials/using-jekyll-with-bundler.md
Normal file
106
docs/_tutorials/using-jekyll-with-bundler.md
Normal file
@@ -0,0 +1,106 @@
|
||||
---
|
||||
layout: tutorials
|
||||
permalink: /tutorials/using-jekyll-with-bundler/
|
||||
title: Using Jekyll with Bundler
|
||||
---
|
||||
|
||||
> Bundler provides a consistent environment for Ruby projects by tracking and
|
||||
> installing the exact gems and versions that are needed.
|
||||
|
||||
[Bundler](https://bundler.io) can be a great tool to use with Jekyll. Because it
|
||||
tracks dependencies on a per-project basis, it is particularly useful if you
|
||||
need to run different versions of Jekyll in different projects, or if you don't
|
||||
want to install Jekyll at the system or user level. This tutorial will show you
|
||||
how to create a new Jekyll project using Bundler and without installing Jekyll
|
||||
outside the project.
|
||||
|
||||
## Before You Begin
|
||||
|
||||
To complete this tutorial, you'll need to have
|
||||
[Ruby](https://www.ruby-lang.org/en/) and [Bundler](https://bundler.io/)
|
||||
installed. You can find the installation instructions on their websites.
|
||||
|
||||
## Initialize Bundler
|
||||
|
||||
The first thing to do is create a new directory for your project and run
|
||||
`bundle init`. This creates a new Bundler project (by creating an empty
|
||||
Gemfile).
|
||||
|
||||
```sh
|
||||
mkdir my-jekyll-website
|
||||
cd my-jekyll-website
|
||||
bundle init
|
||||
```
|
||||
|
||||
## Configure Bundler
|
||||
|
||||
This step is optional, but encouraged. We're going to configure Bundler to install
|
||||
gems in the `./vendor/bundle/` project subdirectory. This allows us to install
|
||||
our dependencies in an isolated environment, ensuring they don't conflict with
|
||||
other gems on your system. If you skip this step, Bundler will install your
|
||||
dependencies globally on your system.
|
||||
|
||||
```sh
|
||||
bundle install --path vendor/bundle
|
||||
```
|
||||
|
||||
<div class="note info">
|
||||
<h5>Bundler Config is Persistent</h5>
|
||||
<p>
|
||||
This step is only required once per project. Bundler saves your config in
|
||||
<code>./.bundle/config</code>, so future gems will be installed to the same
|
||||
location.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
## Add Jekyll
|
||||
|
||||
Now, we're going to use Bundler to add Jekyll as a dependency of our new
|
||||
project. This command will add the Jekyll gem to our Gemfile and install it to
|
||||
the `./vendor/bundle/` folder.
|
||||
|
||||
```sh
|
||||
bundle add jekyll
|
||||
```
|
||||
|
||||
## Create A Jekyll Scaffold
|
||||
|
||||
Now that Jekyll is installed, we can use it to create the scaffolding for our
|
||||
site. We need the `--force` parameter because our folder isn't empty - it
|
||||
already has some Bundler files in it. We run the `bundle install` separately
|
||||
because Jekyll gets confused if the Gemfile already exists.
|
||||
|
||||
```sh
|
||||
bundle exec jekyll new --force --skip-bundle .
|
||||
bundle install
|
||||
```
|
||||
|
||||
## Serve the Site
|
||||
|
||||
Your new website is ready! You can serve the website with
|
||||
`bundle exec jekyll serve` and visit it at
|
||||
[http://127.0.0.1:4000](http://127.0.0.1:4000). From here, you're ready to
|
||||
continue developing the site on your own. All of the normal Jekyll commands are
|
||||
available to you, but you should prefix them with `bundle exec` so that Bundler
|
||||
runs the version of Jekyll that is installed in your project folder.
|
||||
|
||||
## Commit to Source Control
|
||||
|
||||
If you're storing your new site in version control, you'll want to ignore the
|
||||
`./vendor/` and `./.bundle/` folders since they contain user- or
|
||||
platform-specific information. New users will be able to install the correct
|
||||
dependencies based on `Gemfile` and `Gemfile.lock`, which should both be checked
|
||||
in. You can use this `.gitigonre` to get started, if you want.
|
||||
|
||||
**.gitignore**
|
||||
|
||||
```
|
||||
# Ignore folders generated by Bundler
|
||||
vendor
|
||||
.bundle
|
||||
|
||||
# Ignore folders generated by Jekyll
|
||||
.sass-cache
|
||||
_site
|
||||
```
|
||||
|
||||
35
docs/_tutorials/video-walkthroughs.md
Normal file
35
docs/_tutorials/video-walkthroughs.md
Normal file
@@ -0,0 +1,35 @@
|
||||
---
|
||||
layout: tutorials
|
||||
permalink: /tutorials/video-walkthroughs/
|
||||
title: Video Walkthroughs
|
||||
---
|
||||
|
||||
[Giraffe Academy](https://www.youtube.com/c/GiraffeAcademy) has a series of videos that will walk you through the basics of using Jekyll. In this series you'll learn everything from installing Jekyll on your computer and setting up your first site, to using more complex features like variables, layouts and conditionals.
|
||||
|
||||
<div class="videoWrapper" >
|
||||
<iframe src="https://www.youtube.com/embed/T1itpPvFWHI?rel=0" frameborder="0" allowfullscreen></iframe>
|
||||
</div>
|
||||
|
||||
## List of Lessons
|
||||
|
||||
1. [Introduction to Jekyll (see above)](https://www.youtube.com/watch?v=T1itpPvFWHI&list=PLLAZ4kZ9dFpOPV5C5Ay0pHaa0RJFhcmcB&index=1)
|
||||
2. [Mac Installation](https://www.youtube.com/watch?v=WhrU9m82Wm8&list=PLLAZ4kZ9dFpOPV5C5Ay0pHaa0RJFhcmcB&index=2)
|
||||
3. [Windows Installation](https://www.youtube.com/watch?v=LfP7Y9Ja6Qc&list=PLLAZ4kZ9dFpOPV5C5Ay0pHaa0RJFhcmcB&index=3)
|
||||
4. [Creating a Site](https://www.youtube.com/watch?v=pxua_1vyFck&index=4&list=PLLAZ4kZ9dFpOPV5C5Ay0pHaa0RJFhcmcB)
|
||||
5. [Front Matter](https://www.youtube.com/watch?v=ZtEbGztktvc&index=5&list=PLLAZ4kZ9dFpOPV5C5Ay0pHaa0RJFhcmcB)
|
||||
6. [Writing Posts](https://www.youtube.com/watch?v=gsYqPL9EFwQ&list=PLLAZ4kZ9dFpOPV5C5Ay0pHaa0RJFhcmcB&index=6)
|
||||
7. [Working With Drafts](https://www.youtube.com/watch?v=X8jXkW3k2Jg&index=7&list=PLLAZ4kZ9dFpOPV5C5Ay0pHaa0RJFhcmcB)
|
||||
8. [Creating Pages](https://www.youtube.com/watch?v=1na-IWfv08M&index=8&list=PLLAZ4kZ9dFpOPV5C5Ay0pHaa0RJFhcmcB)
|
||||
9. [Permalinks](https://www.youtube.com/watch?v=938jDG_YPdc&list=PLLAZ4kZ9dFpOPV5C5Ay0pHaa0RJFhcmcB&index=9)
|
||||
10. [Front Matter Defaults](https://www.youtube.com/watch?v=CLCaJJ1zUHU&index=10&list=PLLAZ4kZ9dFpOPV5C5Ay0pHaa0RJFhcmcB)
|
||||
11. [Themes](https://www.youtube.com/watch?v=NoRS2D-cyko&list=PLLAZ4kZ9dFpOPV5C5Ay0pHaa0RJFhcmcB&index=11)
|
||||
12. [Layouts](https://www.youtube.com/watch?v=bDQsGdCWv4I&list=PLLAZ4kZ9dFpOPV5C5Ay0pHaa0RJFhcmcB&index=12)
|
||||
13. [Variables](https://www.youtube.com/watch?v=nLJBF2KiOZw&index=13&list=PLLAZ4kZ9dFpOPV5C5Ay0pHaa0RJFhcmcB)
|
||||
14. [Includes](https://www.youtube.com/watch?v=HfcJeRby2a8&index=14&list=PLLAZ4kZ9dFpOPV5C5Ay0pHaa0RJFhcmcB)
|
||||
15. [Looping Through Posts](https://www.youtube.com/watch?v=6N1X5XffuUA&index=15&list=PLLAZ4kZ9dFpOPV5C5Ay0pHaa0RJFhcmcB)
|
||||
16. [Conditionals](https://www.youtube.com/watch?v=iNZBEki_x6o&list=PLLAZ4kZ9dFpOPV5C5Ay0pHaa0RJFhcmcB&index=16)
|
||||
17. [Data Files](https://www.youtube.com/watch?v=M6b0KmLB-pM&list=PLLAZ4kZ9dFpOPV5C5Ay0pHaa0RJFhcmcB&index=17)
|
||||
18. [Static Files](https://www.youtube.com/watch?v=knWjmVlVpso&index=18&list=PLLAZ4kZ9dFpOPV5C5Ay0pHaa0RJFhcmcB)
|
||||
19. [Hosting on Github Pages](https://www.youtube.com/watch?v=fqFjuX4VZmU&list=PLLAZ4kZ9dFpOPV5C5Ay0pHaa0RJFhcmcB&index=19)
|
||||
|
||||
|
||||
@@ -1,12 +1,14 @@
|
||||
---
|
||||
layout: page
|
||||
title: Community
|
||||
permalink: /community/
|
||||
title: JekyllConf
|
||||
redirect_from: /community/index.html
|
||||
permalink: /jekyllconf/
|
||||
---
|
||||
|
||||
[JekyllConf](http://jekyllconf.com) is a free, online conference for all things Jekyll hosted by [CloudCannon](http://cloudcannon.com). Each year members of the Jekyll community speak about interesting use cases, tricks they've learned, or meta Jekyll topics.
|
||||
|
||||
## Featured
|
||||
|
||||
{% assign random = site.time | date: "%s%N" | modulo: site.data.jekyllconf-talks.size %}
|
||||
{% assign featured = site.data.jekyllconf-talks[random] %}
|
||||
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user