Compare commits

..

887 Commits

Author SHA1 Message Date
Pat Hawks
177c1ca09e Cache all the things! 2018-08-13 13:17:14 -05:00
Pat Hawks
07c5ddde4a Cache converted Markdown 2018-08-07 16:26:49 -05:00
Pat Hawks
4081044178 Cache highlights 2018-08-07 16:25:50 -05:00
Pat Hawks
139073430f Fix stupid test in a stupid way 2018-08-07 16:19:46 -05:00
Pat Hawks
575bf51fa2 Use disk for persistent cache 2018-08-07 16:19:32 -05:00
jekyllbot
4814b45847 Update history to reflect merge of #7173 [ci skip] 2018-08-06 15:02:19 -04:00
Ashwin Maroli
81392ae0ee Output Jekyll Version while debugging (#7173)
Merge pull request 7173
2018-08-06 15:02:17 -04:00
olivia
9136e9c394 add cloudcannon to site sponsors 2018-08-06 18:33:31 +02:00
Pat Hawks
62a65cd358 Always clear cache when config changes 2018-08-04 14:27:11 -05:00
Pat Hawks
3e077bba84 Use key? instead of has_key? because Rubocop 2018-08-04 14:27:10 -05:00
Pat Hawks
2b33b3df23 Add getset method 2018-08-04 14:27:10 -05:00
Pat Hawks
f7d5559f10 Add basic Cache class 2018-08-04 14:27:07 -05:00
liv
4d6edb3a26 update sponsor links 2018-08-04 19:38:08 +02:00
olivia
fb7a13ab1e add siteleaf to site sponsors 2018-08-03 13:31:41 +02:00
jekyllbot
87cc350313 Update history to reflect merge of #7168 [ci skip] 2018-08-02 15:05:10 -04:00
Ken Salomon
85be75160c Document TSV as a supported data file format (#7168)
Merge pull request 7168
2018-08-02 15:05:09 -04:00
Frank Taillandier
0ff2ef7d28 Merge pull request #7171 from ashmaroli/codeclimate-badges
Fix links in Code Climate badges
2018-08-02 20:58:26 +02:00
Ashwin Maroli
aaa723373b Fix links in Code Climate badges 2018-08-02 22:30:33 +05:30
liv
ce6173360d revert and manually use sponsor images 2018-08-02 09:24:04 +02:00
liv
b4b90a989c use the correct sponsor embed 2018-08-02 09:22:13 +02:00
liv
edbd9f3028 fix opencollective display in readme 2018-08-01 14:25:41 +02:00
liv
2eb0c5bc8d Merge pull request #7142 from monkeywithacupcake/patch-1
Display Open Collective backers and sponsors
2018-08-01 14:12:13 +02:00
liv
e51f9c346c Merge pull request #7143 from jekyll/sponsor
Prepare docs for sponsoring
2018-08-01 14:11:33 +02:00
liv
f0da10a77a update blog post date 2018-08-01 09:56:40 +02:00
jekyllbot
51629865de Update history to reflect merge of #7158 [ci skip] 2018-07-31 16:12:59 -04:00
Pat Hawks
6e980f3f6a Remove 'cache_dir' during jekyll clean (#7158)
Merge pull request 7158
2018-07-31 16:12:57 -04:00
jekyllbot
37c9347422 Update history to reflect merge of #7163 [ci skip] 2018-07-28 12:22:16 -04:00
Zhang Xiangze
0001895968 Add closing tags for <a> (#7163)
Merge pull request 7163
2018-07-28 12:22:15 -04:00
jekyllbot
d0f8c86d2f Update history to reflect merge of #7162 [ci skip] 2018-07-27 15:17:03 -04:00
Kevin Plattret
493757d7cf Add version badge for date filters with ordinal (#7162)
Merge pull request 7162
2018-07-27 15:17:00 -04:00
Ashwin Maroli
66ac9b8675 Merge 'master' into optimize-liquid-rendering 2018-07-24 23:23:16 +05:30
Pat Hawks
ef41eeb7d4 Name some of our Travis builds 2018-07-23 13:29:36 -05:00
jekyllbot
fe0a6caa7f Update history to reflect merge of #7146 [ci skip] 2018-07-20 19:22:46 -04:00
Ken Salomon
5701087e7b Do not process Liquid in post excerpt when disabled in front matter (#7146)
Merge pull request 7146
2018-07-20 19:22:44 -04:00
Ashwin Maroli
e9f78247de Merge branch 'master' into sponsor 2018-07-17 22:06:47 +05:30
jekyllbot
02a2f9460a Update history to reflect merge of #7144 [ci skip] 2018-07-17 10:42:12 -04:00
Ashwin Maroli
e61cc513e9 Lock Travis to Bundler-1.16.2 (#7144)
Merge pull request 7144
2018-07-17 10:42:10 -04:00
olivia
477dbb34f4 update with suggestions 2018-07-17 16:04:14 +02:00
olivia
f0e26e9c1a add intentions to post; change title 2018-07-17 15:58:16 +02:00
olivia
9f05275619 Merge branch 'master' into sponsor 2018-07-17 12:20:54 +02:00
olivia
89ac354d5a add blank newline 2018-07-17 12:20:09 +02:00
Ashwin Maroli
f034f624cc document change in behavior and its workaround 2018-07-17 09:58:18 +05:30
Ashwin Maroli
c58d747506 Merge branch 'master' of https://github.com/jekyll/jekyll into optimize-liquid-rendering 2018-07-17 08:50:53 +05:30
jess
5c41eb743f Update README.markdown
Hi, I'm making updates for Open Collective. Either you or a supporter signed this repo up for Open Collective. This pull request adds backers and sponsors from your Open Collective https://opencollective.com/jekyll❤️

It adds two badges at the top to show the latest number of backers and sponsors. It also adds placeholders so that the avatar/logo of new backers/sponsors can automatically be shown without having to update your README.md. [more info](https://github.com/opencollective/opencollective/wiki/Github-banner). See how it looks on this [repo](https://github.com/apex/apex#backers).

You can also add a postinstall script to let people know after npm|yarn install that you are welcoming donations (optional). [More info](https://github.com/OpenCollective/opencollective-cli)
You can also add a "Donate" button to your website and automatically show your backers and sponsors there with our widgets. Have a look here: https://opencollective.com/widgets

P.S: As with any pull request, feel free to comment or suggest changes. The only thing "required" are the placeholders on the README because we believe it's important to acknowledge the people in your community that are contributing (financially or with code!).

Thank you for your great contribution to the open source community. You are awesome! 🙌
And welcome to the open collective community! 😊

Come chat with us in the #opensource channel on https://slack.opencollective.com - great place to ask questions and share best practices with other open source sustainers!
2018-07-16 13:06:18 -07:00
jekyllbot
ad9fbeb4b1 Update history to reflect merge of #7140 [ci skip] 2018-07-16 15:04:22 -04:00
Ashwin Maroli
50e0379444 Initialize upgrading doc for v4.0 (#7140)
Merge pull request 7140
2018-07-16 15:04:19 -04:00
Frank Taillandier
c2649ce5fb Merge pull request #7141 from belhassen07/master
Add dev.to link
2018-07-16 17:14:37 +02:00
Frank Taillandier
4cfba70355 Merge branch 'master' into master 2018-07-16 17:14:22 +02:00
Belhassen Chelbi
6802ec93eb Add Dev.to website link 2018-07-16 15:13:26 +01:00
jekyllbot
707e48a412 Update history to reflect merge of #7139 [ci skip] 2018-07-16 09:58:28 -04:00
Belhassen Chelbi
ca2766c2a1 Add DEV Community's Jekyll tag to community page (#7139)
Merge pull request 7139
2018-07-16 09:58:26 -04:00
Ashwin Maroli
cf9176efba parse variables in our tags directly via Liquid 2018-07-16 14:15:35 +05:30
Ashwin Maroli
8256ff1757 cache templates parsed by Liquid 2018-07-16 14:14:58 +05:30
Belhassen Chelbi
af78a1a568 Add DEV Community's Jekyll tag to community page 2018-07-16 03:17:22 +01:00
jekyllbot
34a1b7aeef Update history to reflect merge of #7138 [ci skip] 2018-07-15 18:18:44 -04:00
104fps
b2c6d03b47 Update docs about post creation (#7138)
Merge pull request 7138
2018-07-15 18:18:43 -04:00
jekyllbot
e49f507e4f Update history to reflect merge of #7134 [ci skip] 2018-07-15 16:11:46 -04:00
Ashwin Maroli
506c764e1e fix incorrectly passed arguments to assert_equal (#7134)
Merge pull request 7134
2018-07-15 16:11:45 -04:00
jekyllbot
16e9820dac Update history to reflect merge of #7133 [ci skip] 2018-07-13 19:48:02 -04:00
Ken Salomon
c7ce7ae054 fix up refute_equal call (#7133)
Merge pull request 7133
2018-07-13 19:48:00 -04:00
jekyllbot
3be9e74942 Update history to reflect merge of #6824 [ci skip] 2018-07-13 12:12:51 -04:00
Pat Hawks
7a4b3fe03d Disable Liquid via front matter (#6824)
Merge pull request 6824
2018-07-13 12:12:49 -04:00
jekyllbot
b69196cad3 Update history to reflect merge of #7132 [ci skip] 2018-07-13 06:33:58 -04:00
Scott Killen
f9ada3ced6 Fix custom 404 page for GitHub pages (#7132)
Merge pull request 7132
2018-07-13 06:33:56 -04:00
jekyllbot
e10444abf7 Update history to reflect merge of #7128 [ci skip] 2018-07-12 10:21:25 -04:00
Ashwin Maroli
9adac3a11e Fix Rubocop offences in test files (#7128)
Merge pull request 7128
2018-07-12 10:21:23 -04:00
jekyllbot
0612542582 Update history to reflect merge of #7125 [ci skip] 2018-07-11 13:32:41 -04:00
jekyllbot
5d1f85928a Use a real theme in the example (#7125)
Merge pull request 7125
2018-07-11 13:32:39 -04:00
jekyllbot
dcbc443387 Update history to reflect merge of #7126 [ci skip] 2018-07-11 10:01:20 -04:00
Jakob Krigovsky
1801793035 Use .markdown for page templates (#7126)
Merge pull request 7126
2018-07-11 10:01:17 -04:00
jekyllbot
0e0960e2c3 Update history to reflect merge of #7127 [ci skip] 2018-07-11 09:14:16 -04:00
Nicolas Hoizey
402ee84abb Add the jekyll-firstimage filter plugin (#7127)
Merge pull request 7127
2018-07-11 09:14:14 -04:00
jekyllbot
5950a7c113 Update history to reflect merge of #7122 [ci skip] 2018-07-09 23:06:56 -04:00
Alex Wood
8846741ed2 Fix #7082 Add call to unused method (#7122)
Merge pull request 7122
2018-07-09 23:06:54 -04:00
jekyllbot
a1ea95d445 Update history to reflect merge of #7114 [ci skip] 2018-07-09 12:12:39 -04:00
Derek Smart
3650baa5db add jekyll-xml-source (#7114)
Merge pull request 7114
2018-07-09 12:12:37 -04:00
Pat Hawks
4c7dbb6915 Fix tests to have "expected value" as the first argument passed to assert_equal (#7104)
* assert_equal(exp, act)

* improve clarity of PageWithoutAFile test

* Hoist invariant out of loop
2018-07-09 11:10:35 -05:00
jekyllbot
c124937e69 Update history to reflect merge of #6608 [ci skip] 2018-07-09 01:25:34 -04:00
Kelly-Ann Green
f4fcfbdaa0 Update item_property to return numbers as numbers instead of strings (#6608)
Merge pull request 6608
2018-07-09 01:25:32 -04:00
jekyllbot
caa0846e7b Update history to reflect merge of #7095 [ci skip] 2018-07-08 14:12:13 -04:00
Alexey Kopytko
d57715031a Instructions to view theme’s files under Linux (#7095)
Merge pull request 7095
2018-07-08 14:12:11 -04:00
jekyllbot
565567ac08 Update history to reflect merge of #7105 [ci skip] 2018-07-08 14:04:43 -04:00
Christian Oliff
385bf36724 Updates to v1.4 (#7105)
Merge pull request 7105
2018-07-08 14:04:41 -04:00
Frank Taillandier
70f4d4908d Fix: Escape Liquid 2018-07-07 13:01:41 +02:00
jekyllbot
bfd58fa949 Update history to reflect merge of #7112 [ci skip] 2018-07-06 14:47:05 -04:00
Boris van Hoytema
43f4fc6c70 GitHub enables you to use themes from other repos (#7112)
Merge pull request 7112
2018-07-06 14:47:03 -04:00
jekyllbot
4d96e4b7bd Update history to reflect merge of #7024 [ci skip] 2018-06-29 15:36:39 -04:00
Tom Harvey
e418d9b2f4 Example of CircleCI deployment through CircleCI v2 (#7024)
Merge pull request 7024
2018-06-29 15:36:37 -04:00
olivia
2dcdc49a36 add sponsoring post 2018-06-28 19:17:50 +02:00
olivia
efb7819d2e add forestry logo 2018-06-28 17:55:29 +02:00
olivia
67331185c2 add sponsor display in website footer 2018-06-26 22:48:26 +02:00
jekyllbot
caae9d2eca Update history to reflect merge of #7078 [ci skip] 2018-06-25 21:43:35 -04:00
Ralph
cb84017bbe Update rubocop version to 0.57.x (#7078)
Merge pull request 7078
2018-06-25 21:43:33 -04:00
jekyllbot
0728ccf08b Update history to reflect merge of #7093 [ci skip] 2018-06-23 16:57:36 -04:00
jekyllbot
0b6962cfe9 Use assert_include (#7093)
Merge pull request 7093
2018-06-23 16:57:35 -04:00
jekyllbot
3204445d6f Update history to reflect merge of #7091 [ci skip] 2018-06-23 09:27:32 -04:00
Steven Westmoreland
76422b03b7 Adding jekyll-info plugin (#7091)
Merge pull request 7091
2018-06-23 09:27:30 -04:00
jekyllbot
76919eea3b Update history to reflect merge of #7089 [ci skip] 2018-06-21 05:25:52 -04:00
Anne Gentle
1d461224dd Update travis-ci.md (#7089)
Merge pull request 7089
2018-06-21 05:25:50 -04:00
jekyllbot
8b63fbed6b Update history to reflect merge of #7086 [ci skip] 2018-06-20 11:43:50 -04:00
Jan Pobořil
f0cbbbb304 Added plugin json-get. (#7086)
Merge pull request 7086
2018-06-20 11:43:48 -04:00
jekyllbot
55ea4c840b Update history to reflect merge of #7066 [ci skip] 2018-06-17 11:36:56 -04:00
jekyllbot
bbc9c99cf9 Remember to release docs gem (#7066)
Merge pull request 7066
2018-06-17 11:36:54 -04:00
Frank Taillandier
6dbf8f469c Merge pull request #7070 from chrisfinazzo/remove-gemnasium
Remove Gemnasium badge
2018-06-12 17:55:34 +02:00
chrisfinazzo
cd996387a5 Remove Gemnasium badge 2018-06-11 22:05:38 -04:00
jekyllbot
baf70295f9 Update history to reflect merge of #7049 [ci skip] 2018-06-05 13:27:04 -04:00
Patrick Favre-Bulle
10b23f7466 Add Hints for some Improved Travis Config in Doc (#7049)
Merge pull request 7049
2018-06-05 13:27:02 -04:00
jekyllbot
e47dad9d20 Update history to reflect merge of #7058 [ci skip] 2018-06-05 12:09:26 -04:00
Stephan Fischer
4baa0093ed [Doc] Fixing a small typo (#7058)
Merge pull request 7058
2018-06-05 12:09:24 -04:00
Frank Taillandier
d7cef0c6db Merge branch 'master' into release-3.8.3 2018-06-05 16:08:49 +02:00
Pat Hawks
4c2c33aefd Merge branch '3.8-stable' into master 2018-06-05 08:31:40 -05:00
Pat Hawks
48e2de862d Release 💎 3.8.3 2018-06-05 08:23:52 -05:00
Pat Hawks
5687a09255 Release 💎 3.8.3 2018-06-04 21:39:43 -05:00
jekyllbot
c6415ce081 Update history to reflect merge of #7046 [ci skip] 2018-06-02 13:56:29 -04:00
Keith Mifsud
0e360623cb Listed the keyll-target-blank plugin in plugins list. (#7046)
Merge pull request 7046
2018-06-02 13:56:27 -04:00
jekyllbot
035ea729ff Update history to reflect merge of #7050 [ci skip] 2018-06-02 06:50:34 -04:00
Frank Taillandier
6c771608e5 Update Rubocop's config (#7050)
Merge pull request 7050
2018-06-02 06:50:32 -04:00
jekyllbot
6805f1c342 Update history to reflect merge of #7044 [ci skip] 2018-05-31 12:13:47 -04:00
Parker Moore
1684905ec7 Allow i18n v0.9.5 and higher (#7044)
Merge pull request 7044
2018-05-31 12:13:45 -04:00
jekyllbot
d64493806c Update history to reflect merge of #7037 [ci skip] 2018-05-24 16:27:59 -04:00
Ali Thompson
e3b325931b Update drafts.md (#7037)
Merge pull request 7037
2018-05-24 16:27:57 -04:00
jekyllbot
a96f846bdb Update history to reflect merge of #7031 [ci skip] 2018-05-21 02:45:05 -04:00
Dan Friedman
97c28f5495 Updated to supported version (#7031)
Merge pull request 7031
2018-05-21 02:45:03 -04:00
jekyllbot
03c252ba4d Update history to reflect merge of #7027 [ci skip] 2018-05-20 11:32:29 -05:00
Philip Belesky
6792ff936c Fix --unpublished not affecting collection documents (#7027)
Merge pull request 7027
2018-05-20 11:31:28 -05:00
jekyllbot
e932a1e27f Update history to reflect merge of #7027 [ci skip] 2018-05-20 12:30:17 -04:00
Philip Belesky
9aec161550 Fix --unpublished not affecting collection documents (#7027)
Merge pull request 7027
2018-05-20 12:30:15 -04:00
jekyllbot
9968df06b3 Update history to reflect merge of #6768 [ci skip] 2018-05-19 15:49:56 -04:00
Ana María Martínez Gómez
bc84603017 Useless privates removed (#6768)
Merge pull request 6768
2018-05-19 15:49:54 -04:00
Pat Hawks
d22b8ee392 Release 💎 3.8.2 2018-05-19 10:30:00 -05:00
Pat Hawks
784f2e2c0d Merge branch '3.8-stable' 2018-05-19 10:30:00 -05:00
jekyllbot
b89efa5d5d Update history to reflect merge of #7016 [ci skip] 2018-05-18 12:38:33 -05:00
Nikita Skalkin
450da91b4b Update rubocop version (#7016)
Merge pull request 7016
2018-05-18 12:34:52 -05:00
jekyllbot
b18872b658 Update history to reflect merge of #7015 [ci skip] 2018-05-18 11:28:46 -05:00
Kyle Barbour
74581422e3 Add whitespace control to LIQUID_TAG_REGEX (#7015)
Merge pull request 7015
2018-05-18 11:27:43 -05:00
jekyllbot
aed72f6464 Update history to reflect merge of #7015 [ci skip] 2018-05-17 18:22:33 -04:00
Kyle Barbour
b915c7577b Add whitespace control to LIQUID_TAG_REGEX (#7015)
Merge pull request 7015
2018-05-17 18:22:32 -04:00
jekyllbot
3bf940b7ee Update history to reflect merge of #7016 [ci skip] 2018-05-15 15:37:08 -04:00
Nikita Skalkin
fbaf591c12 Update rubocop version (#7016)
Merge pull request 7016
2018-05-15 15:37:05 -04:00
liv
007af750f4 Merge pull request #6995 from jekyll/oe-patch-1
Replace individual core team emails with link to team page
2018-05-15 17:39:23 +02:00
jekyllbot
62d297d4a0 Update history to reflect merge of #7011 [ci skip] 2018-05-14 10:05:24 -04:00
Martin Scharm
df0a5f7b0b added the CAT plugin to the plugin list (#7011)
Merge pull request 7011
2018-05-14 10:05:22 -04:00
Ashwin Maroli
8bb98632b4 Merge branch 'master' into oe-patch-1 2018-05-11 12:41:02 +05:30
jekyllbot
5a41149b7b Update history to reflect merge of #7007 [ci skip] 2018-05-10 18:28:40 -04:00
Ashwin Maroli
4f06767ac8 Load Rouge for TestKramdown (#7007)
Merge pull request 7007
2018-05-10 18:28:39 -04:00
Frank Taillandier
c6000597d9 Rephrase sentence 2018-05-10 18:35:18 +02:00
jekyllbot
b63036989a Update history to reflect merge of #7005 [ci skip] 2018-05-10 10:40:55 -04:00
penguinpet
9343d2e6bb proposed change for passive voice. (#7005)
Merge pull request 7005
2018-05-10 10:40:54 -04:00
jekyllbot
5d1823b604 Update history to reflect merge of #6988 [ci skip] 2018-05-09 09:44:38 -04:00
jekyllbot
149d5de59a Remove support for rdiscount (#6988)
Merge pull request 6988
2018-05-09 09:44:36 -04:00
jekyllbot
c2211eec0c Update history to reflect merge of #6985 [ci skip] 2018-05-09 07:52:13 -04:00
Andreas Möller
0b196ebd00 Mention _drafts in custom collections_dir note (#6985)
Merge pull request 6985
2018-05-09 07:52:11 -04:00
jekyllbot
56593bf897 Update history to reflect merge of #7003 [ci skip] 2018-05-09 07:45:21 -04:00
Frank Taillandier
e9b507a0df Textile is only supported through a converter plugin (#7003)
Merge pull request 7003
2018-05-09 07:45:18 -04:00
jekyllbot
a59eaff789 Update history to reflect merge of #7002 [ci skip] 2018-05-09 06:20:25 -04:00
Frank Taillandier
e2d8d3b92f List all static files variables (#7002)
Merge pull request 7002
2018-05-09 06:20:23 -04:00
olivia
66f8e748fe Replace individual core team emails 2018-05-07 19:52:59 +02:00
jekyllbot
0c5b74377b Update history to reflect merge of #6994 [ci skip] 2018-05-07 13:49:56 -04:00
Arjun Thakur
cec17d03f8 Updated nginx configuration for custom-404-page documentation (#6994)
Merge pull request 6994
2018-05-07 13:49:55 -04:00
Frank Taillandier
9e76d2b496 Merge pull request #6993 from ashmaroli/revert-docs-liquified-link
Revert update to docs meant for v4.0
2018-05-07 10:21:20 +02:00
Ashwin Maroli
192df096b0 Revert update to docs meant for v4.0 2018-05-07 13:43:41 +05:30
jekyllbot
694800270a Update history to reflect merge of #6990 [ci skip] 2018-05-07 03:45:34 -04:00
jekyllbot
7612056bed Update history to reflect merge of #6987 [ci skip] 2018-05-06 10:18:04 -04:00
Nikita Skalkin
e0758ba550 Remove support for Redcarpet (#6987)
Merge pull request 6987
2018-05-06 10:18:02 -04:00
Frank Taillandier
41fa9cda36 Fix tests
Co-Authored-By: ashmaroli <ashmaroli@users.noreply.github.com>
2018-05-04 14:14:44 +02:00
jekyllbot
be25b47486 Update history to reflect merge of #6978 [ci skip] 2018-05-03 10:03:57 -04:00
Ashwin Maroli
f8dfbd2f7b Drop support for older versions of Rouge (#6978)
Merge pull request 6978
2018-05-03 10:03:55 -04:00
jekyllbot
acdbf81476 Update history to reflect merge of #6551 [ci skip] 2018-05-03 08:53:32 -04:00
Ashwin Maroli
7e1afd32a5 Suggest re-running command with --trace on fail (#6551)
Merge pull request 6551
2018-05-03 08:53:30 -04:00
Frank Taillandier
1eff0214d1 Update index.html 2018-05-03 10:43:10 +02:00
Frank Taillandier
bb1889afe4 Update quickstart.md 2018-05-03 10:41:04 +02:00
jekyllbot
3eb73f2795 Update history to reflect merge of #6269 [ci skip] 2018-05-02 19:58:14 -04:00
Alexey Pelykh
b95151c4a7 Liquefied link tag (#6269)
Merge pull request 6269
2018-05-02 19:58:12 -04:00
jekyllbot
c0ae27f068 Update history to reflect merge of #6926 [ci skip] 2018-05-02 16:59:34 -04:00
Lars Kanis
64677e7c36 Update Windows install docs (#6926)
Merge pull request 6926
2018-05-02 16:59:32 -04:00
jekyllbot
3899bf52f8 Update history to reflect merge of #6977 [ci skip] 2018-05-02 14:46:39 -04:00
Pat Hawks
15f1ed8c4f We are not using Ruby 2.2 anymore (#6977)
Merge pull request 6977
2018-05-02 14:46:37 -04:00
jekyllbot
b6201db17f Update history to reflect merge of #6976 [ci skip] 2018-05-02 12:14:21 -04:00
Nikita Skalkin
ed9e72db9e yajl-ruby update to v1.4.0 (#6976)
Merge pull request 6976
2018-05-02 12:14:19 -04:00
jekyllbot
a499018dc8 Update history to reflect merge of #6975 [ci skip] 2018-05-02 07:33:55 -04:00
Pat Hawks
c08b882717 Update instructions for releasing docs Gem (#6975)
Merge pull request 6975
2018-05-02 07:33:53 -04:00
Pat Hawks
b0a1c42222 Merge branch '3.8-stable' 2018-05-01 15:12:42 -05:00
Pat Hawks
3ed4dbd227 Release 💎 3.8.1 2018-05-01 15:00:40 -05:00
jekyllbot
da6c4c488a Update history to reflect merge of #6956 [ci skip] 2018-05-01 13:57:27 -04:00
Karel Bílek
a80442ee87 Add version number for group_by_exp doc (#6956)
Merge pull request 6956
2018-05-01 13:57:25 -04:00
jekyllbot
9b8f9bba4e Update history to reflect merge of #6945 [ci skip] 2018-05-01 11:02:26 -05:00
jekyllbot
9ad78ebdeb Update history to reflect merge of #6959 [ci skip] 2018-05-01 10:59:36 -05:00
Ashwin Maroli
4a45407558 Liquify documents unless published == false 2018-05-01 10:59:36 -05:00
jekyllbot
305342ffa4 Update history to reflect merge of #6959 [ci skip] 2018-05-01 11:04:40 -04:00
Ashwin Maroli
b22e281bc5 Liquify documents unless published == false (#6959)
Merge pull request 6959
2018-05-01 11:04:38 -04:00
jekyllbot
5b37555835 Update history to reflect merge of #6931 [ci skip] 2018-05-01 09:33:53 -04:00
jekyllbot
95a103b882 bump i18n (#6931)
Merge pull request 6931
2018-05-01 09:33:51 -04:00
jekyllbot
12fa319ee4 Update history to reflect merge of #6967 [ci skip] 2018-05-01 08:37:46 -04:00
Pat Hawks
9461c900c0 Loggers should accept both numbers and symbols (#6967)
Merge pull request 6967
2018-05-01 08:37:45 -04:00
jekyllbot
43de0b694f Update history to reflect merge of #6970 [ci skip] 2018-04-30 19:55:26 -05:00
Pat Hawks
e00c8c72e9 Backported to 3.8-stable, NOT master 2018-04-30 19:52:50 -05:00
jekyllbot
3e8196fc7e Update history to reflect merge of #6970 [ci skip] 2018-04-30 20:49:18 -04:00
Pat Hawks
a89bba3712 Fix rendering Liquid constructs in excerpts (#6970)
Merge pull request 6970
2018-04-30 20:49:16 -04:00
jekyllbot
eea203c77e Update history to reflect merge of #6951 [ci skip] 2018-04-30 20:00:13 -04:00
Ashwin Maroli
8c8e2db0e5 Memoize computing excerpt's relative_path (#6951)
Merge pull request 6951
2018-04-30 20:00:11 -04:00
jekyllbot
ebce53dd08 Update history to reflect merge of #6968 [ci skip] 2018-04-30 18:29:25 -04:00
030
34b710e133 [#6920] prevent that vendor folder will be committed (#6968)
Merge pull request 6968
2018-04-30 18:29:23 -04:00
jekyllbot
f686b244cf Update history to reflect merge of #6969 [ci skip] 2018-04-30 15:40:13 -04:00
Chris Finazzo
739411ff3b Fix typo (#6969)
Merge pull request 6969
2018-04-30 15:40:11 -04:00
jekyllbot
c8eb0c1950 Update history to reflect merge of #6781 [ci skip] 2018-04-30 15:03:35 -04:00
Damien Solodow
27ca1282fa update windows doc (#6781)
Merge pull request 6781
2018-04-30 15:03:34 -04:00
jekyllbot
b22915fe22 Update history to reflect merge of #6770 [ci skip] 2018-04-30 15:01:00 -04:00
Ashwin Maroli
cf6d60b145 remove unnecessary Jekyll::Page constant (#6770)
Merge pull request 6770
2018-04-30 15:00:58 -04:00
jekyllbot
c60dd66db5 Update history to reflect merge of #6560 [ci skip] 2018-04-30 11:44:50 -04:00
Ashwin Maroli
c2851766c5 Drop support for Ruby 2.1 and 2.2 (#6560)
Merge pull request 6560
2018-04-30 11:44:48 -04:00
jekyllbot
c27533c75d Update history to reflect merge of #6511 [ci skip] 2018-04-30 11:19:45 -04:00
Ashwin Maroli
f81f1e8e1b remove unused error class (#6511)
Merge pull request 6511
2018-04-30 11:19:43 -04:00
jekyllbot
99da7cd940 Update history to reflect merge of #6927 [ci skip] 2018-04-30 10:59:35 -04:00
Chris Finazzo
3e32d12c45 WIP: Do not advise users to install Jekyll outside of Bundler (#6927)
Merge pull request 6927
2018-04-30 10:59:33 -04:00
jekyllbot
3af8553c7c Update history to reflect merge of #6945 [ci skip] 2018-04-26 01:58:27 -04:00
Ashwin Maroli
7f9ac93e4f Fix rendering Liquid constructs in excerpts (#6945)
Merge pull request 6945
2018-04-26 01:58:25 -04:00
jekyllbot
4dd00fd354 Update history to reflect merge of #6949 [ci skip] 2018-04-22 22:11:47 -04:00
Monica Powell
3ee71c048c Updated casing of SaaS (#6949)
Merge pull request 6949
2018-04-22 22:11:45 -04:00
jekyllbot
77fe78eaf7 Update history to reflect merge of #6934 [ci skip] 2018-04-22 16:28:47 -04:00
olivia
0dede77a4a Add 4.0 development post (#6934)
Merge pull request 6934
2018-04-22 16:28:45 -04:00
jekyllbot
f9f5d5fa57 Update history to reflect merge of #6946 [ci skip] 2018-04-22 08:35:07 -04:00
Robert Riemann
d5c2ebe610 add liquid tag jekyll-flickr (#6946)
Merge pull request 6946
2018-04-22 08:35:05 -04:00
jekyllbot
f691121d2b Update history to reflect merge of #6932 [ci skip] 2018-04-20 15:24:41 -04:00
jekyllbot
29787c7eb7 use jekyll-compose if installed (#6932)
Merge pull request 6932
2018-04-20 15:24:39 -04:00
jekyllbot
83d950a4b7 Update history to reflect merge of #6925 [ci skip] 2018-04-20 05:29:24 -04:00
Mike Kasberg
5966e84313 Add Installation Instructions for Ubuntu (#6925)
Merge pull request 6925
2018-04-20 05:29:22 -04:00
jekyllbot
66a8a03124 Update history to reflect merge of #6849 [ci skip] 2018-04-19 11:08:03 -04:00
Ashwin Maroli
40d6ebd85e Release post for v3.8.0 (#6849)
Merge pull request 6849
2018-04-19 11:08:01 -04:00
olivia
d0b907c2e6 Release 💎 3.8.0 2018-04-19 17:07:12 +02:00
jekyllbot
a7b1cbe3f8 Update history to reflect merge of #6885 [ci skip] 2018-04-19 11:02:38 -04:00
Ashwin Maroli
bea275e4c5 Allow front matter defaults to be applied properly to documents gathered under custom collections_dir (#6885)
Merge pull request 6885
2018-04-19 11:02:36 -04:00
jekyllbot
8941265837 Update history to reflect merge of #6933 [ci skip] 2018-04-18 17:09:26 -04:00
Awjin Ahn
24df53be20 Update index.md (#6933)
Merge pull request 6933
2018-04-18 17:09:24 -04:00
jekyllbot
3a5cd964af Update history to reflect merge of #6822 [ci skip] 2018-04-16 15:11:30 -04:00
ashmaroli
cd513da07e Refactor private method HighlightBlock#parse_options (#6822)
Merge pull request 6822
2018-04-16 15:11:28 -04:00
jekyllbot
822d020086 Update history to reflect merge of #6930 [ci skip] 2018-04-16 12:21:08 -04:00
David Zhang
7a6d0ccca3 Fix CodeClimate badges [ci skip] (#6930)
Merge pull request 6930
2018-04-16 12:21:06 -04:00
jekyllbot
d14f9aba99 Update history to reflect merge of #6929 [ci skip] 2018-04-16 10:24:09 -04:00
Frank Taillandier
4d26d30b6c Bump to Rubocop 0.55 (#6929)
Merge pull request 6929
2018-04-16 10:24:07 -04:00
Frank Taillandier
7e72cbddd2 Merge pull request #6928 from ashmaroli/troubleshooting-docs
Correct errors in troubleshooting.md
2018-04-16 13:47:14 +02:00
Ashwin Maroli
6fc2cfea6e remove unnecessary characters 2018-04-16 16:10:53 +05:30
Ashwin Maroli
3f98a743ed Correct errors in troubleshooting.md 2018-04-16 12:54:39 +05:30
jekyllbot
2a86c00011 Update history to reflect merge of #6881 [ci skip] 2018-04-12 15:45:36 -04:00
Frank Taillandier
7dc4d4fd67 Docs: Install Jekyll on macOS (#6881)
Merge pull request 6881
2018-04-12 15:45:34 -04:00
olivia
551037c37b Release 💎 3.8.0.pre.rc2 2018-04-12 21:16:35 +02:00
jekyllbot
ba52e9e7c1 Update history to reflect merge of #6782 [ci skip] 2018-04-12 14:24:57 -04:00
Delson Lima
5096e8a9ac add Arch Linux instalation troubleshoot (#6782)
Merge pull request 6782
2018-04-12 14:24:55 -04:00
jekyllbot
c9346ef522 Update history to reflect merge of #6841 [ci skip] 2018-04-12 12:56:48 -04:00
ashmaroli
8f78afe92b optimize computing filename in LiquidRenderer (#6841)
Merge pull request 6841
2018-04-12 12:56:47 -04:00
Pat Hawks
5da2b316eb Move #6891 to Bug Fixes 2018-04-12 11:27:58 -05:00
jekyllbot
449a874bf7 Update history to reflect merge of #6891 [ci skip] 2018-04-12 11:37:44 -04:00
ashmaroli
d09db32d10 handle liquid tags in excerpts robustly (#6891)
Merge pull request 6891
2018-04-12 11:37:42 -04:00
jekyllbot
d1aa1cfd5b Update history to reflect merge of #6887 [ci skip] 2018-04-12 11:37:16 -04:00
ashmaroli
971815cd5c store regexp in a constant (#6887)
Merge pull request 6887
2018-04-12 11:37:14 -04:00
jekyllbot
5ba6a36b1f Update history to reflect merge of #6868 [ci skip] 2018-04-12 11:36:54 -04:00
ashmaroli
053b522a82 implement a cache within the where filter (#6868)
Merge pull request 6868
2018-04-12 11:36:53 -04:00
jekyllbot
beada92da8 Update history to reflect merge of #6856 [ci skip] 2018-04-12 11:36:14 -04:00
ashmaroli
29dc190fcb Store and retrieve converter instances for Jekyll::Filters via a hash (#6856)
Merge pull request 6856
2018-04-12 11:36:12 -04:00
jekyllbot
bfdd26fdcc Update history to reflect merge of #6818 [ci skip] 2018-04-12 11:34:58 -04:00
ashmaroli
651b9b5593 include_relative tag should find related documents in collections gathered within custom collections_dir (#6818)
Merge pull request 6818
2018-04-12 11:34:55 -04:00
jekyllbot
8fab142750 Update history to reflect merge of #6919 [ci skip] 2018-04-11 13:15:15 -04:00
Benjamin Høegh
3cbfc48e63 Fixed code issue (#6919)
Merge pull request 6919
2018-04-11 13:15:13 -04:00
jekyllbot
2765f0fcb9 Update history to reflect merge of #6910 [ci skip] 2018-04-10 11:00:15 -04:00
ashmaroli
36fbcaa863 Optimize loading library into memory (#6910)
Merge pull request 6910
2018-04-10 11:00:12 -04:00
jekyllbot
ef027be97e Update history to reflect merge of #6916 [ci skip] 2018-04-10 09:21:26 -04:00
ashmaroli
748051fbc6 Improve comment included in the starter index.md (#6916)
Merge pull request 6916
2018-04-10 09:21:25 -04:00
jekyllbot
a27d8faa34 Update history to reflect merge of #6917 [ci skip] 2018-04-09 16:58:00 -04:00
ashmaroli
d97b3412bc regenerate unconditionally unless its incremental (#6917)
Merge pull request 6917
2018-04-09 16:57:59 -04:00
jekyllbot
925fb6da45 Update history to reflect merge of #6915 [ci skip] 2018-04-09 04:26:51 -04:00
David Zhang
2a032a38ec Bump Rubocop to 0.54.x (#6915)
Merge pull request 6915
2018-04-09 04:26:49 -04:00
jekyllbot
7c12ebb28a Update history to reflect merge of #6855 [ci skip] 2018-04-08 13:07:03 -04:00
Kacper Duras
ba94e87978 Add jekyll-w2m to plugins (#6855)
Merge pull request 6855
2018-04-08 13:07:01 -04:00
jekyllbot
b6e3e739d9 Update history to reflect merge of #6907 [ci skip] 2018-04-05 16:26:31 -04:00
Roger Rohrbach
37b729fd87 Assert existence of <collection>.files (#6907)
Merge pull request 6907
2018-04-05 16:26:29 -04:00
jekyllbot
568257a192 Update history to reflect merge of #6898 [ci skip] 2018-04-04 03:46:21 -04:00
Robert Riemann
fcb2eb6658 doc: add liquid tag plugin jekyll-onebox for html previews (#6898)
Merge pull request 6898
2018-04-04 03:46:20 -04:00
jekyllbot
744563c188 Update history to reflect merge of #6897 [ci skip] 2018-04-03 13:43:15 -04:00
Stefan Dellmuth
2eee8128b0 Prevent rendering issue caused by a missing ul-tag (#6897)
Merge pull request 6897
2018-04-03 13:43:13 -04:00
jekyllbot
d3418738ad Update history to reflect merge of #6896 [ci skip] 2018-04-03 12:27:57 -04:00
Stefan Dellmuth
90e9ae308e Fixed typo in description of categories and tags (#6896)
Merge pull request 6896
2018-04-03 12:27:56 -04:00
Frank Taillandier
f119d2c921 Fix build on Travis
Co-Authored-By: ashmaroli <ashmaroli@users.noreply.github.com>
2018-04-03 14:10:43 +02:00
olivia
31e64b9fe9 Release 💎 3.8.0.pre.rc1 2018-04-03 13:34:57 +02:00
Frank Taillandier
e0f5001182 bump rubies 2018-03-31 17:13:11 +02:00
jekyllbot
bdbad98327 Update history to reflect merge of #6833 [ci skip] 2018-03-30 14:07:48 -04:00
Paweł Kuna
9e56c2727b Update plugins.md (#6833)
Merge pull request 6833
2018-03-30 14:07:47 -04:00
jekyllbot
688a63e671 Update history to reflect merge of #6878 [ci skip] 2018-03-30 10:50:53 -04:00
Kacper Duras
8b61d7a328 Bump JRuby (#6878)
Merge pull request 6878
2018-03-30 10:50:52 -04:00
jekyllbot
70df9c55e5 Update history to reflect merge of #6882 [ci skip] 2018-03-28 17:45:23 -04:00
steelman
6786970c96 Docs: describe difference between tags and categories (#6882)
Merge pull request 6882
2018-03-28 17:45:21 -04:00
Frank Taillandier
69e2c65be6 Latest version is 3.7.3 2018-03-25 18:18:59 +02:00
jekyllbot
31bdcdbc76 Update history to reflect merge of #6860 [ci skip] 2018-03-21 19:10:07 -04:00
ashmaroli
33f59aef2c minimize array allocations in the where filter (#6860)
Merge pull request 6860
2018-03-21 19:10:05 -04:00
jekyllbot
7d759f0ff0 Update history to reflect merge of #6858 [ci skip] 2018-03-21 18:24:06 -04:00
ashmaroli
8f3363e2dc Fix passing multiline params to include tag when using the variable syntax (#6858)
Merge pull request 6858
2018-03-21 18:24:04 -04:00
jekyllbot
f7b5e313c1 Update history to reflect merge of #6848 [ci skip] 2018-03-21 10:36:09 -04:00
ashmaroli
7317627b97 Improve regex usage in Tags::IncludeTag (#6848)
Merge pull request 6848
2018-03-21 10:36:06 -04:00
jekyllbot
603d513643 Update history to reflect merge of #6740 [ci skip] 2018-03-21 10:26:17 -04:00
ashmaroli
8c6433bd2d access document permalink attribute efficiently (#6740)
Merge pull request 6740
2018-03-21 10:26:15 -04:00
jekyllbot
e45997fb5b Update history to reflect merge of #6696 [ci skip] 2018-03-19 09:30:42 -04:00
ashmaroli
8595c67df0 Debug writing files during the build process (#6696)
Merge pull request 6696
2018-03-19 09:30:41 -04:00
Frank Taillandier
78684aa18a Merge pull request #6859 from EarthSchlange/patch-1
Fixed Minor Grammar Issue
2018-03-19 10:38:58 +01:00
Michael H
889c2e069c Fixed Minor Grammar Issue
This adds the missing 'and' between major updates ... detailed instructions.
2018-03-18 14:24:31 -07:00
jekyllbot
f6a43568d3 Update history to reflect merge of #6828 [ci skip] 2018-03-16 19:27:21 -04:00
Mike Kasberg
a275faa586 Add Bundler Installation Instructions (#6828)
Merge pull request 6828
2018-03-16 19:27:19 -04:00
Frank Taillandier
8caa101439 Merge pull request #6846 from ashmaroli/variable-for-avatar
Assign and use Liquid variables in templates
2018-03-14 13:27:05 +01:00
jekyllbot
af102baecd Update history to reflect merge of #6814 [ci skip] 2018-03-14 06:52:32 -04:00
ashmaroli
68315cea8a memoize document output extension (#6814)
Merge pull request 6814
2018-03-14 06:52:30 -04:00
jekyllbot
6f2a2915f1 Update history to reflect merge of #6809 [ci skip] 2018-03-14 06:51:46 -04:00
ashmaroli
55d64c7e70 Memoize Site#site_data (#6809)
Merge pull request 6809
2018-03-14 06:51:45 -04:00
jekyllbot
6a7a393df5 Update history to reflect merge of #6726 [ci skip] 2018-03-14 06:50:20 -04:00
ashmaroli
51bdea1303 Allow passing :strict_variables and :strict_filters options to Liquid's renderer (#6726)
Merge pull request 6726
2018-03-14 06:50:18 -04:00
Ashwin Maroli
b91ecf3c01 assign and use Liquid variables in templates 2018-03-14 15:34:46 +05:30
Frank Taillandier
86d86258a8 Merge pull request #6840 from MarioCekic/patch-1
Remove unnecessary whitespace in configuration.md
2018-03-11 18:22:59 +01:00
jekyllbot
13761dbf67 Update history to reflect merge of #6839 [ci skip] 2018-03-11 13:19:35 -04:00
Florian Thomas
5bb12d0099 fix minitest deprecation warning in test (#6839)
Merge pull request 6839
2018-03-11 13:19:33 -04:00
jekyllbot
83dc61a54c Update history to reflect merge of #6838 [ci skip] 2018-03-11 00:42:30 -05:00
Max Vilimpoc
e9ea98678c Update windows.md to explain an issue with jekyll new. (#6838)
Merge pull request 6838
2018-03-11 00:42:29 -05:00
Mario Cekic
3773827715 Update configuration.md 2018-03-10 15:05:21 +00:00
Mario Cekic
0aaddbd76b Update configuration.md 2018-03-10 14:30:50 +00:00
jekyllbot
a944dd940a Update history to reflect merge of #6795 [ci skip] 2018-03-09 21:11:26 -05:00
ashmaroli
f8a66ca76c Improve handling non-default collection documents rendering and writing (#6795)
Merge pull request 6795
2018-03-09 21:11:24 -05:00
jekyllbot
7508da11c1 Update history to reflect merge of #6610 [ci skip] 2018-03-09 21:09:57 -05:00
ashmaroli
e1b64f9afd Change regex to sanitize and normalize filenames passed to LiquidRenderer (#6610)
Merge pull request 6610
2018-03-09 21:09:55 -05:00
jekyllbot
1aae0bcc3a Update history to reflect merge of #6819 [ci skip] 2018-03-08 10:58:58 -05:00
ashmaroli
297371e6e2 Delegated methods after private keyword are meant to be private (#6819)
Merge pull request 6819
2018-03-08 10:58:57 -05:00
jekyllbot
c7f007686a Update history to reflect merge of #6773 [ci skip] 2018-03-05 17:16:01 -05:00
Ana María Martínez Gómez
ebcd830693 Allow date filters to output ordinal days (#6773)
Merge pull request 6773
2018-03-05 17:15:59 -05:00
jekyllbot
5b77850dc9 Update history to reflect merge of #5195 [ci skip] 2018-03-05 10:15:38 -05:00
Ben Balter
ced613c678 Add debug output to theme rendering (#5195)
Merge pull request 5195
2018-03-05 10:15:36 -05:00
Frank Taillandier
6130280f8b Update links to CloudCannon documentation 2018-03-04 23:27:45 +01:00
jekyllbot
93e16428d8 Update history to reflect merge of #6813 [ci skip] 2018-03-01 04:57:31 -05:00
ashmaroli
4032c3e286 Rewrite script/rubyprof as a Ruby script (#6813)
Merge pull request 6813
2018-03-01 04:57:30 -05:00
jekyllbot
7b2908809c Update history to reflect merge of #6759 [ci skip] 2018-02-28 15:52:56 -05:00
ashmaroli
16228ae499 create a single instance of PostReader per site (#6759)
Merge pull request 6759
2018-02-28 15:52:54 -05:00
jekyllbot
a9c7ca91fd Update history to reflect merge of #6767 [ci skip] 2018-02-28 11:07:52 -05:00
ashmaroli
07e49f8d23 Compute document's relative_path faster (#6767)
Merge pull request 6767
2018-02-28 11:07:50 -05:00
jekyllbot
5748d6ac30 Update history to reflect merge of #6735 [ci skip] 2018-02-28 11:06:10 -05:00
ashmaroli
23bb50c71c Bypass rendering via Liquid unless required (#6735)
Merge pull request 6735
2018-02-28 11:06:08 -05:00
jekyllbot
767db9417b Update history to reflect merge of #6808 [ci skip] 2018-02-28 11:00:56 -05:00
ashmaroli
6047927eed memoize helper methods in site-cleaner (#6808)
Merge pull request 6808
2018-02-28 11:00:54 -05:00
jekyllbot
d2a21fe776 Update history to reflect merge of #6801 [ci skip] 2018-02-27 17:29:07 -05:00
ashmaroli
ed20cb4f90 Remind user to resolve conflict in jekyll new with --force (#6801)
Merge pull request 6801
2018-02-27 17:29:05 -05:00
jekyllbot
92d491ea13 Update history to reflect merge of #6802 [ci skip] 2018-02-26 04:54:37 -05:00
Antonio Argote
bc214d28c7 add missing step for gem-based theme conversion (#6802)
Merge pull request 6802
2018-02-26 04:54:35 -05:00
jekyllbot
82d495aa0c Update history to reflect merge of #6807 [ci skip] 2018-02-26 04:53:04 -05:00
Christian Oliff
a9a77ee7e5 always load analytics.js over HTTPS (#6807)
Merge pull request 6807
2018-02-26 04:53:02 -05:00
olivia
dc8a0ee15f Update 3.7.3 release post 2018-02-25 18:05:25 +01:00
olivia
2ac6397368 Whoops, forgot the docs version 2018-02-25 18:01:09 +01:00
jekyllbot
08b222bdba Update history to reflect merge of #6803 [ci skip] 2018-02-25 11:58:48 -05:00
ashmaroli
12cbe54650 Draft a release post for v3.7.3 (#6803)
Merge pull request 6803
2018-02-25 11:58:46 -05:00
olivia
19f6ab70ae Generate docs site 2018-02-25 17:58:11 +01:00
olivia
01bc01cb9d Update history for 3.7.3 release 2018-02-25 17:43:24 +01:00
jekyllbot
ce8f111758 Update history to reflect merge of #6791 [ci skip] 2018-02-25 06:09:46 -05:00
ashmaroli
017f032b4c Do not hardcode locale unless certainly necessary (#6791)
Merge pull request 6791
2018-02-25 06:09:44 -05:00
olivia
ce44eb6921 fix broken link in maintainer blog post 2018-02-20 20:03:58 +01:00
Frank Taillandier
5868616810 Add @ayastreb wrap-up 2018-02-20 18:22:08 +01:00
jekyllbot
bc2c0c4f80 Update history to reflect merge of #6597 [ci skip] 2018-02-20 10:58:52 -05:00
ashmaroli
5ebdc184c0 Excerpt relative-path should match its path (#6597)
Merge pull request 6597
2018-02-20 10:58:50 -05:00
Frank Taillandier
da6a697cda Gauges away, we can Gauges away 2018-02-20 16:30:20 +01:00
jekyllbot
9262ff7ec4 Update history to reflect merge of #6724 [ci skip] 2018-02-20 09:47:58 -05:00
ashmaroli
a662bc24aa Append appropriate closing tag to Liquid block in an excerpt (#6724)
Merge pull request 6724
2018-02-20 09:47:56 -05:00
jekyllbot
88a3daa978 Update history to reflect merge of #6681 [ci skip] 2018-02-20 09:42:46 -05:00
ashmaroli
cef66defbd Allow Jekyll Doctor to detect stray posts dir (#6681)
Merge pull request 6681
2018-02-20 09:42:45 -05:00
jekyllbot
2b77ee80e0 Update history to reflect merge of #6736 [ci skip] 2018-02-20 09:36:36 -05:00
ashmaroli
a5c25ada1e Replace simple regex with equivalent Ruby methods (#6736)
Merge pull request 6736
2018-02-20 09:36:34 -05:00
jekyllbot
3a0d9bbc57 Update history to reflect merge of #6794 [ci skip] 2018-02-20 09:34:43 -05:00
Heinrich Hartmann
216582d703 Add reference to Liquid to plugin docs (#6794)
Merge pull request 6794
2018-02-20 09:34:41 -05:00
jekyllbot
3dd76a1941 Update history to reflect merge of #6792 [ci skip] 2018-02-20 04:51:09 -05:00
Christian Oliff
a59e0e3a14 Always load Google Fonts over HTTPS (#6792)
Merge pull request 6792
2018-02-20 04:51:07 -05:00
jekyllbot
a3aea47459 Update history to reflect merge of #6790 [ci skip] 2018-02-19 15:48:57 -05:00
Parker Moore
9a1cb9890b Say hello to Jekyll's New Lead Developer (#6790)
Merge pull request 6790
2018-02-19 15:48:55 -05:00
jekyllbot
fc28a3d8d1 Update history to reflect merge of #6784 [ci skip] 2018-02-18 10:47:32 -05:00
Frank Taillandier
00639f89bd Fix theme gem feature (#6784)
Merge pull request 6784
2018-02-18 10:47:31 -05:00
jekyllbot
31bd301b28 Update history to reflect merge of #6741 [ci skip] 2018-02-18 03:16:11 -05:00
ashmaroli
64706465de Cache the list of documents to be written (#6741)
Merge pull request 6741
2018-02-18 03:16:09 -05:00
jekyllbot
63046dbbf5 Update history to reflect merge of #6785 [ci skip] 2018-02-17 18:55:02 -05:00
John Eismeier
c5a2c40694 Propose fix some typos (#6785)
Merge pull request 6785
2018-02-17 18:55:01 -05:00
jekyllbot
e83645d702 Update history to reflect merge of #6777 [ci skip] 2018-02-17 08:55:06 -05:00
ashmaroli
275a1f4d5d Add a cucumber feature to test link tag (#6777)
Merge pull request 6777
2018-02-17 08:55:05 -05:00
jekyllbot
28ff8adcc6 Update history to reflect merge of #6775 [ci skip] 2018-02-16 11:42:00 -05:00
ashmaroli
e99f973b63 Update docs on permalink configuration (#6775)
Merge pull request 6775
2018-02-16 11:41:58 -05:00
jekyllbot
c038d83fc7 Update history to reflect merge of #6779 [ci skip] 2018-02-15 12:33:17 -05:00
ashmaroli
7040d26757 Fix documentation for {{ page.excerpt }} (#6779)
Merge pull request 6779
2018-02-15 12:33:16 -05:00
olivia
2da9eaf914 fix incorrect pull request metadata 2018-02-15 12:13:22 +01:00
jekyllbot
93ac88b70f Update history to reflect merge of #6776 [ci skip] 2018-02-15 06:05:29 -05:00
ashmaroli
28a1399bbd codeclimate: exclude livereload.js (#6776)
Merge pull request 6776
2018-02-15 06:05:27 -05:00
jekyllbot
5928eeee5b Update history to reflect merge of #6668 [ci skip] 2018-02-14 08:13:59 -05:00
ashmaroli
03f5610c97 Test against Ruby 2.5 on AppVeyor (#6668)
Merge pull request 6668
2018-02-14 08:13:57 -05:00
olivia
0395910391 make some PR titles more verbose 2018-02-11 11:48:54 +01:00
jekyllbot
073ac1c406 Update history to reflect merge of #6764 [ci skip] 2018-02-10 21:58:15 -05:00
Semen Zhydenko
8fae0052c8 Fix typos (#6764)
Merge pull request 6764
2018-02-10 21:58:13 -05:00
jekyllbot
33017b702d Update history to reflect merge of #6765 [ci skip] 2018-02-10 15:34:46 -05:00
Damien Solodow
8ebe5e3a3e Update windows.md (#6765)
Merge pull request 6765
2018-02-10 15:34:45 -05:00
jekyllbot
0b09c4ad8d Update history to reflect merge of #6757 [ci skip] 2018-02-08 08:51:15 -05:00
Eric Cornelissen
c0d891b08b Add jekyll-fontello to plugins (#6757)
Merge pull request 6757
2018-02-08 08:51:13 -05:00
jekyllbot
e6876b288a Update history to reflect merge of #6751 [ci skip] 2018-02-07 08:54:13 -05:00
jekyllbot
067d1e907f Remove links to Gists (#6751)
Merge pull request 6751
2018-02-07 08:54:11 -05:00
jekyllbot
8077019fc1 Update history to reflect merge of #6752 [ci skip] 2018-02-07 05:35:16 -05:00
KajMagnus
49b040c94e Mention Talkyard, a new commenting system for Jekyll and others. (#6752)
Merge pull request 6752
2018-02-07 05:35:15 -05:00
olivia
d343b0345e fix uncategorized entries in history file 2018-02-07 11:16:41 +01:00
jekyllbot
68dee159c5 Update history to reflect merge of #6745 [ci skip] 2018-02-07 05:11:47 -05:00
olivia
4c9166a9e1 Add document on releasing a new version (#6745)
Merge pull request 6745
2018-02-07 05:11:46 -05:00
olivia
1727db8ee5 fix contribution title in history document 2018-02-06 19:20:27 +01:00
jekyllbot
17065444e9 Update history to reflect merge of #6750 [ci skip] 2018-02-06 13:17:25 -05:00
Jakob Vad Nielsen
64c98ef08b Update plugins.md (#6750)
Merge pull request 6750
2018-02-06 13:17:23 -05:00
Frank Taillandier
0f2c27bcb0 update link to Sass example 2018-02-03 23:12:42 +01:00
jekyllbot
19cd07f059 Update history to reflect merge of #6737 [ci skip] 2018-02-01 15:02:41 -05:00
Tim Carry
6563350ded Adding the jekyll-algolia plugin to the list of plugins (#6737)
Merge pull request 6737
2018-02-01 15:02:40 -05:00
jekyllbot
3fb325998d Update history to reflect merge of #6732 [ci skip] 2018-01-31 15:55:57 -05:00
ashmaroli
bc06e241ea replace simple regex with a native Ruby method (#6732)
Merge pull request 6732
2018-01-31 15:55:55 -05:00
jekyllbot
23491541f6 Update history to reflect merge of #6730 [ci skip] 2018-01-31 15:32:53 -05:00
Parker Moore
b4985d1e63 Two massive performance improvements for large sites (#6730)
Merge pull request 6730
2018-01-31 15:32:51 -05:00
jekyllbot
138a12c481 Update history to reflect merge of #6593 [ci skip] 2018-01-29 11:36:39 -05:00
ashmaroli
8b72fa3fbf move duplicate code to a single private method (#6593)
Merge pull request 6593
2018-01-29 11:36:38 -05:00
olivia
5d12f318b3 update post username from "pup" to "oe" 2018-01-27 20:02:10 +01:00
olivia
0978bbe120 update release post 2018-01-25 19:38:08 +01:00
olivia
053acd31ac Release 💎 3.7.2 2018-01-25 19:34:49 +01:00
olivia
ece1a307c5 Bump version in docs config.yml 2018-01-25 19:33:16 +01:00
olivia
c04f4e901a We're skipping 3.6.1 2018-01-25 19:32:54 +01:00
olivia
50dbf1ace7 Release 💎 3.7.1 2018-01-25 19:22:48 +01:00
olivia
0c4eff0653 Prepare for 3.7.1 release 2018-01-25 19:21:00 +01:00
olivia
50b9858d3a Release 💎 3.7.1 2018-01-25 19:10:24 +01:00
jekyllbot
b2086eb1d4 Update history to reflect merge of #6695 [ci skip] 2018-01-25 13:04:18 -05:00
ashmaroli
5ca193eed9 Release v3.7.1 (#6695)
Merge pull request 6695
2018-01-25 13:04:16 -05:00
jekyllbot
641545821d Update history to reflect merge of #6685 [ci skip] 2018-01-25 10:45:36 -05:00
ashmaroli
a6b4ce0928 Refactor collections_dir feature for consistency (#6685)
Merge pull request 6685
2018-01-25 10:45:35 -05:00
jekyllbot
c8d729830c Update history to reflect merge of #6697 [ci skip] 2018-01-25 10:43:58 -05:00
Florian Thomas
cf5c689d94 Fix timezone incosistencies between different ruby version (#6697)
Merge pull request 6697
2018-01-25 10:43:56 -05:00
jekyllbot
c9d2da8722 Update history to reflect merge of #6720 [ci skip] 2018-01-25 10:42:51 -05:00
Chayoung You
731960e6e3 Remove redgreen gem as reflect of #204, 093a5ef (#6720)
Merge pull request 6720
2018-01-25 10:42:50 -05:00
jekyllbot
2ab15486a6 Update history to reflect merge of #6716 [ci skip] 2018-01-25 10:37:06 -05:00
Hendrik Schneider
07ec68a5d0 Update plugins.md (#6716)
Merge pull request 6716
2018-01-25 10:37:05 -05:00
Frank Taillandier
00cb17d3c4 Update History.markdown 2018-01-24 16:20:01 +01:00
jekyllbot
85cd6105df Update history to reflect merge of #6711 [ci skip] 2018-01-24 10:16:37 -05:00
ashmaroli
4d68304dea add gem "wdm" to all newly generated Gemfiles (#6711)
Merge pull request 6711
2018-01-24 10:16:35 -05:00
Frank Taillandier
83a6aebb2d Docs: Showcase sites and themes 2018-01-22 21:36:30 +01:00
jekyllbot
8ee052d454 Update history to reflect merge of #6615 [ci skip] 2018-01-20 17:04:54 -05:00
Parker Moore
3f4bb55e07 Write a Rubocop Cop to ensure no #p or #puts calls get committed to master. (#6615)
Merge pull request 6615
2018-01-20 17:04:52 -05:00
jekyllbot
707dd03fb0 Update history to reflect merge of #6654 [ci skip] 2018-01-20 16:45:15 -05:00
Kacper Duras
4490d2cfbf Add jekyll-html to plugins. (#6654)
Merge pull request 6654
2018-01-20 16:45:14 -05:00
jekyllbot
53c00c0a18 Update history to reflect merge of #6694 [ci skip] 2018-01-20 16:42:00 -05:00
Alexandr
44ffce977c Update installation.md (#6694)
Merge pull request 6694
2018-01-20 16:41:59 -05:00
jekyllbot
6b98a5c9cf Update history to reflect merge of #6692 [ci skip] 2018-01-19 14:26:49 -05:00
ashmaroli
009d308f9f Glob scope path only if configured with a pattern (#6692)
Merge pull request 6692
2018-01-19 14:26:47 -05:00
jekyllbot
578ad7695f Update history to reflect merge of #6703 [ci skip] 2018-01-19 14:22:12 -05:00
Paul Robert Lloyd
af88add273 Update note about naming of collections_dir. (#6703)
Merge pull request 6703
2018-01-19 14:22:10 -05:00
jekyllbot
5923160756 Update history to reflect merge of #6698 [ci skip] 2018-01-19 10:50:24 -05:00
Frank Taillandier
7a78da840d Lint file and bump theme dependencies (#6698)
Merge pull request 6698
2018-01-19 10:50:23 -05:00
jekyllbot
603f2ea52f Update history to reflect merge of #6666 [ci skip] 2018-01-14 16:38:19 -05:00
ashmaroli
2cb5375519 Update deploy-script in documentation (#6666)
Merge pull request 6666
2018-01-14 16:38:17 -05:00
jekyllbot
1dc0702e29 Update history to reflect merge of #6600 [ci skip] 2018-01-14 16:35:40 -05:00
jekyllbot
4a43a65969 Bump rdoc to 6.0 (#6600)
Merge pull request 6600
2018-01-14 16:35:39 -05:00
jekyllbot
8e62993fc8 Update history to reflect merge of #6596 [ci skip] 2018-01-14 16:28:13 -05:00
ashmaroli
9a88900246 require external library only if necessary (#6596)
Merge pull request 6596
2018-01-14 16:28:12 -05:00
jekyllbot
9cc6e2a1d1 Update history to reflect merge of #6670 [ci skip] 2018-01-14 15:47:55 -05:00
Florian Thomas
082e0623af inform that symlinks are not allowed in safe mode (#6670)
Merge pull request 6670
2018-01-14 15:47:53 -05:00
jekyllbot
f77d704a1b Update history to reflect merge of #6680 [ci skip] 2018-01-07 06:40:58 -05:00
Andreas Möller
a8a6230474 Fix: Add note about posts directory in context of custom collections directory (#6680)
Merge pull request 6680
2018-01-07 06:40:57 -05:00
jekyllbot
7895168cff Update history to reflect merge of #6677 [ci skip] 2018-01-06 11:10:33 -05:00
Florian Thomas
6a827547ab Update version in config.yml via YAML load / dump (#6677)
Merge pull request 6677
2018-01-06 11:10:31 -05:00
jekyllbot
a84e9e1f6d Update history to reflect merge of #6676 [ci skip] 2018-01-06 09:39:49 -05:00
jekyllbot
413de6a9b3 Display latest version in header (#6676)
Merge pull request 6676
2018-01-06 09:39:48 -05:00
Frank Taillandier
5ef2debefb typo 2018-01-06 13:45:07 +01:00
Frank Taillandier
4dccca27e0 Docs: Mention previous config key for plugins
fix #6674
2018-01-06 10:35:41 +01:00
jekyllbot
7f39de67d6 Update history to reflect merge of #6664 [ci skip] 2018-01-05 09:27:09 -05:00
jekyllbot
c96289f4ca CI: Test against Ruby 2.5.0 (#6664)
Merge pull request 6664
2018-01-05 09:27:08 -05:00
Frank Taillandier
c00054a069 Merge pull request #6538 from jekyll/pull/imageOptim
Site: Lossless image optimization
2018-01-05 14:27:08 +01:00
Frank Taillandier
401f8fef5b Typo 2018-01-03 16:23:03 +01:00
Frank Taillandier
a3351cff4f Docs: LiveReload option 2018-01-02 22:22:05 +01:00
Frank Taillandier
c9da3c424a Fix link 2018-01-02 20:45:44 +01:00
olivia
32e9522ef1 fix post year 2018-01-02 20:34:59 +01:00
Frank Taillandier
5ba27d1edf Fix date 2018-01-02 20:27:47 +01:00
Frank Taillandier
4d6959ca4c Release 💎 3.7.0 2018-01-02 20:25:21 +01:00
Frank Taillandier
abacae55ec Release 💎 3.7.0 2018-01-02 20:24:20 +01:00
jekyllbot
3d624cd290 Update history to reflect merge of #6603 [ci skip] 2018-01-02 14:18:28 -05:00
ashmaroli
3c959af8d1 Do not coerce layout paths in theme-gem to the source directory (#6603)
Merge pull request 6603
2018-01-02 14:18:26 -05:00
jekyllbot
9b8db401e7 Update history to reflect merge of #6634 [ci skip] 2018-01-02 14:17:22 -05:00
jekyllbot
c3026bdf31 Post: Jekyll 3.7.0 released (#6634)
Merge pull request 6634
2018-01-02 14:17:20 -05:00
jekyllbot
c07985eca8 Update history to reflect merge of #6639 [ci skip] 2018-01-02 12:50:45 -05:00
ashmaroli
bf8837e495 fix permalink icon markup in news-item layout (#6639)
Merge pull request 6639
2018-01-02 12:50:43 -05:00
jekyllbot
34694ae6d1 Update history to reflect merge of #6652 [ci skip] 2018-01-02 12:37:00 -05:00
Jashank Jeremy
a9fe56830b Switch to an actively-maintained TOML parser. (#6652)
Merge pull request 6652
2018-01-02 12:36:58 -05:00
Frank Taillandier
f49431ab85 Merge pull request #6635 from ashmaroli/page-inspect-patch
Correct custom inspect string for Jekyll::Page
2018-01-02 11:23:49 +01:00
Frank Taillandier
9a812a931a Merge pull request #6595 from ashmaroli/shorter-log-key
Use a shorter topic label for readability
2018-01-02 11:21:35 +01:00
Frank Taillandier
4ce9f8920b Merge pull request #6657 from m1guelpf/patch-1
Update license year
2018-01-01 14:23:43 +01:00
Miguel Piedrafita
b3286e7468 Update license year 2018-01-01 00:59:11 +01:00
jekyllbot
53cfa642fb Update history to reflect merge of #6651 [ci skip] 2017-12-26 11:26:13 -05:00
Alex Ibrado
60f645eb76 Add Tweetsert, Stickyposts, Paginate::Content (#6651)
Merge pull request 6651
2017-12-26 11:26:12 -05:00
Frank Taillandier
96d3b5e986 Docs: Remove requirements for Jekyll 2.x 2017-12-21 16:44:29 +01:00
jekyllbot
47e9304342 Update history to reflect merge of #6645 [ci skip] 2017-12-21 10:35:49 -05:00
Christian Oliff
14ab1bc9b2 Correct WordPress capitalization (#6645)
Merge pull request 6645
2017-12-21 10:35:47 -05:00
jekyllbot
aef0e1c252 Update history to reflect merge of #6641 [ci skip] 2017-12-21 10:33:45 -05:00
ashmaroli
d615257815 Improve docs styling for code to be run in shell (#6641)
Merge pull request 6641
2017-12-21 10:33:43 -05:00
jekyllbot
76a0fc3888 Update history to reflect merge of #6638 [ci skip] 2017-12-17 07:56:56 -05:00
Andreas Möller
16b9ce908e Fix: Update link to i18n_filter plugin (#6638)
Merge pull request 6638
2017-12-17 07:56:55 -05:00
Ashwin Maroli
94f74ff4ec correct custom inspect string for Jekyll::Page 2017-12-16 07:33:20 +05:30
jekyllbot
999151dcaa Update history to reflect merge of #6631 [ci skip] 2017-12-15 15:55:55 -05:00
jekyllbot
ffe8b28c68 update classifier-reborn to 2.2.0 (#6631)
Merge pull request 6631
2017-12-15 15:55:53 -05:00
jekyllbot
ff2795f98b Update history to reflect merge of #6609 [ci skip] 2017-12-15 08:35:55 -05:00
ashmaroli
1971ddd7a3 use require_relative to load Jekyll classes (#6609)
Merge pull request 6609
2017-12-15 08:35:53 -05:00
jekyllbot
72ccd29edc Update history to reflect merge of #6632 [ci skip] 2017-12-15 05:33:55 -05:00
Dr. Wolfram Schroers
d854b22656 Add jekyll-category-pages plugin (#6632)
Merge pull request 6632
2017-12-15 05:33:54 -05:00
jekyllbot
d1440b9738 Update history to reflect merge of #6602 [ci skip] 2017-12-15 03:11:40 -05:00
ashmaroli
e149803e99 memoize path to metadata file (#6602)
Merge pull request 6602
2017-12-15 03:11:39 -05:00
jekyllbot
c471f94347 Update history to reflect merge of #6605 [ci skip] 2017-12-15 03:10:23 -05:00
ashmaroli
1082a39417 Register reload hooks in Server#process (#6605)
Merge pull request 6605
2017-12-15 03:10:22 -05:00
jekyllbot
3b9ed96c30 Update history to reflect merge of #6607 [ci skip] 2017-12-14 15:43:20 -05:00
ashmaroli
acb82c92a8 Cleanup LiveReloadReactor (#6607)
Merge pull request 6607
2017-12-14 15:43:18 -05:00
jekyllbot
71e3bce63d Update history to reflect merge of #6623 [ci skip] 2017-12-12 06:28:07 -05:00
Junko Suzuki
bc8fee97c5 Update "Requirements" for Ruby version (#6623)
Merge pull request 6623
2017-12-12 06:28:05 -05:00
jekyllbot
977837fa3a Update history to reflect merge of #6618 [ci skip] 2017-12-10 18:28:54 -05:00
Kacper Duras
36d70ecb8e Add disqus-for-jekyll to plugins. (#6618)
Merge pull request 6618
2017-12-10 18:28:52 -05:00
jekyllbot
0801caae8e Update history to reflect merge of #6617 [ci skip] 2017-12-10 13:38:28 -05:00
Yashu Mittal
f9044ac5c6 Default time zone depends upon server (#6617)
Merge pull request 6617
2017-12-10 13:38:27 -05:00
jekyllbot
fc783cd13c Update history to reflect merge of #6606 [ci skip] 2017-12-10 08:35:14 -05:00
jekyllbot
ba75c87f63 Remove paginate check (#6606)
Merge pull request 6606
2017-12-10 08:35:12 -05:00
jekyllbot
1691685c77 Update history to reflect merge of #6613 [ci skip] 2017-12-08 09:43:38 -05:00
János Rusiczki
713467817a Remove link to severly outdated asset plugin (#6613)
Merge pull request 6613
2017-12-08 09:43:37 -05:00
Frank Taillandier
64ef79291f Update History.markdown 2017-12-08 10:50:49 +01:00
Frank Taillandier
23c3484660 Merge branch 'ashmaroli-kramdown-warning-config' 2017-12-07 19:56:01 +01:00
jekyllbot
28e20b9334 Update history to reflect merge of #5142 [ci skip] 2017-12-07 19:55:26 +01:00
Alex Wood
50ff219ba2 Add LiveReload functionality to Jekyll. (#5142)
Merge pull request 5142
2017-12-07 19:55:25 +01:00
Frank Taillandier
e3142e4c5a Docs: Add title and anchor 2017-12-07 19:55:25 +01:00
Frank Taillandier
e8c8eacf7b Dev: Run preview in incremental mode 2017-12-07 19:55:24 +01:00
Frank Taillandier
75ba9366df Docs: Build for production 2017-12-07 19:55:23 +01:00
Frank Taillandier
cdb031084c Docs: Avoid Kramdown warnings 2017-12-07 19:55:23 +01:00
jekyllbot
760d586de2 Update history to reflect merge of #6589 [ci skip] 2017-12-07 19:55:22 +01:00
Frank Taillandier
2fe54170b4 Dependency: Bump jekyll-watch to 2.0 (#6589)
Merge pull request 6589
2017-12-07 19:55:22 +01:00
Parker Moore
0f04f446a7 Merge pull request #6552 from ashmaroli/version-patch
Update Jekyll::VERSION to the latest released version
2017-12-07 19:55:21 +01:00
jekyllbot
0c4b12e6aa Update history to reflect merge of #6556 [ci skip] 2017-12-07 19:55:20 +01:00
Ashwin Maroli
7826bfe552 last released version is at 3.6.2 2017-12-07 19:55:20 +01:00
ashmaroli
65f7deca98 Add PageWithoutAFile class from jekyll plugins (#6556)
Merge pull request 6556
2017-12-07 19:55:19 +01:00
jekyllbot
e3b8ba33da Update history to reflect merge of #6584 [ci skip] 2017-12-07 19:55:18 +01:00
ashmaroli
61e53b6b61 cleanup test_redcarpet.rb (#6584)
Merge pull request 6584
2017-12-07 19:55:18 +01:00
jekyllbot
664b20d375 Update history to reflect merge of #6582 [ci skip] 2017-12-07 19:55:17 +01:00
jekyllbot
79bf9f2865 Bump yajl-ruby (#6582)
Merge pull request 6582
2017-12-07 19:55:17 +01:00
jekyllbot
ff4718d824 Update history to reflect merge of #5937 [ci skip] 2017-12-07 19:55:16 +01:00
Parker Moore
bd1d44493f Upgrade pygments to v1.x (#5937)
Merge pull request 5937
2017-12-07 19:55:16 +01:00
jekyllbot
05bca8128c Update history to reflect merge of #6577 [ci skip] 2017-12-07 19:55:15 +01:00
ashmaroli
e063ac530c drop forwarding to private methods (#6577)
Merge pull request 6577
2017-12-07 19:55:14 +01:00
jekyllbot
8060934f96 Update history to reflect merge of #6575 [ci skip] 2017-12-07 19:55:14 +01:00
ashmaroli
abeee6fdf6 use version-badge on an existing feature intro (#6575)
Merge pull request 6575
2017-12-07 19:55:13 +01:00
jekyllbot
65fd990459 Update history to reflect merge of #6569 [ci skip] 2017-12-07 19:55:13 +01:00
Florian Thomas
7ef3260327 return correct file in dir if dir has same name as file (#6569)
Merge pull request 6569
2017-12-07 19:55:12 +01:00
jekyllbot
f58d5988fa Update history to reflect merge of #6574 [ci skip] 2017-12-07 19:55:11 +01:00
jekyllbot
ed03ca5c16 Docs: Include version badge for latest features (#6574)
Merge pull request 6574
2017-12-07 19:55:11 +01:00
jekyllbot
a25fd72334 Update history to reflect merge of #5828 [ci skip] 2017-12-07 19:55:10 +01:00
Jonathan Hooper
f906a3cb59 Rescue from Psych::SyntaxError instead of SyntaxError after parsing YAML (#5828)
Merge pull request 5828
2017-12-07 19:55:10 +01:00
jekyllbot
398e7d5089 Update history to reflect merge of #6573 [ci skip] 2017-12-07 19:55:09 +01:00
ashmaroli
6b003a4438 fail gracefully if "sass" gem cannot be loaded (#6573)
Merge pull request 6573
2017-12-07 19:55:09 +01:00
jekyllbot
c2195b0118 Update history to reflect merge of #6570 [ci skip] 2017-12-07 19:55:08 +01:00
ashmaroli
0f249eec9f move logo above navigation on small screens (#6570)
Merge pull request 6570
2017-12-07 19:55:08 +01:00
jekyllbot
f85a039633 Update history to reflect merge of #6567 [ci skip] 2017-12-07 19:55:07 +01:00
ashmaroli
0f35470480 Site header redesign (#6567)
Merge pull request 6567
2017-12-07 19:55:06 +01:00
jekyllbot
13911961b9 Update history to reflect merge of #6565 [ci skip] 2017-12-07 19:55:05 +01:00
jekyllbot
0fdb39bbd6 Avoid block parser warning in SmartyPants (#6565)
Merge pull request 6565
2017-12-07 19:55:05 +01:00
Frank Taillandier
68935f1bda Reformat 2017-12-07 19:55:04 +01:00
Frank Taillandier
3f8cd30d4d Site: Display search only on large resolutions 2017-12-07 19:55:03 +01:00
jekyllbot
e4888f2e52 Update history to reflect merge of #6561 [ci skip] 2017-12-07 19:55:03 +01:00
ashmaroli
22cba713dc Bump JRuby version in Travis config (#6561)
Merge pull request 6561
2017-12-07 19:55:02 +01:00
jekyllbot
977cfb0ac0 Update history to reflect merge of #6557 [ci skip] 2017-12-07 19:55:02 +01:00
jekyllbot
7c72e62552 Site: Search with @Algolia DocSearch (#6557)
Merge pull request 6557
2017-12-07 19:55:01 +01:00
jekyllbot
c2ee73ef8d Update history to reflect merge of #6550 [ci skip] 2017-12-07 19:55:01 +01:00
Aaron D Borden
32d1b43fc0 Add json extension to list of directory indices (#6550)
Merge pull request 6550
2017-12-07 19:55:00 +01:00
jekyllbot
d8d6360107 Update history to reflect merge of #6555 [ci skip] 2017-12-07 19:54:59 +01:00
Doug Beney
a74853501a Update plugins.md (#6555)
Merge pull request 6555
2017-12-07 19:54:59 +01:00
Frank Taillandier
57ec30d6ef Site: Kramdown and Rouge are set by default 2017-12-07 19:54:58 +01:00
Frank Taillandier
2774a1aeb6 Fix Kramdown warnings 2017-12-07 19:54:57 +01:00
Ashwin Maroli
fcb1b410e3 rename log_warnings to show_warnings 2017-12-07 23:44:15 +05:30
jekyllbot
3efb1ad857 Update history to reflect merge of #5142 [ci skip] 2017-12-06 16:33:53 -05:00
Alex Wood
9d68b1b134 Add LiveReload functionality to Jekyll. (#5142)
Merge pull request 5142
2017-12-06 16:33:51 -05:00
Ashwin Maroli
8e2c240fa6 use a shorter topic label for readability
Jekyll's logger like the first parameter to be of 20 chars or lesser
2017-12-04 13:03:39 +05:30
Frank Taillandier
9ec9273ed9 Docs: Add title and anchor 2017-12-03 19:52:37 +01:00
Frank Taillandier
a58629f97d Dev: Run preview in incremental mode 2017-12-03 19:40:10 +01:00
Frank Taillandier
0186bdb384 Docs: Build for production 2017-12-03 19:39:02 +01:00
Frank Taillandier
2ea970d2b5 Docs: Avoid Kramdown warnings 2017-12-03 19:38:34 +01:00
jekyllbot
4c97f5ef22 Update history to reflect merge of #6589 [ci skip] 2017-12-02 18:51:09 -06:00
Frank Taillandier
a37bde52b3 Dependency: Bump jekyll-watch to 2.0 (#6589)
Merge pull request 6589
2017-12-02 18:51:07 -06:00
Parker Moore
80f6d7b3fa Merge pull request #6552 from ashmaroli/version-patch
Update Jekyll::VERSION to the latest released version
2017-12-02 14:55:27 -05:00
jekyllbot
5a10887f86 Update history to reflect merge of #6556 [ci skip] 2017-11-30 12:16:37 -06:00
ashmaroli
38342006a3 Add PageWithoutAFile class from jekyll plugins (#6556)
Merge pull request 6556
2017-11-30 12:16:35 -06:00
jekyllbot
f7b45c4440 Update history to reflect merge of #6584 [ci skip] 2017-11-29 08:56:47 -05:00
ashmaroli
da0df228cd cleanup test_redcarpet.rb (#6584)
Merge pull request 6584
2017-11-29 08:56:46 -05:00
jekyllbot
64c87c9253 Update history to reflect merge of #6582 [ci skip] 2017-11-29 03:37:08 -05:00
jekyllbot
a13740839a Bump yajl-ruby (#6582)
Merge pull request 6582
2017-11-29 03:37:07 -05:00
jekyllbot
b77593ce74 Update history to reflect merge of #5937 [ci skip] 2017-11-29 03:17:09 -05:00
Parker Moore
c14b8b5864 Upgrade pygments to v1.x (#5937)
Merge pull request 5937
2017-11-29 03:17:08 -05:00
jekyllbot
fce3cbfd81 Update history to reflect merge of #6577 [ci skip] 2017-11-26 14:36:43 -05:00
ashmaroli
0b4f657039 drop forwarding to private methods (#6577)
Merge pull request 6577
2017-11-26 14:36:41 -05:00
jekyllbot
110b473487 Update history to reflect merge of #6575 [ci skip] 2017-11-24 07:19:10 -05:00
ashmaroli
01806bcec4 use version-badge on an existing feature intro (#6575)
Merge pull request 6575
2017-11-24 07:19:08 -05:00
jekyllbot
bd3c395cfc Update history to reflect merge of #6569 [ci skip] 2017-11-24 03:49:15 -05:00
Florian Thomas
368fa1f723 return correct file in dir if dir has same name as file (#6569)
Merge pull request 6569
2017-11-24 03:49:13 -05:00
jekyllbot
c7c31e014c Update history to reflect merge of #6574 [ci skip] 2017-11-24 03:43:39 -05:00
jekyllbot
46b2501df6 Docs: Include version badge for latest features (#6574)
Merge pull request 6574
2017-11-24 03:43:37 -05:00
jekyllbot
cebcff1412 Update history to reflect merge of #5828 [ci skip] 2017-11-22 09:37:20 -05:00
Jonathan Hooper
1c469eb53a Rescue from Psych::SyntaxError instead of SyntaxError after parsing YAML (#5828)
Merge pull request 5828
2017-11-22 09:37:18 -05:00
jekyllbot
f6cf8b934a Update history to reflect merge of #6573 [ci skip] 2017-11-21 14:28:10 -05:00
ashmaroli
c2586bbae7 fail gracefully if "sass" gem cannot be loaded (#6573)
Merge pull request 6573
2017-11-21 14:28:08 -05:00
jekyllbot
28f64fb2b3 Update history to reflect merge of #6570 [ci skip] 2017-11-20 08:06:48 -05:00
ashmaroli
e88b81318c move logo above navigation on small screens (#6570)
Merge pull request 6570
2017-11-20 08:06:47 -05:00
jekyllbot
5d71314e16 Update history to reflect merge of #6567 [ci skip] 2017-11-19 14:00:39 -05:00
ashmaroli
b59078ed26 Site header redesign (#6567)
Merge pull request 6567
2017-11-19 14:00:38 -05:00
jekyllbot
73675070f5 Update history to reflect merge of #6565 [ci skip] 2017-11-17 16:36:12 -05:00
jekyllbot
2c646a304c Avoid block parser warning in SmartyPants (#6565)
Merge pull request 6565
2017-11-17 16:36:11 -05:00
Frank Taillandier
04f4e891f0 Reformat 2017-11-16 22:20:38 +01:00
Frank Taillandier
d63792b4e7 Site: Display search only on large resolutions 2017-11-15 21:28:25 +01:00
jekyllbot
f421aa4070 Update history to reflect merge of #6561 [ci skip] 2017-11-15 14:25:18 -05:00
ashmaroli
dd5685bb78 Bump JRuby version in Travis config (#6561)
Merge pull request 6561
2017-11-15 14:25:16 -05:00
jekyllbot
1a398c48b8 Update history to reflect merge of #6557 [ci skip] 2017-11-15 10:19:40 -05:00
jekyllbot
9431fdb9cd Site: Search with @Algolia DocSearch (#6557)
Merge pull request 6557
2017-11-15 10:19:37 -05:00
jekyllbot
621df9db8e Update history to reflect merge of #6550 [ci skip] 2017-11-13 16:30:25 -05:00
Aaron D Borden
707a8c7a0e Add json extension to list of directory indices (#6550)
Merge pull request 6550
2017-11-13 16:30:23 -05:00
jekyllbot
5cb8a0e847 Update history to reflect merge of #6555 [ci skip] 2017-11-13 14:49:41 -05:00
Doug Beney
e86ec7450e Update plugins.md (#6555)
Merge pull request 6555
2017-11-13 14:49:39 -05:00
Frank Taillandier
cb9f227378 Site: Kramdown and Rouge are set by default 2017-11-13 18:21:04 +01:00
Frank Taillandier
169ecf91c9 Fix Kramdown warnings 2017-11-13 17:41:15 +01:00
Ashwin Maroli
77852b8838 add option to configure kramdown warning output 2017-11-13 22:02:58 +05:30
Ashwin Maroli
c812d35249 last released version is at 3.6.2 2017-11-13 16:43:27 +05:30
jekyllbot
525efbc2f8 Update history to reflect merge of #6545 [ci skip] 2017-11-12 16:35:34 -05:00
ashmaroli
77dd16a472 style mobile-docs select element (#6545)
Merge pull request 6545
2017-11-12 16:35:33 -05:00
jekyllbot
f07c9daf3a Update history to reflect merge of #6546 [ci skip] 2017-11-12 13:50:50 -05:00
ashmaroli
9b044b9dfb Lock to cucumber 3.0.1 on Ruby 2.1 (#6546)
Merge pull request 6546
2017-11-12 13:50:49 -05:00
jekyllbot
174eb585a0 Update history to reflect merge of #6548 [ci skip] 2017-11-12 13:08:44 -05:00
jekyllbot
c80e2709d9 This plugin has been integrated into Jekyll Core (#6548)
Merge pull request 6548
2017-11-12 13:08:43 -05:00
Pat Hawks
41312370a3 Add extra smartify test 2017-11-12 11:52:18 -06:00
jekyllbot
9c7ef8f14e Update history to reflect merge of #6544 [ci skip] 2017-11-12 11:19:29 -05:00
jekyllbot
5e7152546e Site: Back to original main navigation (#6544)
Merge pull request 6544
2017-11-12 11:19:27 -05:00
jekyllbot
8dcff01ad7 Update history to reflect merge of #6541 [ci skip] 2017-11-11 17:35:49 -05:00
jekyllbot
8605f11f86 Dependencies: upgrade to toml 0.2.0 (#6541)
Merge pull request 6541
2017-11-11 17:35:47 -05:00
Frank Taillandier
4bfdd28790 Site: Lossless image optimization
Ran ImageOptim
2017-11-10 22:12:07 +01:00
jekyllbot
d104cf02ef Update history to reflect merge of #6519 [ci skip] 2017-11-10 11:54:59 -05:00
ImgBot
fd271f5bb2 [ImgBot] optimizes images (#6519)
Merge pull request 6519
2017-11-10 11:54:58 -05:00
jekyllbot
9f2e57a99a Update history to reflect merge of #6478 [ci skip] 2017-11-10 11:35:46 -05:00
Pat Hawks
582165897d Allow URL filters to work directly with documents (#6478)
Merge pull request 6478
2017-11-10 11:35:44 -05:00
jekyllbot
b26dbaddd2 Update history to reflect merge of #6535 [ci skip] 2017-11-10 08:25:03 -05:00
ashmaroli
8081f54936 use double-quotes around gem name (#6535)
Merge pull request 6535
2017-11-10 08:25:01 -05:00
jekyllbot
b05bb59a4e Update history to reflect merge of #6522 [ci skip] 2017-11-09 09:11:07 -05:00
Florian Thomas
fa22ebf056 Log kramdown warnings if log level is WARN (#6522)
Merge pull request 6522
2017-11-09 09:11:05 -05:00
jekyllbot
1f3ce72f6b Update history to reflect merge of #6533 [ci skip] 2017-11-09 02:20:28 -05:00
xiaoiver
0c2541139b add jekyll-pwa-plugin (#6533)
Merge pull request 6533
2017-11-09 02:20:26 -05:00
jekyllbot
47bdfc72ff Update history to reflect merge of #6532 [ci skip] 2017-11-08 11:47:16 -05:00
ashmaroli
a2e48ebba3 remove parentheses around arguments to raise (#6532)
Merge pull request 6532
2017-11-08 11:47:14 -05:00
jekyllbot
4b675aa1ea Update history to reflect merge of #6529 [ci skip] 2017-11-07 15:39:59 -05:00
ashmaroli
758ee7ed87 Refactor method to reduce ABC Metric size (#6529)
Merge pull request 6529
2017-11-07 15:39:58 -05:00
jekyllbot
efd9864df6 Update history to reflect merge of #6525 [ci skip] 2017-11-06 09:36:21 -05:00
ashmaroli
7690fcb02b use Kernel#Array instead of explicit Array check (#6525)
Merge pull request 6525
2017-11-06 09:36:19 -05:00
jekyllbot
52482ce88a Update history to reflect merge of #6526 [ci skip] 2017-11-06 07:35:45 -05:00
ashmaroli
bb42e6251e enable Style/UnneededCapitalW cop (#6526)
Merge pull request 6526
2017-11-06 07:35:43 -05:00
jekyllbot
17bd584319 Update history to reflect merge of #6520 [ci skip] 2017-11-05 22:50:47 -05:00
ashmaroli
0205fb9e79 Assert raising Psych::SyntaxError when "strict_front_matter"=>true (#6520)
Merge pull request 6520
2017-11-05 22:50:46 -05:00
jekyllbot
db2fc380a0 Update history to reflect merge of #6490 [ci skip] 2017-11-05 10:17:53 -05:00
Johannes Müller
a66c4780cc filter relative_url should keep absolute urls with scheme/authority (#6490)
Merge pull request 6490
2017-11-05 10:17:51 -05:00
jekyllbot
beed5513e4 Update history to reflect merge of #6514 [ci skip] 2017-11-04 10:50:31 -04:00
mrHoliday
a559dfaa6e Update fmt (#6514)
Merge pull request 6514
2017-11-04 10:50:30 -04:00
Frank Taillandier
94dc9265cb Style: Remove line after magic comment 2017-11-03 09:13:09 +01:00
jekyllbot
42c21aba86 Update history to reflect merge of #6513 [ci skip] 2017-11-03 04:10:08 -04:00
ashmaroli
3838564d21 Remove unnecessary encoding comment (#6513)
Merge pull request 6513
2017-11-03 04:10:07 -04:00
jekyllbot
fc272d4dfb Update history to reflect merge of #6509 [ci skip] 2017-11-02 23:07:27 -04:00
Alex Tsui
93e3eb06d2 Add latin mode to slugify (#6509)
Merge pull request 6509
2017-11-02 23:07:25 -04:00
jekyllbot
53d48d52e7 Update history to reflect merge of #5870 [ci skip] 2017-11-02 16:54:43 -04:00
Parker Moore
8fc463bdce Add Utils::Internet.connected? to determine whether host machine has internet connection. (#5870)
Merge pull request 5870
2017-11-02 16:54:42 -04:00
jekyllbot
7e31e274fb Update history to reflect merge of #6500 [ci skip] 2017-11-01 04:56:33 -04:00
Jordon Bedwell
f72e2ccaa6 .sass-cache doesn't *always* land in options['source'] (#6500)
Merge pull request 6500
2017-11-01 04:56:32 -04:00
jekyllbot
2023b44f2e Update history to reflect merge of #6502 [ci skip] 2017-10-30 14:54:08 -04:00
Jordon Bedwell
aa959cef8a Allow plugins to modify the obsolete files. (#6502)
Merge pull request 6502
2017-10-30 14:54:06 -04:00
jekyllbot
cc89a838f5 Update history to reflect merge of #6499 [ci skip] 2017-10-29 16:31:42 -04:00
Jordon Bedwell
2ecf50f18f Fix #6498: Use Gem to discover the location of bundler. (#6499)
Merge pull request 6499
2017-10-29 16:31:40 -04:00
jekyllbot
c52707bc66 Update history to reflect merge of #6495 [ci skip] 2017-10-29 11:02:47 -04:00
ashmaroli
0feccde80a clean up Rubocop config (#6495)
Merge pull request 6495
2017-10-29 11:02:45 -04:00
Matt Rogers
0baf586723 Merge pull request #6496 from jekyll/revert-6151-future-collection-liquid-test
Revert "Added direct collection access to future collection item feature test"
2017-10-29 09:50:25 -05:00
Matt Rogers
e39f9db593 Revert "Added direct collection access to future collection item feature test (#6151)"
This reverts commit 49fa2dee0e.
2017-10-28 23:33:27 -05:00
Matt Rogers
c122a3bda4 Revert "Update history to reflect merge of #6151 [ci skip]"
This reverts commit f535218a05.
2017-10-28 23:33:27 -05:00
jekyllbot
f535218a05 Update history to reflect merge of #6151 [ci skip] 2017-10-28 11:48:33 -04:00
Brandon Dusseau
49fa2dee0e Added direct collection access to future collection item feature test (#6151)
Merge pull request 6151
2017-10-28 11:48:31 -04:00
jekyllbot
5f37f75d9e Update history to reflect merge of #6494 [ci skip] 2017-10-28 11:46:03 -04:00
Jed Fox
7de55c6089 Fix a few minor issues in the docs (#6494)
Merge pull request 6494
2017-10-28 11:46:02 -04:00
jekyllbot
afcffc7831 Update history to reflect merge of #6059 [ci skip] 2017-10-28 11:43:33 -04:00
Ankit Singhaniya
310bbbe529 add formester to the list of saas form backend (#6059)
Merge pull request 6059
2017-10-28 11:43:32 -04:00
jekyllbot
b71d9b36b6 Update history to reflect merge of #6455 [ci skip] 2017-10-28 11:34:40 -04:00
Angelika Tyborska
8dbe5de66b Raise when theme root directory is not available (#6455)
Merge pull request 6455
2017-10-28 11:34:38 -04:00
jekyllbot
df6608e11d Update history to reflect merge of #6482 [ci skip] 2017-10-28 11:24:42 -04:00
ashmaroli
9632733efa enable 'Lint/RescueWithoutErrorClass' Cop (#6482)
Merge pull request 6482
2017-10-28 11:24:41 -04:00
jekyllbot
63255ae2c1 Update history to reflect merge of #6486 [ci skip] 2017-10-28 10:52:03 -04:00
Andrew Dassonville
1f8704f876 Remove sudo from macOS troubleshooting instructions (#6486)
Merge pull request 6486
2017-10-28 10:52:02 -04:00
jekyllbot
d628d438a8 Update history to reflect merge of #6491 [ci skip] 2017-10-27 12:25:37 -04:00
Chris Finazzo
39210d00e9 Update normalize.css to v7.0.0 (#6491)
Merge pull request 6491
2017-10-27 12:25:36 -04:00
jekyllbot
e635489c66 Update history to reflect merge of #6489 [ci skip] 2017-10-27 12:02:01 -04:00
Gert-jan Theunissen
a4315fac3b Updated custom-404-page.md (#6489)
Merge pull request 6489
2017-10-27 12:01:59 -04:00
Frank Taillandier
52c34060e3 Docs: Avoid FUD (props @Parkr) 2017-10-27 17:59:00 +02:00
jekyllbot
248bd59f5a Update history to reflect merge of #6488 [ci skip] 2017-10-27 11:55:08 -04:00
ashmaroli
a1d45f9717 Add a note on :jekyll_plugins group in the docs (#6488)
Merge pull request 6488
2017-10-27 11:55:07 -04:00
jekyllbot
08644f1e82 Update history to reflect merge of #6469 [ci skip] 2017-10-26 14:21:21 -04:00
jekyllbot
e0eff967f3 Rely on jekyll-mentions for linking usernames (#6469)
Merge pull request 6469
2017-10-26 14:21:20 -04:00
jekyllbot
4865b902c1 Update history to reflect merge of #6476 [ci skip] 2017-10-23 15:20:57 -04:00
jekyllbot
8d88ee997c Site: Add default twitter card image (#6476)
Merge pull request 6476
2017-10-23 15:20:55 -04:00
jekyllbot
57ab42a8d0 Update history to reflect merge of #6468 [ci skip] 2017-10-23 11:59:55 -04:00
jekyllbot
3bd808c8b0 Do not linkify escaped characters as PRs in History (#6468)
Merge pull request 6468
2017-10-23 11:59:53 -04:00
jekyllbot
1c64f65f25 Update history to reflect merge of #6474 [ci skip] 2017-10-23 09:12:11 -04:00
jekyllbot
e9654c3fea Site: Rename method (#6474)
Merge pull request 6474
2017-10-23 09:12:09 -04:00
jekyllbot
c933ec5a57 Update history to reflect merge of #6472 [ci skip] 2017-10-23 04:27:38 -04:00
Jon Anning
0d8c704921 Update first-timers-issue-template.md (#6472)
Merge pull request 6472
2017-10-23 04:27:36 -04:00
Frank Taillandier
c0e4ce13b5 Merge pull request #6462 from jekyll/pull/post-3.6.2-released
Add Jekyll 3.6.2 release post
2017-10-22 21:44:39 +02:00
Frank Taillandier
2993f9bc99 Typo 2017-10-22 20:27:07 +02:00
jekyllbot
bfdbcc3984 Update history to reflect merge of #6466 [ci skip] 2017-10-22 11:39:09 -04:00
Vishesh Ruparelia
945a24e568 Update templates.md (#6466)
Merge pull request 6466
2017-10-22 11:39:08 -04:00
Frank Taillandier
280cf98030 Typos 2017-10-21 23:59:49 +02:00
Frank Taillandier
1790385c31 Add Jekyll 3.6.2 release post 2017-10-21 23:45:30 +02:00
jekyllbot
bdef182000 Update history to reflect merge of #6460 [ci skip] 2017-10-21 16:15:25 -04:00
jekyllbot
48d7dd4305 Update site History (#6460)
Merge pull request 6460
2017-10-21 16:15:24 -04:00
Pat Hawks
bb9b634a0c Update release notes for v3.6.2 2017-10-21 14:28:32 -05:00
jekyllbot
a674620de6 Update history to reflect merge of #6457 [ci skip] 2017-10-21 12:14:48 -04:00
Sebastian Kulig
d5c17b9db0 Update _config.yml (#6457)
Merge pull request 6457
2017-10-21 12:14:47 -04:00
jekyllbot
4e561a84e4 Update release notes for v3.6.1 (#6449) 2017-10-20 10:41:24 -05:00
jekyllbot
04e40d133f Update history to reflect merge of #6447 [ci skip] 2017-10-20 05:18:18 -04:00
olivia
32f8e53a93 add post about diversity (#6447)
Merge pull request 6447
2017-10-20 05:18:17 -04:00
jekyllbot
28af8bd85f Update history to reflect merge of #6444 [ci skip] 2017-10-19 14:22:37 -04:00
jekyllbot
e7f1ce2e2b Update Rubocop to 0.51.0 (#6444)
Merge pull request 6444
2017-10-19 14:22:36 -04:00
jekyllbot
32d38e68ef Update history to reflect merge of #6445 [ci skip] 2017-10-19 14:18:32 -04:00
Maximiliano Kotvinsky
ae326148cc Add test for layout as string (#6445)
Merge pull request 6445
2017-10-19 14:18:30 -04:00
jekyllbot
c0478e290b Update history to reflect merge of #6442 [ci skip] 2017-10-18 22:55:46 -04:00
bellvat
84c250394e Update 'data.layout' as a string. (#6442)
Merge pull request 6442
2017-10-18 22:55:45 -04:00
jekyllbot
3715633aae Update history to reflect merge of #6322 [ci skip] 2017-10-17 23:15:28 -04:00
Frank Taillandier
363bd6c7eb Problematic UTF+bom files (#6322)
Merge pull request 6322
2017-10-17 23:15:26 -04:00
jekyllbot
e0a97b5f12 Update history to reflect merge of #6431 [ci skip] 2017-10-17 20:36:18 -04:00
Pat Hawks
c6b890698c Add configuration for first-timers bot (#6431)
Merge pull request 6431
2017-10-17 20:36:16 -04:00
jekyllbot
640c5137c2 Update history to reflect merge of #6339 [ci skip] 2017-10-17 17:14:05 -04:00
jekyllbot
5ebfbe042d Update history to reflect merge of #6429 [ci skip] 2017-10-15 20:51:07 -04:00
Frank Taillandier
a5f8cb74dc Docs: Contacts for CoC violation (#6429)
Merge pull request 6429
2017-10-15 20:51:05 -04:00
jekyllbot
72debf854b Update history to reflect merge of #6425 [ci skip] 2017-10-12 03:51:53 -04:00
Edward Shen
5f1b881c91 Added github-cards to the list of plugins (#6425)
Merge pull request 6425
2017-10-12 03:51:52 -04:00
jekyllbot
3f694695e1 Update history to reflect merge of #6424 [ci skip] 2017-10-11 16:27:01 -04:00
Goulven Champenois
b3d607f264 Explain how to override output collection index page (#6424)
Merge pull request 6424
2017-10-11 16:26:59 -04:00
jekyllbot
1bb36ebc9e Update history to reflect merge of #6421 [ci skip] 2017-10-09 09:15:56 -04:00
Goulven Champenois
2b9bb2306a Fix list appearance by adding missing ol tag (#6421)
Merge pull request 6421
2017-10-09 09:15:55 -04:00
jekyllbot
b13a6161ed Update history to reflect merge of #6268 [ci skip] 2017-10-09 06:52:20 -04:00
Alexey Pelykh
a78b518f83 Scope path glob (#6268)
Merge pull request 6268
2017-10-09 06:52:19 -04:00
jekyllbot
2606e01d5b Update history to reflect merge of #6406 [ci skip] 2017-10-08 10:41:12 -04:00
Giraffe Academy
1a2625443d docs: Added new tutorial to tutorials section on docs (#6406)
Merge pull request 6406
2017-10-08 10:41:10 -04:00
jekyllbot
79194b5ad0 Update history to reflect merge of #6415 [ci skip] 2017-10-08 09:50:10 -04:00
Frank Taillandier
ffc29618a1 Link to Support (#6415)
Merge pull request 6415
2017-10-08 09:50:09 -04:00
jekyllbot
a7a7373281 Update history to reflect merge of #6417 [ci skip] 2017-10-07 19:54:34 -04:00
Matt Rogers
d48412401a Provide a better default hash for tracking liquid stats (#6417)
Merge pull request 6417
2017-10-07 19:54:32 -04:00
jekyllbot
4a2ab9247c Update history to reflect merge of #6412 [ci skip] 2017-10-04 11:36:38 -04:00
Frank Taillandier
1d29f505c0 Mark collection_dir as unreleased (#6412)
Merge pull request 6412
2017-10-04 11:36:37 -04:00
jekyllbot
7fb10e12bf Update history to reflect merge of #6411 [ci skip] 2017-10-04 07:18:52 -04:00
Kewin Dousse
f38cf2efdb Renaming duplicate of "Scenario 6" to "Scenario 7" (#6411)
Merge pull request 6411
2017-10-04 07:18:50 -04:00
jekyllbot
50de153c69 Update history to reflect merge of #6408 [ci skip] 2017-10-03 03:56:43 -04:00
ashmaroli
6c6c8b071c Fix docs for the new collections_dir feature (#6408)
Merge pull request 6408
2017-10-03 03:56:42 -04:00
jekyllbot
a20d13d6b5 Update history to reflect merge of #6407 [ci skip] 2017-10-03 03:52:14 -04:00
Frank Taillandier
85aebe9b90 Docs: updates (#6407)
Merge pull request 6407
2017-10-03 03:52:13 -04:00
jekyllbot
ac3e6b384f Update history to reflect merge of #6405 [ci skip] 2017-10-02 10:32:48 -04:00
Kenton Hansen
fe5fb5beb7 Fixes formatting on pre-formatted text. (#6405)
Merge pull request 6405
2017-10-02 10:32:47 -04:00
jekyllbot
ac575a0c50 Update history to reflect merge of #6399 [ci skip] 2017-10-02 09:47:07 -04:00
Kenton Hansen
77bb9267ac Docs: Filtering Posts with categories, tags, or other variables (#6399)
Merge pull request 6399
2017-10-02 09:47:05 -04:00
jekyllbot
b11ad8ea77 Update history to reflect merge of #6398 [ci skip] 2017-10-02 02:57:56 -04:00
ashmaroli
b77cc3f070 fix code-block highlighting in docs (#6398)
Merge pull request 6398
2017-10-02 02:57:54 -04:00
jekyllbot
4c0f26c8a1 Update history to reflect merge of #6389 [ci skip] 2017-09-29 19:12:37 -04:00
ashmaroli
76c52f43f7 add special styling for code-blocks run in shell (#6389)
Merge pull request 6389
2017-09-29 19:12:36 -04:00
jekyllbot
f8762bd5d5 Update history to reflect merge of #6396 [ci skip] 2017-09-29 08:41:41 -04:00
Frank Taillandier
7b1c5dfcce Docs: Update instructions (#6396)
Merge pull request 6396
2017-09-29 08:41:39 -04:00
jekyllbot
816d59129d Update history to reflect merge of #6395 [ci skip] 2017-09-29 03:39:20 -04:00
Frank Taillandier
7333baf06d Upgrade to Cucumber 3.0 (#6395)
Merge pull request 6395
2017-09-29 03:39:19 -04:00
jekyllbot
5df6e3f865 Update history to reflect merge of #6388 [ci skip] 2017-09-27 05:19:54 -04:00
ashmaroli
7d36527dfc fix diff syntax-highlighting (#6388)
Merge pull request 6388
2017-09-27 05:19:52 -04:00
jekyllbot
528c03c22f Update history to reflect merge of #6387 [ci skip] 2017-09-27 05:18:14 -04:00
ashmaroli
eadad9eb7e improve documentation for theme-gem installation (#6387)
Merge pull request 6387
2017-09-27 05:18:13 -04:00
jekyllbot
cfec06cdba Update history to reflect merge of #6384 [ci skip] 2017-09-25 10:41:59 -04:00
Frank Taillandier
e4b456a2ee Docs: GitHub Pages instructions (#6384)
Merge pull request 6384
2017-09-25 10:41:58 -04:00
jekyllbot
a9b95e58c6 Update history to reflect merge of #6331 [ci skip] 2017-09-24 11:50:56 -04:00
Parker Moore
0331fb41ad Allow the user to set collections_dir to put all collections under one subdirectory (#6331)
Merge pull request 6331
2017-09-24 11:50:55 -04:00
jekyllbot
6f3d7a0034 Update history to reflect merge of #6381 [ci skip] 2017-09-23 16:11:19 -04:00
Frank Taillandier
5f8ba181f0 bump Rouge (#6381)
Merge pull request 6381
2017-09-23 16:11:17 -04:00
jekyllbot
9113e0aa05 Update history to reflect merge of #6182 [ci skip] 2017-09-23 16:03:42 -04:00
ashmaroli
e5403396b7 Disable default layouts for Pages with a layout: none declaration (#6182)
Merge pull request 6182
2017-09-23 16:03:40 -04:00
jekyllbot
023775e4eb Update history to reflect merge of #6380 [ci skip] 2017-09-22 09:51:59 -04:00
Jan Piotrowski
76014aee2a Docs: remove duplicate "available" (#6380)
Merge pull request 6380
2017-09-22 09:51:58 -04:00
jekyllbot
d9770bb283 Update history to reflect merge of #6379 [ci skip] 2017-09-22 09:11:25 -04:00
Frank Taillandier
4359df8e65 Docs: Style lists in tables (#6379)
Merge pull request 6379
2017-09-22 09:11:23 -04:00
jekyllbot
c84aef0619 Update history to reflect merge of #6368 [ci skip] 2017-09-22 09:06:34 -04:00
ashmaroli
00bad8bfe5 Bump rubocop to use v0.50.x (#6368)
Merge pull request 6368
2017-09-22 09:06:32 -04:00
jekyllbot
e083f93ed8 Update history to reflect merge of #6136 [ci skip] 2017-09-22 03:38:07 -04:00
ashmaroli
9d7f0c1f85 elaborate on excluding items from processing (#6136)
Merge pull request 6136
2017-09-22 03:38:05 -04:00
jekyllbot
7dccfcf2b5 Update history to reflect merge of #6371 [ci skip] 2017-09-22 02:55:21 -04:00
i-give-up
ab31983122 Update frontmatter.md (#6371)
Merge pull request 6371
2017-09-22 02:55:19 -04:00
jekyllbot
dc4acbc66c Update history to reflect merge of #6244 [ci skip] 2017-09-22 02:54:39 -04:00
Oliver Steele
09b849938d Doc y_day in docs/permalinks (#6244)
Merge pull request 6244
2017-09-22 02:54:38 -04:00
Parker Moore
3feafed56c Release 💎 3.6.0 2017-09-21 17:30:21 -04:00
Parker Moore
fb9c3b738d Merge pull request #6378 from jekyll/release-3-6-0
Add Jekyll 3.6.0 release post
2017-09-21 17:27:19 -04:00
Parker Moore
ec3a7b9078 Add Jekyll 3.6.0 release post 2017-09-21 16:49:02 -04:00
jekyllbot
738fc55896 Update history to reflect merge of #6377 [ci skip] 2017-09-21 16:36:28 -04:00
ashmaroli
211a595329 Don't break if bundler is not installed (#6377)
Merge pull request 6377
2017-09-21 16:36:26 -04:00
Parker Moore
ca3a56b37c Fix typo in debug message. cc #6344 2017-09-21 16:31:37 -04:00
jekyllbot
c9ac5fee94 Update history to reflect merge of #6344 [ci skip] 2017-09-21 16:30:25 -04:00
Florian Thomas
47bcbfb654 skip adding binary files as posts (#6344)
Merge pull request 6344
2017-09-21 16:30:23 -04:00
jekyllbot
97d4437179 Update history to reflect merge of #6350 [ci skip] 2017-09-21 15:57:26 -04:00
Ben Balter
a5fd0c0b26 Mutable drops should fallback to their own methods when a mutation isn't present (#6350)
Merge pull request 6350
2017-09-21 15:57:24 -04:00
jekyllbot
66e2d38d58 Update history to reflect merge of #6375 [ci skip] 2017-09-20 15:05:42 -04:00
Frank Taillandier
b802093f15 fix permalink example (#6375)
Merge pull request 6375
2017-09-20 15:05:40 -04:00
jekyllbot
fa49c02335 Update history to reflect merge of #6349 [ci skip] 2017-09-20 15:04:37 -04:00
Florian Thomas
e3ee9ba113 add note to contributing docs about script/console (#6349)
Merge pull request 6349
2017-09-20 15:04:36 -04:00
jekyllbot
e9f2d85767 Update history to reflect merge of #6366 [ci skip] 2017-09-15 10:57:51 -04:00
ashmaroli
2b6330b686 bump rubies on Travis (#6366)
Merge pull request 6366
2017-09-15 10:57:50 -04:00
jekyllbot
8b47fb1f7a Update history to reflect merge of #6338 [ci skip] 2017-09-06 12:52:36 -04:00
Ben Balter
1637f29d6c Alias Drop#invoke_drop to Drop#[] (#6338)
Merge pull request 6338
2017-09-06 12:52:34 -04:00
jekyllbot
22f2724a1f Update history to reflect merge of #6346 [ci skip] 2017-09-04 16:54:29 -04:00
Ohad Schneider
579f9ee1dd Fix precedence docs (#6346)
Merge pull request 6346
2017-09-04 16:54:28 -04:00
jekyllbot
b6853bf938 Update history to reflect merge of #6342 [ci skip] 2017-09-02 10:38:09 -04:00
Parker Moore
6ce912e957 Use a Schwartzian transform with custom sorting (#6342)
Merge pull request 6342
2017-09-02 10:38:07 -04:00
jekyllbot
1a4f53de14 Update history to reflect merge of #6343 [ci skip] 2017-09-01 18:36:26 -04:00
Frank Taillandier
cb58716310 Docs: updates (#6343)
Merge pull request 6343
2017-09-01 18:36:25 -04:00
jekyllbot
fb27b2e296 Update history to reflect merge of #6333 [ci skip] 2017-08-30 15:30:58 -04:00
Frank Taillandier
94f377eed5 use latest rubocop channel on codeclimate (#6333)
Merge pull request 6333
2017-08-30 15:30:57 -04:00
jekyllbot
68d0214c6c Update history to reflect merge of #6336 [ci skip] 2017-08-30 14:17:19 -04:00
Bradley Meck
53500a215a Update mime-types. (#6336)
Merge pull request 6336
2017-08-30 14:17:18 -04:00
jekyllbot
6a2a33d09d Update history to reflect merge of #6337 [ci skip] 2017-08-30 09:20:40 -04:00
Natanael Arndt
692ce49460 Fix typo in site.url section of variables.md :-[ (#6337)
Merge pull request 6337
2017-08-30 09:20:38 -04:00
jekyllbot
e2b3ab85a0 Update history to reflect merge of #6270 [ci skip] 2017-08-30 08:48:16 -04:00
Natanael Arndt
06d16504ff Docs: site.url behavior on development and production environments (#6270)
Merge pull request 6270
2017-08-30 08:48:15 -04:00
jekyllbot
0aa55dbffb Update history to reflect merge of #6334 [ci skip] 2017-08-28 15:00:46 -04:00
Frank Taillandier
1a7bcb09f6 Docs: post's date can be overriden in YAML front matter (#6334)
Merge pull request 6334
2017-08-28 15:00:44 -04:00
Parker Moore
709a3444de Release 💎 3.6.0.pre.beta1 2017-08-23 12:56:09 -04:00
jekyllbot
fe0c105ff0 Update history to reflect merge of #6329 [ci skip] 2017-08-22 17:56:00 -04:00
Antonio Argote
88f5af23b1 document application of page.id (#6329)
Merge pull request 6329
2017-08-22 17:55:59 -04:00
Parker Moore
2b5457b9d2 Merge pull request #6327 from jekyll/fix-history
Fix History
2017-08-20 23:18:23 -04:00
Frank Taillandier
f808593fbf Fix History
Some of the latest PRs weren't affected to the good category. My bad.

Note to self: Space matters. 🌌
2017-08-19 15:54:18 +02:00
jekyllbot
2989a9a81b Update history to reflect merge of #6325 [ci skip] 2017-08-19 07:20:01 -04:00
David Zhang
df25873ed4 Rename CODE_OF_CONDUCT to show in banner (#6325)
Merge pull request 6325
2017-08-19 07:19:59 -04:00
jekyllbot
851c36d828 Update history to reflect merge of #6326 [ci skip] 2017-08-19 07:11:30 -04:00
Frank Taillandier
1d3fa81d53 plugins is the new gems (#6326)
Merge pull request 6326
2017-08-19 07:11:29 -04:00
jekyllbot
5cc2b6affc Update history to reflect merge of #6324 [ci skip] 2017-08-18 18:01:03 -04:00
Frank Taillandier
ee23d06507 add SUPPORT file for GitHub (#6324)
Merge pull request 6324
2017-08-18 18:01:02 -04:00
jekyllbot
d08256d1ce Update history to reflect merge of #6321 [ci skip] 2017-08-18 13:20:39 -04:00
Frank Taillandier
72877a9b07 update links (#6321)
Merge pull request 6321
2017-08-18 13:20:37 -04:00
jekyllbot
22449496b8 Update history to reflect merge of #6311 [ci skip] 2017-08-18 12:46:56 -04:00
Antonio Argote
2321370119 trim plugins page, clarify intention of templates (#6311)
Merge pull request 6311
2017-08-18 12:46:54 -04:00
jekyllbot
02767d612e Update history to reflect merge of #6315 [ci skip] 2017-08-18 12:45:24 -04:00
Parker Moore
232ec4679a Allow yield to logger methods & bail early on no-op messages (#6315)
Merge pull request 6315
2017-08-18 12:45:23 -04:00
Parker Moore
08840946f3 Update history to reflect merge of #6320
[ci skip]
2017-08-18 12:42:58 -04:00
Parker Moore
b86785dc7c Merge pull request #6320 from jekyll/add-CODEOWNERS
Add CODEOWNERS file to help automate reviews.
2017-08-18 12:42:07 -04:00
Frank Taillandier
f2860047b7 /cc a team is now handled by CODEOWNERS 2017-08-18 18:20:24 +02:00
Frank Taillandier
f232e1039a move CODEOWNERS to .github 2017-08-18 18:18:34 +02:00
Parker Moore
22cc59905b Add CODEOWNERS file to help automate reviews.
Documentation from GitHub: https://help.github.com/articles/about-codeowners/

jekyllbot does too much already -- I'd like to see GitHub help us keep organized.
This is also an exercise in logically splitting up the codebase. The build team
is pretty overloaded it looks like -- can we split anything out?
2017-08-18 11:38:32 -04:00
jekyllbot
54c1e5515e Update history to reflect merge of #6318 [ci skip] 2017-08-18 11:09:36 -04:00
Aleksander Kuś
db4ab43bdb name unification (#6318)
Merge pull request 6318
2017-08-18 11:09:34 -04:00
jekyllbot
2ce17697d3 Update history to reflect merge of #6317 [ci skip] 2017-08-18 11:09:08 -04:00
Aleksander Kuś
9b6e85203a name unification (#6317)
Merge pull request 6317
2017-08-18 11:09:07 -04:00
Parker Moore
62c822e834 Utils::Rouge: add missing frozen_string_literal comment. 2017-08-17 22:19:53 -04:00
Parker Moore
8e9605a32c Update history note for #5919 2017-08-17 14:06:06 -04:00
jekyllbot
21fa0d7755 Update history to reflect merge of #5919 [ci skip] 2017-08-17 11:16:20 -04:00
Parker Moore
4c15b9e5e4 [WIP] Add shim that works for both Rouge 1 and Rouge 2 (#5919)
Merge pull request 5919
2017-08-17 11:16:18 -04:00
Parker Moore
6b8de2a757 3.5.2: thank the contributors 2017-08-12 16:42:53 -04:00
Parker Moore
07d4c36652 Add release post for v3.5.2 2017-08-12 16:36:29 -04:00
Parker Moore
97c0c6cc77 Update site for v3.5.2 2017-08-12 16:30:47 -04:00
Parker Moore
48fafd9fc0 Release 💎 3.5.2 2017-08-12 16:29:45 -04:00
Parker Moore
722c49cd6f script/backport-pr: cherry-pick the commit properly
We used to do traditional merges but since we started doing squash merges,
we don't want the -m1 flag for git-cherry-pick.
2017-08-12 16:08:10 -04:00
jekyllbot
c810d761f7 Update history to reflect merge of #6274 [ci skip] 2017-08-12 15:18:52 -04:00
André Jaenisch
d4443e43d6 Execute build command using bundle. (#6274)
Merge pull request 6274
2017-08-12 15:18:51 -04:00
jekyllbot
a761a7acbc Update history to reflect merge of #6289 [ci skip] 2017-08-10 16:40:08 -04:00
Parker Moore
c059675bcc script/backport-pr: commit message no longer includes the # (#6289)
Merge pull request 6289
2017-08-10 16:40:06 -04:00
jekyllbot
073d2f1e6a Update history to reflect merge of #6284 [ci skip] 2017-08-10 16:27:16 -04:00
Parker Moore
3f0c77cfd5 Add a quick test for DataReader (#6284)
Merge pull request 6284
2017-08-10 16:27:14 -04:00
jekyllbot
dfdefcf367 Update history to reflect merge of #6280 [ci skip] 2017-08-10 11:14:54 -04:00
Ben Balter
045226f160 Guard against type error in absolute url (#6280)
Merge pull request 6280
2017-08-10 11:14:52 -04:00
jekyllbot
29b96f4408 Update history to reflect merge of #6283 [ci skip] 2017-08-09 19:16:06 -04:00
Pedro Lamas
a4181459b9 Fixes minor typo in post text (#6283)
Merge pull request 6283
2017-08-09 19:16:05 -04:00
jekyllbot
e39558f837 Update history to reflect merge of #6264 [ci skip] 2017-08-08 23:25:06 -04:00
lymaconsulting
bc962fe7d8 Customizing url in collection elements clarified (#6264)
Merge pull request 6264
2017-08-08 23:25:04 -04:00
jekyllbot
fbabb1eb26 Update history to reflect merge of #6281 [ci skip] 2017-08-08 23:10:39 -04:00
Parker Moore
bd31986ad6 Fix Drop#key? so it can handle a nil argument (#6281)
Merge pull request 6281
2017-08-08 23:10:38 -04:00
jekyllbot
3fab69e3c9 Update history to reflect merge of #6200 [ci skip] 2017-08-07 12:13:35 -04:00
ashmaroli
c8eee7ffcb Access custom config array throughout session (#6200)
Merge pull request 6200
2017-08-07 12:13:33 -04:00
jekyllbot
adde25120c Update history to reflect merge of #6277 [ci skip] 2017-08-06 10:49:02 -04:00
Florian Thomas
39631db0bd make flakey test more robust (#6277)
Merge pull request 6277
2017-08-06 10:49:01 -04:00
jekyllbot
6b1aa4ce01 Update history to reflect merge of #6273 [ci skip] 2017-08-05 11:01:42 -04:00
Kyle Zhao
a99186fe0a delegate StaticFile#to_json to StaticFile#to_liquid for a more (#6273)
Merge pull request 6273
2017-08-05 11:01:40 -04:00
jekyllbot
5c2e75823a Update history to reflect merge of #6266 [ci skip] 2017-08-04 15:53:27 -04:00
Parker Moore
d8dfc33b8b Memoize the return value of Document#url (#6266)
Merge pull request 6266
2017-08-04 15:53:26 -04:00
jekyllbot
305e293d46 Update history to reflect merge of #6257 [ci skip] 2017-08-03 23:10:19 -04:00
ashmaroli
8cade08de0 update theme-template README (#6257)
Merge pull request 6257
2017-08-03 23:10:18 -04:00
Parker Moore
922fa53401 Update history in docs site based on recent updates to History.markdown 2017-08-03 22:47:28 -04:00
jekyllbot
828ee760c2 Update history to reflect merge of #6206 [ci skip] 2017-08-03 22:00:25 -04:00
Florian Thomas
cc1cb8150a set LiquidError#template_name for errors in included file (#6206)
Merge pull request 6206
2017-08-03 22:00:24 -04:00
jekyllbot
73419cb374 Update history to reflect merge of #6265 [ci skip] 2017-08-03 21:27:33 -04:00
Parker Moore
7cf5f51ca2 Enforce Style/FrozenStringLiteralComment. (#6265)
Merge pull request 6265
2017-08-03 21:27:32 -04:00
jekyllbot
f9f05e3f75 Update history to reflect merge of #6262 [ci skip] 2017-08-03 08:40:15 -04:00
Sid Verma
eac51ba189 Update deprecated gems key to plugins. (#6262)
Merge pull request 6262
2017-08-03 08:40:14 -04:00
308 changed files with 10808 additions and 3750 deletions

View File

@@ -3,6 +3,7 @@ engines:
enabled: false
rubocop:
enabled: true
channel: rubocop-0-54
exclude_paths:
- .codeclimate.yml
@@ -28,6 +29,8 @@ exclude_paths:
- test/**/*
- vendor/**/*
- lib/jekyll/commands/serve/livereload_assets/livereload.js
ratings:
paths:
- lib/**/*.rb

86
.github/CODEOWNERS vendored Normal file
View File

@@ -0,0 +1,86 @@
# The Jekyll project has 6 affinity teams, shown here: https://teams.jekyllrb.com/
# They are as follows:
#
# 1. @jekyll/build
# 2. @jekyll/documentation
# 3. @jekyll/ecosystem
# 4. @jekyll/performance
# 5. @jekyll/stability
# 6. @jekyll/windows
#
# Each of these teams has a mission. Wherever possible, GitHub should
# automatically require review from these teams on the pieces of the
# repository they maintain.
# @jekyll/documentation
/docs/ @jekyll/documentation
# @jekyll/build
/exe/ @jekyll/build
/lib/jekyll.rb @jekyll/build
/lib/jekyll/cleaner.rb @jekyll/build
/lib/jekyll/collection.rb @jekyll/build
/lib/jekyll/command.rb @jekyll/build
/lib/jekyll/commands/ @jekyll/build
/lib/jekyll/converter.rb @jekyll/build
/lib/jekyll/converters/ @jekyll/build
/lib/jekyll/convertible.rb @jekyll/build
/lib/jekyll/document.rb @jekyll/build
/lib/jekyll/drops/ @jekyll/build
/lib/jekyll/entry_filter.rb @jekyll/build
/lib/jekyll/errors.rb @jekyll/build
/lib/jekyll/excerpt.rb @jekyll/build
/lib/jekyll/filters/ @jekyll/build
/lib/jekyll/filters.rb @jekyll/build
/lib/jekyll/layout.rb @jekyll/build
/lib/jekyll/liquid_extensions.rb @jekyll/build
/lib/jekyll/liquid_renderer/ @jekyll/build
/lib/jekyll/liquid_renderer.rb @jekyll/build
/lib/jekyll/log_adapter.rb @jekyll/build
/lib/jekyll/mime.types @jekyll/build
/lib/jekyll/page.rb @jekyll/build
/lib/jekyll/publisher.rb @jekyll/build
/lib/jekyll/reader.rb @jekyll/build
/lib/jekyll/readers/ @jekyll/build
/lib/jekyll/regenerator.rb @jekyll/build
/lib/jekyll/related_posts.rb @jekyll/build
/lib/jekyll/renderer.rb @jekyll/build
/lib/jekyll/site.rb @jekyll/build
/lib/jekyll/static_file.rb @jekyll/build
/lib/jekyll/stevenson.rb @jekyll/build
/lib/jekyll/tags/ @jekyll/build
/lib/jekyll/url.rb @jekyll/build
/lib/jekyll/utils/ @jekyll/build
/lib/jekyll/utils.rb @jekyll/build
# @jekyll/ecosystem
/lib/jekyll/external.rb @jekyll/ecosystem
/lib/jekyll/generator.rb @jekyll/ecosystem
/lib/jekyll/hooks.rb @jekyll/ecosystem
/lib/jekyll/plugin.rb @jekyll/ecosystem
/lib/jekyll/plugin_manager.rb @jekyll/ecosystem
/lib/jekyll/theme.rb @jekyll/ecosystem
/lib/jekyll/theme_builder.rb @jekyll/ecosystem
# @jekyll/stability
Gemfile @jekyll/stability
*.gemspec @jekyll/stability
.travis.yml @jekyll/stability
appveyor.yml @jekyll/stability
/lib/jekyll/configuration.rb @jekyll/stability
/lib/jekyll/deprecator.rb @jekyll/stability
/lib/jekyll/frontmatter_defaults.rb @jekyll/stability
/lib/site_template @jekyll/stability
/lib/theme_template @jekyll/stability
/features/ @jekyll/stability
/test/ @jekyll/stability
# Special cases
.github/ @jekyll/affinity-team-captains
CODE_OF_CONDUCT.markdown @jekyll/affinity-team-captains
History.markdown @jekyll/affinity-team-captains
LICENSE @jekyll/affinity-team-captains # This file should never change.
README.markdown @jekyll/affinity-team-captains
/lib/jekyll/version.rb @jekyll/affinity-team-captains
/rake/ @jekyll/affinity-team-captains
/script/ @jekyll/affinity-team-captains

View File

@@ -4,10 +4,7 @@ Hi there! Interested in contributing to Jekyll? We'd love your help. Jekyll is a
## Where to get help or report a problem
* If you have a question about using Jekyll, start a discussion on [Jekyll Talk](https://talk.jekyllrb.com).
* If you think you've found a bug within a Jekyll plugin, open an issue in that plugin's repository.
* If you think you've found a bug within Jekyll itself, [open an issue](https://github.com/jekyll/jekyll/issues/new).
* More resources are listed on our [Help page](https://jekyllrb.com/help/).
See [the support guidelines](https://jekyllrb.com/docs/support/)
## Ways to contribute
@@ -114,25 +111,37 @@ If your contribution changes any Jekyll behavior, make sure to update the docume
* Don't bump the Gem version in your pull request (if you don't know what that means, you probably didn't).
* You can use the command `script/console` to start a REPL to explore the result of
Jekyll's methods. It also provides you with helpful methods to quickly create a
site or configuration. [Feel free to check it out!](https://github.com/jekyll/jekyll/blob/master/script/console)
## Running tests locally
### Test Dependencies
To run the test suite and build the gem you'll need to install Jekyll's dependencies by running the following command:
<pre class="highlight"><code>$ script/bootstrap</code></pre>
```sh
script/bootstrap
```
Before you make any changes, run the tests and make sure that they pass (to confirm your environment is configured properly):
<pre class="highlight"><code>$ script/cibuild</code></pre>
```sh
script/cibuild
```
If you are only updating a file in `test/`, you can use the command:
<pre class="highlight"><code>$ script/test test/blah_test.rb</code></pre>
```sh
script/test test/blah_test.rb
```
If you are only updating a `.feature` file, you can use the command:
<pre class="highlight"><code>$ script/cucumber features/blah.feature</code></pre>
```sh
script/cucumber features/blah.feature
```
Both `script/test` and `script/cucumber` can be run without arguments to
run its entire respective suite.

View File

@@ -10,9 +10,6 @@
a generic usage question, please consider asking your question at
https://talk.jekyllrb.com where non-bug questions go.
Please make sure to mention an affinity team whose responsibilities
most closely align with your issue.
Thanks!
-->
@@ -51,7 +48,7 @@
## My Reproduction Steps
<!--
If this error occured on GitHub Pages, please try to provide us with logs,
If this error occurred on GitHub Pages, please try to provide us with logs,
and look at them yourself, to determine if this is an actual Jekyll bug. In
the event you are unsure, file a ticket, however, when you do please provide
the logs (strip them of personal information.)
@@ -79,5 +76,3 @@
The minimum should be personal information. Though we normally don't log
anything like that so there should be no need to alter it.
-->
/cc include any Jekyll affinity teams here (see https://teams.jekyllrb.com/ for more info)

20
.github/SUPPORT.markdown vendored Normal file
View File

@@ -0,0 +1,20 @@
# Jekyll Support
## Getting Help
**Jekyll's issue tracker is not a support forum.**
If you're looking for support for Jekyll, there are a lot of options:
* Read [Jekyll Documentation](https://jekyllrb.com/docs/home/)
* If you have a question about using Jekyll, start a discussion on [Jekyll Forum](https://talk.jekyllrb.com/) or [StackOverflow](https://stackoverflow.com/questions/tagged/jekyll)
* Chat with Jekyllers &mdash; Join [our Gitter channel](https://gitter.im/jekyll/jekyll) or [our IRC channel on Freenode](irc:irc.freenode.net/jekyll)
There are a bunch of helpful community members on these services that should be willing to point you in the right direction.
## Report a bug
* If you think you've found a bug within a Jekyll plugin, open an issue in that plugin's repository &mdash; First [look for the plugin on rubygems](https://rubygems.org/) then click on the `Homepage` link to access the plugin repository.
* If you think you've found a bug within Jekyll itself, [open an issue](https://github.com/jekyll/jekyll/issues/new).
Happy Jekyllin'!

44
.github/first-timers-issue-template.md vendored Normal file
View File

@@ -0,0 +1,44 @@
### 🆕🐥☝ First Timers Only.
This issue is reserved for people who never contributed to Open Source before. We know that the process of creating a pull request is the biggest barrier for new contributors. This issue is for you 💝
[About First Timers Only](http://www.firsttimersonly.com/).
### 🤔 What you will need to know.
Nothing. This issue is meant to welcome you to Open Source :) We are happy to walk you through the process.
### 📋 Step by Step
- [ ] 👌 **Join the team**: Add yourself to a Jekyll affinity team.
Go to [teams.jekyllrb.com](https://teams.jekyllrb.com/) and join a team that best fits your interests. Once you click the link to join a team, you will soon receive an email inviting you to join the Jekyll organization.
- [ ] 🙋 **Claim this issue**: Comment below.
Leave a comment that you have claimed this issue.
- [ ] 📝 **Update** the file [$FILENAME]($BRANCH_URL) in the `$REPO` repository (press the little pen Icon) and edit the line as shown below.
```diff
$DIFF
```
- [ ] 💾 **Commit** your changes
- [ ] 🔀 **Start a Pull Request**. There are two ways how you can start a pull request:
1. If you are familiar with the terminal or would like to learn it, [here is a great tutorial](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github) on how to send a pull request using the terminal.
2. You can [edit files directly in your browser](https://help.github.com/articles/editing-files-in-your-repository/)
- [ ] 🏁 **Done** Ask in comments for a review :)
### 🤔❓ Questions
Leave a comment below!
This issue was created by [First-Timers-Bot](https://github.com/hoodiehq/first-timers-bot).

6
.github/first-timers.yml vendored Normal file
View File

@@ -0,0 +1,6 @@
repository: jekyll
labels:
- good first issue
- help-wanted
- first-time-only
template: .github/first-timers-issue-template.md

View File

@@ -1,52 +1,48 @@
---
require:
- ./rubocop/jekyll
Jekyll/NoPutsAllowed:
Exclude:
- rake/*.rake
AllCops:
TargetRubyVersion: 2.0
TargetRubyVersion: 2.3
Include:
- lib/**/*.rb
- test/**/*.rb
Exclude:
- bin/**/*
- exe/**/*
- benchmark/**/*
- script/**/*
- vendor/**/*
Layout/AlignArray:
Enabled: false
- tmp/**/*
Layout/AlignHash:
EnforcedHashRocketStyle: table
Layout/AlignParameters:
Enabled: false
Layout/EmptyLinesAroundAccessModifier:
Enabled: false
Layout/EmptyLinesAroundModuleBody:
Enabled: false
Layout/EndOfLine:
EnforcedStyle: lf
Layout/ExtraSpacing:
AllowForAlignment: true
Layout/FirstParameterIndentation:
EnforcedStyle: consistent
Layout/IndentationWidth:
Severity: error
Layout/IndentArray:
EnforcedStyle: consistent
Layout/IndentHash:
EnforcedStyle: consistent
Layout/IndentHeredoc:
Enabled: false
Layout/MultilineMethodCallIndentation:
EnforcedStyle: indented
Layout/MultilineOperationIndentation:
EnforcedStyle: indented
Layout/SpaceAroundOperators:
Enabled: true
Layout/SpaceInsideBrackets:
Lint/NestedPercentLiteral:
Exclude:
- test/test_site.rb
Layout/EmptyComment:
Enabled: false
Lint/EndAlignment:
Layout/EndAlignment:
Severity: error
Lint/UnreachableCode:
Severity: error
Lint/UselessAccessModifier:
Enabled: false
Lint/Void:
Exclude:
- lib/jekyll/site.rb
Metrics/AbcSize:
Max: 21
Metrics/BlockLength:
@@ -54,22 +50,26 @@ Metrics/BlockLength:
- test/**/*.rb
- lib/jekyll/configuration.rb
- rake/*.rake
- jekyll.gemspec
Metrics/ClassLength:
Exclude:
- !ruby/regexp /features\/.*.rb$/
- !ruby/regexp /test\/.*.rb$/
Max: 300
- lib/jekyll/document.rb
- lib/jekyll/site.rb
- lib/jekyll/commands/serve.rb
- lib/jekyll/configuration.rb
Max: 240
Metrics/CyclomaticComplexity:
Max: 9
Exclude:
- lib/jekyll/utils.rb
- lib/jekyll/commands/serve.rb
Metrics/LineLength:
Exclude:
- !ruby/regexp /features\/.*.rb/
- Rakefile
- rake/*.rake
- Gemfile
- jekyll.gemspec
Max: 90
Max: 100
Severity: warning
Metrics/MethodLength:
CountComments: false
@@ -81,6 +81,19 @@ Metrics/ParameterLists:
Max: 4
Metrics/PerceivedComplexity:
Max: 8
Naming/FileName:
Enabled: false
Naming/HeredocDelimiterNaming:
Exclude:
- test/**/*.rb
Naming/MemoizedInstanceVariableName:
Exclude:
- lib/jekyll/page_without_a_file.rb
- lib/jekyll/drops/unified_payload_drop.rb
- lib/jekyll/drops/site_drop.rb
Naming/UncommunicativeMethodParamName:
AllowedNames:
- _
Security/MarshalLoad:
Exclude:
- !ruby/regexp /test\/.*.rb$/
@@ -89,33 +102,32 @@ Security/YAMLLoad:
Exclude:
- !ruby/regexp /features\/.*.rb/
- !ruby/regexp /test\/.*.rb$/
Style/Alias:
Style/AccessModifierDeclarations:
Enabled: false
Style/Alias:
EnforcedStyle: prefer_alias_method
Style/AndOr:
Severity: error
Style/Attr:
Enabled: false
Style/BracesAroundHashParameters:
Enabled: false
Style/ClassAndModuleChildren:
Enabled: false
Exclude:
- test/**/*.rb
Style/FrozenStringLiteralComment:
EnforcedStyle: always
Style/Documentation:
Enabled: false
Exclude:
- !ruby/regexp /features\/.*.rb$/
Style/DoubleNegation:
Enabled: false
Style/FileName:
Enabled: false
Style/FormatStringToken:
Exclude:
- lib/jekyll/utils/ansi.rb
Style/GuardClause:
Enabled: false
Style/HashSyntax:
EnforcedStyle: hash_rockets
Severity: error
Style/IfUnlessModifier:
Enabled: false
Style/InverseMethods:
Enabled: false
Style/MixinUsage:
Exclude:
- test/helper.rb
Style/ModuleFunction:
Enabled: false
Style/MultilineTernaryOperator:
@@ -129,25 +141,22 @@ Style/PercentLiteralDelimiters:
"%w": "()"
"%W": "()"
"%x": "()"
Style/RedundantReturn:
Enabled: false
Style/RedundantSelf:
Enabled: false
Style/RegexpLiteral:
EnforcedStyle: percent_r
Style/RescueModifier:
Enabled: false
Style/SafeNavigation:
Exclude:
- lib/jekyll/document.rb
Style/SignalException:
EnforcedStyle: only_raise
Style/SingleLineMethods:
Enabled: false
Style/StringLiterals:
EnforcedStyle: double_quotes
Style/StringLiteralsInInterpolation:
EnforcedStyle: double_quotes
Style/SymbolArray:
Enabled: false
Style/TrailingCommaInLiteral:
EnforcedStyle: brackets
Style/TrailingCommaInArrayLiteral:
EnforcedStyleForMultiline: consistent_comma
Style/TrailingCommaInHashLiteral:
EnforcedStyleForMultiline: consistent_comma
Style/UnneededCapitalW:
Enabled: false

View File

@@ -5,20 +5,19 @@ language: ruby
sudo: false
rvm:
- &ruby1 2.4.1
- &ruby2 2.3.4
- &ruby3 2.2.7
- &ruby4 2.1.10
- &jruby jruby-9.1.7.0
- &ruby1 2.5.1
- &ruby2 2.4.4
- &ruby3 2.3.7
- &jruby jruby-9.1.16.0
matrix:
include:
- rvm: *ruby1
env: TEST_SUITE=fmt
name: "🤖️ Code Format"
- rvm: *ruby1
env: TEST_SUITE=default-site
- rvm: *ruby1
env: ROUGE_VERSION=1.11.1 # runs everything with this version
name: "🏠️ Default Site"
exclude:
- rvm: *jruby
env: TEST_SUITE=cucumber
@@ -55,3 +54,4 @@ after_success:
before_install:
- gem update --system
- gem install bundler --version 1.16.2

46
CODE_OF_CONDUCT.markdown Normal file
View File

@@ -0,0 +1,46 @@
# Code of Conduct
## Our Pledge
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
## Our Standards
Examples of behavior that contributes to creating a positive environment include:
* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members
Examples of unacceptable behavior by participants include:
* The use of sexualized language or imagery and unwelcome sexual attention or advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a professional setting
## Our Responsibilities
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
## Scope
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting a project maintainer. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [https://www.contributor-covenant.org/version/1/4/code-of-conduct.html][version]
[homepage]: https://www.contributor-covenant.org/
[version]: https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

31
Gemfile
View File

@@ -1,11 +1,10 @@
# frozen_string_literal: true
source "https://rubygems.org"
gemspec :name => "jekyll"
gem "rake", "~> 12.0"
# Dependency of jekyll-mentions. RubyGems in Ruby 2.1 doesn't shield us from this.
gem "activesupport", "~> 4.2", :groups => [:test_legacy, :site] if RUBY_VERSION < "2.2.2"
group :development do
gem "launchy", "~> 2.3"
gem "pry"
@@ -19,14 +18,14 @@ end
group :test do
gem "codeclimate-test-reporter", "~> 1.0.5"
gem "cucumber", "~> 2.1"
gem "cucumber", "~> 3.0"
gem "httpclient"
gem "jekyll_test_plugin"
gem "jekyll_test_plugin_malicious"
# nokogiri v1.8 does not work with ruby 2.1 and below
gem "nokogiri", RUBY_VERSION >= "2.2" ? "~> 1.7" : "~> 1.7.0"
gem "nokogiri", "~> 1.7"
gem "rspec"
gem "rspec-mocks"
gem "rubocop", "~> 0.49.1"
gem "rubocop", "~> 0.57.2"
gem "test-dependency-theme", :path => File.expand_path("test/fixtures/test-dependency-theme", __dir__)
gem "test-theme", :path => File.expand_path("test/fixtures/test-theme", __dir__)
@@ -36,14 +35,13 @@ end
#
group :test_legacy do
if RUBY_PLATFORM =~ %r!cygwin! || RUBY_VERSION.start_with?("2.2")
if RUBY_PLATFORM =~ %r!cygwin!
gem "test-unit"
end
gem "minitest"
gem "minitest-profile"
gem "minitest-reporters"
gem "redgreen"
gem "shoulda"
gem "simplecov"
end
@@ -53,7 +51,6 @@ end
group :benchmark do
if ENV["BENCHMARK"]
gem "benchmark-ips"
gem "benchmark-memory"
gem "rbtrace"
gem "ruby-prof"
gem "stackprof"
@@ -70,18 +67,16 @@ group :jekyll_optional_dependencies do
gem "jekyll-gist"
gem "jekyll-paginate"
gem "jekyll-redirect-from"
gem "kramdown", "~> 1.9"
gem "kramdown", "~> 1.14"
gem "mime-types", "~> 3.0"
gem "rdoc", "~> 5.0"
gem "toml", "~> 0.1.0"
gem "rdoc", "~> 6.0"
gem "tomlrb", "~> 1.2"
platform :ruby, :mswin, :mingw, :x64_mingw do
gem "classifier-reborn", "~> 2.1.0"
gem "classifier-reborn", "~> 2.2.0"
gem "liquid-c", "~> 3.0"
gem "pygments.rb", "~> 0.6.0"
gem "rdiscount", "~> 2.0"
gem "redcarpet", "~> 3.2", ">= 3.2.3"
gem "yajl-ruby", "~> 1.2"
gem "pygments.rb", "~> 1.0"
gem "yajl-ruby", "~> 1.3"
end
# Windows does not include zoneinfo files, so bundle the tzinfo-data gem

View File

@@ -1,12 +1,407 @@
## HEAD
* Textile is only supported through a converter plugin (#7003)
### Documentation
* Release post for v3.8.0 (#6849)
* Add Installation Instructions for Ubuntu (#6925)
* add liquid tag jekyll-flickr (#6946)
* Add 4.0 development post (#6934)
* Updated copy - fixed casing of SaaS on resources page. (#6949)
* WIP: Do not advise users to install Jekyll outside of Bundler (#6927)
* Don&#39;t prompt for sudo when installing with Ubuntu WSL (#6781)
* Fix typo (#6969)
* Add version number for group_by_exp doc (#6956)
* Update Windows install docs (#6926)
* Remove documentation for using Redcarpet (#6990)
* Updated nginx configuration for custom-404-page documentation (#6994)
* List all static files variables (#7002)
* Document that _drafts need to be contained within the custom collection directory (#6985)
* proposed change for passive voice. (#7005)
* added the CAT plugin to the plugin list (#7011)
* Updated to supported version (#7031)
* Clarify definition of &#39;draft&#39; (#7037)
* Listed the jekyll-target-blank plugin in plugins list. (#7046)
* Typo (#7058)
* Add Hints for some Improved Travis Config in Doc (#7049)
* Added plugin json-get. (#7086)
* Update travis-ci.md to point out &#34;this is an example Gemfile&#34; (#7089)
* Adding `jekyll-info` plugin (#7091)
* GitHub enables you to use themes from other repos (#7112)
* Updates to CODE OF CONDUCT (v1.4.0) (#7105)
* Instructions to view themes files under Linux (#7095)
* add jekyll-xml-source (#7114)
* Add the jekyll-firstimage filter plugin (#7127)
* Use a real theme in the example (#7125)
* Update docs about post creation (#7138)
* Add DEV Community&#39;s Jekyll tag to community page (#7139)
* Initialize upgrading doc for v4.0 (#7140)
* Add version badge for date filters with ordinal (#7162)
* Add closing tags for &lt;a&gt; (#7163)
* Add TSV to list of supported _data files. (#7168)
### Minor Enhancements
* use jekyll-compose if installed (#6932)
* Memoize computing excerpt&#39;s relative_path (#6951)
* Liquefied link tag (#6269)
* Suggest re-running command with --trace on fail (#6551)
* Update item_property to return numbers as numbers instead of strings (#6608)
* Use .markdown for page templates (#7126)
* Fix custom 404 page for GitHub pages (#7132)
### Major Enhancements
* Remove unused error class (#6511)
* Drop support for Ruby 2.1 and 2.2 (#6560)
* Add vendor folder to a newly installed site&#39;s .gitignore (#6968)
* bump i18n (#6931)
* We are not using Ruby 2.2 anymore (#6977)
* Drop support for older versions of Rouge (#6978)
* Remove support for Redcarpet (#6987)
* Remove support for rdiscount (#6988)
* Remove &#39;cache_dir&#39; during `jekyll clean` (#7158)
* Output Jekyll Version while debugging (#7173)
### Development Fixes
* Strip unnecessary leading whitespace in template (#6228)
* Users should be installing patch versions. (#6198)
* fix tests (#6240)
* Define path with __dir__ (#6087)
* exit site.process sooner (#6239)
* Remove unnecessary Jekyll::Page constant (#6770)
* Loggers should accept both numbers and symbols (#6967)
* Update instructions for releasing docs Gem (#6975)
* yajl-ruby update to v1.4.0 (#6976)
* Load Rouge for TestKramdown (#7007)
* Useless privates removed (#6768)
* Allow i18n v0.9.5 and higher (#7044)
* Update Rubocop&#39;s config (#7050)
* Remember to release docs gem (#7066)
* Use assert_include (#7093)
* Update rubocop version to 0.57.x ### -docs (#7078)
* Example of CircleCI deployment through CircleCI v2 (#7024)
* Fix Rubocop offences in test files (#7128)
* fix up refute_equal call (#7133)
* Fix incorrectly passed arguments to assert_equal (#7134)
* Lock Travis to Bundler-1.16.2 (#7144)
### Bug Fixes
* Add call to unused method `validate_options` in `commands/serve.rb` (#7122)
### feature
* Disable Liquid via front matter (#6824)
* Do not process Liquid in post excerpt when disabled in front matter (#7146)
## 3.8.3 / 2018-06-05
### Bug Fixes
* Fix --unpublished not affecting collection documents (#7027)
## 3.8.2 / 2018-05-18
### Development Fixes
* Update rubocop version (#7016)
### Bug Fixes
* Add whitespace control to LIQUID_TAG_REGEX (#7015)
## 3.8.1 / 2018-05-01
### Bug Fixes
* Fix rendering Liquid constructs in excerpts (#6945)
* Liquify documents unless published == false (#6959)
## 3.8.0 / 2018-04-19
### Development Fixes
* move duplicate code to a single private method (#6593)
* Test against Ruby 2.5 on AppVeyor (#6668)
* Replace simple regex with a native Ruby method (#6732)
* Codeclimate: exclude livereload.js (#6776)
* Add a cucumber feature to test link tag (#6777)
* Fix theme gem feature (#6784)
* Replace simple regex with equivalent Ruby methods (#6736)
* Rewrite `script/rubyprof` as a Ruby script (#6813)
* Add debug output to theme rendering (#5195)
* fix minitest deprecation warning in test (#6839)
* Memoize `Site#site_data` (#6809)
* Memoize document output extension (#6814)
* Access document permalink attribute efficiently (#6740)
* Minimize array allocations in the `where` filter (#6860)
* Bump JRuby (#6878)
* Assert existence of &lt;collection&gt;.files (#6907)
* Bump Rubocop to 0.54.x (#6915)
* Regenerate unconditionally unless its an incremental build (#6917)
* Centralize require statements (#6910)
* Bump to Rubocop 0.55 (#6929)
* Refactor private method `HighlightBlock#parse_options` (#6822)
### Minor Enhancements
* Two massive performance improvements for large sites (#6730)
* Cache the list of documents to be written (#6741)
* Allow Jekyll Doctor to detect stray posts dir (#6681)
* Excerpt relative-path should match its path (#6597)
* Remind user to resolve conflict in `jekyll new` with `--force` (#6801)
* Memoize helper methods in site-cleaner (#6808)
* Compute document&#39;s relative_path faster (#6767)
* Create a single instance of PostReader per site (#6759)
* Allow date filters to output ordinal days (#6773)
* Change regex to sanitize and normalize filenames passed to LiquidRenderer (#6610)
* Allow passing :strict_variables and :strict_filters options to Liquid&#39;s renderer (#6726)
* Debug writing files during the build process (#6696)
* Improve regex usage in `Tags::IncludeTag` (#6848)
* Improve comment included in the starter index.md (#6916)
* Store and retrieve converter instances for Jekyll::Filters via a hash (#6856)
* Implement a cache within the `where` filter (#6868)
* Store regexp in a constant (#6887)
* Optimize computing filename in LiquidRenderer (#6841)
### Documentation
* Adding the jekyll-algolia plugin to the list of plugins (#6737)
* Added Premonition plugin to list of plugins (#6750)
* Add document on releasing a new version (#6745)
* Mention Talkyard, a new commenting system for Jekyll and others. (#6752)
* Add &#39;jekyll-fontello&#39; to plugins (#6757)
* Install dh-autoreconf on Windows (#6765)
* Fix common typos (#6764)
* Fix documentation for `{{ page.excerpt }}` (#6779)
* Update docs on permalink configuration (#6775)
* Propose fix some typos (#6785)
* Say hello to Jekyll&#39;s New Lead Developer (#6790)
* Add reference to Liquid to plugin docs (#6794)
* Draft a release post for v3.7.3 (#6803)
* add missing step for gem-based theme conversion (#6802)
* Update windows.md to explain an issue with jekyll new. (#6838)
* Add Bundler Installation Instructions (#6828)
* Docs: describe difference between tags and categories (#6882)
* Add `jekyll-random` plugin to docs (#6833)
* Fixed typo in description of categories and tags (#6896)
* Add missing ul-tag (#6897)
* doc: add liquid tag plugin jekyll-onebox for html previews (#6898)
* Add `jekyll-w2m` to plugins (#6855)
* Fix tutorials navigation HTML (#6919)
* add Arch Linux instalation troubleshoot (#6782)
* Docs: Install Jekyll on macOS (#6881)
* Fix CodeClimate badges [ci skip] (#6930)
* Update index.md (#6933)
### Site Enhancements
* Remove links to Gists (#6751)
* Always load Google Fonts over HTTPS (#6792)
* always load analytics.js over HTTPS (#6807)
### Bug Fixes
* Append appropriate closing tag to Liquid block in an excerpt ### -minor (#6724)
* Bypass rendering via Liquid unless required (#6735)
* Delegated methods after `private` keyword are meant to be private (#6819)
* Improve handling non-default collection documents rendering and writing (#6795)
* Fix passing multiline params to include tag when using the variable syntax (#6858)
* `include_relative` tag should find related documents in collections gathered within custom `collections_dir` (#6818)
* Handle liquid tags in excerpts robustly (#6891)
* Allow front matter defaults to be applied properly to documents gathered under custom `collections_dir` (#6885)
## 3.7.3 / 2018-02-25
### Bug Fixes
* Do not hardcode locale unless certainly necessary (#6791)
## 3.7.2 / 2018-01-25
### Development Fixes
* CI: Test against Ruby 2.5.0 (#6664)
* Bump rdoc to 6.0 (#6600)
* Lint file and bump theme dependencies (#6698)
* Write a Rubocop Cop to ensure no `#p` or `#puts` calls get committed to master. (#6615)
* Remove redgreen gem (#6720)
### Site Enhancements
* Display latest version in header (#6676)
* Update version in `config.yml` via YAML load / dump (#6677)
### Documentation
* Fix: Add note about posts in context of collections_dir (#6680)
* Update deploy-script in documentation (#6666)
* Add note about naming of collections_dir (#6703)
* Update installation.md (#6694)
* Add `jekyll-html` to plugins. (#6654)
* Update plugins.md (#6716)
* Release v3.7.1 (#6695)
### Bug Fixes
* inform that symlinks are not allowed in safe mode (#6670)
* Glob scope path only if configured with a pattern (#6692)
* Add gem &#34;wdm&#34; to all newly generated Gemfiles (#6711)
* Fix timezone inconsistencies between different ruby version (#6697)
* Refactor collections_dir feature for consistency (#6685)
### Minor Enhancements
* Require external library only if necessary (#6596)
## 3.7.0 / 2018-01-02
### Minor Enhancements
* Add LiveReload functionality to Jekyll. (#5142)
* Add Utils::Internet.connected? to determine whether host machine has internet connection. (#5870)
* Disable default layouts for Pages with a `layout: none` declaration (#6182)
* Scope path glob (#6268)
* Allow the user to set collections_dir to put all collections under one subdirectory (#6331)
* Upgrade to Rouge 3 (#6381)
* Allow URL filters to work directly with documents (#6478)
* filter relative_url should keep absolute urls with scheme/authority (#6490)
* `.sass-cache` doesn&#39;t *always* land in `options[&#39;source&#39;]` (#6500)
* Allow plugins to modify the obsolete files. (#6502)
* Add latin mode to `slugify` (#6509)
* Log Kramdown warnings if log level is WARN (#6522)
* Add an option to configure kramdown warning output (#6554)
* Add `json` extension to list of directory indices (#6550)
* Dependency: Bump jekyll-watch to 2.0 (#6589)
* Remove paginate check (#6606)
* update classifier-reborn to 2.2.0 (#6631)
* Switch to an actively-maintained TOML parser. (#6652)
* Do not coerce layout paths in theme-gem to the source directory (#6603)
### Bug Fixes
* Raise when theme root directory is not available (#6455)
* Avoid block parser warning in SmartyPants (#6565)
* Fail gracefully if &#34;sass&#34; gem cannot be loaded (#6573)
* return correct file in dir if dir has same name as file (#6569)
* Register reload hooks in Server#process (#6605)
* Memoize path to metadata file (#6602)
* Use `require_relative` to load Jekyll classes (#6609)
### Development Fixes
* Added direct collection access to future collection item feature test(#6151)
* add failing test for non-utf8 encoding (#6339)
* Upgrade to Cucumber 3.0 (#6395)
* Provide a better default hash for tracking liquid stats (#6417)
* Add configuration for first-timers bot (#6431)
* Do not linkify escaped characters as PRs in History (#6468)
* Rely on jekyll-mentions for linking usernames (#6469)
* Update first-timers-issue-template.md (#6472)
* Enable `Lint/RescueWithoutErrorClass` Cop (#6482)
* Clean up Rubocop config (#6495)
* Use Gem to discover the location of bundler (#6499)
* Remove unnecessary encoding comment (#6513)
* Suggest using Rubocop to automatically fix errors (#6514)
* Assert raising Psych::SyntaxError when`&#34;strict_front_matter&#34;=&gt;true` (#6520)
* Use Kernel#Array instead of explicit Array check (#6525)
* RuboCop: Enable `Style/UnneededCapitalW` cop (#6526)
* Refactor method to reduce ABC Metric size (#6529)
* Remove parentheses around arguments to raise (#6532)
* Use double-quotes around gem name (#6535)
* Dependencies: upgrade to toml 0.2.0 (#6541)
* Lock to cucumber 3.0.1 on Ruby 2.1 (#6546)
* Bump JRuby version in Travis config (#6561)
* Rescue from Psych::SyntaxError instead of SyntaxError after parsing YAML(#5828)
* Drop forwarding to private methods by exposing those methods as public(#6577)
* Upgrade pygments to v1.x (#5937)
* Bump yajl-ruby (#6582)
* Cleanup test_redcarpet.rb (#6584)
* Add PageWithoutAFile class from jekyll plugins (#6556)
* Cleanup LiveReloadReactor (#6607)
### Documentation
* Add formester to the list of saas form backend (#6059)
* GitHub Pages instructions (#6384)
* Improve documentation for theme-gem installation (#6387)
* Fix diff syntax-highlighting (#6388)
* Update instructions (#6396)
* Fix code-block highlighting in docs (#6398)
* Filtering Posts with categories, tags, or other variables (#6399)
* Fixes formatting on pre-formatted text. (#6405)
* Added new tutorial to tutorials section on docs (#6406)
* Updates (#6407)
* Fix `collections_dir` example (#6408)
* Renaming duplicate of &#34;Scenario 6&#34; to &#34;Scenario 7&#34; (#6411)
* Mark `collection_dir` as unreleased (#6412)
* Fix link to SUPPORT (#6415)
* Fix list appearance by adding missing `ol` tag (#6421)
* Explain how to override output collection index page (#6424)
* Added github-cards to the list of plugins (#6425)
* CoC violation correspondants (#6429)
* Add a note about Liquid and syntax highlighting (#6466)
* Remove `sudo` from macOS troubleshooting instructions (#6486)
* Add a note on `:jekyll_plugins` group in the docs (#6488)
* Updated custom-404-page.md (#6489)
* Fix a few minor issues in the docs (#6494)
* Add jekyll-pwa-plugin (#6533)
* Remove Jekyll-Smartify from plugins directory (#6548)
* Updated Jekyll-Pug listing to include official website (#6555)
* Remove link to severely outdated asset plugin (#6613)
* Default time zone depends upon server (#6617)
* Add `disqus-for-jekyll` to plugins. (#6618)
* Update &#34;Requirements&#34; for Ruby version (#6623)
* Fix: Update link to i18n_filter plugin (#6638)
* Correct WordPress capitalization (#6645)
* Add Tweetsert, Stickyposts, Paginate::Content (#6651)
* Post: Jekyll 3.7.0 released (#6634)
### Site Enhancements
* Add special styling for code-blocks run in shell (#6389)
* Add post about diversity (#6447)
* Update list of files excluded from Docs site (#6457)
* Update site History (#6460)
* Add default twitter card image (#6476)
* Update normalize.css to v7.0.0 (#6491)
* Optimize images (#6519)
* Back to original main navigation (#6544)
* Styles: mobile-docs select element (#6545)
* Search with DocSearch by @Algolia (#6557)
* Site header redesign (#6567)
* Move logo above site navigation on small screens (#6570)
* Docs: Include version badge for latest features (#6574)
* Use version-badge on an existing feature intro (#6575)
* Add jekyll-category-pages plugin (#6632)
* Improve docs styling for code to be run in shell (#6641)
* Fix permalink icon markup in news-item layout (#6639)
## 3.6.2 / 2017-10-21
### Development Fixes
* Update Rubocop to 0.51.0 (#6444)
* Add test for layout as string (#6445)
### Bug Fixes
* Problematic UTF+bom files (#6322)
* Always treat `data.layout` as a string (#6442)
## 3.6.1 / 2017-10-20
### Documentation
* Doc y_day in docs/permalinks (#6244)
* Update frontmatter.md (#6371)
* Elaborate on excluding items from processing (#6136)
* Style lists in tables (#6379)
* Remove duplicate &#34;available&#34; (#6380)
### Development Fixes
* Bump rubocop to use `v0.50.x` (#6368)
## 3.6.0 / 2017-09-21
### Minor Enhancements
@@ -14,22 +409,82 @@
* Add URL checks to Doctor (#5760)
* Fix serving files that clash with directories (#6222) (#6231)
* Bump supported Ruby version to `>= 2.1.0` (#6220)
* set `LiquidError#template_name` for errors in included file (#6206)
* Access custom config array throughout session (#6200)
* Add support for Rouge 2, in addition to Rouge 1 (#5919)
* Allow `yield` to logger methods &amp; bail early on no-op messages (#6315)
* Update mime-types. (#6336)
* Use a Schwartzian transform with custom sorting (#6342)
* Alias `Drop#invoke_drop` to `Drop#[]` (#6338)
### Bug Fixes
* `Deprecator`: fix typo for `--serve` command (#6229)
* `Reader#read_directories`: guard against an entry not being a directory (#6226)
* kramdown: symbolize keys in-place (#6247)
* Call to_s on site.url before attempting to concatenate strings (#6253)
* Call `to_s` on site.url before attempting to concatenate strings (#6253)
* Enforce Style/FrozenStringLiteralComment (#6265)
* Update theme-template README to note &#39;assets&#39; directory (#6257)
* Memoize the return value of `Document#url` (#6266)
* delegate `StaticFile#to_json` to `StaticFile#to_liquid` (#6273)
* Fix `Drop#key?` so it can handle a nil argument (#6281)
* Guard against type error in absolute url (#6280)
* Mutable drops should fallback to their own methods when a mutation isn&#39;t present (#6350)
* Skip adding binary files as posts (#6344)
* Don&#39;t break if bundler is not installed (#6377)
### Documentation
* Fix a typo in `custom-404-page.md` (#6218)
* Docs: fix links to issues in History.markdown (#6255)
* Update deprecated gems key to plugins. (#6262)
* Fixes minor typo in post text (#6283)
* Execute build command using bundle. (#6274)
* name unification - buddy details (#6317)
* name unification - application index (#6318)
* trim and relocate plugin info across docs (#6311)
* update Jekyll&#39;s README (#6321)
* add SUPPORT file for GitHub (#6324)
* Rename CODE_OF_CONDUCT to show in banner (#6325)
* Docs : illustrate page.id for a collection&#39;s document (#6329)
* Docs: post&#39;s date can be overriden in YAML front matter (#6334)
* Docs: `site.url` behavior on development and production environments (#6270)
* Fix typo in site.url section of variables.md :-[ (#6337)
* Docs: updates (#6343)
* Fix precedence docs (#6346)
* add note to contributing docs about `script/console` (#6349)
* Docs: Fix permalink example (#6375)
### Site Enhancements
* Adding DevKit helpers (#6225)
* Customizing url in collection elements clarified (#6264)
* Plugins is the new gems (#6326)
### Development Fixes
* Strip unnecessary leading whitespace in template (#6228)
* Users should be installing patch versions. (#6198)
* Fix tests (#6240)
* Define path with `__dir__` (#6087)
* exit site.process sooner (#6239)
* make flakey test more robust (#6277)
* Add a quick test for DataReader (#6284)
* script/backport-pr: commit message no longer includes the `#` (#6289)
* Add Add CODEOWNERS file to help automate reviews. (#6320)
* Fix builds on codeclimate (#6333)
* Bump rubies on Travis (#6366)
## 3.5.2 / 2017-08-12
### Bug Fixes
* Backport #6281 for v3.5.x: Fix `Drop#key?` so it can handle a nil argument (#6288)
* Backport #6280 for v3.5.x: Guard against type error in `absolute_url` (#6287)
* Backport #6266 for v3.5.x: Memoize the return value of `Document#url` (#6301)
* Backport #6273 for v3.5.x: delegate `StaticFile#to_json` to `StaticFile#to_liquid` (#6302)
* Backport #6226 for v3.5.x: `Reader#read_directories`: guard against an entry not being a directory (#6304)
* Backport #6247 for v3.5.x: kramdown: symbolize keys in-place (#6303)
## 3.5.1 / 2017-07-17
@@ -50,7 +505,7 @@
* added BibSonomy plugin (#6143)
* add plugins for multiple page pagination (#6055)
* Update minimum Ruby version in installation.md (#6164)
* [docs] Add information about finding a collection in `site.collections` (#6165)
* Add information about finding a collection in `site.collections` (#6165)
* Add `{% raw %}` to Liquid example on site (#6179)
* Added improved Pug plugin - removed 404 Jade plugin (#6174)
* Linking the link (#6210)
@@ -155,7 +610,7 @@
### Development Fixes
* [Rubocop] add missing comma (#5835)
* Rubocop: add missing comma (#5835)
* Appease classifier-reborn (#5934)
* Allow releases & development on `*-stable` branches (#5926)
* Add script/backport-pr (#5925)
@@ -192,7 +647,7 @@
### Bug Fixes
* Exclude Gemfile by default (#5860)
* Convertible#validate_permalink!: ensure the return value of data["permalink"] is a string before asking if it is empty (#5878)
* Convertible#validate_permalink!: ensure the return value of `data["permalink"]` is a string before asking if it is empty (#5878)
* Allow abbreviated post dates (#5920)
* Remove dependency on include from default about.md (#5903)
* Allow colons in `uri_escape` filter (#5957)
@@ -253,7 +708,7 @@
* Switch to `https` when possible. (#5611)
* Update `_font-awesome.scss` to move .woff file before .ttf (#5614)
* Update documentation on updating FontAwesome Iconset (#5655)
* [site] Use defaults for docs and news-items (#5744)
* Use defaults for docs and news-items (#5744)
* Sort gems in `docs/_config.yml` (#5746)
* Add missing class (#5791)
* Improve template docs (#5694)
@@ -314,7 +769,7 @@
* Update quickstart.md (#5758)
* Correct minor typo (#5764)
* Fix a markdown link to look properly on the web (#5769)
* [docs] Info about the help command usage (#5312)
* Info about the help command usage (#5312)
* Add missing merge labels for jekyllbot (#5753)
* Fix broken links in documentation (#5736)
* Docs: add `match_regex` and `replace_regex` filters (#5799)
@@ -446,10 +901,10 @@
* Site: exclude README.md and .gitignore (#5304)
* Add link to Staticman (#5224)
* Update url for OpenShift (#5320)
* [docs] add help for missing static_file e.g. on heroku (#5334)
* Add help for missing static_file e.g. on heroku (#5334)
* Add a line about updating theme-gems in the docs (#5318)
* Explain how to copy a theme's files (#5335)
* [docs] .md as default extension in examples (#5316)
* .md as default extension in examples (#5316)
* Fix small typo in docs (#5347)
* Add missing period to sentence in first paragraph. (#5372)
* added jekyll-spotify plugin (#5369)
@@ -458,7 +913,7 @@
* Add documentation for `relative_url` and `absolute_url` (#5405)
* Bugfix on logo in JSON-LD (#5421)
* Fix Travis.ci documentation (#5413)
* [docs] Update documentation regarding `bundle install` after `jekyll new` (#5428)
* Update documentation regarding `bundle install` after `jekyll new` (#5428)
* Replace classic box-sizing reset with inheritance reset (#5411)
* Update Wikipedia YAML list link (#5452)
* Add Jekyll 3.3 release post (#5442)
@@ -468,9 +923,9 @@
* Update appveyor.yml and fix optional deps for Ruby x64 (#5180)
* Improve tests for Jekyll::PluginManager (#5167)
* Update Ruby versions in travis.yml (#5221)
* Avoid installing unecessary gems for site testing (#5272)
* Avoid installing unnecessary gems for site testing (#5272)
* Proposal: Affinity teams and their captains (#5273)
* Replace duplicate with postive local test in issue template (#5286)
* Replace duplicate with positive local test in issue template (#5286)
* Update AppVeyor config. (#5240)
* Execute jekyll from clone instead of defined binary when running 'script/default-site' (#5295)
* rubocop: lib/jekyll/document.rb complexity fixes (#5045)
@@ -514,7 +969,7 @@
* Allow collections to have documents that have no file extension (#4545)
* Add size property to `group_by` result (#4557)
* Site Template: Removed unnecessary nesting from `_base.scss` (#4637)
* Adding a debug log statment for skipped future documents. (#4558)
* Adding a debug log statement for skipped future documents. (#4558)
* Site Template: Changed main `<div>` to `<main>` and added accessibility info (#4636)
* Add array support to `where` filter (#4555)
* 'jekyll clean': also remove .sass-cache (#4652)
@@ -762,7 +1217,7 @@
* Fix broken links to the Code of Conduct (#4436)
* Upgrade notes: mention trailing slash in permalink; fixes #4440 (#4455)
* Add hooks to the plugin categories toc (#4463)
* [add note] Jekyll 3 requires newer version of Ruby. (#4461)
* Jekyll 3 requires newer version of Ruby. (#4461)
* Fix typo in upgrading docs (#4473)
* Add note about upgrading documentation on jekyllrb.com/help/ (#4484)
* Update Rake link (#4496)
@@ -823,14 +1278,14 @@
* utils/drops: update Drop to support `Utils.deep_merge_hashes` (#4289)
* Make sure jekyll/drops/drop is loaded first. (#4292)
* Convertible/Page/Renderer: use payload hash accessor & setter syntax for backwards-compatibility (#4311)
* Drop: fix hash setter precendence (#4312)
* Drop: fix hash setter precedence (#4312)
* utils: `has_yaml_header?` should accept files with extraneous spaces (#4290)
* Escape html from site.title and page.title in site template (#4307)
* Allow custom file extensions if defined in `permalink` YAML front matter (#4314)
* Fix deep_merge_hashes! handling of drops and hashes (#4359)
* Page should respect output extension of its permalink (#4373)
* Disable auto-regeneration when running server detached (#4376)
* Drop#[]: only use public_send for keys in the content_methods array (#4388)
* Drop#: only use public_send for keys in the content_methods array (#4388)
* Extract title from filename successfully when no date. (#4195)
### Development Fixes
@@ -1232,7 +1687,7 @@
### Site Enhancements
* Add `@alfredxing` to the `@jekyll/core` team. :tada: (#3218)
* Add @alfredxing to the @jekyll/core team. :tada: (#3218)
* Document the `-q` option for the `build` and `serve` commands (#3149)
* Fix some minor typos/flow fixes in documentation website content (#3165)
* Add `keep_files` to configuration documentation (#3162)

View File

@@ -1,6 +1,6 @@
The MIT License (MIT)
Copyright (c) 2008-2017 Tom Preston-Werner and Jekyll contributors
Copyright (c) 2008-2018 Tom Preston-Werner and Jekyll contributors
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal

View File

@@ -3,13 +3,13 @@
[![Gem Version](https://img.shields.io/gem/v/jekyll.svg)][ruby-gems]
[![Linux Build Status](https://img.shields.io/travis/jekyll/jekyll/master.svg?label=Linux%20build)][travis]
[![Windows Build status](https://img.shields.io/appveyor/ci/jekyll/jekyll/master.svg?label=Windows%20build)][appveyor]
[![Test Coverage](https://img.shields.io/codeclimate/coverage/github/jekyll/jekyll.svg)][coverage]
[![Code Climate](https://img.shields.io/codeclimate/github/jekyll/jekyll.svg)][codeclimate]
[![Dependency Status](https://img.shields.io/gemnasium/jekyll/jekyll.svg)][gemnasium]
[![Maintainability](https://api.codeclimate.com/v1/badges/8ba0cb5b17bb9848e128/maintainability)][codeclimate]
[![Test Coverage](https://api.codeclimate.com/v1/badges/8ba0cb5b17bb9848e128/test_coverage)][coverage]
[![Security](https://hakiri.io/github/jekyll/jekyll/master.svg)][hakiri]
[![Backers on Open Collective](https://opencollective.com/jekyll/backers/badge.svg)](#backers)
[![Sponsors on Open Collective](https://opencollective.com/jekyll/sponsors/badge.svg)](#sponsors)
[ruby-gems]: https://rubygems.org/gems/jekyll
[gemnasium]: https://gemnasium.com/jekyll/jekyll
[codeclimate]: https://codeclimate.com/github/jekyll/jekyll
[coverage]: https://codeclimate.com/github/jekyll/jekyll/coverage
[hakiri]: https://hakiri.io/github/jekyll/jekyll/master
@@ -22,7 +22,9 @@ Jekyll is a simple, blog-aware, static site generator perfect for personal, proj
Jekyll does what you tell it to do — no more, no less. It doesn't try to outsmart users by making bold assumptions, nor does it burden them with needless complexity and configuration. Put simply, Jekyll gets out of your way and allows you to concentrate on what truly matters: your content.
## Having trouble with OS X/macOS?
See: https://jekyllrb.com/philosophy
## Having trouble?
See: https://jekyllrb.com/docs/troubleshooting/
@@ -37,13 +39,13 @@ See: https://jekyllrb.com/docs/troubleshooting/
## Code of Conduct
In order to have a more open and welcoming community, Jekyll adheres to a
[code of conduct](CONDUCT.markdown) adapted from the Ruby on Rails code of
[code of conduct](CODE_OF_CONDUCT.markdown) adapted from the Ruby on Rails code of
conduct.
Please adhere to this code of conduct in any interactions you have in the
Jekyll community. It is strictly enforced on all official Jekyll
repositories, websites, and resources. If you encounter someone violating
these terms, please let a maintainer ([@parkr](https://github.com/parkr), [@envygeeks](https://github.com/envygeeks), [@mattr-](https://github.com/mattr-), or [@alfredxing](https://github.com/alfredxing)) know and we will address it as soon as possible.
these terms, please let one of our [core team members](https://jekyllrb.com/team/#core-team) know and we will address it as soon as possible.
## Diving In
@@ -54,6 +56,28 @@ these terms, please let a maintainer ([@parkr](https://github.com/parkr), [@envy
* Use the built-in [Liquid Extensions](https://jekyllrb.com/docs/templates/) to make your life easier
* Use custom [Plugins](https://jekyllrb.com/docs/plugins/) to generate content specific to your site
## Credits
### Contributors
This project exists thanks to all the people who contribute.
<a href="graphs/contributors"><img src="https://opencollective.com/jekyll/contributors.svg?width=890&button=false" /></a>
### Backers
Thank you to all our backers! 🙏 [Become a backer](https://opencollective.com/jekyll#backer)
<a href="https://opencollective.com/jekyll#backers" target="_blank"><img src="https://opencollective.com/jekyll/backers.svg?width=890" /></a>
### Sponsors
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor!](https://opencollective.com/jekyll#sponsor)
<a href="https://opencollective.com/jekyll/sponsor/0/website" target="_blank"><img src="https://opencollective.com/jekyll/sponsor/0/avatar.svg" /></a>
<a href="https://opencollective.com/jekyll/sponsor/1/website" target="_blank"><img src="https://opencollective.com/jekyll/sponsor/1/avatar.svg" /></a>
<a href="https://opencollective.com/jekyll/sponsor/2/website" target="_blank"><img src="https://opencollective.com/jekyll/sponsor/2/avatar.svg" /></a>
## License
See the [LICENSE](https://github.com/jekyll/jekyll/blob/master/LICENSE) file.

View File

@@ -1,3 +1,5 @@
# frozen_string_literal: true
require "rubygems"
require "rake"
require "rdoc"
@@ -44,19 +46,13 @@ def normalize_bullets(markdown)
end
def linkify_prs(markdown)
markdown.gsub(%r!#(\d+)!) do |word|
markdown.gsub(%r!(?<\!&)#(\d+)!) do |word|
"[#{word}]({{ site.repository }}/issues/#{word.delete("#")})"
end
end
def linkify_users(markdown)
markdown.gsub(%r!(@\w+)!) do |username|
"[#{username}](https://github.com/#{username.delete("@")})"
end
end
def linkify(markdown)
linkify_users(linkify_prs(markdown))
linkify_prs(markdown)
end
def liquid_escape(markdown)
@@ -70,11 +66,11 @@ def custom_release_header_anchors(markdown)
_, major, minor, patch = *release_notes.match(header_regexp)
release_notes
.gsub(header_regexp, "\\0\n{: #v\\1-\\2-\\3}")
.gsub(section_regexp) { |section| "#{section}\n{: ##{sluffigy(section)}-v#{major}-#{minor}-#{patch}}" }
.gsub(section_regexp) { |section| "#{section}\n{: ##{slugify(section)}-v#{major}-#{minor}-#{patch}}" }
end.join("\n## ")
end
def sluffigy(header)
def slugify(header)
header.delete("#").strip.downcase.gsub(%r!\s+!, "-")
end
@@ -99,7 +95,7 @@ def siteify_file(file, overrides_front_matter = {})
abort "You seem to have misplaced your #{file} file. I can haz?" unless File.exist?(file)
title = begin
File.read(file).match(%r!\A# (.*)$!)[1]
rescue
rescue NoMethodError
File.basename(file, ".*").downcase.capitalize
end
slug = File.basename(file, ".markdown").downcase

View File

@@ -16,20 +16,18 @@ install:
environment:
BUNDLE_WITHOUT: "benchmark:site:development"
matrix:
- RUBY_FOLDER_VER: "24"
- RUBY_FOLDER_VER: "25"
TEST_SUITE: "test"
- RUBY_FOLDER_VER: "25"
TEST_SUITE: "cucumber"
- RUBY_FOLDER_VER: "25"
TEST_SUITE: "default-site"
- RUBY_FOLDER_VER: "25-x64"
TEST_SUITE: "test"
- RUBY_FOLDER_VER: "24"
TEST_SUITE: "cucumber"
- RUBY_FOLDER_VER: "24"
TEST_SUITE: "default-site"
- RUBY_FOLDER_VER: "24-x64"
TEST_SUITE: "test"
- RUBY_FOLDER_VER: "23"
TEST_SUITE: "test"
- RUBY_FOLDER_VER: "22"
TEST_SUITE: "test"
- RUBY_FOLDER_VER: "21"
TEST_SUITE: "test"
test_script:
- ruby --version

101
benchmark/conditional_liquid.rb Executable file
View File

@@ -0,0 +1,101 @@
#!/usr/bin/env ruby
# frozen_string_literal: true
require "liquid"
require "benchmark/ips"
# Test if processing content string without any Liquid constructs, via Liquid,
# is slower than checking whether constructs exist ( using `String#include?` )
# and return-ing the "plaintext" content string as is..
#
# Ref: https://github.com/jekyll/jekyll/pull/6735
# Sample contents
WITHOUT_LIQUID = <<-TEXT.freeze
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Fusce auctor libero at
pharetra tempus. Etiam bibendum magna et metus fermentum, eu cursus lorem
mattis. Curabitur vel dui et lacus rutrum suscipit et eget neque.
Nullam luctus fermentum est id blandit. Phasellus consectetur ullamcorper
ligula, at finibus eros laoreet id. Etiam sit amet est in libero efficitur
tristique. Ut nec magna augue. Quisque ut fringilla lacus, ac dictum enim.
Aliquam vel ornare mauris. Suspendisse ornare diam tempor nulla facilisis
aliquet. Sed ultrices placerat ultricies.
TEXT
WITH_LIQUID = <<-LIQUID.freeze
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Fusce auctor libero at
pharetra tempus. {{ author }} et metus fermentum, eu cursus lorem
mattis. Curabitur vel dui et lacus rutrum suscipit et eget neque.
Nullam luctus fermentum est id blandit. Phasellus consectetur ullamcorper
ligula, {% if author == "Jane Doe" %} at finibus eros laoreet id. {% else %}
Etiam sit amet est in libero efficitur.{% endif %}
tristique. Ut nec magna augue. Quisque ut fringilla lacus, ac dictum enim.
Aliquam vel ornare mauris. Suspendisse ornare diam tempor nulla facilisis
aliquet. Sed ultrices placerat ultricies.
LIQUID
WITH_JUST_LIQUID_VAR = <<-LIQUID.freeze
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Fusce auctor libero at
pharetra tempus. et metus fermentum, eu cursus lorem, ac dictum enim.
mattis. Curabitur vel dui et lacus rutrum suscipit et {{ title }} neque.
Nullam luctus fermentum est id blandit. Phasellus consectetur ullamcorper
ligula, at finibus eros laoreet id. Etiam sit amet est in libero efficitur.
tristique. Ut nec magna augue. {{ author }} Quisque ut fringilla lacus
Aliquam vel ornare mauris. Suspendisse ornare diam tempor nulla facilisis
aliquet. Sed ultrices placerat ultricies.
LIQUID
SUITE = {
:"plain text" => WITHOUT_LIQUID,
:"tags n vars" => WITH_LIQUID,
:"just vars" => WITH_JUST_LIQUID_VAR,
}.freeze
# Mimic how Jekyll's LiquidRenderer would process a non-static file, with
# some dummy payload
def always_liquid(content)
Liquid::Template.error_mode = :warn
Liquid::Template.parse(content, :line_numbers => true).render(
"author" => "John Doe",
"title" => "FooBar"
)
end
# Mimic how the proposed change would first execute a couple of checks and
# proceed to process with Liquid if necessary
def conditional_liquid(content)
return content if content.nil? || content.empty?
return content unless content.include?("{%") || content.include?("{{")
always_liquid(content)
end
# Test https://github.com/jekyll/jekyll/pull/6735#discussion_r165499868
# ------------------------------------------------------------------------
def check_with_regex(content)
!content.to_s.match?(%r!{[{%]!)
end
def check_with_builtin(content)
content.include?("{%") || content.include?("{{")
end
SUITE.each do |key, text|
Benchmark.ips do |x|
x.report("regex-check - #{key}") { check_with_regex(text) }
x.report("builtin-check - #{key}") { check_with_builtin(text) }
x.compare!
end
end
# ------------------------------------------------------------------------
# Let's roll!
SUITE.each do |key, text|
Benchmark.ips do |x|
x.report("always thru liquid - #{key}") { always_liquid(text) }
x.report("conditional liquid - #{key}") { conditional_liquid(text) }
x.compare!
end
end

29
benchmark/local-require Executable file
View File

@@ -0,0 +1,29 @@
#!/usr/bin/env ruby
# frozen_string_literal: true
require 'benchmark/ips'
require 'jekyll'
require 'json'
DATA = {"foo"=>"bar", "alpha"=>{"beta"=>"gamma"}, "lipsum"=>["lorem", "ipsum", "dolor"]}
def local_require
require 'json'
JSON.pretty_generate(DATA)
end
def global_require
JSON.pretty_generate(DATA)
end
def graceful_require
Jekyll::External.require_with_graceful_fail("json")
JSON.pretty_generate(DATA)
end
Benchmark.ips do |x|
x.report("local-require") { local_require }
x.report("global-require") { global_require }
x.report("graceful-require") { graceful_require }
x.compare!
end

View File

@@ -0,0 +1,33 @@
#!/usr/bin/env ruby
# -------------------------------------------------------------------
# Benchmarking changes in https://github.com/jekyll/jekyll/pull/6767
# -------------------------------------------------------------------
require 'benchmark/ips'
require 'pathutil'
DOC_PATH = File.join(File.expand_path(__dir__), "_puppies", "rover.md")
COL_PATH = File.join(File.expand_path(__dir__), "_puppies")
def pathutil_relative
Pathutil.new(DOC_PATH).relative_path_from(COL_PATH).to_s
end
def native_relative
DOC_PATH.sub("#{COL_PATH}/", "")
end
if pathutil_relative == native_relative
Benchmark.ips do |x|
x.report("pathutil") { pathutil_relative }
x.report("native") { native_relative }
x.compare!
end
else
print "PATHUTIL: "
puts pathutil_relative
print "NATIVE: "
puts native_relative
end

View File

@@ -1,36 +0,0 @@
#!/usr/bin/env ruby
# frozen_string_literal: true
require "benchmark/ips"
require "benchmark/memory"
GC.disable
PERIOD = "."
PROPERTY_AS_HASH = ["hello", "there_oh", "friends"]
property = "hello.there_oh.friends"
item = Hash.new { |h, k| h[k] = Hash.new(&h.default_proc) }
def candidate(property, item)
property.to_s.split(".".freeze).each_with_object(item) do |attribute, memo|
memo = memo[attribute]
end
end
def control(property, item)
property.to_s.split(".").reduce(item) do |subvalue, attribute|
subvalue[attribute]
end
end
Benchmark.ips do |x|
x.report("candidate") { candidate(property, item) }
x.report("control") { control(property, item) }
x.compare!
end
Benchmark.memory do |x|
x.report("candidate") { candidate(property, item) }
x.report("control") { control(property, item) }
x.compare!
end

26
benchmark/sanitize-url.rb Executable file
View File

@@ -0,0 +1,26 @@
#!/usr/bin/env ruby
require "benchmark/ips"
PATH = "/../../..../...//.....//lorem/ipsum//dolor///sit.xyz"
def sanitize_with_regex
"/" + PATH.gsub(%r!/{2,}!, "/").gsub(%r!\.+/|\A/+!, "")
end
def sanitize_with_builtin
"/#{PATH}".gsub("..", "/").gsub("./", "").squeeze("/")
end
if sanitize_with_regex == sanitize_with_builtin
Benchmark.ips do |x|
x.report("sanitize w/ regexes") { sanitize_with_regex }
x.report("sanitize w/ builtin") { sanitize_with_builtin }
x.compare!
end
else
puts "w/ regexes: #{sanitize_with_regex}"
puts "w/ builtin: #{sanitize_with_builtin}"
puts ""
puts "Thank you. Do try again :("
end

View File

@@ -0,0 +1,115 @@
#!/usr/bin/env ruby
# frozen_string_literal: true
#
# The Ruby documentation for #sort_by describes what's called a Schwartzian transform:
#
# > A more efficient technique is to cache the sort keys (modification times in this case)
# > before the sort. Perl users often call this approach a Schwartzian transform, after
# > Randal Schwartz. We construct a temporary array, where each element is an array
# > containing our sort key along with the filename. We sort this array, and then extract
# > the filename from the result.
# > This is exactly what sort_by does internally.
#
# The well-documented efficiency of sort_by is a good reason to use it. However, when a property
# does not exist on an item being sorted, it can cause issues (no nil's allowed!)
# In Jekyll::Filters#sort_input, we extract the property in each iteration of #sort,
# which is quite inefficient! How inefficient? This benchmark will tell you just how, and how much
# it can be improved by using the Schwartzian transform. Thanks, Randall!
require 'benchmark/ips'
require 'minitest'
require File.expand_path("../lib/jekyll", __dir__)
def site
@site ||= Jekyll::Site.new(
Jekyll.configuration("source" => File.expand_path("../docs", __dir__))
).tap(&:reset).tap(&:read)
end
def site_docs
site.collections["docs"].docs.dup
end
def sort_by_property_directly(docs, meta_key)
docs.sort! do |apple, orange|
apple_property = apple[meta_key]
orange_property = orange[meta_key]
if !apple_property.nil? && !orange_property.nil?
apple_property <=> orange_property
elsif !apple_property.nil? && orange_property.nil?
-1
elsif apple_property.nil? && !orange_property.nil?
1
else
apple <=> orange
end
end
end
def schwartzian_transform(docs, meta_key)
docs.collect! { |d|
[d[meta_key], d]
}.sort! { |apple, orange|
if !apple[0].nil? && !orange[0].nil?
apple.first <=> orange.first
elsif !apple[0].nil? && orange[0].nil?
-1
elsif apple[0].nil? && !orange[0].nil?
1
else
apple[-1] <=> orange[-1]
end
}.collect! { |d| d[-1] }
end
# Before we test efficiency, do they produce the same output?
class Correctness
include Minitest::Assertions
require "pp"
define_method :mu_pp, &:pretty_inspect
attr_accessor :assertions
def initialize(docs, property)
@assertions = 0
@docs = docs
@property = property
end
def assert!
assert sort_by_property_directly(@docs, @property).is_a?(Array), "sort_by_property_directly must return an array"
assert schwartzian_transform(@docs, @property).is_a?(Array), "schwartzian_transform must return an array"
assert_equal sort_by_property_directly(@docs, @property),
schwartzian_transform(@docs, @property)
puts "Yeah, ok, correctness all checks out for property #{@property.inspect}"
end
end
Correctness.new(site_docs, "redirect_from".freeze).assert!
Correctness.new(site_docs, "title".freeze).assert!
# First, test with a property only a handful of documents have.
Benchmark.ips do |x|
x.config(time: 10, warmup: 5)
x.report('sort_by_property_directly with sparse property') do
sort_by_property_directly(site_docs, "redirect_from".freeze)
end
x.report('schwartzian_transform with sparse property') do
schwartzian_transform(site_docs, "redirect_from".freeze)
end
x.compare!
end
# Next, test with a property they all have.
Benchmark.ips do |x|
x.config(time: 10, warmup: 5)
x.report('sort_by_property_directly with non-sparse property') do
sort_by_property_directly(site_docs, "title".freeze)
end
x.report('schwartzian_transform with non-sparse property') do
schwartzian_transform(site_docs, "title".freeze)
end
x.compare!
end

View File

@@ -27,9 +27,6 @@ sitemap: false
<li>
<a href="/news/">News</a>
</li>
<li>
<a href="/community/">Community</a>
</li>
<li>
<a href="/help/">Help</a>
</li>

View File

@@ -1,60 +1,48 @@
markdown: kramdown
highlighter: rouge
sass:
style: compressed
gauges_id: 503c5af6613f5d0f19000027
google_analytics_id: UA-50755011-1
google_site_verification: onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY
repository: https://github.com/jekyll/jekyll
help_url: https://github.com/jekyll/jekyll-help
timezone: America/Los_Angeles
defaults:
-
scope:
path: "_docs"
type: "docs"
values:
layout: "docs"
-
scope:
path: "_posts"
type: "posts"
values:
layout: "news_item"
collections:
docs:
permalink: /:collection/:path/
output: true
posts:
permalink: /news/:year/:month/:day/:title/
output: true
tutorials:
output: true
---
version: 3.8.3
name: Jekyll • Simple, blog-aware, static sites
description: Transform your plain text into static websites and blogs
url: https://jekyllrb.com
repository: https://github.com/jekyll/jekyll
timezone: America/Los_Angeles
twitter:
username: jekyllrb
logo: /img/logo-2x.png
gems:
- jekyll-avatar
- jekyll-feed
- jekyll-mentions
- jekyll-redirect-from
- jekyll-seo-tag
- jekyll-sitemap
- jemoji
logo: "/img/logo-2x.png"
google_analytics_id: UA-50755011-1
google_site_verification: onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY
collections:
docs:
permalink: "/:collection/:path/"
output: true
posts:
permalink: "/news/:year/:month/:day/:title/"
output: true
tutorials:
output: true
defaults:
- scope:
path: _docs
type: docs
values:
layout: docs
- scope:
path: _posts
type: posts
values:
layout: news_item
image: "/img/twitter-card.png"
plugins:
- jekyll-avatar
- jekyll-feed
- jekyll-mentions
- jekyll-redirect-from
- jekyll-seo-tag
- jekyll-sitemap
- jemoji
sass:
style: compressed
exclude:
- .gitignore
- README.md
- ".gitignore"
- CNAME
- icomoon-selection.json
- readme.md

15
docs/_data/sponsors.yml Normal file
View File

@@ -0,0 +1,15 @@
- name: Forestry.io
image: /img/forestry-logo.png
url: https://forestry.io
width: 140
height: 30
- name: CloudCannon
image: /img/cloudcannon-logo.png
url: https://cloudcannon.com
width: 75
height: 30
- name: Siteleaf
image: /img/siteleaf-logo.png
url: https://siteleaf.com
width: 40
height: 50

View File

@@ -1,10 +1,12 @@
- title: Tutorials
tutorials:
- home
- video-walkthroughs
- navigation
- orderofinterpretation
- custom-404-page
- convert-site-to-jekyll
- using-jekyll-with-bundler
#- title: Another section
# tutorials:

View File

@@ -53,7 +53,7 @@ sass:
The Sass converter will default the `sass_dir` configuration option to
`_sass`.
[example-sass]: https://github.com/jekyll/jekyll-sass-converter/tree/master/example
[example-sass]: https://github.com/jekyll/jekyll-sass-converter/tree/master/docs
<div class="note info">
<h5>The <code>sass_dir</code> is only used by Sass</h5>

View File

@@ -1,4 +1,10 @@
# Code of Conduct
---
title: Code of Conduct
permalink: "/docs/code_of_conduct/"
note: This file is autogenerated. Edit /CODE_OF_CONDUCT.markdown instead.
redirect_from: "/conduct/index.html"
editable: false
---
As contributors and maintainers of this project, and in the interest of
fostering an open and welcoming community, we pledge to respect all people who

View File

@@ -46,6 +46,21 @@ defaults:
layout: page
```
<div class="note">
<h5>Gather your collections {%- include docs_version_badge.html version="3.7.0" -%}</h5>
<p>You can optionally specify a directory to store all your collections in the same place with <code>collections_dir: my_collections</code>.</p>
<p>Then Jekyll will look in <code>my_collections/_books</code> for the <code>books</code> collection, and
in <code>my_collections/_recipes</code> for the <code>recipes</code> collection.</p>
</div>
<div class="note warning">
<h5>Be sure to move drafts and posts into custom collections directory</h5>
<p>If you specify a directory to store all your collections in the same place with <code>collections_dir: my_collections</code>, then you will need to move your <code>_drafts</code> and <code>_posts</code> directory to <code>my_collections/_drafts</code> and <code>my_collections/_posts</code>. Note that, the name of your collections directory cannot start with an underscore (`_`).</p>
</div>
### Step 2: Add your content {#step2}
Create a corresponding folder (e.g. `<source>/_my_collection`) and add
@@ -78,6 +93,20 @@ For example, if you have `_my_collection/some_subdir/some_doc.md`,
it will be rendered using Liquid and the Markdown converter of your
choice and written out to `<dest>/my_collection/some_subdir/some_doc.html`.
If you wish a specific page to be shown when accessing `/my_collection/`,
simply add `permalink: /my_collection/index.html` to a page.
To list items from the collection, on that page or any other, you can use:
{% raw %}
```liquid
{% for item in site.my_collection %}
<h2>{{ item.title }}</h2>
<p>{{ item.description }}</p>
<p><a href="{{ item.url }}">{{ item.title }}</a></p>
{% endfor %}
```
{% endraw %}
<div class="note info">
<h5>Don't forget to add YAML for processing</h5>
<p>
@@ -111,7 +140,7 @@ _my_collection/
each of the following `permalink` configurations will produce the document structure shown below it.
* **Default**
* **Default**
Same as `permalink: /:collection/:path`.
```
@@ -121,7 +150,7 @@ each of the following `permalink` configurations will produce the document struc
│   └── some_doc.html
...
```
* `permalink: pretty`
* `permalink: pretty`
Same as `permalink: /:collection/:path/`.
```
@@ -198,7 +227,13 @@ each of the following `permalink` configurations will produce the document struc
<p><code>:title</code></p>
</td>
<td>
<p>The document's lowercase title (as defined in its <a href="/docs/frontmatter/">front matter</a>), with every sequence of spaces and non-alphanumeric characters replaced by a hyphen. If the document does not define a title in its <a href="/docs/frontmatter/">front matter</a>, this is equivalent to <code>name</code>.</p>
<p>
The <code>:title</code> template variable will take the
<code>slug</code> <a href="/docs/frontmatter/">front matter</a>
variable value if any is present in the document; if none is
defined then <code>:title</code> will be equivalent to
<code>:name</code>, aka the slug generated from the filename.
</p>
</td>
</tr>
<tr>
@@ -219,7 +254,7 @@ each of the following `permalink` configurations will produce the document struc
Each collection is accessible as a field on the `site` variable. For example, if
you want to access the `albums` collection found in `_albums`, you'd use
`site.albums`.
`site.albums`.
Each collection is itself an array of documents (e.g., `site.albums` is an array of documents, much like `site.pages` and
`site.posts`). See the table below for how to access attributes of those documents.
@@ -304,15 +339,29 @@ you specified in your `_config.yml` (if present) and the following information:
<div class="note info">
<h5>A Hard-Coded Collection</h5>
<p>In addition to any collections you create yourself, the
<code>posts</code> collection is hard-coded into Jekyll. It exists whether
you have a <code>_posts</code> directory or not. This is something to note
when iterating through <code>site.collections</code> as you may need to
<p>In addition to any collections you create yourself, the
<code>posts</code> collection is hard-coded into Jekyll. It exists whether
you have a <code>_posts</code> directory or not. This is something to note
when iterating through <code>site.collections</code> as you may need to
filter it out.</p>
<p>You may wish to use filters to find your collection:
<code>{% raw %}{{ site.collections | where: "label", "myCollection" | first }}{% endraw %}</code></p>
</div>
<div class="note info">
<h5>Collections and Time</h5>
<p>Except for documents in hard-coded default collection <code>posts</code>, all documents in collections
you create, are accessible via Liquid irrespective of their assigned date, if any, and therefore renderable.
</p>
<p>However documents are attempted to be written to disk only if the concerned collection
metadata has <code>output: true</code>. Additionally, future-dated documents are only written if
<code>site.future</code> <em>is also true</em>.
</p>
<p>More fine-grained control over documents being written to disk can be exercised by setting
<code>published: false</code> (<em><code>true</code> by default</em>) in the document's front matter.
</p>
</div>
### Documents
@@ -437,7 +486,7 @@ works:
Every album in the collection could be listed on a single page with a template:
```html
```liquid
{% raw %}
{% for album in site.albums %}
<h2>{{ album.title }}</h2>

View File

@@ -108,7 +108,7 @@ class="flag">flags</code> (specified on the command-line) that control them.
<a href="https://en.wikipedia.org/wiki/Tz_database">IANA Time Zone
Database</a> is valid, e.g. <code>America/New_York</code>. A list of all
available values can be found <a href="https://en.wikipedia.org/wiki/List_of_tz_database_time_zones">
here</a>. The default is the local time zone, as set by your operating system.
here</a>. When serving on a local machine, the default time zone is set by your operating system. But when served on a remote host/server, the default time zone depends on the server's setting or location.
</p>
</td>
<td class="align-center">
@@ -518,7 +518,7 @@ defaults:
-
scope:
path: ""
type: "posts"
type: "pages"
values:
layout: "my-site"
-
@@ -530,7 +530,7 @@ defaults:
author: "Mr. Hyde"
```
With these defaults, all posts would use the `my-site` layout. Any html files that exist in the `projects/` folder will use the `project` layout, if it exists. Those files will also have the `page.author` [liquid variable](../variables/) set to `Mr. Hyde`.
With these defaults, all pages would use the `my-site` layout. Any html files that exist in the `projects/` folder will use the `project` layout, if it exists. Those files will also have the `page.author` [liquid variable](../variables/) set to `Mr. Hyde`.
```yaml
collections:
@@ -549,11 +549,39 @@ defaults:
In this example, the `layout` is set to `default` inside the
[collection](../collections/) with the name `my_collection`.
### Glob patterns in Front Matter defaults
It is also possible to use glob patterns (currently limited to patterns that contain `*`) when matching defaults. For example, it is possible to set specific layout for each `special-page.html` in any subfolder of `section` folder. {%- include docs_version_badge.html version="3.7.0" -%}
```yaml
collections:
my_collection:
output: true
defaults:
-
scope:
path: "section/*/special-page.html"
values:
layout: "specific-layout"
```
<div class="note warning">
<h5>Globbing and Performance</h5>
<p>
Please note that globbing a path is known to have a negative effect on
performance and is currently not optimized, especially on Windows.
Globbing a path will increase your build times in proportion to the size
of the associated collection directory.
</p>
</div>
### Precedence
Jekyll will apply all of the configuration settings you specify in the `defaults` section of your `_config.yml` file. However, you can choose to override settings from other scope/values pair by specifying a more specific path for the scope.
You can see that in the second to last example above. First, we set the default layout to `my-site`. Then, using a more specific path, we set the default layout for files in the `projects/` path to `project`. This can be done with any value that you would set in the page or post front matter.
You can see that in the second to last example above. First, we set the default page layout to `my-site`. Then, using a more specific path, we set the default layout for pages in the `projects/` path to `project`. This can be done with any value that you would set in the page or post front matter.
Finally, if you set defaults in the site configuration by adding a `defaults` section to your `_config.yml` file, you can override those settings in a post or page file. All you need to do is specify the settings in the post or page front matter. For example:
@@ -602,23 +630,24 @@ file or on the command-line.
```yaml
# Where things are
source: .
destination: ./_site
plugins_dir: _plugins
layouts_dir: _layouts
data_dir: _data
includes_dir: _includes
source: .
destination: ./_site
collections_dir: .
plugins_dir: _plugins
layouts_dir: _layouts
data_dir: _data
includes_dir: _includes
collections:
posts:
output: true
# Handling Reading
safe: false
include: [".htaccess"]
exclude: ["Gemfile", "Gemfile.lock", "node_modules", "vendor/bundle/", "vendor/cache/", "vendor/gems/", "vendor/ruby/"]
keep_files: [".git", ".svn"]
encoding: "utf-8"
markdown_ext: "markdown,mkdown,mkdn,mkd,md"
safe: false
include: [".htaccess"]
exclude: ["Gemfile", "Gemfile.lock", "node_modules", "vendor/bundle/", "vendor/cache/", "vendor/gems/", "vendor/ruby/"]
keep_files: [".git", ".svn"]
encoding: "utf-8"
markdown_ext: "markdown,mkdown,mkdn,mkd,md"
strict_front_matter: false
# Filtering Content
@@ -655,7 +684,9 @@ verbose: false
defaults: []
liquid:
error_mode: warn
error_mode: warn
strict_filters: false
strict_variables: false
# Markdown Processors
rdiscount:
@@ -665,13 +696,14 @@ redcarpet:
extensions: []
kramdown:
auto_ids: true
entity_output: as_char
toc_levels: 1..6
smart_quotes: lsquo,rsquo,ldquo,rdquo
input: GFM
hard_wrap: false
footnote_nr: 1
auto_ids: true
entity_output: as_char
toc_levels: 1..6
smart_quotes: lsquo,rsquo,ldquo,rdquo
input: GFM
hard_wrap: false
footnote_nr: 1
show_warnings: false
```
## Liquid Options
@@ -683,6 +715,14 @@ options are
- `warn` --- Output a warning on the console for each error.
- `strict` --- Output an error message and stop the build.
You can also configure Liquid's renderer to catch non-assigned variables and
non-existing filters by setting `strict_variables` and / or `strict_filters`
to `true` respectively. {% include docs_version_badge.html version="3.8.0" %}
Do note that while `error_mode` configures Liquid's parser, the `strict_variables`
and `strict_filters` options configure Liquid's renderer and are consequently,
mutually exclusive.
## Markdown Options
The various Markdown renderers supported by Jekyll sometimes have extra options

View File

@@ -1,10 +1,10 @@
---
title: "BuddyWorks"
title: "Buddy"
---
[BuddyWorks][buddyworks-homepage] is a [Docker][docker-homepage]-based CI server that you can set up in 15-20 minutes to build, test, and deploy your Jekyll websites. It supports [GitHub][github-homepage], [Bitbucket][bitbucket-homepage], and [GitLab][gitlab-homepage] repositories, and can be installed on-premises or used in cloud. The following guide will show you how to set up a free environment to build and test your Jekyll project.
[Buddy][buddy-homepage] is a [Docker][docker-homepage]-based CI server that you can set up in 15-20 minutes to build, test, and deploy your Jekyll websites. It supports [GitHub][github-homepage], [Bitbucket][bitbucket-homepage], and [GitLab][gitlab-homepage] repositories, and can be installed on-premises or used in cloud. The following guide will show you how to set up a free environment to build and test your Jekyll project.
[buddyworks-homepage]: https://buddy.works
[buddy-homepage]: https://buddy.works
[docker-homepage]: https://www.docker.com/
[github-homepage]: https://github.com
[bitbucket-homepage]: https://bitbucket.org/
@@ -12,7 +12,7 @@ title: "BuddyWorks"
## 1. Getting started
1. Log in at [https://buddy.works](https://buddy.works) with your GitHub/Bitbucket account or email
1. Log in at [https://buddy.works][buddy-homepage] with your GitHub/Bitbucket account or email
2. Choose your Git provider and select or push your Jekyll Project
3. Create a new pipeline and set the trigger mode to 'On every push'
4. Add and configure the Jekyll action and save the pipeline
@@ -29,7 +29,7 @@ Whenever you make a push to the selected branch, the Jekyll action runs `jekyll
If you prefer configuration as code over GUI, you can generate a `buddy.yml` that will create a pipeline with the Jekyll action once you push it to the target branch:
```ruby
```yaml
- pipeline: "Build and Deploy Jekyll site"
trigger_mode: "ON_EVERY_PUSH"
ref_name: "master"
@@ -45,7 +45,7 @@ If you prefer configuration as code over GUI, you can generate a `buddy.yml` tha
## 4. Setting up on-premises server
The self-hosted version of BuddyWorks can be installed on any type of server supporting Docker, including [Linux][bw-linux], [Mac][bw-mac], [AWS EC2][bw-aws-ec2], [DigitalOcean][bw-digitalocean], and [Microsoft Azure][bw-azure].
The self-hosted version of Buddy can be installed on any type of server supporting Docker, including [Linux][bw-linux], [Mac][bw-mac], [AWS EC2][bw-aws-ec2], [DigitalOcean][bw-digitalocean], and [Microsoft Azure][bw-azure].
[bw-linux]: https://buddy.works/knowledge/standalone/installation-linux
[bw-mac]: https://buddy.works/knowledge/standalone/installation-mac-osx
@@ -55,8 +55,8 @@ The self-hosted version of BuddyWorks can be installed on any type of server sup
## 5. Questions?
This entire guide is open-source. Go ahead and [edit it][jekyll-docs-ci-buddyworks] if you want to expand it or have a fix or [ask for help][jekyll-help] if you run into trouble and need assistance. BuddyWorks also has an [online community][buddyworks-forum] for help.
This entire guide is open-source. Go ahead and [edit it][jekyll-docs-ci-buddy] if you want to expand it or have a fix or [ask for help][jekyll-help] if you run into trouble and need assistance. Buddy also has an [online community][buddy-forum] for help.
[jekyll-docs-ci-buddyworks]: https://github.com/jekyll/jekyll/edit/master/docs/_docs/continuous-integration/buddyworks.md
[jekyll-docs-ci-buddy]: https://github.com/jekyll/jekyll/edit/master/docs/_docs/continuous-integration/buddyworks.md
[jekyll-help]: https://jekyllrb.com/help/
[buddyworks-forum]: http://forum.buddy.works/
[buddy-forum]: http://forum.buddy.works/

View File

@@ -25,7 +25,7 @@ The easiest way to manage dependencies for a Jekyll project (with or without Cir
[4]: http://bundler.io/gemfile.html
```yaml
```ruby
source 'https://rubygems.org'
ruby '2.4.0'
@@ -40,7 +40,7 @@ CircleCI detects when `Gemfile` is present is will automatically run `bundle ins
The most basic test that can be run is simply seeing if `jekyll build` actually works. This is a blocker, a dependency if you will, for other tests you might run on the generate site. So we'll run Jekyll, via Bundler, in the `dependencies` phase.
```
```yaml
dependencies:
post:
- bundle exec jekyll build
@@ -61,9 +61,9 @@ test:
## Complete Example circle.yml File
When you put it all together, here's an example of what that `circle.yml` file could look like:
When you put it all together, here's an example of what that `circle.yml` file could look like in v1:
```
```yaml
machine:
environment:
NOKOGIRI_USE_SYSTEM_LIBRARIES: true # speeds up installation of html-proofer
@@ -83,6 +83,75 @@ deployment:
- rsync -va --delete ./_site username@my-website:/var/html
```
for CircleCI v2, a Docker-based system which new projects will follow, set the `S3_BUCKET_NAME` environment variable (an example of the required config file is shown below).
```yaml
defaults: &defaults
working_directory: ~/repo
version: 2
jobs:
build:
<<: *defaults
docker:
- image: circleci/ruby:2.5
environment:
BUNDLE_PATH: ~/repo/vendor/bundle
steps:
- checkout
- restore_cache:
keys:
- rubygems-v1-{% raw %}{{ checksum "Gemfile.lock" }}{% endraw %}
- rubygems-v1-fallback
- run:
name: Bundle Install
command: bundle check || bundle install
- run:
name: HTMLProofer tests
command: |
bundle exec htmlproofer ./_site \
--allow-hash-href \
--check-favicon \
--check-html \
--disable-external
- save_cache:
key: rubygems-v1-{% raw %}{{ checksum "Gemfile.lock" }}{% endraw %}
paths:
- vendor/bundle
- run:
name: Jekyll build
command: bundle exec jekyll build
- persist_to_workspace:
root: ./
paths:
- _site
deploy:
<<: *defaults
docker:
- image: circleci/python:3.6.3
environment:
S3_BUCKET_NAME: <<YOUR BUCKET NAME HERE>>
steps:
- attach_workspace:
at: ./
- run:
name: Install AWS CLI
command: pip install awscli --upgrade --user
- run:
name: Upload to s3
command: ~/.local/bin/aws s3 sync ./_site s3://$S3_BUCKET_NAME/ --delete --acl public-read
workflows:
version: 2
test-deploy:
jobs:
- build
- deploy:
requires:
- build
filters:
branches:
only: master
```
## Questions?
This entire guide is open-source. Go ahead and [edit it][7] if you have a fix or [ask for help][8] if you run into trouble and need some help. CircleCI also has an [online community][9] for help.

View File

@@ -7,4 +7,4 @@ Continuous Integration (CI) enables you to publish your Jekyll generated website
* [Travis CI](travis-ci)
* [CircleCI](circleci)
* [BuddyWorks](buddyworks)
* [Buddy](buddyworks)

View File

@@ -49,7 +49,7 @@ Some options can be specified via command-line switches. Check out the
For example to avoid testing external sites, use this command:
```sh
$ bundle exec htmlproofer ./_site --disable-external
bundle exec htmlproofer ./_site --disable-external
```
### The HTML Proofer Library
@@ -76,7 +76,7 @@ with Ruby and requires RubyGems to install, we use the Ruby language build
environment. Below is a sample `.travis.yml` file, followed by
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:
**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. Here is an example `Gemfile` with two referenced gems, "jekyll" and "html-proofer":
```ruby
source "https://rubygems.org"
@@ -90,7 +90,7 @@ Your `.travis.yml` file should look like this:
```yaml
language: ruby
rvm:
- 2.3.3
- 2.4.1
before_script:
- chmod +x ./script/cibuild # or do this locally and commit
@@ -110,6 +110,12 @@ 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
cache: bundler # caching bundler gem packages will speed up build
# Optional: disable email notifications about the outcome of your builds
notifications:
email: false
```
Ok, now for an explanation of each line:
@@ -123,12 +129,13 @@ access to Bundler, RubyGems, and a Ruby runtime.
```yaml
rvm:
- 2.3.3
- 2.4.1
```
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.
script. Use a [version which is pre-installed on the Travis build docker][5]
image to speed up the build.
```yaml
before_script:
@@ -210,6 +217,23 @@ does need `sudo` access, modify the line to `sudo: required`.
sudo: false
```
To speed up the build, you should cache the gem packages created by `bundler`.
Travis has a pre-defined [cache strategy for this tool][6] which should have
all the default configs to do exactly that.
```yaml
cache: bundler
```
Optionally, if you are not interested in the build email notifications you
can disable them with this configuration. Travis supports a wide array of
notification services, you may find [another one more useful (e.g. slack)][7].
```yaml
notifications:
email: false
```
### Troubleshooting
**Travis error:** *"You are trying to install in deployment mode after changing
@@ -227,3 +251,6 @@ fix or [ask for help][4] if you run into trouble and need some help.
[3]: https://github.com/jekyll/jekyll/edit/master/docs/_docs/continuous-integration/travis-ci.md
[4]: https://jekyllrb.com/help/
[5]: https://docs.travis-ci.com/user/languages/ruby/#Specifying-Ruby-versions-and-implementations
[6]: https://docs.travis-ci.com/user/caching/#Caching-directories-(Bundler%2C-dependencies)
[7]: https://docs.travis-ci.com/user/notifications/

View File

@@ -8,10 +8,7 @@ Hi there! Interested in contributing to Jekyll? We'd love your help. Jekyll is a
## Where to get help or report a problem
* If you have a question about using Jekyll, start a discussion on [Jekyll Talk](https://talk.jekyllrb.com).
* If you think you've found a bug within a Jekyll plugin, open an issue in that plugin's repository.
* If you think you've found a bug within Jekyll itself, [open an issue](https://github.com/jekyll/jekyll/issues/new).
* More resources are listed on our [Help page](https://jekyllrb.com/help/).
See [the support guidelines](https://jekyllrb.com/docs/support/)
## Ways to contribute
@@ -118,25 +115,37 @@ If your contribution changes any Jekyll behavior, make sure to update the docume
* Don't bump the Gem version in your pull request (if you don't know what that means, you probably didn't).
* You can use the command `script/console` to start a REPL to explore the result of
Jekyll's methods. It also provides you with helpful methods to quickly create a
site or configuration. [Feel free to check it out!](https://github.com/jekyll/jekyll/blob/master/script/console)
## Running tests locally
### Test Dependencies
To run the test suite and build the gem you'll need to install Jekyll's dependencies by running the following command:
<pre class="highlight"><code>$ script/bootstrap</code></pre>
```sh
script/bootstrap
```
Before you make any changes, run the tests and make sure that they pass (to confirm your environment is configured properly):
<pre class="highlight"><code>$ script/cibuild</code></pre>
```sh
script/cibuild
```
If you are only updating a file in `test/`, you can use the command:
<pre class="highlight"><code>$ script/test test/blah_test.rb</code></pre>
```sh
script/test test/blah_test.rb
```
If you are only updating a `.feature` file, you can use the command:
<pre class="highlight"><code>$ script/cucumber features/blah.feature</code></pre>
```sh
script/cucumber features/blah.feature
```
Both `script/test` and `script/cucumber` can be run without arguments to
run its entire respective suite.

View File

@@ -56,8 +56,8 @@ determines the variable name).
You can now render the list of members in a template:
```html
{% raw %}
```liquid
<ul>
{% for member in site.data.members %}
<li>
@@ -67,8 +67,8 @@ You can now render the list of members in a template:
</li>
{% endfor %}
</ul>
{% endraw %}
```
{% endraw %}
{: .note .info }
If your Jekyll site has a lot of pages, such as with documentation websites, see the detailed examples in [how to build robust navigation for your site]({% link _tutorials/navigation.md %}).
@@ -106,8 +106,8 @@ members:
The organizations can then be accessed via `site.data.orgs`, followed by the
file name:
```html
{% raw %}
```liquid
<ul>
{% for org_hash in site.data.orgs %}
{% assign org = org_hash[1] %}
@@ -119,8 +119,8 @@ file name:
</li>
{% endfor %}
</ul>
{% endraw %}
```
{% endraw %}
## Example: Accessing a specific author
@@ -136,8 +136,8 @@ dave:
The author can then be specified as a page variable in a post's frontmatter:
```html
{% raw %}
```liquid
---
title: sample post
author: dave
@@ -149,8 +149,7 @@ author: dave
title="{{ author.name }}">
{{ author.name }}
</a>
{% endraw %}
```
{% endraw %}
For information on how to build robust navigation for your site (especially if you have a documentation website or another type of Jekyll site with a lot of pages to organize), see [Navigation](/tutorials/navigation).

View File

@@ -5,6 +5,31 @@ permalink: /docs/deployment-methods/
Sites built using Jekyll can be deployed in a large number of ways due to the static nature of the generated output. A few of the most common deployment techniques are described below.
<div class="note">
<h5>ProTip™: Use GitHub Pages for zero-hassle Jekyll hosting</h5>
<p>GitHub Pages are powered by Jekyll behind the scenes, so if youre looking for a zero-hassle, zero-cost solution, GitHub Pages are a great way to <a href="../github-pages/">host your Jekyll-powered website for free</a>.</p>
</div>
## Netlify
Netlify provides Global CDN, Continuous Deployment, one click HTTPS and [much more](https://www.netlify.com/features/), providing developers the most robust toolset available for modern web projects, without added complexity. Netlify supports custom plugins for Jekyll and has a free plan for open source projects.
Read this [Jekyll step-by-step guide](https://www.netlify.com/blog/2015/10/28/a-step-by-step-guide-jekyll-3.0-on-netlify/) to setup your Jekyll site on Netlify.
## Aerobatic
[Aerobatic](https://www.aerobatic.com) has custom domains, global CDN distribution, basic auth, CORS proxying, and a growing list of plugins all included.
Automating the deployment of a Jekyll site is simple. See their [Jekyll docs](https://www.aerobatic.com/docs/static-site-generators/#jekyll) for more details. Your built `_site` folder is deployed to their highly-available, globally distributed hosting service.
## Kickster
Use [Kickster](http://kickster.nielsenramon.com/) for easy (automated) deploys to GitHub Pages when using unsupported plugins on GitHub Pages.
Kickster provides a basic Jekyll project setup packed with web best practises and useful optimization tools increasing your overall project quality. Kickster ships with automated and worry-free deployment scripts for GitHub Pages.
Setting up Kickster is very easy, just install the gem and you are good to go. More documentation can here found [here](https://github.com/nielsenramon/kickster#kickster). If you do not want to use the gem or start a new project you can just copy paste the deployment scripts for [Travis CI](https://github.com/nielsenramon/kickster/tree/master/snippets/travis) or [Circle CI](https://github.com/nielsenramon/kickster#automated-deployment-with-circle-ci).
## Web hosting providers (FTP)
Just about any traditional web hosting provider will let you upload files to their servers over FTP. To upload a Jekyll site to a web host using FTP, simply run the `jekyll build` command and copy the contents of the generated `_site` folder to the root folder of your hosting account. This is most likely to be the `httpdocs` or `public_html` folder on most hosting providers.
@@ -41,13 +66,15 @@ server$ mkdir /var/www/myrepo
Next, add the following lines to hooks/post-receive and be sure Jekyll is
installed on the server:
```sh
```bash
GIT_REPO=$HOME/myrepo.git
TMP_GIT_CLONE=$HOME/tmp/myrepo
GEMFILE=$TMP_GIT_CLONE/Gemfile
PUBLIC_WWW=/var/www/myrepo
git clone $GIT_REPO $TMP_GIT_CLONE
jekyll build -s $TMP_GIT_CLONE -d $PUBLIC_WWW
BUNDLE_GEMFILE=$GEMFILE bundle install
BUNDLE_GEMFILE=$GEMFILE bundle exec jekyll build -s $TMP_GIT_CLONE -d $PUBLIC_WWW
rm -Rf $TMP_GIT_CLONE
exit
```
@@ -187,22 +214,3 @@ low-volume blogs as you only pay for what you use.
If you'd like to deploy your site to an OpenShift gear, there's [a cartridge
for that](https://github.com/openshift-quickstart/jekyll-openshift).
<div class="note">
<h5>ProTip™: Use GitHub Pages for zero-hassle Jekyll hosting</h5>
<p>GitHub Pages are powered by Jekyll behind the scenes, so if youre looking for a zero-hassle, zero-cost solution, GitHub Pages are a great way to <a href="../github-pages/">host your Jekyll-powered website for free</a>.</p>
</div>
## Kickster
Use [Kickster](http://kickster.nielsenramon.com/) for easy (automated) deploys to GitHub Pages when using unsupported plugins on GitHub Pages.
Kickster provides a basic Jekyll project setup packed with web best practises and useful optimization tools increasing your overall project quality. Kickster ships with automated and worry-free deployment scripts for GitHub Pages.
Setting up Kickster is very easy, just install the gem and you are good to go. More documentation can here found [here](https://github.com/nielsenramon/kickster#kickster). If you do not want to use the gem or start a new project you can just copy paste the deployment scripts for [Travis CI](https://github.com/nielsenramon/kickster/tree/master/snippets/travis) or [Circle CI](https://github.com/nielsenramon/kickster#automated-deployment-with-circle-ci).
## Aerobatic
[Aerobatic](https://www.aerobatic.com) has custom domains, global CDN distribution, basic auth, CORS proxying, and a growing list of plugins all included.
Automating the deployment of a Jekyll site is simple. See our [Jekyll docs](https://www.aerobatic.com/docs/static-site-generators/#jekyll) for more details. Your built `_site` folder is deployed to our highly-available, globally distributed hosting service.

View File

@@ -3,7 +3,7 @@ title: Working with drafts
permalink: /docs/drafts/
---
Drafts are posts without a date. They're posts you're still working on and
Drafts are posts without a date in the filename. They're posts you're still working on and
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:

View File

@@ -68,6 +68,20 @@ front matter of a page or post.
<code>_layouts</code> directory.
</p>
<ul>
<li>
Using <code>null</code> will produce a file without using a layout
file. However this is overridden if the file is a post/document and has a
layout defined in the <a href="../configuration/#front-matter-defaults">
frontmatter defaults</a>.
</li>
<li>
Starting from version 3.5.0, using <code>none</code> in a post/document will
produce a file without using a layout file regardless of frontmatter defaults.
Using <code>none</code> in a page, however, will cause Jekyll to attempt to
use a layout named "none".
</li>
</ul>
</td>
</tr>
<tr>
@@ -115,14 +129,14 @@ data that is sent to the Liquid templating engine during the conversion. For
instance, if you set a title, you can use that in your layout to set the page
title:
```html
```liquid
<!DOCTYPE HTML>
<html>
<head>
<title>{% raw %}{{ page.title }}{% endraw %}</title>
</head>
<body>
...
```
## Predefined Variables for Posts
@@ -153,7 +167,7 @@ These are available out-of-the-box to be used in the front matter for a post.
</tr>
<tr>
<td>
<p style="margin-bottom: 5px;"><code>category</code></p>
<p><code>category</code></p>
<p><code>categories</code></p>
</td>
<td>

View File

@@ -4,103 +4,82 @@ permalink: /docs/github-pages/
---
[GitHub Pages](https://pages.github.com) are public web pages for users,
organizations, and repositories, that are freely hosted on GitHub's
`github.io` domain or on a custom domain name of your choice. GitHub Pages are
powered by Jekyll behind the scenes, so in addition to supporting regular HTML
content, theyre also a great way to host your Jekyll-powered website for free.
organizations, and repositories, that are freely hosted on GitHub's `github.io`
domain or on a custom domain name of your choice. GitHub Pages are powered by
Jekyll behind the scenes, so they're a great way to host your Jekyll-powered
website for free.
Your site is automatically generated by GitHub Pages when you push your source
files. Note that GitHub Pages works equally well for regular HTML content,
simply because Jekyll treats files without YAML front matter as static assets.
So if you only need to push generated HTML, you're good to go without any
further setup.
Never built a website with GitHub Pages before? [See this marvelous guide by
Jonathan McGlone to get you up and running](http://jmcglone.com/guides/github-pages/).
This guide will teach you what you need to know about Git, GitHub, and Jekyll to create your very own website on GitHub Pages.
Jonathan McGlone](http://jmcglone.com/guides/github-pages/) to get you up and
running. This guide will teach you what you need to know about Git, GitHub, and
Jekyll to create your very own website on GitHub Pages.
## The github-pages gem
Our friends at GitHub have provided the
[github-pages](https://github.com/github/pages-gem) gem which is used to manage
[Jekyll and its dependencies on GitHub Pages](https://pages.github.com/versions/).
Using it in your projects means that when you deploy your site to GitHub Pages,
you will not be caught by unexpected differences between various versions of the
gems.
Note that GitHub Pages runs in `safe` mode and only allows [a set of whitelisted
plugins](https://help.github.com/articles/configuring-jekyll-plugins/#default-plugins).
To use the currently-deployed version of the gem in your project, add the
following to your `Gemfile`:
```ruby
source "https://rubygems.org"
gem "github-pages", group: :jekyll_plugins
```
Be sure to run `bundle update` often.
<div class="note">
<h5>GitHub Pages Documentation, Help, and Support</h5>
<p>
For more information about what you can do with GitHub Pages, as well as for
troubleshooting guides, you should check out
<a href="https://help.github.com/categories/github-pages-basics/">GitHubs Pages Help section</a>.
If all else fails, you should contact <a href="https://github.com/contact">GitHub Support</a>.
</p>
</div>
### Project Page URL Structure
Sometimes it's nice to preview your Jekyll site before you push your `gh-pages`
branch to GitHub. However, the subdirectory-like URL structure GitHub uses for
Project Pages complicates the proper resolution of URLs. In order to assure your site builds properly, use `site.github.url` in your URLs.
Project Pages complicates the proper resolution of URLs. In order to assure your
site builds properly, use the handy [URL filters](../templates/#filters):
```html
{% raw %}
<!-- Useful for styles with static names... -->
<link href="{{ site.github.url }}/path/to/css.css" rel="stylesheet">
<!-- and for documents/pages whose URLs can change... -->
[{{ page.title }}]("{{ page.url | prepend: site.github.url }}")
{% endraw %}
```liquid
<!-- For styles with static names... -->
<link href="{{ "/assets/css/style.css" | relative_url }}" rel="stylesheet">
<!-- For documents/pages whose URLs can change... -->
[{{ page.title }}]("{{ page.url | relative_url }}")
```
{% endraw %}
This way you can preview your site locally from the site root on localhost,
but when GitHub generates your pages from the gh-pages branch all the URLs
but when GitHub generates your pages from the `gh-pages` branch all the URLs
will resolve properly.
## Deploying Jekyll to GitHub Pages
GitHub Pages work by looking at certain branches of repositories on GitHub.
There are two basic types available: user/organization pages and project pages.
There are two basic types available: [user/organization and project pages](https://help.github.com/articles/user-organization-and-project-pages/).
The way to deploy these two types of sites are nearly identical, except for a
few minor details.
<div class="note protip" markdown="1">
<div markdown="1">
</div>
##### Use the `github-pages` gem
Our friends at GitHub have provided the
[github-pages](https://github.com/github/pages-gem)
gem which is used to manage Jekyll and its dependencies on
GitHub Pages. Using it in your projects means that when you deploy
your site to GitHub Pages, you will not be caught by unexpected
differences between various versions of the gems. To use the
currently-deployed version of the gem in your project, add the
following to your `Gemfile`:
<div class="code-block" markdown="1">
<div markdown="1">
</div>
```ruby
source 'https://rubygems.org'
require 'json'
require 'open-uri'
versions = JSON.parse(open('https://pages.github.com/versions.json').read)
gem 'github-pages', versions['github-pages']
```
</div>
This will ensure that when you run `bundle install`, you
have the correct version of the `github-pages` gem.
If that fails, simplify it:
<div class="code-block" markdown="1">
<div markdown="1">
</div>
```ruby
source 'https://rubygems.org'
gem 'github-pages'
```
</div>
And be sure to run `bundle update` often.
If you like to install `pages-gem` on Windows you can find instructions by Jens Willmer on
[how to install github-pages gem on Windows (x64)](https://jwillmer.de/blog/tutorial/how-to-install-jekyll-and-pages-gem-on-windows-10-x46#github-pages-and-plugins).
</div>
<div class="note info">
<h5>Installing <code>github-pages</code> gem on Windows</h5>
<p>
While Windows is not officially supported, it is possible
to install <code>github-pages</code> gem on Windows.
Special instructions can be found on our
<a href="../windows/#installation">Windows-specific docs page</a>.
</p>
</div>
### User and Organization Pages
User and organization pages live in a special GitHub repository dedicated to
@@ -140,7 +119,7 @@ Please refer to GitHub official documentation on
to see more detailed examples.
<div class="note warning">
<h5>Source Files Must be in the Root Directory</h5>
<h5>Source files must be in the root directory</h5>
<p>
GitHub Pages <a href="https://help.github.com/articles/troubleshooting-github-pages-build-failures#source-setting">overrides</a>
the <a href="/docs/configuration/#global-configuration">“Site Source”</a>
@@ -149,12 +128,13 @@ to see more detailed examples.
</p>
</div>
<div class="note">
<h5>GitHub Pages Documentation, Help, and Support</h5>
<div class="note info">
<h5>Installing the <code>github-pages</code> gem on Windows</h5>
<p>
For more information about what you can do with GitHub Pages, as well as for
troubleshooting guides, you should check out
<a href="https://help.github.com/categories/github-pages-basics/">GitHubs Pages Help section</a>.
If all else fails, you should contact <a href="https://github.com/contact">GitHub Support</a>.
While Windows is not officially supported, it is possible
to install the <code>github-pages</code> gem on Windows.
Special instructions can be found on our
<a href="../windows/#installation">Windows-specific docs page</a>.
</p>
</div>

View File

@@ -4,6 +4,447 @@ permalink: "/docs/history/"
note: This file is autogenerated. Edit /History.markdown instead.
---
## 3.8.3 / 2018-06-05
{: #v3-8-3}
### Bug Fixes
{: #bug-fixes-v3-8-3}
- Fix --unpublished not affecting collection documents ([#7027]({{ site.repository }}/issues/7027))
## 3.8.2 / 2018-05-18
{: #v3-8-2}
### Development Fixes
{: #development-fixes-v3-8-2}
- Update rubocop version ([#7016]({{ site.repository }}/issues/7016))
### Bug Fixes
{: #bug-fixes-v3-8-2}
- Add whitespace control to LIQUID_TAG_REGEX ([#7015]({{ site.repository }}/issues/7015))
## 3.8.1 / 2018-05-01
{: #v3-8-1}
### Bug Fixes
{: #bug-fixes-v3-8-1}
- Fix rendering Liquid constructs in excerpts ([#6945]({{ site.repository }}/issues/6945))
- Liquify documents unless published == false ([#6959]({{ site.repository }}/issues/6959))
## 3.8.0 / 2018-04-19
{: #v3-8-0}
### Development Fixes
{: #development-fixes-v3-8-0}
- move duplicate code to a single private method ([#6593]({{ site.repository }}/issues/6593))
- Test against Ruby 2.5 on AppVeyor ([#6668]({{ site.repository }}/issues/6668))
- Replace simple regex with a native Ruby method ([#6732]({{ site.repository }}/issues/6732))
- Codeclimate: exclude livereload.js ([#6776]({{ site.repository }}/issues/6776))
- Add a cucumber feature to test link tag ([#6777]({{ site.repository }}/issues/6777))
- Fix theme gem feature ([#6784]({{ site.repository }}/issues/6784))
- Replace simple regex with equivalent Ruby methods ([#6736]({{ site.repository }}/issues/6736))
- Rewrite `script/rubyprof` as a Ruby script ([#6813]({{ site.repository }}/issues/6813))
- Add debug output to theme rendering ([#5195]({{ site.repository }}/issues/5195))
- fix minitest deprecation warning in test ([#6839]({{ site.repository }}/issues/6839))
- Memoize `Site#site_data` ([#6809]({{ site.repository }}/issues/6809))
- Memoize document output extension ([#6814]({{ site.repository }}/issues/6814))
- Access document permalink attribute efficiently ([#6740]({{ site.repository }}/issues/6740))
- Minimize array allocations in the `where` filter ([#6860]({{ site.repository }}/issues/6860))
- Bump JRuby ([#6878]({{ site.repository }}/issues/6878))
- Assert existence of &lt;collection&gt;.files ([#6907]({{ site.repository }}/issues/6907))
- Bump Rubocop to 0.54.x ([#6915]({{ site.repository }}/issues/6915))
- Regenerate unconditionally unless its an incremental build ([#6917]({{ site.repository }}/issues/6917))
- Centralize require statements ([#6910]({{ site.repository }}/issues/6910))
- Bump to Rubocop 0.55 ([#6929]({{ site.repository }}/issues/6929))
- Refactor private method `HighlightBlock#parse_options` ([#6822]({{ site.repository }}/issues/6822))
### Minor Enhancements
{: #minor-enhancements-v3-8-0}
- Two massive performance improvements for large sites ([#6730]({{ site.repository }}/issues/6730))
- Cache the list of documents to be written ([#6741]({{ site.repository }}/issues/6741))
- Allow Jekyll Doctor to detect stray posts dir ([#6681]({{ site.repository }}/issues/6681))
- Excerpt relative-path should match its path ([#6597]({{ site.repository }}/issues/6597))
- Remind user to resolve conflict in `jekyll new` with `--force` ([#6801]({{ site.repository }}/issues/6801))
- Memoize helper methods in site-cleaner ([#6808]({{ site.repository }}/issues/6808))
- Compute document&#39;s relative_path faster ([#6767]({{ site.repository }}/issues/6767))
- Create a single instance of PostReader per site ([#6759]({{ site.repository }}/issues/6759))
- Allow date filters to output ordinal days ([#6773]({{ site.repository }}/issues/6773))
- Change regex to sanitize and normalize filenames passed to LiquidRenderer ([#6610]({{ site.repository }}/issues/6610))
- Allow passing :strict_variables and :strict_filters options to Liquid&#39;s renderer ([#6726]({{ site.repository }}/issues/6726))
- Debug writing files during the build process ([#6696]({{ site.repository }}/issues/6696))
- Improve regex usage in `Tags::IncludeTag` ([#6848]({{ site.repository }}/issues/6848))
- Improve comment included in the starter index.md ([#6916]({{ site.repository }}/issues/6916))
- Store and retrieve converter instances for Jekyll::Filters via a hash ([#6856]({{ site.repository }}/issues/6856))
- Implement a cache within the `where` filter ([#6868]({{ site.repository }}/issues/6868))
- Store regexp in a constant ([#6887]({{ site.repository }}/issues/6887))
- Optimize computing filename in LiquidRenderer ([#6841]({{ site.repository }}/issues/6841))
### Documentation
- Adding the jekyll-algolia plugin to the list of plugins ([#6737]({{ site.repository }}/issues/6737))
- Added Premonition plugin to list of plugins ([#6750]({{ site.repository }}/issues/6750))
- Add document on releasing a new version ([#6745]({{ site.repository }}/issues/6745))
- Mention Talkyard, a new commenting system for Jekyll and others. ([#6752]({{ site.repository }}/issues/6752))
- Add &#39;jekyll-fontello&#39; to plugins ([#6757]({{ site.repository }}/issues/6757))
- Install dh-autoreconf on Windows ([#6765]({{ site.repository }}/issues/6765))
- Fix common typos ([#6764]({{ site.repository }}/issues/6764))
- Fix documentation for {% raw %}`{{ page.excerpt }}`{% endraw %} ([#6779]({{ site.repository }}/issues/6779))
- Update docs on permalink configuration ([#6775]({{ site.repository }}/issues/6775))
- Propose fix some typos ([#6785]({{ site.repository }}/issues/6785))
- Say hello to Jekyll&#39;s New Lead Developer ([#6790]({{ site.repository }}/issues/6790))
- Add reference to Liquid to plugin docs ([#6794]({{ site.repository }}/issues/6794))
- Draft a release post for v3.7.3 ([#6803]({{ site.repository }}/issues/6803))
- add missing step for gem-based theme conversion ([#6802]({{ site.repository }}/issues/6802))
- Update windows.md to explain an issue with jekyll new. ([#6838]({{ site.repository }}/issues/6838))
- Add Bundler Installation Instructions ([#6828]({{ site.repository }}/issues/6828))
- Docs: describe difference between tags and categories ([#6882]({{ site.repository }}/issues/6882))
- Add `jekyll-random` plugin to docs ([#6833]({{ site.repository }}/issues/6833))
- Fixed typo in description of categories and tags ([#6896]({{ site.repository }}/issues/6896))
- Add missing ul-tag ([#6897]({{ site.repository }}/issues/6897))
- doc: add liquid tag plugin jekyll-onebox for html previews ([#6898]({{ site.repository }}/issues/6898))
- Add `jekyll-w2m` to plugins ([#6855]({{ site.repository }}/issues/6855))
- Fix tutorials navigation HTML ([#6919]({{ site.repository }}/issues/6919))
- add Arch Linux instalation troubleshoot ([#6782]({{ site.repository }}/issues/6782))
- Docs: Install Jekyll on macOS ([#6881]({{ site.repository }}/issues/6881))
- Fix CodeClimate badges [ci skip] ([#6930]({{ site.repository }}/issues/6930))
- Update index.md ([#6933]({{ site.repository }}/issues/6933))
### Site Enhancements
{: #site-enhancements-v3-8-0}
- Remove links to Gists ([#6751]({{ site.repository }}/issues/6751))
- Always load Google Fonts over HTTPS ([#6792]({{ site.repository }}/issues/6792))
- always load analytics.js over HTTPS ([#6807]({{ site.repository }}/issues/6807))
### Bug Fixes
{: #bug-fixes-v3-8-0}
- Append appropriate closing tag to Liquid block in an excerpt ### -minor ([#6724]({{ site.repository }}/issues/6724))
- Bypass rendering via Liquid unless required ([#6735]({{ site.repository }}/issues/6735))
- Delegated methods after `private` keyword are meant to be private ([#6819]({{ site.repository }}/issues/6819))
- Improve handling non-default collection documents rendering and writing ([#6795]({{ site.repository }}/issues/6795))
- Fix passing multiline params to include tag when using the variable syntax ([#6858]({{ site.repository }}/issues/6858))
- `include_relative` tag should find related documents in collections gathered within custom `collections_dir` ([#6818]({{ site.repository }}/issues/6818))
- Handle liquid tags in excerpts robustly ([#6891]({{ site.repository }}/issues/6891))
- Allow front matter defaults to be applied properly to documents gathered under custom `collections_dir` ([#6885]({{ site.repository }}/issues/6885))
## 3.7.3 / 2018-02-25
{: #v3-7-3}
### Bug Fixes
{: #bug-fixes-v3-7-3}
- Do not hardcode locale unless certainly necessary ([#6791]({{ site.repository }}/issues/6791))
## 3.7.2 / 2018-01-25
{: #v3-7-2}
### Development Fixes
{: #development-fixes-v3-7-2}
- CI: Test against Ruby 2.5.0 ([#6664]({{ site.repository }}/issues/6664))
- Bump rdoc to 6.0 ([#6600]({{ site.repository }}/issues/6600))
- Lint file and bump theme dependencies ([#6698]({{ site.repository }}/issues/6698))
- Write a Rubocop Cop to ensure no `#p` or `#puts` calls get committed to master. ([#6615]({{ site.repository }}/issues/6615))
- Remove redgreen gem ([#6720]({{ site.repository }}/issues/6720))
### Site Enhancements
{: #site-enhancements-v3-7-2}
- Display latest version in header ([#6676]({{ site.repository }}/issues/6676))
- Update version in `config.yml` via YAML load / dump ([#6677]({{ site.repository }}/issues/6677))
### Documentation
- Fix: Add note about posts in context of collections_dir ([#6680]({{ site.repository }}/issues/6680))
- Update deploy-script in documentation ([#6666]({{ site.repository }}/issues/6666))
- Add note about naming of collections_dir ([#6703]({{ site.repository }}/issues/6703))
- Update installation.md ([#6694]({{ site.repository }}/issues/6694))
- Add `jekyll-html` to plugins. ([#6654]({{ site.repository }}/issues/6654))
- Update plugins.md ([#6716]({{ site.repository }}/issues/6716))
- Release v3.7.1 ([#6695]({{ site.repository }}/issues/6695))
### Bug Fixes
{: #bug-fixes-v3-7-2}
- inform that symlinks are not allowed in safe mode ([#6670]({{ site.repository }}/issues/6670))
- Glob scope path only if configured with a pattern ([#6692]({{ site.repository }}/issues/6692))
- Add gem &#34;wdm&#34; to all newly generated Gemfiles ([#6711]({{ site.repository }}/issues/6711))
- Fix timezone inconsistencies between different ruby version ([#6697]({{ site.repository }}/issues/6697))
- Refactor collections_dir feature for consistency ([#6685]({{ site.repository }}/issues/6685))
### Minor Enhancements
{: #minor-enhancements-v3-7-2}
- Require external library only if necessary ([#6596]({{ site.repository }}/issues/6596))
## 3.7.0 / 2018-01-02
{: #v3-7-0}
### Minor Enhancements
{: #minor-enhancements-v3-7-0}
- Add LiveReload functionality to Jekyll. ([#5142]({{ site.repository }}/issues/5142))
- Add Utils::Internet.connected? to determine whether host machine has internet connection. ([#5870]({{ site.repository }}/issues/5870))
- Disable default layouts for Pages with a `layout: none` declaration ([#6182]({{ site.repository }}/issues/6182))
- Scope path glob ([#6268]({{ site.repository }}/issues/6268))
- Allow the user to set collections_dir to put all collections under one subdirectory ([#6331]({{ site.repository }}/issues/6331))
- Upgrade to Rouge 3 ([#6381]({{ site.repository }}/issues/6381))
- Allow URL filters to work directly with documents ([#6478]({{ site.repository }}/issues/6478))
- filter relative_url should keep absolute urls with scheme/authority ([#6490]({{ site.repository }}/issues/6490))
- `.sass-cache` doesn&#39;t *always* land in `options[&#39;source&#39;]` ([#6500]({{ site.repository }}/issues/6500))
- Allow plugins to modify the obsolete files. ([#6502]({{ site.repository }}/issues/6502))
- Add latin mode to `slugify` ([#6509]({{ site.repository }}/issues/6509))
- Log Kramdown warnings if log level is WARN ([#6522]({{ site.repository }}/issues/6522))
- Add an option to configure kramdown warning output ([#6554]({{ site.repository }}/issues/6554))
- Add `json` extension to list of directory indices ([#6550]({{ site.repository }}/issues/6550))
- Dependency: Bump jekyll-watch to 2.0 ([#6589]({{ site.repository }}/issues/6589))
- Remove paginate check ([#6606]({{ site.repository }}/issues/6606))
- update classifier-reborn to 2.2.0 ([#6631]({{ site.repository }}/issues/6631))
- Switch to an actively-maintained TOML parser. ([#6652]({{ site.repository }}/issues/6652))
- Do not coerce layout paths in theme-gem to the source directory ([#6603]({{ site.repository }}/issues/6603))
### Bug Fixes
{: #bug-fixes-v3-7-0}
- Raise when theme root directory is not available ([#6455]({{ site.repository }}/issues/6455))
- Avoid block parser warning in SmartyPants ([#6565]({{ site.repository }}/issues/6565))
- Fail gracefully if &#34;sass&#34; gem cannot be loaded ([#6573]({{ site.repository }}/issues/6573))
- return correct file in dir if dir has same name as file ([#6569]({{ site.repository }}/issues/6569))
- Register reload hooks in Server#process ([#6605]({{ site.repository }}/issues/6605))
- Memoize path to metadata file ([#6602]({{ site.repository }}/issues/6602))
- Use `require_relative` to load Jekyll classes ([#6609]({{ site.repository }}/issues/6609))
### Development Fixes
{: #development-fixes-v3-7-0}
- Added direct collection access to future collection item feature test([#6151]({{ site.repository }}/issues/6151))
- add failing test for non-utf8 encoding ([#6339]({{ site.repository }}/issues/6339))
- Upgrade to Cucumber 3.0 ([#6395]({{ site.repository }}/issues/6395))
- Provide a better default hash for tracking liquid stats ([#6417]({{ site.repository }}/issues/6417))
- Add configuration for first-timers bot ([#6431]({{ site.repository }}/issues/6431))
- Do not linkify escaped characters as PRs in History ([#6468]({{ site.repository }}/issues/6468))
- Rely on jekyll-mentions for linking usernames ([#6469]({{ site.repository }}/issues/6469))
- Update first-timers-issue-template.md ([#6472]({{ site.repository }}/issues/6472))
- Enable `Lint/RescueWithoutErrorClass` Cop ([#6482]({{ site.repository }}/issues/6482))
- Clean up Rubocop config ([#6495]({{ site.repository }}/issues/6495))
- Use Gem to discover the location of bundler ([#6499]({{ site.repository }}/issues/6499))
- Remove unnecessary encoding comment ([#6513]({{ site.repository }}/issues/6513))
- Suggest using Rubocop to automatically fix errors ([#6514]({{ site.repository }}/issues/6514))
- Assert raising Psych::SyntaxError when`&#34;strict_front_matter&#34;=&gt;true` ([#6520]({{ site.repository }}/issues/6520))
- Use Kernel#Array instead of explicit Array check ([#6525]({{ site.repository }}/issues/6525))
- RuboCop: Enable `Style/UnneededCapitalW` cop ([#6526]({{ site.repository }}/issues/6526))
- Refactor method to reduce ABC Metric size ([#6529]({{ site.repository }}/issues/6529))
- Remove parentheses around arguments to raise ([#6532]({{ site.repository }}/issues/6532))
- Use double-quotes around gem name ([#6535]({{ site.repository }}/issues/6535))
- Dependencies: upgrade to toml 0.2.0 ([#6541]({{ site.repository }}/issues/6541))
- Lock to cucumber 3.0.1 on Ruby 2.1 ([#6546]({{ site.repository }}/issues/6546))
- Bump JRuby version in Travis config ([#6561]({{ site.repository }}/issues/6561))
- Rescue from Psych::SyntaxError instead of SyntaxError after parsing YAML([#5828]({{ site.repository }}/issues/5828))
- Drop forwarding to private methods by exposing those methods as public([#6577]({{ site.repository }}/issues/6577))
- Upgrade pygments to v1.x ([#5937]({{ site.repository }}/issues/5937))
- Bump yajl-ruby ([#6582]({{ site.repository }}/issues/6582))
- Cleanup test_redcarpet.rb ([#6584]({{ site.repository }}/issues/6584))
- Add PageWithoutAFile class from jekyll plugins ([#6556]({{ site.repository }}/issues/6556))
- Cleanup LiveReloadReactor ([#6607]({{ site.repository }}/issues/6607))
### Documentation
- Add formester to the list of saas form backend ([#6059]({{ site.repository }}/issues/6059))
- GitHub Pages instructions ([#6384]({{ site.repository }}/issues/6384))
- Improve documentation for theme-gem installation ([#6387]({{ site.repository }}/issues/6387))
- Fix diff syntax-highlighting ([#6388]({{ site.repository }}/issues/6388))
- Update instructions ([#6396]({{ site.repository }}/issues/6396))
- Fix code-block highlighting in docs ([#6398]({{ site.repository }}/issues/6398))
- Filtering Posts with categories, tags, or other variables ([#6399]({{ site.repository }}/issues/6399))
- Fixes formatting on pre-formatted text. ([#6405]({{ site.repository }}/issues/6405))
- Added new tutorial to tutorials section on docs ([#6406]({{ site.repository }}/issues/6406))
- Updates ([#6407]({{ site.repository }}/issues/6407))
- Fix `collections_dir` example ([#6408]({{ site.repository }}/issues/6408))
- Renaming duplicate of &#34;Scenario 6&#34; to &#34;Scenario 7&#34; ([#6411]({{ site.repository }}/issues/6411))
- Mark `collection_dir` as unreleased ([#6412]({{ site.repository }}/issues/6412))
- Fix link to SUPPORT ([#6415]({{ site.repository }}/issues/6415))
- Fix list appearance by adding missing `ol` tag ([#6421]({{ site.repository }}/issues/6421))
- Explain how to override output collection index page ([#6424]({{ site.repository }}/issues/6424))
- Added github-cards to the list of plugins ([#6425]({{ site.repository }}/issues/6425))
- CoC violation correspondants ([#6429]({{ site.repository }}/issues/6429))
- Add a note about Liquid and syntax highlighting ([#6466]({{ site.repository }}/issues/6466))
- Remove `sudo` from macOS troubleshooting instructions ([#6486]({{ site.repository }}/issues/6486))
- Add a note on `:jekyll_plugins` group in the docs ([#6488]({{ site.repository }}/issues/6488))
- Updated custom-404-page.md ([#6489]({{ site.repository }}/issues/6489))
- Fix a few minor issues in the docs ([#6494]({{ site.repository }}/issues/6494))
- Add jekyll-pwa-plugin ([#6533]({{ site.repository }}/issues/6533))
- Remove Jekyll-Smartify from plugins directory ([#6548]({{ site.repository }}/issues/6548))
- Updated Jekyll-Pug listing to include official website ([#6555]({{ site.repository }}/issues/6555))
- Remove link to severely outdated asset plugin ([#6613]({{ site.repository }}/issues/6613))
- Default time zone depends upon server ([#6617]({{ site.repository }}/issues/6617))
- Add `disqus-for-jekyll` to plugins. ([#6618]({{ site.repository }}/issues/6618))
- Update &#34;Requirements&#34; for Ruby version ([#6623]({{ site.repository }}/issues/6623))
- Fix: Update link to i18n_filter plugin ([#6638]({{ site.repository }}/issues/6638))
- Correct WordPress capitalization ([#6645]({{ site.repository }}/issues/6645))
- Add Tweetsert, Stickyposts, Paginate::Content ([#6651]({{ site.repository }}/issues/6651))
- Post: Jekyll 3.7.0 released ([#6634]({{ site.repository }}/issues/6634))
### Site Enhancements
{: #site-enhancements-v3-7-0}
- Add special styling for code-blocks run in shell ([#6389]({{ site.repository }}/issues/6389))
- Add post about diversity ([#6447]({{ site.repository }}/issues/6447))
- Update list of files excluded from Docs site ([#6457]({{ site.repository }}/issues/6457))
- Update site History ([#6460]({{ site.repository }}/issues/6460))
- Add default twitter card image ([#6476]({{ site.repository }}/issues/6476))
- Update normalize.css to v7.0.0 ([#6491]({{ site.repository }}/issues/6491))
- Optimize images ([#6519]({{ site.repository }}/issues/6519))
- Back to original main navigation ([#6544]({{ site.repository }}/issues/6544))
- Styles: mobile-docs select element ([#6545]({{ site.repository }}/issues/6545))
- Search with DocSearch by @Algolia ([#6557]({{ site.repository }}/issues/6557))
- Site header redesign ([#6567]({{ site.repository }}/issues/6567))
- Move logo above site navigation on small screens ([#6570]({{ site.repository }}/issues/6570))
- Docs: Include version badge for latest features ([#6574]({{ site.repository }}/issues/6574))
- Use version-badge on an existing feature intro ([#6575]({{ site.repository }}/issues/6575))
- Add jekyll-category-pages plugin ([#6632]({{ site.repository }}/issues/6632))
- Improve docs styling for code to be run in shell ([#6641]({{ site.repository }}/issues/6641))
- Fix permalink icon markup in news-item layout ([#6639]({{ site.repository }}/issues/6639))
## 3.6.2 / 2017-10-21
{: #v3-6-2}
### Development Fixes
{: #development-fixes-v3-6-2}
- Update Rubocop to 0.51.0 ([#6444]({{ site.repository }}/issues/6444))
- Add test for layout as string ([#6445]({{ site.repository }}/issues/6445))
### Bug Fixes
{: #bug-fixes-v3-6-2}
- Problematic UTF+bom files ([#6322]({{ site.repository }}/issues/6322))
- Always treat `data.layout` as a string ([#6442]({{ site.repository }}/issues/6442))
## 3.6.1 / 2017-10-20
{: #v3-6-1}
### Documentation
- Doc y_day in docs/permalinks ([#6244]({{ site.repository }}/issues/6244))
- Update frontmatter.md ([#6371]({{ site.repository }}/issues/6371))
- Elaborate on excluding items from processing ([#6136]({{ site.repository }}/issues/6136))
- Style lists in tables ([#6379]({{ site.repository }}/issues/6379))
- Remove duplicate &#34;available&#34; ([#6380]({{ site.repository }}/issues/6380))
### Development Fixes
{: #development-fixes-v3-6-1}
- Bump rubocop to use `v0.50.x` ([#6368]({{ site.repository }}/issues/6368))
## 3.6.0 / 2017-09-21
{: #v3-6-0}
### Minor Enhancements
{: #minor-enhancements-v3-6-0}
- Ignore final newline in folded YAML string ([#6054]({{ site.repository }}/issues/6054))
- Add URL checks to Doctor ([#5760]({{ site.repository }}/issues/5760))
- Fix serving files that clash with directories ([#6222]({{ site.repository }}/issues/6222)) ([#6231]({{ site.repository }}/issues/6231))
- Bump supported Ruby version to `>= 2.1.0` ([#6220]({{ site.repository }}/issues/6220))
- set `LiquidError#template_name` for errors in included file ([#6206]({{ site.repository }}/issues/6206))
- Access custom config array throughout session ([#6200]({{ site.repository }}/issues/6200))
- Add support for Rouge 2, in addition to Rouge 1 ([#5919]({{ site.repository }}/issues/5919))
- Allow `yield` to logger methods &amp; bail early on no-op messages ([#6315]({{ site.repository }}/issues/6315))
- Update mime-types. ([#6336]({{ site.repository }}/issues/6336))
- Use a Schwartzian transform with custom sorting ([#6342]({{ site.repository }}/issues/6342))
- Alias `Drop#invoke_drop` to `Drop#[]` ([#6338]({{ site.repository }}/issues/6338))
### Bug Fixes
{: #bug-fixes-v3-6-0}
- `Deprecator`: fix typo for `--serve` command ([#6229]({{ site.repository }}/issues/6229))
- `Reader#read_directories`: guard against an entry not being a directory ([#6226]({{ site.repository }}/issues/6226))
- kramdown: symbolize keys in-place ([#6247]({{ site.repository }}/issues/6247))
- Call `to_s` on site.url before attempting to concatenate strings ([#6253]({{ site.repository }}/issues/6253))
- Enforce Style/FrozenStringLiteralComment ([#6265]({{ site.repository }}/issues/6265))
- Update theme-template README to note &#39;assets&#39; directory ([#6257]({{ site.repository }}/issues/6257))
- Memoize the return value of `Document#url` ([#6266]({{ site.repository }}/issues/6266))
- delegate `StaticFile#to_json` to `StaticFile#to_liquid` ([#6273]({{ site.repository }}/issues/6273))
- Fix `Drop#key?` so it can handle a nil argument ([#6281]({{ site.repository }}/issues/6281))
- Guard against type error in absolute url ([#6280]({{ site.repository }}/issues/6280))
- Mutable drops should fallback to their own methods when a mutation isn&#39;t present ([#6350]({{ site.repository }}/issues/6350))
- Skip adding binary files as posts ([#6344]({{ site.repository }}/issues/6344))
- Don&#39;t break if bundler is not installed ([#6377]({{ site.repository }}/issues/6377))
### Documentation
- Fix a typo in `custom-404-page.md` ([#6218]({{ site.repository }}/issues/6218))
- Docs: fix links to issues in History.markdown ([#6255]({{ site.repository }}/issues/6255))
- Update deprecated gems key to plugins. ([#6262]({{ site.repository }}/issues/6262))
- Fixes minor typo in post text ([#6283]({{ site.repository }}/issues/6283))
- Execute build command using bundle. ([#6274]({{ site.repository }}/issues/6274))
- name unification - buddy details ([#6317]({{ site.repository }}/issues/6317))
- name unification - application index ([#6318]({{ site.repository }}/issues/6318))
- trim and relocate plugin info across docs ([#6311]({{ site.repository }}/issues/6311))
- update Jekyll&#39;s README ([#6321]({{ site.repository }}/issues/6321))
- add SUPPORT file for GitHub ([#6324]({{ site.repository }}/issues/6324))
- Rename CODE_OF_CONDUCT to show in banner ([#6325]({{ site.repository }}/issues/6325))
- Docs : illustrate page.id for a collection&#39;s document ([#6329]({{ site.repository }}/issues/6329))
- Docs: post&#39;s date can be overriden in YAML front matter ([#6334]({{ site.repository }}/issues/6334))
- Docs: `site.url` behavior on development and production environments ([#6270]({{ site.repository }}/issues/6270))
- Fix typo in site.url section of variables.md :-[ ([#6337]({{ site.repository }}/issues/6337))
- Docs: updates ([#6343]({{ site.repository }}/issues/6343))
- Fix precedence docs ([#6346]({{ site.repository }}/issues/6346))
- add note to contributing docs about `script/console` ([#6349]({{ site.repository }}/issues/6349))
- Docs: Fix permalink example ([#6375]({{ site.repository }}/issues/6375))
### Site Enhancements
{: #site-enhancements-v3-6-0}
- Adding DevKit helpers ([#6225]({{ site.repository }}/issues/6225))
- Customizing url in collection elements clarified ([#6264]({{ site.repository }}/issues/6264))
- Plugins is the new gems ([#6326]({{ site.repository }}/issues/6326))
### Development Fixes
{: #development-fixes-v3-6-0}
- Strip unnecessary leading whitespace in template ([#6228]({{ site.repository }}/issues/6228))
- Users should be installing patch versions. ([#6198]({{ site.repository }}/issues/6198))
- Fix tests ([#6240]({{ site.repository }}/issues/6240))
- Define path with `__dir__` ([#6087]({{ site.repository }}/issues/6087))
- exit site.process sooner ([#6239]({{ site.repository }}/issues/6239))
- make flakey test more robust ([#6277]({{ site.repository }}/issues/6277))
- Add a quick test for DataReader ([#6284]({{ site.repository }}/issues/6284))
- script/backport-pr: commit message no longer includes the `#` ([#6289]({{ site.repository }}/issues/6289))
- Add Add CODEOWNERS file to help automate reviews. ([#6320]({{ site.repository }}/issues/6320))
- Fix builds on codeclimate ([#6333]({{ site.repository }}/issues/6333))
- Bump rubies on Travis ([#6366]({{ site.repository }}/issues/6366))
## 3.5.2 / 2017-08-12
{: #v3-5-2}
### Bug Fixes
{: #bug-fixes-v3-5-2}
- Backport [#6281]({{ site.repository }}/issues/6281) for v3.5.x: Fix `Drop#key?` so it can handle a nil argument ([#6288]({{ site.repository }}/issues/6288))
- Backport [#6280]({{ site.repository }}/issues/6280) for v3.5.x: Guard against type error in `absolute_url` ([#6287]({{ site.repository }}/issues/6287))
- Backport [#6266]({{ site.repository }}/issues/6266) for v3.5.x: Memoize the return value of `Document#url` ([#6301]({{ site.repository }}/issues/6301))
- Backport [#6273]({{ site.repository }}/issues/6273) for v3.5.x: delegate `StaticFile#to_json` to `StaticFile#to_liquid` ([#6302]({{ site.repository }}/issues/6302))
- Backport [#6226]({{ site.repository }}/issues/6226) for v3.5.x: `Reader#read_directories`: guard against an entry not being a directory ([#6304]({{ site.repository }}/issues/6304))
- Backport [#6247]({{ site.repository }}/issues/6247) for v3.5.x: kramdown: symbolize keys in-place ([#6303]({{ site.repository }}/issues/6303))
## 3.5.1 / 2017-07-17
{: #v3-5-1}
@@ -26,8 +467,8 @@ note: This file is autogenerated. Edit /History.markdown instead.
- added BibSonomy plugin ([#6143]({{ site.repository }}/issues/6143))
- add plugins for multiple page pagination ([#6055]({{ site.repository }}/issues/6055))
- Update minimum Ruby version in installation.md ([#6164]({{ site.repository }}/issues/6164))
- [docs] Add information about finding a collection in `site.collections` ([#6165]({{ site.repository }}/issues/6165))
- Add {%raw%} to Liquid example on site ([#6179]({{ site.repository }}/issues/6179))
- Add information about finding a collection in `site.collections` ([#6165]({{ site.repository }}/issues/6165))
- Add {% raw %}`{% raw %}`{% endraw %} to Liquid example on site ([#6179]({{ site.repository }}/issues/6179))
- Added improved Pug plugin - removed 404 Jade plugin ([#6174]({{ site.repository }}/issues/6174))
- Linking the link ([#6210]({{ site.repository }}/issues/6210))
- Small correction in documentation for includes ([#6193]({{ site.repository }}/issues/6193))
@@ -128,7 +569,7 @@ note: This file is autogenerated. Edit /History.markdown instead.
- Be more specific on what to upload ([#6119]({{ site.repository }}/issues/6119))
- Remove Blank Newlines from "Jekyll on Windows" Page ([#6126]({{ site.repository }}/issues/6126))
- Link the troubleshooting page in the quickstart page ([#6134]({{ site.repository }}/issues/6134))
- add documentation about the &[#34]({{ site.repository }}/issues/34);pinned&[#34]({{ site.repository }}/issues/34); label ([#6147]({{ site.repository }}/issues/6147))
- add documentation about the &#34;pinned&#34; label ([#6147]({{ site.repository }}/issues/6147))
- docs(JekyllOnWindows): Add a new Installation way ([#6141]({{ site.repository }}/issues/6141))
- corrected windows.md ([#6149]({{ site.repository }}/issues/6149))
- Refine documentation for Windows ([#6153]({{ site.repository }}/issues/6153))
@@ -136,7 +577,7 @@ note: This file is autogenerated. Edit /History.markdown instead.
### Development Fixes
{: #development-fixes-v3-5-0}
- [Rubocop] add missing comma ([#5835]({{ site.repository }}/issues/5835))
- Rubocop: add missing comma ([#5835]({{ site.repository }}/issues/5835))
- Appease classifier-reborn ([#5934]({{ site.repository }}/issues/5934))
- Allow releases & development on `*-stable` branches ([#5926]({{ site.repository }}/issues/5926))
- Add script/backport-pr ([#5925]({{ site.repository }}/issues/5925))
@@ -175,7 +616,7 @@ note: This file is autogenerated. Edit /History.markdown instead.
{: #bug-fixes-v3-5-0}
- Exclude Gemfile by default ([#5860]({{ site.repository }}/issues/5860))
- Convertible#validate_permalink!: ensure the return value of data["permalink"] is a string before asking if it is empty ([#5878]({{ site.repository }}/issues/5878))
- Convertible#validate_permalink!: ensure the return value of `data["permalink"]` is a string before asking if it is empty ([#5878]({{ site.repository }}/issues/5878))
- Allow abbreviated post dates ([#5920]({{ site.repository }}/issues/5920))
- Remove dependency on include from default about.md ([#5903]({{ site.repository }}/issues/5903))
- Allow colons in `uri_escape` filter ([#5957]({{ site.repository }}/issues/5957))
@@ -251,7 +692,7 @@ note: This file is autogenerated. Edit /History.markdown instead.
- Switch to `https` when possible. ([#5611]({{ site.repository }}/issues/5611))
- Update `_font-awesome.scss` to move .woff file before .ttf ([#5614]({{ site.repository }}/issues/5614))
- Update documentation on updating FontAwesome Iconset ([#5655]({{ site.repository }}/issues/5655))
- [site] Use defaults for docs and news-items ([#5744]({{ site.repository }}/issues/5744))
- Use defaults for docs and news-items ([#5744]({{ site.repository }}/issues/5744))
- Sort gems in `docs/_config.yml` ([#5746]({{ site.repository }}/issues/5746))
- Add missing class ([#5791]({{ site.repository }}/issues/5791))
- Improve template docs ([#5694]({{ site.repository }}/issues/5694))
@@ -313,7 +754,7 @@ note: This file is autogenerated. Edit /History.markdown instead.
- Update quickstart.md ([#5758]({{ site.repository }}/issues/5758))
- Correct minor typo ([#5764]({{ site.repository }}/issues/5764))
- Fix a markdown link to look properly on the web ([#5769]({{ site.repository }}/issues/5769))
- [docs] Info about the help command usage ([#5312]({{ site.repository }}/issues/5312))
- Info about the help command usage ([#5312]({{ site.repository }}/issues/5312))
- Add missing merge labels for jekyllbot ([#5753]({{ site.repository }}/issues/5753))
- Fix broken links in documentation ([#5736]({{ site.repository }}/issues/5736))
- Docs: add `match_regex` and `replace_regex` filters ([#5799]({{ site.repository }}/issues/5799))
@@ -456,10 +897,10 @@ note: This file is autogenerated. Edit /History.markdown instead.
- Site: exclude README.md and .gitignore ([#5304]({{ site.repository }}/issues/5304))
- Add link to Staticman ([#5224]({{ site.repository }}/issues/5224))
- Update url for OpenShift ([#5320]({{ site.repository }}/issues/5320))
- [docs] add help for missing static_file e.g. on heroku ([#5334]({{ site.repository }}/issues/5334))
- Add help for missing static_file e.g. on heroku ([#5334]({{ site.repository }}/issues/5334))
- Add a line about updating theme-gems in the docs ([#5318]({{ site.repository }}/issues/5318))
- Explain how to copy a theme's files ([#5335]({{ site.repository }}/issues/5335))
- [docs] .md as default extension in examples ([#5316]({{ site.repository }}/issues/5316))
- .md as default extension in examples ([#5316]({{ site.repository }}/issues/5316))
- Fix small typo in docs ([#5347]({{ site.repository }}/issues/5347))
- Add missing period to sentence in first paragraph. ([#5372]({{ site.repository }}/issues/5372))
- added jekyll-spotify plugin ([#5369]({{ site.repository }}/issues/5369))
@@ -468,7 +909,7 @@ note: This file is autogenerated. Edit /History.markdown instead.
- Add documentation for `relative_url` and `absolute_url` ([#5405]({{ site.repository }}/issues/5405))
- Bugfix on logo in JSON-LD ([#5421]({{ site.repository }}/issues/5421))
- Fix Travis.ci documentation ([#5413]({{ site.repository }}/issues/5413))
- [docs] Update documentation regarding `bundle install` after `jekyll new` ([#5428]({{ site.repository }}/issues/5428))
- Update documentation regarding `bundle install` after `jekyll new` ([#5428]({{ site.repository }}/issues/5428))
- Replace classic box-sizing reset with inheritance reset ([#5411]({{ site.repository }}/issues/5411))
- Update Wikipedia YAML list link ([#5452]({{ site.repository }}/issues/5452))
- Add Jekyll 3.3 release post ([#5442]({{ site.repository }}/issues/5442))
@@ -479,9 +920,9 @@ note: This file is autogenerated. Edit /History.markdown instead.
- Update appveyor.yml and fix optional deps for Ruby x64 ([#5180]({{ site.repository }}/issues/5180))
- Improve tests for Jekyll::PluginManager ([#5167]({{ site.repository }}/issues/5167))
- Update Ruby versions in travis.yml ([#5221]({{ site.repository }}/issues/5221))
- Avoid installing unecessary gems for site testing ([#5272]({{ site.repository }}/issues/5272))
- Avoid installing unnecessary gems for site testing ([#5272]({{ site.repository }}/issues/5272))
- Proposal: Affinity teams and their captains ([#5273]({{ site.repository }}/issues/5273))
- Replace duplicate with postive local test in issue template ([#5286]({{ site.repository }}/issues/5286))
- Replace duplicate with positive local test in issue template ([#5286]({{ site.repository }}/issues/5286))
- Update AppVeyor config. ([#5240]({{ site.repository }}/issues/5240))
- Execute jekyll from clone instead of defined binary when running 'script/default-site' ([#5295]({{ site.repository }}/issues/5295))
- rubocop: lib/jekyll/document.rb complexity fixes ([#5045]({{ site.repository }}/issues/5045))
@@ -533,7 +974,7 @@ note: This file is autogenerated. Edit /History.markdown instead.
- Allow collections to have documents that have no file extension ([#4545]({{ site.repository }}/issues/4545))
- Add size property to `group_by` result ([#4557]({{ site.repository }}/issues/4557))
- Site Template: Removed unnecessary nesting from `_base.scss` ([#4637]({{ site.repository }}/issues/4637))
- Adding a debug log statment for skipped future documents. ([#4558]({{ site.repository }}/issues/4558))
- Adding a debug log statement for skipped future documents. ([#4558]({{ site.repository }}/issues/4558))
- Site Template: Changed main `<div>` to `<main>` and added accessibility info ([#4636]({{ site.repository }}/issues/4636))
- Add array support to `where` filter ([#4555]({{ site.repository }}/issues/4555))
- 'jekyll clean': also remove .sass-cache ([#4652]({{ site.repository }}/issues/4652))
@@ -784,7 +1225,7 @@ note: This file is autogenerated. Edit /History.markdown instead.
### Bug Fixes
{: #bug-fixes-v3-1-2}
- Fix syntax highlighting in kramdown by making `[@config](https://github.com/config)` accessible in the Markdown converter. ([#4428]({{ site.repository }}/issues/4428))
- Fix syntax highlighting in kramdown by making `@config` accessible in the Markdown converter. ([#4428]({{ site.repository }}/issues/4428))
- `Jekyll.sanitized_path`: sanitizing a questionable path should handle tildes ([#4492]({{ site.repository }}/issues/4492))
- Fix `titleize` so already capitalized words are not dropped ([#4525]({{ site.repository }}/issues/4525))
- Permalinks which end in a slash should always output HTML ([#4546]({{ site.repository }}/issues/4546))
@@ -802,7 +1243,7 @@ note: This file is autogenerated. Edit /History.markdown instead.
- Fix broken links to the Code of Conduct ([#4436]({{ site.repository }}/issues/4436))
- Upgrade notes: mention trailing slash in permalink; fixes [#4440]({{ site.repository }}/issues/4440) ([#4455]({{ site.repository }}/issues/4455))
- Add hooks to the plugin categories toc ([#4463]({{ site.repository }}/issues/4463))
- [add note] Jekyll 3 requires newer version of Ruby. ([#4461]({{ site.repository }}/issues/4461))
- Jekyll 3 requires newer version of Ruby. ([#4461]({{ site.repository }}/issues/4461))
- Fix typo in upgrading docs ([#4473]({{ site.repository }}/issues/4473))
- Add note about upgrading documentation on jekyllrb.com/help/ ([#4484]({{ site.repository }}/issues/4484))
- Update Rake link ([#4496]({{ site.repository }}/issues/4496))
@@ -867,18 +1308,18 @@ note: This file is autogenerated. Edit /History.markdown instead.
- Convertible should make layout data accessible via `layout` instead of `page` ([#4205]({{ site.repository }}/issues/4205))
- Avoid using `Dir.glob` with absolute path to allow special characters in the path ([#4150]({{ site.repository }}/issues/4150))
- Handle empty config files ([#4052]({{ site.repository }}/issues/4052))
- Rename `[@options](https://github.com/options)` so that it does not impact Liquid. ([#4173]({{ site.repository }}/issues/4173))
- Rename `@options` so that it does not impact Liquid. ([#4173]({{ site.repository }}/issues/4173))
- utils/drops: update Drop to support `Utils.deep_merge_hashes` ([#4289]({{ site.repository }}/issues/4289))
- Make sure jekyll/drops/drop is loaded first. ([#4292]({{ site.repository }}/issues/4292))
- Convertible/Page/Renderer: use payload hash accessor & setter syntax for backwards-compatibility ([#4311]({{ site.repository }}/issues/4311))
- Drop: fix hash setter precendence ([#4312]({{ site.repository }}/issues/4312))
- Drop: fix hash setter precedence ([#4312]({{ site.repository }}/issues/4312))
- utils: `has_yaml_header?` should accept files with extraneous spaces ([#4290]({{ site.repository }}/issues/4290))
- Escape html from site.title and page.title in site template ([#4307]({{ site.repository }}/issues/4307))
- Allow custom file extensions if defined in `permalink` YAML front matter ([#4314]({{ site.repository }}/issues/4314))
- Fix deep_merge_hashes! handling of drops and hashes ([#4359]({{ site.repository }}/issues/4359))
- Page should respect output extension of its permalink ([#4373]({{ site.repository }}/issues/4373))
- Disable auto-regeneration when running server detached ([#4376]({{ site.repository }}/issues/4376))
- Drop#[]: only use public_send for keys in the content_methods array ([#4388]({{ site.repository }}/issues/4388))
- Drop#: only use public_send for keys in the content_methods array ([#4388]({{ site.repository }}/issues/4388))
- Extract title from filename successfully when no date. ([#4195]({{ site.repository }}/issues/4195))
### Development Fixes
@@ -928,7 +1369,7 @@ note: This file is autogenerated. Edit /History.markdown instead.
- Add documentation for smartify Liquid filter ([#4333]({{ site.repository }}/issues/4333))
- Fixed broken link to blog on using mathjax with jekyll ([#4344]({{ site.repository }}/issues/4344))
- Documentation: correct reference in Precedence section of Configuration docs ([#4355]({{ site.repository }}/issues/4355))
- Add [@jmcglone](https://github.com/jmcglone)'s guide to github-pages doc page ([#4364]({{ site.repository }}/issues/4364))
- Add @jmcglone's guide to github-pages doc page ([#4364]({{ site.repository }}/issues/4364))
- Added the Wordpress2Jekyll Wordpress plugin ([#4377]({{ site.repository }}/issues/4377))
- Add Contentful Extension to list of third-party plugins ([#4390]({{ site.repository }}/issues/4390))
- Correct Minor spelling error ([#4394]({{ site.repository }}/issues/4394))
@@ -1309,7 +1750,7 @@ note: This file is autogenerated. Edit /History.markdown instead.
### Site Enhancements
{: #site-enhancements-v2-5-3}
- Add `[@alfredxing](https://github.com/alfredxing)` to the `[@jekyll](https://github.com/jekyll)/core` team. :tada: ([#3218]({{ site.repository }}/issues/3218))
- Add @alfredxing to the @jekyll/core team. :tada: ([#3218]({{ site.repository }}/issues/3218))
- Document the `-q` option for the `build` and `serve` commands ([#3149]({{ site.repository }}/issues/3149))
- Fix some minor typos/flow fixes in documentation website content ([#3165]({{ site.repository }}/issues/3165))
- Add `keep_files` to configuration documentation ([#3162]({{ site.repository }}/issues/3162))
@@ -1906,7 +2347,7 @@ note: This file is autogenerated. Edit /History.markdown instead.
- Fixed typo in datafiles doc page ([#1854]({{ site.repository }}/issues/1854))
- Clarify how to access `site` in docs ([#1864]({{ site.repository }}/issues/1864))
- Add closing `<code>` tag to `context.registers[:site]` note ([#1867]({{ site.repository }}/issues/1867))
- Fix link to [@mojombo](https://github.com/mojombo)'s site source ([#1897]({{ site.repository }}/issues/1897))
- Fix link to @mojombo's site source ([#1897]({{ site.repository }}/issues/1897))
- Add `paginate: nil` to default configuration in docs ([#1896]({{ site.repository }}/issues/1896))
- Add link to our License in the site footer ([#1889]({{ site.repository }}/issues/1889))
- Add a charset note in "Writing Posts" doc page ([#1902]({{ site.repository }}/issues/1902))
@@ -2373,7 +2814,7 @@ note: This file is autogenerated. Edit /History.markdown instead.
- Add documentation about `paginate_path` to "Templates" page in docs ([#1129]({{ site.repository }}/issues/1129))
- Give the quick-start guide its own page ([#1191]({{ site.repository }}/issues/1191))
- Update ProTip on Installation page in docs to point to all the info about Pygments and the 'highlight' tag. ([#1196]({{ site.repository }}/issues/1196))
- Run `site/img` through ImageOptim (thanks [@qrush](https://github.com/qrush)!) ([#1208]({{ site.repository }}/issues/1208))
- Run `site/img` through ImageOptim (thanks @qrush!) ([#1208]({{ site.repository }}/issues/1208))
- Added Jade Converter to `site/docs/plugins` ([#1210]({{ site.repository }}/issues/1210))
- Fix location of docs pages in Contributing pages ([#1214]({{ site.repository }}/issues/1214))
- Add ReadInXMinutes plugin to the plugin list ([#1222]({{ site.repository }}/issues/1222))
@@ -2855,25 +3296,25 @@ note: This file is autogenerated. Edit /History.markdown instead.
{: #v0-5-3}
- Bug Fixes
- Solving the permalink bug where non-html files wouldn't work ([@jeffrydegrande](https://github.com/jeffrydegrande))
- Solving the permalink bug where non-html files wouldn't work (@jeffrydegrande)
## 0.5.2 / 2009-06-24
{: #v0-5-2}
- Enhancements
- Added --paginate option to the executable along with a paginator object for the payload ([@calavera](https://github.com/calavera))
- Added --paginate option to the executable along with a paginator object for the payload (@calavera)
- Upgraded RedCloth to 4.2.1, which makes `<notextile>` tags work once again.
- Configuration options set in config.yml are now available through the site payload ([@vilcans](https://github.com/vilcans))
- Configuration options set in config.yml are now available through the site payload (@vilcans)
- Posts can now have an empty YAML front matter or none at all (@ bahuvrihi)
- Bug Fixes
- Fixing Ruby 1.9 issue that requires `#to_s` on the err object ([@Chrononaut](https://github.com/Chrononaut))
- Fixes for pagination and ordering posts on the same day ([@ujh](https://github.com/ujh))
- Made pages respect permalinks style and permalinks in yml front matter ([@eugenebolshakov](https://github.com/eugenebolshakov))
- Index.html file should always have index.html permalink ([@eugenebolshakov](https://github.com/eugenebolshakov))
- Added trailing slash to pretty permalink style so Apache is happy ([@eugenebolshakov](https://github.com/eugenebolshakov))
- Fixing Ruby 1.9 issue that requires `#to_s` on the err object (@Chrononaut)
- Fixes for pagination and ordering posts on the same day (@ujh)
- Made pages respect permalinks style and permalinks in yml front matter (@eugenebolshakov)
- Index.html file should always have index.html permalink (@eugenebolshakov)
- Added trailing slash to pretty permalink style so Apache is happy (@eugenebolshakov)
- Bad markdown processor in config fails sooner and with better message (@ gcnovus)
- Allow CRLFs in yaml front matter ([@juretta](https://github.com/juretta))
- Allow CRLFs in yaml front matter (@juretta)
- Added Date#xmlschema for Ruby versions < 1.9
@@ -2883,15 +3324,15 @@ note: This file is autogenerated. Edit /History.markdown instead.
### Major Enhancements
{: #major-enhancements-v0-5-1}
- Next/previous posts in site payload ([@pantulis](https://github.com/pantulis), [@tomo](https://github.com/tomo))
- Next/previous posts in site payload (@pantulis, @tomo)
- Permalink templating system
- Moved most of the README out to the GitHub wiki
- Exclude option in configuration so specified files won't be brought over with generated site ([@duritong](https://github.com/duritong))
- Exclude option in configuration so specified files won't be brought over with generated site (@duritong)
- Bug Fixes
- Making sure config.yaml references are all gone, using only config.yml
- Fixed syntax highlighting breaking for UTF-8 code ([@henrik](https://github.com/henrik))
- Worked around RDiscount bug that prevents Markdown from getting parsed after highlight ([@henrik](https://github.com/henrik))
- CGI escaped post titles ([@Chrononaut](https://github.com/Chrononaut))
- Fixed syntax highlighting breaking for UTF-8 code (@henrik)
- Worked around RDiscount bug that prevents Markdown from getting parsed after highlight (@henrik)
- CGI escaped post titles (@Chrononaut)
## 0.5.0 / 2009-04-07
@@ -2900,21 +3341,21 @@ note: This file is autogenerated. Edit /History.markdown instead.
### Minor Enhancements
{: #minor-enhancements-v0-5-0}
- Ability to set post categories via YAML ([@qrush](https://github.com/qrush))
- Ability to set prevent a post from publishing via YAML ([@qrush](https://github.com/qrush))
- Add textilize filter ([@willcodeforfoo](https://github.com/willcodeforfoo))
- Add 'pretty' permalink style for wordpress-like urls ([@dysinger](https://github.com/dysinger))
- Made it possible to enter categories from YAML as an array ([@Chrononaut](https://github.com/Chrononaut))
- Ignore Emacs autosave files ([@Chrononaut](https://github.com/Chrononaut))
- Ability to set post categories via YAML (@qrush)
- Ability to set prevent a post from publishing via YAML (@qrush)
- Add textilize filter (@willcodeforfoo)
- Add 'pretty' permalink style for wordpress-like urls (@dysinger)
- Made it possible to enter categories from YAML as an array (@Chrononaut)
- Ignore Emacs autosave files (@Chrononaut)
- Bug Fixes
- Use block syntax of popen4 to ensure that subprocesses are properly disposed ([@jqr](https://github.com/jqr))
- Close open4 streams to prevent zombies ([@rtomayko](https://github.com/rtomayko))
- Only query required fields from the WP Database ([@ariejan](https://github.com/ariejan))
- Prevent `_posts` from being copied to the destination directory ([@bdimcheff](https://github.com/bdimcheff))
- Use block syntax of popen4 to ensure that subprocesses are properly disposed (@jqr)
- Close open4 streams to prevent zombies (@rtomayko)
- Only query required fields from the WP Database (@ariejan)
- Prevent `_posts` from being copied to the destination directory (@bdimcheff)
- Refactors
- Factored the filtering code into a method ([@Chrononaut](https://github.com/Chrononaut))
- Fix tests and convert to Shoulda ([@qrush](https://github.com/qrush), [@technicalpickles](https://github.com/technicalpickles))
- Add Cucumber acceptance test suite ([@qrush](https://github.com/qrush), [@technicalpickles](https://github.com/technicalpickles))
- Factored the filtering code into a method (@Chrononaut)
- Fix tests and convert to Shoulda (@qrush, @technicalpickles)
- Add Cucumber acceptance test suite (@qrush, @technicalpickles)
## 0.4.1
@@ -2922,9 +3363,9 @@ note: This file is autogenerated. Edit /History.markdown instead.
### Minor Enhancements
{: #minor-enhancements-v--}
- Changed date format on wordpress converter (zeropadding) ([@dysinger](https://github.com/dysinger))
- Changed date format on wordpress converter (zeropadding) (@dysinger)
- Bug Fixes
- Add Jekyll binary as executable to gemspec ([@dysinger](https://github.com/dysinger))
- Add Jekyll binary as executable to gemspec (@dysinger)
## 0.4.0 / 2009-02-03
@@ -2938,20 +3379,20 @@ note: This file is autogenerated. Edit /History.markdown instead.
### Minor Enhancements
{: #minor-enhancements-v0-4-0}
- Type importer ([@codeslinger](https://github.com/codeslinger))
- `site.topics` accessor ([@baz](https://github.com/baz))
- Add `array_to_sentence_string` filter ([@mchung](https://github.com/mchung))
- Add a converter for textpattern ([@PerfectlyNormal](https://github.com/PerfectlyNormal))
- Add a working Mephisto / MySQL converter ([@ivey](https://github.com/ivey))
- Allowing .htaccess files to be copied over into the generated site ([@briandoll](https://github.com/briandoll))
- Add option to not put file date in permalink URL ([@mreid](https://github.com/mreid))
- Add line number capabilities to highlight blocks ([@jcon](https://github.com/jcon))
- Type importer (@codeslinger)
- `site.topics` accessor (@baz)
- Add `array_to_sentence_string` filter (@mchung)
- Add a converter for textpattern (@PerfectlyNormal)
- Add a working Mephisto / MySQL converter (@ivey)
- Allowing .htaccess files to be copied over into the generated site (@briandoll)
- Add option to not put file date in permalink URL (@mreid)
- Add line number capabilities to highlight blocks (@jcon)
- Bug Fixes
- Fix permalink behavior ([@cavalle](https://github.com/cavalle))
- Fixed an issue with pygments, markdown, and newlines ([@zpinter](https://github.com/zpinter))
- Ampersands need to be escaped ([@pufuwozu](https://github.com/pufuwozu), [@ap](https://github.com/ap))
- Test and fix the site.categories hash ([@zzot](https://github.com/zzot))
- Fix site payload available to files ([@matrix9180](https://github.com/matrix9180))
- Fix permalink behavior (@cavalle)
- Fixed an issue with pygments, markdown, and newlines (@zpinter)
- Ampersands need to be escaped (@pufuwozu, @ap)
- Test and fix the site.categories hash (@zzot)
- Fix site payload available to files (@matrix9180)
## 0.3.0 / 2008-12-24
@@ -2960,19 +3401,19 @@ note: This file is autogenerated. Edit /History.markdown instead.
### Major Enhancements
{: #major-enhancements-v0-3-0}
- Added `--server` option to start a simple WEBrick server on destination directory ([@johnreilly](https://github.com/johnreilly) and [@mchung](https://github.com/mchung))
- Added `--server` option to start a simple WEBrick server on destination directory (@johnreilly and @mchung)
### Minor Enhancements
{: #minor-enhancements-v0-3-0}
- Added post categories based on directories containing `_posts` ([@mreid](https://github.com/mreid))
- Added post categories based on directories containing `_posts` (@mreid)
- Added post topics based on directories underneath `_posts`
- Added new date filter that shows the full month name ([@mreid](https://github.com/mreid))
- Merge Post's YAML front matter into its to_liquid payload ([@remi](https://github.com/remi))
- Added new date filter that shows the full month name (@mreid)
- Merge Post's YAML front matter into its to_liquid payload (@remi)
- Restrict includes to regular files underneath `_includes`
- Bug Fixes
- Change YAML delimiter matcher so as to not chew up 2nd level markdown headers ([@mreid](https://github.com/mreid))
- Fix bug that meant page data (such as the date) was not available in templates ([@mreid](https://github.com/mreid))
- Change YAML delimiter matcher so as to not chew up 2nd level markdown headers (@mreid)
- Fix bug that meant page data (such as the date) was not available in templates (@mreid)
- Properly reject directories in `_layouts`
@@ -2980,13 +3421,13 @@ note: This file is autogenerated. Edit /History.markdown instead.
{: #v0-2-1}
- Major Changes
- Use Maruku (pure Ruby) for Markdown by default ([@mreid](https://github.com/mreid))
- Use Maruku (pure Ruby) for Markdown by default (@mreid)
- Allow use of RDiscount with `--rdiscount` flag
### Minor Enhancements
{: #minor-enhancements-v0-2-1}
- Don't load directory_watcher unless it's needed ([@pjhyett](https://github.com/pjhyett))
- Don't load directory_watcher unless it's needed (@pjhyett)
## 0.2.0 / 2008-12-14
@@ -3015,10 +3456,10 @@ note: This file is autogenerated. Edit /History.markdown instead.
### Minor Enhancements
{: #minor-enhancements-v0-1-5}
- Output informative message if RDiscount is not available ([@JackDanger](https://github.com/JackDanger))
- Output informative message if RDiscount is not available (@JackDanger)
- Bug Fixes
- Prevent Jekyll from picking up the output directory as a source ([@JackDanger](https://github.com/JackDanger))
- Skip `related_posts` when there is only one post ([@JackDanger](https://github.com/JackDanger))
- Prevent Jekyll from picking up the output directory as a source (@JackDanger)
- Skip `related_posts` when there is only one post (@JackDanger)
## 0.1.4 / 2008-12-08
@@ -3032,12 +3473,12 @@ note: This file is autogenerated. Edit /History.markdown instead.
{: #v0-1-3}
- Major Features
- Markdown support ([@vanpelt](https://github.com/vanpelt))
- Mephisto and CSV converters ([@vanpelt](https://github.com/vanpelt))
- Code hilighting ([@vanpelt](https://github.com/vanpelt))
- Markdown support (@vanpelt)
- Mephisto and CSV converters (@vanpelt)
- Code hilighting (@vanpelt)
- Autobuild
- Bug Fixes
- Accept both `\r\n` and `\n` in YAML header ([@vanpelt](https://github.com/vanpelt))
- Accept both `\r\n` and `\n` in YAML header (@vanpelt)
## 0.1.2 / 2008-11-22

View File

@@ -5,9 +5,11 @@ permalink: /docs/includes/
The `include` tag allows you to include the content from another file stored in the `_includes` folder:
{% raw %}
```liquid
{% raw %}{% include footer.html %}{% endraw %}
{% include footer.html %}
```
{% endraw %}
Jekyll will look for the referenced file (in this case, `footer.html`) in the `_includes` directory at the root of your source directory and insert its contents.
@@ -15,9 +17,11 @@ Jekyll will look for the referenced file (in this case, `footer.html`) in the `_
You can choose to include file fragments relative to the current file by using the `include_relative` tag:
{% raw %}
```liquid
{% raw %}{% include_relative somedir/footer.html %}{% endraw %}
{% include_relative somedir/footer.html %}
```
{% endraw %}
You won't need to place your included content within the `_includes` directory. Instead,
the inclusion is specifically relative to the file where the tag is being used. For example,
@@ -42,9 +46,11 @@ my_variable: footer_company_a.html
You could then reference that variable in your include:
{% raw %}
```liquid
{% raw %}{% include {{ page.my_variable }} %}{% endraw %}
{% include {{ page.my_variable }} %}
```
{% endraw %}
In this example, the include would insert the file `footer_company_a.html` from the `_includes/footer_company_a.html` directory.
@@ -52,18 +58,22 @@ In this example, the include would insert the file `footer_company_a.html` from
You can also pass parameters to an include. For example, suppose you have a file called `note.html` in your `_includes` folder that contains this formatting:
{% raw %}
```liquid
{% raw %}<div markdown="span" class="alert alert-info" role="alert">
<div markdown="span" class="alert alert-info" role="alert">
<i class="fa fa-info-circle"></i> <b>Note:</b>
{{ include.content }}
</div>{% endraw %}
</div>
```
{% endraw %}
The `{% raw %}{{ include.content }}{% endraw %}` is a parameter that gets populated when you call the include and specify a value for that parameter, like this:
{% raw %}
```liquid
{% raw %}{% include note.html content="This is my sample note." %} {% endraw %}
{% include note.html content="This is my sample note." %}
```
{% endraw %}
The value of `content` (which is `This is my sample note`) will be inserted into the {% raw %}`{{ include.content }}`{% endraw %} parameter.
@@ -76,20 +86,24 @@ For example, suppose you have a special image syntax with complex formatting, an
<a href="http://jekyllrb.com">
<img src="logo.png" style="max-width: 200px;"
alt="Jekyll logo" />
</a>
<figcaption>This is the Jekyll logo</figcaption>
</figure>
```
You could templatize this content in your include and make each value available as a parameter, like this:
{% raw %}
```liquid
{% raw %}<figure>
<figure>
<a href="{{ include.url }}">
<img src="{{ include.file }}" style="max-width: {{ include.max-width }};"
alt="{{ include.alt }}"/>
</a>
<figcaption>{{ include.caption }}</figcaption>
</figure>{% endraw %}
</figure>
```
{% endraw %}
This include contains 5 parameters:
@@ -101,15 +115,17 @@ This include contains 5 parameters:
Here's an example that passes all the parameters to this include (the include file is named `image.html`):
{% raw %}
```liquid
{% raw %}{% include image.html url="http://jekyllrb.com"
{% include image.html url="http://jekyllrb.com"
max-width="200px" file="logo.png" alt="Jekyll logo"
caption="This is the Jekyll logo." %} {% endraw %}
caption="This is the Jekyll logo." %}
```
{% endraw %}
The result is the original HTML code shown earlier.
To safeguard situations where users don't supply a value for the parameter, you can use [Liquid's default filter](https://help.shopify.com/themes/liquid/filters/additional-filters#default).
To safeguard situations where users don't supply a value for the parameter, you can use [Liquid's default filter](https://shopify.github.io/liquid/filters/default/).
Overall, you can create includes that act as templates for a variety of uses &mdash; inserting audio or video clips, alerts, special formatting, and more. However, note that you should avoid using too many includes, as this will slow down the build time of your site. For example, don't use includes every time you insert an image. (The above technique shows a use case for special images.)
@@ -121,16 +137,21 @@ The string you pass to your include parameter can't contain curly braces. For ex
If you want to include this variable in your parameter that you pass to an include, you need to store the entire parameter as a variable before passing it to the include. You can use `capture` tags to create the variable:
{% raw %}
```liquid
{% raw %}{% capture download_note %}The latest version of
{{ site.product_name }} is now available.{% endcapture %}{% endraw %}
{% capture download_note %}
The latest version of {{ site.product_name }} is now available.
{% endcapture %}
```
{% endraw %}
Then pass this captured variable into the parameter for the include. Omit the quotation marks around the parameter content because it's no longer a string (it's a variable):
{% raw %}
```liquid
{% raw %}{% include note.html content=download_note %}{% endraw %}
{% include note.html content=download_note %}
```
{% endraw %}
### Passing references to YAML files as parameter values
@@ -150,18 +171,22 @@ Here's an example. In the `_data` folder, suppose you have a YAML file called `p
In the `_includes` folder, assume you have a file called `spotlight.html` with this code:
{% raw %}
```liquid
{% raw %}{% for person in include.participants %}
{% for person in include.participants %}
{% if person.login_age == "new" %}
{{ person.name }}
{% endif %}
{% endfor %}{% endraw %}
{% endfor %}
```
{% endraw %}
Now when you insert the `spotlight.html` include file, you can submit the YAML file as a parameter:
{% raw %}
```liquid
{% include spotlight.html participants=site.data.profiles %}
```
{% raw %}{% include spotlight.html participants=site.data.profiles %}{% endraw %}
```
{% endraw %}
In this instance, `site.data.profiles` gets inserted in place of {% raw %}`include.participants`{% endraw %} in the include file, and the Liquid logic processes. The result will be `Jane Doe`.

View File

@@ -4,53 +4,38 @@ permalink: /docs/home/
redirect_from: /docs/index.html
---
This site aims to be a comprehensive guide to Jekyll. Well cover topics such
as getting your site up and running, creating and managing your content,
customizing the way your site works and looks, deploying to various
environments, and give you some advice on participating in the future
development of Jekyll itself.
This site aims to be a comprehensive guide to Jekyll. Well cover topics such as getting your site up and running, creating and managing content, customizing your build, and deploying.
## So what is Jekyll, exactly?
## What is Jekyll, exactly?
Jekyll is a simple, blog-aware, static site generator. It takes a template
directory containing raw text files in various formats, runs it through
a converter (like [Markdown](https://daringfireball.net/projects/markdown/))
and our [Liquid](https://github.com/Shopify/liquid/wiki) renderer, and
spits out a complete, ready-to-publish static website suitable
for serving with your favorite web server. Jekyll also happens to be the engine
behind [GitHub Pages](https://pages.github.com), which means you can use Jekyll
to host your projects page, blog, or website from GitHubs servers **for
free**.
Jekyll is a simple, blog-aware, static site generator.
## Helpful Hints
You create your content as text files ([Markdown](https://daringfireball.net/projects/markdown/)), and organize them into folders. Then, you build the shell of your site using [Liquid](https://shopify.github.io/liquid/)-enhanced HTML templates. Jekyll automatically stitches the content and templates together, generating a website made entirely of static assets, suitable for uploading to any server.
Throughout this guide there are a number of small-but-handy pieces of
information that can make using Jekyll easier, more interesting, and less
hazardous. Heres what to look out for.
Jekyll happens to be the engine behind [GitHub Pages](https://pages.github.com), so you can host your projects Jekyll page/blog/website on GitHubs servers **for free**.
## Navigating the Guide
Throughout this guide, you'll see these special sections that help you get the most out of Jekyll:
<div class="note">
<h5>ProTips™ help you get more from Jekyll</h5>
<p>These are tips and tricks that will help you be a Jekyll wizard!</p>
<h5>ProTips™</h5>
<p>Tips and tricks that'll make you a Jekyll wizard!</p>
</div>
<div class="note info">
<h5>Notes are handy pieces of information</h5>
<p>These are for the extra tidbits sometimes necessary to understand
Jekyll.</p>
<h5>Notes</h5>
<p>Extra tidbits that are sometimes necessary to understand Jekyll.</p>
</div>
<div class="note warning">
<h5>Warnings help you not blow things up</h5>
<p>Be aware of these messages if you wish to avoid certain death.</p>
<h5>Warnings</h5>
<p>Common pitfalls to avoid.</p>
</div>
<div class="note unreleased">
<h5>You'll see this by a feature that hasn't been released</h5>
<p>Some pieces of this website are for future versions of Jekyll that
are not yet released.</p>
<h5>Unreleased</h5>
<p>Features planned for future versions of Jekyll, but not available yet.</p>
</div>
If you come across anything along the way that we havent covered, or if you
know of a tip you think others would find handy, please [file an
issue]({{ site.repository }}/issues/new) and well see about
including it in this guide.
If you find anything we havent covered, or would like to share a tip that others might find handy, please [file an issue]({{ site.repository }}/issues/new) and well see about adding it to the guide.

View File

@@ -1,70 +1,176 @@
---
title: Installation
description: Official guide to install Jekyll on macOS, GNU/Linux or Windows.
permalink: /docs/installation/
---
Getting Jekyll installed and ready-to-go should only take a few minutes.
If it ever becomes a pain, please [file an issue]({{ site.repository }}/issues/new)
(or submit a pull request) describing the issue you
encountered and how we might make the process easier.
Jekyll is a [Ruby Gem](http://guides.rubygems.org/rubygems-basics/), and can be
installed on most systems.
### Requirements
- [Requirements](#requirements)
- [Install Jekyll on macOS](#macOS)
- [Install Jekyll on Ubuntu Linux](#ubuntu)
- [Install Jekyll on Windows](../windows/)
- [Upgrade Jekyll](#upgrade-jekyll)
## Requirements
Installing Jekyll should be straight-forward if all requirements are met.
Before you start, make sure your system has the following:
- GNU/Linux, Unix, or macOS
- [Ruby](https://www.ruby-lang.org/en/downloads/) version 2.1 or above, including all development
headers
- [RubyGems](https://rubygems.org/pages/download)
- [GCC](https://gcc.gnu.org/install/) and [Make](https://www.gnu.org/software/make/) (in case your system doesn't have them installed, which you can check by running `gcc -v` and `make -v` in your system's command line interface)
- [Ruby](https://www.ruby-lang.org/en/downloads/) version 2.2.5 or above, including all development headers (ruby installation can be checked by running `ruby -v`)
- [RubyGems](https://rubygems.org/pages/download) (which you can check by running `gem -v`)
- [GCC](https://gcc.gnu.org/install/) and [Make](https://www.gnu.org/software/make/) (in case your system doesn't have them installed, which you can check by running `gcc -v`,`g++ -v` and `make -v` in your system's command line interface)
#### Only required for Jekyll 2 and earlier
## Install on macOS {#macOS}
- [NodeJS](https://nodejs.org/), or another JavaScript runtime (for CoffeeScript support).
- [Python 2.7](https://www.python.org/downloads/)
We only cover macOS High Sierra 10.13 here, which comes with Ruby 2.3.3, older systems will need to [install a more recent Ruby version via Homebrew](#homebrew).
<div class="note info">
<h5>Problems installing Jekyll?</h5>
<p>
Check out the <a href="../troubleshooting/">troubleshooting</a> page or
<a href="{{ site.repository }}/issues/new">report an issue</a> so the
Jekyll community can improve the experience for everyone.
</p>
</div>
<div class="note info">
<h5>Running Jekyll on Windows</h5>
<p>
While Windows is not officially supported, it is possible to get Jekyll running
on Windows. Special instructions can be found on our
<a href="../windows/#installation">Windows-specific docs page</a>.
</p>
</div>
## Install with RubyGems
The best way to install Jekyll is via
[RubyGems](https://rubygems.org/pages/download). At the terminal prompt,
simply run the following command to install Jekyll:
First, you need to install the command-line tools to be able to compile native extensions, open a terminal and run:
```sh
$ gem install jekyll
xcode-select --install
```
All of Jekylls gem dependencies are automatically installed by the above
command, so you wont have to worry about them at all.
### Set up Ruby included with the OS
Check your Ruby version meet our requirements:
```sh
ruby -v
2.3.3
```
Great, let's install Jekyll. We also need [Bundler](https://bundler.io/) to help us handle [plugins](../plugins) and [themes](../themes):
```sh
gem install bundler jekyll
```
That's it, you're ready to go, either by installing our [default minimal blog theme](https://github.com/jekyll/minima) with `jekyll new jekyll-website` or by starting from scratch:
```sh
mkdir jekyll-website
cd jekyll-website
# Create a Gemfile
bundle init
# Add Jekyll
bundle add jekyll
# Install gems
bundle install
```
Great, from there you can now either use a [theme](../themes/) or [create your own layouts](../templates/).
### Install a newer Ruby version via Homebrew {#homebrew}
If you wish to install the latest version of Ruby and get faster builds, we recommend to do it via [Homebrew](https://brew.sh) a handy package manager for macOS.
```sh
/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
brew install ruby
ruby -v
ruby 2.5.1p57 (2018-03-29 revision 63029) [x86_64-darwin17]
```
Yay! Now you have a shiny Ruby on your system!
### Install multiple Ruby versions with rbenv {#rbenv}
Developers often use [rbenv](https://github.com/rbenv/rbenv) to manage multiple Ruby versions. This can be useful if you want to run the same Ruby version used by [GitHub Pages](https://pages.github.com/versions/) or [Netlify](https://www.netlify.com/docs/#ruby) for instance.
```sh
# Install rbenv and ruby-build
brew install rbenv
# Setup rbenv integration to your shell
rbenv init
# Check your install
curl -fsSL https://github.com/rbenv/rbenv-installer/raw/master/bin/rbenv-doctor | bash
```
Restart your terminal for changes to take effect.
Now we can install the Ruby version of our choice, let's go with Ruby 2.5.1 here:
```sh
rbenv install 2.5.1
rbenv global 2.5.1
ruby -v
ruby 2.5.1p57 (2018-03-29 revision 63029) [x86_64-darwin17]
```
That's it! Head over [rbenv command references](https://github.com/rbenv/rbenv#command-reference) to learn how to use different versions of Ruby in your projects.
<div class="note info" markdown="1">
##### Problems installing Jekyll?
Check out the [troubleshooting](../troubleshooting/) page or
[ask for help on our forum](https://talk.jekyllrb.com).
<div class="note info">
<h5>Installing Xcode Command-Line Tools</h5>
<p>
If you run into issues installing Jekyll's dependencies which make use of
native extensions and are using macOS, you will need to install Xcode
and the Command-Line Tools it ships with. Download them in
<code>Preferences &#8594; Downloads &#8594; Components</code>.
</p>
</div>
## Install on Ubuntu Linux {#ubuntu}
Before we install Jekyll, we need to make sure we have all the required
dependencies.
```sh
sudo apt-get install ruby ruby-dev build-essential
```
It is best to avoid installing Ruby Gems as the root user. Therefore, we need to
set up a gem installation directory for your user account. The following
commands will add environment variables to your `~/.bashrc` file to configure
the gem installation path. Run them now:
```sh
echo '# Install Ruby Gems to ~/gems' >> ~/.bashrc
echo 'export GEM_HOME=$HOME/gems' >> ~/.bashrc
echo 'export PATH=$HOME/gems/bin:$PATH' >> ~/.bashrc
source ~/.bashrc
```
Finally, install Jekyll:
```sh
gem install jekyll bundler
```
That's it! You're ready to start using Jekyll.
## Upgrade Jekyll
Before you start developing with Jekyll, you may want to check that you're up to date with the latest version. To find the currently installed version of Jekyll, run one of these commands:
```sh
jekyll --version
gem list jekyll
```
You can use RubyGems to find [the current version of Jekyll](https://rubygems.org/gems/jekyll). Another way to check if you have the latest version is to run the command `gem outdated`. This will provide a list of all the gems on your system that need to be updated. If you aren't running the latest version, run this command:
```sh
bundle update jekyll
```
Alternatively, if you don't have Bundler installed run:
```sh
gem update jekyll
```
To upgrade to latest Rubygems, run:
```
gem update --system
```
Refer to our [upgrading section](../upgrading/) to upgrade from Jekyll 2.x or 1.x.
## Pre-releases
In order to install a pre-release, make sure you have all the requirements
@@ -86,50 +192,11 @@ more involved. This gives you the advantage of having the latest and greatest,
but may be unstable.
```sh
$ git clone git://github.com/jekyll/jekyll.git
$ cd jekyll
$ script/bootstrap
$ bundle exec rake build
$ ls pkg/*.gem | head -n 1 | xargs gem install -l
```
## Optional Extras
There are a number of (optional) extra features that Jekyll supports that you
may want to install, depending on how you plan to use Jekyll. These extras
include LaTeX support, and the use of alternative content rendering engines.
Check out [the extras page](../extras/) for more information.
<div class="note">
<h5>ProTip™: Enable Syntax Highlighting</h5>
<p>
If youre the kind of person who is using Jekyll, then chances are youll
want to enable syntax highlighting using <a href="http://pygments.org/">Pygments</a>
or <a href="https://github.com/jayferd/rouge">Rouge</a>. You should really
<a href="../templates/#code-snippet-highlighting">check out how to
do that</a> before you go any farther.
</p>
</div>
## Already Have Jekyll?
Before you start developing with Jekyll, you may want to check that you're up to date with the latest version. To find your version of Jekyll, run one of these commands:
```sh
$ jekyll --version
$ gem list jekyll
```
You can also use [RubyGems](https://rubygems.org/gems/jekyll) to find the current versioning of any gem. But you can also use the `gem` command line tool:
```sh
$ gem search jekyll --remote
```
and you'll search for just the name `jekyll`, and in brackets will be latest version. Another way to check if you have the latest version is to run the command `gem outdated`. This will provide a list of all the gems on your system that need to be updated. If you aren't running the latest version, run this command:
```sh
$ gem update jekyll
git clone git://github.com/jekyll/jekyll.git
cd jekyll
script/bootstrap
bundle exec rake build
ls pkg/*.gem | head -n 1 | xargs gem install -l
```
Now that youve got everything up-to-date and installed, lets get to work!

View File

@@ -7,11 +7,11 @@ title: "Avoiding Burnout"
# 1. Use Jekyll
Maintainers of Jekyll should be using it regularly. This is partly because you won't be a good maintainer unless you can put yourself in the shoes of our users but also because you may decide to stop using Jekyll and at that point you should also decide not to be a maintainer and find other things to work on.
Maintainers of Jekyll should be using it regularly. This is partly because you won't be a good maintainer unless you can put yourself in the shoes of our users, but also because you may at some point decide to stop using Jekyll, and at that point you should also decide to stop being a maintainer and find other things to work on.
# 2. No Guilt About Leaving
All maintainers can stop working on Jekyll at any time without any guilt or explanation (like a job). We may still ask for your help with questions after you leave but you are under no obligation to answer them. Like a job, if you create a big mess and then leave you still have no obligations but we may think less of you (or, realistically, probably just revert the problematic work). Like a job, you should probably take a break from Jekyll at least a few times a year.
All maintainers can stop working on Jekyll at any time without any guilt or explanation (like at a job). We may still ask for your help with questions after you leave but you are under no obligation to answer them. If you create a big mess and then leave you still have no obligations but we may think less of you (or, realistically, probably just revert the problematic work). Also, you should probably take a break from Jekyll at least a few times a year.
This also means contributors should be consumers. If a maintainer finds they are not using a project in the real-world, they should reconsider their involvement with the project.

View File

@@ -8,13 +8,14 @@ permalink: /docs/maintaining/
Hello! This is where we document various processes for maintaining Jekyll. Being a maintainer for any Jekyll project is a big responsibility, so we put together some helpful documentation for various tasks you might do as a maintainer.
1. [Affinity teams & their captains](affinity-team-captain/)
2. [Triaging and issue](triaging-an-issue/)
3. [Reviewing a pull request](reviewing-a-pull-request/)
4. [Merging a pull request](merging-a-pull-request/)
5. [Avoiding burnout](avoiding-burnout/)
6. [Special Labels](special-labels/)
- [Affinity teams & their captains](affinity-team-captain/)
- [Triaging an issue](triaging-an-issue/)
- [Reviewing a pull request](reviewing-a-pull-request/)
- [Merging a pull request](merging-a-pull-request/)
- [Avoiding burnout](avoiding-burnout/)
- [Special Labels](special-labels/)
- [Releasing a new version](releasing-a-new-version/)
Interested in becoming a maintainer? Here is some documentation for **contributors**:
1. [Becoming a maintainer](becoming-a-maintainer/)
- [Becoming a maintainer](becoming-a-maintainer/)

View File

@@ -16,7 +16,7 @@ All pull requests should be subject to code review. Code review is a [foundation
We have [a helpful little bot](https://github.com/jekyllbot) which we use to merge pull requests. We don't use the GitHub.com interface for two reasons:
1. You can't modify anything on mobile (e.g. titles, labels)
2. Provide a consistent paper trail in the `History.markdown` file for each release
2. We like to provide a consistent paper trail in the `History.markdown` file for each release
To merge a pull request, leave a comment thanking the contributor, then add the special merge request:
@@ -30,12 +30,12 @@ The merge request is made up of three things:
1. `@jekyllbot:` this is the prefix our bot looks for when processing commands
2. `merge` the command
3. `+dev` the category to which the changes belong
3. `+dev` the category to which the changes belong.
The categories match the H3's in the history/changelog file, and they are:
The categories match the headings in the `History.markdown` file, and they are:
1. Major Enhancements (`+major`) major updates or breaking changes to the code which necessitate a major version bump (v3 ~> v4)
2. Minor Enhancements (`+minor`) minor updates (feature, enhancement) which necessitate a minor version bump (v3.1 ~> v3.2)
2. Minor Enhancements (`+minor`) minor updates (with the labels `feature` or `enhancement`) which necessitate a minor version bump (v3.1 ~> v3.2)
3. Bug Fixes (`+bug`) corrections to code which do not change or add functionality, which necessitate a patch version bump (v3.1.0 ~> v3.1.1)
4. Documentation (`+doc`) - changes to the documentation found in `docs/_docs/`
5. Site Enhancements (`+site`) changes to the source of [https://jekyllrb.com](https://jekyllrb.com) found in `docs/`

View File

@@ -0,0 +1,89 @@
---
title: "Releasing a new version"
---
**This guide is for maintainers.** These special people have **write access** to one or more of Jekyll's repositories and help merge the contributions of others. You may find what is written here interesting, but its definitely not for everyone.
{: .note .info }
The most important thing to understand before making a release is that there's no need to feel nervous. Most things are revertable, and even if you do publish an incomplete gem version, we can always skip that one. Don't hestitate to contact the other maintainers if you feel unsure or don't know what to do next.
### Bump the version
The only important place you need to manually bump the version is in `lib/jekyll/version.rb`. Adjust that, and everything else should work fine.
### Update the history document
Replace the first header of the history document with a version milestone. This looks like the following:
```diff
-## HEAD
+## 3.7.1 / 2018-01-25
```
Adjust the version number and the date. The `## HEAD` heading will be regenerated next time a pull request is merged.
Once you've done this, update the website by running the following command:
```sh
bundle exec rake site:generate
```
This updates the website's changelog, and pushes the versions in various other places.
It's recommended that you go over the `History.markdown` file manually one more time, in case there are any spelling errors or such. Feel free to fix those manually, and after you're done generating the website changelog, commit your changes.
## Write a release post
In case this isn't done already, you can generate a new release post using the included `rake` command:
```sh
bundle exec rake site:releases:new[3.8.0]
```
where `3.8.0` should be replaced with the new version. Then, write the post. Be sure to thank all of the collaborators and maintainers who have contributed since the last release. You can generate a log of their names using the following command:
```sh
git shortlog -sn master...v3.7.2
```
where, again `v3.7.2` is the last release. Be sure to open a pull request for your release post.
### Push the version
Before you do this step, make sure the following things are done:
- You have permission to push a new gem version to RubyGems
- You're logged into RubyGems on your command line
- A release post has been prepared, and is ideally already live
- All of the prior steps are done, committed, and pushed to `master`
Really the only thing left to do is to run this command:
```sh
bundle exec rake release
```
This will automatically build the new gem, make a release commit and tag and then push the new gem to RubyGems. Don't worry about creating a GitHub release, @jekyllbot should take care of that.
And then, you're done! :tada: Feel free to celebrate!
If you have access to the [@jekyllrb](https://twitter.com/jekyllrb) Twitter account, you should tweet the release post from there. If not, just ask another maintainer to do it or to give you access.
### Build the docs
We package our documentation as a :gem: Gem for offline use.
This is done with the
[**jekyll-docs**](https://github.com/jekyll/jekyll-docs#building) repository,
and more detailed instructions are provided there.
## For non-core gems
If you're not a maintainer for `jekyll/jekyll`, the procedure is much simpler in a lot of cases. Generally, the procedure still looks like this:
- Bump the gem version manually, usually in `lib/<plugin_name>/version.rb`
- Adjust the history file
- Run `bundle exec rake release` or `script/release`, depending on which of the two exists
- Rejoice
Be sure to ask your project's maintainers if you're unsure!

View File

@@ -60,7 +60,7 @@ If you have a lot of pages, you can organize those pages into subfolders. The sa
If you have pages organized into subfolders in your source folder and want to flatten them in the root folder on build, you must add the [permalink]({% link _docs/permalinks.md %}) property directly in your page's front matter like this:
```
```yaml
---
title: My page
permalink: mypageurl.html

View File

@@ -9,12 +9,12 @@ multiple pages. Jekyll offers a pagination plugin, so you can automatically
generate the appropriate files and folders you need for paginated listings.
For Jekyll 3, include the `jekyll-paginate` plugin in your Gemfile and in
your `_config.yml` under `gems`. For Jekyll 2, this is standard.
your `_config.yml` under `plugins`. For Jekyll 2, this is standard.
<div class="note info">
<h5>Pagination only works within HTML files</h5>
<p>
Pagination does not work from within Markdown or Textile files from
Pagination does not work from within Markdown files from
your Jekyll site. Pagination works when called from within the HTML
file, named <code>index.html</code>, which optionally may reside in and
produce pagination from within a subdirectory, via the
@@ -24,7 +24,7 @@ your `_config.yml` under `gems`. For Jekyll 2, this is standard.
## Enable pagination
To enable pagination for your blog, add a line to the `_config.yml` file that
To enable pagination for posts on your blog, add a line to the `_config.yml` file that
specifies how many items should be displayed per page:
```yaml
@@ -55,6 +55,14 @@ directory.
</p>
</div>
<div class="note info">
<h5>Pagination for categories, tags and collections</h5>
<p>
The more recent <a href="https://github.com/sverrirs/jekyll-paginate-v2">jekyll-paginate-v2</a> plugin supports more features. See the <a href="https://github.com/sverrirs/jekyll-paginate-v2/tree/master/examples">pagination examples</a> in the repository.
<strong>This plugin is not supported by GitHub Pages</strong>.
</p>
</div>
## Liquid Attributes Available
The pagination plugin exposes the `paginator` liquid object with the following
@@ -145,8 +153,8 @@ the `paginator` variable that will now be available to you. Youll probably
want to do this in one of the main pages of your site. Heres one example of a
simple way of rendering paginated Posts in a HTML file:
```html
{% raw %}
```liquid
---
layout: default
title: My Blog
@@ -177,8 +185,8 @@ title: My Blog
<span class="next ">Next</span>
{% endif %}
</div>
{% endraw %}
```
{% endraw %}
<div class="note warning">
<h5>Beware the page one edge-case</h5>
@@ -192,8 +200,8 @@ title: My Blog
The following HTML snippet should handle page one, and render a list of each
page with links to all but the current page.
```html
{% raw %}
```liquid
{% if paginator.total_pages > 1 %}
<div class="pagination">
{% if paginator.previous_page %}
@@ -219,5 +227,5 @@ page with links to all but the current page.
{% endif %}
</div>
{% endif %}
{% endraw %}
```
{% endraw %}

View File

@@ -6,7 +6,7 @@ permalink: /docs/permalinks/
Permalinks refer to the URLs (excluding the domain name or directory folder) for your pages, posts, or collections.
Jekyll supports a flexible way to build permalinks, allowing you to leverage various template variables or choose built-in permalink styles (such as `date`) that automatically use a template-variable pattern.
You construct permalinks by creating a template URL where dynamic elements are represented by colon-prefixed keywords. The default template permalink is `/:categories/:year/:month/:day/:title.html`. Each of the colon-prefixed keywords is a template variable.
You construct permalinks by creating a template URL where dynamic elements are represented by colon-prefixed keywords. The default template permalink is `/:categories/:year/:month/:day/:title:output_ext`. Each of the colon-prefixed keywords is a template variable.
## Where to configure permalinks
@@ -15,7 +15,7 @@ You can configure your site's permalinks through the [Configuration]({% link _do
Setting permalink styles in your configuration file applies the setting globally in your project. You configure permalinks in your `_config.yml` file like this:
```yaml
permalink: /:categories/:year/:month/:day/:title.html
permalink: /:categories/:year/:month/:day/:title:output_ext
```
If you don't specify any permalink setting, Jekyll uses the above pattern as the default.
@@ -26,7 +26,7 @@ The permalink can also be set using a built-in permalink style:
permalink: date
```
`date` is the same as `:categories/:year/:month/:day/:title.html`, the default. See [Built-in Permalink Styles](#builtinpermalinkstyles) below for more options.
`date` is the same as `:categories/:year/:month/:day/:title:output_ext`, the default. See [Built-in Permalink Styles](#builtinpermalinkstyles) below for more options.
Setting the permalink in your post, page, or collection's front matter overrides any global settings. Here's an example:
@@ -66,7 +66,10 @@ The following table lists the template variables available for permalinks. You c
<p><code>year</code></p>
</td>
<td>
<p>Year from the post's filename</p>
<p>
Year from the post's filename. May be overridden via the documents
<code>date</code> YAML front matter
</p>
</td>
</tr>
<tr>
@@ -74,7 +77,10 @@ The following table lists the template variables available for permalinks. You c
<p><code>month</code></p>
</td>
<td>
<p>Month from the post's filename</p>
<p>
Month from the post's filename. May be overridden via the documents
<code>date</code> YAML front matter
</p>
</td>
</tr>
<tr>
@@ -82,7 +88,10 @@ The following table lists the template variables available for permalinks. You c
<p><code>i_month</code></p>
</td>
<td>
<p>Month from the post's filename without leading zeros.</p>
<p>
Month without leading zeros from the post's filename. May be
overridden via the documents <code>date</code> YAML front matter
</p>
</td>
</tr>
<tr>
@@ -90,7 +99,10 @@ The following table lists the template variables available for permalinks. You c
<p><code>day</code></p>
</td>
<td>
<p>Day from the post's filename</p>
<p>
Day from the post's filename. May be overridden via the documents
<code>date</code> YAML front matter
</p>
</td>
</tr>
<tr>
@@ -98,7 +110,18 @@ The following table lists the template variables available for permalinks. You c
<p><code>i_day</code></p>
</td>
<td>
<p>Day from the post's filename without leading zeros.</p>
<p>
Day without leading zeros from the post's filename. May be overridden
via the documents <code>date</code> YAML front matter
</p>
</td>
</tr>
<tr>
<td>
<p><code>y_day</code></p>
</td>_
<td>
<p>Day of the year from the post's filename, with leading zeros.</p>
</td>
</tr>
<tr>
@@ -106,7 +129,10 @@ The following table lists the template variables available for permalinks. You c
<p><code>short_year</code></p>
</td>
<td>
<p>Year from the post's filename without the century.</p>
<p>
Year without the century from the post's filename. May be overridden
via the documents <code>date</code> YAML front matter
</p>
</td>
</tr>
<tr>
@@ -115,7 +141,8 @@ The following table lists the template variables available for permalinks. You c
</td>
<td>
<p>
Hour of the day, 24-hour clock, zero-padded from the post's <code>date</code> front matter. (00..23)
Hour of the day, 24-hour clock, zero-padded from the post's
<code>date</code> front matter. (00..23)
</p>
</td>
</tr>
@@ -199,7 +226,7 @@ Although you can specify a custom permalink pattern using [template variables](#
<p><code>date</code></p>
</td>
<td>
<p><code>/:categories/:year/:month/:day/:title.html</code></p>
<p><code>/:categories/:year/:month/:day/:title:output_ext</code></p>
</td>
</tr>
<tr>
@@ -215,7 +242,7 @@ Although you can specify a custom permalink pattern using [template variables](#
<p><code>ordinal</code></p>
</td>
<td>
<p><code>/:categories/:year/:y_day/:title.html</code></p>
<p><code>/:categories/:year/:y_day/:title:output_ext</code></p>
</td>
</tr>
<tr>
@@ -223,7 +250,7 @@ Although you can specify a custom permalink pattern using [template variables](#
<p><code>none</code></p>
</td>
<td>
<p><code>/:categories/:title.html</code></p>
<p><code>/:categories/:title:output_ext</code></p>
</td>
</tr>
</tbody>
@@ -270,7 +297,7 @@ Given a post named: `/2009-04-29-slap-chop.md`
</tr>
<tr>
<td>
<p><code>/:month-:day-:year/:title.html</code></p>
<p><code>/:month-:day-:year/:title:output_ext</code></p>
</td>
<td>
<p><code>/04-29-2009/slap-chop.html</code></p>
@@ -303,7 +330,7 @@ The permalink setting in your configuration file specifies the permalink style u
For example:
* A permalink style of `/:categories/:year/:month/:day/:title.html` for posts becomes `/:title.html` for pages and collections.
* A permalink style of `/:categories/:year/:month/:day/:title:output_ext` for posts becomes `/:title.html` for pages and collections.
* A permalink style of `pretty` (or `/:categories/:year/:month/:day/:title/`), which omits the file extension and contains a trailing slash, will update page and collection permalinks to also omit the file extension and contain a trailing slash: `/:title/`.
* A permalink style of `date`, which contains a trailing file extension, will update page permalinks to also contain a trailing file extension: `/:title.html`. But no time or category information will be included.
@@ -327,13 +354,13 @@ As with posts, if you use a permalink style that omits the `.html` file extensio
By default, collections follow a similar structure in the `_site` folder as pages, except that the path is prefaced by the collection name. For example: `collectionname/mypage.html`. For permalink settings that omit the file extension, the path would be `collection_name/mypage/index.html`.
Collections have their own way of setting permalinks. Additionally, collections have unique template variables available available (such as `path` and `output_ext`). See the [Configuring permalinks for collections](../collections/#permalinks) in Collections for more information.
Collections have their own way of setting permalinks. Additionally, collections have unique template variables available (such as `path` and `output_ext`). See the [Configuring permalinks for collections](../collections/#permalinks) in Collections for more information.
## Flattening pages in \_site on build
If you want to flatten your pages (pull them out of subfolders) in the `_site` directory when your site builds (similar to posts), add the `permalink` property to the front matter of each page, with no path specified:
```
```yaml
---
title: My page
permalink: mypageurl.html

View File

@@ -25,27 +25,36 @@ having to modify the Jekyll source itself.
You have 3 options for installing plugins:
1. In your site source root, make a `_plugins` directory. Place your plugins
here. Any file ending in `*.rb` inside this directory will be loaded before
Jekyll generates your site.
2. In your `_config.yml` file, add a new array with the key `plugins` and the
values of the gem names of the plugins you'd like to use. An example:
here. Any file ending in `*.rb` inside this directory will be loaded before
Jekyll generates your site.
2. In your `_config.yml` file, add a new array with the key `plugins` (or `gems` for Jekyll < `3.5.0`) and the
values of the gem names of the plugins you'd like to use. An example:
plugins: [jekyll-coffeescript, jekyll-watch, jekyll-assets]
# This will require each of these plugins automatically.
```yaml
# This will require each of these plugins automatically.
plugins:
- jekyll-gist
- jekyll-coffeescript
- jekyll-assets
- another-jekyll-plugin
```
Then install your plugins using `gem install jekyll-coffeescript jekyll-watch jekyll-assets`
Then install your plugins using `gem install jekyll-gist jekyll-coffeescript jekyll-assets another-jekyll-plugin`
3. Add the relevant plugins to a Bundler group in your `Gemfile`. An
example:
example:
group :jekyll_plugins do
gem "my-jekyll-plugin"
gem "another-jekyll-plugin"
end
Now you need to install all plugins from your Bundler group by running single command `bundle install`
```ruby
group :jekyll_plugins do
gem "jekyll-gist"
gem "jekyll-coffeescript"
gem "jekyll-assets"
gem "another-jekyll-plugin"
end
```
Now you need to install all plugins from your Bundler group by running single command `bundle install`.
<div class="note info">
<h5>
@@ -59,7 +68,25 @@ values of the gem names of the plugins you'd like to use. An example:
</p>
</div>
In general, plugins you make will fall into one of five categories:
### The jekyll_plugins group
Jekyll gives this particular group of gems in your `Gemfile` a different
treatment. Any gem included in this group is loaded before Jekyll starts
processing the rest of your source directory.
A gem included here will be activated even if its not explicitly listed under
the `plugins:` key in your site's config file.
<div class="note warning">
<p>
Gems included in the <code>:jekyll-plugins</code> group are activated
regardless of the <code>--safe</code> mode setting. Be aware of what
gems are included under this group!
</p>
</div>
In general, plugins you make will fall broadly into one of five categories:
1. [Generators](#generators)
2. [Converters](#converters)
@@ -67,6 +94,12 @@ In general, plugins you make will fall into one of five categories:
4. [Tags](#tags)
5. [Hooks](#hooks)
See the bottom of the page for a [list of available plugins](#available-plugins).
For further information on how to develop your own plugins, check out the [Liquid documentation](https://github.com/Shopify/liquid/wiki/Liquid-for-Programmers) as well.
If you never developed a Jekyll plugin [check this useful wrap-up](https://ayastreb.me/writing-a-jekyll-plugin/) by @ayastreb to get started.
## Generators
You can create a generator when you need Jekyll to create additional content
@@ -110,7 +143,6 @@ This is a more complex generator that generates new pages:
```ruby
module Jekyll
class CategoryPage < Page
def initialize(site, base, dir, category)
@site = site
@@ -139,7 +171,6 @@ module Jekyll
end
end
end
end
```
@@ -378,11 +409,11 @@ Liquid::Template.register_tag('render_time', Jekyll::RenderTimeTag)
In the example above, we can place the following tag anywhere in one of our
pages:
```ruby
{% raw %}
```ruby
<p>{% render_time page rendered at: %}</p>
{% endraw %}
```
{% endraw %}
And we would get something like this on the page:
@@ -726,10 +757,6 @@ You can find a few useful plugins at the following locations:
#### Generators
- [ArchiveGenerator by Ilkka Laukkanen](https://gist.github.com/707909): Uses [this archive page](https://gist.github.com/707020) to generate archives.
- [LESS.js Generator by Andy Fowler](https://gist.github.com/642739): Renders
LESS.js files during generation.
- [Version Reporter by Blake Smith](https://gist.github.com/449491): Creates a version.html file containing the Jekyll version.
- [Sitemap.xml Generator by Michael Levin](https://github.com/kinnetica/jekyll-plugins): Generates a sitemap.xml file by traversing all of the available posts and pages.
- [Full-text search by Pascal Widdershoven](https://github.com/PascalW/jekyll_indextank): Adds full-text search to your Jekyll site with a plugin and a bit of JavaScript.
- [AliasGenerator by Thomas Mango](https://github.com/tsmango/jekyll_alias_generator): Generates redirect pages for posts when an alias is specified in the YAML Front Matter.
@@ -745,7 +772,6 @@ LESS.js files during generation.
- [Typescript Generator by Matt Sheehan](https://github.com/sheehamj13/jekyll_ts): Generate Javascript on build from your Typescript.
- [Jekyll::AutolinkEmail by Ivan Tse](https://github.com/ivantsepp/jekyll-autolink_email): Autolink your emails.
- [Jekyll::GitMetadata by Ivan Tse](https://github.com/ivantsepp/jekyll-git_metadata): Expose Git metadata for your templates.
- [Jekyll Http Basic Auth Plugin](https://gist.github.com/snrbrnjna/422a4b7e017192c284b3): Plugin to manage http basic auth for jekyll generated pages and directories.
- [Jekyll Auto Image by Merlos](https://github.com/merlos/jekyll-auto-image): Gets the first image of a post. Useful to list your posts with images or to add [twitter cards](https://dev.twitter.com/cards/overview) to your site.
- [Jekyll Portfolio Generator by Shannon Babincsak](https://github.com/codeinpink/jekyll-portfolio-generator): Generates project pages and computes related projects out of project data files.
- [Jekyll-Umlauts by Arne Gockeln](https://github.com/webchef/jekyll-umlauts): This generator replaces all german umlauts (äöüß) case sensitive with html.
@@ -755,25 +781,23 @@ LESS.js files during generation.
- [Jekyll Art Gallery plugin](https://github.com/alexivkin/Jekyll-Art-Gallery-Plugin): An advanced art/photo gallery generation plugin for creating galleries from a set of image folders. Supports image tagging, thumbnails, sorting, image rotation, post-processing (remove EXIF, add watermark), multiple collections and much more.
- [jekyll-ga](https://github.com/developmentseed/jekyll-ga): A Jekyll plugin that downloads Google Analytics data and adds it to posts. Useful for making a site that lists "most popular" content. [Read the introduction](https://developmentseed.org/blog/google-analytics-jekyll-plugin/) post on the developmentSEED blog.
- [jekyll-multi-paginate](https://github.com/fadhilnapis/jekyll-multi-paginate): Simple Jekyll paginator for multiple page. Ease you to make pagination on multiple page especially like multiple language.
- [jekyll-category-pages](https://github.com/field-theory/jekyll-category-pages): Easy-to-use category index pages with and without pagination. Supports non-URL-safe category keywords and has extensive documentation and test coverage.
- [Tweetsert](https://github.com/ibrado/jekyll-tweetsert): Imports tweets (Twitter statuses) as new posts. Features multiple timeline support, hashtag import, filtering, automatic category and/or tags, optional retweets and replies.
- [Stickyposts](https://github.com/ibrado/jekyll-stickyposts): Moves or copies (pins) posts marked `sticky: true` to the top of the list. Perfect for keeping important announcements on the home page, or giving collections a descriptive entry. Paginator friendly.
- [Jekyll::Paginate::Content](https://github.com/ibrado/jekyll-paginate-content): Content paginator in the style of jekyll-paginator-v2 that splits pages, posts, and collection entries into several pages. Specify a separator or use HTML &lt;h1&gt; etc. headers. Automatic splitting, single-page view, pager/trail, self-adjusting links, multipage TOC, SEO support.
- [Premonition](https://github.com/amedia/premonition): Adds block-styled side content to your page. For example summary, notes, hints or warning boxes.
- [jekyll-fontello](https://github.com/ericcornelissen/jekyll-fontello): A Jekyll plugin that automatically downloads your webfont from Fontello.
- [Target Blank](https://github.com/keithmifsud/jekyll-target-blank): A Jekyll plugin to automatically open external links in a new browser tab or window.
- [jekyll-info](https://github.com/swestmoreland/jekyll-info): A plugin to provide information about your Jekyll sites configuration.
#### Converters
- [Pug plugin by Doug Beney](https://github.com/DougBeney/jekyll-pug): Pug (previously Jade) converter for Jekyll.
- [Pug plugin by Doug Beney](http://jekyll-pug.dougie.io): Use the popular Pug (previously Jade) templating language in Jekyll. Complete with caching, includes support, and much more.
- [Textile converter](https://github.com/jekyll/jekyll-textile-converter): Convert `.textile` files into HTML. Also includes the `textilize` Liquid filter.
- [Slim plugin](https://github.com/slim-template/jekyll-slim): Slim converter and includes for Jekyll with support for Liquid tags.
- [HAML plugin by Sam Z](https://gist.github.com/517556): HAML converter for Jekyll.
- [HAML-Sass Converter by Adam Pearson](https://gist.github.com/481456): Simple HAML-Sass converter for Jekyll. [Fork](https://gist.github.com/528642) by Sam X.
- [Sass SCSS Converter by Mark Wolfe](https://gist.github.com/960150): Sass converter which uses the new CSS compatible syntax, based Sam Xs fork above.
- [LESS Converter by Jason Graham](https://gist.github.com/639920): Convert LESS files to CSS.
- [LESS Converter by Josh Brown](https://gist.github.com/760265): Simple LESS converter.
- [Upcase Converter by Blake Smith](https://gist.github.com/449463): An example Jekyll converter.
- [CoffeeScript Converter by phaer](https://gist.github.com/959938): A [CoffeeScript](http://coffeescript.org) to Javascript converter.
- [Markdown References by Olov Lassus](https://github.com/olov/jekyll-references): Keep all your markdown reference-style link definitions in one \_references.md file.
- [Stylus Converter](https://gist.github.com/988201): Convert .styl to .css.
- [ReStructuredText Converter](https://github.com/xdissent/jekyll-rst): Converts ReST documents to HTML with Pygments syntax highlighting.
- [Jekyll-pandoc-multiple-formats](https://github.com/fauno/jekyll-pandoc-multiple-formats) by [edsl](https://github.com/edsl): Use pandoc to generate your site in multiple formats. Supports pandocs markdown extensions.
- [Transform Layouts](https://gist.github.com/1472645): Allows HAML layouts (you need a HAML Converter plugin for this to work).
- [Org-mode Converter](https://gist.github.com/abhiyerra/7377603): Org-mode converter for Jekyll.
- [Customized Kramdown Converter](https://github.com/mvdbos/kramdown-with-pygments): Enable Pygments syntax highlighting for Kramdown-parsed fenced code blocks.
- [Bigfootnotes Plugin](https://github.com/TheFox/jekyll-bigfootnotes): Enables big footnotes for Kramdown.
- [AsciiDoc Plugin](https://github.com/asciidoctor/jekyll-asciidoc): AsciiDoc convertor for Jekyll using [Asciidoctor](http://asciidoctor.org/).
@@ -784,10 +808,7 @@ LESS.js files during generation.
- [Truncate HTML](https://github.com/MattHall/truncatehtml) by [Matt Hall](https://codebeef.com/): A Jekyll filter that truncates HTML while preserving markup structure.
- [Domain Name Filter by Lawrence Woodman](https://github.com/LawrenceWoodman/domain_name-liquid_filter): Filters the input text so that just the domain name is left.
- [Summarize Filter by Mathieu Arnold](https://gist.github.com/731597): Remove markup after a `<div id="extended">` tag.
- [i18n_filter](https://github.com/gacha/gacha.id.lv/blob/master/_plugins/i18n_filter.rb): Liquid filter to use I18n localization.
- [Smilify](https://github.com/SaswatPadhi/jekyll_smilify) by [SaswatPadhi](https://github.com/SaswatPadhi): Convert text emoticons in your content to themeable smiley pics.
- [Read in X Minutes](https://gist.github.com/zachleat/5792681) by [zachleat](https://github.com/zachleat): Estimates the reading time of a string (for blog post content).
- [Jekyll-timeago](https://github.com/markets/jekyll-timeago): Converts a time value to the time ago in words.
- [pluralize](https://github.com/bdesham/pluralize): Easily combine a number and a word into a grammatically-correct amount like “1 minute” or “2 minute**s**”.
- [reading_time](https://github.com/bdesham/reading_time): Count words and estimate reading time for a piece of text, ignoring HTML elements that are unlikely to contain running text.
@@ -798,7 +819,6 @@ LESS.js files during generation.
- [Deprecated articles keeper](https://github.com/kzykbys/JekyllPlugins) by [Kazuya Kobayashi](http://blog.kazuya.co/): A simple Jekyll filter which monitor how old an article is.
- [Jekyll-jalali](https://github.com/mehdisadeghi/jekyll-jalali) by [Mehdi Sadeghi](http://mehdix.ir): A simple Gregorian to Jalali date converter filter.
- [Jekyll Thumbnail Filter](https://github.com/matallo/jekyll-thumbnail-filter): Related posts thumbnail filter.
- [Jekyll-Smartify](https://github.com/pathawks/jekyll-smartify): SmartyPants filter. Make &quot;quotes&quot; &ldquo;curly&rdquo;
- [liquid-md5](https://github.com/pathawks/liquid-md5): Returns an MD5 hash. Helpful for generating Gravatars in templates.
- [jekyll-roman](https://github.com/paulrobertlloyd/jekyll-roman): A liquid filter for Jekyll that converts numbers into Roman numerals.
- [jekyll-typogrify](https://github.com/myles/jekyll-typogrify): A Jekyll plugin that brings the functions of [typogruby](http://avdgaag.github.io/typogruby/).
@@ -807,35 +827,26 @@ LESS.js files during generation.
- [match_regex](https://github.com/sparanoid/match_regex): A Liquid filter to perform regex match.
- [replace_regex](https://github.com/sparanoid/replace_regex): A Liquid filter to perform regex replace.
- [Jekyll Money](https://rubygems.org/gems/jekyll-money): A Jekyll plugin for dealing with money. Because we all have to at some point.
- [jekyll-random](https://github.com/codecalm/jekyll-random) by [codecalm](https://nodecalm.net): A Jekyll plugin that generates pseudo-random data. Very useful when you want to generate a large amount of random data.
- [jekyll-firstimage](https://github.com/nhoizey/jekyll-firstimage) adds a Liquid filter finding the first image in a HTML content string, including responsive images srcset.
#### Tags
You can find a few useful plugins at the following locations:
- [Jekyll-gist](https://github.com/jekyll/jekyll-gist): Use the `gist` tag to easily embed a GitHub Gist onto your site. This works with public or secret gists.
- [Asset Path Tag](https://github.com/samrayner/jekyll-asset-path-plugin) by [Sam Rayner](http://www.samrayner.com/): Allows organisation of assets into subdirectories by outputting a path for a given file relative to the current post or page.
- [Delicious Plugin by Christian Hellsten](https://github.com/christianhellsten/jekyll-plugins): Fetches and renders bookmarks from delicious.com.
- [Ultraviolet Plugin by Steve Alex](https://gist.github.com/480380): Jekyll tag for the [Ultraviolet](https://github.com/grosser/ultraviolet) code highligher.
- [Tag Cloud Plugin by Ilkka Laukkanen](https://gist.github.com/710577): Generate a tag cloud that links to tag pages.
- [GIT Tag by Alexandre Girard](https://gist.github.com/730347): Add Git activity inside a list.
- [MathJax Liquid Tags by Jessy Cowan-Sharp](https://gist.github.com/834610): Simple liquid tags for Jekyll that convert inline math and block equations to the appropriate MathJax script tags.
- [Non-JS Gist Tag by Brandon Tilley](https://gist.github.com/1027674) A Liquid tag that embeds Gists and shows code for non-JavaScript enabled browsers and readers.
- [Render Time Tag by Blake Smith](https://gist.github.com/449509): Displays the time a Jekyll page was generated.
- [Status.net/OStatus Tag by phaer](https://gist.github.com/912466): Displays the notices in a given status.net/ostatus feed.
- [Embed.ly client by Robert Böhnke](https://github.com/robb/jekyll-embedly-client): Autogenerate embeds from URLs using oEmbed.
- [Logarithmic Tag Cloud](https://gist.github.com/2290195): Flexible. Logarithmic distribution. Documentation inline.
- [oEmbed Tag by Tammo van Lessen](https://gist.github.com/1455726): Enables easy content embedding (e.g. from YouTube, Flickr, Slideshare) via oEmbed.
- [FlickrSetTag by Thomas Mango](https://github.com/tsmango/jekyll_flickr_set_tag): Generates image galleries from Flickr sets.
- [Tweet Tag by Scott W. Bradley](https://github.com/scottwb/jekyll-tweet-tag): Liquid tag for [Embedded Tweets](https://dev.twitter.com/docs/embedded-tweets) using Twitters shortcodes.
- [Jekyll Twitter Plugin](https://github.com/rob-murray/jekyll-twitter-plugin): A Liquid tag plugin that renders Tweets from Twitter API. Currently supports the [oEmbed](https://dev.twitter.com/rest/reference/get/statuses/oembed) API.
- [Jekyll-contentblocks](https://github.com/rustygeldmacher/jekyll-contentblocks): Lets you use Rails-like content_for tags in your templates, for passing content from your posts up to your layouts.
- [Generate YouTube Embed](https://gist.github.com/1805814) by [joelverhagen](https://github.com/joelverhagen): Jekyll plugin which allows you to embed a YouTube video in your page with the YouTube ID. Optionally specify width and height dimensions. Like “oEmbed Tag” but just for YouTube.
- [Jekyll-beastiepress](https://github.com/okeeblow/jekyll-beastiepress): FreeBSD utility tags for Jekyll sites.
- [Jsonball](https://gist.github.com/1895282): Reads json files and produces maps for use in Jekyll files.
- [Bibjekyll](https://github.com/pablooliveira/bibjekyll): Render BibTeX-formatted bibliographies/citations included in posts and pages using bibtex2html.
- [Jekyll-citation](https://github.com/archome/jekyll-citation): Render BibTeX-formatted bibliographies/citations included in posts and pages (pure Ruby).
- [Jekyll Dribbble Set Tag](https://github.com/ericdfields/Jekyll-Dribbble-Set-Tag): Builds Dribbble image galleries from any user.
- [Debbugs](https://gist.github.com/2218470): Allows posting links to Debian BTS easily.
- [Jekyll-devonly_tag](https://gist.github.com/2403522): A block tag for including markup only during development.
- [JekyllGalleryTag](https://github.com/redwallhp/JekyllGalleryTag) by [redwallhp](https://github.com/redwallhp): Generates thumbnails from a directory of images and displays them in a grid.
- [Youku and Tudou Embed](https://gist.github.com/Yexiaoxing/5891929): Liquid plugin for embedding Youku and Tudou videos.
- [Jekyll-swfobject](https://github.com/sectore/jekyll-swfobject): Liquid plugin for embedding Adobe Flash files (.swf) using [SWFObject](https://github.com/swfobject/swfobject).
- [Jekyll Picture Tag](https://github.com/robwierzbowski/jekyll-picture-tag): Easy responsive images for Jekyll. Based on the proposed [`<picture>`](https://html.spec.whatwg.org/multipage/embedded-content.html#the-picture-element) element, polyfilled with Scott Jehls [Picturefill](https://github.com/scottjehl/picturefill).
- [Jekyll Image Tag](https://github.com/robwierzbowski/jekyll-image-tag): Better images for Jekyll. Save image presets, generate resized images, and add classes, alt text, and other attributes.
@@ -845,8 +856,6 @@ LESS.js files during generation.
- [Jekyll Date Chart](https://github.com/GSI/jekyll_date_chart) by [GSI](https://github.com/GSI): Block that renders date line charts based on textile-formatted tables.
- [Jekyll Image Encode](https://github.com/GSI/jekyll_image_encode) by [GSI](https://github.com/GSI): Tag that renders base64 codes of images fetched from the web.
- [Jekyll Quick Man](https://github.com/GSI/jekyll_quick_man) by [GSI](https://github.com/GSI): Tag that renders pretty links to man page sources on the internet.
- [jekyll-font-awesome](https://gist.github.com/23maverick23/8532525): Quickly and easily add Font Awesome icons to your posts.
- [Lychee Gallery Tag](https://gist.github.com/tobru/9171700) by [tobru](https://github.com/tobru): Include [Lychee](https://lychee.electerious.com/) albums into a post. For an introduction, see [Jekyll meets Lychee - A Liquid Tag plugin](https://tobrunet.ch/articles/jekyll-meets-lychee-a-liquid-tag-plugin/)
- [Image Set/Gallery Tag](https://github.com/callmeed/jekyll-image-set) by [callmeed](https://github.com/callmeed): Renders HTML for an image gallery from a folder in your Jekyll site. Just pass it a folder name and class/tag options.
- [jekyll_figure](https://github.com/lmullen/jekyll_figure): Generate figures and captions with links to the figure in a variety of formats
- [Jekyll GitHub Sample Tag](https://github.com/bwillis/jekyll-github-sample): A liquid tag to include a sample of a github repo file in your Jekyll site.
@@ -875,7 +884,13 @@ LESS.js files during generation.
- [Jekyll If File Exists](https://github.com/k-funk/jekyll-if-file-exists): A Jekyll Plugin that checks if a file exists with an if/else block.
- [BibSonomy](https://github.com/rjoberon/bibsonomy-jekyll): Jekyll
plugin to generate publication lists from [BibSonomy](https://www.bibsonomy.org/).
- [github-cards](https://github.com/edward-shen/github-cards): Creates styleable Github cards for your Github projects.
- [disqus-for-jekyll](https://github.com/kacperduras/disqus-for-jekyll): A Jekyll plugin to view the comments powered by Disqus.
- [jekyll-html](https://github.com/kacperduras/jekyll-html): A Jekyll plugin to use HTML tags in Jekyll pages, posts and collections.
- [jekyll-onebox](https://github.com/rriemann/jekyll-onebox): Liquid tag for displaying HTML previews (embeds) for links to popular domains. Plugin is based on [Onebox](https://github.com/discourse/onebox) that powers link previews in [Discourse](http://github.com/discourse/discourse) forums.
- [jekyll-w2m](https://github.com/kacperduras/jekyll-w2m): A Jekyll plugin to liberate content from Microsoft Word documents (powered by [word-to-markdown](https://github.com/benbalter/word-to-markdown)).
- [jekyll-flickr](https://github.com/rriemann/jekyll-flickr): Liquid tag for responsive Flickr images using HTML5 srcset. Subtitles and automatic license notices are supported.
- [CAT](https://github.com/binfalse/jekyll-cat): Include the contents of any file (like the `include` command, but also for files outside of `_include`). Similar to Unix' `cat` tool; useful for including source code etc. in posts and pages.
#### Collections
@@ -885,24 +900,18 @@ LESS.js files during generation.
#### Other
- [Analytics for Jekyll](https://github.com/hendrikschneider/jekyll-analytics) by Hendrik Schneider: An effortless way to add various trackers like Google Analytics, Piwik, etc. to your site
- [Analytics for Jekyll](https://github.com/hendrikschneider/jekyll-analytics) by Hendrik Schneider: An effortless way to add various trackers like Google Analytics, Matomo (formerly Piwik), mPulse, etc. to your site.
- [ditaa-ditaa](https://github.com/tmthrgd/ditaa-ditaa) by Tom Thorogood: a drastic revision of jekyll-ditaa that renders diagrams drawn using ASCII art into PNG images.
- [Pygments Cache Path by Raimonds Simanovskis](https://github.com/rsim/blog.rayapps.com/blob/master/_plugins/pygments_cache_patch.rb): Plugin to cache syntax-highlighted code from Pygments.
- [Draft/Publish Plugin by Michael Ivey](https://gist.github.com/49630): Save posts as drafts.
- [Growl Notification Generator by Tate Johnson](https://gist.github.com/490101): Send Jekyll notifications to Growl.
- [Growl Notification Hook by Tate Johnson](https://gist.github.com/525267): Better alternative to the above, but requires his “hook” fork.
- [Related Posts by Lawrence Woodman](https://github.com/LawrenceWoodman/related_posts-jekyll_plugin): Overrides `site.related_posts` to use categories to assess relationship.
- [jekyll-tagging-related_posts](https://github.com/toshimaru/jekyll-tagging-related_posts): Jekyll related_posts function based on tags (works on Jekyll3).
- [Tiered Archives by Eli Naeher](https://gist.github.com/88cda643aa7e3b0ca1e5): Create tiered template variable that allows you to group archives by year and month.
- [Jekyll-localization](https://github.com/blackwinter/jekyll-localization): Jekyll plugin that adds localization features to the rendering engine.
- [Jekyll-rendering](https://github.com/blackwinter/jekyll-rendering): Jekyll plugin to provide alternative rendering engines.
- [Jekyll-pagination](https://github.com/blackwinter/jekyll-pagination): Jekyll plugin to extend the pagination generator.
- [Jekyll-tagging](https://github.com/pattex/jekyll-tagging): Jekyll plugin to automatically generate a tag cloud and tag pages.
- [Jekyll-scholar](https://github.com/inukshuk/jekyll-scholar): Jekyll extensions for the blogging scholar.
- [Jekyll-asset_bundler](https://github.com/moshen/jekyll-asset_bundler): Bundles and minifies JavaScript and CSS.
- [Jekyll-assets](http://jekyll.github.io/jekyll-assets/) by [ixti](https://github.com/ixti): Rails-alike assets pipeline (write assets in CoffeeScript, Sass, LESS etc; specify dependencies for automatic bundling using simple declarative comments in assets; minify and compress; use JST templates; cache bust; and many-many more).
- [JAPR](https://github.com/kitsched/japr): Jekyll Asset Pipeline Reborn - Powerful asset pipeline for Jekyll that collects, converts and compresses JavaScript and CSS assets.
- [File compressor](https://gist.github.com/2758691) by [mytharcher](https://github.com/mytharcher): Compress HTML and JavaScript files on site build.
- [Jekyll-minibundle](https://github.com/tkareine/jekyll-minibundle): Asset bundling and cache busting using external minification tool of your choice. No gem dependencies.
- [Singlepage-jekyll](https://github.com/JCB-K/singlepage-jekyll) by [JCB-K](https://github.com/JCB-K): Turns Jekyll into a dynamic one-page website.
- [generator-jekyllrb](https://github.com/robwierzbowski/generator-jekyllrb): A generator that wraps Jekyll in [Yeoman](http://yeoman.io/), a tool collection and workflow for building modern web apps.
@@ -929,20 +938,15 @@ LESS.js files during generation.
- [Jekyll-Post](https://github.com/robcrocombe/jekyll-post): A CLI tool to easily draft, edit, and publish Jekyll posts.
- [jekyll-numbered-headings](https://github.com/muratayusuke/jekyll-numbered-headings): Adds ordered number to headings.
- [jekyll-pre-commit](https://github.com/mpchadwick/jekyll-pre-commit): A framework for running checks against your posts using a git pre-commit hook before you publish them.
#### Editors
- [sublime-jekyll](https://github.com/23maverick23/sublime-jekyll): A Sublime Text package for Jekyll static sites. This package should help creating Jekyll sites and posts easier by providing access to key template tags and filters, as well as common completions and a current date/datetime command (for dating posts). You can install this package manually via GitHub, or via [Package Control](https://packagecontrol.io/packages/Jekyll).
- [vim-jekyll](https://github.com/parkr/vim-jekyll): A vim plugin to generate
new posts and run `jekyll build` all without leaving vim.
- [markdown-writer](https://atom.io/packages/markdown-writer): An Atom package for Jekyll. It can create new posts/drafts, manage tags/categories, insert link/images and add many useful key mappings.
- [Wordpress2Jekyll](https://wordpress.org/plugins/wp2jekyll/): A Wordpress plugin that allows you to use Wordpress as your editor and (automatically) export content in to Jekyll. WordPress2Jekyll attempts to marry these two systems together in order to make a site that can be easily managed from all devices.
- [jekyll-pwa-plugin](https://github.com/lavas-project/jekyll-pwa): A plugin provides PWA support for Jekyll. It generates a service worker in Jekyll build process and makes precache and runtime cache available in the runtime with Google Workbox.
- [jekyll-algolia](https://community.algolia.com/jekyll-algolia/): Add fast and relevant search to your Jekyll site through the Algolia API.
- [jekyll-get](https://github.com/18F/jekyll-get): Download data from external JSON API sources to use in generating a site.
- [jekyll-xml-source](https://github.com/mcred/jekyll-xml-source): Download XML and RSS from external sites for use in site data.
<div class="note info">
<h5>Jekyll Plugins Wanted</h5>
<h5>Submit your gem plugins</h5>
<p>
If you have a Jekyll plugin that you would like to see added to this list,
you should <a href="../contributing/">read the contributing page</a> to find
You're encouraged to add your Jekyll gem plugins to this list, <a href="../contributing/">read the contributing page</a> to find
out how to make that happen.
</p>
</div>

View File

@@ -26,7 +26,7 @@ To create a new post, all you need to do is create a file in the `_posts`
directory. How you name files in this folder is important. Jekyll requires blog
post files to be named according to the following format:
```sh
```
YEAR-MONTH-DAY-title.MARKUP
```
@@ -34,7 +34,7 @@ Where `YEAR` is a four-digit number, `MONTH` and `DAY` are both two-digit
numbers, and `MARKUP` is the file extension representing the format used in the
file. For example, the following are examples of valid post filenames:
```sh
```
2011-12-31-new-years-eve-is-awesome.md
2012-09-12-how-to-write-a-blog.md
```
@@ -78,55 +78,54 @@ digital assets along with your text content. While the syntax for linking to
these resources differs between Markdown and Textile, the problem of working
out where to store these files in your site is something everyone will face.
There are a number of ways to include digital assets in Jekyll.
There are a number of ways to include digital assets in Jekyll.
One common solution is to create a folder in the root of the project directory
called something like `assets` or `downloads`, into which any images, downloads
called something like `assets`, into which any images, files
or other resources are placed. Then, from within any post, they can be linked
to using the sites root as the path for the asset to include. Again, this will
depend on the way your sites (sub)domain and path are configured, but here are
some examples (in Markdown) of how you could do this using the `site.url`
variable in a post.
some examples in Markdown of how you could do this using the `absolute_url`
filter in a post.
Including an image asset in a post:
```text
{% raw %}
```markdown
... which is shown in the screenshot below:
![My helpful screenshot]({% raw %}{{ site.url }}{% endraw %}/assets/screenshot.jpg)
![My helpful screenshot]({{ "/assets/screenshot.jpg" | absolute_url }})
```
{% endraw %}
Linking to a PDF for readers to download:
```text
... you can [get the PDF]({% raw %}{{ site.url }}{% endraw %}/assets/mydoc.pdf) directly.
{% raw %}
```markdown
... you can [get the PDF]({{ "/assets/mydoc.pdf" | absolute_url }}) directly.
```
{% endraw %}
<div class="info">
<div class="note">
<h5>ProTip™: Link using just the site root URL</h5>
<p>
You can skip the <code>{% raw %}{{ site.url }}{% endraw %}</code> variable
if you <strong>know</strong> your site will only ever be displayed at the
root URL of your domain. In this case you can reference assets directly with
just <code>/path/file.jpg</code>.
</p>
</div>
## A typical post
Jekyll can handle many different iterations of the idea you might associate with a "post," however a standard blog style post, including a Title, Layout, Publishing Date, and Categories might look like this:
```
```markdown
---
layout: post
title: "Welcome to Jekyll!"
date: 2015-11-17 16:16:01 -0600
categories: jekyll update
---
Youll find this post in your `_posts` directory. Go ahead and edit it and re-build the site to see your changes. You can rebuild the site in many different ways, but the most common way is to run `bundle exec jekyll serve`, which launches a web server and auto-regenerates your site when a file is updated.
To add new posts, simply add a file in the `_posts` directory that follows the convention `YYYY-MM-DD-name-of-post.ext` and includes the necessary front matter. Take a look at the source for this post to get an idea about how it works.
```
Everything in between the first and second `---` are part of the YAML Front Matter, and everything after the second `---` will be rendered with Markdown and show up as "Content."
Everything in between the first and second `---` are part of the YAML Front Matter, and everything after the second `---` will be rendered with Markdown and show up as "Content".
## Displaying an index of posts
@@ -136,15 +135,17 @@ you have a list of posts somewhere. Creating an index of posts on another page
language](https://docs.shopify.com/themes/liquid/basics) and its tags. Heres a
basic example of how to create a list of links to your blog posts:
{% raw %}
```html
<ul>
{% raw %}{% for post in site.posts %}{% endraw %}
{% for post in site.posts %}
<li>
<a href="{% raw %}{{ post.url }}{% endraw %}">{% raw %}{{ post.title }}{% endraw %}</a>
<a href="{{ post.url }}">{{ post.title }}</a>
</li>
{% raw %}{% endfor %}{% endraw %}
{% endfor %}
</ul>
```
{% endraw %}
Of course, you have full control over how (and where) you display your posts,
and how you structure your site. You should read more about [how templates
@@ -155,39 +156,116 @@ you wish to access the currently-rendering page/posts's variables (the
variables of the post/page that has the `for` loop in it), use the `page`
variable instead.
## Displaying post categories or tags
Hey, that's pretty neat, but what about showing just some of your posts that are
related to each other? For that you can use any of the [variables definable in
Front Matter](https://jekyllrb.com/docs/frontmatter/). In the "typical post"
section you can see how to define categories. Simply add the categories to your
Front Matter as a [yaml
list](https://en.wikipedia.org/wiki/YAML#Basic_components).
Now that your posts have a category or multiple categories, you can make a page
or a template displaying just the posts in those categories you specify. Here's
a basic example of how to create a list of posts from a specific category.
First, in the `_layouts` directory create a new file called `category.html` - in
that file put (at least) the following:
{% raw %}
```liquid
---
layout: page
---
{% for post in site.categories[page.category] %}
<a href="{{ post.url | absolute_url }}">
{{ post.title }}
</a>
{% endfor %}
```
{% endraw %}
Next, in the root directory of your Jekyll install, create a new directory
called `category` and then create a file for each category you want to list. For
example, if you have a category `blog` then create a file in the new directory
called `blog.html` with at least
```yaml
---
layout: category
title: Blog
category: blog
---
```
In this case, the listing pages will be accessible at `{baseurl}/category/blog.html`
Although categories and tags are very similar, they are used to group posts,
there are a few differences between them. Categories and sub-categories create
hierarchies that, by default, are reflected in the directory structure of your
site. A post with the following header
```yaml
---
layout: post
title: A Trip
category: [ blog, travel ]
---
```
will be accessible at `{baseurl}/blog/travel/year/month/day/A-Trip.html`. On
the other hand, a tagged post
```yaml
---
layout: post
title: A Trip
tags: [ blog, travel ]
---
```
will be saved as `{baseurl}/year/month/day/A-Trip.html`. It is up to you to
create `{baseurl}/tag/blog.html` and `{baseurl}/tag/travel.html` the same way as
described above for categories.
While this example is done with tags and categories, you can easily extend your
lists to filter by any other variable created with extensions.
## Post excerpts
Each post automatically takes the first block of text, from the beginning of
the content to the first occurrence of `excerpt_separator`, and sets it as the `post.excerpt`.
the content to the first occurrence of `excerpt_separator`, and sets it in the
post's data hash.
Take the above example of an index of posts. Perhaps you want to include
a little hint about the post's content by adding the first paragraph of each of
your posts:
```html
{% raw %}
```liquid
<ul>
{% raw %}{% for post in site.posts %}{% endraw %}
{% for post in site.posts %}
<li>
<a href="{% raw %}{{ post.url }}{% endraw %}">{% raw %}{{ post.title }}{% endraw %}</a>
{% raw %}{{ post.excerpt }}{% endraw %}
<a href="{{ post.url }}">{{ post.title }}</a>
{{ post.excerpt }}
</li>
{% raw %}{% endfor %}{% endraw %}
{% endfor %}
</ul>
```
{% endraw %}
Because Jekyll grabs the first paragraph you will not need to wrap the excerpt
in `p` tags, which is already done for you. These tags can be removed with the
following if you'd prefer:
```html
{% raw %}{{ post.excerpt | remove: '<p>' | remove: '</p>' }}{% endraw %}
{% raw %}
```liquid
{{ post.excerpt | remove: '<p>' | remove: '</p>' }}
```
{% endraw %}
If you don't like the automatically-generated post excerpt, it can be
explicitly overridden by adding an `excerpt` value to your post's YAML
Front Matter. Alternatively, you can choose to define a custom
`excerpt_separator` in the post's YAML front matter:
```text
```yaml
---
excerpt_separator: <!--more-->
---
@@ -214,8 +292,9 @@ Jekyll also has built-in support for syntax highlighting of code snippets using
either Pygments or Rouge, and including a code snippet in any post is easy.
Just use the dedicated Liquid tag as follows:
```text
{% raw %}{% highlight ruby %}{% endraw %}
{% raw %}
```liquid
{% highlight ruby %}
def show
@widget = Widget(params[:id])
respond_to do |format|
@@ -223,8 +302,9 @@ def show
format.json { render json: @widget }
end
end
{% raw %}{% endhighlight %}{% endraw %}
{% endhighlight %}
```
{% endraw %}
And the output will look like this:

View File

@@ -8,16 +8,16 @@ If you already have a full [Ruby](https://www.ruby-lang.org/en/downloads/) devel
```sh
# Install Jekyll and Bundler gems through RubyGems
~ $ gem install jekyll bundler
gem install jekyll bundler
# Create a new Jekyll site at ./myblog
~ $ jekyll new myblog
jekyll new myblog
# Change into your new directory
~ $ cd myblog
cd myblog
# Build the site on the preview server
~/myblog $ bundle exec jekyll serve
bundle exec jekyll serve
# Now browse to http://localhost:4000
```
@@ -26,13 +26,15 @@ If you encounter any unexpected errors during the above, please refer to the [tr
## About Bundler
`gem install jekyll bundler` installs the [jekyll](https://rubygems.org/gems/jekyll/) and [bundler](https://rubygems.org/gems/bundler) gems through [RubyGems](https://rubygems.org/). You need only to install the gems one time &mdash; not every time you create a new Jekyll project. Here are some additional details:
`gem install bundler` installs the [bundler](https://rubygems.org/gems/bundler) gem through [RubyGems](https://rubygems.org/). You only need to install it once &mdash; not every time you create a new Jekyll project. Here are some additional details:
* `bundler` is a gem that manages other Ruby gems. It makes sure your gems and gem versions are compatible, and that you have all necessary dependencies each gem requires.
* The `Gemfile` and `Gemfile.lock` files inform Bundler about the gem requirements in your site. If your site doesn't have these Gemfiles, you can omit `bundle exec` and just run `jekyll serve`.
* When you run `bundle exec jekyll serve`, Bundler uses the gems and versions as specified in `Gemfile.lock` to ensure your Jekyll site builds with no compatibility or dependency conflicts.
For more information about how to use Bundler in your Jekyll project, this [tutorial](https://jekyllrb.com/tutorials/using-jekyll-with-bundler/) should provide answers to the most common questions and explain how to get up and running quickly.
## Options for creating a new site with Jekyll
`jekyll new <PATH>` installs a new Jekyll site at the path specified (relative to current directory). In this case, Jekyll will be installed in a directory called `myblog`. Here are some additional details:

View File

@@ -3,41 +3,60 @@ title: Resources
permalink: /docs/resources/
---
Jekylls growing use is producing a wide variety of tutorials, frameworks, extensions, examples, and other resources that can be very helpful. Below is a collection of links to some of the most popular Jekyll resources.
Jekyll's growing use is producing a wide variety of tutorials, frameworks, extensions, examples, and other resources that can be very helpful. Below is a collection of links to some of the most popular Jekyll resources.
### Useful Guides
## Editors
- [Jekyll Tips](http://jekyll.tips) is a set of resources created by [CloudCannon](https://cloudcannon.com) to help folks get up and running with Jekyll. They cover all skill levels, and even include some great video tutorials.
- [Jekyll Cheatsheet](http://jekyll.tips/jekyll-cheat-sheet/) is a single-page resource for Jekyll filters, variables, and the like.
- [“Creating and Hosting a Personal Site on GitHub”](http://jmcglone.com/guides/github-pages/)
- [Build A Blog With Jekyll And GitHub Pages on Smashing Magazine](https://www.smashingmagazine.com/2014/08/01/build-blog-jekyll-github-pages/)
- [jekyll-atom](https://atom.io/packages/jekyll): A collection of snippets and tools for Jekyll in Atom
- [markdown-writer](https://atom.io/packages/markdown-writer): An Atom package for Jekyll. It can create new posts/drafts, manage tags/categories, insert link/images and add many useful key mappings.
- [sublime-jekyll](https://github.com/23maverick23/sublime-jekyll): A Sublime Text package for Jekyll static sites. This package should help creating Jekyll sites and posts easier by providing access to key template tags and filters, as well as common completions and a current date/datetime command (for dating posts). You can install this package manually via GitHub, or via [Package Control](https://packagecontrol.io/packages/Jekyll).
- [vim-jekyll](https://github.com/parkr/vim-jekyll): A vim plugin to generate new posts and run `jekyll build` all without leaving vim.
- [WordPress2Jekyll](https://wordpress.org/plugins/wp2jekyll/): A WordPress plugin that allows you to use WordPress as your editor and (automatically) export content in to Jekyll. WordPress2Jekyll attempts to marry these two systems together in order to make a site that can be easily managed from all devices.
## Useful Guides
- [CloudCannon Academy](https://learn.cloudcannon.com/) is a set of resources created by [CloudCannon](https://cloudcannon.com/) to help folks get up and running with Jekyll. They cover all skill levels, and even include some great video tutorials.
- [Jekyll Cheatsheet](https://learn.cloudcannon.com/jekyll-cheat-sheet/) is a single-page resource for Jekyll filters, variables, and the like.
- ["Creating and Hosting a Personal Site on GitHub"](http://jmcglone.com/guides/github-pages/)
- ['Build A Blog With Jekyll And GitHub Pages' on Smashing Magazine](https://www.smashingmagazine.com/2014/08/01/build-blog-jekyll-github-pages/)
- Publishing to GitHub Pages? [Check out our documentation page for just that purpose](/docs/github-pages/).
- [Blogging with Git, Emacs and Jekyll](https://metajack.im/2009/01/23/blogging-with-git-emacs-and-jekyll/)
- [Tips for working with GitHub Pages Integration](https://gist.github.com/jedschneider/2890453)
### Integrations
## Integrations
- Use a saas service as a backend for forms (contact forms, hiring forms, etc.)
- [Formspree (also open source)](https://formspree.io/)
- Use a SaaS service as a backend for forms (contact forms, hiring forms, etc.)
- [Formspree (open source)](https://formspree.io/)
- [FormKeep](https://formkeep.com/guides/contact-form-jekyll?utm_source=github&utm_medium=jekyll-docs&utm_campaign=contact-form-jekyll)
- [Simple Form](https://getsimpleform.com/)
- [Formingo](https://www.formingo.co/guides/jekyll?utm_source=github&utm_medium=jekyll-docs&utm_campaign=Jekyll%20Documentation)
- [Jekyll Bootstrap](http://jekyllbootstrap.com), 0 to Blog in 3 minutes. Provides detailed explanations, examples, and helper-code to make getting started with Jekyll easier.
- [Integrating Twitter with Jekyll](http://www.justkez.com/integrating-twitter-with-jekyll/)
> “Having migrated Justkez.com to be based on Jekyll, I was pondering how I might include my recent twitterings on the front page of the site. In the WordPress world, this would have been done via a plugin which may or may not have hung the loading of the page, might have employed caching, but would certainly have had some overheads. … Not in Jekyll.”
- [Staticman](https://staticman.net): Add user-generated content to a Jekyll site (free and open source)
- [Formester](http://www.formester.com)
- [Talkyard](https://www.talkyard.io/blog-comments): Embedded comments for Jekyll and others (free and open source, or hosted serverless)
- [Staticman](https://staticman.net): Add user-generated content to a Jekyll site (free and open source)
- [Snipcart](https://snipcart.com/blog/static-site-e-commerce-part-2-integrating-snipcart-with-jekyll): Add a shopping cart to a Jekyll site
- [Contentful](https://www.contentful.com/ecosystem/jekyll/): use Jekyll together with the API-driven Contentful CMS.
- [Algolia](https://blog.algolia.com/instant-search-blog-documentation-jekyll-plugin/): Add a powerful instant search to your Jekyll site
### Other commentary
## Other commentary
- [My Jekyll Fork, by Mike West](https://mikewest.org/2009/11/my-jekyll-fork)
- [How I'm using Jekyll in 2016](https://mademistakes.com/articles/using-jekyll-2016/)
> “Jekyll is a well-architected throwback to a time before WordPress, when men were men, and HTML was static. I like the ideas it espouses, and have made a few improvements to its core. Here, Ill point out some highlights of my fork in the hopes that they see usage beyond this site.”
- [Talkyard comments instructions for Jekyll](https://jekyll-demo.talkyard.io/2018/01/09/installation-instructions.html)
- [About this Website, by Carter Allen](http://cartera.me/2010/08/12/about-this-website/)
- [Static Comments with Jekyll & Staticman](https://mademistakes.com/articles/improving-jekyll-static-comments/)
> “Jekyll is everything that I ever wanted in a blogging engine. Really. It isnt perfect, but whats excellent about it is that if theres something wrong, I know exactly how it works and how to fix it. It runs on the your machine only, and is essentially an added”build" step between you and the browser. I coded this entire site in TextMate using standard HTML5 and CSS3, and then at the end I added just a few little variables to the markup. Presto-chango, my site is built and I am at peace with the world.”
- [Adding Ajax pagination to Jekyll](https://eduardoboucas.com/blog/2014/11/05/adding-ajax-pagination-to-jekyll.html)
- ['My Jekyll Fork', by Mike West](https://mikewest.org/2009/11/my-jekyll-fork)
> "Jekyll is a well-architected throwback to a time before WordPress, when men were men, and HTML was static. I like the ideas it espouses, and have made a few improvements to it's core. Here, I'll point out some highlights of my fork in the hopes that they see usage beyond this site."
- ['About this Website', by Carter Allen](http://cartera.me/2010/08/12/about-this-website/)
> "Jekyll is everything that I ever wanted in a blogging engine. Really. It isn't perfect, but what's excellent about it is that if there's something wrong, I know exactly how it works and how to fix it. It runs on the your machine only, and is essentially an added"build" step between you and the browser. I coded this entire site in TextMate using standard HTML5 and CSS3, and then at the end I added just a few little variables to the markup. Presto-chango, my site is built and I am at peace with the world."
- [Generating a Tag Cloud in Jekyll](http://www.justkez.com/generating-a-tag-cloud-in-jekyll/) A guide to implementing a tag cloud and per-tag content pages using Jekyll.
- A way to [extend Jekyll](https://github.com/rfelix/jekyll_ext) without forking and modifying the Jekyll gem codebase and some [portable Jekyll extensions](https://wiki.github.com/rfelix/jekyll_ext/extensions) that can be reused and shared.
- [Using your Rails layouts in Jekyll](http://numbers.brighterplanet.com/2010/08/09/sharing-rails-views-with-jekyll)
- [Adding Ajax pagination to Jekyll](https://eduardoboucas.com/blog/2014/11/05/adding-ajax-pagination-to-jekyll.html)

View File

@@ -66,13 +66,13 @@ following metadata:
</table>
</div>
Note that in the above table, `file` can be anything. It's simply an arbitrarily set variable used in your own logic (such as in a for loop). It isn't a global site or page variable.
Note that in the above table, `file` can be anything. It's simply an arbitrarily set variable used in your own logic (such as in a for loop). It isn't a global site or page variable.
## Add front matter to static files
Although you can't directly add front matter values to static files, you can set front matter values through the [defaults property](../configuration/#front-matter-defaults) in your configuration file. When Jekyll builds the site, it will use the front matter values you set.
Although you can't directly add front matter values to static files, you can set front matter values through the [defaults property](../configuration/#front-matter-defaults) in your configuration file. When Jekyll builds the site, it will use the front matter values you set.
Here's an example:
Here's an example:
In your `_config.yml` file, add the following values to the `defaults` property:
@@ -88,11 +88,13 @@ This assumes that your Jekyll site has a folder path of `assets/img` where you
Suppose you want to list all your image assets as contained in `assets/img`. You could use this for loop to look in the `static_files` object and get all static files that have this front matter property:
{% raw %}
```liquid
{% raw %}{% assign image_files = site.static_files | where: "image", true %}
{% assign image_files = site.static_files | where: "image", true %}
{% for myimage in image_files %}
{{ myimage.path }}
{% endfor %}{% endraw %}
{% endfor %}
```
{% endraw %}
When you build your site, the output will list the path to each file that meets this front matter condition.

View File

@@ -5,7 +5,8 @@ permalink: /docs/structure/
Jekyll is, at its core, a text transformation engine. The concept behind the
system is this: you give it text written in your favorite markup language, be
that Markdown, Textile, or just plain HTML, and it churns that through a layout
that Markdown, [Textile](https://github.com/jekyll/jekyll-textile-converter)
, or just plain HTML, and it churns that through a layout
or a series of layout files. Throughout that process you can tweak how you want
the site URLs to look, what data gets displayed in the layout, and more. This
is all done through editing text files; the static web site is the final
@@ -136,9 +137,9 @@ An overview of what each of these does:
<p>
Well-formatted site data should be placed here. The Jekyll engine
will autoload all data files (using either the <code>.yml</code>,
<code>.yaml</code>, <code>.json</code> or <code>.csv</code>
formats and extensions) in this directory, and they will be
accessible via `site.data`. If there's a file
<code>.yaml</code>, <code>.json</code>, <code>.csv</code> or
<code>.tsv</code> formats and extensions) in this directory,
and they will be accessible via `site.data`. If there's a file
<code>members.yml</code> under the directory, then you can access
contents of the file through <code>site.data.members</code>.
</p>
@@ -185,7 +186,7 @@ An overview of what each of these does:
<tr>
<td>
<p><code>index.html</code> or <code>index.md</code> and other HTML,
Markdown, Textile files</p>
Markdown files</p>
</td>
<td>
<p>

24
docs/_docs/support.md Normal file
View File

@@ -0,0 +1,24 @@
---
title: Support
permalink: "/docs/support/"
note: This file is autogenerated. Edit /.github/SUPPORT.markdown instead.
---
## Getting Help
**Jekyll's issue tracker is not a support forum.**
If you're looking for support for Jekyll, there are a lot of options:
* Read [Jekyll Documentation](https://jekyllrb.com/docs/home/)
* If you have a question about using Jekyll, start a discussion on [Jekyll Forum](https://talk.jekyllrb.com/) or [StackOverflow](https://stackoverflow.com/questions/tagged/jekyll)
* Chat with Jekyllers &mdash; Join [our Gitter channel](https://gitter.im/jekyll/jekyll) or [our IRC channel on Freenode](irc:irc.freenode.net/jekyll)
There are a bunch of helpful community members on these services that should be willing to point you in the right direction.
## Report a bug
* If you think you've found a bug within a Jekyll plugin, open an issue in that plugin's repository &mdash; First [look for the plugin on rubygems](https://rubygems.org/) then click on the `Homepage` link to access the plugin repository.
* If you think you've found a bug within Jekyll itself, [open an issue](https://github.com/jekyll/jekyll/issues/new).
Happy Jekyllin'!

View File

@@ -6,8 +6,9 @@ permalink: /docs/templates/
Jekyll uses the [Liquid](https://shopify.github.io/liquid/) templating language to
process templates. All of the standard Liquid [tags](https://shopify.github.io/liquid/tags/control-flow/) and
[filters](https://shopify.github.io/liquid/filters/abs/) are
supported. Jekyll even adds a few handy filters and tags of its own to make
common tasks easier.
supported. To make common tasks easier, Jekyll even adds a few handy filters
and tags of its own, all of which you can find on this page. Jekyll even lets
you come up with your own tags via plugins.
## Filters
@@ -90,6 +91,21 @@ common tasks easier.
</p>
</td>
</tr>
<tr>
<td>
<p class="name"><strong>Date to String in ordinal US style</strong></p>
<p>Format a date to ordinal, US, short format.
{% include docs_version_badge.html version="3.8.0" %}</p>
</td>
<td class="align-center">
<p>
<code class="filter">{% raw %}{{ site.time | date_to_string: "ordinal", "US" }}{% endraw %}</code>
</p>
<p>
<code class="output">Nov 7th, 2008</code>
</p>
</td>
</tr>
<tr>
<td>
<p class="name"><strong>Date to Long String</strong></p>
@@ -104,6 +120,21 @@ common tasks easier.
</p>
</td>
</tr>
<tr>
<td>
<p class="name"><strong>Date to Long String in ordinal UK style</strong></p>
<p>Format a date to ordinal, UK, long format.
{% include docs_version_badge.html version="3.8.0" %}</p>
</td>
<td class="align-center">
<p>
<code class="filter">{% raw %}{{ site.time | date_to_long_string: "ordinal" }}{% endraw %}</code>
</p>
<p>
<code class="output">7th November 2008</code>
</p>
</td>
</tr>
<tr>
<td>
<p class="name"><strong>Where</strong></p>
@@ -118,7 +149,8 @@ common tasks easier.
<tr>
<td>
<p class="name"><strong>Where Expression</strong></p>
<p>Select all the objects in an array where the expression is true. Jekyll v3.2.0 & later.</p>
<p>Select all the objects in an array where the expression is true.
{% include docs_version_badge.html version="3.2.0" %}</p>
</td>
<td class="align-center">
<p>
@@ -149,7 +181,8 @@ common tasks easier.
<tr>
<td>
<p class="name"><strong>Group By Expression</strong></p>
<p>Group an array's items using a Liquid expression.</p>
<p>Group an array's items using a Liquid expression.
{% include docs_version_badge.html version="3.4.0" %}</p>
</td>
<td class="align-center">
<p>
@@ -292,6 +325,18 @@ common tasks easier.
<p>
<code class="output">the-_config.yml-file</code>
</p>
<p>
<code class="filter">{% raw %}{{ "The _cönfig.yml file" | slugify: 'ascii' }}{% endraw %}</code>
</p>
<p>
<code class="output">the-c-nfig-yml-file</code>
</p>
<p>
<code class="filter">{% raw %}{{ "The cönfig.yml file" | slugify: 'latin' }}{% endraw %}</code>
</p>
<p>
<code class="output">the-config-yml-file</code>
</p>
</td>
</tr>
<tr>
@@ -415,16 +460,25 @@ The default is `default`. They are as follows (with what they filter):
- `raw`: spaces
- `default`: spaces and non-alphanumeric characters
- `pretty`: spaces and non-alphanumeric characters except for `._~!$&'()+,;=@`
- `ascii`: spaces, non-alphanumeric, and non-ASCII characters
- `latin`: like `default`, except Latin characters are first transliterated (e.g. `àèïòü` to `aeiou`) {%- include docs_version_badge.html version="3.7.0" -%}
## Tags
* [Includes](#includes)
* [Code snippet highlighting](#code-snippet-highlighting)
* [Linking to pages, collections and posts (the new and improved way)](#links)
* [Linking to posts (the old way)](#linking-to-posts)
### Includes
If you have small page snippets that you want to include in multiple places on your site, save the snippets as *include files* and insert them where required, by using the `include` tag:
{% raw %}
```liquid
{% raw %}{% include footer.html %}{% endraw %}
{% include footer.html %}
```
{% endraw %}
Jekyll expects all *include files* to be placed in an `_includes` directory at the root of your source directory. In the above example, this will embed the contents of `_includes/footer.html` into the calling file.
@@ -445,15 +499,15 @@ languages](http://pygments.org/languages/)
To render a code block with syntax highlighting, surround your code as follows:
```liquid
{% raw %}
```liquid
{% highlight ruby %}
def foo
puts 'foo'
end
{% endhighlight %}
{% endraw %}
```
{% endraw %}
The argument to the `highlight` tag (`ruby` in the example above) is the
language identifier. To find the appropriate identifier to use for the language
@@ -461,6 +515,13 @@ you want to highlight, look for the “short name” on the [Rouge
wiki](https://github.com/jayferd/rouge/wiki/List-of-supported-languages-and-lexers)
or the [Pygments' Lexers page](http://pygments.org/docs/lexers/).
<div class="note info">
<h5>Jekyll processes all Liquid filters in code blocks</h5>
<p>If you are using a language that contains curly braces, you
will likely need to place <code>{&#37; raw &#37;}</code> and
<code>{&#37; endraw &#37;}</code> tags around your code.</p>
</div>
#### Line numbers
There is a second argument to `highlight` called `linenos` that is optional.
@@ -468,15 +529,15 @@ Including the `linenos` argument will force the highlighted code to include line
numbers. For instance, the following code block would include line numbers next
to each line:
```liquid
{% raw %}
```liquid
{% highlight ruby linenos %}
def foo
puts 'foo'
end
{% endhighlight %}
{% endraw %}
```
{% endraw %}
#### Stylesheets for syntax highlighting
@@ -488,27 +549,6 @@ site. If you use `linenos`, you might want to include an additional CSS class
definition for the `.lineno` class in `syntax.css` to distinguish the line
numbers from the highlighted code.
### Gist
Use the `gist` tag to easily embed a GitHub Gist onto your site. This works
with public or secret gists:
```liquid
{% raw %}
{% gist parkr/931c1c8d465a04042403 %}
{% endraw %}
```
You may also optionally specify the filename in the gist to display:
```liquid
{% raw %}
{% gist parkr/931c1c8d465a04042403 jekyll-private-gist.markdown %}
{% endraw %}
```
To use the `gist` tag, you'll need to add the
[jekyll-gist](https://github.com/jekyll/jekyll-gist) gem to your project.
## Links
@@ -518,25 +558,25 @@ To link to a post, a page, collection item, or file, the `link` tag will generat
You must include the file's original extension when using the `link` tag. Here are some examples:
```liquid
{% raw %}
```liquid
{{ site.baseurl }}{% link _collection/name-of-document.md %}
{{ site.baseurl }}{% link _posts/2016-07-26-name-of-post.md %}
{{ site.baseurl }}{% link news/index.html %}
{{ site.baseurl }}{% link /assets/files/doc.pdf %}
{% endraw %}
```
{% endraw %}
You can also use the `link` tag to create a link in Markdown as follows:
```liquid
{% raw %}
```liquid
[Link to a document]({{ site.baseurl }}{% link _collection/name-of-document.md %})
[Link to a post]({{ site.baseurl }}{% link _posts/2016-07-26-name-of-post.md %})
[Link to a page]({{ site.baseurl }}{% link news/index.html %})
[Link to a file]({{ site.baseurl }}{% link /assets/files/doc.pdf %})
{% endraw %}
```
{% endraw %}
(Including `{% raw %}{{ site.baseurl }}{% endraw %}` is optional &mdash; it depends on whether you want to preface the page URL with the `baseurl` value.)
@@ -546,7 +586,7 @@ For example, suppose you're creating a link in `page_a.md` (stored in `pages/fol
If you're unsure of the path, add `{% raw %}{{ page.path }}{% endraw %}` to the page and it will display the path.
One major benefit of using the `link` tag is link validation. If the link doesn't exist, Jekyll won't build your site. This is a good thing, as it will alert you to a broken link so you can fix it (rather than allowing you to build and deploy a site with broken links).
One major benefit of using the `link` or `post_url` tag is link validation. If the link doesn't exist, Jekyll won't build your site. This is a good thing, as it will alert you to a broken link so you can fix it (rather than allowing you to build and deploy a site with broken links).
Note you cannot add filters to `link` tags. For example, you cannot append a string using Liquid filters, such as `{% raw %}{% link mypage.html | append: "#section1" %} {% endraw %}`. To link to sections on a page, you will need to use regular HTML or Markdown linking techniques.
@@ -554,26 +594,26 @@ Note you cannot add filters to `link` tags. For example, you cannot append a str
If you want to include a link to a post on your site, the `post_url` tag will generate the correct permalink URL for the post you specify.
```liquid
{% raw %}
```liquid
{{ site.baseurl }}{% post_url 2010-07-21-name-of-post %}
{% endraw %}
```
{% endraw %}
If you organize your posts in subdirectories, you need to include subdirectory path to the post:
```liquid
{% raw %}
```liquid
{{ site.baseurl }}{% post_url /subdir/2010-07-21-name-of-post %}
{% endraw %}
```
{% endraw %}
There is no need to include the file extension when using the `post_url` tag.
You can also use this tag to create a link to a post in Markdown as follows:
```liquid
{% raw %}
```liquid
[Name of Link]({{ site.baseurl }}{% post_url 2010-07-21-name-of-post %})
{% endraw %}
```
{% endraw %}

View File

@@ -3,7 +3,7 @@ title: Themes
permalink: /docs/themes/
---
Jekyll has an extensive theme system that allows you to leverage community-maintained templates and styles to customize your site's presentation. Jekyll themes package up layouts, includes, and stylesheets in a way that can be overridden by your site's content.
Jekyll has an extensive theme system that allows you to leverage community-maintained templates and styles to customize your site's presentation. Jekyll themes specify plugins and package up assets, layouts, includes, and stylesheets in a way that can be overridden by your site's content.
## Understanding gem-based themes
@@ -19,8 +19,8 @@ In the case of Minima, you see only the following files in your Jekyll site dire
├── _config.yml
├── _posts
│ └── 2016-12-04-welcome-to-jekyll.markdown
├── about.md
└── index.md
├── about.markdown
└── index.markdown
```
The `Gemfile` and `Gemfile.lock` files are used by Bundler to keep track of the required gems and gem versions you need to build your Jekyll site.
@@ -47,11 +47,13 @@ To locate a theme's files on your computer:
2. Open the theme's directory in Finder or Explorer:
```shell
```sh
# On MacOS
open $(bundle show minima)
# On Windows
explorer /usr/local/lib/ruby/gems/2.3.0/gems/minima-2.1.0
# On Linux
xdg-open $(bundle show minima)
```
A Finder or Explorer window opens showing the theme's files and directories. The Minima theme gem contains these files:
@@ -88,7 +90,7 @@ With a clear understanding of the theme's files, you can now override any theme
Let's say, for a second example, you want to override Minima's footer. In your Jekyll site, create an `_includes` folder and add a file in it called `footer.html`. Jekyll will now use your site's `footer.html` file instead of the `footer.html` file from the Minima theme gem.
To modify any stylesheet you must take the extra step of also copying the main sass file (`_sass/minima.scss` in the Minima theme) into the `_sass` directory in your site's source.
To modify any stylesheet you must take the extra step of also copying the main sass file (`_sass/minima.scss` in the Minima theme) into the `_sass` directory in your site's source.
Jekyll will look first to your site's content before looking to the theme's defaults for any requested file in the following folders:
@@ -108,7 +110,48 @@ Suppose you want to get rid of the gem-based theme and convert it to a regular t
To do this, copy the files from the theme gem's directory into your Jekyll site directory. (For example, copy them to `/myblog` if you created your Jekyll site at `/myblog`. See the previous section for details.)
Then remove references to the theme gem in `Gemfile` and configuration. For example, to remove `minima`:
Then you must tell Jekyll about the plugins that were referenced by the theme. You can find these plugins in the theme's gemspec file as runtime dependencies. If you were converting the Minima theme, for example, you might see:
```
spec.add_runtime_dependency "jekyll-feed", "~> 0.9"
spec.add_runtime_dependency "jekyll-seo-tag", "~> 2.1"
```
You should include these references in the `Gemfile` in one of two ways.
You could list them individually in both `Gemfile` and `_config.yml`.
```ruby
# ./Gemfile
gem "jekyll-feed", "~> 0.9"
gem "jekyll-seo-tag", "~> 2.1"
```
```yaml
# ./_config.yml
plugins:
- jekyll-feed
- jekyll-seo-tag
```
Or you could list them explicitly as Jekyll plugins in your Gemfile, and not update `_config.yml`, like this:
```ruby
# ./Gemfile
group :jekyll_plugins do
gem "jekyll-feed", "~> 0.9"
gem "jekyll-seo-tag", "~> 2.1"
end
```
Either way, don't forget to `bundle update`.
However, if you're publishing on GitHub Pages you should update only your `_config.yml` as GitHub Pages doesn't load plugins via Bundler.
Finally, remove references to the theme gem in `Gemfile` and configuration. For example, to remove `minima`:
- Open `Gemfile` and remove `gem "minima", "~> 2.0"`.
- Open `_config.yml` and remove `theme: minima`.
@@ -123,10 +166,21 @@ For example, search for [jekyll theme on RubyGems](https://rubygems.org/search?u
To install a gem-based theme:
1. Add the theme to your site's `Gemfile`:
1. Add the theme gem to your site's `Gemfile`:
```sh
gem "jekyll-theme-awesome"
```ruby
# ./Gemfile
# This is an example, declare the theme gem you want to use here
gem "jekyll-theme-minimal"
```
Or if you've started with the `jekyll new` command, replace `gem "minima", "~> 2.0"` with the gem you want, e.g:
```diff
# ./Gemfile
- gem "minima", "~> 2.0"
+ gem "jekyll-theme-minimal"
```
2. Install the theme:
@@ -137,8 +191,8 @@ To install a gem-based theme:
3. Add the following to your site's `_config.yml` to activate the theme:
```sh
theme: jekyll-theme-awesome
```yaml
theme: jekyll-theme-minimal
```
4. Build your site:
@@ -150,7 +204,7 @@ To install a gem-based 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 }
If you're publishing your Jekyll site on [GitHub Pages](https://pages.github.com/), note that GitHub Pages supports only some gem-based themes. See [Supported Themes](https://pages.github.com/themes/) in GitHub's documentation to see which themes are supported.
If you're publishing your Jekyll site on [GitHub Pages](https://pages.github.com/), note that GitHub Pages supports only [some gem-based themes](https://pages.github.com/themes/). GitHub Pages also supports [using any theme hosted on GitHub](https://help.github.com/articles/adding-a-jekyll-theme-to-your-github-pages-site/#adding-a-jekyll-theme-in-your-sites-_configyml-file) using the `remote_theme` configuration as if it were a gem-based theme.
## Creating a gem-based theme
@@ -208,13 +262,15 @@ _sass
Your theme's styles can be included in the user's stylesheet using the `@import` directive.
{% raw %}
```css
{% raw %}@import "{{ site.theme }}";{% endraw %}
@import "{{ site.theme }}";
```
{% endraw %}
### Theme-gem dependencies
### Theme-gem dependencies {%- include docs_version_badge.html version="3.5.0" -%}
From `v3.5`, Jekyll will automatically require all whitelisted `runtime_dependencies` of your theme-gem even if they're not explicitly included under the `gems` array in the site's config file. (NOTE: whitelisting is only required when building or serving with the `--safe` option.)
Jekyll will automatically require all whitelisted `runtime_dependencies` of your theme-gem even if they're not explicitly included under the `plugins` array in the site's config file. (Note: whitelisting is only required when building or serving with the `--safe` option.)
With this, the end-user need not keep track of the plugins required to be included in their config file for their theme-gem to work as intended.
@@ -224,7 +280,7 @@ Your theme should include a `/README.md` file, which explains how site authors c
### Adding a screenshot
Themes are visual. Show users what your theme looks like by including a screenshot as `/screenshot.png` within your theme's repository where it can be retrieved programatically. You can also include this screenshot within your theme's documentation.
Themes are visual. Show users what your theme looks like by including a screenshot as `/screenshot.png` within your theme's repository where it can be retrieved programmatically. You can also include this screenshot within your theme's documentation.
### Previewing your theme

View File

@@ -36,6 +36,12 @@ If you installed the above - specifically on Fedora 23 - but the extensions woul
sudo dnf install redhat-rpm-config
```
On Arch Linux you need to run:
```sh
sudo pacman -S ruby-ffi
```
On Ubuntu if you get stuck after `bundle exec jekyll serve` and see error
messages like `Could not locate Gemfile` or `.bundle/ directory`, it's likely
because all requirements have not been fully met. Recent stock Ubuntu
@@ -65,7 +71,7 @@ sudo emerge -av dev-ruby/rubygems
On Windows, you may need to install [RubyInstaller
DevKit](https://wiki.github.com/oneclick/rubyinstaller/development-kit).
On Android (with Termux) you can install all requirements by running:
On Android (with Termux) you can install all requirements by running:
```sh
apt update && apt install libffi-dev clang ruby-dev make
@@ -74,7 +80,7 @@ apt update && apt install libffi-dev clang ruby-dev make
On macOS, you may need to update RubyGems (using `sudo` only if necessary):
```sh
sudo gem update --system
gem update --system
```
If you still have issues, you can download and install new Command Line
@@ -84,11 +90,11 @@ Tools (such as `gcc`) using the following command:
xcode-select --install
```
which may allow you to install native gems using this command (again using
which may allow you to install native gems using this command (again, using
`sudo` only if necessary):
```sh
sudo gem install jekyll
gem install jekyll
```
Note that upgrading macOS does not automatically upgrade Xcode itself
@@ -97,16 +103,65 @@ Xcode.app can interfere with the command line tools downloaded above. If
you run into this issue, upgrade Xcode and install the upgraded Command
Line Tools.
### Running Jekyll as Non-Superuser (no sudo!)
{: #no-sudo}
On most flavors of Linux, macOS, and Bash on Ubuntu on Windows, it is
possible to run Jekyll as a non-superuser and without having to install
gems to system-wide locations by adding the following lines to the end
of your `.bashrc` file:
```
# Ruby exports
export GEM_HOME=$HOME/gems
export PATH=$HOME/gems/bin:$PATH
```
This tells `gem` to place its gems within the user's home folder,
not in a system-wide location, and adds the local `jekyll` command to the
user's `PATH` ahead of any system-wide paths.
This is also useful for many shared webhosting services, where user accounts
have only limited privileges. Adding these exports to `.bashrc` before running
`gem install jekyll bundler` allows a complete non-`sudo` install of Jekyll.
To activate the new exports, either close and restart Bash, logout and
log back into your shell account, or run `. .bashrc` in the
currently-running shell.
If you see the following error when running the `jekyll new` command,
you can solve it by using the above-described procedure:
```sh
jekyll new test
Running bundle install in /home/user/test...
Your user account isn't allowed to install to the system RubyGems.
You can cancel this installation and run:
bundle install --path vendor/bundle
to install the gems into ./vendor/bundle/, or you can enter your password
and install the bundled gems to RubyGems using sudo.
Password:
```
Once this is done, the `jekyll new` command should work properly for
your user account.
### Jekyll &amp; Mac OS X 10.11
With the introduction of System Integrity Protection, several directories
that were previously writable are now considered system locations and are no
longer available. Given these changes, there are a couple of simple ways to get
up and running. One option is to change the location where the gem will be
installed (again using `sudo` only if necessary):
installed (again, using `sudo` only if necessary):
```sh
sudo gem install -n /usr/local/bin jekyll
gem install -n /usr/local/bin jekyll
```
Alternatively, Homebrew can be installed and used to set up Ruby. This can be
@@ -172,13 +227,13 @@ jekyll serve --baseurl '/blog'
… then make sure that you access the site at:
```sh
```
http://localhost:4000/blog/index.html
```
It wont work to just access:
```sh
```
http://localhost:4000/blog
```
@@ -195,10 +250,37 @@ That is: defaults are overridden by options specified in `_config.yml`,
and flags specified at the command-line will override all other settings
specified elsewhere.
If you encounter an error in building the site, with the error message
"'0000-00-00-welcome-to-jekyll.markdown.erb' does not have a valid date in the
YAML front matter." try including the line `exclude: [vendor]`
in `_config.yml`.
**Note: From v3.3.0 onward, Jekyll does not process `node_modules` and certain subdirectories within `vendor`, by default. But, by having an `exclude:` array defined explicitly in the config file overrides this default setting, which results in some users to encounter an error in building the site, with the following error message:**
```sh
ERROR: YOUR SITE COULD NOT BE BUILT:
------------------------------------
Invalid date '<%= Time.now.strftime('%Y-%m-%d %H:%M:%S %z') %>':
Document 'vendor/bundle/gems/jekyll-3.4.3/lib/site_template/_posts/0000-00-00-welcome-to-jekyll.markdown.erb'
does not have a valid date in the YAML front matter.
```
Simply adding `vendor/bundle` to the `exclude:` list will solve this problem but will lead to having other sub-directories under `/vendor/` (and also `/node_modules/`, if present) be processed to the destination folder `_site`.
The proper solution is to incorporate the default setting for `exclude:` rather than override it completely:
For versions upto `v3.4.3`, the `exclude:` setting must look like following:
```yaml
exclude:
- Gemfile
- Gemfile.lock
- node_modules
- vendor/bundle/
- vendor/cache/
- vendor/gems/
- vendor/ruby/
- any_additional_item # any user-specific listing goes at the end
```
From `v3.5` onward, `Gemfile` and `Gemfile.lock` are also excluded by default. So, in most cases there is no need to define another `exclude:` array in the config file. So an existing definition can either be modified as above, or removed completely, or simply commented out to enable easy edits in future.
## Markup Problems
@@ -208,9 +290,8 @@ problems.
### Liquid
The latest version, version 2.0, seems to break the use of `{{ "{{" }}` in
templates. Unlike previous versions, using `{{ "{{" }}` in 2.0 triggers the
following error:
Liquid version 2.0 seems to break the use of `{{ "{{" }}` in templates.
Unlike previous versions, using `{{ "{{" }}` in 2.0 triggers the following error:
```sh
'{{ "{{" }}' was not properly terminated with regexp: /\}\}/ (Liquid::SyntaxError)
@@ -234,7 +315,7 @@ The issue is caused by trying to copy a non-existing symlink.
<div class="note">
<h5>Please report issues you encounter!</h5>
<p>
If you come across a bug, please <a href="{{ site.help_url }}/issues/new">create an issue</a>
If you come across a bug, please <a href="{{ site.repository }}/issues/new">create an issue</a>
on GitHub describing the problem and any work-arounds you find so we can
document it here for others.
</p>

View File

@@ -4,10 +4,26 @@ title: Upgrading
permalink: /docs/upgrading/
---
Upgrading from an older version of Jekyll? Upgrading to a new major version of Jekyll (e.g. from v2.x to v3.x) may cause some headaches. Take the following guides to aid your upgrade:
Upgrading from an older version of Jekyll? Upgrading to a new major version of
Jekyll (e.g. from v2.x to v3.x) may cause some headaches. Take the following
guides to aid your upgrade:
- [From 0.x to 1.x and 2.x](/docs/upgrading/0-to-2/)
- [From 2.x to 3.x](/docs/upgrading/2-to-3/)
If you are making a minor update (for example from 3.3.1 to the latest version at the time 3.3.2) run 'bundle update jekyll' when in your site directory.
If you would like to update all your gems, run 'bundle update' when in your site directory.
## Minor updates
<div class="note">
<h5>Stay Up to Date</h5>
<p>We recommend you update Jekyll as often as possible to benefit from
the latest bug fixes.
</p>
</div>
If you followed our setup recommendations and installed [Bundler](http://bundler.io/), run `bundle update jekyll` or simply `bundle update` and all your gems will
update to the latest versions.
If you don't have Bundler installed, run `gem update jekyll`.
The procedure is similar [if you use the `github-pages`
gem](https://help.github.com/articles/setting-up-your-github-pages-site-locally-with-jekyll/#keeping-your-site-up-to-date-with-the-github-pages-gem).

View File

@@ -9,7 +9,7 @@ and 2.0 that you'll want to know about.
Before we dive in, go ahead and fetch the latest version of Jekyll:
```sh
$ gem update jekyll
gem update jekyll
```
<div class="note feature">

View File

@@ -3,20 +3,21 @@ title: Upgrading from 2.x to 3.x
permalink: /docs/upgrading/2-to-3/
---
Upgrading from an older version of Jekyll? A few things have changed in 3.0
Upgrading from an older version of Jekyll? A few things have changed in Jekyll 3
that you'll want to know about.
Before we dive in, go ahead and fetch the latest version of Jekyll:
```sh
$ gem update jekyll
gem update jekyll
```
Please note: Jekyll 3.2 requires Ruby version >= 2.1
Since v3.2 Jekyll requires Ruby version >= 2.1
{: .note .warning }
<div class="note feature">
<h5 markdown="1">Diving in</h5>
<p markdown="1">Want to get a new Jekyll site up and running quickly? Simply
<h5>Diving in</h5>
<p>Want to get a new Jekyll site up and running quickly? Simply
run <code>jekyll new SITENAME</code> to create a new folder with a bare bones
Jekyll site.</p>
</div>
@@ -43,6 +44,10 @@ For `site.collections.myCollection` in Jekyll 2, you now do:
This is a bit cumbersome at first, but is easier than a big `for` loop.
### Textile support
We dropped native support for Textile, from now on you have to install our [jekyll-textile-converter](https://github.com/jekyll/jekyll-textile-converter) plugin to work with Textile files.
### Dropped dependencies
We dropped a number of dependencies the Core Team felt were optional. As such, in 3.0, they must be explicitly installed and included if you use any of the features. They are:
@@ -68,7 +73,7 @@ generate when running `jekyll build` or `jekyll serve`.
<h5>Future Posts on GitHub Pages</h5>
<p>
An exception to the above rule are GitHub Pages sites, where the <code>--future</code> flag remains <em>enabled</em>
by default to maintain historical consistency for those sites.
by default to maintain historical consistency for those sites.
</p>
</div>

View File

@@ -0,0 +1,51 @@
---
title: Upgrading from 3.x to 4.x
permalink: /docs/upgrading/3-to-4/
---
Upgrading from an older version of Jekyll? A few things have changed in Jekyll 4
that you'll want to know about.
Before we dive in, you need to have at least Ruby 2.3.0 installed. Run the following
in your terminal to check
```sh
ruby -v
```
If you're using Ruby >= 2.3.0, go ahead and fetch the latest version of Jekyll:
```sh
gem update jekyll
```
### Template rendering
We've slightly altered the way Jekyll parses and renders your various templates to improve
the overall build times. Jekyll now parses a template once, caches it internally and then
renders the parsed template multiple times as required by your pages and documents.
The downside to this is that some of the community-authored plugins may not work as they
previously used to.
#### For Plugin-authors
* If your plugin depends on the following code: `site.liquid_renderer.file(path).parse(content)`,
note that the return value (`template`, an instance of *`Liquid::Template`*), from that line will
always be the **same object** for a given `path`. <br/>
The *`template`* instance is then rendered as previously, with respect to the `payload` passed to it.
You'll therefore have to ensure that *`payload`* is not memoized or cached in your plugin instance.
* If its a requirement that `template` you get from the above step *be different* at all times,
you can invoke *`Liquid::Template`* directly:
```diff
- template = site.liquid_renderer.file(path).parse(content)
+ template = Liquid::Template.parse(content)
```
---
*Did we miss something? Please click "Improve this page" above and add a section. Thanks!*

View File

@@ -7,22 +7,31 @@ The Jekyll gem makes a `jekyll` executable available to you in your Terminal
window. You can use this command in a number of ways:
```sh
$ jekyll build
jekyll build
# => The current folder will be generated into ./_site
$ jekyll build --destination <destination>
jekyll build --destination <destination>
# => The current folder will be generated into <destination>
$ jekyll build --source <source> --destination <destination>
jekyll build --source <source> --destination <destination>
# => The <source> folder will be generated into <destination>
$ jekyll build --watch
jekyll build --watch
# => The current folder will be generated into ./_site,
# watched for changes, and regenerated automatically.
```
## Override default development settings
Default URL is set to `http://localhost:4000` in development environment. {% include docs_version_badge.html version="3.3.0" %}
If you want to build for your production environment:
- Set your production URL in `_config.yml` e.g. `url: https://example.com`.
- Run `JEKYLL_ENV=production bundle exec jekyll build`.
<div class="note info">
<h5>Changes to _config.yml are not included during automatic regeneration.</h5>
<h5>Changes to <code>_config.yml</code> are not included during automatic regeneration.</h5>
<p>
The <code>_config.yml</code> master configuration file contains global configurations
and variable definitions that are read once at execution time. Changes made to <code>_config.yml</code>
@@ -52,25 +61,24 @@ Jekyll also comes with a built-in development server that will allow you to
preview what the generated site will look like in your browser locally.
```sh
$ jekyll serve
jekyll serve
# => A development server will run at http://localhost:4000/
# Auto-regeneration: enabled. Use `--no-watch` to disable.
$ jekyll serve --detach
jekyll serve --livereload
# LiveReload refreshes your browser after a change.
jekyll serve --incremental
# Incremental will perform a partial build in order to reduce regeneration time.
jekyll serve --detach
# => Same as `jekyll serve` but will detach from the current terminal.
# If you need to kill the server, you can `kill -9 1234` where "1234" is the PID.
# If you cannot find the PID, then do, `ps aux | grep jekyll` and kill the instance.
```
<div class="note info">
<h5>Be aware of default behavior</h5>
<p>
As of version 2.4, the <code>serve</code> command will watch for changes automatically. To disable this, you can use <code>jekyll serve --no-watch</code>, which preserves the old behavior.
</p>
</div>
```sh
$ jekyll serve --no-watch
jekyll serve --no-watch
# => Same as `jekyll serve` but will not watch for changes.
```
@@ -89,8 +97,8 @@ destination: _deploy
Then the following two commands will be equivalent:
```sh
$ jekyll build
$ jekyll build --source _source --destination _deploy
jekyll build
jekyll build --source _source --destination _deploy
```
For more about the possible configuration options, see the

View File

@@ -124,8 +124,7 @@ following is a reference of the available data.
A list of all <a href="/docs/static-files/">static files</a> (i.e.
files not processed by Jekyll's converters or the Liquid renderer).
Each file has three properties: <code>path</code>,
<code>modified_time</code> and <code>extname</code>.
Each file has five properties: <code>path</code>, <code>modified_time</code>, <code>name</code>, <code>basename</code> and <code>extname</code>.
</p></td>
</tr>
@@ -185,17 +184,32 @@ following is a reference of the available data.
</p></td>
</tr>
<tr>
<td><p><code>site.url</code></p></td>
<td><p>
Contains the url of your site as it is configured in the <code>_config.yml</code>.
For example, if you have <code>url: http://mysite.com</code>
in your configuration file, then it will be accessible in Liquid as
<code>site.url</code>. For the development environment there is
<a href="/news/#3-siteurl-is-set-by-the-development-server">an exception</a>,
if you are running <code>jekyll serve</code> in a development environment
<code>site.url</code> will be set to the value of <code>host</code>,
<code>port</code>, and SSL-related options. This defaults to
<code>url: http://localhost:4000</code>.
</p></td>
</tr>
<tr>
<td><p><code>site.[CONFIGURATION_DATA]</code></p></td>
<td><p>
All the variables set via the command line and your
<code>_config.yml</code> are available through the <code>site</code>
variable. For example, if you have <code>url: http://mysite.com</code>
in your configuration file, then in your Posts and Pages it will be
stored in <code>site.url</code>. Jekyll does not parse changes to
<code>_config.yml</code> in <code>watch</code> mode, you must restart
Jekyll to see changes to variables.
variable. For example, if you have <code>foo: bar</code>
in your configuration file, then it will be accessible in Liquid as <code>site.foo</code>.
Jekyll does not parse changes to <code>_config.yml</code> in
<code>watch</code> mode, you must restart Jekyll to see changes to variables.
</p></td>
</tr>
@@ -235,7 +249,7 @@ following is a reference of the available data.
<td><p><code>page.excerpt</code></p></td>
<td><p>
The un-rendered excerpt of the Page.
The un-rendered excerpt of a document.
</p></td>
</tr>
@@ -265,8 +279,9 @@ following is a reference of the available data.
<td><p><code>page.id</code></p></td>
<td><p>
An identifier unique to the Post (useful in RSS feeds). e.g.
An identifier unique to a document in a Collection or a Post (useful in RSS feeds). e.g.
<code>/2008/12/14/my-post</code>
<code>/my-collection/my-document</code>
</p></td>
</tr>

View File

@@ -7,177 +7,27 @@ While Windows is not an officially-supported platform, it can be used to run Jek
## Installing Jekyll
If you are using Windows 10 Anniversary Update, the easiest way to run Jekyll is by [installing][WSL-Guide] the new Bash on Ubuntu on Windows.
### Installation via Bash on Windows 10
*Note:* You must have [Bash on Ubuntu on Windows][BASH-WSL] enabled.
First let's make sure all our packages / repositories are up to date. Open a new Command Prompt instance, and type the following:
```
bash
```
Your Command Prompt instance should now be a Bash instance. Now we must update our repo lists and packages.
```
sudo apt-get update -y && sudo apt-get upgrade -y
```
Now we can install Ruby. To do this we will use a repository from [BrightBox](https://www.brightbox.com/docs/ruby/ubuntu/), which hosts optimized versions of Ruby for Ubuntu.
```
sudo apt-add-repository ppa:brightbox/ruby-ng
sudo apt-get update
sudo apt-get install ruby2.3 ruby2.3-dev build-essential
```
Next let's update our Ruby gems:
```
sudo gem update
```
Now all that is left to do is install Jekyll.
```
sudo gem install jekyll bundler
```
Check if Jekyll installed properly by running:
```
jekyll -v
```
**And that's it!**
To start a new project named `my_blog`, just run:
```
jekyll new my_blog
```
You can make sure time management is working properly by inspecting your `_posts` folder. You should see a markdown file with the current date in the filename.
**Note:** Bash on Ubuntu on Windows is still under development, so you may run into issues.
[WSL-Guide]: https://msdn.microsoft.com/en-us/commandline/wsl/install_guide
[BASH-WSL]: https://msdn.microsoft.com/en-us/commandline/wsl/about
The easiest way to run Jekyll is by using the [RubyInstaller][] for Windows.
### Installation via RubyInstaller
[RubyInstaller][] is a self-contained Windows-based installer that includes the Ruby language, an execution environment, important documentation, and more.
We only cover RubyInstaller-2.4 and newer here, older versions need to [install the Devkit][Devkit-install] manually.
1. Download and Install a package manager version from [RubyInstaller Downloads][RubyInstaller-downloads].
2. Install Jekyll and Bundler via a command prompt window: `gem install jekyll bundler`
1. Download and Install a **Ruby+Devkit** version from [RubyInstaller Downloads][RubyInstaller-downloads].
Use default options for installation.
2. Open a new command prompt window from the start menu, so that changes to the `PATH` environment variable becomes effective.
Install Jekyll and Bundler via: `gem install jekyll bundler`
3. Check if Jekyll installed properly: `jekyll -v`
That's it, you're ready to install our [default minimal blog theme](https://github.com/jekyll/minima) with `jekyll new jekyll-website`.
[RubyInstaller]: https://rubyinstaller.org/
[RubyInstaller-downloads]: https://rubyinstaller.org/downloads/
[Devkit-install]: https://github.com/oneclick/rubyinstaller/wiki/Development-Kit
### Installation via Chocolatey
A quick way to install Jekyll using Chocolatey is to follow the [installation instructions by David Burela](https://davidburela.wordpress.com/2015/11/28/easily-install-jekyll-on-windows-with-3-command-prompt-entries-and-chocolatey/):
1. Install a package manager for Windows called [Chocolatey][]
2. Install Ruby via Chocolatey: `choco install ruby -y`
3. Reopen a command prompt and install Jekyll: `gem install jekyll`
Updates in the infrastructure of Ruby may cause SSL errors when attempting to use `gem install` with versions of the RubyGems package older than 2.6. (The RubyGems package installed via the Chocolatey tool is version 2.3) If you have installed an older version, you can update the RubyGems package using the directions [here][ssl-certificate-update].
[ssl-certificate-update]: http://guides.rubygems.org/ssl-certificate-update/#installing-using-update-packages
### Installing *github-pages* via Chocolatey
This section is part of an article written by [Jens Willmer][jwillmerPost]. To follow the instructions you need to have [Chocolatey][] installed on your system. If you already have a version of Ruby installed you need to uninstall it before you can continue.
#### Install Ruby and Ruby development kit
Open a command prompt and execute the following commands:
* `choco install ruby -version 2.2.4`
* `choco install ruby2.devkit` - _needed for compilation of json gem_
#### Configure Ruby development kit
The development kit did not set the environment path for Ruby so we need to do it.
* Open command prompt in `C:\tools\DevKit2`
* Execute `ruby dk.rb init` to create a file called `config.yml`
* Edit the `config.yml` file and include the path to Ruby `- C:/tools/ruby22`
* Execute the following command to set the path: `ruby dk.rb install`
#### Nokogiri gem installation
This gem is also needed in the github-pages and to get it running on Windows x64 we have to install a few things.
**Note:** In the current [pre release][nokogiriFails] it works out of the box with Windows x64 but this version is not referenced in the github-pages.
`choco install libxml2 -Source "https://www.nuget.org/api/v2/"`{:.language-ruby}
`choco install libxslt -Source "https://www.nuget.org/api/v2/"`{:.language-ruby}
`choco install libiconv -Source "https://www.nuget.org/api/v2/"`{:.language-ruby}
```ruby
gem install nokogiri --^
--with-xml2-include=C:\Chocolatey\lib\libxml2.2.7.8.7\build\native\include^
--with-xml2-lib=C:\Chocolatey\lib\libxml2.redist.2.7.8.7\build\native\bin\v110\x64\Release\dynamic\cdecl^
--with-iconv-include=C:\Chocolatey\lib\libiconv.1.14.0.11\build\native\include^
--with-iconv-lib=C:\Chocolatey\lib\libiconv.redist.1.14.0.11\build\native\bin\v110\x64\Release\dynamic\cdecl^
--with-xslt-include=C:\Chocolatey\lib\libxslt.1.1.28.0\build\native\include^
--with-xslt-lib=C:\Chocolatey\lib\libxslt.redist.1.1.28.0\build\native\bin\v110\x64\Release\dynamic
```
#### Install github-pages
* Open command prompt and install [Bundler][]: `gem install bundler`
* Create a file called `Gemfile` without any extension in your root directory of your blog
* Copy & paste the two lines into the file:
```ruby
source 'https://rubygems.org'
gem 'github-pages', group: :jekyll_plugins
```
* **Note:** We use an unsecure connection because SSL throws exceptions in the version of Ruby
* Open a command prompt, target your local blog repository root, and install github-pages: `bundle install`
After this process you should have github-pages installed on your system and you can host your blog again with `jekyll s`.
There will be a warning on startup that you should include `gem 'wdm', '>= 0.1.0' if Gem.win_platform?` to your `Gemfile` but I could not get `jekyll s` working if I include that line so for the moment I ignore that warning.
In the future the installation process of the github-pages should be as simple as the setup of the blog. But as long as the new version of the Nokogiri ([v1.6.8][nokogiriReleases]) is not stable and referenced, it is work to get it up and running on Windows.
[jwillmerPost]: https://jwillmer.de/blog/tutorial/how-to-install-jekyll-and-pages-gem-on-windows-10-x46 "Installation instructions by Jens Willmer"
[Chocolatey]: https://chocolatey.org/install "Package manager for Windows"
[nokogiriFails]: https://github.com/sparklemotion/nokogiri/issues/1456#issuecomment-206481794 "Nokogiri fails to install on Ruby 2.3 for Windows"
[Bundler]: http://bundler.io/ "Ruby Dependencie Manager"
[nokogiriReleases]: https://github.com/sparklemotion/nokogiri/releases "Nokogiri Releases"
---
For a more conventional way of installing Jekyll you can follow this [complete guide to install Jekyll 3 on Windows by Sverrir Sigmundarson][windows-installjekyll3].
Optionally you can use [Autoinstall Jekyll for Windows][fastjekyll-autoinstall].
---
[windows-installjekyll3]: https://labs.sverrirs.com/jekyll/
[fastjekyll-autoinstall]: https://github.com/KeJunMao/fastjekyll#autoinstall-jekyll-for-windows
## Encoding
### Encoding
If you use UTF-8 encoding, make sure that no `BOM` header characters exist in your files or very, very bad things will happen to
Jekyll. This is especially relevant when you're running Jekyll on Windows.
@@ -185,11 +35,11 @@ Jekyll. This is especially relevant when you're running Jekyll on Windows.
Additionally, you might need to change the code page of the console window to UTF-8 in case you get a "Liquid Exception: Incompatible character encoding" error during the site generation process. It can be done with the following command:
```sh
$ chcp 65001
chcp 65001
```
## Time-Zone Management
### Time-Zone Management
Since Windows doesn't have a native source of zoneinfo data, the Ruby Interpreter would not understand IANA Timezones and hence using them had the `TZ` environment variable default to UTC/GMT 00:00.
Though Windows users could alternatively define their blog's timezone by setting the key to use POSIX format of defining timezones, it wasn't as user-friendly when it came to having the clock altered to changing DST-rules.
@@ -204,10 +54,9 @@ gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]
[IANA-database]: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
### Auto Regeneration
## Auto Regeneration
As of v1.3.0, Jekyll uses the `listen` gem to watch for changes when the `--watch` switch is specified during a build or serve. While `listen` has built-in support for UNIX systems, it may require an extra gem for compatibility with Windows.
Jekyll uses the `listen` gem to watch for changes when the `--watch` switch is specified during a build or serve. While `listen` has built-in support for UNIX systems, it may require an extra gem for compatibility with Windows.
Add the following to the Gemfile for your site if you have issues with auto-regeneration on Windows alone:
@@ -215,4 +64,75 @@ Add the following to the Gemfile for your site if you have issues with auto-rege
gem 'wdm', '~> 0.1.1' if Gem.win_platform?
```
You may first have to download and install the [Ruby DevKit](https://rubyinstaller.org/downloads/) by following [the instructions here](https://github.com/oneclick/rubyinstaller/wiki/Development-Kit).
You have to use a [Ruby+Devkit](https://rubyinstaller.org/downloads/) version of the RubyInstaller.
## Installation via Bash on Windows 10
If you are using Windows 10 version 1607 or later, another option to run Jekyll is by [installing][WSL-Guide] the Windows Subsystem for Linux.
*Note:* You must have [Windows Subsystem for Linux][BASH-WSL] enabled.
First let's make sure all our packages / repositories are up to date. Open a new Command Prompt instance, and type the following:
```sh
bash
```
Your Command Prompt instance should now be a Bash instance. Now we must update our repo lists and packages.
```sh
sudo apt-get update -y && sudo apt-get upgrade -y
```
Now we can install Ruby. To do this we will use a repository from [BrightBox](https://www.brightbox.com/docs/ruby/ubuntu/), which hosts optimized versions of Ruby for Ubuntu.
```sh
sudo apt-add-repository ppa:brightbox/ruby-ng
sudo apt-get update
sudo apt-get install ruby2.4 ruby2.4-dev build-essential dh-autoreconf
```
Next let's update our Ruby gems:
```sh
sudo gem update
```
Now all that is left to do is install Jekyll.
```sh
sudo gem install jekyll bundler
```
Check if Jekyll installed properly by running:
```sh
jekyll -v
```
Configure the bundler/gem path so bundle doesn't prompt for sudo
```sh
bundle config path vendor/bundle
```
**And that's it!**
To start a new project named `my_blog`, just run:
```sh
jekyll new my_blog
```
You can make sure time management is working properly by inspecting your `_posts` folder. You should see a markdown file with the current date in the filename.
<div class="note info">
<h5>Non-superuser account issues</h5>
<p>If the `jekyll new` command prints the error "Your user account isn't allowed to install to the system RubyGems", see the "Running Jekyll as Non-Superuser" instructions in <a href="/docs/troubleshooting/#no-sudo">Troubleshooting</a>.</p>
</div>
**Note:** Bash on Ubuntu on Windows is still under development, so you may run into issues.
[WSL-Guide]: https://msdn.microsoft.com/en-us/commandline/wsl/install_guide
[BASH-WSL]: https://msdn.microsoft.com/en-us/commandline/wsl/about

View File

@@ -1,26 +1,9 @@
{% if site.gauges_id %}
<!-- Gauges (http://get.gaug.es/) -->
<script>
var _gauges = _gauges || [];
(function() {
var t = document.createElement('script');
t.type = 'text/javascript';
t.async = true;
t.id = 'gauges-tracker';
t.setAttribute('data-site-id', '{{ site.gauges_id }}');
t.src = '//secure.gaug.es/track.js';
var s = document.getElementsByTagName('script')[0];
s.parentNode.insertBefore(t, s);
})();
</script>
{% endif %}
{% if site.google_analytics_id %}
<!-- Google Analytics (https://www.google.com/analytics) -->
<script>
!function(j,e,k,y,l,L){j.GoogleAnalyticsObject=y,j[y]||(j[y]=function(){
(j[y].q=j[y].q||[]).push(arguments)}),j[y].l=+new Date,l=e.createElement(k),
L=e.getElementsByTagName(k)[0],l.src='//www.google-analytics.com/analytics.js',
L=e.getElementsByTagName(k)[0],l.src='https://www.google-analytics.com/analytics.js',
L.parentNode.insertBefore(l,L)}(window,document,'script','ga');
ga('create', '{{ site.google_analytics_id }}', 'jekyllrb.com');

View File

@@ -0,0 +1 @@
<span class="version-badge" title="This feature is available starting version {{ include.version }}">{{ include.version }}</span>

View File

@@ -11,5 +11,15 @@
</a>
</p>
</div>
<div class="unit two-thirds align-right center-on-mobiles">
<p>
Sponsored by
{% for sponsor in site.data.sponsors %}
<a href="{{ sponsor.url }}" style="margin-left: 10px;">
<img src="{{ sponsor.image }}" height="{{ sponsor.height }}" width="{{ sponsor.width }}" alt="{{ sponsor.name }}">
</a>
{% endfor %}
</p>
</div>
</div>
</footer>

View File

@@ -1,18 +1,31 @@
<header>
<nav class="mobile-nav show-on-mobiles">
{% include primary-nav-items.html %}
</nav>
<div class="grid">
<div class="unit one-third center-on-mobiles">
<div class="flexbox">
<div class="center-on-mobiles">
<h1>
<a href="/">
<a href="/" class="logo">
<span class="sr-only">Jekyll</span>
<img src="/img/logo-2x.png" width="249" height="115" alt="Jekyll Logo">
<img src="/img/logo-2x.png" width="140" height="65" alt="Jekyll Logo">
</a>
</h1>
</div>
<nav class="main-nav unit two-thirds hide-on-mobiles">
<nav class="main-nav hide-on-mobiles">
{% include primary-nav-items.html %}
</nav>
<div class="search hide-on-mobiles">
{% include search/input.html %}
</div>
<div class="meta hide-on-mobiles">
<ul>
<li>
<a href="{{ site.repository }}/releases/tag/v{{ site.version }}">v{{ site.version }}</a>
</li>
<li>
<a href="{{ site.repository }}">GitHub</a>
</li>
</ul>
</div>
</div>
<nav class="mobile-nav show-on-mobiles">
{% include mobile-nav-items.html %}
</nav>
</header>

View File

@@ -0,0 +1,17 @@
<ul>
<li class="{% if page.overview %}current{% endif %}">
<a href="/">Home</a>
</li>
<li class="{% if page.url contains '/docs/' %}current{% endif %}">
<a href="/docs/home/">Docs</a>
</li>
<li class="{% if page.author %}current{% endif %}">
<a href="/news/">News</a>
</li>
<li class="{% if page.url contains '/help/' %}current{% endif %}">
<a href="/help/">Help</a>
</li>
<li>
<a href="{{ site.repository }}">GitHub</a>
</li>
</ul>

View File

@@ -13,10 +13,10 @@
<span class="post-date">
{{ post.date | date_to_string }}
</span>
<a href="https://github.com/{{ post.author }}" class="post-author">
{% assign author = post.author %}
{% assign author = post.author %}
<a href="https://github.com/{{ author }}" class="post-author">
{% avatar user=author size=24 %}
{{ post.author }}
{{ author }}
</a>
</div>
<div class="post-content">

View File

@@ -8,13 +8,7 @@
<li class="{% if page.author %}current{% endif %}">
<a href="/news/">News</a>
</li>
<li class="{% if page.url contains '/community/' %}current{% endif %}">
<a href="/community/">Community</a>
</li>
<li class="{% if page.url contains '/help/' %}current{% endif %}">
<a href="/help/">Help</a>
</li>
<li>
<a href="{{ site.repository }}">GitHub</a>
</li>
</ul>

View File

@@ -0,0 +1 @@
<input type="text" id="docsearch-input" placeholder="Search the docs…">

View File

@@ -0,0 +1,9 @@
<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.js"></script>
<script type="text/javascript"> docsearch({
apiKey: '50fe39c839958dfad797000f33e2ec17',
indexName: 'jekyllrb',
inputSelector: '#docsearch-input',
enhancedSearchInput: true,
debug: false // Set debug to true if you want to inspect the dropdown
});
</script>

View File

@@ -6,7 +6,9 @@
<meta name="generator" content="Jekyll v{{ jekyll.version }}">
{% feed_meta %}
<link rel="alternate" type="application/atom+xml" title="Recent commits to Jekylls master branch" href="{{ site.repository }}/commits/master.atom">
<link rel="stylesheet" href="//fonts.googleapis.com/css?family=Lato:300,300italic,400,400italic,700,700italic,900">
<link rel="preconnect" href="https://fonts.gstatic.com/" crossorigin>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Lato:300,300italic,400,400italic,700,700italic,900">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css" />
<link rel="stylesheet" href="/css/screen.css">
<link rel="icon" type="image/x-icon" href="/favicon.ico">
{% seo %}

View File

@@ -8,6 +8,6 @@
{% include footer.html %}
{% include anchor_links.html %}
{% include analytics.html %}
{% include search/script.html %}
</body>
</html>

View File

@@ -5,7 +5,10 @@ layout: news
<article>
<h2>
{{ page.title }}
<a href="{{ page.url }}" class="permalink" title="Permalink"></a>
<a href="{{ page.url }}" class="header-link" title="Permalink">
<span class="sr-only">Permalink</span>
<i class="fa fa-link"></i>
</a>
</h2>
<span class="post-category">
<span class="label">
@@ -16,9 +19,10 @@ layout: news
<span class="post-date">
{{ page.date | date_to_string }}
</span>
<a href="https://github.com/{{ page.author }}" class="post-author">
{% avatar {{ page.author}} size=24 %}
{{ page.author }}
{% assign author = page.author %}
<a href="https://github.com/{{ author }}" class="post-author">
{% avatar user=author size=24 %}
{{ author }}
</a>
</div>
<div class="post-content">

View File

@@ -6,25 +6,18 @@ version: 1.1.1
categories: [release]
---
Coming just 10 days after the release of v1.1.0, v1.1.1 is out with a patch for
the nasty excerpt inception bug ([#1339]({{ site.repository }}/issues/1339)) and
non-zero exit codes for invalid commands ([#1338]({{ site.repository
}}/issues/1338)).
Coming just 10 days after the release of v1.1.0, v1.1.1 is out with a patch for the nasty
excerpt inception bug ([#1339][]) and non-zero exit codes for invalid commands
([#1338][]).
To all those affected by the [strange excerpt bug in v1.1.0]({{ site.repository
}}/issues/1321), I'm sorry. I think we have it all patched up and it should be
deployed to [GitHub Pages](https://pages.github.com/) in the next couple weeks.
Thank you for your patience!
To all those affected by the [strange excerpt bug in v1.1.0][#1321], I'm sorry. I think we
have it all patched up and it should be deployed to [GitHub Pages][gh_pages] in the next
couple weeks. Thank you for your patience!
If you're checking out v1.1.x for the first time, definitely check out [what
shipped with v1.1.0!]({{ site.repository }}/releases/tag/v1.1.0)
If you're checking out v1.1.x for the first time, definitely check out [what shipped with
v1.1.0!][v1_1_0]
See the [GitHub Release][] page for more a more detailed changelog for this release.
{% assign issue_numbers = "1339|1338|1321" | split: "|" %}
{% for issue in issue_numbers %}
[#{{ issue }}]: {{ site.repository }}/issues/{{ issue }}
{% endfor %}
[GitHub Release]: {{ site.repository }}/releases/tag/v1.1.1
[gh_pages]: https://pages.github.com/
[v1_1_0]: {{ site.repository }}/releases/tag/v1.1.0
See the [GitHub Release]({{ site.repository }}/releases/tag/v1.1.1) page for
more a more detailed changelog for this release.

View File

@@ -5,7 +5,7 @@ author: parkr
categories: [partners]
---
![Jekyll Sticker](/img/jekyll-sticker.jpg)
![Jekyll Sticker](/img/jekyll-sticker.png)
You may have heard that [@cobyism](https://github.com/cobyism)'s excellent
Jekyll logo has been made into a sticker. You may have sat idly by, wishing

View File

@@ -10,7 +10,7 @@ Happy Holidays, everyone.
Jekyll v2.5.3 is a quick patch release, containing some minor fixes. See the
[full history](/docs/history/) for more info. If you notice any problems,
please [let us know]({{ site.help_url }}).
please [let us know]({{ site.repository }}).
This release also marks the start of Jekyll 3 development. I wrote about it
over on my personal blog: [Jekyll 3 &mdash; The Road Ahead](https://byparker.com/blog/2014/jekyll-3-the-road-ahead/).

View File

@@ -9,7 +9,7 @@ categories: [release]
Good news! Nearly 400 commits later, Jekyll 3.5.0 has been released into
the wild. Some new shiny things you might want to test out:
- Jekyll now uses Liquid 4, the latest! It comes with whitespace control, new filters `concat` annd `compact`, loop performance improvements and [many fixes](https://github.com/Shopify/liquid/blob/master/History.md#400--2016-12-14--branch-4-0-stable)
- Jekyll now uses Liquid 4, the latest! It comes with whitespace control, new filters `concat` and `compact`, loop performance improvements and [many fixes](https://github.com/Shopify/liquid/blob/master/History.md#400--2016-12-14--branch-4-0-stable)
- Themes can specify runtime dependencies (in their gemspecs) and we'll require those. This makes it easier for theme writers to use plugins.
- Speaking of themes, we'll properly handle the discrepancy between a convertible file in the local site and a static file in the theme. Overriding a file locally now doesn't matter if it's convertible or static.
- Pages, posts, and other documents can now access layout variables via `{% raw %}{{ layout }}{% endraw %}`.

View File

@@ -0,0 +1,23 @@
---
title: 'Jekyll 3.5.2 Released'
date: 2017-08-12 16:31:40 -0400
author: parkr
version: 3.5.2
categories: [release]
---
3.5.2 is out with 6 great bug fixes, most notably one which should dramatically speed up generation of your site! In testing #6266, jekyllrb.com generation when from 18 seconds down to 8! Here is the full line-up of fixes:
* Backport #6266 for v3.5.x: Memoize the return value of `Document#url` (#6301)
* Backport #6247 for v3.5.x: kramdown: symbolize keys in-place (#6303)
* Backport #6281 for v3.5.x: Fix `Drop#key?` so it can handle a nil argument (#6288)
* Backport #6280 for v3.5.x: Guard against type error in `absolute_url` (#6287)
* Backport #6273 for v3.5.x: delegate `StaticFile#to_json` to `StaticFile#to_liquid` (#6302)
* Backport #6226 for v3.5.x: `Reader#read_directories`: guard against an entry not being a directory (#6304
A [full history](/docs/history/#v3-5-2) is available for your perusal. As always, please file bugs if you encounter them! Opening a pull request with a failing test for your expected behaviour is the easiest way for us to address the issue since we have a reproducible example to test again. Short of that, please fill out our issue template to the best of your ability and we'll try to get to it quickly!
Many thanks to our contributors without whom this release could not be
possible: Ben Balter & Kyle Zhao.
Happy Jekylling!

View File

@@ -0,0 +1,17 @@
---
title: 'Jekyll turns 3.6!'
date: 2017-09-21 16:38:20 -0400
author: parkr
version: 3.6.0
categories: [release]
---
Another much-anticipated release of Jekyll. This release comes with it Rouge 2 support, but note you can continue to use Rouge 1 if you'd prefer. We also now require Ruby 2.1.0 as 2.0.x is no longer supported by the Ruby team.
Otherwise, it's a massive bug-fix release! A few bugs were found and squashed with our `Drop` implementation. We're using the Schwartzian transform to speed up our custom sorting (thanks, Perl community!). We now protect against images that are named like posts and we generally worked on guarding our code to enforce requirements, instead of assuming the input was as expected.
Please let us know if you find any bugs! You can see [the full history here](/docs/history/#v3-6-0).
Many thanks to our contributors who helped make this release possible: Aleksander Kuś, André Jaenisch, Antonio Argote, ashmaroli, Ben Balter, Bogdan, Bradley Meck, David Zhang, Florian Thomas, Frank Taillandier, Jordon Bedwell, Joshua Byrd, Kyle Zhao, lymaconsulting, Maciej Bembenista, Matt Sturgeon, Natanael Arndt, Ohad Schneider, Pat Hawks, Pedro Lamas, and Sid Verma.
As always, Happy Jekylling!

View File

@@ -0,0 +1,44 @@
---
title: "Diversity in Open Source, and Jekyll's role in it"
date: 2017-10-19 21:33:00 +0200
author: oe
categories: [community]
---
Open Source has a problem with diversity. GitHub recently conducted a [survey](http://opensourcesurvey.org/2017) which revealed that 95% of the respondents were identifying as male. This is even worse than in the tech industry overall, where the percentage is only about 76%. Every other week, there seems to be another case of a maintainer engaging in targeted harassment against minorities. People somehow deem it completely okay to let these things slide, though.
Fortunately, there's a couple of things we can do to make it easier and more comfortable for people that have never contributed to any open source project before, to contribute to our projects.
## Add a Code of Conduct, and enforce it
This might seem like one of the easiest steps to do, but it actually requires a lot of dedication to pull through with. Basically, a Code of Conduct is a document detailing what is and what isn't acceptable behavior in your project. A good Code of Conduct also details enforcement procedures, that means how the person violating the Code of Conduct gets dealt with. This is the point at which I've seen a looooot of projects fail. It's easy enough to copy-paste a Code of Conduct into your project, but it's more important to be clear on how to enforce it. Inconsistent —or worse, nonexistent— enforcement is just going to scare off newcomers even more!
The most widely adopted Code of Conduct is the [Contributor Covenant](https://www.contributor-covenant.org/). It's a very good catch-all document, but it is a bit light in the enforcement section, so I'd recommend to flesh it out by yourself, be it by means of adding contact information or expanding the enforcement rules.
No matter which Code of Conduct you pick, the most important thing is to actually _read it for yourself_. The worst thing in open source is a maintainer that doesn't know when they've violated their own Code of Conduct.
## Document your contributing workflow
The problem that puts people off the most is incomplete or missing documentation, as revealed through GitHub's [open source survey](http://opensourcesurvey.org/2017). A very popular myth in programming is that good code explains itself, which might be true, but only for the person writing it. It's important, especially once you put your project out there for the world to see, to document not only your code, but also the process by which you maintain it. Otherwise, it's going to be extremely hard for newcomers to even figure out where to begin contributing to your project.
Jekyll has [an entire section of its docs](/docs/contributing) dedicated to information on how to contribute for this very reason. Every documentation page has a link to directly edit and improve it on GitHub. It's also important to realize that not all contributions are code. It can be documentation, it can be reviewing pull requests, but it can also just be weighing into issues, and all of this should be recognized in the same way. At Jekyll, out of 397 total merged pull requests in the last year, __204__ were documentation pull requests!
## Create newcomer-friendly issues
For most people new to open source, the biggest hurdle is creating their first pull request. That's why initiatives such as [YourFirstPR](https://twitter.com/yourfirstpr) and [First Timers Only](http://www.firsttimersonly.com/) were started. Recently, [a GitHub bot that automatically creates first-timer friendly issues](https://github.com/hoodiehq/first-timers-bot) was launched, which makes it very easy for maintainers to convert otherwise small or trivial changes into viable pull requests that can be taken on by newcomers! So we decided to give it a shot, and we've created a couple of very easy `first timers only` issues:
- [Issue #6437](https://github.com/jekyll/jekyll/issues/6437)
- [Issue #6438](https://github.com/jekyll/jekyll/issues/6438)
- [Issue #6439](https://github.com/jekyll/jekyll/issues/6439)
(There's also an up-to-date listing of all of our `first timers only` issues [here](https://github.com/jekyll/jekyll/issues?q=is%3Aissue+is%3Aopen+label%3Afirst-time-only))
These issues are designed to be taken on only by someone who has had little to no exposure to contributing to open source before, and additionally, project maintainers offer support in case a question arises.
Jekyll is a very big and popular open source project, and we hope that with these special issues, we can help people who haven't contributed to open source before to catch a footing in these unsteady waters.
## Be nice
I know this is a cliche and a overused phrase, but really, it works if you pull through with it. Come to terms with the fact that some people aren't as fast or reliable as you might want to think. Don't get angry when a contributor takes a day longer than you might like them to. Treat new contributors to your project with respect, but also with hospitality. Think twice before you send that comment with slurs in it.
I've been contributing to open source for about 4 years now, and I've had my fair share of horrible, horrible experiences. But Jekyll has historically been a project that has always valued the people contributing to it over the code itself, and I hope we can keep it that way. I also hope that other project maintainers read this and take inspiration from this post. Every project should be more diverse.

View File

@@ -0,0 +1,42 @@
---
title: 'Jekyll 3.6.2 Released'
date: 2017-10-21 21:31:40 +0200
author: dirtyf
version: 3.6.2
categories: [release]
---
3.6.2 is out, it's a tiny patch release and we invite you to run `bundle update`
if you want to avoid possible build problems with:
* some UTF-8 and UTF-16 encoded files,
* fully numeric layout names (we convert those to string for you now).
Other changes include updates to our documentation, like this [complete
video series by Giraffe Academy](../tutorials/video-walkthroughs/) aimed at
complete beginners. A big thanks to Mike for this.
And if you're wondering what happened to version 3.6.1, it was just our new
release maintainer getting familiar with the release process. 😄
We try to release patch releases as quickly as possible and we're already
working on the next minor version 3.7.0 that will allow you to store all your
collections in a single directory. Stay tuned.
Theme developers are invited to test the brand new
[`jekyll-remote-theme`](https://github.com/benbalter/jekyll-remote-theme) plugin
and give their feedback to @benbalter. This plugin allows you to use any
GitHub hosted theme as a remote theme!
Once again, many thanks to our contributors who helped make this release possible:
ashmaroli, bellvat, Frank Taillandier, i-give-up, Jan Piotrowski, Maximiliano
Kotvinsky, Oliver Steele and Pat Hawks. For some it was their [first
contribution to open-source]({% link
_posts/2017-10-19-diversity-open-source.markdown %}) 👏
As it's been nine years this week that Tom Preston-Werner started this project,
I also wanna seize this opportunity to thank [all of the 732 contributors](https://github.com/jekyll/jekyll/graphs/contributors) who
helped make it possible for Jekyll to power millions of websites around the world
today.
Happy Birthday Jekyll! 🎂

View File

@@ -0,0 +1,37 @@
---
title: "Jekyll 3.7.0 Released"
description: "Jekyll 3.7.0 brings LiveReload, a directory for your collections and much more…"
date: 2018-01-02 11:21:40 +0100
author: DirtyF
version: 3.7.0
categories: [release]
---
We're happy to release a new minor for the new year.
Here are a few of the latest additions from our contributors:
* LiveReload is available as an option during development: with `jekyll serve --livereload` no more manual page refresh. A big thanks to @awood for this feature and to @andreyvit, LiveReload author.
* New `collections_dir` configuration option allows you to store all your [collections](/docs/collections) in a single folder. Your source root folder should now look cleaner :sparkles: .
* If you're using a [gem-based theme](/docs/themes/) in coordination with the `--incremental` option, you should notice some significant speed during the regeneration process, we did see build time went down **from 12s to 2s** with @mmistakes [minimal-mistakes theme](https://github.com/mmistakes/minimal-mistakes) during our tests.
* Jekyll will now check to determine whether host machine has internet connection.
* A new `latin` option is available to better [handle URLs slugs](/docs/templates/#options-for-the-slugify-filter).
* And of course many bug fixes and updates to our documentation — which you can now search thanks to our friends @Algolia.
* [Full history is here](/docs/history/#v3-7-0).
This release wouldn't have been possible without all the following people:
Aaron Borden, Alex Tsui, Alex Wood, Alexey Pelykh, Andrew Dassonville, Angelika Tyborska, Ankit Singhaniya, Ashwin Maroli, bellvat, Brandon Dusseau, Chris Finazzo, Doug Beney, Dr. Wolfram Schroers, Edward Shen, Florian Thomas, Frank Taillandier, Gert-jan Theunissen, Goulven Champenois, János Rusiczki, Jed Fox, Johannes Müller, Jon Anning, Jonathan Hooper, Jordon Bedwell, Junko Suzuki, Kacper Duras, Kenton Hansen, Kewin Dousse, Matt Rogers, Maximiliano Kotvinsky, mrHoliday, Olivia, Parker Moore, Pat Hawks, Sebastian Kulig, Vishesh Ruparelia, Xiaoiver and Yashu Mittal.
A big thanks to everyone!
Oh, one last thing…
### :pray: upgrade your Ruby
Prepare for the next major update, as next major version Jekyll 4.0 will drop support for Ruby 2.1 and 2.2.
> Ruby 2.2 is now under the state of the security maintenance phase, until the end of the March of 2018. After the date, maintenance of Ruby 2.2 will be ended. We recommend you start planning migration to newer versions of Ruby, such as 2.4 or 2.3. — [Ruby Core Team](https://www.ruby-lang.org/en/news/2017/12/14/ruby-2-2-9-released/)
We strongly encourage you to upgrade to at least Ruby 2.4.x [like our friends at GitHub Pages](https://pages.github.com/versions/) or even go with [Ruby 2.5](https://www.ruby-lang.org/en/news/2017/12/25/ruby-2-5-0-released/).
Happy new year to all from the Jekyll team!

View File

@@ -0,0 +1,67 @@
---
title: "Jekyll 3.7.2 Released"
date: 2018-01-25 22:22:22 +0530
author: ashmaroli
version: 3.7.2
categories: [release]
---
Close on the heels of shipping 3.7.0, we were informed of a couple of
regressions due to the changes made in that release. In due time, Team Jekyll
set out to address those issues as early as possible.
Days later here we're, announcing 3.7.2 (sorry for skipping 3.7.1,
RubyGems didn't want to play nice) that fixes numerous issues! :tada:
The highlights being:
* A major regression in 3.7.0 was that when a Front Matter Default was
configured with a `scope["path"]` set to a directory, Jekyll would scan
that directory for any subfolders and files, for each document in that
`path`.
Though this is intended, it increases build times in proportion to the size
of the directory.
We addressed this by having Jekyll scan the directory path only if the user
explicitly configures the `scope["path"]` using wildcards.
Read our [documentation](/docs/configuration/#glob-patterns-in-front-matter-defaults)
for more details.
A huge shout-out to @mmistakes for bringing this to our notice and
additionally providing us with a test repository to aid in resolving the issue.
* Another regression reported was related to our "Custom collections
directory" feature introduced in 3.7.0.
Users setting `collection_dir` to a certain directory would have *altered*
paths to their posts still at the root of their site's source. This
roughly translated to 404 errors on URLs to their posts.
Props to @localheinz for bringing this regression to our notice.
We decided to resolve this by having Jekyll ignore posts and drafts at the
root of the site's source directory if the user customizes the
`collection_dir` setting.
Ergo, if you set a custom location for your collections, please ensure you
move all of your collections into that directory. **This includes posts and
drafts as well**. Your links generated by
`{% raw %}{% post_url %}{% endraw %}` or `{% raw %}{% link %}{% endraw %}`
will adapt automatically.
* We also found out that `gem "wdm"` boosts performance while directories are
being watched on Windows. So we recommend having it included in your Gemfile
for a better development experience on Windows. (Newly generated Gemfiles
will hereafter have that gem listed automatically :wink:)
In addition to the above, numerous other minor fixes and documentation updates
have been made that should improve your Jekyll experience. All of which, would
not have been possible without our wonderful contributors:
Alexandr, Andreas Möller, Ashwin Maroli, Chayoung You, Florian Thomas,
Frank Taillandier, Hendrik Schneider, Kacper Duras, Olivia, Parker Moore and
Paul Robert Lloyd.
As always, you can see our full changelog on [the History page](/docs/history/).
Happy Jekylling! :sparkles:

View File

@@ -0,0 +1,43 @@
---
layout: news_item
title: "Meet Jekyll's New Lead Developer"
date: "2018-02-19 20:48:09 -0500"
author: parkr
categories: [team]
---
Jekyll has a new Lead Developer: [Olivia](https://liv.cat/)!
After over 5 years of leading Jekyll, many releases from 0.12.1 to 3.6.0, and
countless conversations in GitHub Issues, Pull Requests, Jekyll Talk, and
more, I am passing on the torch as Lead Developer of Jekyll.
Olivia has been working with the Jekyll community for some time now. You
may have seen her around in issues and pull requests on the various Jekyll
repositories. She started as a contributor, then joined the Core team as our
community lead. Olivia joined the Jekyll Core Team with experience in the
Node.js community, both online and as a volunteer organizer with JSConf EU.
In my conversations with Olivia, it is clear that Jekyll's vision of
simplicity for the user ([no magic!](/philosophy#1-no-magic)) and letting
users' [content be king](/philosophy#3-content-is-king) will remain a top
priority. In just the last few weeks as the transition has been occurring,
we have seen some incredible work on performance that will make future
versions of Jekyll work better at scale. She will be prioritizing work on
innovative improvements to make Jekyll that much better for all of us.
Olivia balances an eye for quality with the need for shipping well.
When Tom Preston-Werner met me at GitHub HQ 2.0 in January 2013 to pass on
the torch, I could never have dreamed of all the amazing experiences this
community would share with me over the next 5 years. From visiting @qrush
in Buffalo, NY for a hack night on Jekyll to attending a Jekyll planning
session hosted by @benbalter at GitHub to Google Summer of Code which gave
us jekyll-admin, I am eternally grateful to all of you for the opportunity
to lead this excellent community. I'm confident Olivia will continue to
lead Jekyll to even greater heights.
As always, Happy Jekylling!
Parker
*Curious about who else runs this show? [Check out our excellent team.](/team/)*

View File

@@ -0,0 +1,19 @@
---
title: 'Jekyll 3.7.3 Released'
date: 2018-02-25 13:02:08 +0530
author: ashmaroli
version: 3.7.3
categories: [release]
---
Hello Jekyllers!! :wave:
We're pleased to announce the release of `v3.7.3` which fixes a bug one might encounter while using `Jekyll - 3.7.x` along with a
Jekyll plugin that in turn uses the `I18n` library.
When [v3.7.0]({% link _posts/2018-01-02-jekyll-3-7-0-released.md %}) enhanced our `slugify` filter with a `latin` option, we also
hardcoded a default fallback locale for the `I18n` library to avoid an exception raised in the event the library fails to find
any locale. This led to issues with third-party i18n plugins for Jekyll, especially since the default locale got assigned before
the plugin was loaded, irrespective of whether the `slugify` filter was used.
Jekyll will henceforth set the default locale if and only if necessary.

View File

@@ -0,0 +1,28 @@
---
title: "Jekyll 4.0 is on the Horizon!"
date: "2018-04-19 16:07:00 +0100"
author: oe
categories: [community]
---
With the release of Jekyll 3.8.0, it's been 2 and a half years since the last major release. Jekyll 3.0.0 was released in late October of 2015! That's a long time ago, and we've been working towards the next major release of Jekyll for a couple of months now. Here's a small preview of what's to come:
- Dropping support for Ruby 2.1 and 2.2. Both versions have reached their EOL period.
- Dropping Pygments as a dependency. We're already defaulting to Rouge, and this removes the implicit Python dependency. (finally!)
- Making the `link` tag use relative URLs. This is a big breaking change, but it's the cleaner solution.
We're open to more ideas, though. If the development cost isn't too high, or if someone volunteers to take care of the implementation, it's likely that your suggestion might make it into Jekyll 4.0. Head over to this [issue] for more details. Some interesting topics might be improving Internationalization support in Jekyll, creating convenience Liquid tags, et cetera.
That being said, the development period of version 4.0 begins _now_. This means a couple of things:
- New features will only be implemented in Jekyll 4.0. There will be no 3.9.0 or the like.
- Same with bug fixes, unless they concern something introduced in Jekyll 3.7 or 3.8, in which case we will backport the fixes and release a patch version.
- Now is a great time to finally take on the feature you've wanted to see in Jekyll for ages! Just open an issue or experiment with the code to get going!
As for a release date, we're currently aiming for late summer, around September or so. However, keep in mind that this project is purely volunteer-run, and as such, delays might occur and we might not hit that release date.
Finally, this is a great time for newcomers to open-source to make their first contribution. We'll be doing our best to mark recommended contributions and create newcomer-friendly issues, as well as to provide mentoring throughout the contribution process (although we'd like to think that we're already pretty proficient at that). So if you've always been hestitant about contributing to a large open-source project, Jekyll is a good place to start!
Happy Jekylling! :wave:
[issue]: https://github.com/jekyll/jekyll/issues/6948

View File

@@ -0,0 +1,43 @@
---
title: 'Jekyll 3.8.0 Released'
date: 2018-04-19 19:45:15 +0530
author: ashmaroli
version: 3.8.0
categories: [release]
---
Aloha Jekyllers!! :wave:
After months of toiling on the codebase and shipping a couple of release-candidates, the Jekyll Team is delighted to finally
present `v3.8.0`, packed with optimizations, improvements, some new features and a couple of bug-fixes. Yay!!!
Under the hood, Jekyll has undergone many minor changes that will allow it to run more performantly in the coming years. :smiley:
Rest assured, our users should see minor improvements in their site's build times.
Speaking of improvements, users running a site containing a huge amount of posts or those who like to use our `where` filter
frequently in a single template, are going to see a massive reduction in their total build times!! :tada:
Hold on, this version is not just about optimizations, there are some new features as well..:
* Detect non-existent variables and filters specified in a template by enabling `strict_variables` and `strict_filters` under the
`liquid` key in your config file.
* Allow *date filters* to output ordinal days.
* `jekyll doctor` now warns you if you have opted for custom `collections_dir` but placed `_posts` directory outside that
directory.
..and yes, a couple of bug-fixes, notably:
* Jekyll now handles future-dated documents properly.
* Jekyll is able to handle Liquid blocks intelligently in excerpts.
* A few methods that were *not meant to be publically accessible* have been entombed properly.
* A few bugs that still plagued our `collections_dir` feature from `v3.7` got crushed.
As always, the full list of changes since last release can be viewed [here](/docs/history/#v3-8-0).
A big thanks to the following people who contributed to our repository with pull-requests that improved our codebase, documentation
and tests:
Ana María Martínez Gómez, Antonio Argote, Ashwin Maroli, Awjin Ahn, Ben Balter, Benjamin Høegh, Christian Oliff, Damien Solodow,
David Zhang, Delson Lima, Eric Cornelissen, Florian Thomas, Frank Taillandier, Heinrich Hartmann, Jakob Vad Nielsen, John Eismeier,
Kacper Duras, KajMagnus, Mario Cekic, Max Vilimpoc, Michael H, Mike Kasberg, Parker Moore, Pat Hawks, Paweł Kuna, Robert Riemann,
Roger Rohrbach, Semen Zhydenko, Stefan Dellmuth, Tim Carry, olivia, and steelman.
Happy Jekylling!! :sparkles:

View File

@@ -0,0 +1,20 @@
---
title: 'Jekyll 3.8.1 Released'
date: 2018-05-01 11:56:01 -0500
author: pathawks
version: 3.8.1
categories: [release]
---
Happy May Day :tada:
The Jekyll team is happy to announce the release of `v3.8.1`, which fixes
a couple of bugs that were introduced two weeks ago in `v3.8.0`. If you have
experienced trouble regarding post excerpts or non-published posts, this release
should be the remedy. Thanks to @Chaosed0 and @domLocalHeroes for originally
reporting these issues, and to @ashmaroli for fixing them so quickly.
As a reminder, we have started work on Jekyll 4.0. If there are any
features that you would love to see added to Jekyll, or any pain points you
would like to see removed, please do add your ideas to the [Jekyll 4.0 idea
list](https://github.com/jekyll/jekyll/issues/6948).

View File

@@ -0,0 +1,19 @@
---
title: 'Jekyll 3.8.2 Released'
date: 2018-05-19 10:30:00 -0500
author: pathawks
version: 3.8.2
categories: [release]
---
Hello Jekyllers!!
Today we are releasing `v3.8.2`, which fixes the way Jekyll generates excerpts
for posts when the first paragraph of the post contains Liquid tags that take
advantage of [Liquid's whitespace control feature][Liquid whitespace].
Big thanks to @kylebarbour, who first reported this issue and also very quickly
submitted a fix. Also thanks to @nickskalkin for making sure that we are using
the latest version of Rubocop to lint our code.
[Liquid whitespace]: https://shopify.github.io/liquid/basics/whitespace/

View File

@@ -0,0 +1,13 @@
---
title: 'Jekyll 3.8.3 Released'
date: 2018-06-05 09:00:00 -0500
author: pathawks
version: 3.8.3
categories: [release]
---
This release fixes a regression in 3.8 where collections with `published: false`
do not show when using the `--unpublished` flag.
Thanks to @philipbelesky for reporting and fixing this issue; collections with
`published: false` now behave the same way as Posts.

View File

@@ -0,0 +1,68 @@
---
title: "Sponsoring Jekyll's development"
date: 2018-08-01 15:00:00 +0200
author: oe
categories: [community]
---
_(TL;DR: We're open for sponsorships on our [OpenCollective page](https://opencollective.com/jekyll))_
Hi Jekyllers,
As you may know, Jekyll is a completely free and open source project. We offer our
software and its related plugins and documentation at no cost because we believe
that good software should not cost anything. We're not planning on changing that,
but today I want to talk about a different monetary aspect of open source.
Open source developers being paid for the work they do is a rare sight. Most open source
software is effectively the result of hundreds and thousands of hours of free labor provided
by individuals who are passionate enough to work outside of their day job to create
software that, ironically, is being used by almost every company that offers
digital services. It's a problem that has gotten more attention in recent years, with
the open source community becoming more diverse and more and more companies actively
investing in providing monetary support for open source developers.
Jekyll has always been a product of volunteers. Rarely has someone been paid to implement
a certain plugin or feature. Today, we're excited to announce that we will finally
be able to fund our contributors! __We are opening an OpenCollective to receive
individual and corporate sponsorships__. This is not unheard of, [Hugo](http://gohugo.io)
is also funded by sponsorships, as are many other similar projects, such as
[webpack](https://opencollective.com/webpack), [Babel](https://opencollective.com/babel) or
[RuboCop](https://opencollective.com/rubocop).
OpenCollective is a service that makes it easy for open source projects to receive funding
from individuals and companies alike. It's specifically designed for open source and
many other projects already use it for funding.
Sponsoring is, for us, a method to finally realize some of the more ambitious goals we've had
with the project for years. The closest thing we want to realize is to __release Jekyll 4.0, and
to make it as polished as we can__. In the future, we would also like to work on other things that
will improve the Jekyll ecosystem. Here's a couple of ideas:
- Create a comprehensive official plugin and theme directory site
- Improve tooling built around measuring and improving Jekyll's performance
- Improve maintenance for official plugins
- Including the community into official decisions; making Jekyll more friendly to folks in the community
Again, these are just some ideas, but with the help of sponsoring, they are now one step closer
to being realized :heart:
<div align="center">
<img src="/img/forestry-logo.png" width="300" />
</div>
With that, we would like to announce our very first sponsor: [__Forestry.io__](https://forestry.io)! Forestry is
a CMS that integrates with your Jekyll sites and lets you update content using a beautiful
interface, and then automatically commits it back to your GitHub repository. We're excited to have
them on board on a new, exciting step of our journey.
Will anything change for Jekyll users? The answer is no - this step does not impact the Jekyll software
in any aspect. In fact, you might see positive changes, such as more features and better
performance. Surprisingly, that's what happens when you properly fund people for their work!
If you have been a long time user for Jekyll and would like to give something back to the project,
you can consider a small monthly donation to our [OpenCollective page](http://opencollective.com/jekyll).
If your company heavily relies on Jekyll, do consider sponsoring us! Contact me at
`olivia at fastmail dot com` and we'll figure something out together.
Thanks for sticking with us, and happy Jekylling! :tada:

View File

@@ -0,0 +1,60 @@
.searchbox {
padding-top: 1px;
.searchbox__input {
padding: 6px 5px 5px 29px;
font-size: 0.75em;
border: none;
border-radius: 5px;
color: #555;
background-color: #333 !important;
box-shadow: 0 0 1px 0 #555;
&::-webkit-input-placeholder {
color: #aaa;
}
&:-ms-input-placeholder {
color: #aaa;
}
&::placeholder {
color: #aaa;
}
&:focus, &:active {
color: #eaeaea;
background-color: #252525 !important;
}
}
}
.searchbox__submit svg { fill: #fc0 }
.searchbox__reset svg { fill: #999 }
.algolia-autocomplete {
.ds-dropdown-menu {
font-size: 1rem;
text-shadow: none;
.ds-suggestion.ds-cursor .algolia-docsearch-suggestion:not(.suggestion-layout-simple) .algolia-docsearch-suggestion--content {
background-color: rgba(221, 221, 221, 0.5);
}
}
.algolia-docsearch-suggestion--category-header {
background-color: #444;
color: #ddd;
padding: 0.35em;
}
.algolia-docsearch-suggestion--subcategory-column {
color: #444;
}
.algolia-docsearch-suggestion--highlight {
background-color: #fc0;
color: #222;
}
.algolia-docsearch-suggestion--text .algolia-docsearch-suggestion--highlight {
box-shadow: inset 0 -2px 0 0 #fc0;
}
}

View File

@@ -1,4 +1,4 @@
/*! normalize.css v6.0.0 | MIT License | github.com/necolas/normalize.css */
/*! normalize.css v7.0.0 | MIT License | github.com/necolas/normalize.css */
/* Document
========================================================================== */
@@ -18,6 +18,14 @@ html {
/* Sections
========================================================================== */
/**
* Remove the margin in all browsers (opinionated).
*/
body {
margin: 0;
}
/**
* Add the correct display in IE 9-.
*/
@@ -225,7 +233,8 @@ svg:not(:root) {
========================================================================== */
/**
* Remove the margin in Firefox and Safari.
* 1. Change the font styles in all browsers (opinionated).
* 2. Remove the margin in Firefox and Safari.
*/
button,
@@ -233,7 +242,10 @@ input,
optgroup,
select,
textarea {
margin: 0;
font-family: sans-serif; /* 1 */
font-size: 100%; /* 1 */
line-height: 1.15; /* 1 */
margin: 0; /* 2 */
}
/**
@@ -292,6 +304,14 @@ button:-moz-focusring,
outline: 1px dotted ButtonText;
}
/**
* Correct the padding in Firefox.
*/
fieldset {
padding: 0.35em 0.75em 0.625em;
}
/**
* 1. Correct the text wrapping in Edge and IE.
* 2. Correct the color inheritance from `fieldset` elements in IE.

Some files were not shown because too many files have changed in this diff Show More