mirror of
https://github.com/jekyll/jekyll.git
synced 2026-04-28 03:01:03 -04:00
Compare commits
1273 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
7c44c5a56d | ||
|
|
cd3831296a | ||
|
|
88a338d345 | ||
|
|
d3e387d146 | ||
|
|
cb6724046d | ||
|
|
ff012e795a | ||
|
|
d50ef0e3dd | ||
|
|
347651e571 | ||
|
|
9f8f031469 | ||
|
|
f27eb77d0b | ||
|
|
51d04cbd00 | ||
|
|
2713716d55 | ||
|
|
07d4333579 | ||
|
|
f8ec71af3b | ||
|
|
dbfe0cdf56 | ||
|
|
1e0697a258 | ||
|
|
3e504f0837 | ||
|
|
262ebbb9f0 | ||
|
|
810f0e93d0 | ||
|
|
e515ddeb29 | ||
|
|
d050f6de10 | ||
|
|
b7cbfc0fb7 | ||
|
|
09ec7c81f2 | ||
|
|
09548c3d96 | ||
|
|
fcbbc4d0bc | ||
|
|
6744921f69 | ||
|
|
6110002d1e | ||
|
|
bafe37cc9d | ||
|
|
cc3197856b | ||
|
|
fc66991243 | ||
|
|
3e1fad273b | ||
|
|
4268301071 | ||
|
|
1254ffc593 | ||
|
|
2d1a50c212 | ||
|
|
c7b301709c | ||
|
|
df45f26187 | ||
|
|
d71dff74ae | ||
|
|
7bf4627046 | ||
|
|
b194211a32 | ||
|
|
74a5297c19 | ||
|
|
0de653d186 | ||
|
|
f10c914fd5 | ||
|
|
ca3aaec7b5 | ||
|
|
3d1a7efe26 | ||
|
|
92354fa7fc | ||
|
|
70fae19b88 | ||
|
|
3035806826 | ||
|
|
1bafbd91fa | ||
|
|
7314e4a5db | ||
|
|
2c68069a41 | ||
|
|
1852e54d10 | ||
|
|
57a6847165 | ||
|
|
7af41649e9 | ||
|
|
9824c3103b | ||
|
|
8157d53af0 | ||
|
|
e1eff52cd2 | ||
|
|
4399dbbd3d | ||
|
|
2dafd50664 | ||
|
|
b30c499196 | ||
|
|
c0341ad9f4 | ||
|
|
7298da6de4 | ||
|
|
7d2b2961ef | ||
|
|
5237040b44 | ||
|
|
ebd40da4a6 | ||
|
|
d55cfe5154 | ||
|
|
52e189c46a | ||
|
|
55887194cd | ||
|
|
0a17b0ab0a | ||
|
|
e523b22510 | ||
|
|
b9a17e05dc | ||
|
|
acc00e41fb | ||
|
|
3e2139e894 | ||
|
|
2adac58b41 | ||
|
|
2115b73cb5 | ||
|
|
1669f944d1 | ||
|
|
8b2a35dc50 | ||
|
|
b108f4c87e | ||
|
|
db4c571020 | ||
|
|
6be62def90 | ||
|
|
a087d34ece | ||
|
|
8b9391da98 | ||
|
|
3eedfd8fe0 | ||
|
|
16217b2ed7 | ||
|
|
d9bf26bd9f | ||
|
|
e92dd2055d | ||
|
|
e6b9dd1cc1 | ||
|
|
257e60b9a7 | ||
|
|
0c234c90a9 | ||
|
|
2d35364c02 | ||
|
|
a2ffde8f14 | ||
|
|
1bb2259a10 | ||
|
|
a856a948c9 | ||
|
|
a1bdd31249 | ||
|
|
99d12724f9 | ||
|
|
26144645d8 | ||
|
|
762bf18d25 | ||
|
|
803c8827e3 | ||
|
|
142e12addc | ||
|
|
fcec2a6af9 | ||
|
|
81535dc188 | ||
|
|
4896f54b87 | ||
|
|
ce6f20f187 | ||
|
|
bc5e59ca3e | ||
|
|
a87cfec587 | ||
|
|
26f775c210 | ||
|
|
9bb242b44a | ||
|
|
3689844597 | ||
|
|
7729d12cdc | ||
|
|
12a86c1298 | ||
|
|
0ce9d726f5 | ||
|
|
8ed9863f07 | ||
|
|
d6844d284c | ||
|
|
4d597643ec | ||
|
|
343d5f7be5 | ||
|
|
11a0b6578e | ||
|
|
3431c9f7b8 | ||
|
|
eca7f46749 | ||
|
|
821a845166 | ||
|
|
d979b4bf9b | ||
|
|
124c63fd59 | ||
|
|
89bbb249af | ||
|
|
344d07cb55 | ||
|
|
0484986c16 | ||
|
|
c7d0dda5a7 | ||
|
|
ea72f98609 | ||
|
|
0f5c34d16d | ||
|
|
0d8e21f779 | ||
|
|
2be5d56059 | ||
|
|
e6829b5949 | ||
|
|
8a4edc550b | ||
|
|
cc1972848d | ||
|
|
51d9be83a1 | ||
|
|
c4a23b4ced | ||
|
|
b9275920dd | ||
|
|
53d20bc77e | ||
|
|
7aa9c3f12c | ||
|
|
00e3c979c9 | ||
|
|
0a1c837755 | ||
|
|
7c901baac1 | ||
|
|
1f9c2b1380 | ||
|
|
146d5930a4 | ||
|
|
6ec86f4207 | ||
|
|
d1f67bf85a | ||
|
|
c9d24b7d18 | ||
|
|
62ec32c883 | ||
|
|
aa97be3ab5 | ||
|
|
389bbe1621 | ||
|
|
0d12a02893 | ||
|
|
d4b7b44328 | ||
|
|
6cec4aebc6 | ||
|
|
f2fcd17627 | ||
|
|
c569edcf0a | ||
|
|
884962c20e | ||
|
|
53d472b7e2 | ||
|
|
f93e40209c | ||
|
|
08b30056b7 | ||
|
|
5e93ca6353 | ||
|
|
8bac0559d1 | ||
|
|
b4393e2d36 | ||
|
|
dc554c2cd5 | ||
|
|
21cd382409 | ||
|
|
b37d18234a | ||
|
|
6f05ebb520 | ||
|
|
ed042de6c4 | ||
|
|
7c8c825f27 | ||
|
|
63e4e750ec | ||
|
|
6d1bc6c6ea | ||
|
|
c90d44d2be | ||
|
|
7133bddfb2 | ||
|
|
41d0ba66ea | ||
|
|
8ec7421c03 | ||
|
|
c61752a336 | ||
|
|
fcef78c4b6 | ||
|
|
6f2d1591fc | ||
|
|
f67dfb71fe | ||
|
|
3de78877c0 | ||
|
|
38f9e93a10 | ||
|
|
22a7714bba | ||
|
|
55257d2a14 | ||
|
|
275f5a6209 | ||
|
|
7ea610f8c0 | ||
|
|
d879840cc5 | ||
|
|
a945a65818 | ||
|
|
e27a65d9e3 | ||
|
|
01c33907a3 | ||
|
|
a138b02b10 | ||
|
|
761ddcae24 | ||
|
|
274d350d61 | ||
|
|
80ae013541 | ||
|
|
a0a351aa7a | ||
|
|
cff8f2994c | ||
|
|
aa901cdaba | ||
|
|
ef3f9d0e7a | ||
|
|
d716d9b7be | ||
|
|
5a31aacfbe | ||
|
|
7118999958 | ||
|
|
553fae8f17 | ||
|
|
459bc17019 | ||
|
|
f0574e047e | ||
|
|
b38ac5d938 | ||
|
|
feddd7daec | ||
|
|
1c7aa4729e | ||
|
|
54927d6522 | ||
|
|
91ef3a7cc9 | ||
|
|
69172bcc4a | ||
|
|
3d3f310a5e | ||
|
|
51695b2165 | ||
|
|
5b4269eca5 | ||
|
|
8e91263031 | ||
|
|
fd5f2eb399 | ||
|
|
682c0fc98f | ||
|
|
6847b604c8 | ||
|
|
b6d4ba56b7 | ||
|
|
9c197d9555 | ||
|
|
79b0f27bf6 | ||
|
|
0f70bb1320 | ||
|
|
d57b04782d | ||
|
|
2f5b7dc1dc | ||
|
|
8138e67ffb | ||
|
|
719c0938a5 | ||
|
|
93c7cdf0d0 | ||
|
|
06651c960a | ||
|
|
a920cf040b | ||
|
|
6c5a371b92 | ||
|
|
157c8e888e | ||
|
|
a69919ecbe | ||
|
|
6dbb5e2df1 | ||
|
|
c4ccfae3af | ||
|
|
481901b413 | ||
|
|
8321b14b29 | ||
|
|
81b16b24fc | ||
|
|
6b6ce3cf18 | ||
|
|
6366f56c21 | ||
|
|
5df8ef5717 | ||
|
|
d79ca534e4 | ||
|
|
5c55d95446 | ||
|
|
2b30c06140 | ||
|
|
fc6f7802a2 | ||
|
|
aebf711c61 | ||
|
|
bacb300876 | ||
|
|
3966a37d71 | ||
|
|
93c5f71faf | ||
|
|
59fa8549f9 | ||
|
|
db53213d16 | ||
|
|
9564782054 | ||
|
|
aaa062b047 | ||
|
|
8e027fced9 | ||
|
|
f277baa975 | ||
|
|
8197e17495 | ||
|
|
69937373bd | ||
|
|
0dc15dba88 | ||
|
|
fa96843555 | ||
|
|
6571ea0c1a | ||
|
|
992be253a6 | ||
|
|
081d7c016a | ||
|
|
2a02c798ac | ||
|
|
eab6752f52 | ||
|
|
aa86651650 | ||
|
|
ae27db62eb | ||
|
|
87c745573f | ||
|
|
25d4291d62 | ||
|
|
588b3a6649 | ||
|
|
99fc60e28c | ||
|
|
846ab94f43 | ||
|
|
3a7cbadd82 | ||
|
|
f3859384c0 | ||
|
|
ee84a95a38 | ||
|
|
9ae0a7023b | ||
|
|
1ac87eaae2 | ||
|
|
cfe61771e0 | ||
|
|
262be85c49 | ||
|
|
504411e476 | ||
|
|
650a3c7932 | ||
|
|
ad0f329d1c | ||
|
|
152fa877f6 | ||
|
|
3a45bf7d26 | ||
|
|
279f1516d2 | ||
|
|
29d8fee4ce | ||
|
|
950a37395f | ||
|
|
d8d42f6abc | ||
|
|
92dbe313e9 | ||
|
|
2eedf7d79c | ||
|
|
75d59911ae | ||
|
|
b78827cecb | ||
|
|
7309ecf8e1 | ||
|
|
3bfdc00d14 | ||
|
|
f2bfc832a0 | ||
|
|
054b23f69a | ||
|
|
0b94cf3fa1 | ||
|
|
1a11536a2c | ||
|
|
74baeb889a | ||
|
|
7a9427ccec | ||
|
|
5a1c5311f3 | ||
|
|
9aea71137e | ||
|
|
5a932c90b5 | ||
|
|
6d7f305e7c | ||
|
|
cf26bf5db0 | ||
|
|
87b9cfe2b5 | ||
|
|
13aec48137 | ||
|
|
b8f17b9034 | ||
|
|
562ffe7a3f | ||
|
|
c877d6f75c | ||
|
|
0233d93352 | ||
|
|
59b61c3f9f | ||
|
|
57fd5f887d | ||
|
|
4888b84b44 | ||
|
|
345f043cc4 | ||
|
|
566b42b8b3 | ||
|
|
55de780520 | ||
|
|
42725b1325 | ||
|
|
d86a293d78 | ||
|
|
a2e911c1b5 | ||
|
|
3e0363be4a | ||
|
|
aa2cfc81b7 | ||
|
|
a70abbeab5 | ||
|
|
8813173ba7 | ||
|
|
6ebdcdb198 | ||
|
|
9fd7e2c063 | ||
|
|
eefcbf5dde | ||
|
|
19f7a0b8fc | ||
|
|
c1e6f1fb94 | ||
|
|
9164973a6c | ||
|
|
f53a3b6272 | ||
|
|
dddafccb36 | ||
|
|
8c979ec565 | ||
|
|
3d38e8510c | ||
|
|
3840a38081 | ||
|
|
d632cdda68 | ||
|
|
57ab7c5f98 | ||
|
|
f0293def80 | ||
|
|
42b85bb82f | ||
|
|
b47db14f86 | ||
|
|
a666e6faee | ||
|
|
f69671c46c | ||
|
|
08436d75b8 | ||
|
|
da0776d70e | ||
|
|
57b86ee77e | ||
|
|
9b09d8a8e8 | ||
|
|
63595f388d | ||
|
|
45aac995d8 | ||
|
|
2f167aeea7 | ||
|
|
4af0f0262e | ||
|
|
4f80dde8c4 | ||
|
|
5093849b58 | ||
|
|
d905a0475a | ||
|
|
6a34966f20 | ||
|
|
a78426f20d | ||
|
|
9ddc12bad8 | ||
|
|
ac6bbc1906 | ||
|
|
8014c54ee0 | ||
|
|
73e79f0049 | ||
|
|
8496e2e8b6 | ||
|
|
d0f57b61d4 | ||
|
|
741102bd40 | ||
|
|
b781b9967d | ||
|
|
17883b77c6 | ||
|
|
6b121d2d85 | ||
|
|
5b21f8fda9 | ||
|
|
2b15b0b325 | ||
|
|
4420c3b2af | ||
|
|
40cc44c2ea | ||
|
|
b5ee87b4ca | ||
|
|
7c8dd4a55e | ||
|
|
f3d0a97604 | ||
|
|
095d5344cd | ||
|
|
b2ece36d27 | ||
|
|
160782ec50 | ||
|
|
f3093e2f6f | ||
|
|
34404af031 | ||
|
|
20f9c26088 | ||
|
|
0ad9fa3ba3 | ||
|
|
809ceea107 | ||
|
|
bd4e7465ef | ||
|
|
fd65e6ce32 | ||
|
|
a9da814f17 | ||
|
|
349569592e | ||
|
|
d0d41792f9 | ||
|
|
d49bf808b6 | ||
|
|
02602bebd7 | ||
|
|
4f8d8557e4 | ||
|
|
488496a3a6 | ||
|
|
1979426812 | ||
|
|
35846b8406 | ||
|
|
0e2aa46bcb | ||
|
|
b0425d8308 | ||
|
|
1930e13cad | ||
|
|
891a66bddb | ||
|
|
23d7929948 | ||
|
|
0d8796fbe6 | ||
|
|
7f578b5dd8 | ||
|
|
1cd880f9d0 | ||
|
|
f56f252b28 | ||
|
|
59b8f2da55 | ||
|
|
7892c5e1f3 | ||
|
|
2183d9d6b4 | ||
|
|
158e02623a | ||
|
|
9c33754f4f | ||
|
|
299e89df01 | ||
|
|
8903038571 | ||
|
|
250ca228c9 | ||
|
|
e0580c8909 | ||
|
|
ff55309dd7 | ||
|
|
13330caa19 | ||
|
|
e4233b055e | ||
|
|
a74a6be4c4 | ||
|
|
a5470a32f1 | ||
|
|
df1cafd507 | ||
|
|
7c6fde1ac2 | ||
|
|
bcedf2079f | ||
|
|
cf33a9c427 | ||
|
|
8aa54ad801 | ||
|
|
0a75156f85 | ||
|
|
13ce18d6a6 | ||
|
|
276404c3f8 | ||
|
|
d759cfbeb9 | ||
|
|
b908c3de1d | ||
|
|
6b289314e1 | ||
|
|
27139f40e2 | ||
|
|
478ea05c2e | ||
|
|
ade752b1c3 | ||
|
|
4319a752b1 | ||
|
|
3180b1490d | ||
|
|
c5e1c66b73 | ||
|
|
a24636d1dc | ||
|
|
326332a5d5 | ||
|
|
87c00b2756 | ||
|
|
594a6bf193 | ||
|
|
db61028b58 | ||
|
|
3dcad7284b | ||
|
|
830f157f51 | ||
|
|
596f5d1af3 | ||
|
|
9061f0b1f3 | ||
|
|
9716b57e10 | ||
|
|
1e97ae014f | ||
|
|
d0ae757714 | ||
|
|
06b3d72aa3 | ||
|
|
1b36e9fe85 | ||
|
|
748b2f1279 | ||
|
|
dadf43798e | ||
|
|
b82b93c7c0 | ||
|
|
a9f92278d3 | ||
|
|
f1f8319566 | ||
|
|
912079a796 | ||
|
|
e080c7f1ce | ||
|
|
9f8876a332 | ||
|
|
72629091d1 | ||
|
|
30399528e4 | ||
|
|
a49a5dcf4e | ||
|
|
dca8047f77 | ||
|
|
5a243fb64c | ||
|
|
3e65dd36a9 | ||
|
|
e6f3fd347c | ||
|
|
b3ce1392db | ||
|
|
1c68c23f85 | ||
|
|
8e361dfe7d | ||
|
|
4d44940b9c | ||
|
|
fbebdb7ce7 | ||
|
|
088e931901 | ||
|
|
c526c9dd62 | ||
|
|
519ccdf4d9 | ||
|
|
4bff65be90 | ||
|
|
554749ae0a | ||
|
|
b937757dce | ||
|
|
70ba8c578a | ||
|
|
de6476812f | ||
|
|
7841db8acf | ||
|
|
ab4abb1933 | ||
|
|
539154a158 | ||
|
|
06126af5cc | ||
|
|
d9a4f6a59a | ||
|
|
6167c09569 | ||
|
|
bc7aaf5274 | ||
|
|
d0f55d7207 | ||
|
|
c9bf8d0726 | ||
|
|
61eda2ee40 | ||
|
|
aa8d7772d5 | ||
|
|
6ab8b5ffe1 | ||
|
|
e0ce4a00f8 | ||
|
|
05445b81c7 | ||
|
|
50854d2f76 | ||
|
|
82d6657ae8 | ||
|
|
bc7eb70385 | ||
|
|
a63a6d8487 | ||
|
|
9e4f469469 | ||
|
|
ca77dae267 | ||
|
|
58cd8f3f4e | ||
|
|
ddff013696 | ||
|
|
f084de7bc9 | ||
|
|
01c59004e9 | ||
|
|
cb99cf603a | ||
|
|
d3ae8403ea | ||
|
|
997c61470b | ||
|
|
2bd592077d | ||
|
|
da0b456288 | ||
|
|
eef3687486 | ||
|
|
b5dcd4b295 | ||
|
|
57c6408b7f | ||
|
|
d504eb5ce9 | ||
|
|
15dc18343c | ||
|
|
d4a68eb642 | ||
|
|
a7bc7ff9c7 | ||
|
|
3943de066c | ||
|
|
d5e96757a5 | ||
|
|
801d12b916 | ||
|
|
050aacfc85 | ||
|
|
3f1b12972b | ||
|
|
20e1da8d0b | ||
|
|
9ccd0d767a | ||
|
|
bf8c15f949 | ||
|
|
6d2b344c0e | ||
|
|
88b57ce649 | ||
|
|
663117403d | ||
|
|
c4483a3a29 | ||
|
|
896a502129 | ||
|
|
8408449551 | ||
|
|
6e0119d5e1 | ||
|
|
b113c01198 | ||
|
|
c6417e8c82 | ||
|
|
c6f2459b4e | ||
|
|
73b7bd8172 | ||
|
|
28365aef96 | ||
|
|
52f5dc154c | ||
|
|
dc8c6e0e43 | ||
|
|
8540487997 | ||
|
|
95e9774100 | ||
|
|
e735e45156 | ||
|
|
ae72c64441 | ||
|
|
4d0d528fd5 | ||
|
|
26b827a536 | ||
|
|
1374a6c84c | ||
|
|
c5bd075bc7 | ||
|
|
4dab0c7da6 | ||
|
|
65d1dc48f3 | ||
|
|
207b6f19f0 | ||
|
|
9d45644e6c | ||
|
|
d158d73ce1 | ||
|
|
2236ee4284 | ||
|
|
d4e18fc979 | ||
|
|
3b2bbcb70f | ||
|
|
8e25b8bffb | ||
|
|
909800839c | ||
|
|
27cfa00a43 | ||
|
|
ff80d2f2b5 | ||
|
|
9220c5a634 | ||
|
|
b22fa7ce4e | ||
|
|
8b69c6f0b5 | ||
|
|
94af8ca75a | ||
|
|
f29ebc4911 | ||
|
|
16ff4c12bb | ||
|
|
e01f1ece48 | ||
|
|
2351ef6bbe | ||
|
|
bd96ca4ab6 | ||
|
|
54281530fb | ||
|
|
4278f856ef | ||
|
|
ca03a41564 | ||
|
|
1bf47ec394 | ||
|
|
6292476482 | ||
|
|
26f1ea2487 | ||
|
|
dd82c72e14 | ||
|
|
b9017f8b81 | ||
|
|
09570623f2 | ||
|
|
07518d9540 | ||
|
|
d9b8360d96 | ||
|
|
f4c3c5afd6 | ||
|
|
59c8f02129 | ||
|
|
989fc9c3db | ||
|
|
1155371f4e | ||
|
|
83456e7cd2 | ||
|
|
142957ff49 | ||
|
|
954c0bfe07 | ||
|
|
ea185f11af | ||
|
|
b65aa4748b | ||
|
|
7e34be945a | ||
|
|
a31766d329 | ||
|
|
058f9e8533 | ||
|
|
deab138f23 | ||
|
|
edec81ef96 | ||
|
|
823a8630b6 | ||
|
|
55317817d1 | ||
|
|
dbf312eec0 | ||
|
|
c83246bfe2 | ||
|
|
2c224b0990 | ||
|
|
a3ecce7cc1 | ||
|
|
087b763478 | ||
|
|
4b476f70e6 | ||
|
|
30e34a72c0 | ||
|
|
9b0532a3c4 | ||
|
|
41a99b300d | ||
|
|
7dd9e954d9 | ||
|
|
4b698747dc | ||
|
|
5805ea78ec | ||
|
|
6b0b6418dc | ||
|
|
3580e4fe82 | ||
|
|
0f3ce73516 | ||
|
|
28548f985e | ||
|
|
57944c3da4 | ||
|
|
da72c0974c | ||
|
|
810e411bdf | ||
|
|
d0fbae2294 | ||
|
|
5e3f9cdd4f | ||
|
|
ed3f745b77 | ||
|
|
71a971ff46 | ||
|
|
0e0e9f2081 | ||
|
|
90cf9f210e | ||
|
|
9f02ec6cf8 | ||
|
|
8d4ab9366e | ||
|
|
9176924eab | ||
|
|
1be51f963b | ||
|
|
f8aea7b35c | ||
|
|
e5028d505b | ||
|
|
9da15b62b1 | ||
|
|
c1e1d2a099 | ||
|
|
f4a9a2622c | ||
|
|
04cfd9f725 | ||
|
|
ff224cdfb2 | ||
|
|
acbdc3a4a5 | ||
|
|
eb28b5c296 | ||
|
|
3c2765d104 | ||
|
|
84c4d1998a | ||
|
|
a3b179373c | ||
|
|
9ee211a076 | ||
|
|
96194c3ce2 | ||
|
|
d590d7a738 | ||
|
|
990d385736 | ||
|
|
51f5c2809f | ||
|
|
c22d9e69df | ||
|
|
b474ea8550 | ||
|
|
5fb48430ca | ||
|
|
2f9ebaf7f4 | ||
|
|
cca211af98 | ||
|
|
b6044aebd6 | ||
|
|
dbea0c5389 | ||
|
|
0bd29bd632 | ||
|
|
2b4680bb94 | ||
|
|
ff25e4e2cf | ||
|
|
0963f85871 | ||
|
|
f8a4f58fff | ||
|
|
dcdbc29497 | ||
|
|
7975d2e994 | ||
|
|
1cfcf38289 | ||
|
|
5ca080ac6f | ||
|
|
dbc0349909 | ||
|
|
311e3d2fef | ||
|
|
5e74610755 | ||
|
|
cfeb54d4be | ||
|
|
10cfaa2a75 | ||
|
|
ed98597d49 | ||
|
|
196275f5b4 | ||
|
|
eb88aa330c | ||
|
|
0db1ec339d | ||
|
|
3ae7d0c319 | ||
|
|
b9f232e5bf | ||
|
|
b88f0a21d6 | ||
|
|
3b6561a57c | ||
|
|
4dee1f6aa7 | ||
|
|
16ba22f7c3 | ||
|
|
20b3758edb | ||
|
|
f417cf8a0f | ||
|
|
83a72606b3 | ||
|
|
99663a9199 | ||
|
|
2b57795c7f | ||
|
|
73223f3a5a | ||
|
|
49e97ef9b0 | ||
|
|
0e8f204011 | ||
|
|
695b5396fd | ||
|
|
9ef9c2fb64 | ||
|
|
3435b5ddac | ||
|
|
b44457a80b | ||
|
|
e503c17dfa | ||
|
|
b1f9a0809c | ||
|
|
5e760a206a | ||
|
|
8a3ea59141 | ||
|
|
f55cf34739 | ||
|
|
75989fdb3e | ||
|
|
5c6c01793c | ||
|
|
218c7039a9 | ||
|
|
9336ad0fcf | ||
|
|
a3cd584311 | ||
|
|
cc994105ed | ||
|
|
070267af8a | ||
|
|
f42fac60b0 | ||
|
|
b1674ed5b1 | ||
|
|
5194d1a42c | ||
|
|
a29498eaae | ||
|
|
1f366730f8 | ||
|
|
506ba8af1e | ||
|
|
49573b6fcf | ||
|
|
0ebf7129cf | ||
|
|
3674a7760f | ||
|
|
d683baa257 | ||
|
|
26b2a6251c | ||
|
|
8d2227a03a | ||
|
|
4b5126dda7 | ||
|
|
146d0f301d | ||
|
|
5b51b8bdf3 | ||
|
|
841727eed7 | ||
|
|
232054a059 | ||
|
|
d4a7fbee28 | ||
|
|
ac6ba15bae | ||
|
|
cc82d44222 | ||
|
|
ba8573c420 | ||
|
|
1c0f21230d | ||
|
|
f6dc749332 | ||
|
|
09f3e46945 | ||
|
|
1a934125d9 | ||
|
|
e3214c23a3 | ||
|
|
c46f219d3c | ||
|
|
5a339cc735 | ||
|
|
8bc104969f | ||
|
|
d4c87e3655 | ||
|
|
ba08e17204 | ||
|
|
25bff0075c | ||
|
|
08b279cbdd | ||
|
|
a25e97b5fb | ||
|
|
3a8e28cba1 | ||
|
|
c698e83eb1 | ||
|
|
3aead1d4a9 | ||
|
|
72d49490d2 | ||
|
|
51a80b8225 | ||
|
|
bfaa80e41c | ||
|
|
ac552cd4e4 | ||
|
|
dcc8960806 | ||
|
|
2f8c0ffc5d | ||
|
|
5688266d54 | ||
|
|
c261730799 | ||
|
|
897f0c52fa | ||
|
|
0599f114d6 | ||
|
|
4b7109d273 | ||
|
|
5a1a7e1056 | ||
|
|
70aa8a4e37 | ||
|
|
325b4c88d5 | ||
|
|
a072e9d25f | ||
|
|
b772329c60 | ||
|
|
a7d25ed963 | ||
|
|
6f3c01ca87 | ||
|
|
2ef70fd348 | ||
|
|
89c6b0ec0d | ||
|
|
12c1ada0e5 | ||
|
|
3a76ddf7a2 | ||
|
|
18a8b4dcc7 | ||
|
|
549371fd4e | ||
|
|
8154eb40aa | ||
|
|
390c98045c | ||
|
|
cdee574782 | ||
|
|
6ddd64d4c4 | ||
|
|
1c71b5939f | ||
|
|
3ccc91430f | ||
|
|
2bbad7cb43 | ||
|
|
b156aa912a | ||
|
|
6f5ad2530e | ||
|
|
aeca7a195e | ||
|
|
6dd3cc21c4 | ||
|
|
205acb0916 | ||
|
|
5312e85478 | ||
|
|
d093c76d35 | ||
|
|
9278eb8fce | ||
|
|
856dbcb2de | ||
|
|
77751cbf15 | ||
|
|
357e3621e2 | ||
|
|
6358a8f92c | ||
|
|
0b169f7739 | ||
|
|
13d60c21e1 | ||
|
|
8a71f0f48e | ||
|
|
b539c32364 | ||
|
|
1779aa681a | ||
|
|
fdd282cb75 | ||
|
|
f6f0f483bf | ||
|
|
08b883b268 | ||
|
|
d13112dbdc | ||
|
|
14e857029a | ||
|
|
902f344a50 | ||
|
|
5c03e1da3f | ||
|
|
97fecafff5 | ||
|
|
b06cfb9c50 | ||
|
|
7ee99bcd38 | ||
|
|
d220c7a9a9 | ||
|
|
0c7693f7b9 | ||
|
|
4afb407304 | ||
|
|
0f74db4131 | ||
|
|
7a933893db | ||
|
|
fa6934300b | ||
|
|
a71e677207 | ||
|
|
c70ca8ac97 | ||
|
|
765a23468e | ||
|
|
e9fed13392 | ||
|
|
a07917a7b2 | ||
|
|
f27fa75935 | ||
|
|
7c381c931b | ||
|
|
8fd287edba | ||
|
|
20910976c4 | ||
|
|
b972daa54d | ||
|
|
c3313d868e | ||
|
|
0c6162fc0a | ||
|
|
a9666bf1c7 | ||
|
|
1dbcf97bef | ||
|
|
52d32a643e | ||
|
|
2c3e044688 | ||
|
|
499b83236c | ||
|
|
6239bca6e6 | ||
|
|
3a1ac37ed1 | ||
|
|
6cf6da04af | ||
|
|
5e343f620a | ||
|
|
ddf833505c | ||
|
|
4a2b96293b | ||
|
|
713fbb6652 | ||
|
|
d1f4d874be | ||
|
|
8d748ce45f | ||
|
|
fb1a459ddd | ||
|
|
492cfcd962 | ||
|
|
cb0545dd46 | ||
|
|
8d65ce675a | ||
|
|
e85e89bbff | ||
|
|
73f70e9071 | ||
|
|
e72bfdab21 | ||
|
|
ce1c148898 | ||
|
|
ad94182b49 | ||
|
|
902ff4c132 | ||
|
|
9f1f70267f | ||
|
|
c96fc1166c | ||
|
|
15477d2417 | ||
|
|
d3c9b8d077 | ||
|
|
6c279b173f | ||
|
|
3fe9e92c4f | ||
|
|
b5466196ea | ||
|
|
d8acc434ae | ||
|
|
959f19c086 | ||
|
|
c2441ffbb4 | ||
|
|
eba9a2716b | ||
|
|
176b347737 | ||
|
|
9e8f205009 | ||
|
|
8b1c3bbf33 | ||
|
|
4c4327a14b | ||
|
|
e6dc78b22f | ||
|
|
6fd734f6ea | ||
|
|
dfc7d61765 | ||
|
|
5f2bb5d0aa | ||
|
|
2f95517bfd | ||
|
|
59a04ab4cb | ||
|
|
732ca468fa | ||
|
|
43fe09a07b | ||
|
|
7197028cd5 | ||
|
|
915b80b6b3 | ||
|
|
c8606c5765 | ||
|
|
f41bd1bab7 | ||
|
|
1f01c88fa0 | ||
|
|
688c7b1925 | ||
|
|
184da0ca2f | ||
|
|
e0f2848da6 | ||
|
|
652f1bad0b | ||
|
|
a5db408d5c | ||
|
|
f5a8000baa | ||
|
|
8917fa8282 | ||
|
|
ea0b43f56d | ||
|
|
8308a06b02 | ||
|
|
b3583a4236 | ||
|
|
03c2811ae0 | ||
|
|
912e6b469a | ||
|
|
b15423b6a9 | ||
|
|
bf524d62aa | ||
|
|
59bd2587df | ||
|
|
1c6916f237 | ||
|
|
e2ae0bab8a | ||
|
|
93f176f8c5 | ||
|
|
712e77abd2 | ||
|
|
6e504a0d2e | ||
|
|
3531df7428 | ||
|
|
d725991237 | ||
|
|
fe143c4e8f | ||
|
|
f5a0db9dcc | ||
|
|
74d363f080 | ||
|
|
986eda335c | ||
|
|
52fcd6981f | ||
|
|
5e30823544 | ||
|
|
7cd20261ab | ||
|
|
6a07254cbf | ||
|
|
956495f450 | ||
|
|
4b1012537f | ||
|
|
6355a07d4b | ||
|
|
14b36aae38 | ||
|
|
b5cff52f02 | ||
|
|
d6e58623c6 | ||
|
|
3a8025cb08 | ||
|
|
0212c83814 | ||
|
|
1e22c3659a | ||
|
|
d68ddf9dac | ||
|
|
bbbbb2e704 | ||
|
|
c2ee828ad6 | ||
|
|
675c105e85 | ||
|
|
dc4b91b0c8 | ||
|
|
e7677bdf51 | ||
|
|
97e196cb19 | ||
|
|
c642b84e80 | ||
|
|
e367f13f72 | ||
|
|
899316f401 | ||
|
|
261bc8f467 | ||
|
|
2bc8dc53ff | ||
|
|
597e8ee5d5 | ||
|
|
06cff8f781 | ||
|
|
e97fd34479 | ||
|
|
7efb0d4856 | ||
|
|
372f350a75 | ||
|
|
5acac4a925 | ||
|
|
db6050768d | ||
|
|
03f7bc1a8c | ||
|
|
714c99b418 | ||
|
|
5dfaa66d48 | ||
|
|
b5cec7d335 | ||
|
|
22982ef79e | ||
|
|
d5d2fd8674 | ||
|
|
f8c038566c | ||
|
|
14c1ac388f | ||
|
|
ca2abea086 | ||
|
|
35b3c91b64 | ||
|
|
3a3405fe51 | ||
|
|
7a02f29e70 | ||
|
|
5e46a02d71 | ||
|
|
8c231ed50a | ||
|
|
8a5148f589 | ||
|
|
632f3fd8de | ||
|
|
8d0a4be5e0 | ||
|
|
0ac9c7fe70 | ||
|
|
40c6702a0d | ||
|
|
753ff9216c | ||
|
|
f73b2d0a01 | ||
|
|
30eebaf5e0 | ||
|
|
45a5a976f0 | ||
|
|
ab3cda6e58 | ||
|
|
ff591dd5dc | ||
|
|
cd63272080 | ||
|
|
427e30c0f8 | ||
|
|
87acab9a86 | ||
|
|
b5aafc3137 | ||
|
|
f271b8b4b5 | ||
|
|
001cbf2c07 | ||
|
|
ae71db4693 | ||
|
|
acc9f511c5 | ||
|
|
d855ec03ba | ||
|
|
0880dc097f | ||
|
|
38eb326b7f | ||
|
|
d58c986b2b | ||
|
|
0d0ed561fd | ||
|
|
382be191ae | ||
|
|
0696e6c169 | ||
|
|
615a9ee9ac | ||
|
|
e85690a61f | ||
|
|
795bcdef68 | ||
|
|
40ec84cf61 | ||
|
|
4c35d15a3b | ||
|
|
3e42e6d461 | ||
|
|
1cec820628 | ||
|
|
fbff506faa | ||
|
|
5a23b130ce | ||
|
|
8fbeb52314 | ||
|
|
98262b73d5 | ||
|
|
474fc0a9a8 | ||
|
|
7537b01e74 | ||
|
|
23646549c4 | ||
|
|
c00c761e1d | ||
|
|
5291bd0498 | ||
|
|
fd75f0f7b1 | ||
|
|
6ef2bcb29a | ||
|
|
746e360c63 | ||
|
|
b950e7dd90 | ||
|
|
34d172007b | ||
|
|
4fbbeddae2 | ||
|
|
cceb8c5876 | ||
|
|
a15958d5a7 | ||
|
|
6f1e1d80cd | ||
|
|
b353e181c1 | ||
|
|
aff1430608 | ||
|
|
e56e58e498 | ||
|
|
02bf4f1032 | ||
|
|
d9c9e0238a | ||
|
|
dc5fd15f71 | ||
|
|
1502d00063 | ||
|
|
0ca45a48e5 | ||
|
|
3c0d1a18bf | ||
|
|
a7cbb89dfc | ||
|
|
cf810a88fa | ||
|
|
2caf8e0621 | ||
|
|
5c036cf3c4 | ||
|
|
757233754e | ||
|
|
10543e7c46 | ||
|
|
de39107c76 | ||
|
|
65e78b3280 | ||
|
|
3a04093e51 | ||
|
|
733c56a65e | ||
|
|
1c937013fd | ||
|
|
3292850b98 | ||
|
|
2ca80920dc | ||
|
|
f8c708ffec | ||
|
|
17d8c96a63 | ||
|
|
ad7bd84098 | ||
|
|
1a05483a63 | ||
|
|
cc0c5ea19e | ||
|
|
db7cd6f612 | ||
|
|
8e939cd86e | ||
|
|
a99adcafaa | ||
|
|
7641971d7e | ||
|
|
48274244e3 | ||
|
|
d5c3785d29 | ||
|
|
de5970ae55 | ||
|
|
d84844c223 | ||
|
|
ad59b6e62a | ||
|
|
37b93f10dd | ||
|
|
59346eb228 | ||
|
|
8af77643c5 | ||
|
|
f52a0e7200 | ||
|
|
d01f7943de | ||
|
|
fab092fcec | ||
|
|
4e06f07ad4 | ||
|
|
6eaa8e90f8 | ||
|
|
04d4473119 | ||
|
|
dbcbf809ff | ||
|
|
f2263a11b7 | ||
|
|
c69ca4c11e | ||
|
|
48f16974ce | ||
|
|
7d3f8ac75d | ||
|
|
c0910f2bc5 | ||
|
|
3896f6d5d8 | ||
|
|
b019234007 | ||
|
|
2c567a6dc3 | ||
|
|
80a65d161f | ||
|
|
0d11511914 | ||
|
|
41a8b10780 | ||
|
|
a8d27e5788 | ||
|
|
e02049727b | ||
|
|
6eaf2634f2 | ||
|
|
dbda462c2f | ||
|
|
6db5272528 | ||
|
|
281a873c71 | ||
|
|
d743c80357 | ||
|
|
e85f2a0ee9 | ||
|
|
8f07affe2a | ||
|
|
a9f110b861 | ||
|
|
16c1146b4f | ||
|
|
1380836a4b | ||
|
|
013e2f159d | ||
|
|
498324bbff | ||
|
|
51c4152919 | ||
|
|
8ac5b03006 | ||
|
|
cd31761f9a | ||
|
|
ee2c41ad6a | ||
|
|
f3a29677f9 | ||
|
|
f7714add15 | ||
|
|
f2d08cf138 | ||
|
|
ca0b1f7ea6 | ||
|
|
12deccc513 | ||
|
|
20110571ef | ||
|
|
3885057e9e | ||
|
|
1d81d2087e | ||
|
|
5949b4a5bb | ||
|
|
eb14b88175 | ||
|
|
952947c65e | ||
|
|
cb80934277 | ||
|
|
eab2b438c9 | ||
|
|
66e5453c35 | ||
|
|
9e92061eb3 | ||
|
|
ce9a8cb0f2 | ||
|
|
df585aa5c6 | ||
|
|
b006810f17 | ||
|
|
98eef8af95 | ||
|
|
211c16003e | ||
|
|
bc16d13d79 | ||
|
|
6ef54393c2 | ||
|
|
de5d773a6a | ||
|
|
df7992c626 | ||
|
|
df01b6825e | ||
|
|
c76b458dd5 | ||
|
|
ad98883843 | ||
|
|
5a1a8c9c82 | ||
|
|
271a8aebfb | ||
|
|
0635bbba06 | ||
|
|
555b2fbe72 | ||
|
|
c8cae38da6 | ||
|
|
cfe6cf7ca1 | ||
|
|
454a1e415c | ||
|
|
5034cc377a | ||
|
|
aad587ca2f | ||
|
|
146d49dc8f | ||
|
|
2caff755c4 | ||
|
|
eb56ca8c41 | ||
|
|
fb860fc1b7 | ||
|
|
473d85b580 | ||
|
|
583fe84edc | ||
|
|
e3df910533 | ||
|
|
3611ae99d9 | ||
|
|
2a81fef996 | ||
|
|
b484738239 | ||
|
|
b64b6aa526 | ||
|
|
465e7dd8b0 | ||
|
|
96ac1185a1 | ||
|
|
6dc9665573 | ||
|
|
83f8df49ab | ||
|
|
6a2ffbac62 | ||
|
|
64219cc11a | ||
|
|
b40524fbc3 | ||
|
|
1e89aa7a13 | ||
|
|
a4369ea7e5 | ||
|
|
451881efcf | ||
|
|
894d1fe21e | ||
|
|
26d0a8db77 | ||
|
|
6f89fd5f3f | ||
|
|
f2bad8524f | ||
|
|
8c9492d5fa | ||
|
|
207e4df3de | ||
|
|
f615475378 | ||
|
|
5258f78a51 | ||
|
|
73ae01b4e5 | ||
|
|
13eaa4fd77 | ||
|
|
3b021c6046 | ||
|
|
419c670947 | ||
|
|
cddc40fef4 | ||
|
|
85e3ce37af | ||
|
|
fa3323ec92 | ||
|
|
ffe6e0d996 | ||
|
|
b28e14bcd6 | ||
|
|
917b470459 | ||
|
|
1ae4f513d8 | ||
|
|
209cd6b729 | ||
|
|
1504864d9e | ||
|
|
3751b47c50 | ||
|
|
92720363e1 | ||
|
|
4986cb78a3 | ||
|
|
7f3a9e1f40 | ||
|
|
cd861d7fc5 | ||
|
|
4dab3dd423 | ||
|
|
8f79551da3 | ||
|
|
d9ab71cb59 | ||
|
|
770b6ab073 | ||
|
|
b7bf19ff31 | ||
|
|
2d8a228b59 | ||
|
|
55734ee482 | ||
|
|
53d6b91fc8 | ||
|
|
6c081427c4 | ||
|
|
44cf61d241 | ||
|
|
b8e7669228 | ||
|
|
51c0c934d3 | ||
|
|
46f54e6b94 | ||
|
|
0ee1a75d16 | ||
|
|
c9d5c7d30a | ||
|
|
342d5a4250 | ||
|
|
19b566e6ea | ||
|
|
d74f8d6dd9 | ||
|
|
035352feff | ||
|
|
a04c45a2b6 | ||
|
|
6ed193277d | ||
|
|
960342eb38 | ||
|
|
008e694732 | ||
|
|
4d264b5b9c | ||
|
|
b45f575ffe | ||
|
|
f535497d90 | ||
|
|
70fb98f777 | ||
|
|
514fdc7610 | ||
|
|
605cd265c0 | ||
|
|
6d0bab5d59 | ||
|
|
1d788203df | ||
|
|
1ac9c21956 | ||
|
|
298d56aab2 | ||
|
|
d8dc0b6333 | ||
|
|
30f2bdff5b | ||
|
|
685abf109b | ||
|
|
e4057e0c81 | ||
|
|
57ccbe08ea | ||
|
|
bac65ea8c5 | ||
|
|
49a3f543f3 | ||
|
|
3b2d68d333 | ||
|
|
2b73696d03 | ||
|
|
d5dd423bfd | ||
|
|
42cc2445a5 | ||
|
|
f67f771a45 | ||
|
|
655ffd45be | ||
|
|
0d89b77dae | ||
|
|
341407ef2a | ||
|
|
1d55558956 | ||
|
|
46b2ab8e88 | ||
|
|
823a84fec9 | ||
|
|
1ec64f568d | ||
|
|
f6f0d39b81 | ||
|
|
94647af1f4 | ||
|
|
894b356619 | ||
|
|
f61ba8abf7 | ||
|
|
ccd5c9e106 | ||
|
|
4e09375531 | ||
|
|
9315cdb473 | ||
|
|
40e3a04704 | ||
|
|
87825e1e14 | ||
|
|
46dd5cf5a2 | ||
|
|
adc6a491b9 | ||
|
|
6f794ae320 | ||
|
|
27366f2e30 | ||
|
|
8257f0abd9 | ||
|
|
f922e8994a | ||
|
|
b97d9b688e | ||
|
|
5e302d7ec6 | ||
|
|
b122148acf | ||
|
|
1e74c7a547 | ||
|
|
8144e7620f | ||
|
|
bb307bf6c1 | ||
|
|
f210cafdf2 | ||
|
|
519c3eb51f | ||
|
|
1cf5c8abd7 | ||
|
|
7635d08ecf | ||
|
|
fc0d440201 | ||
|
|
e470cae6da | ||
|
|
1ef7653fed | ||
|
|
66c4ff8800 | ||
|
|
64d1a81968 | ||
|
|
61b17d3dc8 | ||
|
|
1efb1d7a58 | ||
|
|
4907b4c9f2 | ||
|
|
1bc8a83774 | ||
|
|
b0c3e3fa47 | ||
|
|
1430b6901d | ||
|
|
9880cea627 | ||
|
|
42b68261da | ||
|
|
b1a6b21dad | ||
|
|
b35a2dd66d | ||
|
|
6f000c3807 | ||
|
|
499339548d | ||
|
|
cd1d7afd59 | ||
|
|
f17d0076e0 | ||
|
|
0daf1f5514 | ||
|
|
5e212648f6 | ||
|
|
129a0b6b7d | ||
|
|
a42d0ad9e9 | ||
|
|
ec105b3e54 | ||
|
|
19a8473023 | ||
|
|
eb4e9dd347 | ||
|
|
d576d7bfae | ||
|
|
4effe25cc1 | ||
|
|
4c65772c44 | ||
|
|
764a2c1b39 | ||
|
|
487631e935 | ||
|
|
e823ac5180 | ||
|
|
9347e90a67 | ||
|
|
4aadfe9fd7 | ||
|
|
bbd2a2b7f1 | ||
|
|
33255e3ac3 | ||
|
|
0920d2b48a | ||
|
|
a30068bf3f | ||
|
|
a1a4b3937a | ||
|
|
6aae64c985 | ||
|
|
0f90fe67d2 | ||
|
|
4a70382d5b | ||
|
|
bdaa0c3b5b | ||
|
|
f60d3a8dbc | ||
|
|
c0dec091a2 | ||
|
|
36dc8c2169 | ||
|
|
285aa54445 | ||
|
|
ceace852b0 | ||
|
|
64e4984ff5 | ||
|
|
5f8ae36380 | ||
|
|
7b63c8d201 | ||
|
|
0a04932020 | ||
|
|
f89fbbe9e6 | ||
|
|
e3c71ea407 | ||
|
|
1a203a0598 | ||
|
|
92168954d2 | ||
|
|
b29ce257c3 | ||
|
|
78acdc72e2 | ||
|
|
678d494d90 | ||
|
|
eb341514a7 | ||
|
|
e8617cf7cd | ||
|
|
ea84ac9b04 | ||
|
|
06ee9bcff4 | ||
|
|
c86fba6fb3 | ||
|
|
ff3df203c4 | ||
|
|
8b880cb993 | ||
|
|
ada7c4f441 | ||
|
|
47416169c3 | ||
|
|
8bfb9e51f3 | ||
|
|
91b348966e |
@@ -1,29 +1,33 @@
|
||||
engines:
|
||||
rubocop: { enabled: true }
|
||||
fixme: { enabled: false }
|
||||
fixme:
|
||||
enabled: false
|
||||
rubocop:
|
||||
enabled: true
|
||||
|
||||
exclude_paths:
|
||||
- .rubocop.yml
|
||||
- .codeclimate.yml
|
||||
- .travis.yml
|
||||
- .gitignore
|
||||
- .rspec
|
||||
- .codeclimate.yml
|
||||
- .gitignore
|
||||
- .rspec
|
||||
- .rubocop.yml
|
||||
- .travis.yml
|
||||
|
||||
- Gemfile.lock
|
||||
- CHANGELOG.{md,markdown,txt,textile}
|
||||
- CONTRIBUTING.{md,markdown,txt,textile}
|
||||
- readme.{md,markdown,txt,textile}
|
||||
- README.{md,markdown,txt,textile}
|
||||
- Readme.{md,markdown,txt,textile}
|
||||
- ReadMe.{md,markdown,txt,textile}
|
||||
- COPYING
|
||||
- LICENSE
|
||||
- Gemfile.lock
|
||||
- CHANGELOG.{md,markdown,txt,textile}
|
||||
- CONTRIBUTING.{md,markdown,txt,textile}
|
||||
- readme.{md,markdown,txt,textile}
|
||||
- README.{md,markdown,txt,textile}
|
||||
- Readme.{md,markdown,txt,textile}
|
||||
- ReadMe.{md,markdown,txt,textile}
|
||||
- COPYING
|
||||
- LICENSE
|
||||
|
||||
- features/**/*
|
||||
- script/**/*
|
||||
- site/**/*
|
||||
- spec/**/*
|
||||
- test/**/*
|
||||
- vendor/**/*
|
||||
|
||||
- site/**/*
|
||||
- test/**/*
|
||||
- vendor/**/*
|
||||
- features/**/*
|
||||
- script/**/*
|
||||
- spec/**/*
|
||||
ratings:
|
||||
paths:
|
||||
- lib/**/*.rb
|
||||
- lib/**/*.rb
|
||||
|
||||
14
.editorconfig
Normal file
14
.editorconfig
Normal file
@@ -0,0 +1,14 @@
|
||||
# editorconfig.org
|
||||
|
||||
root = true
|
||||
|
||||
[*]
|
||||
charset = utf-8
|
||||
end_of_line = lf
|
||||
indent_size = 2
|
||||
indent_style = space
|
||||
insert_final_newline = true
|
||||
trim_trailing_whitespace = true
|
||||
|
||||
[*.md]
|
||||
trim_trailing_whitespace = false
|
||||
10
.github/CONTRIBUTING.markdown
vendored
10
.github/CONTRIBUTING.markdown
vendored
@@ -49,7 +49,7 @@ That's it! You'll be automatically subscribed to receive updates as others revie
|
||||
### Submitting a pull request via Git command line
|
||||
|
||||
1. Fork the project by clicking "Fork" in the top right corner of [`jekyll/jekyll`](https://github.com/jekyll/jekyll).
|
||||
2. Clone the repository lcoally `git clone https://github.com/<you-username>/jekyll`.
|
||||
2. Clone the repository locally `git clone https://github.com/<you-username>/jekyll`.
|
||||
3. Create a new, descriptively named branch to contain your change ( `git checkout -b my-awesome-feature` ).
|
||||
4. Hack away, add tests. Not necessarily in that order.
|
||||
5. Make sure everything still passes by running `script/cibuild` (see [the tests section](#running-tests-locally) below)
|
||||
@@ -62,13 +62,13 @@ We want the Jekyll documentation to be the best it can be. We've open-sourced ou
|
||||
|
||||
### How to submit changes
|
||||
|
||||
You can find the documentation for jekyllrb.com in the [site](https://github.com/jekyll/jekyll/tree/master/site) directory. See the section above, [submitting a pull request](#submitting-a-pull-request) for information on how to propose a change.
|
||||
You can find the documentation for jekyllrb.com in the [docs](https://github.com/jekyll/jekyll/tree/master/docs) directory. See the section above, [submitting a pull request](#submitting-a-pull-request) for information on how to propose a change.
|
||||
|
||||
One gotcha, all pull requests should be directed at the `master` branch (the default branch).
|
||||
|
||||
### Adding plugins
|
||||
|
||||
If you want to add your plugin to the [list of plugins](https://jekyllrb.com/docs/plugins/#available-plugins), please submit a pull request modifying the [plugins page source file](site/_docs/plugins.md) by adding a link to your plugin under the proper subheading depending upon its type.
|
||||
If you want to add your plugin to the [list of plugins](https://jekyllrb.com/docs/plugins/#available-plugins), please submit a pull request modifying the [plugins page source file](https://github.com/jekyll/jekyll/blob/master/docs/_docs/plugins.md) by adding a link to your plugin under the proper subheading depending upon its type.
|
||||
|
||||
## Code Contributions
|
||||
|
||||
@@ -80,7 +80,7 @@ Any time you propose a code change, you should also include updates to the docum
|
||||
|
||||
#### Documentation
|
||||
|
||||
If your contribution changes any Jekyll behavior, make sure to update the documentation. Documentation lives in the `site/_docs` folder (spoiler alert: it's a Jekyll site!). If the docs are missing information, please feel free to add it in. Great docs make a great project. Include changes to the documentation within your pull request, and once merged, `jekyllrb.com` will be updated.
|
||||
If your contribution changes any Jekyll behavior, make sure to update the documentation. Documentation lives in the `docs/_docs` folder (spoiler alert: it's a Jekyll site!). If the docs are missing information, please feel free to add it in. Great docs make a great project. Include changes to the documentation within your pull request, and once merged, `jekyllrb.com` will be updated.
|
||||
|
||||
#### Tests
|
||||
|
||||
@@ -90,7 +90,7 @@ If your contribution changes any Jekyll behavior, make sure to update the docume
|
||||
|
||||
### Code contributions generally
|
||||
|
||||
* Jekyll follows the [GitHub Ruby Styleguide](https://github.com/styleguide/ruby).
|
||||
* Jekyll uses the [Rubocop](https://github.com/bbatsov/rubocop) static analyzer to ensure that contributions follow the [GitHub Ruby Styleguide](https://github.com/styleguide/ruby). Please check your code using `script/fmt` and resolve any errors before pushing your branch.
|
||||
|
||||
* Don't bump the Gem version in your pull request (if you don't know what that means, you probably didn't).
|
||||
|
||||
|
||||
74
.github/ISSUE_TEMPLATE.md
vendored
74
.github/ISSUE_TEMPLATE.md
vendored
@@ -1,20 +1,82 @@
|
||||
###### What version of Jekyll are you using (`jekyll -v`)?
|
||||
<!--
|
||||
Hi! Thanks for considering to file a bug with Jekyll. Please take the time to
|
||||
answer the basic questions. You can convert `[ ]` into `[x]` to check boxes (or submit
|
||||
and check.) If there is no need for certain fields like output and redirection, please delete
|
||||
those headers before submitting. We know not all tickets require those steps.
|
||||
Otherwise, please try to be as detailed as possible.
|
||||
|
||||
If you are unsure this is a bug in Jekyll, or this is a bug caused
|
||||
by a plugin that isn't directly related to Jekyll, or if this is just
|
||||
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.
|
||||
|
||||
###### What operating system are you using?
|
||||
Thanks!
|
||||
-->
|
||||
|
||||
- [ ] I believe this to be a bug, not a question about using Jekyll.
|
||||
- [ ] I updated to the latest Jekyll (or) if on GitHub Pages to the latest `github-pages`
|
||||
- [ ] I read the CONTRIBUTION file at https://jekyllrb.com/docs/contributing/
|
||||
- [ ] This is a feature request.
|
||||
|
||||
---
|
||||
|
||||
###### What did you do?
|
||||
(Please include the content causing the issue, any relevant configuration settings, and the command you ran)
|
||||
- [ ] I am on (or have tested on) ***macOS*** 10+
|
||||
- [ ] I am on (or have tested on) ***Debian/Ubuntu*** GNU/Linux
|
||||
- [ ] I am on (or have tested on) ***Fedora*** GNU/Linux
|
||||
- [ ] I am on (or have tested on) ***Arch*** GNU/Linux
|
||||
- [ ] I am on (or have tested on) ***Other*** GNU/Linux
|
||||
- [ ] I am on (or have tested on) ***Windows*** 10+
|
||||
|
||||
<!--
|
||||
Other GNU/Linux includes Scientific GNU/Linux, CentOS GNU/Linux, and others.
|
||||
If you are on a minor sub-distro (such as ElementaryOS which does not diverge from
|
||||
Ubuntu much, please check the parent distro. Kubuntu, Edubuntu, Lubuntu should
|
||||
also be flagged as Ubuntu as their packages come from upstream Ubuntu.
|
||||
-->
|
||||
|
||||
---
|
||||
|
||||
###### What did you expect to see?
|
||||
- [ ] I was trying to install.
|
||||
- [ ] There is a broken Plugin API.
|
||||
- [ ] I had an error on GitHub Pages, and I have reproduced it locally.
|
||||
- [ ] I had an error on GitHub Pages, and GitHub Support said it was a Jekyll Bug.
|
||||
- [ ] I had an error on GitHub Pages and I did not test it locally.
|
||||
- [ ] I was trying to build.
|
||||
- [ ] It was another bug.
|
||||
|
||||
## My Reproduction Steps
|
||||
|
||||
<!--
|
||||
If this error occured 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.)
|
||||
|
||||
###### What did you see instead?
|
||||
If you have trouble finding your logs, please email support@github.com and
|
||||
they will happily help you. If you cannot find logs, please try your best to
|
||||
replicate it locally because we cannot fix a problem if we do not know
|
||||
exactly what caused it, or within a relatively close distance.
|
||||
-->
|
||||
|
||||
<!--
|
||||
Insert the steps you took to for this problem to exist. Such as the
|
||||
directories you created and, the full command you ran, and include any
|
||||
plugins you have installed, this is very important.
|
||||
|
||||
If your steps are complicated, you can also submit a GitHub
|
||||
repository (please no zips, they will be removed and rejected by maintainers,)
|
||||
and just supply a command for us to reproduce it ourselves.
|
||||
-->
|
||||
|
||||
## The Output I Wanted
|
||||
|
||||
<!--
|
||||
Insert the output from the command. Alter it as little as you can.
|
||||
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)
|
||||
|
||||
1
.gitignore
vendored
1
.gitignore
vendored
@@ -13,6 +13,7 @@
|
||||
/vendor
|
||||
Gemfile.lock
|
||||
_site/
|
||||
bin/
|
||||
bbin/
|
||||
coverage
|
||||
gh-pages/
|
||||
|
||||
203
.rubocop.yml
203
.rubocop.yml
@@ -1,80 +1,131 @@
|
||||
Metrics/MethodLength: { Max: 24 }
|
||||
Metrics/ClassLength: { Max: 240 }
|
||||
Metrics/ModuleLength: { Max: 240 }
|
||||
Metrics/LineLength: { Max: 112 }
|
||||
Metrics/CyclomaticComplexity: { Max: 8 }
|
||||
Metrics/PerceivedComplexity: { Max: 8 }
|
||||
Metrics/ParameterLists: { Max: 4 }
|
||||
Metrics/MethodLength: { Max: 24 }
|
||||
Metrics/AbcSize: { Max: 20 }
|
||||
|
||||
Style/IndentHash: { EnforcedStyle: consistent }
|
||||
Style/HashSyntax: { EnforcedStyle: hash_rockets }
|
||||
Style/SignalException: { EnforcedStyle: only_raise }
|
||||
Style/AlignParameters: { EnforcedStyle: with_fixed_indentation }
|
||||
Style/StringLiteralsInInterpolation: { EnforcedStyle: double_quotes }
|
||||
Style/MultilineMethodCallIndentation: { EnforcedStyle: indented }
|
||||
Style/MultilineOperationIndentation: { EnforcedStyle: indented }
|
||||
Style/FirstParameterIndentation: { EnforcedStyle: consistent }
|
||||
Style/StringLiterals: { EnforcedStyle: double_quotes }
|
||||
Style/RegexpLiteral: { EnforcedStyle: slashes }
|
||||
Style/IndentArray: { EnforcedStyle: consistent }
|
||||
Style/ExtraSpacing: { AllowForAlignment: true }
|
||||
|
||||
Style/PercentLiteralDelimiters:
|
||||
PreferredDelimiters:
|
||||
'%q': '{}'
|
||||
'%Q': '{}'
|
||||
'%r': '!!'
|
||||
'%s': '()'
|
||||
'%w': '()'
|
||||
'%W': '()'
|
||||
'%x': '()'
|
||||
|
||||
Style/AlignArray: { Enabled: false }
|
||||
Style/StringLiterals: { Enabled: false }
|
||||
Style/Documentation: { Enabled: false }
|
||||
Style/DoubleNegation: { Enabled: false }
|
||||
Style/UnneededCapitalW: { Enabled: false }
|
||||
Style/EmptyLinesAroundModuleBody: { Enabled: false }
|
||||
Style/EmptyLinesAroundAccessModifier: { Enabled: false }
|
||||
Style/BracesAroundHashParameters: { Enabled: false }
|
||||
Style/SpaceInsideBrackets: { Enabled: false }
|
||||
Style/IfUnlessModifier: { Enabled: false }
|
||||
Style/ModuleFunction: { Enabled: false }
|
||||
Style/RescueModifier: { Enabled: false }
|
||||
Style/GuardClause: { Enabled: false }
|
||||
Style/FileName: { Enabled: false }
|
||||
Lint/UselessAccessModifier: { Enabled: false }
|
||||
Style/SpaceAroundOperators: { Enabled: false }
|
||||
Style/RedundantReturn: { Enabled: false }
|
||||
Style/SingleLineMethods: { Enabled: false }
|
||||
|
||||
---
|
||||
AllCops:
|
||||
TargetRubyVersion: 2.0
|
||||
Include:
|
||||
- lib/**/*.rb
|
||||
|
||||
- lib/**/*.rb
|
||||
Exclude:
|
||||
- .rubocop.yml
|
||||
- .codeclimate.yml
|
||||
- .travis.yml
|
||||
- .gitignore
|
||||
- .rspec
|
||||
|
||||
- Gemfile.lock
|
||||
- CHANGELOG.{md,markdown,txt,textile}
|
||||
- CONTRIBUTING.{md,markdown,txt,textile}
|
||||
- readme.{md,markdown,txt,textile}
|
||||
- README.{md,markdown,txt,textile}
|
||||
- Readme.{md,markdown,txt,textile}
|
||||
- ReadMe.{md,markdown,txt,textile}
|
||||
- COPYING
|
||||
- LICENSE
|
||||
|
||||
- site/**/*
|
||||
- test/**/*
|
||||
- vendor/**/*
|
||||
- features/**/*
|
||||
- script/**/*
|
||||
- spec/**/*
|
||||
- lib/jekyll/renderer.rb
|
||||
- bin/**/*
|
||||
- exe/**/*
|
||||
- benchmark/**/*
|
||||
- script/**/*
|
||||
- vendor/**/*
|
||||
Lint/EndAlignment:
|
||||
Severity: error
|
||||
Lint/UnreachableCode:
|
||||
Severity: error
|
||||
Lint/UselessAccessModifier:
|
||||
Enabled: false
|
||||
Metrics/AbcSize:
|
||||
Max: 21
|
||||
Metrics/BlockLength:
|
||||
Exclude:
|
||||
- test/**/*.rb
|
||||
- lib/jekyll/configuration.rb
|
||||
Metrics/ClassLength:
|
||||
Exclude:
|
||||
- !ruby/regexp /features\/.*.rb$/
|
||||
- !ruby/regexp /test\/.*.rb$/
|
||||
Max: 300
|
||||
Metrics/CyclomaticComplexity:
|
||||
Max: 9
|
||||
Metrics/LineLength:
|
||||
Exclude:
|
||||
- !ruby/regexp /features\/.*.rb/
|
||||
Max: 90
|
||||
Severity: warning
|
||||
Metrics/MethodLength:
|
||||
CountComments: false
|
||||
Max: 20
|
||||
Severity: error
|
||||
Metrics/ModuleLength:
|
||||
Max: 240
|
||||
Metrics/ParameterLists:
|
||||
Max: 4
|
||||
Metrics/PerceivedComplexity:
|
||||
Max: 8
|
||||
Style/Alias:
|
||||
Enabled: false
|
||||
Style/AlignArray:
|
||||
Enabled: false
|
||||
Style/AlignHash:
|
||||
EnforcedHashRocketStyle: table
|
||||
Style/AlignParameters:
|
||||
Enabled: false
|
||||
EnforcedStyle: with_fixed_indentation
|
||||
Style/AndOr:
|
||||
Severity: error
|
||||
Style/Attr:
|
||||
Enabled: false
|
||||
Style/BracesAroundHashParameters:
|
||||
Enabled: false
|
||||
Style/ClassAndModuleChildren:
|
||||
Enabled: false
|
||||
Style/Documentation:
|
||||
Enabled: false
|
||||
Exclude:
|
||||
- !ruby/regexp /features\/.*.rb$/
|
||||
Style/DoubleNegation:
|
||||
Enabled: false
|
||||
Style/EmptyLinesAroundAccessModifier:
|
||||
Enabled: false
|
||||
Style/EmptyLinesAroundModuleBody:
|
||||
Enabled: false
|
||||
Style/ExtraSpacing:
|
||||
AllowForAlignment: true
|
||||
Style/FileName:
|
||||
Enabled: false
|
||||
Style/FirstParameterIndentation:
|
||||
EnforcedStyle: consistent
|
||||
Style/GuardClause:
|
||||
Enabled: false
|
||||
Style/HashSyntax:
|
||||
EnforcedStyle: hash_rockets
|
||||
Severity: error
|
||||
Style/IfUnlessModifier:
|
||||
Enabled: false
|
||||
Style/IndentArray:
|
||||
EnforcedStyle: consistent
|
||||
Style/IndentHash:
|
||||
EnforcedStyle: consistent
|
||||
Style/IndentationWidth:
|
||||
Severity: error
|
||||
Style/ModuleFunction:
|
||||
Enabled: false
|
||||
Style/MultilineMethodCallIndentation:
|
||||
EnforcedStyle: indented
|
||||
Style/MultilineOperationIndentation:
|
||||
EnforcedStyle: indented
|
||||
Style/MultilineTernaryOperator:
|
||||
Severity: error
|
||||
Style/PercentLiteralDelimiters:
|
||||
PreferredDelimiters:
|
||||
"%q": "{}"
|
||||
"%Q": "{}"
|
||||
"%r": "!!"
|
||||
"%s": "()"
|
||||
"%w": "()"
|
||||
"%W": "()"
|
||||
"%x": "()"
|
||||
Style/RedundantReturn:
|
||||
Enabled: false
|
||||
Style/RedundantSelf:
|
||||
Enabled: false
|
||||
Style/RegexpLiteral:
|
||||
EnforcedStyle: percent_r
|
||||
Style/RescueModifier:
|
||||
Enabled: false
|
||||
Style/SignalException:
|
||||
EnforcedStyle: only_raise
|
||||
Style/SingleLineMethods:
|
||||
Enabled: false
|
||||
Style/SpaceAroundOperators:
|
||||
Enabled: false
|
||||
Style/SpaceInsideBrackets:
|
||||
Enabled: false
|
||||
Style/StringLiterals:
|
||||
EnforcedStyle: double_quotes
|
||||
Style/StringLiteralsInInterpolation:
|
||||
EnforcedStyle: double_quotes
|
||||
Style/UnneededCapitalW:
|
||||
Enabled: false
|
||||
|
||||
31
.travis.yml
31
.travis.yml
@@ -1,4 +1,3 @@
|
||||
before_script: bundle update
|
||||
bundler_args: --without benchmark:site:development
|
||||
script: script/cibuild
|
||||
cache: bundler
|
||||
@@ -6,35 +5,31 @@ language: ruby
|
||||
sudo: false
|
||||
|
||||
rvm:
|
||||
- &ruby1 2.3.0
|
||||
- &ruby2 2.2.4
|
||||
- &ruby3 2.1.8
|
||||
- &jruby jruby-9.0.4.0
|
||||
- &rhead ruby-head
|
||||
- &ruby1 2.3.1
|
||||
- &ruby2 2.2.5
|
||||
- &ruby3 2.1.9
|
||||
- &jruby jruby-9.1.2.0
|
||||
|
||||
matrix:
|
||||
fast_finish: true
|
||||
allow_failures:
|
||||
include:
|
||||
- rvm: *ruby1
|
||||
env: TEST_SUITE=fmt
|
||||
- rvm: *ruby1
|
||||
env: TEST_SUITE=default-site
|
||||
exclude:
|
||||
- rvm: *jruby
|
||||
- rvm: *rhead
|
||||
env: TEST_SUITE=cucumber
|
||||
|
||||
env:
|
||||
matrix:
|
||||
- TEST_SUITE=test
|
||||
- TEST_SUITE=cucumber
|
||||
|
||||
branches:
|
||||
only:
|
||||
- master
|
||||
- themes
|
||||
|
||||
notifications:
|
||||
irc:
|
||||
template: "%{repository}#%{build_number} (%{branch}) %{message} %{build_url}"
|
||||
channels: irc.freenode.org#jekyll
|
||||
|
||||
email:
|
||||
recipients:
|
||||
- jordon@envygeeks.io
|
||||
|
||||
slack:
|
||||
secure: "\
|
||||
dNdKk6nahNURIUbO3ULhA09/vTEQjK0fNbgjVjeYPEvROHgQBP1cIP3AJy8aWs8rl5Yyow4Y\
|
||||
|
||||
26
Gemfile
26
Gemfile
@@ -2,9 +2,12 @@ source "https://rubygems.org"
|
||||
gemspec :name => "jekyll"
|
||||
|
||||
gem "rake", "~> 11.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 "rubocop", :branch => :master, :github => "bbatsov/rubocop"
|
||||
gem "pry"
|
||||
|
||||
unless RUBY_ENGINE == "jruby"
|
||||
@@ -15,13 +18,17 @@ end
|
||||
#
|
||||
|
||||
group :test do
|
||||
gem "rubocop", "~> 0.44.1"
|
||||
gem "cucumber", "~> 2.1"
|
||||
gem "jekyll_test_plugin"
|
||||
gem "jekyll_test_plugin_malicious"
|
||||
gem "codeclimate-test-reporter"
|
||||
gem "codeclimate-test-reporter", "~> 0.6.0"
|
||||
gem "rspec-mocks"
|
||||
gem "nokogiri"
|
||||
gem "rspec"
|
||||
gem "test-theme", path: File.expand_path("./test/fixtures/test-theme", File.dirname(__FILE__))
|
||||
|
||||
gem "jruby-openssl" if RUBY_ENGINE == "jruby"
|
||||
end
|
||||
|
||||
#
|
||||
@@ -56,16 +63,16 @@ group :jekyll_optional_dependencies do
|
||||
gem "toml", "~> 0.1.0"
|
||||
gem "coderay", "~> 1.1.0"
|
||||
gem "jekyll-docs", :path => '../docs' if Dir.exist?('../docs') && ENV['JEKYLL_VERSION']
|
||||
gem "jekyll-gist", "~> 1.0"
|
||||
gem "jekyll-feed", "~> 0.1.3"
|
||||
gem "jekyll-coffeescript", "~> 1.0"
|
||||
gem "jekyll-redirect-from", "~> 0.9.1"
|
||||
gem "jekyll-paginate", "~> 1.0"
|
||||
gem "jekyll-gist"
|
||||
gem "jekyll-feed"
|
||||
gem "jekyll-coffeescript"
|
||||
gem "jekyll-redirect-from"
|
||||
gem "jekyll-paginate"
|
||||
gem "mime-types", "~> 3.0"
|
||||
gem "kramdown", "~> 1.9"
|
||||
gem "rdoc", "~> 4.2"
|
||||
|
||||
platform :ruby, :mswin, :mingw do
|
||||
platform :ruby, :mswin, :mingw, :x64_mingw do
|
||||
gem "rdiscount", "~> 2.0"
|
||||
gem "pygments.rb", "~> 0.6.0"
|
||||
gem "redcarpet", "~> 3.2", ">= 3.2.3"
|
||||
@@ -83,6 +90,7 @@ group :site do
|
||||
|
||||
gem "jemoji", "0.5.1"
|
||||
gem "jekyll-sitemap"
|
||||
gem "jekyll-seo-tag", "~> 1.1"
|
||||
gem "jekyll-seo-tag"
|
||||
gem "jekyll-avatar"
|
||||
gem "jekyll-mentions"
|
||||
end
|
||||
|
||||
369
History.markdown
369
History.markdown
@@ -1,35 +1,255 @@
|
||||
## HEAD
|
||||
## 3.3.1 / 2016-11-14
|
||||
|
||||
### Minor Enhancements
|
||||
|
||||
* Collapse `gsub` for performance (#5494)
|
||||
* URL: warn if key doesn't exist in url drop (#5524)
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* Fix typo in `theme_template` README (#5472)
|
||||
* Do not swallow all exceptions on render (#5495)
|
||||
* Site template: fixed `_config.yml` comment typo (#5511)
|
||||
* `jekyll new-theme` should specify Jekyll as a runtime dependency for the theme (#5457)
|
||||
* Be much more specific about ignoring specific vendored directories. (#5564)
|
||||
* Only warn about auto-regeneration bug on Bash On Windows. (#5464)
|
||||
* Allow permalink template to have underscores (#5572)
|
||||
|
||||
### Site Enhancements
|
||||
|
||||
* Documentation: `link` Liquid tag (#5449)
|
||||
* Updating install instruction link for Jekyll 3 on Windows (#5475)
|
||||
* Update normalize.css to v5.0.0 (#5471)
|
||||
* Add jekyll-data to the list of plugins (#5491)
|
||||
* Add info about checking version + updating (#5497)
|
||||
* Add jekyll-include-absolute-plugin to list of third-party plugins (#5492)
|
||||
* Remove jekyll-hook from deployment methods (#5502)
|
||||
* Update deployment-methods.md (#5504)
|
||||
* Ubuntu users should install ruby2.3-dev (#5512)
|
||||
* Remove Glynn as deployment option (#5519)
|
||||
* Fix broken forum link (#5466)
|
||||
* Move documentation to docs folder (#5459)
|
||||
* Fix broken links in CONTRIBUTING (#5533)
|
||||
* Update documentation on jekyllrb.com (#5540)
|
||||
* Fix HTML rendering (#5536)
|
||||
* Remove outdated deployment information (#5557)
|
||||
* no more invalid US-ASCII on lines 30 and 97 (#5520)
|
||||
* Add permalinks to docs in '/maintaining/' (#5532)
|
||||
* Add jekyll-pinboard to list of third-party plugins (#5514)
|
||||
* Fix formatting in 2-to-3.md (#5507)
|
||||
* Add two plugins to the plugins page (#5493)
|
||||
* Use site.baseurl before link and post_url tags (#5559)
|
||||
* Fix link to jekyll-pinboard plugin (#5570)
|
||||
* mention `docs` folder as a way to deploy on GitHub Pages (#5571)
|
||||
|
||||
### Development Fixes
|
||||
|
||||
* fix rubocop errors on testing with Rubocop 0.44 (#5489)
|
||||
* script/test: add missing whitespace (#5479)
|
||||
* Restrict Rubocop version (#5496)
|
||||
* include a hashbang for all benchmark scripts & make them executable (#5505)
|
||||
* Update source in script/proof (#5538)
|
||||
* Collections.feature: conditional steps to have it pass on Windows (#5546)
|
||||
* Fix tests to get script/test to pass on Windows (#5526)
|
||||
|
||||
## 3.3.0 / 2016-10-06
|
||||
|
||||
### Minor Enhancements
|
||||
|
||||
* Colorize interpolated output in logger.info (#5239)
|
||||
* Site template: exclude Gemfile and Gemfile.lock in site config (#5293)
|
||||
* Fix #5233: Increase our ability to detect Windows. (#5235)
|
||||
* update gitignore template to ignore theme gems built by user (#5326)
|
||||
* Adds ability to link to all files (#5199)
|
||||
* Exclude vendor by default (#5361)
|
||||
* Add ThemeAssetsReader which reads assets from a theme (#5364)
|
||||
* Add bundle install to jekyll new command (#5237)
|
||||
* Add absolute_url and relative_url filters. (#5399)
|
||||
* Site template: remove `css/` from new site scaffolding (#5402)
|
||||
* Site template: Move contents of the index.html page to the 'home' layout (#5420)
|
||||
* Exclude node_modules by default (#5210)
|
||||
* Run hooks in priority order. (#5157)
|
||||
* Add `static_file.name` and `.basename` Liquid attributes (#5264)
|
||||
* set site.url in dev environment to `http://localhost:4000` (#5431)
|
||||
* Add support for indented link references on excerpt (#5212)
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* Use jekyll-feed to generate the default site's RSS feed (#5196)
|
||||
* Site#configure_theme: do not set theme unless it's a string (#5189)
|
||||
* Convertible: set self.output in #render_all_layouts and #do_layout (#5337)
|
||||
* Only complain about `kramdown.coderay` if it is actually in the config (#5380)
|
||||
* Clarify documentation in theme gem's README template (#5376)
|
||||
* Allow underscore in highlighter language (#5375)
|
||||
* Site template: set empty url in config file by default (#5338)
|
||||
* Site template config: prepend 'jekyll serve' with 'bundle exec' (#5430)
|
||||
* Don't call `File.utime` for StaticFiles if it's a symlink (#5427)
|
||||
* Fix handling of non-ASCII characters in new `*_url` filters (#5410)
|
||||
* Remove autoload of Draft which no longer exists. (#5441)
|
||||
* Fix issue where Windows drive name is stripped from Jekyll.sanitized_path incorrectly (#5256)
|
||||
* Fix bug where `post_url` tag matched incorrect post with subdirectory (#4873)
|
||||
* Fix loading data from subdir with a period in name (#5433)
|
||||
* Revert Commands::Serve#server_address signature change. (#5456)
|
||||
|
||||
### Site Enhancements
|
||||
|
||||
* Document `to_integer` and `inspect` filters (#5185)
|
||||
* Fix path in the prompt (#5194)
|
||||
* need subcommand build (#5190)
|
||||
* Add the Jekyll Cloudinary plugin (#5183)
|
||||
* Documentation : `new-theme` command (#5205)
|
||||
* Document `link` Liquid tag (#5182)
|
||||
* Remove mention of page for link tag in release post (#5214)
|
||||
* fixed typo (#5226)
|
||||
* Add missing comma (#5222)
|
||||
* Maintain aspect ratio with `height: auto;` (#5254)
|
||||
* Fix a link in deployment-methods.md (#5244)
|
||||
* Documentation: improve highlight in `Creating a theme` (#5249)
|
||||
* Bundler isn't installed by default (#5258)
|
||||
* Update troubleshooting documentation to include fix for issue with vendored gems (#5271)
|
||||
* Link `--lsi` option's description to Wikipedia docs on LSI (#5274)
|
||||
* Document `--profile` option on the configuration page (#5279)
|
||||
* Update homepage to sync with merge of #5258 (#5287)
|
||||
* Add post about Jekyll Admin initial release (#5291)
|
||||
* Replace liquid highlight tag with backticks (#5262)
|
||||
* Word update (#5294)
|
||||
* Site documentation section links always point to https://jekyllrb.com (#5281)
|
||||
* Missing `:site, :post_render` payload documentation on site (#5280)
|
||||
* 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 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)
|
||||
* Fix small typo in docs (#5347)
|
||||
* Add missing period to sentence in first paragraph. (#5372)
|
||||
* added jekyll-spotify plugin (#5369)
|
||||
* Add jekyll-menus to the list of plugins. (#5397)
|
||||
* macOS and one grammar fix (#5403)
|
||||
* 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)
|
||||
* Replace classic box-sizing reset with inheritance reset (#5411)
|
||||
* Update Wikipedia YAML list link (#5452)
|
||||
* Add Jekyll 3.3 release post (#5442)
|
||||
|
||||
### Development Fixes
|
||||
|
||||
* 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)
|
||||
* Proposal: Affinity teams and their captains (#5273)
|
||||
* Replace duplicate with postive 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)
|
||||
* Proxy a number of Convertible methods to Renderer (#5308)
|
||||
* Run executable for Cucumber via Ruby instead of Shell (#5383)
|
||||
* Appease Rubocop (#5381)
|
||||
* remove features' directories on windows with proper access (#5389)
|
||||
* `site_configuration.feature`: use UTC format in timezone (#5416)
|
||||
* swallow bundle output from `jekyll new` while in CI (#5408)
|
||||
* Add .editorconfig (#5412)
|
||||
|
||||
## 3.2.1 / 2016-08-02
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* Include theme directories in default gemspec (#5152)
|
||||
* Fix for symlinked themes (#5156)
|
||||
* Layout: set `relative_path` without using Pathname (#5164)
|
||||
|
||||
### Development Fixes
|
||||
|
||||
* Add test to build the default site (#5154)
|
||||
* script/default-site: specify `BUNDLE_GEMFILE` for new site (#5178)
|
||||
* script/default-site: read Jekyll source from local clone (#5188)
|
||||
|
||||
### Site Enhancements
|
||||
|
||||
* Enable site excerpts (#5150)
|
||||
* Initial 404 page (#5143)
|
||||
* Remove the "this feature is unreleased" warning from the theme docs (#5158)
|
||||
* Future True on GitHub Pages note (#5173)
|
||||
* Minor updates and corrections (#5177)
|
||||
* index.html: update instructions to require bundler (#5169)
|
||||
* docs/quickstart: update instructions to require bundler (#5168)
|
||||
|
||||
## 3.2.0 / 2016-07-26
|
||||
|
||||
### Minor Enhancements
|
||||
|
||||
* Stop testing with Ruby 2.0.x, which is EOL'd. (#4381)
|
||||
* Allow collections to have documents that have no file extension (#4545)
|
||||
* Add size property to group_by result (#4557)
|
||||
* 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)
|
||||
* 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)
|
||||
* Clean up Tags::PostUrl a bit, including better errors and date parsing (#4670)
|
||||
* Use String#encode for xml_escape filter instead of CGI.escapeHTML (#4694)
|
||||
* Add show_dir_listing option for serve command and fix index file names (#4533)
|
||||
* Clean up `Tags::PostUrl` a bit, including better errors and date parsing (#4670)
|
||||
* Use `String#encode` for `xml_escape` filter instead of `CGI.escapeHTML` (#4694)
|
||||
* Add `show_dir_listing` option for serve command and fix index file names (#4533)
|
||||
* Site Template: write a Gemfile which is educational to the new site (#4542)
|
||||
* Site template: add explanation of site variables in the example `_config.yml` (#4704)
|
||||
* Adds `link` Liquid tag to make generation of URL's easier (#4624)
|
||||
* Allow static files to be symlinked in unsafe mode or non-prod environments (#4640)
|
||||
* Add `:after_init` hook & add `Site#config=` to make resetting config easy (#4703)
|
||||
* DocumentDrop: add `#<=>` which sorts by date (falling back to path) (#4741)
|
||||
* Add a `where_exp` filter for filtering by expression (#4478)
|
||||
* Globalize Jekyll's Filters. (#4792)
|
||||
* Gem-based themes (#4595)
|
||||
* Allow symlinks if they point to stuff inside `site.source` (#4710)
|
||||
* Update colorator dependency to v1.x (#4855)
|
||||
* Move EntryFilter to use Pathutil & fix `glob_include?` (#4859)
|
||||
* Add 'jekyll new-theme' command to help users get up and running creating a theme (#4848)
|
||||
* `markdownify` and `smartify` should convert input to string before conversion (#4958)
|
||||
* Run `Site#generate` for 'jekyll doctor' to catch plugin issues (#5005)
|
||||
* Add `normalize_whitepace` filter (#4917)
|
||||
* Move bin/jekyll to exe/jekyll to prevent collision with binstubs (#5014)
|
||||
* Cleaning up site template & theme updates. (#4922)
|
||||
* Add fetch method to Drops (#5056)
|
||||
* Extract tag name to class method (#5063)
|
||||
* check if relative URL contains a colon (#5069)
|
||||
* Enable strict (or lax) liquid parsing via a config variable. (#5053)
|
||||
* Add filter: `to_integer` (#5101)
|
||||
* watcher: pass site instance to watch plugin (#5109)
|
||||
* Show liquid warnings. (#5129)
|
||||
* Add `--baseurl` to `build` subcommand (#5135)
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* Site Template: Added a default lang attribute (#4633)
|
||||
* Site template: Escape title and description where it is used in HTML (#4606)
|
||||
* Document#date: drafts which have no date should use source file mtime (#4611)
|
||||
* Filters#time: clone an input Time so as to be non-destructive (#4590)
|
||||
* `Document#date`: drafts which have no date should use source file mtime (#4611)
|
||||
* `Filters#time`: clone an input Time so as to be non-destructive (#4590)
|
||||
* Doctor: fix issue where `--config` wasn't a recognized flag (#4598)
|
||||
* Ensures related_posts are only set for a post (#4620)
|
||||
* EntryFilter#special?: ignore filenames which begin with '~' (#4491)
|
||||
* Ensures `related_posts` are only set for a post (#4620)
|
||||
* `EntryFilter#special?`: ignore filenames which begin with `~` (#4491)
|
||||
* Cleaner: `keep_files` should only apply to the beginning of paths, not substrings with index > 0 (#3849)
|
||||
* Use SSLEnable instead of EnableSSL and make URL HTTPS. (#4693)
|
||||
* convertible: use `Document::YAML_FRONT_MATTER_REGEXP` to parse transformable files (#4786)
|
||||
* Example in the site template should be IANA-approved example.com (#4793)
|
||||
* 3.2.x/master: Fix defaults for Documents (posts/collection docs) (#4808)
|
||||
* Don't rescue LoadError or bundler load errors for Bundler. (#4857)
|
||||
* `Serve.process` should receive same config as `Build.process` (#4953)
|
||||
* Prevent reset of page in Liquid payload right before rendering layouts (#5009)
|
||||
* Add missing fields to ExcerptDrop (#5067)
|
||||
* Stringify configuration overrides before first use (#5060)
|
||||
* hooks: move `after_init` hook call at the end of `Site#initialize` (#5106)
|
||||
* filters: raise error if no input given to date filters (#5127)
|
||||
* `where_exp` filter should filter posts (#4860)
|
||||
|
||||
### Forward Ports
|
||||
|
||||
* From v3.1.4: Add ExcerptDrop and remove excerpt's ability to refer to itself in Liquid (#4941)
|
||||
* From v3.1.4: Configuration permalink fix and addition of Configuration.from and sorting `site.collections` by label (#4942)
|
||||
* From v3.1.4: Fix `{{ layout }}` oddities (proper inheritance & fixing overflow of old data) (#4943)
|
||||
* From v3.1.5: Sort the results of the `require_all` glob (#4944)
|
||||
* From v3.1.6: Add ability to render drops as JSON (#4945)
|
||||
|
||||
### Development Fixes
|
||||
|
||||
@@ -41,6 +261,56 @@
|
||||
* Update Rake & disable warnings when running tests (#4720)
|
||||
* Fix many warnings (#4537)
|
||||
* Don't blindly assume the last system when determining "open" cmd (#4717)
|
||||
* Fix "locally" typo in contributing documentation (#4756)
|
||||
* Update Rubocop rules (#4886)
|
||||
* Flesh out the issue template to be much more detailed (#4849)
|
||||
* Fixing rubocop offenses in lib/jekyll/cleaner.rb (#4892)
|
||||
* Update `jekyll/commands*` to pass rubocop rules (#4888)
|
||||
* Clean up many test files to pass Rubocop rules (#4902)
|
||||
* Rubocop cleanup for some utils and further test files (#4916)
|
||||
* Rubocop: Low hanging fruit (#4936)
|
||||
* Rubocop: `Drop` changes from v3.1 forward-ports (#4949)
|
||||
* Rubocop: cleanup for misc files (#4946)
|
||||
* Rubocop: Stevenson (#4951)
|
||||
* Rubocop: lib/jekyll/entry_filter.rb (#4950)
|
||||
* Rubocop: `test/*` (#4947)
|
||||
* Rubocop: features (#4934)
|
||||
* Rubocop: Liquid renderer (#4933)
|
||||
* Rubocop: converters (#4931)
|
||||
* Rubocop: Site Drop (#4948)
|
||||
* Rubocop: tags (#4938)
|
||||
* Rubocop: Readers (#4932)
|
||||
* rubocop: jekyll/lib/frontmatter_defaults.rb (#4974)
|
||||
* rubocop: features/step_definitions.rb (#4956)
|
||||
* Rubocop theme and url jekyll libs (#4959)
|
||||
* Rubocop jekyll.rb (#4966)
|
||||
* Rubocop: use %r for all regular expressions. (#4979)
|
||||
* Cleanup and make misc files compliant with Rubocop. (#4940)
|
||||
* Rubocop: jekyll/lib/site.rb (#4973)
|
||||
* Add timings for each scenario in cucumber & print worst offenders (#4908)
|
||||
* rubocop: jekyll/lib/filters.rb (#4993)
|
||||
* Fix rubocop offenses in exe/jekyll (#5017)
|
||||
* Rubocop: lib/jekyll/command.rb (#5018)
|
||||
* rubocop: lib/jekyll/static_file.rb (#5019)
|
||||
* rubocop: lib/jekyll/utils.rb (#5026)
|
||||
* rubocop: lib/jekyll/regenerator.rb (#5025)
|
||||
* rubocop: lib/jekyll/configuration.rb (#5024)
|
||||
* rubocop: lib/jekyll/renderer.rb style fixes (#5032)
|
||||
* rubocop: lib/jekyll/convertible.rb style fixes (#5031)
|
||||
* rubocop: lib/jekyll/document.rb style fixes (#5030)
|
||||
* Remove ruby-head from Travis matrix & fix jruby failures (#5015)
|
||||
* Remove useless statement from Configuration test (#5065)
|
||||
* Change baseurl to example.com for some test cases (#5068)
|
||||
* use activesupport < 5 if we are on a Ruby < 2.2.2 (#5100)
|
||||
* Internal documentation for working on Jekyll (#5011)
|
||||
* rubocop: lib/jekyll/collection.rb (#5022)
|
||||
* tests: Typo fixes. (#5114)
|
||||
* Normalize yml files. (#5116)
|
||||
* Whitespace cleanup. (#5113)
|
||||
* Add AppVeyor support. (#5115)
|
||||
* appveyor.yml: drop Ruby 2.0.0. (#5119)
|
||||
* Fix indentation in benchmark (#5124)
|
||||
* Style fixes for Rubocop 0.42.0 - var == 0 becomes var.zero? - when defining method_missing, also define respond_to_missing? (#5137)
|
||||
|
||||
### Site Enhancements
|
||||
|
||||
@@ -65,6 +335,78 @@
|
||||
* Add Hawkins to the list of third-party plugins (#4755)
|
||||
* Fix a typo in pagination doc (#4763)
|
||||
* Switch second GitHub Pages link to HTTPS (#4760)
|
||||
* Explain data file format requirements more clearly in documentation (#4781)
|
||||
* Add jekyll-i18n_tags to list of third-party plugins (#4775)
|
||||
* Remove Leonard Lamprecht's website from Sites page (#4771)
|
||||
* Updates documentation for collections to include `date` property (#4769)
|
||||
* Added an explicit rerun note to configuration.md, defaults section (#4734)
|
||||
* Update Rack-Jekyll Heroku deployment blog post url (#4789)
|
||||
* Added missing single quote on rsync client side command (#4813)
|
||||
* Organize Form Platforms-as-a-Service into unified list & add FormSpree.io (#4754)
|
||||
* Fixed typo on Configuration page (#4804)
|
||||
* Update FormKeep URL on the Resources doc (#4844)
|
||||
* site: use liquid & reduce some whitespace noise (#4854)
|
||||
* Add jekyll-breadcrumbs to list of third-party plugins (#4874)
|
||||
* Added Pug converter to list of third-party plugins (#4872)
|
||||
* Add jekyll-ideal-image-slider to list of third-party plugins (#4863)
|
||||
* Add Jekyll Tips and the Cheatsheet to the list of resources (#4887)
|
||||
* Removed extra `</p>` from `site/_docs/permalinks.md` (#4890)
|
||||
* Add pubstorm deployment instructions to docs (#4881)
|
||||
* Corrected pagination docs for hidden: true feature (#4903)
|
||||
* Remove a Broken Link for Refheap Plugin (#4971)
|
||||
* Instructions on how to install github-gem on Windows (#4975)
|
||||
* Minor tweak to fix missing apostrophne (#4962)
|
||||
* Instructions on how to install github-gem on Windows (v2) (#4977)
|
||||
* Fix inaccurate HTTP response header field name (#4976)
|
||||
* Add post about GSoC project (#4980)
|
||||
* Link to the HTML page instead of Markdown (#4985)
|
||||
* Update normalize.css to v4.0.0. (#4989)
|
||||
* Add jekyll-tags-list-plugin to list of third-party plugins (#5000)
|
||||
* Windows docs: Command needs to be called from blog path (#5006)
|
||||
* Update text to be consitent with example (#5010)
|
||||
* Update template links to point to core Liquid site (#5012)
|
||||
* Add generator-jekyllized to third-party plugins (#5027)
|
||||
* Add Jekyll Art Hallery generator plugin to list of third-party plugins (#5043)
|
||||
* Add Formingo to the list of Jekyll form SaaS (#5054)
|
||||
* Highlight help nav item when navigated to. (#5058)
|
||||
* Update normalize.css to v4.2.0. (#5096)
|
||||
* Updates html-proofer code (#5098)
|
||||
* Jekyll Community (#5097)
|
||||
* Typo in documentation file templates.md (#5117)
|
||||
* Slightly, improve PNG compression. (#5112)
|
||||
* docs: add jekyll-maps plugin reference (#5123)
|
||||
* docs: fix link to plugins page source (#5122)
|
||||
* Update the configuration docs to match the code (#5131)
|
||||
* Removed confusing word repetition. (#5139)
|
||||
* Add a note about script/fmt (#5138)
|
||||
|
||||
## 3.1.6 / 2016-05-19
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* Add ability to `jsonify` Drops such that, e.g. `site | jsonify`, works. (#4914)
|
||||
|
||||
## 3.1.5 / 2016-05-18
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* Sort the results of the `require_all` glob (affects Linux only). (#4912)
|
||||
|
||||
## 3.1.4 / 2016-05-18
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* Add `ExcerptDrop` and remove excerpt's ability to refer to itself in Liquid (#4907)
|
||||
* Configuration permalink fix where `collections.posts.permalink` inherits properly from `permalink` only when it doesn't exist (#4910)
|
||||
* Add `Configuration.from` to make it easier to build configs from just a hash
|
||||
* Sorting `site.collections` in Liquid by label (#4910)
|
||||
* Fix bug where `layout` in Liquid would inherit from previously-rendered layouts' metadatas (#4909)
|
||||
* Fix bug where `layout` in Liquid would override in the wrong direction (more-specific layouts' data were overwritten by their parent layouts' data; this has now been reversed) (#4909)
|
||||
|
||||
## 3.1.3 / 2016-04-18
|
||||
|
||||
* Fix defaults for Documents to lookup defaults based on `relative_path` instead of `url` (#4807)
|
||||
* Use SSLEnable instead of EnableSSL and make URL HTTPS (WEBrick) (#4693)
|
||||
|
||||
## 3.1.2 / 2016-02-19
|
||||
|
||||
@@ -213,6 +555,15 @@
|
||||
* Add Contentful Extension to list of third-party plugins (#4390)
|
||||
* Correct Minor spelling error (#4394)
|
||||
|
||||
## 3.0.5 / 2016-04-26
|
||||
|
||||
* Remove call to `#backwards_compatibilize` in `Configuration.from` (#4846)
|
||||
|
||||
## 3.0.4 / 2016-04-18
|
||||
|
||||
* Fix defaults for Documents to lookup defaults based on `relative_path` instead of `url` (#4806)
|
||||
* Configuration: allow users to specify a `collections.posts.permalink` directly without `permalink` clobbering it (#4753)
|
||||
|
||||
## 3.0.3 / 2016-02-08
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
@@ -1,10 +1,11 @@
|
||||
# [Jekyll](https://jekyllrb.com/)
|
||||
|
||||
[][ruby-gems]
|
||||
[][travis]
|
||||
[][coverage]
|
||||
[][codeclimate]
|
||||
[][gemnasium]
|
||||
[][travis]
|
||||
[][appveyor]
|
||||
[][coverage]
|
||||
[][codeclimate]
|
||||
[][gemnasium]
|
||||
[][hakiri]
|
||||
|
||||
[ruby-gems]: https://rubygems.org/gems/jekyll
|
||||
@@ -13,6 +14,7 @@
|
||||
[coverage]: https://codeclimate.com/github/jekyll/jekyll/coverage
|
||||
[hakiri]: https://hakiri.io/github/jekyll/jekyll/master
|
||||
[travis]: https://travis-ci.org/jekyll/jekyll
|
||||
[appveyor]: https://ci.appveyor.com/project/jekyll/jekyll/branch/master
|
||||
|
||||
Jekyll is a simple, blog-aware, static site generator perfect for personal, project, or organization sites. Think of it like a file-based CMS, without all the complexity. Jekyll takes your content, renders Markdown and Liquid templates, and spits out a complete, static website ready to be served by Apache, Nginx or another web server. Jekyll is the engine behind [GitHub Pages](https://pages.github.com), which you can use to host sites right from your GitHub repositories.
|
||||
|
||||
|
||||
6
Rakefile
6
Rakefile
@@ -27,6 +27,10 @@ def docs_name
|
||||
"#{name}-docs"
|
||||
end
|
||||
|
||||
def docs_folder
|
||||
"docs"
|
||||
end
|
||||
|
||||
def gemspec_file
|
||||
"#{name}.gemspec"
|
||||
end
|
||||
@@ -102,7 +106,7 @@ def siteify_file(file, overrides_front_matter = {})
|
||||
"note" => "This file is autogenerated. Edit /#{file} instead."
|
||||
}.merge(overrides_front_matter)
|
||||
contents = "#{front_matter.to_yaml}---\n\n#{content_for(file)}"
|
||||
File.write("site/_docs/#{slug}.md", contents)
|
||||
File.write("#{docs_folder}/_docs/#{slug}.md", contents)
|
||||
end
|
||||
|
||||
def content_for(file)
|
||||
|
||||
42
appveyor.yml
Normal file
42
appveyor.yml
Normal file
@@ -0,0 +1,42 @@
|
||||
version: "{build}"
|
||||
|
||||
clone_depth: 10
|
||||
|
||||
branches:
|
||||
only:
|
||||
- master
|
||||
- themes
|
||||
|
||||
build: off
|
||||
|
||||
install:
|
||||
- SET PATH=C:\Ruby%RUBY_FOLDER_VER%\bin;%PATH%
|
||||
- bundle install --retry 5 --jobs=%NUMBER_OF_PROCESSORS% --clean --path vendor\bundle
|
||||
|
||||
environment:
|
||||
BUNDLE_WITHOUT: "benchmark:site:development"
|
||||
matrix:
|
||||
- RUBY_FOLDER_VER: "23"
|
||||
TEST_SUITE: "test"
|
||||
- RUBY_FOLDER_VER: "23"
|
||||
TEST_SUITE: "cucumber"
|
||||
- RUBY_FOLDER_VER: "23"
|
||||
TEST_SUITE: "fmt"
|
||||
- RUBY_FOLDER_VER: "23"
|
||||
TEST_SUITE: "default-site"
|
||||
- RUBY_FOLDER_VER: "23-x64"
|
||||
TEST_SUITE: "test"
|
||||
- RUBY_FOLDER_VER: "22"
|
||||
TEST_SUITE: "test"
|
||||
- RUBY_FOLDER_VER: "21"
|
||||
TEST_SUITE: "test"
|
||||
|
||||
test_script:
|
||||
- ruby --version
|
||||
- gem --version
|
||||
- bundler --version
|
||||
- bash ./script/cibuild
|
||||
|
||||
cache:
|
||||
# If one of the files after the right arrow changes, cache will be skipped
|
||||
- 'vendor\bundle -> appveyor.yml,Gemfile,jekyll.gemspec'
|
||||
21
benchmark/capture-assign.rb
Executable file
21
benchmark/capture-assign.rb
Executable file
@@ -0,0 +1,21 @@
|
||||
#!/usr/bin/env ruby
|
||||
require "liquid"
|
||||
require "benchmark/ips"
|
||||
|
||||
puts "Ruby #{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}"
|
||||
puts "Liquid #{Liquid::VERSION}"
|
||||
|
||||
template1 = '{% capture foobar %}foo{{ bar }}{% endcapture %}{{ foo }}{{ foobar }}'
|
||||
template2 = '{% assign foobar = "foo" | append: bar %}{{ foobar }}'
|
||||
|
||||
def render(template)
|
||||
Liquid::Template.parse(template).render("bar" => "42")
|
||||
end
|
||||
|
||||
puts render(template1)
|
||||
puts render(template2)
|
||||
|
||||
Benchmark.ips do |x|
|
||||
x.report('capture') { render(template1) }
|
||||
x.report('assign') { render(template2) }
|
||||
end
|
||||
1
benchmark/end-with-vs-regexp
Normal file → Executable file
1
benchmark/end-with-vs-regexp
Normal file → Executable file
@@ -1,3 +1,4 @@
|
||||
#!/usr/bin/env ruby
|
||||
require 'benchmark/ips'
|
||||
|
||||
Benchmark.ips do |x|
|
||||
|
||||
0
benchmark/file-dir-ensure-trailing-slash
Normal file → Executable file
0
benchmark/file-dir-ensure-trailing-slash
Normal file → Executable file
1
benchmark/flat-map
Normal file → Executable file
1
benchmark/flat-map
Normal file → Executable file
@@ -1,3 +1,4 @@
|
||||
#!/usr/bin/env ruby
|
||||
require 'benchmark/ips'
|
||||
|
||||
enum = (0..50).to_a
|
||||
|
||||
1
benchmark/hash-fetch
Normal file → Executable file
1
benchmark/hash-fetch
Normal file → Executable file
@@ -1,3 +1,4 @@
|
||||
#!/usr/bin/env ruby
|
||||
require 'benchmark/ips'
|
||||
|
||||
h = {:bar => 'uco'}
|
||||
|
||||
0
benchmark/jekyll-sanitize-path
Normal file → Executable file
0
benchmark/jekyll-sanitize-path
Normal file → Executable file
1
benchmark/proc-call-vs-yield
Normal file → Executable file
1
benchmark/proc-call-vs-yield
Normal file → Executable file
@@ -1,3 +1,4 @@
|
||||
#!/usr/bin/env ruby
|
||||
require 'benchmark/ips'
|
||||
|
||||
def fast
|
||||
|
||||
0
benchmark/regexp-vs-include.rb
Normal file → Executable file
0
benchmark/regexp-vs-include.rb
Normal file → Executable file
1
benchmark/sequential-assignment
Normal file → Executable file
1
benchmark/sequential-assignment
Normal file → Executable file
@@ -1,3 +1,4 @@
|
||||
#!/usr/bin/env ruby
|
||||
require 'benchmark/ips'
|
||||
|
||||
Benchmark.ips do |x|
|
||||
|
||||
1
benchmark/string-concat
Normal file → Executable file
1
benchmark/string-concat
Normal file → Executable file
@@ -1,3 +1,4 @@
|
||||
#!/usr/bin/env ruby
|
||||
require 'benchmark/ips'
|
||||
|
||||
url = "http://jekyllrb.com"
|
||||
|
||||
1
benchmark/string-replacement
Normal file → Executable file
1
benchmark/string-replacement
Normal file → Executable file
@@ -1,3 +1,4 @@
|
||||
#!/usr/bin/env ruby
|
||||
require 'benchmark/ips'
|
||||
|
||||
def str
|
||||
|
||||
1
benchmark/symbol-to-proc
Normal file → Executable file
1
benchmark/symbol-to-proc
Normal file → Executable file
@@ -1,3 +1,4 @@
|
||||
#!/usr/bin/env ruby
|
||||
require 'benchmark/ips'
|
||||
|
||||
Benchmark.ips do |x|
|
||||
|
||||
0
site/.gitignore → docs/.gitignore
vendored
0
site/.gitignore → docs/.gitignore
vendored
40
docs/404.html
Normal file
40
docs/404.html
Normal file
@@ -0,0 +1,40 @@
|
||||
---
|
||||
layout: error
|
||||
permalink: /404.html
|
||||
sitemap: false
|
||||
---
|
||||
|
||||
<section class="intro">
|
||||
<div class="grid">
|
||||
<div class="unit whole align-center">
|
||||
<p class="first">Huh. It seems that page is<br/>Hyde-ing...</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<section class="error">
|
||||
<div class="grid">
|
||||
<div class="unit whole align-center">
|
||||
<p>The resource you requested was not found. Here are some links to help you find your way:</p>
|
||||
<nav class="main-nav">
|
||||
<ul>
|
||||
<li>
|
||||
<a href="/">Home</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/docs/home/">Documentation</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/news/">News</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/community/">Community</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/help/">Help</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
@@ -1,7 +1,5 @@
|
||||
markdown: kramdown
|
||||
highlighter: pygments
|
||||
permalink: /news/:year/:month/:day/:title/
|
||||
excerpt_separator: ""
|
||||
highlighter: rouge
|
||||
|
||||
gauges_id: 503c5af6613f5d0f19000027
|
||||
google_analytics_id: UA-50755011-1
|
||||
@@ -15,6 +13,9 @@ timezone: America/Los_Angeles
|
||||
collections:
|
||||
docs:
|
||||
output: true
|
||||
posts:
|
||||
permalink: /news/:year/:month/:day/:title/
|
||||
output: true
|
||||
|
||||
name: Jekyll • Simple, blog-aware, static sites
|
||||
description: Transform your plain text into static websites and blogs
|
||||
@@ -23,7 +24,7 @@ url: https://jekyllrb.com
|
||||
twitter:
|
||||
username: jekyllrb
|
||||
|
||||
logo: img/logo-2x.png
|
||||
logo: /img/logo-2x.png
|
||||
|
||||
gems:
|
||||
- jekyll-feed
|
||||
@@ -32,3 +33,8 @@ gems:
|
||||
- jekyll-sitemap
|
||||
- jekyll-seo-tag
|
||||
- jekyll-avatar
|
||||
- jekyll-mentions
|
||||
|
||||
exclude:
|
||||
- README.md
|
||||
- .gitignore
|
||||
@@ -26,6 +26,7 @@
|
||||
- permalinks
|
||||
- pagination
|
||||
- plugins
|
||||
- themes
|
||||
- extras
|
||||
|
||||
- title: Deployment
|
||||
@@ -45,5 +46,6 @@
|
||||
- title: Meta
|
||||
docs:
|
||||
- contributing
|
||||
- maintaining
|
||||
- conduct
|
||||
- history
|
||||
167
docs/_data/jekyllconf-talks.yml
Normal file
167
docs/_data/jekyllconf-talks.yml
Normal file
@@ -0,0 +1,167 @@
|
||||
- speaker: Ben Balter
|
||||
twitter_handle: BenBalter
|
||||
youtube_id: Z-37y1qaoxc
|
||||
topic: GitHub Pages behind the scenes
|
||||
year: 2015
|
||||
|
||||
- speaker: Brandon Mathis
|
||||
twitter_handle: imathis
|
||||
youtube_id: KS6e4XxY2H4
|
||||
topic: What the heck is Octopress and why should I care?
|
||||
year: 2015
|
||||
|
||||
- speaker: Brian Rinaldi
|
||||
twitter_handle: remotesynth
|
||||
youtube_id: vT7DhK5zbv0
|
||||
topic: Comparing Jekyll with the Competition
|
||||
year: 2015
|
||||
|
||||
- speaker: Kyle Rush
|
||||
twitter_handle: kylerush
|
||||
youtube_id: ia8vsuiXiL0
|
||||
topic: Meet the Obama Campaign's $250 Million Fundraising Platform
|
||||
year: 2015
|
||||
|
||||
- speaker: Michael Jovel
|
||||
twitter_handle: mjovel
|
||||
youtube_id: 8zSHG6XU_xY
|
||||
topic: Building Living Style Guides with Jekyll
|
||||
year: 2015
|
||||
|
||||
- speaker: Mike Neumegen
|
||||
twitter_handle: mikeneumegen
|
||||
youtube_id: NuChR_YdjrI
|
||||
topic: A CMS for Jekyll
|
||||
year: 2015
|
||||
|
||||
- speaker: Parker Moore
|
||||
twitter_handle: parkr
|
||||
youtube_id: y2SbOIQ5nSA
|
||||
topic: Jekyll 3 and Beyond
|
||||
year: 2015
|
||||
|
||||
- speaker: Tom Preston-Werner
|
||||
twitter_handle: mojombo
|
||||
youtube_id: BMve1OCKj6M
|
||||
topic: Some crazy ideas I have for the future of static sites
|
||||
year: 2015
|
||||
|
||||
- speaker: Allison Zadrozny
|
||||
twitter_handle: allizad
|
||||
youtube_id: Rsc0Mmp1qc8
|
||||
topic: Elasticsearch for Jekyll
|
||||
year: 2016
|
||||
|
||||
- speaker: Amy Johnston
|
||||
twitter_handle: amybeukenex
|
||||
youtube_id: HR12JiUI2Zc
|
||||
topic: Jekyll for Technical Documentation
|
||||
year: 2016
|
||||
|
||||
- speaker: Bud Parr
|
||||
twitter_handle: budparr
|
||||
youtube_id: A1nTuNjoNbg
|
||||
topic: Real World Content Strategy with Jekyll
|
||||
year: 2016
|
||||
|
||||
- speaker: George Phillips
|
||||
twitter_handle: gphillips_nz
|
||||
youtube_id: skb_XWABEDc
|
||||
topic: Building client-editable Jekyll sites
|
||||
year: 2016
|
||||
|
||||
- speaker: Ire Aderinokun
|
||||
twitter_handle: ireaderinokun
|
||||
youtube_id: PRKV5IGKF2c
|
||||
topic: Using Jekyll for Rapid CSS Testing
|
||||
year: 2016
|
||||
|
||||
- speaker: Jon Chan
|
||||
twitter_handle: JonHMChan
|
||||
youtube_id: vDeKPs6xpOM
|
||||
topic: Stack Overflow on Jekyll
|
||||
year: 2016
|
||||
|
||||
- speaker: Julio Faerman
|
||||
twitter_handle: jmfaerman
|
||||
youtube_id: SOMonG8Iqak
|
||||
topic: Jekyll on AWS
|
||||
year: 2016
|
||||
|
||||
- speaker: Katy DeCorah
|
||||
twitter_handle: katydecorah
|
||||
youtube_id: s84wFRD8vfE
|
||||
topic: Unconventional use cases for Jekyll
|
||||
year: 2016
|
||||
|
||||
- speaker: David Darnes
|
||||
twitter_handle: DavidDarnes
|
||||
youtube_id: Y4qwpN40Dvg
|
||||
topic: Doing a lot with a little
|
||||
year: 2016
|
||||
|
||||
- speaker: Ronan Berder
|
||||
twitter_handle: hunvreus
|
||||
youtube_id: TteAQq25_Ns
|
||||
topic: Designing fast websites with Jekyll
|
||||
year: 2016
|
||||
|
||||
- speaker: David Von Lehman
|
||||
twitter_handle: davidvlsea
|
||||
youtube_id: wMlPlKCZfEk
|
||||
topic: Continuous deployment of Jekyll sites powered by Docker
|
||||
year: 2016
|
||||
|
||||
- speaker: David Jones
|
||||
twitter_handle: d_jones
|
||||
youtube_id: 4XxYQ7efk0E
|
||||
topic: Building our agency site with Jekyll
|
||||
year: 2016
|
||||
|
||||
- speaker: Scott Hewitt
|
||||
twitter_handle: scotthewitt
|
||||
youtube_id: qSd3pXQaPsE
|
||||
topic: Jekyll For Every Case
|
||||
year: 2016
|
||||
|
||||
- speaker: Tim Carry
|
||||
twitter_handle: pixelastic
|
||||
youtube_id: ivMML1J4ABY
|
||||
topic: Algolia search on Jekyll sites
|
||||
year: 2016
|
||||
|
||||
- speaker: Nils Borchers
|
||||
twitter_handle: nilsborchers
|
||||
youtube_id: DtNMjuv6Rbo
|
||||
topic: Building a living brand guide with Jekyll and Hologram
|
||||
year: 2016
|
||||
|
||||
- speaker: Mike Neumegen
|
||||
twitter_handle: mikeneumegen
|
||||
youtube_id: rJ5EhVmTR7I
|
||||
topic: Learning resources for the Jekyll community
|
||||
year: 2016
|
||||
|
||||
- speaker: Oliver Pattison
|
||||
twitter_handle: olivermakes
|
||||
youtube_id: BIf6oNpGl74
|
||||
topic: Responsive srcset images with imgix
|
||||
year: 2016
|
||||
|
||||
- speaker: Michael Lee
|
||||
twitter_handle: michaelsoolee
|
||||
youtube_id: F4bJRLEvXIc
|
||||
topic: Jekyll, Your Website's Baseplate
|
||||
year: 2016
|
||||
|
||||
- speaker: Paul Webb
|
||||
twitter_handle: NetOpWibby
|
||||
youtube_id: BRB5DgAE5nM
|
||||
topic: Deploy Jekyll Like A Boss
|
||||
year: 2016
|
||||
|
||||
- speaker: Tom Johnson
|
||||
twitter_handle: tomjohnson
|
||||
youtube_id: nq1AUB72GCQ
|
||||
topic: Overcoming challenges in using Jekyll for documentation projects
|
||||
year: 2016
|
||||
@@ -4,19 +4,19 @@ title: Assets
|
||||
permalink: /docs/assets/
|
||||
---
|
||||
|
||||
Jekyll provides built-in support for Sass and can work with CoffeeScript via
|
||||
a Ruby gem. In order to use them, you must first create a file with the
|
||||
proper extension name (one of `.sass`, `.scss`, or `.coffee`) and ***start the
|
||||
Jekyll provides built-in support for Sass and can work with CoffeeScript via
|
||||
a Ruby gem. In order to use them, you must first create a file with the
|
||||
proper extension name (one of `.sass`, `.scss`, or `.coffee`) and ***start the
|
||||
file with two lines of triple dashes***, like this:
|
||||
|
||||
{% highlight sass %}
|
||||
```sass
|
||||
---
|
||||
---
|
||||
|
||||
// start content
|
||||
.my-definition
|
||||
font-size: 1.2em
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
Jekyll treats these files the same as a regular page, in that the output file
|
||||
will be placed in the same directory that it came from. For instance, if you
|
||||
@@ -46,10 +46,10 @@ If you are using Sass `@import` statements, you'll need to ensure that your
|
||||
`sass_dir` is set to the base directory that contains your Sass files. You
|
||||
can do that thusly:
|
||||
|
||||
{% highlight yaml %}
|
||||
```yaml
|
||||
sass:
|
||||
sass_dir: _sass
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
The Sass converter will default the `sass_dir` configuration option to
|
||||
`_sass`.
|
||||
@@ -72,10 +72,10 @@ The Sass converter will default the `sass_dir` configuration option to
|
||||
You may also specify the output style with the `style` option in your
|
||||
`_config.yml` file:
|
||||
|
||||
{% highlight yaml %}
|
||||
```yaml
|
||||
sass:
|
||||
style: compressed
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
These are passed to Sass, so any output style options Sass supports are valid
|
||||
here, too.
|
||||
@@ -88,7 +88,7 @@ To enable Coffeescript in Jekyll 3.0 and up you must
|
||||
* Install the `jekyll-coffeescript` gem
|
||||
* Ensure that your `_config.yml` is up-to-date and includes the following:
|
||||
|
||||
{% highlight yaml %}
|
||||
```yaml
|
||||
gems:
|
||||
- jekyll-coffeescript
|
||||
{% endhighlight %}
|
||||
```
|
||||
@@ -17,29 +17,29 @@ namespace.
|
||||
Add the following to your site's `_config.yml` file, replacing `my_collection`
|
||||
with the name of your collection:
|
||||
|
||||
{% highlight yaml %}
|
||||
```yaml
|
||||
collections:
|
||||
- my_collection
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
You can optionally specify metadata for your collection in the configuration:
|
||||
|
||||
{% highlight yaml %}
|
||||
```yaml
|
||||
collections:
|
||||
my_collection:
|
||||
foo: bar
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
Default attributes can also be set for a collection:
|
||||
|
||||
{% highlight yaml %}
|
||||
```yaml
|
||||
defaults:
|
||||
- scope:
|
||||
path: ""
|
||||
type: my_collection
|
||||
values:
|
||||
layout: page
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
### Step 2: Add your content
|
||||
|
||||
@@ -62,11 +62,11 @@ If you'd like Jekyll to create a public-facing, rendered version of each
|
||||
document in your collection, set the `output` key to `true` in your collection
|
||||
metadata in your `_config.yml`:
|
||||
|
||||
{% highlight yaml %}
|
||||
```yaml
|
||||
collections:
|
||||
my_collection:
|
||||
output: true
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
This will produce a file for each document in the collection.
|
||||
For example, if you have `_my_collection/some_subdir/some_doc.md`,
|
||||
@@ -76,12 +76,12 @@ choice and written out to `<dest>/my_collection/some_subdir/some_doc.html`.
|
||||
As for posts with [Permalinks](../permalinks/), the document
|
||||
URL can be customized by setting `permalink` metadata for the collection:
|
||||
|
||||
{% highlight yaml %}
|
||||
```yaml
|
||||
collections:
|
||||
my_collection:
|
||||
output: true
|
||||
permalink: /awesome/:path/
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
For example, if you have `_my_collection/some_subdir/some_doc.md`, it will be
|
||||
written out to `<dest>/awesome/some_subdir/some_doc/index.html`.
|
||||
@@ -317,6 +317,16 @@ file, each document has the following attributes:
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<p><code>date</code></p>
|
||||
</td>
|
||||
<td>
|
||||
<p>
|
||||
The date of the document's collection.
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
@@ -329,7 +339,7 @@ one might have front matter in an individual file structured as follows (which
|
||||
must use a supported markup format, and cannot be saved with a `.yaml`
|
||||
extension):
|
||||
|
||||
{% highlight yaml %}
|
||||
```yaml
|
||||
title: "Josquin: Missa De beata virgine and Missa Ave maris stella"
|
||||
artist: "The Tallis Scholars"
|
||||
director: "Peter Phillips"
|
||||
@@ -347,11 +357,11 @@ works:
|
||||
duration: "7:47"
|
||||
- title: "Agnus Dei I, II & III"
|
||||
duration: "6:49"
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
Every album in the collection could be listed on a single page with a template:
|
||||
|
||||
{% highlight html %}
|
||||
```html
|
||||
{% raw %}
|
||||
{% for album in site.albums %}
|
||||
<h2>{{ album.title }}</h2>
|
||||
@@ -367,4 +377,4 @@ Every album in the collection could be listed on a single page with a template:
|
||||
{% endfor %}
|
||||
{% endfor %}
|
||||
{% endraw %}
|
||||
{% endhighlight %}
|
||||
```
|
||||
@@ -284,6 +284,18 @@ class="flag">flags</code> (specified on the command-line) that control them.
|
||||
<p><code class="flag">-I, --incremental</code></p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="setting">
|
||||
<td>
|
||||
<p class="name"><strong>Liquid profiler</strong></p>
|
||||
<p class="description">
|
||||
Generate a Liquid rendering profile to help you identify performance bottlenecks.
|
||||
</p>
|
||||
</td>
|
||||
<td class="align-center">
|
||||
<p><code class="option">profile: BOOL</code></p>
|
||||
<p><code class="flag">--profile</code></p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
@@ -383,23 +395,24 @@ before your site is served.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
## Custom WEBRick Headers
|
||||
## Custom WEBrick Headers
|
||||
|
||||
You can provide custom headers for your site by adding them to `_config.yml`
|
||||
|
||||
{% highlight yaml %}
|
||||
```yaml
|
||||
# File: _config.yml
|
||||
webrick:
|
||||
headers:
|
||||
My-Header: My-Value
|
||||
My-Other-Header: My-Other-Value
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
### Defaults
|
||||
|
||||
We only provide one default and that's a Content-Type header that disables
|
||||
caching in development so that you don't have to fight with Chrome's aggressive
|
||||
caching when you are in development mode.
|
||||
We provide by default `Content-Type` and `Cache-Control` response headers: one
|
||||
dynamic in order to specify the nature of the data being served, the other
|
||||
static in order to disable caching so that you don't have to fight with Chrome's
|
||||
aggressive caching when you are in development mode.
|
||||
|
||||
## Specifying a Jekyll environment at build time
|
||||
|
||||
@@ -407,19 +420,19 @@ In the build (or serve) arguments, you can specify a Jekyll environment and valu
|
||||
|
||||
For example, suppose you set this conditional statement in your code:
|
||||
|
||||
{% highlight liquid %}
|
||||
```liquid
|
||||
{% raw %}
|
||||
{% if jekyll.environment == "production" %}
|
||||
{% include disqus.html %}
|
||||
{% endif %}
|
||||
{% endraw %}
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
When you build your Jekyll site, the content inside the `if` statement won't be run unless you also specify a `production` environment in the build command, like this:
|
||||
|
||||
{% highlight sh %}
|
||||
```sh
|
||||
JEKYLL_ENV=production jekyll build
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
Specifying an environment value allows you to make certain content available only within specific environments.
|
||||
|
||||
@@ -435,24 +448,36 @@ Using [YAML Front Matter](../frontmatter/) is one way that you can specify confi
|
||||
|
||||
Often times, you will find that you are repeating a lot of configuration options. Setting the same layout in each file, adding the same category - or categories - to a post, etc. You can even add custom variables like author names, which might be the same for the majority of posts on your blog.
|
||||
|
||||
Instead of repeating this configuration each time you create a new post or page, Jekyll provides a way to set these defaults in the site configuration. To do this, you can specify site-wide defaults using the `defaults` key in the `_config.yml` file in your projects root directory.
|
||||
Instead of repeating this configuration each time you create a new post or page, Jekyll provides a way to set these defaults in the site configuration. To do this, you can specify site-wide defaults using the `defaults` key in the `_config.yml` file in your project's root directory.
|
||||
|
||||
The `defaults` key holds an array of scope/values pairs that define what defaults should be set for a particular file path, and optionally, a file type in that path.
|
||||
|
||||
Let's say that you want to add a default layout to all pages and posts in your site. You would add this to your `_config.yml` file:
|
||||
|
||||
{% highlight yaml %}
|
||||
```yaml
|
||||
defaults:
|
||||
-
|
||||
scope:
|
||||
path: "" # an empty string here means all files in the project
|
||||
values:
|
||||
layout: "default"
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
Here, we are scoping the `values` to any file that exists in the scopes path. Since the path is set as an empty string, it will apply to **all files** in your project. You probably don't want to set a layout on every file in your project - like css files, for example - so you can also specify a `type` value under the `scope` key.
|
||||
<div class="note info">
|
||||
<h5>Please stop and rerun `jekyll serve` command.</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>
|
||||
during automatic regeneration are not loaded until the next execution.
|
||||
</p>
|
||||
<p>
|
||||
Note <a href="../datafiles">Data Files</a> are included and reloaded during automatic regeneration.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
{% highlight yaml %}
|
||||
Here, we are scoping the `values` to any file that exists in the path `scope`. Since the path is set as an empty string, it will apply to **all files** in your project. You probably don't want to set a layout on every file in your project - like css files, for example - so you can also specify a `type` value under the `scope` key.
|
||||
|
||||
```yaml
|
||||
defaults:
|
||||
-
|
||||
scope:
|
||||
@@ -460,14 +485,14 @@ defaults:
|
||||
type: "posts" # previously `post` in Jekyll 2.2.
|
||||
values:
|
||||
layout: "default"
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
Now, this will only set the layout for files where the type is `posts`.
|
||||
The different types that are available to you are `pages`, `posts`, `drafts` or any collection in your site. While `type` is optional, you must specify a value for `path` when creating a `scope/values` pair.
|
||||
|
||||
As mentioned earlier, you can set multiple scope/values pairs for `defaults`.
|
||||
|
||||
{% highlight yaml %}
|
||||
```yaml
|
||||
defaults:
|
||||
-
|
||||
scope:
|
||||
@@ -482,11 +507,11 @@ defaults:
|
||||
values:
|
||||
layout: "project" # overrides previous default layout
|
||||
author: "Mr. Hyde"
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
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` as well as have the category for the page set to `project`.
|
||||
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`.
|
||||
|
||||
{% highlight yaml %}
|
||||
```yaml
|
||||
collections:
|
||||
- my_collection:
|
||||
output: true
|
||||
@@ -498,7 +523,7 @@ defaults:
|
||||
type: "my_collection" # a collection in your site, in plural form
|
||||
values:
|
||||
layout: "default"
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
In this example, the `layout` is set to `default` inside the
|
||||
[collection](../collections/) with the name `my_collection`.
|
||||
@@ -511,7 +536,7 @@ You can see that in the second to last example above. First, we set the default
|
||||
|
||||
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:
|
||||
|
||||
{% highlight yaml %}
|
||||
```yaml
|
||||
# In _config.yml
|
||||
...
|
||||
defaults:
|
||||
@@ -524,16 +549,16 @@ defaults:
|
||||
author: "Mr. Hyde"
|
||||
category: "project"
|
||||
...
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
{% highlight yaml %}
|
||||
```yaml
|
||||
# In projects/foo_project.md
|
||||
---
|
||||
author: "John Smith"
|
||||
layout: "foobar"
|
||||
---
|
||||
The post text goes here...
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
The `projects/foo_project.md` would have the `layout` set to `foobar` instead
|
||||
of `project` and the `author` set to `John Smith` instead of `Mr. Hyde` when
|
||||
@@ -554,20 +579,22 @@ file or on the command-line.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
{% highlight yaml %}
|
||||
```yaml
|
||||
# Where things are
|
||||
source: .
|
||||
destination: ./_site
|
||||
plugins_dir: ./_plugins
|
||||
layouts_dir: ./_layouts
|
||||
data_dir: ./_data
|
||||
includes_dir: ./_includes
|
||||
collections: null
|
||||
plugins_dir: _plugins
|
||||
layouts_dir: _layouts
|
||||
data_dir: _data
|
||||
includes_dir: _includes
|
||||
collections:
|
||||
posts:
|
||||
output: true
|
||||
|
||||
# Handling Reading
|
||||
safe: false
|
||||
include: [".htaccess"]
|
||||
exclude: []
|
||||
exclude: ["node_modules", "vendor/bundle/", "vendor/cache/", "vendor/gems/", "vendor/ruby/"]
|
||||
keep_files: [".git", ".svn"]
|
||||
encoding: "utf-8"
|
||||
markdown_ext: "markdown,mkdown,mkdn,mkd,md"
|
||||
@@ -594,6 +621,7 @@ detach: false
|
||||
port: 4000
|
||||
host: 127.0.0.1
|
||||
baseurl: "" # does not include hostname
|
||||
show_dir_listing: false
|
||||
|
||||
# Outputting
|
||||
permalink: date
|
||||
@@ -601,8 +629,12 @@ paginate_path: /page:num
|
||||
timezone: null
|
||||
|
||||
quiet: false
|
||||
verbose: false
|
||||
defaults: []
|
||||
|
||||
liquid:
|
||||
error_mode: warn
|
||||
|
||||
# Markdown Processors
|
||||
rdiscount:
|
||||
extensions: []
|
||||
@@ -616,16 +648,19 @@ kramdown:
|
||||
entity_output: as_char
|
||||
toc_levels: 1..6
|
||||
smart_quotes: lsquo,rsquo,ldquo,rdquo
|
||||
enable_coderay: false
|
||||
input: GFM
|
||||
hard_wrap: false
|
||||
footnote_nr: 1
|
||||
```
|
||||
|
||||
coderay:
|
||||
coderay_wrap: div
|
||||
coderay_line_numbers: inline
|
||||
coderay_line_number_start: 1
|
||||
coderay_tab_width: 4
|
||||
coderay_bold_every: 10
|
||||
coderay_css: style
|
||||
{% endhighlight %}
|
||||
## Liquid Options
|
||||
|
||||
Liquid's response to errors can be configured by setting `error_mode`. The
|
||||
options are
|
||||
|
||||
- `lax` --- Ignore all errors.
|
||||
- `warn` --- Output a warning on the console for each error.
|
||||
- `strict` --- Output an error message and stop the build.
|
||||
|
||||
## Markdown Options
|
||||
|
||||
@@ -676,21 +711,11 @@ extensions are:
|
||||
|
||||
[redcarpet_extensions]: https://github.com/vmg/redcarpet/blob/v3.2.2/README.markdown#and-its-like-really-simple-to-use
|
||||
|
||||
### Kramdown
|
||||
|
||||
In addition to the defaults mentioned above, you can also turn on recognition
|
||||
of GitHub Flavored Markdown by passing an `input` option with a value of "GFM".
|
||||
|
||||
For example, in your `_config.yml`:
|
||||
|
||||
kramdown:
|
||||
input: GFM
|
||||
|
||||
### 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:
|
||||
|
||||
{% highlight ruby %}
|
||||
```ruby
|
||||
class Jekyll::Converters::Markdown::MyCustomProcessor
|
||||
def initialize(config)
|
||||
require 'funky_markdown'
|
||||
@@ -705,14 +730,14 @@ class Jekyll::Converters::Markdown::MyCustomProcessor
|
||||
::FunkyMarkdown.new(content).convert
|
||||
end
|
||||
end
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
Once you've created your class and have it properly set up either as a plugin
|
||||
in the `_plugins` folder or as a gem, specify it in your `_config.yml`:
|
||||
|
||||
{% highlight yaml %}
|
||||
```yaml
|
||||
markdown: MyCustomProcessor
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
## Incremental Regeneration
|
||||
<div class="note warning">
|
||||
@@ -19,7 +19,7 @@ Enabling Travis builds for your GitHub repository is pretty simple:
|
||||
1. Go to your profile on travis-ci.org: https://travis-ci.org/profile/username
|
||||
2. Find the repository for which you're interested in enabling builds.
|
||||
3. Click the slider on the right so it says "ON" and is a dark grey.
|
||||
4. Optionally configure the build by clicking on the wrench icon. Further
|
||||
4. Optionally configure the build by clicking on the gear icon. Further
|
||||
configuration happens in your `.travis.yml` file. More details on that
|
||||
below.
|
||||
|
||||
@@ -38,13 +38,13 @@ Save the commands you want to run and succeed in a file: `./script/cibuild`
|
||||
|
||||
### The HTML Proofer Executable
|
||||
|
||||
{% highlight bash %}
|
||||
```sh
|
||||
#!/usr/bin/env bash
|
||||
set -e # halt script on error
|
||||
|
||||
bundle exec jekyll build
|
||||
bundle exec htmlproofer ./_site
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
Some options can be specified via command-line switches. Check out the
|
||||
`html-proofer` README for more information about these switches, or run
|
||||
@@ -52,20 +52,20 @@ Some options can be specified via command-line switches. Check out the
|
||||
|
||||
For example to avoid testing external sites, use this command:
|
||||
|
||||
{% highlight bash %}
|
||||
```sh
|
||||
$ bundle exec htmlproofer ./_site --disable-external
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
### The HTML Proofer Library
|
||||
|
||||
You can also invoke `html-proofer` in Ruby scripts (e.g. in a Rakefile):
|
||||
|
||||
{% highlight ruby %}
|
||||
```ruby
|
||||
#!/usr/bin/env ruby
|
||||
|
||||
require 'html/proofer'
|
||||
HTML::Proofer.new("./_site").run
|
||||
{% endhighlight %}
|
||||
require 'html-proofer'
|
||||
HTMLProofer.check_directory("./_site").run
|
||||
```
|
||||
|
||||
Options are given as a second argument to `.new`, and are encoded in a
|
||||
symbol-keyed Ruby Hash. For more information about the configuration options,
|
||||
@@ -82,19 +82,19 @@ an explanation of each line.
|
||||
|
||||
**Note:** You will need a Gemfile as well, [Travis will automatically install](https://docs.travis-ci.com/user/languages/ruby/#Dependency-Management) the dependencies based on the referenced gems:
|
||||
|
||||
{% highlight ruby %}
|
||||
```ruby
|
||||
source "https://rubygems.org"
|
||||
|
||||
gem "jekyll"
|
||||
gem "html-proofer"
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
Your `.travis.yml` file should look like this:
|
||||
|
||||
{% highlight yaml %}
|
||||
```yaml
|
||||
language: ruby
|
||||
rvm:
|
||||
- 2.1
|
||||
- 2.2.5
|
||||
|
||||
before_script:
|
||||
- chmod +x ./script/cibuild # or do this locally and commit
|
||||
@@ -114,39 +114,39 @@ env:
|
||||
- NOKOGIRI_USE_SYSTEM_LIBRARIES=true # speeds up installation of html-proofer
|
||||
|
||||
sudo: false # route your build to the container-based infrastructure for a faster build
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
Ok, now for an explanation of each line:
|
||||
|
||||
{% highlight yaml %}
|
||||
```yaml
|
||||
language: ruby
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
This line tells Travis to use a Ruby build container. It gives your script
|
||||
access to Bundler, RubyGems, and a Ruby runtime.
|
||||
|
||||
{% highlight yaml %}
|
||||
```yaml
|
||||
rvm:
|
||||
- 2.1
|
||||
{% endhighlight %}
|
||||
- 2.2.5
|
||||
```
|
||||
|
||||
RVM is a popular Ruby Version Manager (like rbenv, chruby, etc). This
|
||||
directive tells Travis the Ruby version to use when running your test
|
||||
script.
|
||||
|
||||
{% highlight yaml %}
|
||||
```yaml
|
||||
before_script:
|
||||
- chmod +x ./script/cibuild
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
The build script file needs to have the *executable* attribute set or
|
||||
Travis will fail with a permission denied error. You can also run this
|
||||
locally and commit the permissions directly, thus rendering this step
|
||||
irrelevant.
|
||||
|
||||
{% highlight yaml %}
|
||||
```yaml
|
||||
script: ./script/cibuild
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
Travis allows you to run any arbitrary shell script to test your site. One
|
||||
convention is to put all scripts for your project in the `script`
|
||||
@@ -154,20 +154,20 @@ directory, and to call your test script `cibuild`. This line is completely
|
||||
customizable. If your script won't change much, you can write your test
|
||||
incantation here directly:
|
||||
|
||||
{% highlight yaml %}
|
||||
```yaml
|
||||
install: gem install jekyll html-proofer
|
||||
script: jekyll build && htmlproofer ./_site
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
The `script` directive can be absolutely any valid shell command.
|
||||
|
||||
{% highlight yaml %}
|
||||
```yaml
|
||||
# branch whitelist, only for GitHub Pages
|
||||
branches:
|
||||
only:
|
||||
- gh-pages # test the gh-pages branch
|
||||
- /pages-(.*)/ # test every branch which starts with "pages-"
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
You want to ensure the Travis builds for your site are being run only on
|
||||
the branch or branches which contain your site. One means of ensuring this
|
||||
@@ -181,11 +181,11 @@ prefixed, exemplified above with the `/pages-(.*)/` regular expression.
|
||||
The `branches` directive is completely optional. Travis will build from every
|
||||
push to any branch of your repo if leave it out.
|
||||
|
||||
{% highlight yaml %}
|
||||
```yaml
|
||||
env:
|
||||
global:
|
||||
- NOKOGIRI_USE_SYSTEM_LIBRARIES=true # speeds up installation of html-proofer
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
Using `html-proofer`? You'll want this environment variable. Nokogiri, used
|
||||
to parse HTML files in your compiled site, comes bundled with libraries
|
||||
@@ -200,19 +200,19 @@ environment variable `NOKOGIRI_USE_SYSTEM_LIBRARIES` to `true`.
|
||||
servers, which Jekyll will mistakenly read and explode on.</p>
|
||||
</div>
|
||||
|
||||
{% highlight yaml %}
|
||||
```yaml
|
||||
exclude: [vendor]
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
By default you should supply the `sudo: false` command to Travis. This command
|
||||
By default you should supply the `sudo: false` command to Travis. This command
|
||||
explicitly tells Travis to run your build on Travis's [container-based
|
||||
infrastructure](https://docs.travis-ci.com/user/workers/container-based-infrastructure/#Routing-your-build-to-container-based-infrastructure). Running on the container-based infrastructure can often times
|
||||
speed up your build. If you have any trouble with your build, or if your build
|
||||
does need `sudo` access, modify the line to `sudo: required`.
|
||||
|
||||
{% highlight yaml %}
|
||||
```yaml
|
||||
sudo: false
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
### Troubleshooting
|
||||
|
||||
@@ -229,5 +229,5 @@ an entry in the `.gitignore` file to avoid it from being checked in again.
|
||||
This entire guide is open-source. Go ahead and [edit it][3] if you have a
|
||||
fix or [ask for help][4] if you run into trouble and need some help.
|
||||
|
||||
[3]: https://github.com/jekyll/jekyll/edit/master/site/_docs/continuous-integration.md
|
||||
[3]: https://github.com/jekyll/jekyll/edit/master/docs/_docs/continuous-integration.md
|
||||
[4]: https://jekyllrb.com/help/
|
||||
@@ -11,8 +11,8 @@ Hi there! Interested in contributing to Jekyll? We'd love your help. Jekyll is a
|
||||
|
||||
* 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/)
|
||||
* 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/).
|
||||
|
||||
## Ways to contribute
|
||||
|
||||
@@ -33,7 +33,7 @@ Whether you're a developer, a designer, or just a Jekyll devotee, there are lots
|
||||
|
||||
* The more information, the better. Make judicious use of the pull request body. Describe what changes were made, why you made them, and what impact they will have for users.
|
||||
|
||||
* Pull request are easy and fun. If this is your first pull request, it may help to [understand GitHub Flow](https://guides.github.com/introduction/flow/)
|
||||
* Pull request are easy and fun. If this is your first pull request, it may help to [understand GitHub Flow](https://guides.github.com/introduction/flow/).
|
||||
|
||||
* If you're submitting a code contribution, be sure to read the [code contributions](#code-contributions) section below.
|
||||
|
||||
@@ -41,7 +41,7 @@ Whether you're a developer, a designer, or just a Jekyll devotee, there are lots
|
||||
|
||||
Many small changes can be made entirely through the github.com web interface.
|
||||
|
||||
1. Navigate to the file within [`jekyll/jekyll`](https://github.com/jekyll/jekyll) that you'd like to edit
|
||||
1. Navigate to the file within [`jekyll/jekyll`](https://github.com/jekyll/jekyll) that you'd like to edit.
|
||||
2. Click the pencil icon in the top right corner to edit the file
|
||||
3. Make your proposed changes
|
||||
4. Click "Propose file change"
|
||||
@@ -53,13 +53,13 @@ That's it! You'll be automatically subscribed to receive updates as others revie
|
||||
|
||||
### Submitting a pull request via Git command line
|
||||
|
||||
1. Fork the project by clicking "Fork" in the top right corner of [`jekyll/jekyll`](https://github.com/jekyll/jekyll)
|
||||
2. Clone the repository lcoally `git clone https://github.com/<you-username>/jekyll`
|
||||
1. Fork the project by clicking "Fork" in the top right corner of [`jekyll/jekyll`](https://github.com/jekyll/jekyll).
|
||||
2. Clone the repository locally `git clone https://github.com/<you-username>/jekyll`.
|
||||
3. Create a new, descriptively named branch to contain your change ( `git checkout -b my-awesome-feature` ).
|
||||
4. Hack away, add tests. Not necessarily in that order.
|
||||
5. Make sure everything still passes by running `script/cibuild` (see [the tests section](#running-tests-locally) below)
|
||||
6. Push the branch up ( `git push origin my-awesome-feature` ).
|
||||
7. Create a pull request by visiting https://github.com/<your-username>/jekyll/ and following the instructions at the top of the screen.
|
||||
7. Create a pull request by visiting `https://github.com/<your-username>/jekyll` and following the instructions at the top of the screen.
|
||||
|
||||
## Proposing updates to the documentation
|
||||
|
||||
@@ -67,13 +67,13 @@ We want the Jekyll documentation to be the best it can be. We've open-sourced ou
|
||||
|
||||
### How to submit changes
|
||||
|
||||
You can find the documentation for jekyllrb.com in the [site](https://github.com/jekyll/jekyll/tree/master/site) directory. See the section above, [submitting a pull request](#submitting-a-pull-request) for information on how to propose a change.
|
||||
You can find the documentation for jekyllrb.com in the [docs](https://github.com/jekyll/jekyll/tree/master/docs) directory. See the section above, [submitting a pull request](#submitting-a-pull-request) for information on how to propose a change.
|
||||
|
||||
One gotcha, all pull requests should be directed at the `master` branch (the default branch).
|
||||
|
||||
### Adding plugins
|
||||
|
||||
If you want to add your plugin to the [list of plugins](https://jekyllrb.com/docs/plugins/#available-plugins), please submit a pull request modifying the [plugins page source file](site/_docs/plugins.md) by adding a link to your plugin under the proper subheading depending upon its type.
|
||||
If you want to add your plugin to the [list of plugins](https://jekyllrb.com/docs/plugins/#available-plugins), please submit a pull request modifying the [plugins page source file](https://github.com/jekyll/jekyll/blob/master/docs/_docs/plugins.md) by adding a link to your plugin under the proper subheading depending upon its type.
|
||||
|
||||
## Code Contributions
|
||||
|
||||
@@ -85,7 +85,7 @@ Any time you propose a code change, you should also include updates to the docum
|
||||
|
||||
#### Documentation
|
||||
|
||||
If your contribution changes any Jekyll behavior, make sure to update the documentation. Documentation lives in the `site/_docs` folder (spoiler alert: it's a Jekyll site!). If the docs are missing information, please feel free to add it in. Great docs make a great project. Include changes to the documentation within your pull request, and once merged, `jekyllrb.com` will be updated.
|
||||
If your contribution changes any Jekyll behavior, make sure to update the documentation. Documentation lives in the `docs/_docs` folder (spoiler alert: it's a Jekyll site!). If the docs are missing information, please feel free to add it in. Great docs make a great project. Include changes to the documentation within your pull request, and once merged, `jekyllrb.com` will be updated.
|
||||
|
||||
#### Tests
|
||||
|
||||
@@ -95,7 +95,7 @@ If your contribution changes any Jekyll behavior, make sure to update the docume
|
||||
|
||||
### Code contributions generally
|
||||
|
||||
* Jekyll follows the [GitHub Ruby Styleguide](https://github.com/styleguide/ruby).
|
||||
* Jekyll uses the [Rubocop](https://github.com/bbatsov/rubocop) static analyzer to ensure that contributions follow the [GitHub Ruby Styleguide](https://github.com/styleguide/ruby). Please check your code using `script/fmt` and resolve any errors before pushing your branch.
|
||||
|
||||
* Don't bump the Gem version in your pull request (if you don't know what that means, you probably didn't).
|
||||
|
||||
@@ -21,8 +21,8 @@ Plugins/themes can also leverage Data Files to set configuration variables.
|
||||
|
||||
As explained on the [directory structure](../structure/) page, the `_data`
|
||||
folder is where you can store additional data for Jekyll to use when generating
|
||||
your site. These files must be YAML files
|
||||
(using either the `.yml`, `.yaml`, `.json` or `csv` extension) and they will be
|
||||
your site. These files must be YAML, JSON, or CSV files (using either
|
||||
the `.yml`, `.yaml`, `.json` or `.csv` extension), and they will be
|
||||
accessible via `site.data`.
|
||||
|
||||
## Example: List of members
|
||||
@@ -32,7 +32,7 @@ of code in your Jekyll templates:
|
||||
|
||||
In `_data/members.yml`:
|
||||
|
||||
{% highlight yaml %}
|
||||
```yaml
|
||||
- name: Eric Mill
|
||||
github: konklone
|
||||
|
||||
@@ -41,23 +41,23 @@ In `_data/members.yml`:
|
||||
|
||||
- name: Liu Fengyun
|
||||
github: liufengyun
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
Or `_data/members.csv`:
|
||||
|
||||
{% highlight text %}
|
||||
```text
|
||||
name,github
|
||||
Eric Mill,konklone
|
||||
Parker Moore,parkr
|
||||
Liu Fengyun,liufengyun
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
This data can be accessed via `site.data.members` (notice that the filename
|
||||
determines the variable name).
|
||||
|
||||
You can now render the list of members in a template:
|
||||
|
||||
{% highlight html %}
|
||||
```html
|
||||
{% raw %}
|
||||
<ul>
|
||||
{% for member in site.data.members %}
|
||||
@@ -69,7 +69,7 @@ You can now render the list of members in a template:
|
||||
{% endfor %}
|
||||
</ul>
|
||||
{% endraw %}
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
## Example: Organizations
|
||||
|
||||
@@ -80,7 +80,7 @@ folder:
|
||||
|
||||
In `_data/orgs/jekyll.yml`:
|
||||
|
||||
{% highlight yaml %}
|
||||
```yaml
|
||||
username: jekyll
|
||||
name: Jekyll
|
||||
members:
|
||||
@@ -89,22 +89,22 @@ members:
|
||||
|
||||
- name: Parker Moore
|
||||
github: parkr
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
In `_data/orgs/doeorg.yml`:
|
||||
|
||||
{% highlight yaml %}
|
||||
```yaml
|
||||
username: doeorg
|
||||
name: Doe Org
|
||||
members:
|
||||
- name: John Doe
|
||||
github: jdoe
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
The organizations can then be accessed via `site.data.orgs`, followed by the
|
||||
file name:
|
||||
|
||||
{% highlight html %}
|
||||
```html
|
||||
{% raw %}
|
||||
<ul>
|
||||
{% for org_hash in site.data.orgs %}
|
||||
@@ -118,22 +118,23 @@ file name:
|
||||
{% endfor %}
|
||||
</ul>
|
||||
{% endraw %}
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
## Example: Accessing a specific author
|
||||
|
||||
Pages and posts can also access a specific data item. The example below shows how to access a specific item:
|
||||
|
||||
`_data/people.yml`:
|
||||
{% highlight yaml %}
|
||||
|
||||
```yaml
|
||||
dave:
|
||||
name: David Smith
|
||||
twitter: DavidSilvaSmith
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
The author can then be specified as a page variable in a post's frontmatter:
|
||||
|
||||
{% highlight html %}
|
||||
```html
|
||||
{% raw %}
|
||||
---
|
||||
title: sample post
|
||||
@@ -148,4 +149,4 @@ author: dave
|
||||
</a>
|
||||
|
||||
{% endraw %}
|
||||
{% endhighlight %}
|
||||
```
|
||||
@@ -8,16 +8,11 @@ Sites built using Jekyll can be deployed in a large number of ways due to the st
|
||||
|
||||
## 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` command and copy 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.
|
||||
|
||||
### FTP using Glynn
|
||||
|
||||
There is a project called [Glynn](https://github.com/dmathieu/glynn), which lets you easily generate your Jekyll powered website’s static files and
|
||||
send them to your host through 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 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.
|
||||
|
||||
## Self-managed web server
|
||||
|
||||
If you have direct access yourself to the deployment web server yourself, the process is essentially the same, except you might have other methods available to you (such as `scp`, or even direct filesystem access) for transferring the files. Just remember to make sure the contents of the generated `_site` folder get placed in the appropriate web root directory for your web server.
|
||||
If you have direct access to the deployment web server, the process is essentially the same, except you might have other methods available to you (such as `scp`, or even direct filesystem access) for transferring the files. Just remember to make sure the contents of the generated `_site` folder get placed in the appropriate web root directory for your web server.
|
||||
|
||||
## Automated methods
|
||||
|
||||
@@ -35,19 +30,19 @@ this](http://web.archive.org/web/20091223025644/http://www.taknado.com/en/2009/0
|
||||
|
||||
To have a remote server handle the deploy for you every time you push changes using Git, you can create a user account which has all the public keys that are authorized to deploy in its `authorized_keys` file. With that in place, setting up the post-receive hook is done as follows:
|
||||
|
||||
{% highlight bash %}
|
||||
```sh
|
||||
laptop$ ssh deployer@example.com
|
||||
server$ mkdir myrepo.git
|
||||
server$ cd myrepo.git
|
||||
server$ git --bare init
|
||||
server$ cp hooks/post-receive.sample hooks/post-receive
|
||||
server$ mkdir /var/www/myrepo
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
Next, add the following lines to hooks/post-receive and be sure Jekyll is
|
||||
installed on the server:
|
||||
|
||||
{% highlight bash %}
|
||||
```sh
|
||||
GIT_REPO=$HOME/myrepo.git
|
||||
TMP_GIT_CLONE=$HOME/tmp/myrepo
|
||||
PUBLIC_WWW=/var/www/myrepo
|
||||
@@ -56,34 +51,21 @@ git clone $GIT_REPO $TMP_GIT_CLONE
|
||||
jekyll build -s $TMP_GIT_CLONE -d $PUBLIC_WWW
|
||||
rm -Rf $TMP_GIT_CLONE
|
||||
exit
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
Finally, run the following command on any users laptop that needs to be able to
|
||||
deploy using this hook:
|
||||
|
||||
{% highlight bash %}
|
||||
```sh
|
||||
laptops$ git remote add deploy deployer@example.com:~/myrepo.git
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
Deploying is now as easy as telling nginx or Apache to look at
|
||||
`/var/www/myrepo` and running the following:
|
||||
|
||||
{% highlight bash %}
|
||||
```sh
|
||||
laptops$ git push deploy master
|
||||
{% endhighlight %}
|
||||
|
||||
### Jekyll-hook
|
||||
|
||||
You can also use jekyll-hook, a server that listens for webhook posts from
|
||||
GitHub, generates a website with Jekyll, and moves it somewhere to be
|
||||
published. Use this to run your own GitHub Pages-style web server.
|
||||
|
||||
This method is useful if you need to serve your websites behind a firewall,
|
||||
need extra server-level features like HTTP basic authentication or want to
|
||||
host your site directly on a CDN or file host like S3.
|
||||
|
||||
Setup steps are fully documented
|
||||
[in the `jekyll-hook` repo](https://github.com/developmentseed/jekyll-hook).
|
||||
```
|
||||
|
||||
### Static Publisher
|
||||
|
||||
@@ -99,10 +81,10 @@ Another way to deploy your Jekyll site is to use [Rake](https://github.com/ruby/
|
||||
|
||||
Once you’ve generated the `_site` directory, you can easily scp it using a
|
||||
`tasks/deploy` shell script similar to [this deploy script][]. You’d obviously
|
||||
need to change the values to reflect your site’s details. There is even [a
|
||||
need to change the values to reflect your site’s details. There is even [a
|
||||
matching TextMate command][] that will help you run this script.
|
||||
|
||||
[this deploy script here]: https://github.com/henrik/henrik.nyh.se/blob/master/script/deploy
|
||||
[this deploy script]: https://github.com/henrik/henrik.nyh.se/blob/master/script/deploy
|
||||
|
||||
[a matching TextMate command]: https://gist.github.com/henrik/214959
|
||||
|
||||
@@ -129,9 +111,9 @@ is to put the restriction to certificate-based authorization in
|
||||
`~/.ssh/authorized_keys`. Then, launch `rrsync` and supply
|
||||
it with the folder it shall have read-write access to:
|
||||
|
||||
{% highlight bash %}
|
||||
```sh
|
||||
command="$HOME/bin/rrsync <folder>",no-agent-forwarding,no-port-forwarding,no-pty,no-user-rc,no-X11-forwarding ssh-rsa <cert>
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
`<folder>` is the path to your site. E.g., `~/public_html/you.org/blog-html/`.
|
||||
|
||||
@@ -139,11 +121,11 @@ command="$HOME/bin/rrsync <folder>",no-agent-forwarding,no-port-forwarding,no-pt
|
||||
|
||||
Add the `deploy` script to the site source folder:
|
||||
|
||||
{% highlight bash %}
|
||||
```sh
|
||||
#!/bin/sh
|
||||
|
||||
rsync -crvz --rsh=ssh -p2222' --delete-after --delete-excluded <folder> <user>@<site>:
|
||||
{% endhighlight %}
|
||||
rsync -crvz --rsh='ssh -p2222' --delete-after --delete-excluded <folder> <user>@<site>:
|
||||
```
|
||||
|
||||
Command line parameters are:
|
||||
|
||||
@@ -155,9 +137,9 @@ your host uses a different port than the default (e.g, HostGator)
|
||||
|
||||
Using this setup, you might run the following command:
|
||||
|
||||
{% highlight bash %}
|
||||
rsync -crvz --rsh='ssh -p2222' --delete-after --delete-excluded _site/ hostuser@example.org:
|
||||
{% endhighlight %}
|
||||
```sh
|
||||
rsync -crvz --rsh='ssh -p2222' --delete-after --delete-excluded _site/ hostuser@example.org:
|
||||
```
|
||||
|
||||
Don't forget the column `:` after server name!
|
||||
|
||||
@@ -169,16 +151,16 @@ copy it to the output folder. This behavior can be changed in `_config.yml`.
|
||||
|
||||
Just add the following line:
|
||||
|
||||
{% highlight yaml %}
|
||||
```yaml
|
||||
# Do not copy these files to the output directory
|
||||
exclude: ["deploy"]
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
Alternatively, you can use an `rsync-exclude.txt` file to control which files will be transferred to your server.
|
||||
|
||||
#### Done!
|
||||
|
||||
Now it's possible to publish your website simply by running the `deploy`
|
||||
Now it's possible to publish your website simply by running the `deploy`
|
||||
script. If your SSH certificate is [passphrase-protected](https://martin.kleppmann.com/2013/05/24/improving-security-of-ssh-private-keys.html), you will be asked to enter it when the
|
||||
script executes.
|
||||
|
||||
@@ -186,7 +168,7 @@ script executes.
|
||||
|
||||
[Rack-Jekyll](https://github.com/adaoraul/rack-jekyll/) is an easy way to deploy your site on any Rack server such as Amazon EC2, Slicehost, Heroku, and so forth. It also can run with [shotgun](https://github.com/rtomayko/shotgun/), [rackup](https://github.com/rack/rack), [mongrel](https://github.com/mongrel/mongrel), [unicorn](https://github.com/defunkt/unicorn/), and [others](https://github.com/adaoraul/rack-jekyll#readme).
|
||||
|
||||
Read [this post](http://blog.crowdint.com/2010/08/02/instant-blog-using-jekyll-and-heroku.html) on how to deploy to Heroku using Rack-Jekyll.
|
||||
Read [this post](http://andycroll.com/ruby/serving-a-jekyll-blog-using-heroku) on how to deploy to Heroku using Rack-Jekyll.
|
||||
|
||||
## Jekyll-Admin for Rails
|
||||
|
||||
@@ -205,7 +187,7 @@ low-volume blogs as you only pay for what you use.
|
||||
## OpenShift
|
||||
|
||||
If you'd like to deploy your site to an OpenShift gear, there's [a cartridge
|
||||
for that](https://github.com/openshift-cartridges/openshift-jekyll-cartridge).
|
||||
for that](https://github.com/openshift-quickstart/jekyll-openshift).
|
||||
|
||||
<div class="note">
|
||||
<h5>ProTip™: Use GitHub Pages for zero-hassle Jekyll hosting</h5>
|
||||
@@ -225,3 +207,4 @@ Setting up Kickster is very easy, just install the gem and you are good to go. M
|
||||
[Aerobatic](https://www.aerobatic.com) is an add-on for Bitbucket that brings GitHub Pages style functionality to Bitbucket users. It includes continuous deployment, custom domains with a wildcard SSL cert, CDN, basic auth, and staging branches all in the box.
|
||||
|
||||
Automating the build and deployment of a Jekyll site is just as simple as GitHub Pages - push your changes to your repo (excluding the `_site` directory) and within seconds a build will be triggered and your built site deployed to our highly- available, globally distributed hosting service. The build process will even install and execute custom Ruby plugins. See our [Jekyll docs](https://www.aerobatic.com/docs/static-generators#jekyll) for more details.
|
||||
|
||||
@@ -9,10 +9,10 @@ don't want to publish yet. To get up and running with drafts, create a
|
||||
`_drafts` folder in your site's root (as described in the [site structure](/docs/structure/) section) and create your
|
||||
first draft:
|
||||
|
||||
{% highlight text %}
|
||||
```text
|
||||
|-- _drafts/
|
||||
| |-- a-draft-post.md
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
To preview your site with drafts, simply run `jekyll serve` or `jekyll build`
|
||||
with the `--drafts` switch. Each will be assigned the value modification time
|
||||
@@ -11,9 +11,9 @@ may want to install, depending on how you plan to use Jekyll.
|
||||
|
||||
Kramdown comes with optional support for LaTeX to PNG rendering via [MathJax](https://www.mathjax.org) within math blocks. See the Kramdown documentation on [math blocks](http://kramdown.gettalong.org/syntax.html#math-blocks) and [math support](http://kramdown.gettalong.org/converter/html.html#math-support) for more details. MathJax requires you to include JavaScript or CSS to render the LaTeX, e.g.
|
||||
|
||||
{% highlight html %}
|
||||
```html
|
||||
<script src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML" type="text/javascript"></script>
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
For more information about getting started, check out [this excellent blog post](http://gastonsanchez.com/opinion/2014/02/16/Mathjax-with-jekyll/).
|
||||
|
||||
@@ -10,12 +10,12 @@ Jekyll as a special file. The front matter must be the first thing in the file
|
||||
and must take the form of valid YAML set between triple-dashed lines. Here is a
|
||||
basic example:
|
||||
|
||||
{% highlight yaml %}
|
||||
```yaml
|
||||
---
|
||||
layout: post
|
||||
title: Blogging Like a Hacker
|
||||
---
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
Between these triple-dashed lines, you can set predefined variables (see below
|
||||
for a reference) or even create custom ones of your own. These variables will
|
||||
@@ -96,38 +96,6 @@ front matter of a page or post.
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<p style="margin-bottom: 5px;"><code>category</code></p>
|
||||
<p><code>categories</code></p>
|
||||
</td>
|
||||
<td>
|
||||
<p>
|
||||
|
||||
Instead of placing posts inside of folders, you can specify one or
|
||||
more categories that the post belongs to. When the site is generated
|
||||
the post will act as though it had been set with these categories
|
||||
normally. Categories (plural key) can be specified as a <a
|
||||
href="https://en.wikipedia.org/wiki/YAML#Lists">YAML list</a> or a
|
||||
comma-separated string.
|
||||
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<p><code>tags</code></p>
|
||||
</td>
|
||||
<td>
|
||||
<p>
|
||||
|
||||
Similar to categories, one or multiple tags can be added to a post.
|
||||
Also like categories, tags can be specified as a YAML list or a
|
||||
comma-separated string.
|
||||
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
@@ -140,7 +108,7 @@ 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:
|
||||
|
||||
{% highlight html %}
|
||||
```html
|
||||
<!DOCTYPE HTML>
|
||||
<html>
|
||||
<head>
|
||||
@@ -148,7 +116,7 @@ title:
|
||||
</head>
|
||||
<body>
|
||||
...
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
## Predefined Variables for Posts
|
||||
|
||||
@@ -176,6 +144,39 @@ These are available out-of-the-box to be used in the front matter for a post.
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<p style="margin-bottom: 5px;"><code>category</code></p>
|
||||
<p><code>categories</code></p>
|
||||
</td>
|
||||
<td>
|
||||
<p>
|
||||
|
||||
Instead of placing posts inside of folders, you can specify one or
|
||||
more categories that the post belongs to. When the site is generated
|
||||
the post will act as though it had been set with these categories
|
||||
normally. Categories (plural key) can be specified as a <a
|
||||
href="https://en.wikipedia.org/wiki/YAML#Basic_components">YAML list</a> or a
|
||||
space-separated string.
|
||||
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<p><code>tags</code></p>
|
||||
</td>
|
||||
<td>
|
||||
<p>
|
||||
|
||||
Similar to categories, one or multiple tags can be added to a post.
|
||||
Also like categories, tags can be specified as a <a
|
||||
href="https://en.wikipedia.org/wiki/YAML#Basic_components">YAML list</a> or a
|
||||
space-separated string.
|
||||
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
@@ -22,14 +22,14 @@ 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 URL's.
|
||||
|
||||
{% highlight html %}
|
||||
```html
|
||||
{% raw %}
|
||||
<!-- Useful for styles with static names... -->
|
||||
<link href="{{ site.github.url }}/path/to/css.css" rel="stylesheet">
|
||||
<!-- and for documents/pages whose URL's can change... -->
|
||||
<a href="{{ page.url | prepend: site.github.url }}">{{ page.title }}</a>
|
||||
{% endraw %}
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
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
|
||||
@@ -54,7 +54,7 @@ few minor details.
|
||||
currently-deployed version of the gem in your project, add the
|
||||
following to your <code>Gemfile</code>:
|
||||
|
||||
{% highlight ruby %}
|
||||
```ruby
|
||||
source 'https://rubygems.org'
|
||||
|
||||
require 'json'
|
||||
@@ -62,20 +62,32 @@ require 'open-uri'
|
||||
versions = JSON.parse(open('https://pages.github.com/versions.json').read)
|
||||
|
||||
gem 'github-pages', versions['github-pages']
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
This will ensure that when you run <code>bundle install</code>, you
|
||||
have the correct version of the <code>github-pages</code> gem.
|
||||
|
||||
If that fails, simplify it:
|
||||
|
||||
{% highlight ruby %}
|
||||
```ruby
|
||||
source 'https://rubygems.org'
|
||||
|
||||
gem 'github-pages'
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
And be sure to run <code>bundle update</code> often.
|
||||
|
||||
If you like to install <code>pages-gem</code> on Windows you can find instructions by Jens Willmer on <a href="http://jwillmer.de/blog/tutorial/how-to-install-jekyll-and-pages-gem-on-windows-10-x46#github-pages-and-plugins">how to install github-pages gem on Windows (x64)</a>.
|
||||
</p>
|
||||
</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>
|
||||
|
||||
@@ -103,21 +115,28 @@ publish the GitHub Pages site, so make sure your Jekyll site is stored there.
|
||||
|
||||
Unlike user and organization Pages, Project Pages are kept in the same
|
||||
repository as the project they are for, except that the website content is
|
||||
stored in a specially named `gh-pages` branch. The content of this branch will
|
||||
be rendered using Jekyll, and the output will become available under a subpath
|
||||
of your user pages subdomain, such as `username.github.io/project` (unless a
|
||||
custom domain is specified—see below).
|
||||
stored in a specially named `gh-pages` branch or in a `docs` folder on the
|
||||
`master` branch. The content will be rendered using Jekyll, and the output
|
||||
will become available under a subpath of your user pages subdomain, such as
|
||||
`username.github.io/project` (unless a custom domain is specified).
|
||||
|
||||
The Jekyll project repository itself is a perfect example of this branch
|
||||
structure—the [master branch]({{ site.repository }}) contains the
|
||||
actual software project for Jekyll, however the Jekyll website (that you’re
|
||||
looking at right now) is contained in the [gh-pages
|
||||
branch]({{ site.repository }}/tree/gh-pages) of the same repository.
|
||||
The Jekyll project repository itself is a perfect example: the
|
||||
[master branch]({{ site.repository }}) contains the actual software project
|
||||
for Jekyll, however the Jekyll website (that you’re looking at right now) is
|
||||
contained in the [docs folder]({{ site.repository }}/tree/master/docs) of the
|
||||
same repository.
|
||||
|
||||
Please refer to GitHub official documentation on
|
||||
[user, organization and projets pages](https://help.github.com/articles/user-organization-and-project-pages/)
|
||||
to see more detailed examples.
|
||||
|
||||
<div class="note warning">
|
||||
<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> configuration value, so if you locate your files anywhere other than the root directory, your site may not build correctly.
|
||||
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>
|
||||
configuration value, so if you locate your files anywhere other than the
|
||||
root directory, your site may not build correctly.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
@@ -5,6 +5,451 @@ permalink: "/docs/history/"
|
||||
note: This file is autogenerated. Edit /History.markdown instead.
|
||||
---
|
||||
|
||||
## 3.3.1 / 2016-11-14
|
||||
{: #v3-3-1}
|
||||
|
||||
### Minor Enhancements
|
||||
{: #minor-enhancements-v3-3-1}
|
||||
|
||||
- Collapse `gsub` for performance ([#5494]({{ site.repository }}/issues/5494))
|
||||
- URL: warn if key doesn't exist in url drop ([#5524]({{ site.repository }}/issues/5524))
|
||||
|
||||
### Bug Fixes
|
||||
{: #bug-fixes-v3-3-1}
|
||||
|
||||
- Fix typo in `theme_template` README ([#5472]({{ site.repository }}/issues/5472))
|
||||
- Do not swallow all exceptions on render ([#5495]({{ site.repository }}/issues/5495))
|
||||
- Site template: fixed `_config.yml` comment typo ([#5511]({{ site.repository }}/issues/5511))
|
||||
- `jekyll new-theme` should specify Jekyll as a runtime dependency for the theme ([#5457]({{ site.repository }}/issues/5457))
|
||||
- Be much more specific about ignoring specific vendored directories. ([#5564]({{ site.repository }}/issues/5564))
|
||||
- Only warn about auto-regeneration bug on Bash On Windows. ([#5464]({{ site.repository }}/issues/5464))
|
||||
- Allow permalink template to have underscores ([#5572]({{ site.repository }}/issues/5572))
|
||||
|
||||
### Site Enhancements
|
||||
{: #site-enhancements-v3-3-1}
|
||||
|
||||
- Documentation: `link` Liquid tag ([#5449]({{ site.repository }}/issues/5449))
|
||||
- Updating install instruction link for Jekyll 3 on Windows ([#5475]({{ site.repository }}/issues/5475))
|
||||
- Update normalize.css to v5.0.0 ([#5471]({{ site.repository }}/issues/5471))
|
||||
- Add jekyll-data to the list of plugins ([#5491]({{ site.repository }}/issues/5491))
|
||||
- Add info about checking version + updating ([#5497]({{ site.repository }}/issues/5497))
|
||||
- Add jekyll-include-absolute-plugin to list of third-party plugins ([#5492]({{ site.repository }}/issues/5492))
|
||||
- Remove jekyll-hook from deployment methods ([#5502]({{ site.repository }}/issues/5502))
|
||||
- Update deployment-methods.md ([#5504]({{ site.repository }}/issues/5504))
|
||||
- Ubuntu users should install ruby2.3-dev ([#5512]({{ site.repository }}/issues/5512))
|
||||
- Remove Glynn as deployment option ([#5519]({{ site.repository }}/issues/5519))
|
||||
- Fix broken forum link ([#5466]({{ site.repository }}/issues/5466))
|
||||
- Move documentation to docs folder ([#5459]({{ site.repository }}/issues/5459))
|
||||
- Fix broken links in CONTRIBUTING ([#5533]({{ site.repository }}/issues/5533))
|
||||
- Update documentation on jekyllrb.com ([#5540]({{ site.repository }}/issues/5540))
|
||||
- Fix HTML rendering ([#5536]({{ site.repository }}/issues/5536))
|
||||
- Remove outdated deployment information ([#5557]({{ site.repository }}/issues/5557))
|
||||
- no more invalid US-ASCII on lines 30 and 97 ([#5520]({{ site.repository }}/issues/5520))
|
||||
- Add permalinks to docs in '/maintaining/' ([#5532]({{ site.repository }}/issues/5532))
|
||||
- Add jekyll-pinboard to list of third-party plugins ([#5514]({{ site.repository }}/issues/5514))
|
||||
- Fix formatting in 2-to-3.md ([#5507]({{ site.repository }}/issues/5507))
|
||||
- Add two plugins to the plugins page ([#5493]({{ site.repository }}/issues/5493))
|
||||
- Use site.baseurl before link and post_url tags ([#5559]({{ site.repository }}/issues/5559))
|
||||
- Fix link to jekyll-pinboard plugin ([#5570]({{ site.repository }}/issues/5570))
|
||||
- mention `docs` folder as a way to deploy on GitHub Pages ([#5571]({{ site.repository }}/issues/5571))
|
||||
|
||||
### Development Fixes
|
||||
{: #development-fixes-v3-3-1}
|
||||
|
||||
- fix rubocop errors on testing with Rubocop 0.44 ([#5489]({{ site.repository }}/issues/5489))
|
||||
- script/test: add missing whitespace ([#5479]({{ site.repository }}/issues/5479))
|
||||
- Restrict Rubocop version ([#5496]({{ site.repository }}/issues/5496))
|
||||
- include a hashbang for all benchmark scripts & make them executable ([#5505]({{ site.repository }}/issues/5505))
|
||||
- Update source in script/proof ([#5538]({{ site.repository }}/issues/5538))
|
||||
- Collections.feature: conditional steps to have it pass on Windows ([#5546]({{ site.repository }}/issues/5546))
|
||||
- Fix tests to get script/test to pass on Windows ([#5526]({{ site.repository }}/issues/5526))
|
||||
|
||||
|
||||
## 3.3.0 / 2016-10-06
|
||||
{: #v3-3-0}
|
||||
|
||||
### Minor Enhancements
|
||||
{: #minor-enhancements-v3-3-0}
|
||||
|
||||
- Colorize interpolated output in logger.info ([#5239]({{ site.repository }}/issues/5239))
|
||||
- Site template: exclude Gemfile and Gemfile.lock in site config ([#5293]({{ site.repository }}/issues/5293))
|
||||
- Fix [#5233]({{ site.repository }}/issues/5233): Increase our ability to detect Windows. ([#5235]({{ site.repository }}/issues/5235))
|
||||
- update gitignore template to ignore theme gems built by user ([#5326]({{ site.repository }}/issues/5326))
|
||||
- Adds ability to link to all files ([#5199]({{ site.repository }}/issues/5199))
|
||||
- Exclude vendor by default ([#5361]({{ site.repository }}/issues/5361))
|
||||
- Add ThemeAssetsReader which reads assets from a theme ([#5364]({{ site.repository }}/issues/5364))
|
||||
- Add bundle install to jekyll new command ([#5237]({{ site.repository }}/issues/5237))
|
||||
- Add absolute_url and relative_url filters. ([#5399]({{ site.repository }}/issues/5399))
|
||||
- Site template: remove `css/` from new site scaffolding ([#5402]({{ site.repository }}/issues/5402))
|
||||
- Site template: Move contents of the index.html page to the 'home' layout ([#5420]({{ site.repository }}/issues/5420))
|
||||
- Exclude node_modules by default ([#5210]({{ site.repository }}/issues/5210))
|
||||
- Run hooks in priority order. ([#5157]({{ site.repository }}/issues/5157))
|
||||
- Add `static_file.name` and `.basename` Liquid attributes ([#5264]({{ site.repository }}/issues/5264))
|
||||
- set site.url in dev environment to `http://localhost:4000` ([#5431]({{ site.repository }}/issues/5431))
|
||||
- Add support for indented link references on excerpt ([#5212]({{ site.repository }}/issues/5212))
|
||||
|
||||
### Bug Fixes
|
||||
{: #bug-fixes-v3-3-0}
|
||||
|
||||
- Use jekyll-feed to generate the default site's RSS feed ([#5196]({{ site.repository }}/issues/5196))
|
||||
- Site#configure_theme: do not set theme unless it's a string ([#5189]({{ site.repository }}/issues/5189))
|
||||
- Convertible: set self.output in #render_all_layouts and #do_layout ([#5337]({{ site.repository }}/issues/5337))
|
||||
- Only complain about `kramdown.coderay` if it is actually in the config ([#5380]({{ site.repository }}/issues/5380))
|
||||
- Clarify documentation in theme gem's README template ([#5376]({{ site.repository }}/issues/5376))
|
||||
- Allow underscore in highlighter language ([#5375]({{ site.repository }}/issues/5375))
|
||||
- Site template: set empty url in config file by default ([#5338]({{ site.repository }}/issues/5338))
|
||||
- Site template config: prepend 'jekyll serve' with 'bundle exec' ([#5430]({{ site.repository }}/issues/5430))
|
||||
- Don't call `File.utime` for StaticFiles if it's a symlink ([#5427]({{ site.repository }}/issues/5427))
|
||||
- Fix handling of non-ASCII characters in new `*_url` filters ([#5410]({{ site.repository }}/issues/5410))
|
||||
- Remove autoload of Draft which no longer exists. ([#5441]({{ site.repository }}/issues/5441))
|
||||
- Fix issue where Windows drive name is stripped from Jekyll.sanitized_path incorrectly ([#5256]({{ site.repository }}/issues/5256))
|
||||
- Fix bug where `post_url` tag matched incorrect post with subdirectory ([#4873]({{ site.repository }}/issues/4873))
|
||||
- Fix loading data from subdir with a period in name ([#5433]({{ site.repository }}/issues/5433))
|
||||
- Revert Commands::Serve#server_address signature change. ([#5456]({{ site.repository }}/issues/5456))
|
||||
|
||||
### Site Enhancements
|
||||
{: #site-enhancements-v3-3-0}
|
||||
|
||||
- Document `to_integer` and `inspect` filters ([#5185]({{ site.repository }}/issues/5185))
|
||||
- Fix path in the prompt ([#5194]({{ site.repository }}/issues/5194))
|
||||
- need subcommand build ([#5190]({{ site.repository }}/issues/5190))
|
||||
- Add the Jekyll Cloudinary plugin ([#5183]({{ site.repository }}/issues/5183))
|
||||
- Documentation : `new-theme` command ([#5205]({{ site.repository }}/issues/5205))
|
||||
- Document `link` Liquid tag ([#5182]({{ site.repository }}/issues/5182))
|
||||
- Remove mention of page for link tag in release post ([#5214]({{ site.repository }}/issues/5214))
|
||||
- fixed typo ([#5226]({{ site.repository }}/issues/5226))
|
||||
- Add missing comma ([#5222]({{ site.repository }}/issues/5222))
|
||||
- Maintain aspect ratio with `height: auto;` ([#5254]({{ site.repository }}/issues/5254))
|
||||
- Fix a link in deployment-methods.md ([#5244]({{ site.repository }}/issues/5244))
|
||||
- Documentation: improve highlight in `Creating a theme` ([#5249]({{ site.repository }}/issues/5249))
|
||||
- Bundler isn't installed by default ([#5258]({{ site.repository }}/issues/5258))
|
||||
- Update troubleshooting documentation to include fix for issue with vendored gems ([#5271]({{ site.repository }}/issues/5271))
|
||||
- Link `--lsi` option's description to Wikipedia docs on LSI ([#5274]({{ site.repository }}/issues/5274))
|
||||
- Document `--profile` option on the configuration page ([#5279]({{ site.repository }}/issues/5279))
|
||||
- Update homepage to sync with merge of [#5258]({{ site.repository }}/issues/5258) ([#5287]({{ site.repository }}/issues/5287))
|
||||
- Add post about Jekyll Admin initial release ([#5291]({{ site.repository }}/issues/5291))
|
||||
- Replace liquid highlight tag with backticks ([#5262]({{ site.repository }}/issues/5262))
|
||||
- Word update ([#5294]({{ site.repository }}/issues/5294))
|
||||
- Site documentation section links always point to https://jekyllrb.com ([#5281]({{ site.repository }}/issues/5281))
|
||||
- Missing `:site, :post_render` payload documentation on site ([#5280]({{ site.repository }}/issues/5280))
|
||||
- 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 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))
|
||||
- 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))
|
||||
- Add jekyll-menus to the list of plugins. ([#5397]({{ site.repository }}/issues/5397))
|
||||
- macOS and one grammar fix ([#5403]({{ site.repository }}/issues/5403))
|
||||
- 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))
|
||||
- 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))
|
||||
|
||||
### Development Fixes
|
||||
{: #development-fixes-v3-3-0}
|
||||
|
||||
- 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))
|
||||
- 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))
|
||||
- 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))
|
||||
- Proxy a number of Convertible methods to Renderer ([#5308]({{ site.repository }}/issues/5308))
|
||||
- Run executable for Cucumber via Ruby instead of Shell ([#5383]({{ site.repository }}/issues/5383))
|
||||
- Appease Rubocop ([#5381]({{ site.repository }}/issues/5381))
|
||||
- remove features' directories on windows with proper access ([#5389]({{ site.repository }}/issues/5389))
|
||||
- `site_configuration.feature`: use UTC format in timezone ([#5416]({{ site.repository }}/issues/5416))
|
||||
- swallow bundle output from `jekyll new` while in CI ([#5408]({{ site.repository }}/issues/5408))
|
||||
- Add .editorconfig ([#5412]({{ site.repository }}/issues/5412))
|
||||
|
||||
|
||||
## 3.2.1 / 2016-08-02
|
||||
{: #v3-2-1}
|
||||
|
||||
### Bug Fixes
|
||||
{: #bug-fixes-v3-2-1}
|
||||
|
||||
- Include theme directories in default gemspec ([#5152]({{ site.repository }}/issues/5152))
|
||||
- Fix for symlinked themes ([#5156]({{ site.repository }}/issues/5156))
|
||||
- Layout: set `relative_path` without using Pathname ([#5164]({{ site.repository }}/issues/5164))
|
||||
|
||||
### Development Fixes
|
||||
{: #development-fixes-v3-2-1}
|
||||
|
||||
- Add test to build the default site ([#5154]({{ site.repository }}/issues/5154))
|
||||
- script/default-site: specify `BUNDLE_GEMFILE` for new site ([#5178]({{ site.repository }}/issues/5178))
|
||||
- script/default-site: read Jekyll source from local clone ([#5188]({{ site.repository }}/issues/5188))
|
||||
|
||||
### Site Enhancements
|
||||
{: #site-enhancements-v3-2-1}
|
||||
|
||||
- Enable site excerpts ([#5150]({{ site.repository }}/issues/5150))
|
||||
- Initial 404 page ([#5143]({{ site.repository }}/issues/5143))
|
||||
- Remove the "this feature is unreleased" warning from the theme docs ([#5158]({{ site.repository }}/issues/5158))
|
||||
- Future True on GitHub Pages note ([#5173]({{ site.repository }}/issues/5173))
|
||||
- Minor updates and corrections ([#5177]({{ site.repository }}/issues/5177))
|
||||
- index.html: update instructions to require bundler ([#5169]({{ site.repository }}/issues/5169))
|
||||
- docs/quickstart: update instructions to require bundler ([#5168]({{ site.repository }}/issues/5168))
|
||||
|
||||
|
||||
## 3.2.0 / 2016-07-26
|
||||
{: #v3-2-0}
|
||||
|
||||
### Minor Enhancements
|
||||
{: #minor-enhancements-v3-2-0}
|
||||
|
||||
- Stop testing with Ruby 2.0.x, which is EOL'd. ([#4381]({{ site.repository }}/issues/4381))
|
||||
- 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))
|
||||
- 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))
|
||||
- Clean up `Tags::PostUrl` a bit, including better errors and date parsing ([#4670]({{ site.repository }}/issues/4670))
|
||||
- Use `String#encode` for `xml_escape` filter instead of `CGI.escapeHTML` ([#4694]({{ site.repository }}/issues/4694))
|
||||
- Add `show_dir_listing` option for serve command and fix index file names ([#4533]({{ site.repository }}/issues/4533))
|
||||
- Site Template: write a Gemfile which is educational to the new site ([#4542]({{ site.repository }}/issues/4542))
|
||||
- Site template: add explanation of site variables in the example `_config.yml` ([#4704]({{ site.repository }}/issues/4704))
|
||||
- Adds `link` Liquid tag to make generation of URL's easier ([#4624]({{ site.repository }}/issues/4624))
|
||||
- Allow static files to be symlinked in unsafe mode or non-prod environments ([#4640]({{ site.repository }}/issues/4640))
|
||||
- Add `:after_init` hook & add `Site#config=` to make resetting config easy ([#4703]({{ site.repository }}/issues/4703))
|
||||
- DocumentDrop: add `#<=>` which sorts by date (falling back to path) ([#4741]({{ site.repository }}/issues/4741))
|
||||
- Add a `where_exp` filter for filtering by expression ([#4478]({{ site.repository }}/issues/4478))
|
||||
- Globalize Jekyll's Filters. ([#4792]({{ site.repository }}/issues/4792))
|
||||
- Gem-based themes ([#4595]({{ site.repository }}/issues/4595))
|
||||
- Allow symlinks if they point to stuff inside `site.source` ([#4710]({{ site.repository }}/issues/4710))
|
||||
- Update colorator dependency to v1.x ([#4855]({{ site.repository }}/issues/4855))
|
||||
- Move EntryFilter to use Pathutil & fix `glob_include?` ([#4859]({{ site.repository }}/issues/4859))
|
||||
- Add 'jekyll new-theme' command to help users get up and running creating a theme ([#4848]({{ site.repository }}/issues/4848))
|
||||
- `markdownify` and `smartify` should convert input to string before conversion ([#4958]({{ site.repository }}/issues/4958))
|
||||
- Run `Site#generate` for 'jekyll doctor' to catch plugin issues ([#5005]({{ site.repository }}/issues/5005))
|
||||
- Add `normalize_whitepace` filter ([#4917]({{ site.repository }}/issues/4917))
|
||||
- Move bin/jekyll to exe/jekyll to prevent collision with binstubs ([#5014]({{ site.repository }}/issues/5014))
|
||||
- Cleaning up site template & theme updates. ([#4922]({{ site.repository }}/issues/4922))
|
||||
- Add fetch method to Drops ([#5056]({{ site.repository }}/issues/5056))
|
||||
- Extract tag name to class method ([#5063]({{ site.repository }}/issues/5063))
|
||||
- check if relative URL contains a colon ([#5069]({{ site.repository }}/issues/5069))
|
||||
- Enable strict (or lax) liquid parsing via a config variable. ([#5053]({{ site.repository }}/issues/5053))
|
||||
- Add filter: `to_integer` ([#5101]({{ site.repository }}/issues/5101))
|
||||
- watcher: pass site instance to watch plugin ([#5109]({{ site.repository }}/issues/5109))
|
||||
- Show liquid warnings. ([#5129]({{ site.repository }}/issues/5129))
|
||||
- Add `--baseurl` to `build` subcommand ([#5135]({{ site.repository }}/issues/5135))
|
||||
|
||||
### Bug Fixes
|
||||
{: #bug-fixes-v3-2-0}
|
||||
|
||||
- Site Template: Added a default lang attribute ([#4633]({{ site.repository }}/issues/4633))
|
||||
- Site template: Escape title and description where it is used in HTML ([#4606]({{ site.repository }}/issues/4606))
|
||||
- `Document#date`: drafts which have no date should use source file mtime ([#4611]({{ site.repository }}/issues/4611))
|
||||
- `Filters#time`: clone an input Time so as to be non-destructive ([#4590]({{ site.repository }}/issues/4590))
|
||||
- Doctor: fix issue where `--config` wasn't a recognized flag ([#4598]({{ site.repository }}/issues/4598))
|
||||
- Ensures `related_posts` are only set for a post ([#4620]({{ site.repository }}/issues/4620))
|
||||
- `EntryFilter#special?`: ignore filenames which begin with `~` ([#4491]({{ site.repository }}/issues/4491))
|
||||
- Cleaner: `keep_files` should only apply to the beginning of paths, not substrings with index > 0 ([#3849]({{ site.repository }}/issues/3849))
|
||||
- Use SSLEnable instead of EnableSSL and make URL HTTPS. ([#4693]({{ site.repository }}/issues/4693))
|
||||
- convertible: use `Document::YAML_FRONT_MATTER_REGEXP` to parse transformable files ([#4786]({{ site.repository }}/issues/4786))
|
||||
- Example in the site template should be IANA-approved example.com ([#4793]({{ site.repository }}/issues/4793))
|
||||
- 3.2.x/master: Fix defaults for Documents (posts/collection docs) ([#4808]({{ site.repository }}/issues/4808))
|
||||
- Don't rescue LoadError or bundler load errors for Bundler. ([#4857]({{ site.repository }}/issues/4857))
|
||||
- `Serve.process` should receive same config as `Build.process` ([#4953]({{ site.repository }}/issues/4953))
|
||||
- Prevent reset of page in Liquid payload right before rendering layouts ([#5009]({{ site.repository }}/issues/5009))
|
||||
- Add missing fields to ExcerptDrop ([#5067]({{ site.repository }}/issues/5067))
|
||||
- Stringify configuration overrides before first use ([#5060]({{ site.repository }}/issues/5060))
|
||||
- hooks: move `after_init` hook call at the end of `Site#initialize` ([#5106]({{ site.repository }}/issues/5106))
|
||||
- filters: raise error if no input given to date filters ([#5127]({{ site.repository }}/issues/5127))
|
||||
- `where_exp` filter should filter posts ([#4860]({{ site.repository }}/issues/4860))
|
||||
|
||||
### Forward Ports
|
||||
{: #forward-ports-v3-2-0}
|
||||
|
||||
- From v3.1.4: Add ExcerptDrop and remove excerpt's ability to refer to itself in Liquid ([#4941]({{ site.repository }}/issues/4941))
|
||||
- From v3.1.4: Configuration permalink fix and addition of Configuration.from and sorting `site.collections` by label ([#4942]({{ site.repository }}/issues/4942))
|
||||
- From v3.1.4: Fix {% raw %}`{{ layout }}`{% endraw %} oddities (proper inheritance & fixing overflow of old data) ([#4943]({{ site.repository }}/issues/4943))
|
||||
- From v3.1.5: Sort the results of the `require_all` glob ([#4944]({{ site.repository }}/issues/4944))
|
||||
- From v3.1.6: Add ability to render drops as JSON ([#4945]({{ site.repository }}/issues/4945))
|
||||
|
||||
### Development Fixes
|
||||
{: #development-fixes-v3-2-0}
|
||||
|
||||
- Add project maintainer profile links ([#4591]({{ site.repository }}/issues/4591))
|
||||
- Fix state leakage in Kramdown test ([#4618]({{ site.repository }}/issues/4618))
|
||||
- Unify method for copying special files from repo to site ([#4601]({{ site.repository }}/issues/4601))
|
||||
- Refresh the contributing file ([#4596]({{ site.repository }}/issues/4596))
|
||||
- change smartify doc from copy/paste of mardownify doc ([#4653]({{ site.repository }}/issues/4653))
|
||||
- Update Rake & disable warnings when running tests ([#4720]({{ site.repository }}/issues/4720))
|
||||
- Fix many warnings ([#4537]({{ site.repository }}/issues/4537))
|
||||
- Don't blindly assume the last system when determining "open" cmd ([#4717]({{ site.repository }}/issues/4717))
|
||||
- Fix "locally" typo in contributing documentation ([#4756]({{ site.repository }}/issues/4756))
|
||||
- Update Rubocop rules ([#4886]({{ site.repository }}/issues/4886))
|
||||
- Flesh out the issue template to be much more detailed ([#4849]({{ site.repository }}/issues/4849))
|
||||
- Fixing rubocop offenses in lib/jekyll/cleaner.rb ([#4892]({{ site.repository }}/issues/4892))
|
||||
- Update `jekyll/commands*` to pass rubocop rules ([#4888]({{ site.repository }}/issues/4888))
|
||||
- Clean up many test files to pass Rubocop rules ([#4902]({{ site.repository }}/issues/4902))
|
||||
- Rubocop cleanup for some utils and further test files ([#4916]({{ site.repository }}/issues/4916))
|
||||
- Rubocop: Low hanging fruit ([#4936]({{ site.repository }}/issues/4936))
|
||||
- Rubocop: `Drop` changes from v3.1 forward-ports ([#4949]({{ site.repository }}/issues/4949))
|
||||
- Rubocop: cleanup for misc files ([#4946]({{ site.repository }}/issues/4946))
|
||||
- Rubocop: Stevenson ([#4951]({{ site.repository }}/issues/4951))
|
||||
- Rubocop: lib/jekyll/entry_filter.rb ([#4950]({{ site.repository }}/issues/4950))
|
||||
- Rubocop: `test/*` ([#4947]({{ site.repository }}/issues/4947))
|
||||
- Rubocop: features ([#4934]({{ site.repository }}/issues/4934))
|
||||
- Rubocop: Liquid renderer ([#4933]({{ site.repository }}/issues/4933))
|
||||
- Rubocop: converters ([#4931]({{ site.repository }}/issues/4931))
|
||||
- Rubocop: Site Drop ([#4948]({{ site.repository }}/issues/4948))
|
||||
- Rubocop: tags ([#4938]({{ site.repository }}/issues/4938))
|
||||
- Rubocop: Readers ([#4932]({{ site.repository }}/issues/4932))
|
||||
- rubocop: jekyll/lib/frontmatter_defaults.rb ([#4974]({{ site.repository }}/issues/4974))
|
||||
- rubocop: features/step_definitions.rb ([#4956]({{ site.repository }}/issues/4956))
|
||||
- Rubocop theme and url jekyll libs ([#4959]({{ site.repository }}/issues/4959))
|
||||
- Rubocop jekyll.rb ([#4966]({{ site.repository }}/issues/4966))
|
||||
- Rubocop: use %r for all regular expressions. ([#4979]({{ site.repository }}/issues/4979))
|
||||
- Cleanup and make misc files compliant with Rubocop. ([#4940]({{ site.repository }}/issues/4940))
|
||||
- Rubocop: jekyll/lib/site.rb ([#4973]({{ site.repository }}/issues/4973))
|
||||
- Add timings for each scenario in cucumber & print worst offenders ([#4908]({{ site.repository }}/issues/4908))
|
||||
- rubocop: jekyll/lib/filters.rb ([#4993]({{ site.repository }}/issues/4993))
|
||||
- Fix rubocop offenses in exe/jekyll ([#5017]({{ site.repository }}/issues/5017))
|
||||
- Rubocop: lib/jekyll/command.rb ([#5018]({{ site.repository }}/issues/5018))
|
||||
- rubocop: lib/jekyll/static_file.rb ([#5019]({{ site.repository }}/issues/5019))
|
||||
- rubocop: lib/jekyll/utils.rb ([#5026]({{ site.repository }}/issues/5026))
|
||||
- rubocop: lib/jekyll/regenerator.rb ([#5025]({{ site.repository }}/issues/5025))
|
||||
- rubocop: lib/jekyll/configuration.rb ([#5024]({{ site.repository }}/issues/5024))
|
||||
- rubocop: lib/jekyll/renderer.rb style fixes ([#5032]({{ site.repository }}/issues/5032))
|
||||
- rubocop: lib/jekyll/convertible.rb style fixes ([#5031]({{ site.repository }}/issues/5031))
|
||||
- rubocop: lib/jekyll/document.rb style fixes ([#5030]({{ site.repository }}/issues/5030))
|
||||
- Remove ruby-head from Travis matrix & fix jruby failures ([#5015]({{ site.repository }}/issues/5015))
|
||||
- Remove useless statement from Configuration test ([#5065]({{ site.repository }}/issues/5065))
|
||||
- Change baseurl to example.com for some test cases ([#5068]({{ site.repository }}/issues/5068))
|
||||
- use activesupport < 5 if we are on a Ruby < 2.2.2 ([#5100]({{ site.repository }}/issues/5100))
|
||||
- Internal documentation for working on Jekyll ([#5011]({{ site.repository }}/issues/5011))
|
||||
- rubocop: lib/jekyll/collection.rb ([#5022]({{ site.repository }}/issues/5022))
|
||||
- tests: Typo fixes. ([#5114]({{ site.repository }}/issues/5114))
|
||||
- Normalize yml files. ([#5116]({{ site.repository }}/issues/5116))
|
||||
- Whitespace cleanup. ([#5113]({{ site.repository }}/issues/5113))
|
||||
- Add AppVeyor support. ([#5115]({{ site.repository }}/issues/5115))
|
||||
- appveyor.yml: drop Ruby 2.0.0. ([#5119]({{ site.repository }}/issues/5119))
|
||||
- Fix indentation in benchmark ([#5124]({{ site.repository }}/issues/5124))
|
||||
- Style fixes for Rubocop 0.42.0 - var == 0 becomes var.zero? - when defining method_missing, also define respond_to_missing? ([#5137]({{ site.repository }}/issues/5137))
|
||||
|
||||
### Site Enhancements
|
||||
{: #site-enhancements-v3-2-0}
|
||||
|
||||
- Add jekyll-seo-tag, jekyll-avatar, and jekyll-sitemap to the site ([#4553]({{ site.repository }}/issues/4553))
|
||||
- Add Google search query to /docs/help/ ([#4589]({{ site.repository }}/issues/4589))
|
||||
- Upgrading, documentation ([#4597]({{ site.repository }}/issues/4597))
|
||||
- Add 'view source' entry ([#4602]({{ site.repository }}/issues/4602))
|
||||
- Add jekyll-video-embed to list of third-party plugins. ([#4621]({{ site.repository }}/issues/4621))
|
||||
- Adding Aerobatic to list of deployment options ([#4630]({{ site.repository }}/issues/4630))
|
||||
- Update documentation: HTMLProofer CLI command ([#4641]({{ site.repository }}/issues/4641))
|
||||
- Document that subdirectories of `_posts` are no longer categories ([#4639]({{ site.repository }}/issues/4639))
|
||||
- Update continuous-integration docs with sudo: false information ([#4628]({{ site.repository }}/issues/4628))
|
||||
- Blog post on refreshed contributing file and new affinity teams ([#4645]({{ site.repository }}/issues/4645))
|
||||
- Fixes typo on collections ([#4647]({{ site.repository }}/issues/4647))
|
||||
- Documentation: future option also works for collections ([#4682]({{ site.repository }}/issues/4682))
|
||||
- Additional package needed for Fedora 23 Workspace ([#4685]({{ site.repository }}/issues/4685))
|
||||
- Fix typo on Chocolatey name in Windows documentation ([#4686]({{ site.repository }}/issues/4686))
|
||||
- Use the correct URL, Fixes [#4698]({{ site.repository }}/issues/4698) ([#4699]({{ site.repository }}/issues/4699))
|
||||
- Add jekyll-paspagon plugin ([#4700]({{ site.repository }}/issues/4700))
|
||||
- Bold-italicize note in assets documentation about needing yaml front matter ([#4706]({{ site.repository }}/issues/4706))
|
||||
- Highlight the `script/` calls in the Contributing documentation ([#4712]({{ site.repository }}/issues/4712))
|
||||
- Add Hawkins to the list of third-party plugins ([#4755]({{ site.repository }}/issues/4755))
|
||||
- Fix a typo in pagination doc ([#4763]({{ site.repository }}/issues/4763))
|
||||
- Switch second GitHub Pages link to HTTPS ([#4760]({{ site.repository }}/issues/4760))
|
||||
- Explain data file format requirements more clearly in documentation ([#4781]({{ site.repository }}/issues/4781))
|
||||
- Add jekyll-i18n_tags to list of third-party plugins ([#4775]({{ site.repository }}/issues/4775))
|
||||
- Remove Leonard Lamprecht's website from Sites page ([#4771]({{ site.repository }}/issues/4771))
|
||||
- Updates documentation for collections to include `date` property ([#4769]({{ site.repository }}/issues/4769))
|
||||
- Added an explicit rerun note to configuration.md, defaults section ([#4734]({{ site.repository }}/issues/4734))
|
||||
- Update Rack-Jekyll Heroku deployment blog post url ([#4789]({{ site.repository }}/issues/4789))
|
||||
- Added missing single quote on rsync client side command ([#4813]({{ site.repository }}/issues/4813))
|
||||
- Organize Form Platforms-as-a-Service into unified list & add FormSpree.io ([#4754]({{ site.repository }}/issues/4754))
|
||||
- Fixed typo on Configuration page ([#4804]({{ site.repository }}/issues/4804))
|
||||
- Update FormKeep URL on the Resources doc ([#4844]({{ site.repository }}/issues/4844))
|
||||
- site: use liquid & reduce some whitespace noise ([#4854]({{ site.repository }}/issues/4854))
|
||||
- Add jekyll-breadcrumbs to list of third-party plugins ([#4874]({{ site.repository }}/issues/4874))
|
||||
- Added Pug converter to list of third-party plugins ([#4872]({{ site.repository }}/issues/4872))
|
||||
- Add jekyll-ideal-image-slider to list of third-party plugins ([#4863]({{ site.repository }}/issues/4863))
|
||||
- Add Jekyll Tips and the Cheatsheet to the list of resources ([#4887]({{ site.repository }}/issues/4887))
|
||||
- Removed extra `</p>` from `site/_docs/permalinks.md` ([#4890]({{ site.repository }}/issues/4890))
|
||||
- Add pubstorm deployment instructions to docs ([#4881]({{ site.repository }}/issues/4881))
|
||||
- Corrected pagination docs for hidden: true feature ([#4903]({{ site.repository }}/issues/4903))
|
||||
- Remove a Broken Link for Refheap Plugin ([#4971]({{ site.repository }}/issues/4971))
|
||||
- Instructions on how to install github-gem on Windows ([#4975]({{ site.repository }}/issues/4975))
|
||||
- Minor tweak to fix missing apostrophne ([#4962]({{ site.repository }}/issues/4962))
|
||||
- Instructions on how to install github-gem on Windows (v2) ([#4977]({{ site.repository }}/issues/4977))
|
||||
- Fix inaccurate HTTP response header field name ([#4976]({{ site.repository }}/issues/4976))
|
||||
- Add post about GSoC project ([#4980]({{ site.repository }}/issues/4980))
|
||||
- Link to the HTML page instead of Markdown ([#4985]({{ site.repository }}/issues/4985))
|
||||
- Update normalize.css to v4.0.0. ([#4989]({{ site.repository }}/issues/4989))
|
||||
- Add jekyll-tags-list-plugin to list of third-party plugins ([#5000]({{ site.repository }}/issues/5000))
|
||||
- Windows docs: Command needs to be called from blog path ([#5006]({{ site.repository }}/issues/5006))
|
||||
- Update text to be consitent with example ([#5010]({{ site.repository }}/issues/5010))
|
||||
- Update template links to point to core Liquid site ([#5012]({{ site.repository }}/issues/5012))
|
||||
- Add generator-jekyllized to third-party plugins ([#5027]({{ site.repository }}/issues/5027))
|
||||
- Add Jekyll Art Hallery generator plugin to list of third-party plugins ([#5043]({{ site.repository }}/issues/5043))
|
||||
- Add Formingo to the list of Jekyll form SaaS ([#5054]({{ site.repository }}/issues/5054))
|
||||
- Highlight help nav item when navigated to. ([#5058]({{ site.repository }}/issues/5058))
|
||||
- Update normalize.css to v4.2.0. ([#5096]({{ site.repository }}/issues/5096))
|
||||
- Updates html-proofer code ([#5098]({{ site.repository }}/issues/5098))
|
||||
- Jekyll Community ([#5097]({{ site.repository }}/issues/5097))
|
||||
- Typo in documentation file templates.md ([#5117]({{ site.repository }}/issues/5117))
|
||||
- Slightly, improve PNG compression. ([#5112]({{ site.repository }}/issues/5112))
|
||||
- docs: add jekyll-maps plugin reference ([#5123]({{ site.repository }}/issues/5123))
|
||||
- docs: fix link to plugins page source ([#5122]({{ site.repository }}/issues/5122))
|
||||
- Update the configuration docs to match the code ([#5131]({{ site.repository }}/issues/5131))
|
||||
- Removed confusing word repetition. ([#5139]({{ site.repository }}/issues/5139))
|
||||
- Add a note about script/fmt ([#5138]({{ site.repository }}/issues/5138))
|
||||
|
||||
|
||||
## 3.1.6 / 2016-05-19
|
||||
{: #v3-1-6}
|
||||
|
||||
### Bug Fixes
|
||||
{: #bug-fixes-v3-1-6}
|
||||
|
||||
- Add ability to `jsonify` Drops such that, e.g. `site | jsonify`, works. ([#4914]({{ site.repository }}/issues/4914))
|
||||
|
||||
|
||||
## 3.1.5 / 2016-05-18
|
||||
{: #v3-1-5}
|
||||
|
||||
### Bug Fixes
|
||||
{: #bug-fixes-v3-1-5}
|
||||
|
||||
- Sort the results of the `require_all` glob (affects Linux only). ([#4912]({{ site.repository }}/issues/4912))
|
||||
|
||||
|
||||
## 3.1.4 / 2016-05-18
|
||||
{: #v3-1-4}
|
||||
|
||||
### Bug Fixes
|
||||
{: #bug-fixes-v3-1-4}
|
||||
|
||||
- Add `ExcerptDrop` and remove excerpt's ability to refer to itself in Liquid ([#4907]({{ site.repository }}/issues/4907))
|
||||
- Configuration permalink fix where `collections.posts.permalink` inherits properly from `permalink` only when it doesn't exist ([#4910]({{ site.repository }}/issues/4910))
|
||||
- Add `Configuration.from` to make it easier to build configs from just a hash
|
||||
- Sorting `site.collections` in Liquid by label ([#4910]({{ site.repository }}/issues/4910))
|
||||
- Fix bug where `layout` in Liquid would inherit from previously-rendered layouts' metadatas ([#4909]({{ site.repository }}/issues/4909))
|
||||
- Fix bug where `layout` in Liquid would override in the wrong direction (more-specific layouts' data were overwritten by their parent layouts' data; this has now been reversed) ([#4909]({{ site.repository }}/issues/4909))
|
||||
|
||||
|
||||
## 3.1.3 / 2016-04-18
|
||||
{: #v3-1-3}
|
||||
|
||||
- Fix defaults for Documents to lookup defaults based on `relative_path` instead of `url` ([#4807]({{ site.repository }}/issues/4807))
|
||||
- Use SSLEnable instead of EnableSSL and make URL HTTPS (WEBrick) ([#4693]({{ site.repository }}/issues/4693))
|
||||
|
||||
|
||||
## 3.1.2 / 2016-02-19
|
||||
{: #v3-1-2}
|
||||
|
||||
@@ -168,6 +613,19 @@ note: This file is autogenerated. Edit /History.markdown instead.
|
||||
- Correct Minor spelling error ([#4394]({{ site.repository }}/issues/4394))
|
||||
|
||||
|
||||
## 3.0.5 / 2016-04-26
|
||||
{: #v3-0-5}
|
||||
|
||||
- Remove call to `#backwards_compatibilize` in `Configuration.from` ([#4846]({{ site.repository }}/issues/4846))
|
||||
|
||||
|
||||
## 3.0.4 / 2016-04-18
|
||||
{: #v3-0-4}
|
||||
|
||||
- Fix defaults for Documents to lookup defaults based on `relative_path` instead of `url` ([#4806]({{ site.repository }}/issues/4806))
|
||||
- Configuration: allow users to specify a `collections.posts.permalink` directly without `permalink` clobbering it ([#4753]({{ site.repository }}/issues/4753))
|
||||
|
||||
|
||||
## 3.0.3 / 2016-02-08
|
||||
{: #v3-0-3}
|
||||
|
||||
@@ -7,7 +7,7 @@ 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
|
||||
encountered and how we might make the process easier.
|
||||
|
||||
### Requirements
|
||||
|
||||
@@ -17,7 +17,7 @@ requirements you’ll need to make sure your system has before you start.
|
||||
- [Ruby](https://www.ruby-lang.org/en/downloads/) (including development
|
||||
headers, v1.9.3 or above for Jekyll 2 and v2 or above for Jekyll 3)
|
||||
- [RubyGems](https://rubygems.org/pages/download)
|
||||
- Linux, Unix, or Mac OS X
|
||||
- Linux, Unix, or macOS
|
||||
- [NodeJS](https://nodejs.org/), or another JavaScript runtime (Jekyll 2 and
|
||||
earlier, for CoffeeScript support).
|
||||
- [Python 2.7](https://www.python.org/downloads/) (for Jekyll 2 and earlier)
|
||||
@@ -37,9 +37,9 @@ The best way to install Jekyll is via
|
||||
[RubyGems](http://rubygems.org/pages/download). At the terminal prompt,
|
||||
simply run the following command to install Jekyll:
|
||||
|
||||
{% highlight bash %}
|
||||
```sh
|
||||
$ gem install jekyll
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
All of Jekyll’s gem dependencies are automatically installed by the above
|
||||
command, so you won’t have to worry about them at all. If you have problems
|
||||
@@ -51,8 +51,8 @@ community can improve the experience for everyone.
|
||||
<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 Mac OS X, you will need to install Xcode
|
||||
and the Command-Line Tools it ships with. Download in
|
||||
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>
|
||||
@@ -62,28 +62,28 @@ community can improve the experience for everyone.
|
||||
In order to install a pre-release, make sure you have all the requirements
|
||||
installed properly and run:
|
||||
|
||||
{% highlight bash %}
|
||||
```sh
|
||||
gem install jekyll --pre
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
This will install the latest pre-release. If you want a particular pre-release,
|
||||
use the `-v` switch to indicate the version you'd like to install:
|
||||
|
||||
{% highlight bash %}
|
||||
```sh
|
||||
gem install jekyll -v '2.0.0.alpha.1'
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
If you'd like to install a development version of Jekyll, the process is a bit
|
||||
more involved. This gives you the advantage of having the latest and greatest,
|
||||
but may be unstable.
|
||||
|
||||
{% highlight bash %}
|
||||
```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
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
## Optional Extras
|
||||
|
||||
@@ -103,4 +103,25 @@ Check out [the extras page](../extras/) for more information.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
Now that you’ve got everything installed, let’s get to work!
|
||||
## 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
|
||||
```
|
||||
|
||||
Now that you’ve got everything up-to-date and installed, let’s get to work!
|
||||
30
docs/_docs/maintaining/affinity-team-captain.md
Normal file
30
docs/_docs/maintaining/affinity-team-captain.md
Normal file
@@ -0,0 +1,30 @@
|
||||
---
|
||||
title: Affinity Team Captains
|
||||
layout: docs
|
||||
permalink: /docs/maintaining/affinity-team-captain/
|
||||
---
|
||||
|
||||
**This guide is for affinity team captains.** These special people are **team maintainers** of one of our [affinity teams][] and help triage and evaluate the issues and contributions of others. You may find what is written here interesting, but it’s definitely not for everyone.
|
||||
{: .note .info }
|
||||
|
||||
## Affinity teams & their captains
|
||||
|
||||
The Jekyll project uses [affinity teams][] to help break up the work of incoming issues and pull requests from community members. We receive a sizeable number of issues and pull requests each week; the use of affinity teams helps distribute this load across a number of specialized groups instead of pushing it all onto @jekyll/core.
|
||||
|
||||
## Responsibilities of Team Captains
|
||||
|
||||
Each affinity team has a few captains who manage the issues and pull requests for that team. When an issue or PR is opened with a `/cc` for a given affinity team, @jekyllbot automatically assigns a random affinity team captain to the issue to triage it. They have access to add labels, reassign the issue, give LGTM's, and so forth. While they do not merge PR's today, they are still asked to review PR's for parts of the codebase under their purview.
|
||||
|
||||
## How do I become a team captain?
|
||||
|
||||
Just ask! Feel free to open an issue on `jekyll/jekyll` and add `/cc @jekyll/core`. We can add you. :smile:
|
||||
|
||||
Alternatively, you can email or otherwise reach out to [@parkr](https://github.com/parkr) directly if you prefer the more private route.
|
||||
|
||||
## Ugh, I'm tired and don't have time to be a captain anymore. What now?
|
||||
|
||||
No sweat at all! Email [@parkr](https://github.com/parkr) and ask to be removed. Alternatively, you should be able to go to your team's page on GitHub.com (go to https://github.com/jekyll, click "Teams", click the link to your team) and change your status to either "member" or leave the team.
|
||||
|
||||
We realize that being a captain is no easy feat so we want to make it a great experience. As always, communicate as much as you can with us about what is working, and what isn't. Thanks for dedicating some time to Jekyll! :sparkles:
|
||||
|
||||
[affinity teams]: https://teams.jekyllrb.com/
|
||||
32
docs/_docs/maintaining/avoiding-burnout.md
Normal file
32
docs/_docs/maintaining/avoiding-burnout.md
Normal file
@@ -0,0 +1,32 @@
|
||||
---
|
||||
title: "Avoiding Burnout"
|
||||
layout: docs
|
||||
permalink: /docs/maintaining/avoiding-burnout/
|
||||
---
|
||||
|
||||
**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 }
|
||||
|
||||
# 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.
|
||||
|
||||
# 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.
|
||||
|
||||
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.
|
||||
|
||||
# 3. Prioritise Maintainers Over Users
|
||||
|
||||
It's important to be user-focused but ultimately, as long as you follow #1 above, Jekyll's minimum number of users will be the number of maintainers. However, if Jekyll has no maintainers it will quickly become useless to all users and the project will die. As a result, no user complaint, behaviour or need takes priority over the burnout of maintainers. If users do not like the direction of the project, the easiest way to influence it is to make significant, high-quality code contributions and become a maintainer.
|
||||
|
||||
# 4. Learn To Say No
|
||||
|
||||
Jekyll gets a lot of feature requests, non-reproducible bug reports, usage questions and PRs we won't accept. These should be closed out as soon as we realise that they aren't going to be resolved or merged. This is kinder than deciding this after a long period of review. Our issue tracker should reflect work to be done.
|
||||
|
||||
---
|
||||
|
||||
Thanks to https://gist.github.com/ryanflorence/124070e7c4b3839d4573 which influenced this document.
|
||||
|
||||
Thanks to [Homebrew's "Avoiding Burnout" document](https://github.com/Homebrew/brew/blob/master/docs/Maintainers-Avoiding-Burnout.md) for providing a perfect base for this document.
|
||||
40
docs/_docs/maintaining/becoming-a-maintainer.md
Normal file
40
docs/_docs/maintaining/becoming-a-maintainer.md
Normal file
@@ -0,0 +1,40 @@
|
||||
---
|
||||
title: "Becoming a Maintainer"
|
||||
layout: docs
|
||||
permalink: /docs/maintaining/becoming-a-maintainer/
|
||||
---
|
||||
|
||||
**This guide is for contributors.** These special people have contributed to one or more of Jekyll's repositories, but do not yet have write access to any. You may find what is written here interesting, but it’s definitely not for everyone.
|
||||
{: .note .info }
|
||||
|
||||
So you want to become a maintainer of a Jekyll project? We'd love to have you! Here are some things we like to see from community members before we promote them to maintainers.
|
||||
|
||||
## 1. Use Jekyll
|
||||
|
||||
You want to maintain Jekyll? Use it often. Do weird things with it. Do normal things with it. Does it work? Does it have any weaknesses? Is there a gap in the product that you think should be filled?
|
||||
|
||||
## 2. Help Triage Issues
|
||||
|
||||
Watch the repository you're interested in. Join [an Affinity Team](https://teams.jekyllrb.com) and receive mentions regarding a particular interest area of the project. When you receive a notification for an issue that has not been triaged by a maintainer, dive in. Can you reproduce the issue? Can you determine the fix? [More tips on Triaging an Issue in our maintainer guide](../triaging-an-issue). Every maintainer loves an issue that is resolved before they get to it. :smiley:
|
||||
|
||||
## 3. Write Documentation
|
||||
|
||||
Good documentation means less confusion for our users and fewer issues to triage. Documentation is always in need of fixes and updates as we change the code. Read through the documentation during your normal usage of the product and submit changes as you feel they are necessary.
|
||||
|
||||
## 4. Write Code
|
||||
|
||||
As a maintainer, you will be reviewing pull requests which update code. You should feel comfortable with the Jekyll codebase enough to confidently review any pull request put forward. In order to become more comfortable, write some code of your own and send a pull request. A great place to start is with any issue labeled "bug" in the issue tracker. Write a test which replicates the problem and fails, then work on fixing the code such that the test passes.
|
||||
|
||||
## 5. Review Pull Requests
|
||||
|
||||
Start by reviewing one pull request a week. Leave detailed comments and [follow our guide for reviewing pull requests](../reviewing-a-pull-request).
|
||||
|
||||
## 6. Ask!
|
||||
|
||||
Open an issue describing your contributions to the project and why you wish to be a maintainer. Issues are nice because you can easily reference where you have demonstrated that you help triage issues, write code & documentation, and review pull requests. You may also email any maintainer privately if you do not feel comfortable asking in the open.
|
||||
|
||||
We would love to expand the team and look forward to many more community members becoming maintainers!
|
||||
|
||||
# Helping Out Elsewhere
|
||||
|
||||
In addition to maintainers of our core and plugin code, the Jekyll team is comprised of moderators for our forums. These helpful community members take a look at the topics posted to https://talk.jekyllrb.com and ensure they are properly categorized and are acceptable under our Code of Conduct. If you would like to be a moderator, email one of the maintainers with links to where you have answered questions and a request to be added as a moderator. More help is always welcome.
|
||||
21
docs/_docs/maintaining/index.md
Normal file
21
docs/_docs/maintaining/index.md
Normal file
@@ -0,0 +1,21 @@
|
||||
---
|
||||
layout: docs
|
||||
title: Maintaining Jekyll
|
||||
permalink: /docs/maintaining/
|
||||
---
|
||||
|
||||
**This guide is for Jekyll contributors and maintainers.** These special people contribute to one or more of Jekyll's repositories or help merge the contributions of others. You may find what is written here interesting, but it’s definitely not for everyone.
|
||||
{: .note .info }
|
||||
|
||||
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/)
|
||||
|
||||
Interested in becoming a maintainer? Here is some documentation for **contributors**:
|
||||
|
||||
1. [Becoming a maintainer](becoming-a-maintainer/)
|
||||
55
docs/_docs/maintaining/merging-a-pull-request.md
Normal file
55
docs/_docs/maintaining/merging-a-pull-request.md
Normal file
@@ -0,0 +1,55 @@
|
||||
---
|
||||
title: "Merging a Pull Request"
|
||||
layout: docs
|
||||
permalink: /docs/maintaining/merging-a-pull-request/
|
||||
---
|
||||
|
||||
**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 }
|
||||
|
||||
## Code Review
|
||||
|
||||
All pull requests should be subject to code review. Code review is a [foundational value](https://blog.fullstory.com/what-we-learned-from-google-code-reviews-arent-just-for-catching-bugs-b125a13aa292) of good engineering teams. Besides providing validation of correctness, it promotes a sense of community and gives other maintainers understanding of all parts of the code base. In short, code review is crucial to a healthy open source project.
|
||||
|
||||
**Read our guide for [Reviewing a pull request](../reviewing-a-pull-request) before merging.** Notably, the change must have tests if for code, and at least two maintainers must give it an OK.
|
||||
|
||||
## Merging
|
||||
|
||||
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
|
||||
|
||||
To merge a pull request, leave a comment thanking the contributor, then add the special merge request:
|
||||
|
||||
```text
|
||||
Thank you very much for your contribution. Folks like you make this project and community strong. :heart:
|
||||
|
||||
@jekyllbot: merge +dev
|
||||
```
|
||||
|
||||
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
|
||||
|
||||
The categories match the H3's in the history/changelog 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)
|
||||
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. Site Enhancements (`+site`) – changes to the source of https://jekyllrb.com, found in `site/`
|
||||
5. Development Fixes (`+dev`) – changes which do not affect user-facing functionality or documentation, such as test fixes or bumping internal dependencies
|
||||
|
||||
Once @jekyllbot has merged the pull request, you should see three things:
|
||||
|
||||
1. A successful merge
|
||||
2. Addition of labels for the necessary category if they aren't already applied
|
||||
3. A commit to the `History.markdown` file which adds a note about the change
|
||||
|
||||
If you forget the category, that's just fine. You can always go back and move the line to the proper category header later. The category is always necessary for `jekyll/jekyll`, but many plugins have too few changes to necessitate changelog categories.
|
||||
|
||||
## Rejoice
|
||||
|
||||
You did it! Thanks for being a maintainer for one of our official Jekyll projects. Your work means the world to our thousands of users who rely on Jekyll daily. :heart:
|
||||
48
docs/_docs/maintaining/reviewing-a-pull-request.md
Normal file
48
docs/_docs/maintaining/reviewing-a-pull-request.md
Normal file
@@ -0,0 +1,48 @@
|
||||
---
|
||||
title: "Reviewing a Pull Request"
|
||||
layout: docs
|
||||
permalink: /docs/maintaining/reviewing-a-pull-request/
|
||||
---
|
||||
|
||||
**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 }
|
||||
|
||||
## Respond Kindly
|
||||
|
||||
Above all else, please review a pull request kindly. Our community can only be strong if we make it a welcoming and inclusive environment. To further promote this, the Jekyll community is governed by a [Code of Conduct](/docs/conduct/) by which all community members must abide.
|
||||
|
||||
Use emoji liberally :heart: :tada: :sparkles: :confetti_ball: and feel free to be emotive!! Contributions keep this project moving forward and we're always happy to receive them, even if the pull request isn't ultimately merged.
|
||||
|
||||
Mike McQuaid's post on the GitHub blog entitled ["Kindly Closing Pull Requests"](https://github.com/blog/2124-kindly-closing-pull-requests) is a great place to start. It describes various scenarios in which it would be acceptable to close a pull request for reasons other than lack of technical integrity or accuracy. Part of being kind is responding to and resolving pull requests quickly.
|
||||
|
||||
## Respond Quickly
|
||||
|
||||
We should be able to review all pull requests within one week. The only time initial review should take longer is if all the maintainers mysteriously took vacation during the same week. Promptness encourages frequent, high-quality contributions from community members and other maintainers.
|
||||
|
||||
If your response requires a response on the part of the author, please add the `pending-feedback` tag. @jekyllbot will automatically remove the tag once the author of the pull request responds.
|
||||
|
||||
## Resolve Quickly
|
||||
|
||||
Similarly, we should aim to resolve pull requests quickly. If a pull request introduces a feature which does not fit into the core purpose or goal of the project, close it promptly with a kind explanation of why it is not acceptable.
|
||||
|
||||
Leave detailed comments wherever possible. Provide the contributor with context around why the change you are requesting is necessary, or why the question you are asking is important to resolve. The more context we can clearly communicate to the contributor, the better able the contributor is to provide high-quality patches.
|
||||
|
||||
You may close a pull request if more than 30 days pass without a response from the author.
|
||||
|
||||
In some cases, review will involve many weeks of back-and-forth. As long as communication continues, this is fine. Ideally, any PR would be capable of resolution within 30 days of it being opened.
|
||||
|
||||
## Look for Tests
|
||||
|
||||
If this is a code change, are there tests for the updated or added behaviour? Shipping a version with bugs is inevitable, but ensuring changes are tested helps keep bugs and regressions to a minimum.
|
||||
|
||||
## CI Must Pass
|
||||
|
||||
It is fine to ask a contributor to investigate failures on Travis and patch them up before you begin your review. It is helpful to leave a message for the contributor indicating that the tests have failed and that no review will occur before the tests pass. If they ask for help, take a look and assist if you can.
|
||||
|
||||
## Rule of Two
|
||||
|
||||
A pull request may be merged once two maintainers have reviewed the pull request and indicated that it is acceptable to them. There is no need to wait for a third unless one of the two reviewers wishes for another set of eyes.
|
||||
|
||||
## Think Security
|
||||
|
||||
We owe it to our users to ensure that using a theme from the community or building someone else's site doesn't come with built-in security vulnerabilities. Things like where files may be read from and written to are important to keep secure. Jekyll is also the basis for hosted services such as [GitHub Pages](https://pages.github.com), which cannot upgrade when security issues are introduced.
|
||||
22
docs/_docs/maintaining/special-labels.md
Normal file
22
docs/_docs/maintaining/special-labels.md
Normal file
@@ -0,0 +1,22 @@
|
||||
---
|
||||
title: "Special Labels"
|
||||
layout: docs
|
||||
permalink: /docs/maintaining/special-labels/
|
||||
---
|
||||
|
||||
**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 }
|
||||
|
||||
We use a series of "special labels" on GitHub.com to automate handling of some parts of the pull request and issue process. @jekyllbot may automatically apply or remove certain labels based on actions taken by users or maintainers. Below are the labels and how they work:
|
||||
|
||||
## `pending-feedback`
|
||||
|
||||
This label is used to indicate that we need more information from the issue/PR author in order to continue. It may be that you need more info before you can properly triage a bug report, or that you have some unanswered questions about a PR that need to be resolved before moving forward. You can safely ignore any issue with this label, as it is waiting for feedback.
|
||||
|
||||
## `needs-work` & `pending-rebase`
|
||||
|
||||
These labels are used to indicate that the Git state of a pull request must change. Both are removed once a push is registered (a "synchronize" event for the pull request) and the pull request becomes mergable. Add `needs-work` to a PR if, after your review, it requires code changes. Add `pending-rebase` to a PR if the code is fine but the branch is not automatically mergable with the target branch (e.g. `master`).
|
||||
|
||||
## `stale`
|
||||
|
||||
This label is automatically added and removed by @jekyllbot based on activity on an issue or pull request. The rules for this label are laid out in [Triaging an Issue: Staleness and automatic closure](../triaging-an-issue/#staleness-and-automatic-closure).
|
||||
56
docs/_docs/maintaining/triaging-an-issue.md
Normal file
56
docs/_docs/maintaining/triaging-an-issue.md
Normal file
@@ -0,0 +1,56 @@
|
||||
---
|
||||
title: "Triaging an Issue"
|
||||
layout: docs
|
||||
permalink: /docs/maintaining/triaging-an-issue/
|
||||
---
|
||||
|
||||
**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 }
|
||||
|
||||
Before evaluating an issue, it is important to identify if it is a feature
|
||||
request or a bug. For the Jekyll project the following definitions are used
|
||||
to identify a feature or a bug:
|
||||
|
||||
**Feature** - A feature is defined as a request that adds functionality to
|
||||
Jekyll outside of its current capabilities.
|
||||
**Bug** - A bug is defined as an issue that identifies an error that a user
|
||||
(or users) encounter when using current Jekyll functionalities.
|
||||
|
||||
## Feature?
|
||||
|
||||
If the issue describes a feature request, ask:
|
||||
|
||||
1. Is this a setting? [Settings are a crutch](http://ben.balter.com/2016/03/08/optimizing-for-power-users-and-edge-cases/#settings-are-a-crutch) for doing "the right thing". Settings usually point to a bad default or an edge case that could be solved easily with a plugin. Keep the :christmas_tree: of settings as small as possible so as not to reduce the usability of the product. We like the philosophy "decisions not options."
|
||||
2. Would at least 80% of users find it useful? If even a quarter of our users won't use it, it's very likely that the request doesn't fit our product's core goal.
|
||||
3. Is there another way to accomplish the end goal of the request? Most feature requests are due to bad documentation for or understanding of a pre-existing feature. See if you can clarify the end goal of the request. What is the user trying to do? Could they accomplish that goal through another feature we already support?
|
||||
4. Even if 80% of our users will use it, does it fit the core goal of our project? We are writing a tool for making static websites, not a swiss army knife for publishing more generally.
|
||||
|
||||
Feel free to get others' opinions and ask questions of the issue author, but depending upon the answers to the questions above, it may be out of scope for our project.
|
||||
|
||||
If the request is within scope, prioritize it on the product roadmap with the other maintainers. Apply the appropriate tags and ensure the right people have weighed in to define the feature's scope and implementation. If you want to be the _best ever_, submit a PR yourself which adds the feature.
|
||||
|
||||
## Bug?
|
||||
|
||||
### Reproducibility
|
||||
|
||||
If the bug has clear reproduction steps, take a minute to try them. If it helps, write a test in our test suite for the scenario which replicates the problem. Can you reliably replicate the issue?
|
||||
|
||||
If you can't replicate the issue, post your replication steps which didn't work and ask for clarification from the issue author.
|
||||
|
||||
### Supported Platform
|
||||
|
||||
Is the author using a supported platform? We support the latest versions of macOS, Ubuntu, Debian, CentOS, Fedora, and Arch Linux.
|
||||
|
||||
You may close the issue immediately if the author cannot reproduce the issue on a supported platform. For Windows-related problems, leave a comment letting the user know that Windows is not officially supported, but that they may absolutely continue using the issue to communicate with folks from `@jekyll/windows` to further investigate. Additionally, you can point them to Jekyll Talk (https://talk.jekyllrb.com) as a means of getting support from the community.
|
||||
|
||||
If the user is experiencing issues with GitHub Pages or another hosted platform that we cannot reproduce, please direct them to the platform's support channel and close the issue.
|
||||
|
||||
### What they wanted vs. what they got
|
||||
|
||||
An issue without a clear explanation of what the user got and what they were expecting to get is not an issue we can accurately respond to. If the user doesn't provide this information, please ask for clarification and apply the `pending-feedback` label. This information helps us build test cases such that we do not break the behaviour again in the future. The `pending-feedback` label will be removed automatically once the issue author posts a reply.
|
||||
|
||||
Is what they wanted to get something we want to happen? Sometimes a bug report is actually masquerading as a feature request. See the guidance above for handling feature requests.
|
||||
|
||||
### Staleness and automatic closure
|
||||
|
||||
@jekyllbot will automatically mark issues as `stale` if no activity occurs for at least one month. @jekyllbot leaves a comment asking for information about reproducibility in current versions. If no one responds after another month, the issue is automatically closed.
|
||||
@@ -46,7 +46,7 @@ directory with a suitable name for the page you want to create. For a site with
|
||||
a homepage, an about page, and a contact page, here’s what the root directory
|
||||
and associated URLs might look like:
|
||||
|
||||
{% highlight bash %}
|
||||
```sh
|
||||
.
|
||||
|-- _config.yml
|
||||
|-- _includes/
|
||||
@@ -57,7 +57,7 @@ and associated URLs might look like:
|
||||
|-- index.html # => http://example.com/
|
||||
|-- other.md # => http://example.com/other.html
|
||||
└── contact.html # => http://example.com/contact.html
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
### Named folders containing index HTML files
|
||||
|
||||
@@ -69,7 +69,7 @@ the page URL ends up being the folder name, and the web server will serve up
|
||||
the respective `index.html` file. Here's an example of what this structure
|
||||
might look like:
|
||||
|
||||
{% highlight bash %}
|
||||
```sh
|
||||
.
|
||||
├── _config.yml
|
||||
├── _includes/
|
||||
@@ -83,7 +83,7 @@ might look like:
|
||||
|── other/
|
||||
| └── index.md # => http://example.com/other/
|
||||
└── index.html # => http://example.com/
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
This approach may not suit everyone, but for people who like clean URLs it’s
|
||||
simple and it works. In the end, the decision is yours!
|
||||
@@ -28,18 +28,18 @@ your `_config.yml` under `gems`. For Jekyll 2, this is standard.
|
||||
To enable pagination for your blog, add a line to the `_config.yml` file that
|
||||
specifies how many items should be displayed per page:
|
||||
|
||||
{% highlight yaml %}
|
||||
```yaml
|
||||
paginate: 5
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
The number should be the maximum number of Posts you’d like to be displayed
|
||||
per-page in the generated site.
|
||||
|
||||
You may also specify the destination of the pagination pages:
|
||||
|
||||
{% highlight yaml %}
|
||||
```yaml
|
||||
paginate_path: "/blog/page:num/"
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
This will read in `blog/index.html`, send it each pagination page in Liquid as
|
||||
`paginator` and write the output to `blog/page:num/`, where `:num` is the
|
||||
@@ -133,8 +133,8 @@ attributes:
|
||||
<div class="note info">
|
||||
<h5>Pagination does not support tags or categories</h5>
|
||||
<p>Pagination pages through every post in the <code>posts</code>
|
||||
variable regardless of variables defined in the YAML Front Matter of
|
||||
each. It does not currently allow paging over groups of posts linked
|
||||
variable unless a post has <code>hidden: true</code> in its YAML Front Matter.
|
||||
It does not currently allow paging over groups of posts linked
|
||||
by a common tag or category. It cannot include any collection of
|
||||
documents because it is restricted to posts.</p>
|
||||
</div>
|
||||
@@ -146,7 +146,7 @@ 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:
|
||||
|
||||
{% highlight html %}
|
||||
```html
|
||||
{% raw %}
|
||||
---
|
||||
layout: default
|
||||
@@ -179,7 +179,7 @@ title: My Blog
|
||||
{% endif %}
|
||||
</div>
|
||||
{% endraw %}
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
<div class="note warning">
|
||||
<h5>Beware the page one edge-case</h5>
|
||||
@@ -193,7 +193,7 @@ 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.
|
||||
|
||||
{% highlight html %}
|
||||
```html
|
||||
{% raw %}
|
||||
{% if paginator.total_pages > 1 %}
|
||||
<div class="pagination">
|
||||
@@ -221,4 +221,4 @@ page with links to all but the current page.
|
||||
</div>
|
||||
{% endif %}
|
||||
{% endraw %}
|
||||
{% endhighlight %}
|
||||
```
|
||||
@@ -101,7 +101,6 @@ permalink is defined according to the format `/:categories/:year/:month/:day/:ti
|
||||
<p>
|
||||
Second of the minute from the post’s <code>date</code> front matter. (00..59)
|
||||
</p>
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -93,7 +93,7 @@ For instance, a generator can inject values computed at build time for template
|
||||
variables. In the following example the template `reading.html` has two
|
||||
variables `ongoing` and `done` that we fill in the generator:
|
||||
|
||||
{% highlight ruby %}
|
||||
```ruby
|
||||
module Reading
|
||||
class Generator < Jekyll::Generator
|
||||
def generate(site)
|
||||
@@ -105,11 +105,11 @@ module Reading
|
||||
end
|
||||
end
|
||||
end
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
This is a more complex generator that generates new pages:
|
||||
|
||||
{% highlight ruby %}
|
||||
```ruby
|
||||
module Jekyll
|
||||
|
||||
class CategoryPage < Page
|
||||
@@ -142,7 +142,7 @@ module Jekyll
|
||||
end
|
||||
|
||||
end
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
In this example, our generator will create a series of files under the
|
||||
`categories` directory for each category, listing the posts in each category
|
||||
@@ -189,7 +189,7 @@ languages are implemented using this method.
|
||||
Below is a converter that will take all posts ending in `.upcase` and process
|
||||
them using the `UpcaseConverter`:
|
||||
|
||||
{% highlight ruby %}
|
||||
```ruby
|
||||
module Jekyll
|
||||
class UpcaseConverter < Converter
|
||||
safe true
|
||||
@@ -208,7 +208,7 @@ module Jekyll
|
||||
end
|
||||
end
|
||||
end
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
Converters should implement at a minimum 3 methods:
|
||||
|
||||
@@ -266,16 +266,16 @@ As of version 2.5.0, Jekyll can be extended with plugins which provide
|
||||
subcommands for the `jekyll` executable. This is possible by including the
|
||||
relevant plugins in a `Gemfile` group called `:jekyll_plugins`:
|
||||
|
||||
{% highlight ruby %}
|
||||
```ruby
|
||||
group :jekyll_plugins do
|
||||
gem "my_fancy_jekyll_plugin"
|
||||
end
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
Each `Command` must be a subclass of the `Jekyll::Command` class and must
|
||||
contain one class method: `init_with_program`. An example:
|
||||
|
||||
{% highlight ruby %}
|
||||
```ruby
|
||||
class MyNewCommand < Jekyll::Command
|
||||
class << self
|
||||
def init_with_program(prog)
|
||||
@@ -292,7 +292,7 @@ class MyNewCommand < Jekyll::Command
|
||||
end
|
||||
end
|
||||
end
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
Commands should implement this single class method:
|
||||
|
||||
@@ -328,7 +328,7 @@ hooking into the tagging system. Built-in examples added by Jekyll include the
|
||||
`highlight` and `include` tags. Below is an example of a custom liquid tag that
|
||||
will output the time the page was rendered:
|
||||
|
||||
{% highlight ruby %}
|
||||
```ruby
|
||||
module Jekyll
|
||||
class RenderTimeTag < Liquid::Tag
|
||||
|
||||
@@ -344,7 +344,7 @@ module Jekyll
|
||||
end
|
||||
|
||||
Liquid::Template.register_tag('render_time', Jekyll::RenderTimeTag)
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
At a minimum, liquid tags must implement:
|
||||
|
||||
@@ -372,24 +372,24 @@ At a minimum, liquid tags must implement:
|
||||
You must also register the custom tag with the Liquid template engine as
|
||||
follows:
|
||||
|
||||
{% highlight ruby %}
|
||||
```ruby
|
||||
Liquid::Template.register_tag('render_time', Jekyll::RenderTimeTag)
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
In the example above, we can place the following tag anywhere in one of our
|
||||
pages:
|
||||
|
||||
{% highlight ruby %}
|
||||
```ruby
|
||||
{% raw %}
|
||||
<p>{% render_time page rendered at: %}</p>
|
||||
{% endraw %}
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
And we would get something like this on the page:
|
||||
|
||||
{% highlight html %}
|
||||
```html
|
||||
<p>page rendered at: Tue June 22 23:38:47 –0500 2010</p>
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
### Liquid filters
|
||||
|
||||
@@ -398,7 +398,7 @@ add tags above. Filters are simply modules that export their methods to liquid.
|
||||
All methods will have to take at least one parameter which represents the input
|
||||
of the filter. The return value will be the output of the filter.
|
||||
|
||||
{% highlight ruby %}
|
||||
```ruby
|
||||
module Jekyll
|
||||
module AssetFilter
|
||||
def asset_url(input)
|
||||
@@ -408,7 +408,7 @@ module Jekyll
|
||||
end
|
||||
|
||||
Liquid::Template.register_filter(Jekyll::AssetFilter)
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
<div class="note">
|
||||
<h5>ProTip™: Access the site object using Liquid</h5>
|
||||
@@ -469,7 +469,7 @@ There are two flags to be aware of when writing a plugin:
|
||||
To use one of the example plugins above as an illustration, here is how you’d
|
||||
specify these two flags:
|
||||
|
||||
{% highlight ruby %}
|
||||
```ruby
|
||||
module Jekyll
|
||||
class UpcaseConverter < Converter
|
||||
safe true
|
||||
@@ -477,7 +477,7 @@ module Jekyll
|
||||
...
|
||||
end
|
||||
end
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
## Hooks
|
||||
|
||||
@@ -491,18 +491,20 @@ call whenever the hook is triggered. For example, if you want to execute some
|
||||
custom functionality every time Jekyll renders a post, you could register a
|
||||
hook like this:
|
||||
|
||||
{% highlight ruby %}
|
||||
```ruby
|
||||
Jekyll::Hooks.register :posts, :post_render do |post|
|
||||
# code to call after Jekyll renders a post
|
||||
end
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
Jekyll provides hooks for <code>:site</code>, <code>:pages</code>,
|
||||
<code>:posts</code>, and <code>:documents</code>. In all cases, Jekyll calls your
|
||||
hooks with the container object as the first callback parameter. But in the
|
||||
case of <code>:pre_render</code>, your hook will also receive a payload hash as
|
||||
a second parameter which allows you full control over the variables that are
|
||||
available while rendering.
|
||||
<code>:posts</code>, and <code>:documents</code>. In all cases, Jekyll calls
|
||||
your hooks with the container object as the first callback parameter. However,
|
||||
all `:pre_render` hooks and the`:site, :post_render` hook will also provide a
|
||||
payload hash as a second parameter. In the case of `:pre_render`, the payload
|
||||
gives you full control over the variables that are available while rendering.
|
||||
In the case of `:site, :post_render`, the payload contains final values after
|
||||
rendering all the site (useful for sitemaps, feeds, etc).
|
||||
|
||||
The complete list of available hooks is below:
|
||||
|
||||
@@ -751,12 +753,14 @@ LESS.js files during generation.
|
||||
- [Jekyll Flickr Plugin](https://github.com/lawmurray/indii-jekyll-flickr) by [Lawrence Murray](http://www.indii.org): Generates posts for photos uploaded to a Flickr photostream.
|
||||
- [Jekyll::Paginate::Category](https://github.com/midnightSuyama/jekyll-paginate-category): Pagination Generator for Jekyll Category.
|
||||
- [AMP-Jekyll by Juuso Mikkonen](https://github.com/juusaw/amp-jekyll): Generate [Accelerated Mobile Pages](https://www.ampproject.org) of Jekyll posts.
|
||||
- [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.
|
||||
|
||||
#### Converters
|
||||
|
||||
- [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.
|
||||
- [Jade plugin by John Papandriopoulos](https://github.com/snappylabs/jade-jekyll-plugin): Jade converter for Jekyll.
|
||||
- [Pug plugin by Josh Waller](https://github.com/mdxprograms/pug-jekyll-plugin): Pug (previously Jade) converter for Jekyll.
|
||||
- [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.
|
||||
@@ -800,6 +804,7 @@ LESS.js files during generation.
|
||||
- [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/).
|
||||
- [Jekyll Email Protect](https://github.com/vwochnik/jekyll-email-protect): Email protection liquid filter for Jekyll
|
||||
- [Jekyll Uglify Filter](https://github.com/mattg/jekyll-uglify-filter): A Liquid filter that runs your JavaScript through UglifyJS.
|
||||
|
||||
#### Tags
|
||||
|
||||
@@ -826,7 +831,6 @@ LESS.js files during generation.
|
||||
- [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.
|
||||
- [Refheap_tag](https://github.com/aburdette/refheap_tag): Liquid tag that allows embedding pastes from [refheap](https://www.refheap.com/).
|
||||
- [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.
|
||||
@@ -858,6 +862,13 @@ LESS.js files during generation.
|
||||
- [Jekyll Flickr Plugin](https://github.com/lawmurray/indii-jekyll-flickr) by [Lawrence Murray](http://www.indii.org): Embeds Flickr photosets (albums) as a gallery of thumbnails, with lightbox links to larger images.
|
||||
- [jekyll-figure](https://github.com/paulrobertlloyd/jekyll-figure): A liquid tag for Jekyll that generates `<figure>` elements.
|
||||
- [Jekyll Video Embed](https://github.com/eug/jekyll-video-embed): It provides several tags to easily embed videos (e.g. Youtube, Vimeo, UStream and Ted Talks)
|
||||
- [jekyll-i18n_tags](https://github.com/KrzysiekJ/jekyll-i18n_tags): Translate your templates.
|
||||
- [Jekyll Ideal Image Slider](https://github.com/xHN35RQ/jekyll-ideal-image-slider): Liquid tag plugin to create image sliders using [Ideal Image Slider](https://github.com/gilbitron/Ideal-Image-Slider).
|
||||
- [Jekyll Tags List Plugin](https://github.com/crispgm/jekyll-tags-list-plugin): A Liquid tag plugin that creates tags list in specific order.
|
||||
- [Jekyll Maps](https://github.com/ayastreb/jekyll-maps) by [Anatoliy Yastreb](https://github.com/ayastreb): A Jekyll plugin to easily embed maps with filterable locations.
|
||||
- [Jekyll Cloudinary](https://nhoizey.github.io/jekyll-cloudinary/) by [Nicolas Hoizey](https://nicolas-hoizey.com/): a Jekyll plugin adding a Liquid tag to ease the use of Cloudinary for responsive images in your Markdown/Kramdown posts.
|
||||
- [jekyll-include-absolute-plugin](https://github.com/tnhu/jekyll-include-absolute-plugin) by [Tan Nhu](https://github.com/tnhu): A Jekyll plugin to include a file from its path relative to Jekyll's source folder.
|
||||
- [Jekyll Download Tag](https://github.com/mattg/jekyll-download-tag): A Liquid tag that acts like `include`, but for external resources.
|
||||
|
||||
#### Collections
|
||||
|
||||
@@ -899,6 +910,13 @@ LESS.js files during generation.
|
||||
- [Official Contentful Jekyll Plugin](https://github.com/contentful/jekyll-contentful-data-import): Adds a `contentful` sub-command to Jekyll to import data from Contentful.
|
||||
- [jekyll-paspagon](https://github.com/KrzysiekJ/jekyll-paspagon): Sell your posts in various formats for cryptocurrencies.
|
||||
- [Hawkins](https://github.com/awood/hawkins): Adds a `liveserve` sub-command to Jekyll that incorporates [LiveReload](http://livereload.com/) into your pages while you preview them. No more hitting the refresh button in your browser!
|
||||
- [Jekyll Autoprefixer](https://github.com/vwochnik/jekyll-autoprefixer): Autoprefixer integration for Jekyll
|
||||
- [Jekyll-breadcrumbs](https://github.com/git-no/jekyll-breadcrumbs): Creates breadcrumbs for Jekyll 3.x, includes features like SEO optimization, optional breadcrumb item translation and more.
|
||||
- [generator-jekyllized](https://github.com/sondr3/generator-jekyllized): A Yeoman generator for rapidly developing sites with Gulp. Live reload your site, automatically minify and optimize your assets and much more.
|
||||
- [Jekyll-Spotify](https://github.com/MertcanGokgoz/Jekyll-Spotify): Easily output Spotify Embed Player for jekyll
|
||||
- [jekyll-menus](https://github.com/forestryio/jekyll-menus): Hugo style menus for your Jekyll site... recursive menus included.
|
||||
- [jekyll-data](https://github.com/ashmaroli/jekyll-data): Read data files within Jekyll Theme Gems.
|
||||
- [jekyll-pinboard](https://github.com/snaptortoise/jekyll-pinboard-plugin): Access your Pinboard bookmarks within your Jekyll theme.
|
||||
|
||||
#### Editors
|
||||
|
||||
@@ -27,18 +27,18 @@ 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:
|
||||
|
||||
{% highlight bash %}
|
||||
```sh
|
||||
YEAR-MONTH-DAY-title.MARKUP
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
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:
|
||||
|
||||
{% highlight bash %}
|
||||
```sh
|
||||
2011-12-31-new-years-eve-is-awesome.md
|
||||
2012-09-12-how-to-write-a-blog.textile
|
||||
{% endhighlight %}
|
||||
2012-09-12-how-to-write-a-blog.md
|
||||
```
|
||||
|
||||
<div class="note">
|
||||
<h5>ProTip™: Link to other posts</h5>
|
||||
@@ -90,16 +90,16 @@ variable in a post.
|
||||
|
||||
Including an image asset in a post:
|
||||
|
||||
{% highlight text %}
|
||||
```text
|
||||
... which is shown in the screenshot below:
|
||||

|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
Linking to a PDF for readers to download:
|
||||
|
||||
{% highlight text %}
|
||||
```text
|
||||
... you can [get the PDF]({% raw %}{{ site.url }}{% endraw %}/assets/mydoc.pdf) directly.
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
<div class="note">
|
||||
<h5>ProTip™: Link using just the site root URL</h5>
|
||||
@@ -119,7 +119,7 @@ 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:
|
||||
|
||||
{% highlight html %}
|
||||
```html
|
||||
<ul>
|
||||
{% raw %}{% for post in site.posts %}{% endraw %}
|
||||
<li>
|
||||
@@ -127,7 +127,7 @@ basic example of how to create a list of links to your blog posts:
|
||||
</li>
|
||||
{% raw %}{% endfor %}{% endraw %}
|
||||
</ul>
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
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
|
||||
@@ -146,7 +146,7 @@ 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:
|
||||
|
||||
{% highlight html %}
|
||||
```html
|
||||
<ul>
|
||||
{% raw %}{% for post in site.posts %}{% endraw %}
|
||||
<li>
|
||||
@@ -155,22 +155,22 @@ your posts:
|
||||
</li>
|
||||
{% raw %}{% endfor %}{% endraw %}
|
||||
</ul>
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
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:
|
||||
|
||||
{% highlight html %}
|
||||
```html
|
||||
{% raw %}{{ post.excerpt | remove: '<p>' | remove: '</p>' }}{% endraw %}
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
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:
|
||||
|
||||
{% highlight text %}
|
||||
```text
|
||||
---
|
||||
excerpt_separator: <!--more-->
|
||||
---
|
||||
@@ -178,7 +178,7 @@ excerpt_separator: <!--more-->
|
||||
Excerpt
|
||||
<!--more-->
|
||||
Out-of-excerpt
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
You can also set the `excerpt_separator` globally in your `_config.yml`
|
||||
configuration file.
|
||||
@@ -197,7 +197,7 @@ 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:
|
||||
|
||||
{% highlight text %}
|
||||
```text
|
||||
{% raw %}{% highlight ruby %}{% endraw %}
|
||||
def show
|
||||
@widget = Widget(params[:id])
|
||||
@@ -207,11 +207,11 @@ def show
|
||||
end
|
||||
end
|
||||
{% raw %}{% endhighlight %}{% endraw %}
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
And the output will look like this:
|
||||
|
||||
{% highlight ruby %}
|
||||
```ruby
|
||||
def show
|
||||
@widget = Widget(params[:id])
|
||||
respond_to do |format|
|
||||
@@ -219,7 +219,7 @@ def show
|
||||
format.json { render json: @widget }
|
||||
end
|
||||
end
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
<div class="note">
|
||||
<h5>ProTip™: Show line numbers</h5>
|
||||
@@ -6,13 +6,15 @@ permalink: /docs/quickstart/
|
||||
|
||||
For the impatient, here's how to get a boilerplate Jekyll site up and running.
|
||||
|
||||
{% highlight bash %}
|
||||
~ $ gem install jekyll
|
||||
```sh
|
||||
~ $ gem install jekyll bundler
|
||||
~ $ jekyll new myblog
|
||||
~ $ cd myblog
|
||||
~/myblog $ jekyll serve
|
||||
~/myblog $ bundle exec jekyll serve
|
||||
# => Now browse to http://localhost:4000
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
The `jekyll new` command now automatically initiates `bundle install` and installs the dependencies required. To skip this, pass `--skip-bundle` option like so `jekyll new myblog --skip-bundle`.
|
||||
|
||||
If you wish to install jekyll into an existing directory, you can do so by running `jekyll new .` from within the directory instead of creating a new one. If the existing directory isn't empty, you'll also have to pass the `--force` option like so `jekyll new . --force`.
|
||||
|
||||
@@ -8,6 +8,8 @@ Jekyll’s growing use is producing a wide variety of tutorials, frameworks, ext
|
||||
|
||||
### Useful Guides
|
||||
|
||||
- [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://cheat.jekyll.tips) 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](http://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/).
|
||||
@@ -16,11 +18,15 @@ Jekyll’s growing use is producing a wide variety of tutorials, frameworks, ext
|
||||
|
||||
### Integrations
|
||||
|
||||
- [Use FormKeep as a backend for forms (contact forms, hiring forms, etc.)](https://formkeep.com/guides/how-to-make-a-contact-form-in-jekyll?utm_source=github&utm_medium=jekyll-docs&utm_campaign=contact-form-jekyll)
|
||||
- [Use Simple Form to add a simple contact form](http://getsimpleform.com/)
|
||||
- Use a saas service as a backend for forms (contact forms, hiring forms, etc.)
|
||||
- [Formspree (also open source)](http://formspree.io/)
|
||||
- [FormKeep](https://formkeep.com/guides/contact-form-jekyll?utm_source=github&utm_medium=jekyll-docs&utm_campaign=contact-form-jekyll)
|
||||
- [Simple Form](http://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)
|
||||
|
||||
### Other commentary
|
||||
|
||||
@@ -14,8 +14,6 @@ learning purposes.
|
||||
([source](https://github.com/github/training-kit))
|
||||
- [Rasmus Andersson](http://rsms.me/)
|
||||
([source](https://github.com/rsms/rsms.github.com))
|
||||
- [Leonard Lamprecht](http://leo.im)
|
||||
([source](https://github.com/leo/leo.github.io))
|
||||
|
||||
If you would like to explore more examples, you can find a list of sites
|
||||
and their sources on the ["Sites" page in the Jekyll wiki][jekyll-sites].
|
||||
@@ -26,7 +26,7 @@ following metadata:
|
||||
<td><p><code>file.path</code></p></td>
|
||||
<td><p>
|
||||
|
||||
The relative path to the file.
|
||||
The relative path to the file, e.g <code>/assets/img/image.jpg</code>
|
||||
|
||||
</p></td>
|
||||
</tr>
|
||||
@@ -34,7 +34,23 @@ following metadata:
|
||||
<td><p><code>file.modified_time</code></p></td>
|
||||
<td><p>
|
||||
|
||||
The `Time` the file was last modified.
|
||||
The `Time` the file was last modified, e.g <code>2016-04-01 16:35:26 +0200</code>
|
||||
|
||||
</p></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><p><code>file.name</code></p></td>
|
||||
<td><p>
|
||||
|
||||
The string name of the file e.g. <code>image.jpg</code> for <code>image.jpg</code>
|
||||
|
||||
</p></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><p><code>file.basename</code></p></td>
|
||||
<td><p>
|
||||
|
||||
The string basename of the file e.g. <code>image</code> for <code>image.jpg</code>
|
||||
|
||||
</p></td>
|
||||
</tr>
|
||||
@@ -14,12 +14,12 @@ product.
|
||||
|
||||
A basic Jekyll site usually looks something like this:
|
||||
|
||||
{% highlight bash %}
|
||||
```sh
|
||||
.
|
||||
├── _config.yml
|
||||
├── _drafts
|
||||
| ├── begin-with-the-crazy-ideas.textile
|
||||
| └── on-simplicity-in-technology.markdown
|
||||
| ├── begin-with-the-crazy-ideas.md
|
||||
| └── on-simplicity-in-technology.md
|
||||
├── _includes
|
||||
| ├── footer.html
|
||||
| └── header.html
|
||||
@@ -27,14 +27,14 @@ A basic Jekyll site usually looks something like this:
|
||||
| ├── default.html
|
||||
| └── post.html
|
||||
├── _posts
|
||||
| ├── 2007-10-29-why-every-programmer-should-play-nethack.textile
|
||||
| └── 2009-04-26-barcamp-boston-4-roundup.textile
|
||||
| ├── 2007-10-29-why-every-programmer-should-play-nethack.md
|
||||
| └── 2009-04-26-barcamp-boston-4-roundup.md
|
||||
├── _data
|
||||
| └── members.yml
|
||||
├── _site
|
||||
├── .jekyll-metadata
|
||||
└── index.html
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
An overview of what each of these does:
|
||||
|
||||
@@ -4,9 +4,9 @@ title: Templates
|
||||
permalink: /docs/templates/
|
||||
---
|
||||
|
||||
Jekyll uses the [Liquid](https://github.com/Shopify/liquid/wiki) templating language to
|
||||
process templates. All of the standard Liquid [tags](https://github.com/Shopify/liquid/wiki/Liquid-for-Designers#tags) and
|
||||
[filters](https://github.com/Shopify/liquid/wiki/Liquid-for-Designers#standard-filters) are
|
||||
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/) and
|
||||
[filters](https://shopify.github.io/liquid/filters/) are
|
||||
supported. Jekyll even adds a few handy filters and tags of its own to make
|
||||
common tasks easier.
|
||||
|
||||
@@ -21,6 +21,34 @@ common tasks easier.
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<p class="name"><strong>Relative URL</strong></p>
|
||||
<p>Prepend the <code>baseurl</code> value to the input. Useful if your site is hosted at a subpath rather than the root of the domain.</p>
|
||||
</td>
|
||||
<td class="align-center">
|
||||
<p>
|
||||
<code class="filter">{% raw %}{{ "/assets/style.css" | relative_url }}{% endraw %}</code>
|
||||
</p>
|
||||
<p>
|
||||
<code class="output">/my-baseurl/assets/style.css</code>
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<p class="name"><strong>Absolute URL</strong></p>
|
||||
<p>Prepend the <code>url</code> and <code>baseurl</code> value to the input.</p>
|
||||
</td>
|
||||
<td class="align-center">
|
||||
<p>
|
||||
<code class="filter">{% raw %}{{ "/assets/style.css" | absolute_url }}{% endraw %}</code>
|
||||
</p>
|
||||
<p>
|
||||
<code class="output">http://example.com/my-baseurl/assets/style.css</code>
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<p class="name"><strong>Date to XML Schema</strong></p>
|
||||
@@ -88,6 +116,22 @@ common tasks easier.
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
<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>
|
||||
</td>
|
||||
<td class="align-center">
|
||||
<p>
|
||||
<code class="filter">{% raw %}{{ site.members | where_exp:"item",
|
||||
"item.graduation_year == 2014" }}{% endraw %}</code>
|
||||
<code class="filter">{% raw %}{{ site.members | where_exp:"item",
|
||||
"item.graduation_year < 2014" }}{% endraw %}</code>
|
||||
<code class="filter">{% raw %}{{ site.members | where_exp:"item",
|
||||
"item.projects contains 'foo'" }}{% endraw %}</code>
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<p class="name"><strong>Group By</strong></p>
|
||||
@@ -240,6 +284,17 @@ common tasks easier.
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<p class="name"><strong>Normalize Whitespace</strong></p>
|
||||
<p>Replace any occurrence of whitespace with a single space.</p>
|
||||
</td>
|
||||
<td class="align-center">
|
||||
<p>
|
||||
<code class="filter">{% raw %}{{ "a \n b" | normalize_whitespace }}{% endraw %}</code>
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<p class="name"><strong>Sort</strong></p>
|
||||
@@ -271,6 +326,17 @@ common tasks easier.
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<p class="name"><strong>To Integer</strong></p>
|
||||
<p>Convert a string or boolean to integer.</p>
|
||||
</td>
|
||||
<td class="align-center">
|
||||
<p>
|
||||
<code class="filter">{% raw %}{{ some_var | to_integer }}{% endraw %}</code>
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<p class="name"><strong>Array Filters</strong></p>
|
||||
@@ -304,6 +370,17 @@ common tasks easier.
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<p class="name"><strong>Inspect</strong></p>
|
||||
<p>Convert an object into its String representation for debugging.</p>
|
||||
</td>
|
||||
<td class="align-center">
|
||||
<p>
|
||||
<code class="filter">{% raw %}{{ some_var | inspect }}{% endraw %}</code>
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
@@ -325,9 +402,9 @@ The default is `default`. They are as follows (with what they filter):
|
||||
If you have small page fragments that you wish to include in multiple places on
|
||||
your site, you can use the `include` tag.
|
||||
|
||||
{% highlight ruby %}
|
||||
```liquid
|
||||
{% raw %}{% include footer.html %}{% endraw %}
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
Jekyll expects all include files to be placed in an `_includes` directory at the
|
||||
root of your source directory. This will embed the contents of
|
||||
@@ -346,23 +423,23 @@ root of your source directory. This will embed the contents of
|
||||
|
||||
You can also pass parameters to an include. Omit the quotation marks to send a variable's value. Liquid curly brackets should not be used here:
|
||||
|
||||
{% highlight ruby %}
|
||||
```liquid
|
||||
{% raw %}{% include footer.html param="value" variable-param=page.variable %}{% endraw %}
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
These parameters are available via Liquid in the include:
|
||||
|
||||
{% highlight ruby %}
|
||||
```liquid
|
||||
{% raw %}{{ include.param }}{% endraw %}
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
#### Including files relative to another file
|
||||
|
||||
You can also choose to include file fragments relative to the current file:
|
||||
|
||||
{% highlight ruby %}
|
||||
```liquid
|
||||
{% raw %}{% include_relative somedir/footer.html %}{% endraw %}
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
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,
|
||||
@@ -388,7 +465,7 @@ languages](http://pygments.org/languages/)
|
||||
|
||||
To render a code block with syntax highlighting, surround your code as follows:
|
||||
|
||||
{% highlight text %}
|
||||
```liquid
|
||||
{% raw %}
|
||||
{% highlight ruby %}
|
||||
def foo
|
||||
@@ -396,7 +473,7 @@ def foo
|
||||
end
|
||||
{% endhighlight %}
|
||||
{% endraw %}
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
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
|
||||
@@ -411,7 +488,7 @@ 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:
|
||||
|
||||
{% highlight text %}
|
||||
```liquid
|
||||
{% raw %}
|
||||
{% highlight ruby linenos %}
|
||||
def foo
|
||||
@@ -419,7 +496,7 @@ def foo
|
||||
end
|
||||
{% endhighlight %}
|
||||
{% endraw %}
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
#### Stylesheets for syntax highlighting
|
||||
|
||||
@@ -431,54 +508,82 @@ 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.
|
||||
|
||||
### Link
|
||||
|
||||
If you want to include a link to a collection's document, a post, a page
|
||||
or a file the `link` tag will generate the correct permalink URL for the path
|
||||
you specify.
|
||||
|
||||
You must include the file extension when using the `link` tag.
|
||||
|
||||
```liquid
|
||||
{% raw %}
|
||||
{{ 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 %}
|
||||
```
|
||||
|
||||
You can also use this tag to create a link in Markdown as follows:
|
||||
|
||||
```liquid
|
||||
{% raw %}
|
||||
[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 %}
|
||||
```
|
||||
|
||||
### Post URL
|
||||
|
||||
If you would like 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.
|
||||
|
||||
{% highlight text %}
|
||||
```liquid
|
||||
{% raw %}
|
||||
{% post_url 2010-07-21-name-of-post %}
|
||||
{{ site.baseurl }}{% post_url 2010-07-21-name-of-post %}
|
||||
{% endraw %}
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
If you organize your posts in subdirectories, you need to include subdirectory
|
||||
path to the post:
|
||||
|
||||
{% highlight text %}
|
||||
```liquid
|
||||
{% raw %}
|
||||
{% post_url /subdir/2010-07-21-name-of-post %}
|
||||
{{ site.baseurl }}{% post_url /subdir/2010-07-21-name-of-post %}
|
||||
{% endraw %}
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
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:
|
||||
|
||||
{% highlight text %}
|
||||
```liquid
|
||||
{% raw %}
|
||||
[Name of Link]({% post_url 2010-07-21-name-of-post %})
|
||||
[Name of Link]({{ site.baseurl }}{% post_url 2010-07-21-name-of-post %})
|
||||
{% endraw %}
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
### Gist
|
||||
|
||||
Use the `gist` tag to easily embed a GitHub Gist onto your site. This works
|
||||
with public or secret gists:
|
||||
|
||||
{% highlight text %}
|
||||
```liquid
|
||||
{% raw %}
|
||||
{% gist parkr/931c1c8d465a04042403 %}
|
||||
{% endraw %}
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
You may also optionally specify the filename in the gist to display:
|
||||
|
||||
{% highlight text %}
|
||||
```liquid
|
||||
{% raw %}
|
||||
{% gist parkr/931c1c8d465a04042403 jekyll-private-gist.markdown %}
|
||||
{% endraw %}
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
To use the `gist` tag, you'll need to add the
|
||||
[jekyll-gist](https://github.com/jekyll/jekyll-gist) gem to your project.
|
||||
110
docs/_docs/themes.md
Normal file
110
docs/_docs/themes.md
Normal file
@@ -0,0 +1,110 @@
|
||||
---
|
||||
layout: docs
|
||||
title: Themes
|
||||
permalink: /docs/themes/
|
||||
---
|
||||
|
||||
Jekyll has an extensive theme system, which allows you to leverage community-maintained templates and styles to customize your site's presentation. Jekyll themes package layouts, includes, and stylesheets in a way that can be overridden by your site's content.
|
||||
|
||||
## Installing a theme
|
||||
|
||||
1. To install a theme, first, add the theme to your site's `Gemfile`:
|
||||
|
||||
gem 'my-awesome-jekyll-theme'
|
||||
|
||||
2. Save the changes to your `Gemfile`
|
||||
3. Run the command `bundle install` to install the theme
|
||||
4. Finally, activate the theme by adding the following to your site's `_config.yml`:
|
||||
|
||||
theme: my-awesome-jekyll-theme
|
||||
|
||||
You can have multiple themes listed in your site's Gemfile, but only one theme can be selected in your site's `_config.yml`.
|
||||
{: .note .info }
|
||||
|
||||
## Overriding theme defaults
|
||||
|
||||
Jekyll themes set default layouts, includes, and stylesheets, that can be overridden by your site's content. For example, if your selected theme has a `page` layout, you can override the theme's layout by creating your own `page` layout in the `_layouts` folder (e.g., `_layouts/page.html`).
|
||||
|
||||
Jekyll will look first to your site's content, before looking to the theme's defaults, for any requested file in the following folders:
|
||||
|
||||
* `/assets`
|
||||
* `/_layouts`
|
||||
* `/_includes`
|
||||
* `/_sass`
|
||||
|
||||
Refer to your selected theme's documentation and source repository for more information on what files you can override.
|
||||
{: .note .info}
|
||||
|
||||
To locate theme's files on your computer, run `bundle show` followed by
|
||||
the name of the theme's gem, e.g. `bundle show minima` for default Jekyll's
|
||||
theme. Then copy the files you want to override, from the returned path to your root folder.
|
||||
|
||||
## Creating a theme
|
||||
|
||||
Jekyll themes are distributed as Ruby gems. Don't worry, Jekyll will help you scaffold a new theme with the `new-theme` command. Just run `jekyll new-theme` with the theme name as an argument:
|
||||
|
||||
```sh
|
||||
jekyll new-theme my-awesome-theme
|
||||
create /path/to/my-awesome-theme/_layouts
|
||||
create /path/to/my-awesome-theme/_includes
|
||||
create /path/to/my-awesome-theme/_sass
|
||||
create /path/to/my-awesome-theme/_layouts/page.html
|
||||
create /path/to/my-awesome-theme/_layouts/post.html
|
||||
create /path/to/my-awesome-theme/_layouts/default.html
|
||||
create /path/to/my-awesome-theme/Gemfile
|
||||
create /path/to/my-awesome-theme/my-awesome-theme.gemspec
|
||||
create /path/to/my-awesome-theme/README.md
|
||||
create /path/to/my-awesome-theme/LICENSE.txt
|
||||
initialize /path/to/my-awesome-theme/.git
|
||||
create /path/to/my-awesome-theme/.gitignore
|
||||
Your new Jekyll theme, my-awesome-theme, is ready for you in /path/to/my-awesome-theme!
|
||||
For help getting started, read /path/to/my-awesome-theme/README.md.
|
||||
```
|
||||
|
||||
Add your template files in the corresponding folders, complete the `.gemspec` and the README files according to your needs.
|
||||
|
||||
### Layouts and includes
|
||||
|
||||
Theme layouts and includes work just like they work in any Jekyll site. Place layouts in your theme's `/_layouts` folder, and place includes in your themes `/_includes` folder.
|
||||
|
||||
For example, if your theme has a `/_layouts/page.html` file, and a page has `layout: page` in its YAML front matter, Jekyll will first look to the site's `_layouts` folder for a the `page` layout, and if none exists, will use your theme's `page` layout.
|
||||
|
||||
### Assets
|
||||
|
||||
Any file in `/assets` will be copied over to the user's site upon build unless they have a file with the same relative path. You may ship any kind of asset here: SCSS, an image, a webfont, etc. These files behave just like pages and static files in Jekyll: if the file has [YAML front matter]({{ site.baseurl }}/docs/frontmatter/) at the top, then it will be rendered. If it does not have YAML front matter, it will simply be copied over into the resulting site. This allows theme creators to ship a default `/assets/styles.scss` file which their layouts can depend on as `/assets/styles.css`.
|
||||
|
||||
All files in `/assets` will be output into the compiled site in the `/assets` folder just as you'd expect from using Jekyll on your sites.
|
||||
|
||||
### Stylesheets
|
||||
|
||||
Your theme's stylesheets should be placed in your theme's `/_sass` folder, again, just as you would when authoring a Jekyll site. Your theme's styles can be included in the user's stylesheet using the `@import` directive.
|
||||
|
||||
### Documenting your theme
|
||||
|
||||
Your theme should include a `/README.md` file, which explains how site authors can install and use your theme. What layouts are included? What includes? Do they need to add anything special to their site's configuration file?
|
||||
|
||||
### 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.
|
||||
|
||||
### Previewing your theme
|
||||
|
||||
To preview your theme as you're authoring it, it may be helpful to add dummy content in, for example, `/index.html` and `/page.html` files. This will allow you to use the `jekyll build` and `jekyll serve` commands to preview your theme, just as you'd preview a Jekyll site.
|
||||
|
||||
If you do preview your theme locally, be sure to add `/_site` to your theme's `.gitignore` file to prevent the compiled site from also being included when you distribute your theme.
|
||||
{: .info .note}
|
||||
|
||||
### Publishing your theme
|
||||
|
||||
Themes are published via [RubyGems.org](https://rubygems.org). You'll need a RubyGems account, which you can [create for free](https://rubygems.org/sign_up).
|
||||
|
||||
1. First, package your theme, by running the following command, replacing `my-awesome-jekyll-theme` with the name of your theme:
|
||||
|
||||
gem build my-awesome-jekyll-theme.gemspec
|
||||
|
||||
2. Next, push your packaged theme up to the RubyGems service, by running the following command, again replacing `my-awesome-jekyll-theme` with the name of your theme:
|
||||
|
||||
gem push my-awesome-jekyll-theme-*.gem
|
||||
|
||||
3. To release a new version of your theme, simply update the version number in the gemspec file, ( `my-awesome-jekyll-theme.gemspec` in this example ), and then repeat Steps 1 & 2 above.
|
||||
We recommend that you follow [Semantic Versioning](http://semver.org/) while bumping your theme-version.
|
||||
@@ -13,6 +13,7 @@ that might be of help. If the problem you’re experiencing isn’t covered belo
|
||||
- [Base-URL Problems](#base-url-problems)
|
||||
- [Configuration problems](#configuration-problems)
|
||||
- [Markup Problems](#markup-problems)
|
||||
- [Production Problems](#production-problems)
|
||||
|
||||
## Installation Problems
|
||||
|
||||
@@ -20,63 +21,63 @@ If you encounter errors during gem installation, you may need to install
|
||||
the header files for compiling extension modules for Ruby 2.0.0. This
|
||||
can be done on Ubuntu or Debian by running:
|
||||
|
||||
{% highlight bash %}
|
||||
sudo apt-get install ruby2.0.0-dev
|
||||
{% endhighlight %}
|
||||
```sh
|
||||
sudo apt-get install ruby2.3-dev
|
||||
```
|
||||
|
||||
On Red Hat, CentOS, and Fedora systems you can do this by running:
|
||||
|
||||
{% highlight bash %}
|
||||
```sh
|
||||
sudo yum install ruby-devel
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
If you installed the above - specifically on Fedora 23 - but the extensions would still not compile, you are probably running a Fedora image that misses the `redhat-rpm-config` package. To solve this, simply run:
|
||||
|
||||
{% highlight bash %}
|
||||
```sh
|
||||
sudo dnf install redhat-rpm-config
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
|
||||
On [NearlyFreeSpeech](https://www.nearlyfreespeech.net/) you need to run the
|
||||
following commands before installing Jekyll:
|
||||
|
||||
{% highlight bash %}
|
||||
```sh
|
||||
export GEM_HOME=/home/private/gems
|
||||
export GEM_PATH=/home/private/gems:/usr/local/lib/ruby/gems/1.8/
|
||||
export PATH=$PATH:/home/private/gems/bin
|
||||
export RB_USER_INSTALL='true'
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
To install RubyGems on Gentoo:
|
||||
|
||||
{% highlight bash %}
|
||||
```sh
|
||||
sudo emerge -av dev-ruby/rubygems
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
On Windows, you may need to install [RubyInstaller
|
||||
DevKit](https://wiki.github.com/oneclick/rubyinstaller/development-kit).
|
||||
|
||||
On Mac OS X, you may need to update RubyGems (using `sudo` only if necessary):
|
||||
On macOS, you may need to update RubyGems (using `sudo` only if necessary):
|
||||
|
||||
{% highlight bash %}
|
||||
```sh
|
||||
sudo gem update --system
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
If you still have issues, you can download and install new Command Line
|
||||
Tools (such as `gcc`) using the command
|
||||
Tools (such as `gcc`) using the following command:
|
||||
|
||||
{% highlight bash %}
|
||||
```sh
|
||||
xcode-select --install
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
which may allow you to install native gems using this command (again using
|
||||
`sudo` only if necessary):
|
||||
|
||||
{% highlight bash %}
|
||||
```sh
|
||||
sudo gem install jekyll
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
Note that upgrading Mac OS X does not automatically upgrade Xcode itself
|
||||
Note that upgrading macOS does not automatically upgrade Xcode itself
|
||||
(that can be done separately via the App Store), and having an out-of-date
|
||||
Xcode.app can interfere with the command line tools downloaded above. If
|
||||
you run into this issue, upgrade Xcode and install the upgraded Command
|
||||
@@ -90,22 +91,22 @@ 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):
|
||||
|
||||
{% highlight bash %}
|
||||
```sh
|
||||
sudo gem install -n /usr/local/bin jekyll
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
Alternatively, Homebrew can be installed and used to set up Ruby. This can be
|
||||
done as follows:
|
||||
|
||||
{% highlight bash %}
|
||||
```sh
|
||||
ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
Once Homebrew is installed, the second step is easy:
|
||||
|
||||
{% highlight bash %}
|
||||
```sh
|
||||
brew install ruby
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
Advanced users (with more complex needs) may find it helpful to choose one of a
|
||||
number of Ruby version managers ([RVM][], [rbenv][], [chruby][], [etc][].) in
|
||||
@@ -119,15 +120,15 @@ which to install Jekyll.
|
||||
If you elect to use one of the above methods to install Ruby, it might be
|
||||
necessary to modify your `$PATH` variable using the following command:
|
||||
|
||||
{% highlight bash %}
|
||||
```sh
|
||||
export PATH=/usr/local/bin:$PATH
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
GUI apps can modify the `$PATH` as follows:
|
||||
|
||||
{% highlight bash %}
|
||||
```sh
|
||||
launchctl setenv PATH "/usr/local/bin:$PATH"
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
Either of these approaches are useful because `/usr/local` is considered a
|
||||
"safe" location on systems which have SIP enabled, they avoid potential
|
||||
@@ -151,21 +152,21 @@ in order to have the `jekyll` executable be available in your Terminal.
|
||||
|
||||
If you are using base-url option like:
|
||||
|
||||
{% highlight bash %}
|
||||
```sh
|
||||
jekyll serve --baseurl '/blog'
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
… then make sure that you access the site at:
|
||||
|
||||
{% highlight bash %}
|
||||
```sh
|
||||
http://localhost:4000/blog/index.html
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
It won’t work to just access:
|
||||
|
||||
{% highlight bash %}
|
||||
```sh
|
||||
http://localhost:4000/blog
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
## Configuration problems
|
||||
|
||||
@@ -180,6 +181,11 @@ 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`.
|
||||
|
||||
## Markup Problems
|
||||
|
||||
The various markup engines that Jekyll uses may have some issues. This
|
||||
@@ -192,9 +198,9 @@ 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:
|
||||
|
||||
{% highlight bash %}
|
||||
```sh
|
||||
'{{ "{{" }}' was not properly terminated with regexp: /\}\}/ (Liquid::SyntaxError)
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
### Excerpts
|
||||
|
||||
@@ -204,6 +210,13 @@ strange errors where references don't exist or a tag hasn't been closed. If you
|
||||
run into these errors, try setting `excerpt_separator: ""` in your
|
||||
`_config.yml`, or set it to some nonsense string.
|
||||
|
||||
## Production Problems
|
||||
|
||||
If you run into an issue that a static file can't be found in your
|
||||
production environment during build since v3.2.0 you should set your
|
||||
[environment to `production`](../configuration/#specifying-a-jekyll-environment-at-build-time).
|
||||
The issue is caused by trying to copy a non-existing symlink.
|
||||
|
||||
<div class="note">
|
||||
<h5>Please report issues you encounter!</h5>
|
||||
<p>
|
||||
@@ -9,9 +9,9 @@ and 2.0 that you'll want to know about.
|
||||
|
||||
Before we dive in, go ahead and fetch the latest version of Jekyll:
|
||||
|
||||
{% highlight bash %}
|
||||
```sh
|
||||
$ gem update jekyll
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
<div class="note feature">
|
||||
<h5 markdown="1">Diving in</h5>
|
||||
@@ -9,9 +9,9 @@ that you'll want to know about.
|
||||
|
||||
Before we dive in, go ahead and fetch the latest version of Jekyll:
|
||||
|
||||
{% highlight bash %}
|
||||
```sh
|
||||
$ gem update jekyll
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
Please note: Jekyll 3 requires Ruby version >= 2.0.0.
|
||||
|
||||
@@ -36,11 +36,11 @@ When iterating over `site.collections`, ensure the above conversions are made.
|
||||
|
||||
For `site.collections.myCollection` in Jekyll 2, you now do:
|
||||
|
||||
{% highlight liquid %}
|
||||
```liquid
|
||||
{% raw %}
|
||||
{% assign myCollection = site.collections | where: "label", "myCollection" | first %}
|
||||
{% endraw %}
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
This is a bit cumbersome at first, but is easier than a big `for` loop.
|
||||
|
||||
@@ -65,6 +65,14 @@ In Jekyll 3, this has been corrected. **Now, `--future` is disabled by default.*
|
||||
This means you will need to include `--future` if you want your future-dated posts to
|
||||
generate when running `jekyll build` or `jekyll serve`.
|
||||
|
||||
<div class="note info">
|
||||
<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.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
### Layout metadata
|
||||
|
||||
Introducing: `layout`. In Jekyll 2 and below, any metadata in the layout was merged onto
|
||||
@@ -89,17 +97,17 @@ In Jekyll 3 and above, relative permalinks have been deprecated. If you
|
||||
created your site using Jekyll 2 and below, you may receive the following
|
||||
error when trying to **serve** or **build**:
|
||||
|
||||
{% highlight text %}
|
||||
```text
|
||||
Since v3.0, permalinks for pages in subfolders must be relative to the site
|
||||
source directory, not the parent directory. Check
|
||||
http://jekyllrb.com/docs/upgrading/ for more info.
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
This can be fixed by removing the following line from your `_config.yml` file:
|
||||
|
||||
{% highlight yaml %}
|
||||
```yaml
|
||||
relative_permalinks: true
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
### Permalinks no longer automatically add a trailing slash
|
||||
|
||||
@@ -109,22 +117,22 @@ In Jekyll 2, any URL constructed from the `permalink:` field had a trailing slas
|
||||
|
||||
Try adding `future: true` to your `_config.yml` file. Are they showing up now? If they are, then you were ensnared by an issue with the way Ruby parses times. Each of your posts is being read in a different timezone than you might expect and, when compared to the computer's current time, is "in the future." The fix for this is to add [a timezone offset](https://en.wikipedia.org/wiki/List_of_UTC_time_offsets) to each post (and make sure you remove `future: true` from your `_config.yml` file). If you're writing from California, for example, you would change this:
|
||||
|
||||
{% highlight yaml %}
|
||||
```yaml
|
||||
---
|
||||
date: 2016-02-06 19:32:10
|
||||
---
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
to this (note the offset):
|
||||
|
||||
{% highlight yaml %}
|
||||
```yaml
|
||||
---
|
||||
date: 2016-02-06 19:32:10 -0800
|
||||
---
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
### My categories have stopped working!
|
||||
|
||||
If you organized your categories as `/_posts/code/2008-12-24-closures.md`, you will need to restructure your directories to put the categories _above_ the `_posts` directories, as follows: `/code/_posts/2008-12-24-closures.md`.
|
||||
If you organized your categories as `/_posts/code/2008-12-24-closures.md`, you will need to restructure your directories to put the categories _above_ the `_posts` directories, as follows: `/code/_posts/2008-12-24-closures.md`.
|
||||
|
||||
_Did we miss something? Please click "Improve this page" above and add a section. Thanks!_
|
||||
@@ -7,7 +7,7 @@ permalink: /docs/usage/
|
||||
The Jekyll gem makes a `jekyll` executable available to you in your Terminal
|
||||
window. You can use this command in a number of ways:
|
||||
|
||||
{% highlight bash %}
|
||||
```sh
|
||||
$ jekyll build
|
||||
# => The current folder will be generated into ./_site
|
||||
|
||||
@@ -20,7 +20,7 @@ $ jekyll build --source <source> --destination <destination>
|
||||
$ jekyll build --watch
|
||||
# => The current folder will be generated into ./_site,
|
||||
# watched for changes, and regenerated automatically.
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
<div class="note info">
|
||||
<h5>Changes to _config.yml are not included during automatic regeneration.</h5>
|
||||
@@ -52,7 +52,7 @@ $ jekyll build --watch
|
||||
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.
|
||||
|
||||
{% highlight bash %}
|
||||
```sh
|
||||
$ jekyll serve
|
||||
# => A development server will run at http://localhost:4000/
|
||||
# Auto-regeneration: enabled. Use `--no-watch` to disable.
|
||||
@@ -61,7 +61,7 @@ $ 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. [Read more](http://unixhelp.ed.ac.uk/shell/jobz5.html).
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
<div class="note info">
|
||||
<h5>Be aware of default behavior</h5>
|
||||
@@ -70,10 +70,10 @@ $ jekyll serve --detach
|
||||
</p>
|
||||
</div>
|
||||
|
||||
{% highlight bash %}
|
||||
```sh
|
||||
$ jekyll serve --no-watch
|
||||
# => Same as `jekyll serve` but will not watch for changes.
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
These are just a few of the available [configuration options](../configuration/).
|
||||
Many configuration options can either be specified as flags on the command line,
|
||||
@@ -82,17 +82,17 @@ file at the root of the source directory. Jekyll will automatically use the
|
||||
options from this file when run. For example, if you place the following lines
|
||||
in your `_config.yml` file:
|
||||
|
||||
{% highlight yaml %}
|
||||
```yaml
|
||||
source: _source
|
||||
destination: _deploy
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
Then the following two commands will be equivalent:
|
||||
|
||||
{% highlight bash %}
|
||||
```sh
|
||||
$ jekyll build
|
||||
$ jekyll build --source _source --destination _deploy
|
||||
{% endhighlight %}
|
||||
```
|
||||
|
||||
For more about the possible configuration options, see the
|
||||
[configuration](../configuration/) page.
|
||||
@@ -40,6 +40,16 @@ following is a reference of the available data.
|
||||
|
||||
</p></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><p><code>layout</code></p></td>
|
||||
<td><p>
|
||||
|
||||
Layout specific information + the <a href="../frontmatter/">YAML front
|
||||
matter</a>. Custom variables set via the YAML Front Matter in
|
||||
layouts will be available here.
|
||||
|
||||
</p></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><p><code>content</code></p></td>
|
||||
<td><p>
|
||||
@@ -105,8 +115,7 @@ following is a reference of the available data.
|
||||
If the page being processed is a Post, this contains a list of up to ten
|
||||
related Posts. By default, these are the ten most recent posts.
|
||||
For high quality but slow to compute results, run the
|
||||
<code>jekyll</code> command with the <code>--lsi</code> (latent semantic
|
||||
indexing) option. Also note GitHub Pages does not support the <code>lsi</code> option when generating sites.
|
||||
<code>jekyll</code> command with the <code>--lsi</code> (<a href="https://en.wikipedia.org/wiki/Latent_semantic_analysis#Latent_semantic_indexing">latent semantic indexing</a>) option. Also note GitHub Pages does not support the <code>lsi</code> option when generating sites.
|
||||
|
||||
</p></td>
|
||||
</tr>
|
||||
@@ -326,6 +335,14 @@ following is a reference of the available data.
|
||||
<code>page.custom_css</code>.
|
||||
|
||||
</p>
|
||||
<p>
|
||||
|
||||
If you specify front matter in a layout, access that via <code>layout</code>.
|
||||
For example, if you specify <code>class: full_page</code>
|
||||
in a page’s front matter, that value will be available as
|
||||
<code>layout.class</code> in the layout and its parents.
|
||||
|
||||
</p>
|
||||
</div>
|
||||
|
||||
## Paginator
|
||||
122
docs/_docs/windows.md
Normal file
122
docs/_docs/windows.md
Normal file
@@ -0,0 +1,122 @@
|
||||
---
|
||||
layout: docs
|
||||
title: Jekyll on Windows
|
||||
permalink: /docs/windows/
|
||||
---
|
||||
|
||||
While Windows is not an officially-supported platform, it can be used to run
|
||||
Jekyll with the proper tweaks. This page aims to collect some of the general
|
||||
knowledge and lessons that have been unearthed by Windows users.
|
||||
|
||||
## Installation
|
||||
|
||||
A quick way to install Jekyll 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](https://chocolatey.org/install)
|
||||
2. Install Ruby via Chocolatey: `choco install ruby -y`
|
||||
3. Reopen a command prompt and install Jekyll: `gem install jekyll`
|
||||
|
||||
For a more conventional way of installing Jekyll you can follow the [installation instructions by Sverrir Sigmundarson][windows-installjekyll3]. These instructions are for newer versions of Ruby 2.2.5 and Jekyll 3.
|
||||
|
||||
For instructions for older versions of Ruby 2.0.0 ([prior to 2.2][hitimes-issue]) and Jekyll 2 and older you should follow the [installation instruction by Julian Thilo][windows-installation].
|
||||
|
||||
|
||||
## 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 if 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
|
||||
```
|
||||
|
||||
[windows-installation]: http://jekyll-windows.juthilo.com/
|
||||
[windows-installjekyll3]: https://labs.sverrirs.com/jekyll/
|
||||
[hitimes-issue]: https://github.com/copiousfreetime/hitimes/issues/40
|
||||
|
||||
## 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 requires an extra gem for compatibility
|
||||
with Windows. Add the following to the Gemfile for your site:
|
||||
|
||||
```ruby
|
||||
gem 'wdm', '~> 0.1.0' if Gem.win_platform?
|
||||
```
|
||||
|
||||
### How to install github-pages
|
||||
|
||||
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 'http://rubygems.org'
|
||||
gem 'github-pages'
|
||||
```
|
||||
|
||||
* **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]: http://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"
|
||||
[Bundler]: http://bundler.io/ "Ruby Dependencie Manager"
|
||||
[nokogiriReleases]: https://github.com/sparklemotion/nokogiri/releases "Nokogiri Releases"
|
||||
[nokogiriFails]: https://github.com/sparklemotion/nokogiri/issues/1456#issuecomment-206481794 "Nokogiri fails to install on Ruby 2.3 for Windows"
|
||||
5
docs/_includes/docs_option.html
Normal file
5
docs/_includes/docs_option.html
Normal file
@@ -0,0 +1,5 @@
|
||||
{% for item in include.items %}
|
||||
{% assign item_url = item | prepend:"/docs/" | append:"/" %}
|
||||
{% assign doc = site.docs | where: "url", item_url | first %}
|
||||
<option value="{{ doc.url }}">{{ doc.title }}</option>
|
||||
{% endfor %}
|
||||
7
docs/_includes/docs_ul.html
Normal file
7
docs/_includes/docs_ul.html
Normal file
@@ -0,0 +1,7 @@
|
||||
<ul>
|
||||
{% for item in include.items %}
|
||||
{% assign item_url = item | prepend:"/docs/" | append:"/" %}
|
||||
{% assign p = site.docs | where:"url", item_url | first %}
|
||||
<li class="{% if item_url == page.url %}current{% endif %}"><a href="{{ p.url }}">{{ p.title }}</a></li>
|
||||
{% endfor %}
|
||||
</ul>
|
||||
@@ -1,4 +1,4 @@
|
||||
<footer role="contentinfo">
|
||||
<footer>
|
||||
<div class="grid">
|
||||
<div class="unit one-third center-on-mobiles">
|
||||
<p>The contents of this website are <br />© {{ site.time | date: '%Y' }} under the terms of the <a href="{{ site.repository }}/blob/master/LICENSE">MIT License</a>.</p>
|
||||
@@ -1,4 +1,4 @@
|
||||
<header role="banner">
|
||||
<header>
|
||||
<nav class="mobile-nav show-on-mobiles">
|
||||
{% include primary-nav-items.html %}
|
||||
</nav>
|
||||
@@ -3,12 +3,15 @@
|
||||
<a href="/">Home</a>
|
||||
</li>
|
||||
<li class="{% if page.url contains '/docs/' %}current{% endif %}">
|
||||
<a href="/docs/home/">Doc<span class="show-on-mobiles">s</span><span class="hide-on-mobiles">umentation</span></a>
|
||||
<a href="/docs/home/">Docs</a>
|
||||
</li>
|
||||
<li class="{% if page.author %}current{% endif %}">
|
||||
<a href="/news/">News</a>
|
||||
</li>
|
||||
<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>
|
||||
@@ -10,7 +10,7 @@ layout: default
|
||||
<div class="unit four-fifths">
|
||||
<article>
|
||||
<div class="improve right hide-on-mobiles">
|
||||
<a href="https://github.com/jekyll/jekyll/edit/master/site/{{ page.path }}"><i class="fa fa-pencil"></i> Improve this page</a>
|
||||
<a href="https://github.com/jekyll/jekyll/edit/master/docs/{{ page.path }}"><i class="fa fa-pencil"></i> Improve this page</a>
|
||||
</div>
|
||||
<h1>{{ page.title }}</h1>
|
||||
{{ content }}
|
||||
23
docs/_layouts/error.html
Normal file
23
docs/_layouts/error.html
Normal file
@@ -0,0 +1,23 @@
|
||||
{% include top.html %}
|
||||
|
||||
<body class="wrap">
|
||||
<header>
|
||||
<div class="grid">
|
||||
<div class="unit whole align-center">
|
||||
<h1>
|
||||
<a href="/">
|
||||
<span class="sr-only">Jekyll</span>
|
||||
<img src="/img/logo-2x.png" width="249" height="115" alt="Jekyll Logo">
|
||||
</a>
|
||||
</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
|
||||
{{ content }}
|
||||
|
||||
{% include anchor_links.html %}
|
||||
{% include analytics.html %}
|
||||
|
||||
</body>
|
||||
</html>
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user