Compare commits

...

1522 Commits

Author SHA1 Message Date
Mike Neumegen
b87eb8f612 fix conflicts 2018-11-05 08:48:30 -08:00
Mike Neumegen
3fc4cc265c new design init 2018-11-05 08:12:34 -08:00
olivia hugger
22d9936042 Merge pull request #7354 from jekyll/add-3.8.5-post
Add 3.8.5 post
2018-11-04 21:23:03 +01:00
olivia
271e476e67 reflect 3.8.5 release 2018-11-04 21:22:28 +01:00
olivia
d0c1cde922 Add 3.8.5 post 2018-11-04 21:07:14 +01:00
olivia hugger
564f7735b3 test for stable and backport branches on travis 2018-11-04 20:41:10 +01:00
jekyllbot
d971e39b4f Update history to reflect merge of #6727 [ci skip] 2018-11-04 14:03:21 -05:00
Ashwin Maroli
d926ebf688 Incorporate relative_url filter in link tag (#6727)
Merge pull request 6727
2018-11-04 14:03:18 -05:00
jekyllbot
1825813c93 Update history to reflect merge of #7250 [ci skip] 2018-11-04 14:02:02 -05:00
Ashwin Maroli
592b530de1 Re-implement handling Liquid blocks in excerpts (#7250)
Merge pull request 7250
2018-11-04 14:02:00 -05:00
jekyllbot
b586bed0ee Update history to reflect merge of #7273 [ci skip] 2018-10-31 13:10:21 -04:00
Ashwin Maroli
f0af098abe Memoize the return value of Site#documents (#7273)
Merge pull request 7273
2018-10-31 13:10:19 -04:00
jekyllbot
501d0253fa Update history to reflect merge of #7343 [ci skip] 2018-10-28 11:39:34 -04:00
Frank Taillandier
c9dda7ad50 docs: minimize rendering count (#7343)
Merge pull request 7343
2018-10-28 11:39:32 -04:00
jekyllbot
7d9667f13f Update history to reflect merge of #7304 [ci skip] 2018-10-28 06:08:34 -04:00
Ashwin Maroli
d67cbb4e5f Load config file from within current theme-gem (#7304)
Merge pull request 7304
2018-10-28 06:08:32 -04:00
jekyllbot
56c35f1a7d Update history to reflect merge of #7316 [ci skip] 2018-10-28 06:04:29 -04:00
Ashwin Maroli
9152b1c9b8 Measure the no. of times a template gets rendered (#7316)
Merge pull request 7316
2018-10-28 06:04:27 -04:00
Frank Taillandier
fbec40589d docs: exclude .jekyll-cache
Stop regenerating: files in  .jekyll-cache
2018-10-28 06:31:11 +01:00
jekyllbot
d492766220 Update history to reflect merge of #7276 [ci skip] 2018-10-28 01:12:05 -04:00
Ashwin Maroli
ea8ac3a7fa Memoize Site#post_attr_hash (#7276)
Merge pull request 7276
2018-10-28 01:12:04 -04:00
jekyllbot
266a8bb746 Update history to reflect merge of #7342 [ci skip] 2018-10-27 18:33:44 -04:00
Aidan Fitzgerald
4bbbb8d3e2 Remove redundant instruction comment (#7342)
Merge pull request 7342
2018-10-27 18:33:43 -04:00
jekyllbot
587111ec9f Update history to reflect merge of #7338 [ci skip] 2018-10-26 09:43:42 -04:00
Ashwin Maroli
8d80ada92b Bump RuboCop to v0.60.x (#7338)
Merge pull request 7338
2018-10-26 09:43:40 -04:00
Frank Taillandier
41c25f30e1 style: commas [ci skip]
Co-Authored-By: Ashwin Maroli <ashmaroli@users.noreply.github.com>
2018-10-26 15:31:20 +02:00
Frank Taillandier
bc11acc7b1 docs: use YAML data for paginator obkect 2018-10-26 15:00:17 +02:00
Frank Taillandier
9ff6a24a06 docs: variables table as include
Co-Authored-By: Ashwin Maroli <ashmaroli@users.noreply.github.com>
2018-10-24 17:23:00 +02:00
Frank Taillandier
29ba846f9b Merge pull request #7336 from jekyll/docs/data-variables
docs: Page variables as YAML data
2018-10-24 16:09:01 +02:00
Ashwin Maroli
75f1bccaa4 Adjust whitespace 2018-10-24 19:21:30 +05:30
Frank Taillandier
a7a9c52ae6 docs: Page variables as YAML data 2018-10-24 14:31:30 +02:00
jekyllbot
4ac66931d0 Update history to reflect merge of #7335 [ci skip] 2018-10-24 07:08:03 -04:00
Ashwin Maroli
7422b741c1 Document Jekyll Filters with YAML data (#7335)
Merge pull request 7335
2018-10-24 07:08:00 -04:00
Frank Taillandier
fe74976942 Merge pull request #7334 from ashmaroli/liquid-filters-template
Liquid templating to DRY content
2018-10-24 09:33:16 +02:00
Ashwin Maroli
6413df69e5 Liquid templating to DRY content 2018-10-24 08:28:07 +05:30
Frank Taillandier
bd623967ff docs: fix link to liquid filter 2018-10-24 01:26:06 +02:00
jekyllbot
3987256119 Update history to reflect merge of #7333 [ci skip] 2018-10-23 19:20:30 -04:00
Frank Taillandier
2b146a64fc docs: list all standard liquid filters (#7333)
Merge pull request 7333
2018-10-23 19:20:28 -04:00
olivia hugger
f3c85d4095 Merge pull request #7319 from jekyll/add-tidelift
Add Tidelift to site sponsors
2018-10-19 23:49:07 +02:00
jekyllbot
ecaefdb991 Update history to reflect merge of #7326 [ci skip] 2018-10-19 16:29:16 -04:00
Ashwin Maroli
c7a99f276c Revert "Cache converter in renderer" (#7326)
Merge pull request 7326
2018-10-19 16:29:14 -04:00
jekyllbot
5925c1a531 Update history to reflect merge of #7327 [ci skip] 2018-10-19 15:42:58 -04:00
Brett C
1530e246d8 grammar change (#7327)
Merge pull request 7327
2018-10-19 15:42:56 -04:00
jekyllbot
b3a7ba5a26 Update history to reflect merge of #7302 [ci skip] 2018-10-19 11:35:44 -04:00
Mario
ad7a5c0121 Skip processing posts that can not be read (#7302)
Merge pull request 7302
2018-10-19 11:35:42 -04:00
Frank Taillandier
7a1254563a Docs: reorganize README
Put things in order: getting started, diving in, then asking for help 😄
2018-10-18 14:04:09 +02:00
jekyllbot
2d14125d53 Update history to reflect merge of #7325 [ci skip] 2018-10-18 07:50:47 -04:00
_94gsc
885f76f84e Add a link to Giraffe Academy's tutorial (#7325)
Merge pull request 7325
2018-10-18 07:50:46 -04:00
olivia
8c9dcfee66 add final newline 2018-10-17 15:01:16 +02:00
olivia
42ecb661e4 add footer section for tidelift instead 2018-10-17 14:57:18 +02:00
olivia
bf02c401a3 add tidelift to site sponsors 2018-10-17 12:08:36 +02:00
Frank Taillandier
fd6e01fd6a docs: tweak capture delay [ci-skip]
Screenshots are better now but with Lazyloading it feels really slow. 🐢
Ideally we'd cache and use the former screenshot as placeholder and replace it with the newer version.
2018-10-12 19:32:50 +02:00
Frank Taillandier
77bc82b92f docs: add a bit of delay before capture [ci-skip]
Some images in the showcase show not fully loaded pages. A bit of delay should help.

Documentation: https://docs.capture.techulus.in/docs/screenshot-options
2018-10-12 19:24:49 +02:00
Frank Taillandier
f65bcd9920 docs: update showcase [ci-skip] 2018-10-12 19:11:56 +02:00
olivia hugger
a28fc8531a update my email in the sponsoring post 2018-10-12 19:01:40 +02:00
olivia hugger
5779b29855 fix typo in blank site template 2018-10-12 13:01:38 +02:00
jekyllbot
749415c47f Update history to reflect merge of #7310 [ci skip] 2018-10-12 06:57:47 -04:00
jekyllbot
37baaec83e feat: enhance --blank scaffolding (#7310)
Merge pull request 7310
2018-10-12 06:57:45 -04:00
jekyllbot
1bb7f03e44 Update history to reflect merge of #7312 [ci skip] 2018-10-10 17:15:42 -04:00
XhmikosR
f6f6a5661d Update appveyor.yml (#7312)
Merge pull request 7312
2018-10-10 17:15:41 -04:00
jekyllbot
153f24c4e4 Update history to reflect merge of #7307 [ci skip] 2018-10-09 20:21:40 -04:00
Jordan Morgan
2966b7ff94 "This restricts you..." to "This restricts your" (#7307)
Merge pull request 7307
2018-10-09 20:21:39 -04:00
jekyllbot
5795bf08fb Update history to reflect merge of #7306 [ci skip] 2018-10-09 18:13:26 -04:00
Jordan Morgan
3b4eb69d22 Added missing semicolon (#7306)
Merge pull request 7306
2018-10-09 18:13:24 -04:00
jekyllbot
148ac25190 Update history to reflect merge of #7300 [ci skip] 2018-10-07 04:50:18 -04:00
Preston Lim
51fe430fdd Add Isomer to showcase (#7300)
Merge pull request 7300
2018-10-07 04:50:17 -04:00
jekyllbot
7eca92adf8 Update history to reflect merge of #7299 [ci skip] 2018-10-05 09:43:07 -04:00
argv-minus-one
052dbf8b98 Automatically load _config.toml (#7299)
Merge pull request 7299
2018-10-05 09:43:06 -04:00
jekyllbot
fec13b3d05 Update history to reflect merge of #7136 [ci skip] 2018-10-03 11:29:48 -04:00
Ashwin Maroli
a2d61f976f Optimize rendering Liquid templates (#7136)
Merge pull request 7136
2018-10-03 11:29:45 -04:00
jekyllbot
440374aa4d Update history to reflect merge of #7190 [ci skip] 2018-10-02 07:27:16 -04:00
Pat Hawks
139ea09967 Do not dump undumpable objects (#7190)
Merge pull request 7190
2018-10-02 07:27:15 -04:00
Frank Taillandier
28cb55c455 chore(history): rendered includes are still WIP 2018-10-02 11:36:25 +02:00
Frank Taillandier
1eeb89460e Update History.markdown 2018-10-02 11:19:26 +02:00
jekyllbot
2cd15712c7 Update history to reflect merge of #7108 [ci skip] 2018-10-02 04:55:46 -04:00
jekyllbot
15128418be Update history to reflect merge of #7183 [ci skip] 2018-10-02 04:16:51 -04:00
Pat Hawks
b8dfc9a32f Cache converter in renderer (#7183)
Merge pull request 7183
2018-10-02 04:16:49 -04:00
jekyllbot
0b90e536ab Update history to reflect merge of #7159 [ci skip] 2018-10-02 04:07:09 -04:00
Pat Hawks
18d33b1fd6 Cache converted markdown (#7159)
Merge pull request 7159
2018-10-02 04:07:08 -04:00
jekyllbot
93b5b57aea Update history to reflect merge of #7291 [ci skip] 2018-10-02 03:14:55 -04:00
Andy Alt
517eb749a0 Docs: Add link tag to item in RSS template (#7291)
Merge pull request 7291
2018-10-02 03:14:54 -04:00
jekyllbot
d667f12941 Update history to reflect merge of #7289 [ci skip] 2018-10-01 14:37:17 -04:00
Grzegorz Kaczorek
55dd39d580 Document converter methods (#7289)
Merge pull request 7289
2018-10-01 14:37:15 -04:00
jekyllbot
452c1c88d0 Update history to reflect merge of #7287 [ci skip] 2018-10-01 08:49:33 -04:00
Ashwin Maroli
faed9c4143 Drop support for jekyll-watch-1.4.0 and older (#7287)
Merge pull request 7287
2018-10-01 08:49:31 -04:00
jekyllbot
a70ed3713f Update history to reflect merge of #7285 [ci skip] 2018-09-30 11:03:03 -04:00
jekyllbot
05f109071d Remove default config for markdown (#7285)
Merge pull request 7285
2018-09-30 11:03:02 -04:00
Frank Taillandier
63deec3074 Add links to YAML cheatsheets
Fix #6054
2018-09-30 11:00:57 +02:00
jekyllbot
8dcb14c582 Update history to reflect merge of #7283 [ci skip] 2018-09-29 08:31:29 -04:00
Frank Taillandier
688d0734b8 Docs: more inclusive writing (#7283)
Merge pull request 7283
2018-09-29 08:31:28 -04:00
jekyllbot
94baf09753 Update history to reflect merge of #7282 [ci skip] 2018-09-28 18:43:27 -04:00
Andy Alt
6c6595bd1e tutorial/convert existing site.md/rss:add title tag to item (#7282)
Merge pull request 7282
2018-09-28 18:43:25 -04:00
Frank Taillandier
927a09b4c5 Add latest version for sidebar
props @pathawks
2018-09-28 09:24:22 +02:00
Frank Taillandier
997c9044d5 Thanks @parkr 🙏 2018-09-27 14:54:25 +02:00
Frank Taillandier
4a6edf4778 Typo 2018-09-27 14:47:22 +02:00
jekyllbot
3055992712 Update history to reflect merge of #7259 [ci skip] 2018-09-27 08:38:32 -04:00
Ashwin Maroli
00311d2638 Add Release Post for v3.6.3, v3.7.4 and v3.8.4 (#7259)
Merge pull request 7259
2018-09-27 08:38:30 -04:00
jekyllbot
353574307a Update history to reflect merge of #7118 [ci skip] 2018-09-27 08:29:48 -04:00
Ashwin Maroli
4707017936 Drop support for pygments as syntax-highlighter (#7118)
Merge pull request 7118
2018-09-27 08:29:46 -04:00
jekyllbot
deff194cbf Update history to reflect merge of #7278 [ci skip] 2018-09-26 15:20:53 -04:00
liv
d306ba74e1 update yajl-ruby (#7278)
Merge pull request 7278
2018-09-26 15:20:51 -04:00
jekyllbot
0d2394bdca Update history to reflect merge of #7277 [ci skip] 2018-09-26 10:18:58 -04:00
Ashwin Maroli
57da5c0e29 Check key in collections only if it isn't "posts" (#7277)
Merge pull request 7277
2018-09-26 10:18:57 -04:00
liv
44a8035d13 reorder doc change template 2018-09-24 19:37:46 +02:00
jekyllbot
ec47c9dd9d Update history to reflect merge of #7200 [ci skip] 2018-09-24 13:29:08 -04:00
Maxwell Gerber
b8cf387b71 Fix Contributors link (#7200)
Merge pull request 7200
2018-09-24 13:29:06 -04:00
jekyllbot
3fc1d5b54b Update history to reflect merge of #7182 [ci skip] 2018-09-24 13:27:46 -04:00
Ashwin Maroli
6eee8b7e06 Strip extra slashes via Jekyll.sanitized_path (#7182)
Merge pull request 7182
2018-09-24 13:27:44 -04:00
jekyllbot
ce05f9cb15 Update history to reflect merge of #7010 [ci skip] 2018-09-24 13:26:34 -04:00
Isaac Goodman
81792c29d3 Use OpenSSL instead of GnuTLS (#7010)
Merge pull request 7010
2018-09-24 13:26:32 -04:00
Frank Taillandier
a0c2e65ed7 add issue template for documentation 2018-09-24 18:46:52 +02:00
jekyllbot
4d293d3376 Update history to reflect merge of #7269 [ci skip] 2018-09-24 12:34:34 -04:00
liv
d83d3e880e Add more issue template(s) and pull request template (#7269)
Merge pull request 7269
2018-09-24 12:34:32 -04:00
jekyllbot
1e81243ef8 Update history to reflect merge of #7270 [ci skip] 2018-09-24 12:31:37 -04:00
Grzegorz Kaczorek
8a7ecfce36 Document two methods, simplify one of the methods (#7270)
Merge pull request 7270
2018-09-24 12:31:36 -04:00
jekyllbot
5267e0b215 Update history to reflect merge of #7267 [ci skip] 2018-09-24 12:29:57 -04:00
ikeji
0960ae0755 Ignore permission error of /proc/version (#7267)
Merge pull request 7267
2018-09-24 12:29:55 -04:00
jekyllbot
f043eeabc5 Update history to reflect merge of #7268 [ci skip] 2018-09-23 06:09:37 -04:00
Luis Guillermo Yáñez
e9aa4ff2c1 Update 10-deployment.md (#7268)
Merge pull request 7268
2018-09-23 06:09:36 -04:00
jekyllbot
05fdb6733f Update history to reflect merge of #7266 [ci skip] 2018-09-22 08:51:36 -04:00
Tobias
096afbeee4 environments.md: reference the build command options that allows multiple config files (#7266)
Merge pull request 7266
2018-09-22 08:51:34 -04:00
Frank Taillandier
e59ff78f9d docs: fix path to Ubuntu 2018-09-21 10:33:31 +02:00
Frank Taillandier
879a4c44f6 docs: install dependencies on Debian 2018-09-21 10:30:58 +02:00
Frank Taillandier
47ec61f9b5 docs: Linux, not Ubuntu 2018-09-21 09:14:13 +02:00
jekyllbot
141a7b784b Update history to reflect merge of #7262 [ci skip] 2018-09-20 09:49:41 -04:00
jekyllbot
88dbe5db8a chore(release): reflect latest patched releases (#7262)
Merge pull request 7262
2018-09-20 09:49:39 -04:00
jekyllbot
f692f0999c Update history to reflect merge of #7263 [ci skip] 2018-09-20 09:45:55 -04:00
Ashwin Maroli
88e0472160 Check if scope applies to type before given path (#7263)
Merge pull request 7263
2018-09-20 09:45:53 -04:00
jekyllbot
72dc3a56f3 Update history to reflect merge of #7260 [ci skip] 2018-09-19 14:02:45 -04:00
Jorie Tappa
2e1492da55 Fix a small grammar error/typo in the docs (#7260)
Merge pull request 7260
2018-09-19 14:02:44 -04:00
jekyllbot
1987c36f27 Update history to reflect merge of #7229 [ci skip] 2018-09-19 07:56:17 -04:00
jekyllbot
bd41ebb97b Update history to reflect merge of #6888 [ci skip] 2018-09-19 07:46:41 -04:00
Ashwin Maroli
352133f39b cache matched defaults sets for given parameters (#6888)
Merge pull request 6888
2018-09-19 07:46:39 -04:00
Frank Taillandier
a0dc346e6c Unlock bundler
https://github.com/bundler/bundler/issues/6629 has been fixed
2018-09-19 02:35:41 -07:00
jekyllbot
573c7edbc1 Update history to reflect merge of #7228 [ci skip] 2018-09-18 12:24:17 -04:00
Frank Taillandier
a22cd6d603 Unpublish unreleased Cache API tutorial 2018-09-15 11:44:37 +02:00
Frank Taillandier
cc363657cb Add Kotn website 2018-09-15 11:09:46 +02:00
Frank Taillandier
495456bb3c Note: building from scratch
Fix #7242
2018-09-13 10:54:32 +02:00
jekyllbot
20d0326d30 Update history to reflect merge of #7241 [ci skip] 2018-09-11 18:26:20 -04:00
Stephen Weiss
938b2f1d01 explicit location of where to create blog.html (#7241)
Merge pull request 7241
2018-09-11 18:26:19 -04:00
Frank Taillandier
f9c981e317 Redirects Fixes #7230 2018-09-11 08:42:12 +02:00
jekyllbot
5dedcd5fce Update history to reflect merge of #7238 [ci skip] 2018-09-10 12:19:32 -04:00
Chris Finazzo
74c185c461 Minor grammar fixes (#7238)
Merge pull request 7238
2018-09-10 12:19:30 -04:00
jekyllbot
4271495fca Update history to reflect merge of #7237 [ci skip] 2018-09-09 18:14:48 -04:00
jekyllbot
a28f54a59f Bump Rubocop to v0.59.0 (#7237)
Merge pull request 7237
2018-09-09 18:14:46 -04:00
jekyllbot
6d777a2a21 Update history to reflect merge of #7234 [ci skip] 2018-09-09 17:27:04 -04:00
Stephen Weiss
d6c1216244 clarified front matter requirement (#7234)
Merge pull request 7234
2018-09-09 17:27:02 -04:00
jekyllbot
874ec5c3e2 Update history to reflect merge of #7226 [ci skip] 2018-09-07 15:17:56 -04:00
Parker Moore
f1c87a9129 Security: fix include bypass of EntryFilter#filter symlink check (#7226)
Merge pull request 7226
2018-09-07 15:17:55 -04:00
liv
863a93f9ff update forestry's sponsor url 2018-09-06 13:07:01 +02:00
jekyllbot
27cade4a28 Update history to reflect merge of #7223 [ci skip] 2018-09-06 02:16:21 -04:00
Justin Vallelonga
e56bf80bfc removes quotes from markdown for assets (#7223)
Merge pull request 7223
2018-09-06 02:16:19 -04:00
Frank Taillandier
56dd010c82 Explain the help command 2018-09-05 10:37:24 +02:00
Frank Taillandier
0db83b5008 Update link 2018-09-04 16:50:03 +02:00
jekyllbot
28492e8401 Update history to reflect merge of #7217 [ci skip] 2018-09-03 16:38:14 -04:00
Bilawal Hameed
895e58b01b Add developer.spotify.com to the Jekyll Showcase (#7217)
Merge pull request 7217
2018-09-03 16:38:12 -04:00
Frank Taillandier
7d5479e52f Update showcase.yml 2018-09-03 15:38:40 +02:00
jekyllbot
0b21d67507 Update history to reflect merge of #7215 [ci skip] 2018-09-03 08:18:33 -04:00
Sundaram Kalyan Vedala
93507f02dc Fix minor grammatical error (#7215)
Merge pull request 7215
2018-09-03 08:18:32 -04:00
jekyllbot
8e5c5a4e8a Update history to reflect merge of #7213 [ci skip] 2018-09-03 04:07:12 -04:00
Ashwin Maroli
182327d49c Add cucumber feature to test include_relative tag (#7213)
Merge pull request 7213
2018-09-03 04:07:11 -04:00
jekyllbot
d626fc07c2 Update history to reflect merge of #7214 [ci skip] 2018-09-03 04:05:39 -04:00
Thanos Kolovos
f22425ad2a Add some minor improvements to image loading (#7214)
Merge pull request 7214
2018-09-03 04:05:38 -04:00
jekyllbot
5c61d69c94 Update history to reflect merge of #7211 [ci skip] 2018-09-02 14:01:12 -04:00
Vitor Oliveira
397d289cd2 Refactoring: Fix benchmark code smell (#7211)
Merge pull request 7211
2018-09-02 14:01:11 -04:00
Frank Taillandier
a693153755 Typo 2018-09-02 10:13:43 +02:00
Frank Taillandier
d684e390df jekyll-plugin topic on GitHub 2018-09-02 07:58:09 +02:00
jekyllbot
8c5ee833d4 Update history to reflect merge of #7210 [ci skip] 2018-09-02 01:50:16 -04:00
ninevra
418018a41f Correct stylesheet url in tutorial step 7 (#7210)
Merge pull request 7210
2018-09-02 01:50:14 -04:00
jekyllbot
1e9cd27dc4 Update history to reflect merge of #7205 [ci skip] 2018-09-01 04:39:58 -04:00
Mike Neumegen
805f438f24 New docs (#7205)
Merge pull request 7205
2018-09-01 04:39:57 -04:00
jekyllbot
3aa41a6055 Update history to reflect merge of #7203 [ci skip] 2018-08-29 13:20:55 -04:00
Ashwin Maroli
9f93fd092f Interpolate Jekyll::Page subclass on inspection (#7203)
Merge pull request 7203
2018-08-29 13:20:52 -04:00
jekyllbot
58f10f8e8a Update history to reflect merge of #7198 [ci skip] 2018-08-26 09:50:36 -04:00
Samuel Gruetter
bd9162a3bb installation instructions for Fedora (#7198)
Merge pull request 7198
2018-08-26 09:50:35 -04:00
jekyllbot
d3fba977f7 Update history to reflect merge of #7196 [ci skip] 2018-08-26 07:45:08 -04:00
Ma HongJun
a983bac6ca Resolve "Unable to locate package ruby2.4" error (#7196)
Merge pull request 7196
2018-08-26 07:45:06 -04:00
jekyllbot
5666e42474 Update history to reflect merge of #7199 [ci skip] 2018-08-26 07:38:02 -04:00
Anny
535637ba06 Add missing html end tag for code example in section 'For loops' (#7199)
Merge pull request 7199
2018-08-26 07:38:00 -04:00
jekyllbot
2913ab2891 Update history to reflect merge of #6854 [ci skip] 2018-08-25 06:07:29 -04:00
ExE Boss
9195b61d51 Add support for *.xhtml files (#6854)
Merge pull request 6854
2018-08-25 06:07:28 -04:00
jekyllbot
130292f15e Update history to reflect merge of #7189 [ci skip] 2018-08-21 10:39:33 -04:00
Ashwin Maroli
7f09faa954 Replace regex arg to :gsub with a string arg (#7189)
Merge pull request 7189
2018-08-21 10:39:31 -04:00
jekyllbot
3f62fd96d3 Update history to reflect merge of #7169 [ci skip] 2018-08-21 03:38:54 -04:00
Pat Hawks
24dd9f1457 Add Cache class (#7169)
Merge pull request 7169
2018-08-21 03:38:53 -04:00
jekyllbot
30568ca7b8 Update history to reflect merge of #7184 [ci skip] 2018-08-16 16:30:52 -04:00
Frank Taillandier
7791ad27a2 update .gitignore 2018-08-16 18:06:56 +02:00
liv
61bb9e9626 change team page phrasing 2018-08-15 21:32:12 +02:00
jekyllbot
19a7c1f06a Update history to reflect merge of #7181 [ci skip] 2018-08-14 08:07:21 -04:00
David J. Malan
176489b95c Corrected sample usage of postfiles (#7181)
Merge pull request 7181
2018-08-14 08:07:19 -04:00
jekyllbot
9a9c480831 Update history to reflect merge of #7179 [ci skip] 2018-08-09 06:30:21 -04:00
Victor Afanasev
5ec7324559 Add info how to deploy using pre-push git hook (#7179)
Merge pull request 7179
2018-08-09 06:30:20 -04: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
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
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
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
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
Parker Moore
56436f46fe Update History.markdown to unify Bug Fixes and fix 2017-07-30 19:20:21 -04:00
jekyllbot
34967978c2 Update history to reflect merge of #6253 [ci skip] 2017-07-30 15:12:43 -04:00
Ben Balter
b35c0d8607 Call to_s on site.url before attempting to concatenate strings (#6253)
Merge pull request 6253
2017-07-30 15:12:42 -04:00
jekyllbot
a6efa48883 Update history to reflect merge of #6255 [ci skip] 2017-07-30 14:32:26 -04:00
Frank Taillandier
12832af98e docs: add missing backticks in History (#6255)
Merge pull request 6255
2017-07-30 14:32:25 -04:00
jekyllbot
f8d06f20aa Update history to reflect merge of #6247 [ci skip] 2017-07-28 12:05:45 -04:00
Parker Moore
143367c5ca kramdown: symbolize keys in-place (#6247)
Merge pull request 6247
2017-07-28 12:05:43 -04:00
jekyllbot
592daf4ce2 Update history to reflect merge of #6239 [ci skip] 2017-07-26 20:09:35 -04:00
ashmaroli
82c219a2e7 exit site.process sooner (#6239)
Merge pull request 6239
2017-07-26 20:09:33 -04:00
jekyllbot
590dd6cf80 Update history to reflect merge of #6087 [ci skip] 2017-07-25 19:20:21 -04:00
Bogdan
8f1959bbc4 Define path with __dir__ (#6087)
Merge pull request 6087
2017-07-25 19:20:20 -04:00
jekyllbot
8a017b5a2a Update history to reflect merge of #6220 [ci skip] 2017-07-25 18:45:45 -04:00
ashmaroli
96724af03e Bump supported Ruby version to >= 2.1.0 (#6220)
Merge pull request 6220
2017-07-25 18:45:44 -04:00
jekyllbot
4493f2a58b Update history to reflect merge of #6225 [ci skip] 2017-07-25 18:23:39 -04:00
Joshua Byrd
93169f60c3 Adding DevKit helpers (#6225)
Merge pull request 6225
2017-07-25 18:23:38 -04:00
jekyllbot
7b255baac2 Update history to reflect merge of #6226 [ci skip] 2017-07-25 18:23:04 -04:00
Parker Moore
188bc71713 Reader#read_directories: guard against an entry not being a directory (#6226)
Merge pull request 6226
2017-07-25 18:23:02 -04:00
jekyllbot
897cdbb427 Update history to reflect merge of #6231 [ci skip] 2017-07-25 18:22:41 -04:00
Matt Sturgeon
ec84bec6d6 Fix serving files that clash with directories (#6231)
Merge pull request 6231
2017-07-25 18:22:40 -04:00
jekyllbot
819491b99c Update history to reflect merge of #6240 [ci skip] 2017-07-25 06:28:18 -04:00
ashmaroli
00a1d70e8f fix tests (#6240)
Merge pull request 6240
2017-07-25 06:28:17 -04:00
jekyllbot
66c39d3bf9 Update history to reflect merge of #6198 [ci skip] 2017-07-24 06:02:25 -04:00
Jordon Bedwell
e25c4af590 Users should be installing patch versions. (#6198)
Merge pull request 6198
2017-07-24 06:02:24 -04:00
jekyllbot
1a592c5757 Update history to reflect merge of #6218 [ci skip] 2017-07-24 05:55:07 -04:00
Maciej Bembenista
a54906c78a Update custom-404-page.md - fix a typo (#6218)
Merge pull request 6218
2017-07-24 05:55:06 -04:00
jekyllbot
56546a28fd Update history to reflect merge of #6229 [ci skip] 2017-07-18 08:11:25 -04:00
ashmaroli
c0c1185c56 deprecator.rb: fix typo for --serve command (#6229)
Merge pull request 6229
2017-07-18 08:11:23 -04:00
jekyllbot
c2b240e9b5 Update history to reflect merge of #5760 [ci skip] 2017-07-18 08:06:07 -04:00
Pat Hawks
da65e94728 Add URL checks to Doctor (#5760)
Merge pull request 5760
2017-07-18 08:06:05 -04:00
jekyllbot
2b28f9fd57 Update history to reflect merge of #6054 [ci skip] 2017-07-18 03:29:34 -04:00
ashmaroli
026f8280e0 Ignore final newline in folded YAML string (#6054)
Merge pull request 6054
2017-07-18 03:29:33 -04:00
jekyllbot
33cb629079 Update history to reflect merge of #6228 [ci skip] 2017-07-18 02:55:56 -04:00
ashmaroli
f904a7201e strip unnecessary leading whitespace (#6228)
Merge pull request 6228
2017-07-18 02:55:54 -04:00
Parker Moore
848bd4edcc Release 💎 3.5.1 2017-07-17 13:14:00 -04:00
jekyllbot
c7d98cae26 Update history to reflect merge of #6045 [ci skip] 2017-07-10 09:46:49 -04:00
Frank Taillandier
59a42230c7 Avoid deprecation message (#6045)
Merge pull request 6045
2017-07-10 09:46:48 -04:00
jekyllbot
fa2aa394d6 Update history to reflect merge of #6214 [ci skip] 2017-07-09 12:55:10 -04:00
Coby Chapple
355436f1ee tweak page margin, and adjust mobile nav accordingly (#6214)
Merge pull request 6214
2017-07-09 12:55:09 -04:00
jekyllbot
e946bbf331 Update history to reflect merge of #6210 [ci skip] 2017-07-08 05:57:56 -04:00
Joshua Byrd
735411e27f Linking the link (#6210)
Merge pull request 6210
2017-07-08 05:57:55 -04:00
jekyllbot
74373baa55 Update history to reflect merge of #6193 [ci skip] 2017-07-01 16:55:36 -04:00
Kevin Plattret
2253b9dd85 Small correction in documentation for includes (#6193)
Merge pull request 6193
2017-07-01 16:55:35 -04:00
jekyllbot
e059a18ef0 Update history to reflect merge of #6192 [ci skip] 2017-07-01 14:25:51 -04:00
Frank Taillandier
a641568da8 Warn for deprecation message (#6192)
Merge pull request 6192
2017-07-01 14:25:50 -04:00
Parker Moore
409a36e6c0 Include v3.4.5 release notes in site and in History.markdown 2017-06-30 22:18:50 -04:00
Parker Moore
b0136fccfa Fix History entry for #6185 2017-06-30 21:59:02 -04:00
jekyllbot
17370b5992 Update history to reflect merge of #6185 [ci skip] 2017-06-30 21:58:27 -04:00
Ben Balter
9f7815786b Always normalize the result of the relative_url filter (#6185)
Merge pull request 6185
2017-06-30 21:58:25 -04:00
Parker Moore
b089e44016 Move Bug Fixes to the top of the current HEAD's history. 2017-06-30 21:55:29 -04:00
jekyllbot
5c95201c98 Update history to reflect merge of #6162 [ci skip] 2017-06-30 21:51:57 -04:00
Ben Balter
f91b614793 Static files contain front matter default keys when to_liquid'd (#6162)
Merge pull request 6162
2017-06-30 21:51:55 -04:00
jekyllbot
4f4d42444a Update history to reflect merge of #6184 [ci skip] 2017-06-26 19:51:10 -04:00
Florian Thomas
a0cf395246 set minimum requirement for jekyll-feed (#6184)
Merge pull request 6184
2017-06-26 19:51:09 -04:00
jekyllbot
00cca72c7b Update history to reflect merge of #6176 [ci skip] 2017-06-26 02:53:34 -04:00
ashmaroli
141b1afd50 test with Ruby 2.4.1-1 on AppVeyor (#6176)
Merge pull request 6176
2017-06-26 02:53:33 -04:00
jekyllbot
605a14412d Update history to reflect merge of #6174 [ci skip] 2017-06-25 18:39:06 -04:00
Doug Beney
6aa8f741c9 Added improved Pug plugin - removed 404 Jade plugin (#6174)
Merge pull request 6174
2017-06-25 18:39:05 -04:00
jekyllbot
e836de3205 Update history to reflect merge of #6179 [ci skip] 2017-06-25 14:00:03 -04:00
Adam Voss
17c888dcab Add raw tags to prevent template rendering (#6179)
Merge pull request 6179
2017-06-25 14:00:01 -04:00
jekyllbot
374de56062 Update history to reflect merge of #6169 [ci skip] 2017-06-24 12:31:59 -04:00
Frank Taillandier
f1410c7e23 run jekyll doctor to check the config (#6169)
Merge pull request 6169
2017-06-24 12:31:58 -04:00
jekyllbot
19a84584c9 Update history to reflect merge of #6163 [ci skip] 2017-06-21 14:24:16 -04:00
ashmaroli
7a85376246 backward compatiblize URLFilters (#6163)
Merge pull request 6163
2017-06-21 14:24:14 -04:00
jekyllbot
ca39b15255 Update history to reflect merge of #6165 [ci skip] 2017-06-21 11:43:13 -04:00
Adam Voss
285fe73b2e Add information about finding a collection in site.collections (#6165)
Merge pull request 6165
2017-06-21 11:43:12 -04:00
jekyllbot
e24fd073fe Update history to reflect merge of #6164 [ci skip] 2017-06-21 04:13:54 -04:00
James, please
0f0dab0239 Update minimum Ruby version in installation.md (#6164)
Merge pull request 6164
2017-06-21 04:13:53 -04:00
Frank Taillandier
3a52866cce Update History.markdown (#6156) 2017-06-19 11:45:13 -04:00
jekyllbot
ffbccb63ba Update history to reflect merge of #6055 [ci skip] 2017-06-19 08:32:38 -04:00
Fadhil
82809bbc6d add plugins for multiple page pagination (#6055)
Merge pull request 6055
2017-06-19 08:32:37 -04:00
jekyllbot
3a527bcecf Update history to reflect merge of #6143 [ci skip] 2017-06-19 08:31:09 -04:00
Robert Jäschke
483951be75 added BibSonomy plugin (#6143)
Merge pull request 6143
2017-06-19 08:31:08 -04:00
jekyllbot
056cebd16b Update history to reflect merge of #6139 [ci skip] 2017-06-19 07:52:59 -04:00
jaybe@jekyll
0dcc7cb20e Update reference to trouble with OS X/macOS (#6139)
Merge pull request 6139
2017-06-19 07:52:58 -04:00
Parker Moore
5380b4fd83 Release 💎 3.5.0 2017-06-18 18:40:44 -04:00
Parker Moore
9eba49cd61 Release 💎 3.5.0 2017-06-18 18:40:35 -04:00
Parker Moore
2207223559 Bump to v3.4.4 2017-06-18 18:20:19 -04:00
Parker Moore
9f302b34ae Release post for Jekyll v3.5 (#6144)
* Add draft of release post for Jekyll v3.5

* add a few details about Liquid 4

* remove @ashmaroli doppelgânger

* change layout: nil to layout: null
2017-06-18 18:15:48 -04:00
jekyllbot
e3917b6fa2 Update history to reflect merge of #6153 [ci skip] 2017-06-18 16:10:48 -04:00
ashmaroli
88e7943084 Refine doc for Windows (#6153)
Merge pull request 6153
2017-06-18 16:10:47 -04:00
jekyllbot
6c88e5c241 Update history to reflect merge of #6140 [ci skip] 2017-06-18 13:20:10 -04:00
Parker Moore
01dd356564 Lock nokogiri to 1.7.x for Ruby 2.1 (#6140)
Merge pull request 6140
2017-06-18 13:20:09 -04:00
jekyllbot
0d96ac4700 Update history to reflect merge of #6149 [ci skip] 2017-06-18 07:27:42 -04:00
Henry Kobin
5ceef94c1b corrected windows.md (#6149)
Merge pull request 6149
2017-06-18 07:27:41 -04:00
jekyllbot
6384724a09 Update history to reflect merge of #6141 [ci skip] 2017-06-16 12:42:34 -04:00
KeJun
8dd76bc6c7 docs(JekyllOnWindows): Add a new Installation way (#6141)
Merge pull request 6141
2017-06-16 12:42:32 -04:00
jekyllbot
7236e514ea Update history to reflect merge of #6147 [ci skip] 2017-06-15 17:33:49 -04:00
penny
aeb0fd7ddf add documentation about the "pinned" label (#6147)
Merge pull request 6147
2017-06-15 17:33:47 -04:00
jekyllbot
fbdfbbb28d Update history to reflect merge of #6137 [ci skip] 2017-06-15 14:29:08 -04:00
Parker Moore
1ae0e83b2d Default baseurl to nil instead of empty string (#6137)
Merge pull request 6137
2017-06-15 14:29:07 -04:00
jekyllbot
3439a0d947 Update history to reflect merge of #6075 [ci skip] 2017-06-15 14:28:42 -04:00
Ben Balter
69e97fa06f Add strip_index filter (#6075)
Merge pull request 6075
2017-06-15 14:28:41 -04:00
jekyllbot
401e20cfa6 Update history to reflect merge of #6093 [ci skip] 2017-06-15 08:29:37 -04:00
Anatoliy Yastreb
d3b00cb84c Bump Rubocop to 0.49.1 (#6093)
Merge pull request 6093
2017-06-15 08:29:35 -04:00
jekyllbot
2c0f5b3059 Update history to reflect merge of #6138 [ci skip] 2017-06-15 08:29:04 -04:00
Parker Moore
79b3f00b21 Allow you to specify the rouge version via an environemnt variable for testing (#6138)
Merge pull request 6138
2017-06-15 08:29:02 -04:00
jekyllbot
ae8889ae2b Update history to reflect merge of #6081 [ci skip] 2017-06-14 16:37:22 -04:00
David Zhang
13b9dcd466 Document difference between cgi_escape and uri_escape #5970 (#6081)
Merge pull request 6081
2017-06-14 16:37:21 -04:00
jekyllbot
1dd3e3b593 Update history to reflect merge of #6086 [ci skip] 2017-06-14 16:36:41 -04:00
David Zhang
551d2ea858 Add test for uri_escape on reserved characters (#6086)
Merge pull request 6086
2017-06-14 16:36:40 -04:00
jekyllbot
36265128cd Update history to reflect merge of #6103 [ci skip] 2017-06-14 16:26:58 -04:00
ashmaroli
4299539db5 Test if hidden collections output a document with a future date (#6103)
Merge pull request 6103
2017-06-14 16:26:56 -04:00
jekyllbot
8221855735 Update history to reflect merge of #5622 [ci skip] 2017-06-14 16:18:08 -04:00
Martin Desrumaux
e031ac9b27 Allow filters to sort & select based on subvalues (#5622)
Merge pull request 5622
2017-06-14 16:18:07 -04:00
jekyllbot
158ab6ce93 Update history to reflect merge of #6092 [ci skip] 2017-06-14 15:42:45 -04:00
Anatoliy Yastreb
2ceff6ab3e Read explicitly included dot-files in collections. #6091 (#6092)
Merge pull request 6092
2017-06-14 15:42:43 -04:00
jekyllbot
4e3b5ba5b4 Update history to reflect merge of #5918 [ci skip] 2017-06-14 15:38:40 -04:00
ashmaroli
fcde83431e Address reading non-binary static files in themes (#5918)
Merge pull request 5918
2017-06-14 15:38:38 -04:00
Parker Moore
b0afe5125c Update history to reflect merge of #5315
[ci skip]
2017-06-14 15:23:47 -04:00
Florian Thomas
b76b4a4e8a add test to use variable in where_exp condition 2017-06-14 15:22:26 -04:00
jekyllbot
61cdebf272 Update history to reflect merge of #6058 [ci skip] 2017-06-14 15:06:56 -04:00
ashmaroli
2a4d33e615 patch URLFilters to prevent // (#6058)
Merge pull request 6058
2017-06-14 15:06:55 -04:00
jekyllbot
cee3cc506e Update history to reflect merge of #6073 [ci skip] 2017-06-14 15:05:40 -04:00
Anatoliy Yastreb
2cfcb23a49 Fix layout front-matter variables rendering. #6071 (#6073)
Merge pull request 6073
2017-06-14 15:05:38 -04:00
jekyllbot
c71c27a397 Update history to reflect merge of #6072 [ci skip] 2017-06-14 15:03:02 -04:00
Christopher League
73368f8f0d In jekyll new, make copied site template user-writable (#6072)
Merge pull request 6072
2017-06-14 15:02:59 -04:00
jekyllbot
35684dd1b8 Update history to reflect merge of #6134 [ci skip] 2017-06-14 03:42:10 -04:00
Kaligule
33aafe0a45 Link the troubleshooting page in the quickstart page (#6134)
Merge pull request 6134
2017-06-14 03:42:09 -04:00
jekyllbot
466a4a69eb Update history to reflect merge of #6126 [ci skip] 2017-06-09 04:07:17 -04:00
Eric Leong
5dedd233bd Remove blank newlines. (#6126)
Merge pull request 6126
2017-06-09 04:07:16 -04:00
jekyllbot
307c0c933d Update history to reflect merge of #6119 [ci skip] 2017-06-04 19:23:18 -04:00
Frank Taillandier
4b7ebeb014 Upload the _site folder *content* (#6119)
Merge pull request 6119
2017-06-04 19:23:17 -04:00
jekyllbot
729472bbda Update history to reflect merge of #6109 [ci skip] 2017-06-02 08:19:11 -04:00
Henry Kobin
9c7ac163cc Added windows to docs.yml (#6109)
Merge pull request 6109
2017-06-02 08:19:09 -04:00
jekyllbot
b6bd2f79d6 Update history to reflect merge of #6115 [ci skip] 2017-06-02 05:32:08 -04:00
Ashton Hellwig
20c0576862 Update windows.md (#6115)
Merge pull request 6115
2017-06-02 05:32:07 -04:00
jekyllbot
00d0b5de6b Update history to reflect merge of #6114 [ci skip] 2017-06-01 19:54:24 -04:00
sean delaney
5a1d78cadf Fix wording in _docs/templates.md links section (#6114)
Merge pull request 6114
2017-06-01 19:54:23 -04:00
jekyllbot
18d8144dc1 Update history to reflect merge of #6111 [ci skip] 2017-06-01 15:54:02 -04:00
Henry Kobin
52b7e5245c updated Bash on Ubuntu on Windows link in tutorial (#6111)
Merge pull request 6111
2017-06-01 15:54:01 -04:00
jekyllbot
22b18543ef Update history to reflect merge of #6110 [ci skip] 2017-06-01 09:14:51 -04:00
Frank Taillandier
b2e6e408ed plugins -> gems (#6110)
Merge pull request 6110
2017-06-01 09:14:50 -04:00
jekyllbot
5790510beb Update history to reflect merge of #6107 [ci skip] 2017-05-31 16:10:12 -04:00
Antonio Argote
8a8b055150 Explain how to override theme styles (#6107)
Merge pull request 6107
2017-05-31 16:10:10 -04:00
jekyllbot
59db714d8b Update history to reflect merge of #6100 [ci skip] 2017-05-31 10:35:55 -04:00
Henry Kobin
b8430df6b1 windows 10 tutorial (#6100)
Merge pull request 6100
2017-05-31 10:35:54 -04:00
jekyllbot
2561470039 Update history to reflect merge of #6088 [ci skip] 2017-05-24 20:57:04 -04:00
Kevin Funk
f1a9af5ba6 Update plugins.md (#6088)
Merge pull request 6088
2017-05-24 20:57:03 -04:00
jekyllbot
dcd54adbc0 Update history to reflect merge of #6078 [ci skip] 2017-05-23 02:47:40 -04:00
Krzysztof Szafranek
6c728120be Use more precise language when explaining links (#6078)
Merge pull request 6078
2017-05-23 02:47:39 -04:00
jekyllbot
93c8b8556e Update history to reflect merge of #6082 [ci skip] 2017-05-23 02:45:45 -04:00
David Zhang
33ff62ee03 Update _config.yml: gems to plugins (#6082)
Merge pull request 6082
2017-05-23 02:45:44 -04:00
jekyllbot
bd104c4ee0 Update history to reflect merge of #5933 [ci skip] 2017-05-15 16:06:25 -04:00
ashmaroli
4d9c93e491 Disable default layouts for documents with a layout: none declaration (#5933)
Merge pull request 5933
2017-05-15 16:06:23 -04:00
jekyllbot
e0dfff0122 Update history to reflect merge of #5803 [ci skip] 2017-05-12 20:28:04 -04:00
ashmaroli
1d55b70365 Remove ruby RUBY_VERSION from generated Gemfile (#5803)
Merge pull request 5803
2017-05-12 20:28:03 -04:00
jekyllbot
771bae4ec5 Update history to reflect merge of #6042 [ci skip] 2017-05-12 20:25:10 -04:00
Hendrik Schneider
3156f74a53 Added plugin jekyll-analytics (#6042)
Merge pull request 6042
2017-05-12 20:25:09 -04:00
jekyllbot
72564f179b Update history to reflect merge of #6064 [ci skip] 2017-05-12 20:24:26 -04:00
Oreonax
f93c155781 Add own plugin -> Jekyll Brand Social Wall (#6064)
Merge pull request 6064
2017-05-12 20:24:25 -04:00
jekyllbot
13b6c502b7 Update history to reflect merge of #5832 [ci skip] 2017-05-09 20:17:37 -04:00
Jonathan Hooper
308ba550ef Add option to fail a build with front matter syntax errors (#5832)
Merge pull request 5832
2017-05-09 20:17:36 -04:00
jekyllbot
86d2b77f3b Update history to reflect merge of #6068 [ci skip] 2017-05-09 03:46:26 -04:00
Shane Neuville
2b535792c7 Fixed documentation inconsistency (#6068)
Merge pull request 6068
2017-05-09 03:46:24 -04:00
jekyllbot
c3c5745e4a Update history to reflect merge of #6070 [ci skip] 2017-05-09 03:45:04 -04:00
Finn Ellis
d3a15fad8d Typo fix (welcomed change -> welcome change). (#6070)
Merge pull request 6070
2017-05-09 03:45:03 -04:00
jekyllbot
be70e8edd7 Update history to reflect merge of #6053 [ci skip] 2017-04-27 11:28:36 -04:00
Sven Meyer
e5c0e91bc5 adjusted date-format in sitemap (#6053)
Merge pull request 6053
2017-04-27 11:28:35 -04:00
jekyllbot
0126f4ab5e Update history to reflect merge of #6050 [ci skip] 2017-04-25 12:09:20 -04:00
zenHeart
501ef914d7 doc correct spelling error (#6050)
Merge pull request 6050
2017-04-25 12:09:19 -04:00
jekyllbot
e3dae0065f Update history to reflect merge of #6009 [ci skip] 2017-04-25 11:40:15 -04:00
Frank Taillandier
d37f604fe2 Compress Website Sass output (#6009)
Merge pull request 6009
2017-04-25 11:40:13 -04:00
jekyllbot
46668744e4 Update history to reflect merge of #6049 [ci skip] 2017-04-25 11:37:37 -04:00
Ryan Streur
0aea7c5262 rephrase a sentence in posts.md to be more direct (#6049)
Merge pull request 6049
2017-04-25 11:37:35 -04:00
jekyllbot
fbd535278e Update history to reflect merge of #6048 [ci skip] 2017-04-24 11:56:05 -04:00
ashmaroli
5f7f9ff196 fix sentence in documentation (#6048)
Merge pull request 6048
2017-04-24 11:56:04 -04:00
jekyllbot
2e34bb816a Update history to reflect merge of #6043 [ci skip] 2017-04-24 03:44:58 -04:00
Liu Cheng
457e4515e8 Update travis-ci.md to correct procedure (#6043)
Merge pull request 6043
2017-04-24 03:44:57 -04:00
jekyllbot
4aa073279f Update history to reflect merge of #6044 [ci skip] 2017-04-22 16:22:27 -04:00
Frank Taillandier
3a36fde240 Fix CI after #6040 (#6044)
Merge pull request 6044
2017-04-22 16:22:26 -04:00
jekyllbot
13976cfb33 Update history to reflect merge of #6040 [ci skip] 2017-04-19 18:42:23 -04:00
dyang
694dcbd9e0 fix typo (#6040)
Merge pull request 6040
2017-04-19 18:42:22 -04:00
jekyllbot
4c61e1809a Update history to reflect merge of #5487 [ci skip] 2017-04-19 14:50:27 -04:00
Florian Thomas
0108b22f3c create configuration from options only once in the boot process (#5487)
Merge pull request 5487
2017-04-19 14:50:25 -04:00
jekyllbot
76fb728f72 Update history to reflect merge of #6035 [ci skip] 2017-04-18 18:43:38 -04:00
Marc Bruins
c35f0ed71c Add MvvmCross to samples (#6035)
Merge pull request 6035
2017-04-18 18:43:36 -04:00
jekyllbot
4b8b3084cd Update history to reflect merge of #6013 [ci skip] 2017-04-17 17:32:06 -04:00
Brent Yi
b728473a63 Update CDN for MathJax (#6013)
Merge pull request 6013
2017-04-17 17:32:04 -04:00
jekyllbot
144d053226 Update history to reflect merge of #6031 [ci skip] 2017-04-17 17:07:00 -04:00
Jeff Puckett
af5d0965c0 doc use example.com (#6031)
Merge pull request 6031
2017-04-17 17:06:59 -04:00
jekyllbot
b37d8b13dc Update history to reflect merge of #6032 [ci skip] 2017-04-17 17:04:00 -04:00
Sven Meyer
a2e5899450 corrected reference to layout in index.md (#6032)
Merge pull request 6032
2017-04-17 17:03:59 -04:00
jekyllbot
14f0db9dcc Update history to reflect merge of #5130 [ci skip] 2017-04-17 07:46:34 -04:00
Florian Thomas
ccb133fd33 add plugins config key as replacement for gems (#5130)
Merge pull request 5130
2017-04-17 07:46:33 -04:00
jekyllbot
3df88b2e31 Update history to reflect merge of #6028 [ci skip] 2017-04-14 16:28:33 -04:00
Jeff Puckett
edc7a7ae54 doc fix typo word usage (#6028)
Merge pull request 6028
2017-04-14 16:28:32 -04:00
jekyllbot
be9b83dff6 Update history to reflect merge of #6027 [ci skip] 2017-04-14 07:33:36 -04:00
Ricky Han
c49bc5c28b changed formatting to fit the style of the documentation (#6027)
Merge pull request 6027
2017-04-14 07:33:35 -04:00
jekyllbot
5f6abda201 Update history to reflect merge of #6026 [ci skip] 2017-04-13 16:30:54 -04:00
Jeff Puckett
7945da2b1f fix typo using past participle (#6026)
Merge pull request 6026
2017-04-13 16:30:53 -04:00
jekyllbot
a6663fc667 Update history to reflect merge of #6021 [ci skip] 2017-04-13 08:13:19 -04:00
Ricky Han
87dd49693b Added txtpen in tutorial (#6021)
Merge pull request 6021
2017-04-13 08:13:18 -04:00
jekyllbot
4e82518a01 Update history to reflect merge of #6018 [ci skip] 2017-04-11 11:19:51 -04:00
Zarino Zappia
034f03ed50 Standardise on "URLs" without apostrophe in docs (#6018)
Merge pull request 6018
2017-04-11 11:19:49 -04:00
jekyllbot
8b8ad61097 Update history to reflect merge of #6006 [ci skip] 2017-04-09 16:45:45 -04:00
ashmaroli
029b993225 Fixup tutorial on creating theme from existing HTML templates (#6006)
Merge pull request 6006
2017-04-09 16:45:43 -04:00
jekyllbot
cce53abe3d Update history to reflect merge of #5997 [ci skip] 2017-04-09 07:24:46 -04:00
ashmaroli
7d7a312b33 Bump Rubocop to v0.48 (#5997)
Merge pull request 5997
2017-04-09 07:24:45 -04:00
jekyllbot
a83b668409 Update history to reflect merge of #6008 [ci skip] 2017-04-05 17:18:24 -04:00
Chris Finazzo
d1c7bdb985 Update normalize.css to v6.0.0 (#6008)
Merge pull request 6008
2017-04-05 17:18:23 -04:00
jekyllbot
84d1f2d408 Update history to reflect merge of #5789 [ci skip] 2017-04-05 16:16:56 -04:00
jekyllbot
768d2bb5a3 absolute_url should not mangle URL if called more than once (#5789)
Merge pull request 5789
2017-04-05 16:16:55 -04:00
jekyllbot
f46dffcc8e Update history to reflect merge of #6007 [ci skip] 2017-04-05 15:36:31 -04:00
Parker Moore
5f19b1a7e0 Use yajl-ruby 1.2.2 (now with 2.4 support) (#6007)
Merge pull request 6007
2017-04-05 15:36:29 -04:00
jekyllbot
b4926daf3a Update history to reflect merge of #5722 [ci skip] 2017-04-04 19:47:12 -04:00
jekyllbot
52ac75b484 Date filters should never raise an exception (#5722)
Merge pull request 5722
2017-04-04 19:47:11 -04:00
jekyllbot
4d689ec051 Update history to reflect merge of #5912 [ci skip] 2017-04-04 18:40:30 -04:00
Ryan Lue
94e6b65ad4 Revamp Permalink section (#5912)
Merge pull request 5912
2017-04-04 18:40:29 -04:00
jekyllbot
fb2654f293 Update history to reflect merge of #5881 [ci skip] 2017-04-04 18:37:34 -04:00
Tom Johnson
dede66936e New tutorial: Convert an HTML site to Jekyll (#5881)
Merge pull request 5881
2017-04-04 18:37:33 -04:00
jekyllbot
370d28e290 Update history to reflect merge of #6002 [ci skip] 2017-04-03 01:28:30 -04:00
Adam Hollett
45b1f9e5ec Fix missing quotation mark (#6002)
Merge pull request 6002
2017-04-03 01:28:29 -04:00
jekyllbot
55103132f9 Update history to reflect merge of #5996 [ci skip] 2017-03-31 14:44:47 -04:00
Parker Moore
faf5be46a5 Filters#time helper: Duplicate time before calling #localtime. (#5996)
Merge pull request 5996
2017-03-31 14:44:46 -04:00
Parker Moore
725c756ae1 travis: don't duplicate fmt & default-site tests 2017-03-31 12:04:36 -04:00
Parker Moore
f3bfe2febd travis: upgrade to 2.4.1 2017-03-31 12:02:16 -04:00
jekyllbot
5dee5a000a Update history to reflect merge of #5604 [ci skip] 2017-03-31 02:00:52 -04:00
Mer
da5ee4685e Update upgrading.md to mention usage of bundle update (#5604)
Merge pull request 5604
2017-03-31 02:00:51 -04:00
jekyllbot
57e93c463a Update history to reflect merge of #5889 [ci skip] 2017-03-31 01:48:55 -04:00
Frank Taillandier
a4c4388b8d Don't raise an error if URL contains a colon (#5889)
Merge pull request 5889
2017-03-31 01:48:54 -04:00
jekyllbot
e7a7215095 Update history to reflect merge of #5914 [ci skip] 2017-03-31 01:46:16 -04:00
ashmaroli
0eb9379354 Require runtime_dependencies of a Gem-based theme from its .gemspec file (#5914)
Merge pull request 5914
2017-03-31 01:46:15 -04:00
jekyllbot
7c49070a0e Update history to reflect merge of #5945 [ci skip] 2017-03-31 01:36:15 -04:00
ashmaroli
e4a09706f5 Add a template for custom 404 page (#5945)
Merge pull request 5945
2017-03-31 01:36:14 -04:00
jekyllbot
b7916f8a83 Update history to reflect merge of #5959 [ci skip] 2017-03-31 01:32:15 -04:00
Yury V. Zaytsev
201470902a Document --unpublished flag introduced in 91e9ecf (#5959)
Merge pull request 5959
2017-03-31 01:32:14 -04:00
jekyllbot
367c452105 Update history to reflect merge of #5960 [ci skip] 2017-03-31 01:31:33 -04:00
Jakub Klímek
4eb82706d8 Mention Bash on Ubuntu on Windows (#5960)
Merge pull request 5960
2017-03-31 01:31:32 -04:00
jekyllbot
a4d2ceb320 Update history to reflect merge of #5974 [ci skip] 2017-03-31 01:31:00 -04:00
Parker Moore
b807799f24 Specify version constraint in subcommand error message. (#5974)
Merge pull request 5974
2017-03-31 01:30:59 -04:00
jekyllbot
bdcdfa694f Update history to reflect merge of #5975 [ci skip] 2017-03-31 01:30:09 -04:00
ashmaroli
1b1fe27d75 Re-surface missing public methods in Jekyll::Document (#5975)
Merge pull request 5975
2017-03-31 01:30:08 -04:00
Parker Moore
20ed6d0a3c Update history to reflect merge of #5052
[ci skip]
2017-03-31 01:23:54 -04:00
Parker Moore
d49c781779 Address my comments in #5052. 2017-03-31 01:22:19 -04:00
Anatoliy Yastreb
1c33bd5797 rubocop: reduce code complexity and remove duplicated code 2017-03-31 01:12:01 -04:00
Parker Moore
db06288448 Update history to reflect merge of #5687
[ci skip]
2017-03-31 01:03:56 -04:00
Parker Moore
d925dbca30 Merge branch 'yajl-ruby-2-4-patch'
* yajl-ruby-2-4-patch:
  Depend on my branch of yajl-ruby with Ruby 2.4 Integer fix
2017-03-31 00:58:12 -04:00
Parker Moore
0cf5310cf5 Merge branch 'ashmaroli-ruby-2.4.0'
* ashmaroli-ruby-2.4.0:
  test with pygments 1.1 on all ruby versions
  update rubygems version on travis
  use compatible versions of gems
  test against ruby-2.4.0
2017-03-31 00:57:40 -04:00
Parker Moore
15e133f627 Depend on my branch of yajl-ruby with Ruby 2.4 Integer fix
/cc https://github.com/brianmario/yajl-ruby/pull/173
2017-03-31 00:56:15 -04:00
Parker Moore
409c8f9f31 Make stackprof a ruby script [ci skip] 2017-03-31 00:50:00 -04:00
jekyllbot
3921e523c5 Update history to reflect merge of #5995 [ci skip] 2017-03-30 22:02:05 -04:00
Frank Taillandier
0d02a25b04 Default options for script/proof (#5995)
Merge pull request 5995
2017-03-30 22:02:04 -04:00
Parker Moore
711a8483c6 travis: upgrade Ruby 2.2 and 2.1 to latest PATCH release 2017-03-30 20:14:04 -04:00
jekyllbot
fe388a885e Update history to reflect merge of #5994 [ci skip] 2017-03-30 17:00:33 -04:00
Tom Johnson
8325d56a1a Fix broken link (#5994)
Merge pull request 5994
2017-03-30 17:00:31 -04:00
Parker Moore
6edc546d36 Update history to reflect merge of #5985
[ci skip]
2017-03-28 18:39:30 -04:00
Christoph Päper
3688640d59 add /_data/*.tsv support (#5985)
* Update data.feature

- add .tsv
- add .csv with `\t`
- add .csv with `;`

* Fix Appveyor with dst-aware cucumber steps

* Check for given content in posts

* mention Ruby > 2.1.0 in docs

* Update history to reflect merge of #5983 [ci skip]

* Update history to reflect merge of #5961 [ci skip]

* Update data_reader.rb

- add .tsv support with tab separated columns
- not adding support for auto-detecting `:col_sep`

ftp://ftp.iana.org/assignments/media-types/text/tab-separated-values
https://www.ietf.org/rfc/rfc4180.txt (CSV)
https://ruby-doc.org/stdlib-2.4.1/libdoc/csv/rdoc/CSV.html

* Update data.feature

don't do semicolons and tabs in .csv within this patch

* Update data.feature

I don't know which component replaced my tab characters by space before.

* Update data.feature

t

* Update data_reader.rb

add a single space to satisfy format checker
2017-03-28 18:36:29 -04:00
jekyllbot
73e70da9e5 Update history to reflect merge of #5989 [ci skip] 2017-03-28 11:35:45 -04:00
jekyllbot
0b93d11cc6 Merge pull request #5989 from ashmaroli/fmt-fix
Merge pull request 5989
2017-03-28 11:35:44 -04:00
Ashwin Maroli
86703f1009 Use Rubocop v0.47.1 till we're ready for v0.48 2017-03-28 09:05:54 +05:30
jekyllbot
f598b7e680 Update history to reflect merge of #5961 [ci skip] 2017-03-27 15:39:20 -04:00
jekyllbot
e5317ced15 Merge pull request #5961 from ashmaroli/cucumber-win-fix
Merge pull request 5961
2017-03-27 15:39:18 -04:00
jekyllbot
7affec2347 Update history to reflect merge of #5983 [ci skip] 2017-03-27 15:38:37 -04:00
jekyllbot
99f5925cd3 Merge pull request #5983 from DirtyF/ruby-2.1
Merge pull request 5983
2017-03-27 15:38:36 -04:00
Frank Taillandier
a2e82b7264 mention Ruby > 2.1.0 in docs 2017-03-27 20:47:55 +02:00
Parker Moore
b367314424 Fix whitespace issue in philosophy document.
/cc https://github.com/jekyll/jekyll/issues/5342#issuecomment-247358296
2017-03-27 13:38:09 -04:00
Parker Moore
a6518c1de3 Update history to reflect merge of #5792 [ci skip] 2017-03-27 13:08:00 -04:00
Parker Moore
b91da2c904 Merge pull request #5792 from jekyll/philosophy
Document Jekyll's Philosophy
2017-03-27 13:04:03 -04:00
Parker Moore
f2bf984160 Update philosophy document based on benbalter's feedback. 2017-03-27 13:03:42 -04:00
jekyllbot
a9830fadac Update history to reflect merge of #5952 [ci skip] 2017-03-25 06:16:03 -04:00
jekyllbot
1f00d89e20 Merge pull request #5952 from tomjohnson1492/patch-19
Merge pull request 5952
2017-03-25 06:16:02 -04:00
Pat Hawks
01c95e85dd Merge branch 'master' into patch-19 2017-03-24 17:27:01 -05:00
jekyllbot
a3aed14d41 Update history to reflect merge of #5978 [ci skip] 2017-03-24 17:14:20 -04:00
jekyllbot
a2a6cc0c6a Merge pull request #5978 from jekyll/custom-404-tuts
Merge pull request 5978
2017-03-24 17:14:19 -04:00
jekyllbot
990809ba07 Update history to reflect merge of #5946 [ci skip] 2017-03-24 16:21:38 -04:00
jekyllbot
220335cef7 Merge pull request #5946 from ashmaroli/custom-404-tuts
Merge pull request 5946
2017-03-24 16:21:37 -04:00
Frank Taillandier
3142f31a7a add custom 404 to tutorial navigation 2017-03-24 21:19:54 +01:00
Ashwin Maroli
58dce4f099 Check for given content in posts 2017-03-23 10:10:38 +05:30
jekyllbot
16e807a41d Update history to reflect merge of #5965 [ci skip] 2017-03-22 11:28:40 -04:00
jekyllbot
cba13d4026 Merge pull request #5965 from Kivlov84/patch-2
Merge pull request 5965
2017-03-22 11:28:39 -04:00
jekyllbot
c48f147192 Update history to reflect merge of #5962 [ci skip] 2017-03-22 10:02:05 -04:00
jekyllbot
af0051f19f Merge pull request #5962 from Kivlov84/patch-1
Merge pull request 5962
2017-03-22 10:02:03 -04:00
Aleksander Kuś
b60b78cfc4 changed link references to names 2017-03-22 13:55:56 +01:00
jekyllbot
c55cc1d9ef Update history to reflect merge of #5971 [ci skip] 2017-03-21 15:34:57 -04:00
jekyllbot
2c4eebc2ae Merge pull request #5971 from tomjohnson1492/patch-21
Merge pull request 5971
2017-03-21 15:34:55 -04:00
Tom Johnson
fe6d4c7bea updates from parkr's review
- removed "actually"
- switched code example to use `where`
2017-03-21 10:27:05 -07:00
jekyllbot
161902eda2 Update history to reflect merge of #5949 [ci skip] 2017-03-21 12:26:06 -04:00
jekyllbot
061aa40e9f Merge pull request #5949 from lukebro/patch-1
Merge pull request 5949
2017-03-21 12:26:05 -04:00
Tom Johnson
f9243c5ab1 Included more details about adding defaults to static files
Based on the functionality released in [3.4.2](http://jekyllrb.com/news/2017/03/09/jekyll-3-4-2-released/) re adding defaults to static files, I thought this page needed some more detail.
2017-03-21 08:52:33 -07:00
Parker Moore
351e3abd8e Merge pull request #5969 from jekyll/release-3.4.3
Release post for v3.4.3
2017-03-21 11:24:49 -04:00
Pat Hawks
ca9d6be061 Release post for v3.4.3 2017-03-21 09:58:02 -05:00
Parker Moore
eab83c3653 Update generated history for jekyllrb.com 2017-03-21 10:00:47 -04:00
Pat Hawks
9d66fc2292 Release 💎 3.4.3 2017-03-21 10:00:04 -04:00
Parker Moore
df0d3f20c4 Fix some errant entries in History.markdown. 2017-03-21 09:58:26 -04:00
jekyllbot
d592f5781a Update history to reflect merge of #5957 [ci skip] 2017-03-21 09:12:18 -04:00
jekyllbot
2907825f62 Merge pull request #5957 from jekyll/pull/escape_colon
Merge pull request 5957
2017-03-21 09:12:16 -04:00
Aleksander Kuś
086bf13a33 Update buddyworks.md
added article to `buddy.yml`
2017-03-21 10:49:48 +01:00
Aleksander Kuś
93f472d1eb Update buddyworks.md
added unique links + minor text changes
2017-03-21 09:34:43 +01:00
jekyllbot
428ff04b7f Update history to reflect merge of #5966 [ci skip] 2017-03-20 15:21:27 -04:00
jekyllbot
ac1369c22c Merge pull request #5966 from fulldecent/patch-1
Merge pull request 5966
2017-03-20 15:21:25 -04:00
William Entriken
f93453368a Prefer .yaml over .toml 2017-03-20 10:56:34 -04:00
Aleksander Kuś
ddc9931c20 added (buddyworks) to ci list
This can only be approved once https://github.com/jekyll/jekyll/pull/5962 has been merged.
2017-03-20 12:04:46 +01:00
Aleksander Kuś
9e55247dac fix in line 42 2017-03-20 11:59:25 +01:00
Aleksander Kuś
be7fc8a2c4 added extension + fixed line 15 2017-03-17 16:46:31 +01:00
Aleksander Kuś
336b488d70 Create buddyworks
Added description for configuring a Jekyll build using a free https://buddy.works project.
2017-03-17 16:18:52 +01:00
Ashwin Maroli
7b1841a78e Fix Appveyor with dst-aware cucumber steps 2017-03-17 17:40:03 +05:30
Pat Hawks
6bc9f71050 Rename test for clarity 2017-03-16 07:59:13 -05:00
Pat Hawks
ec5b45cd7c Allow colons in uri_escape filter
Fixes #5954
2017-03-16 07:54:13 -05:00
jekyllbot
0f0ac6f586 Update history to reflect merge of #5951 [ci skip] 2017-03-14 01:13:38 -04:00
jekyllbot
9e0971e867 Merge pull request #5951 from tomjohnson1492/patch-18
Merge pull request 5951
2017-03-14 01:13:36 -04:00
Tom Johnson
88ad56c9e0 Add link to order of interpretation tutorial in Tutorials nav
Added a link to the Order of interpretation tutorial into the Tutorials nav. This tutorial is published, just not linked.
2017-03-13 09:58:02 -07:00
Tom Johnson
99775e4b51 Fixed path in "Improve this page" link in Tutorials section
The path in the "Improve this page" link that is auto-generated in the Tutorials section had an incorrect parameter. This PR fixes it.
2017-03-13 09:55:27 -07:00
Lukasz Brodowski
cf65d2cd8e Corrected permalink
Fixed the permalink to navigation page since it was moved to under tutorials.
2017-03-12 14:55:47 -07:00
Lukasz Brodowski
4df6753109 Removed navigation paragraph
Removed the paragraph telling a user to visit the navigations page to learn how to build more robust navigation.

The permalink was broken since Navigation no longer exists and no other suitable substitute (closest being ./permalinks) fits the description.
2017-03-12 14:22:16 -07:00
jekyllbot
b87a4358ee Update history to reflect merge of #5947 [ci skip] 2017-03-12 06:02:06 -04:00
jekyllbot
9bf3279695 Merge pull request #5947 from ashmaroli/update-exclude-docs
Merge pull request 5947
2017-03-12 06:02:05 -04:00
Ashwin Maroli
6a7c49c5b8 update exclude array in configuration.md 2017-03-11 17:42:03 +05:30
Ashwin Maroli
06223e510e add a tutorial on serving custom Error 404 page 2017-03-11 17:32:53 +05:30
Parker Moore
633a426ce6 Merge pull request #5941 from jekyll/3.4.2.release.post
Add v3.4.2 release post
2017-03-09 16:12:45 -05:00
Parker Moore
754cd2f1b2 Don't be so "doomsdayesque" 2017-03-09 16:12:32 -05:00
Parker Moore
266d125550 Add v3.4.2 release post 2017-03-09 16:06:16 -05:00
Parker Moore
b3725e202e Fix typo in CONTRIBUTING doc. 2017-03-09 15:41:33 -05:00
Parker Moore
511481e626 Release 💎 3.4.2 2017-03-09 15:39:21 -05:00
Parker Moore
d7822aba33 Release 💎 3.4.2 2017-03-09 15:37:52 -05:00
jekyllbot
ea4a2fd57b Update history to reflect merge of #5903 [ci skip] 2017-03-06 21:05:06 -05:00
jekyllbot
4bf2090534 Merge pull request #5903 from ashmaroli/about-no-includes
Merge pull request 5903
2017-03-06 21:05:05 -05:00
jekyllbot
31a0aef594 Update history to reflect merge of #5925 [ci skip] 2017-03-06 21:00:53 -05:00
jekyllbot
44c35dc538 Merge pull request #5925 from jekyll/backport-pr
Merge pull request 5925
2017-03-06 21:00:52 -05:00
Parker Moore
67a7c22def Fix typo in backport-pr 2017-03-06 21:00:25 -05:00
jekyllbot
bfb6341339 Update history to reflect merge of #5926 [ci skip] 2017-03-06 20:59:58 -05:00
jekyllbot
c4f82f176d Merge pull request #5926 from jekyll/allow-releases-from-stable-branches
Merge pull request 5926
2017-03-06 20:59:57 -05:00
jekyllbot
085b5f56f3 Update history to reflect merge of #5934 [ci skip] 2017-03-06 20:58:53 -05:00
jekyllbot
9a740bc447 Merge pull request #5934 from ashmaroli/appease-classifier
Merge pull request 5934
2017-03-06 20:58:51 -05:00
jekyllbot
3e2875f39c Update history to reflect merge of #5820 [ci skip] 2017-03-06 20:58:05 -05:00
jekyllbot
8e439e673e Merge pull request #5820 from tomjohnson1492/patch-15
Merge pull request 5820
2017-03-06 20:58:04 -05:00
Ashwin Maroli
635e3365cc appease classifier-reborn 2017-03-04 23:29:04 +05:30
jekyllbot
ea91864af8 Update history to reflect merge of #5927 [ci skip] 2017-03-03 15:38:25 -05:00
jekyllbot
108b299702 Merge pull request #5927 from PedroLamas/patch-1
Merge pull request 5927
2017-03-03 15:38:23 -05:00
Parker Moore
834cb7aaef Merge pull request #5930 from jekyll/release-3-4-1
Release 3.4.1
2017-03-03 14:07:24 -05:00
Parker Moore
7b9e64af85 Release post for v3.4.1 2017-03-03 12:09:15 -05:00
Parker Moore
9b91b248ab Release 💎 3.4.1 2017-03-03 12:09:04 -05:00
Pedro Lamas
29ced37641 Navigation has been moved out from docs
Change introduced in a05e64c9d3 has broken the bottom navigation as the page no longer exists, so I removed it from docs.yml
2017-03-02 21:54:51 +00:00
Parker Moore
97375b38c7 Appveyor couldn't possibly support what it says it does in the docs.
https://ci.appveyor.com/project/jekyll/jekyll/build/1.0.1402
2017-03-02 12:59:34 -05:00
Parker Moore
fa9a80b15f You never really know what 'regexp support' means until you break it. 2017-03-02 12:56:20 -05:00
Parker Moore
1fbca40f0b appveyor: build *-stable branches. 2017-03-02 12:50:36 -05:00
Parker Moore
ac727f22a3 travis: build *-stable branches. 2017-03-02 12:49:54 -05:00
Parker Moore
e2cfd7cb4c rake/release: allow releases from *-stable branches. 2017-03-02 12:49:08 -05:00
Parker Moore
47f54dbeca Add script/backport-pr 2017-03-02 12:39:02 -05:00
jekyllbot
56dfe18c5d Update history to reflect merge of #5920 [ci skip] 2017-03-02 12:32:15 -05:00
jekyllbot
3d5cf99df5 Merge pull request #5920 from jekyll/allow-brief-post-dates
Merge pull request 5920
2017-03-02 12:32:13 -05:00
Parker Moore
3e4dbc83e3 Attempt to alleviate strange Windows encoding error.
Error:
TestGeneratedSite#test_: generated sites should render latest post's content. :
Encoding::CompatibilityError: incompatible character encodings: IBM437 and UTF-8
    C:/projects/jekyll/test/test_generated_site.rb:22:in `include?'
    C:/projects/jekyll/test/test_generated_site.rb:22:in `block (2 levels) in <class:TestGeneratedSite>'
    C:/projects/jekyll/test/test_generated_site.rb:34:in `instance_exec'
    C:/projects/jekyll/test/test_generated_site.rb:34:in `block in create_test_from_should_hash'
2017-03-01 22:36:25 -05:00
Parker Moore
ca87c99a3c Fix fmt issues in test for 'include a post with a abbreviated dates' 2017-03-01 22:08:21 -05:00
Parker Moore
4085e29f80 Document::DATE_FILENAME_MATCHER: allow abbreviated dates in post filenames 2017-03-01 21:39:23 -05:00
Parker Moore
8a0c0727ea Failing test: abbreviated post dates are no longer read.
This is a regression introduced by https://github.com/jekyll/jekyll/pull/5609.
2017-03-01 21:38:55 -05:00
jekyllbot
0300a7017b Update history to reflect merge of #5916 [ci skip] 2017-02-28 21:21:27 -05:00
jekyllbot
3551bf6d84 Merge pull request #5916 from jekylltools/master
Merge pull request 5916
2017-02-28 21:21:26 -05:00
jekylltools
f7d1a9c999 update plugin URL to reflect repo move 2017-02-28 17:32:40 -08:00
jekyllbot
05790460c1 Update history to reflect merge of #5698 [ci skip] 2017-02-28 14:04:53 -05:00
jekyllbot
eaa2124226 Merge pull request #5698 from tomjohnson1492/patch-12
Merge pull request 5698
2017-02-28 14:04:51 -05:00
Tom Johnson
0ecbf40d0e fixes from parkr's review. removed yellow style line. moved tutorials link from primary nav to Help page. removed .giignore change. 2017-02-28 10:15:20 -08:00
jekyllbot
31b8a2ba5c Update history to reflect merge of #5910 [ci skip] 2017-02-27 17:41:57 -05:00
jekyllbot
433a9f99a0 Merge pull request #5910 from infotexture/patch-1
Merge pull request 5910
2017-02-27 17:41:55 -05:00
Roger Sheen
b9c645d4c3 Fix typo in contribution information
Minor subject/verb agreement (use plural “pull request**s**” to agree with verb form)
2017-02-27 23:27:30 +01:00
jekyllbot
21106b5431 Update history to reflect merge of #5905 [ci skip] 2017-02-26 04:47:13 -05:00
jekyllbot
7122810b97 Merge pull request #5905 from Strangehill/patch-2
Merge pull request 5905
2017-02-26 04:47:11 -05:00
Antonio Argote
1f5612dd1b update broken links
where once there was a working url, there's now a broken redirect
2017-02-26 16:02:17 +08:00
Ashwin Maroli
90d7472388 Remove dependency on include from default about.md
This ensures better portability, allowing to switch and preview
themes without having to delete the code block.
2017-02-25 08:37:30 +05:30
jekyllbot
e52fa87665 Update history to reflect merge of #5900 [ci skip] 2017-02-23 03:36:34 -05:00
jekyllbot
71084aee3f Merge pull request #5900 from iBobik/patch-1
Merge pull request 5900
2017-02-23 03:36:32 -05:00
Jan Pobořil
4e913add3e Fixed tutorial for publishing gem to include repo.
gem build lists files by git, so it is needed to have them commited.
2017-02-22 22:58:48 +01:00
jekyllbot
2c75cb1ca7 Update history to reflect merge of #5891 [ci skip] 2017-02-19 11:29:53 -05:00
jekyllbot
4838e04038 Merge pull request #5891 from chunfeilung/patch-1
Merge pull request 5891
2017-02-19 11:29:52 -05:00
Chun Fei Lung
db229a85d7 Remove duplicate footnote_nr from default config
The configuration page lists the footnote_nr kramdown configuration option twice. That seemed a bit much, so I removed one of the two lines.
2017-02-18 17:14:15 +01:00
jekyllbot
6137dccfc0 Update history to reflect merge of #5887 [ci skip] 2017-02-17 04:19:18 -05:00
jekyllbot
8367d731f6 Merge pull request #5887 from philnash/uri-escape-docs-update
Merge pull request 5887
2017-02-17 04:19:17 -05:00
Phil Nash
42a65a57e6 Makes uri_escape template docs more specific.
I didn't know the difference between cgi_escape and uri_escape until it bit me when I had a colon in a title I used uri_escape on. Addressable::URI.encode (from addressable 2.4.0 and later) thought it was a URI and raised an error. I should have been using cgi_escape, which is for strings that will be added to URIs and not uri_escape, which is for encoding strings that are already in a URI.

This commit borrows from the addressable docs to make it more specific so that readers choose uri_escape when they already have a URI and cgi_escape when they are just escaping a plain string.
2017-02-17 02:16:37 +00:00
jekyllbot
c48b12ba9f Update history to reflect merge of #5882 [ci skip] 2017-02-14 02:34:16 -05:00
jekyllbot
8816a24f53 Merge pull request #5882 from felicianotech/posts-is-collection
Merge pull request 5882
2017-02-14 02:34:14 -05:00
jekyllbot
2dde1800a2 Update history to reflect merge of #5883 [ci skip] 2017-02-13 14:23:50 -05:00
jekyllbot
e9457a8e66 Merge pull request #5883 from ivanoats/fix-aerobatic-docs
Merge pull request 5883
2017-02-13 14:23:48 -05:00
Ivan Storck
50292be895 fix typo 2017-02-13 11:40:30 -05:00
Ivan Storck
b181eb2515 fix typo 2017-02-12 17:56:08 -05:00
Ivan Storck
b17c6c2914 update Aerobatic docs 2017-02-12 13:54:46 -05:00
jekyllbot
04ae82b849 Update history to reflect merge of #5878 [ci skip] 2017-02-12 09:21:32 -05:00
jekyllbot
cc7afc170b Merge pull request #5878 from jekyll/convertible-validate-permalink-emptiness-as-string
Merge pull request 5878
2017-02-12 09:21:31 -05:00
Ashwin Maroli
6123175a71 test with pygments 1.1 on all ruby versions 2017-02-11 13:58:23 +05:30
jekyllbot
7484c23ba4 Update history to reflect merge of #5880 [ci skip] 2017-02-11 00:21:20 -05:00
jekyllbot
8b3929b139 Merge pull request #5880 from BlueberryFoxtrot/patch-3
Merge pull request 5880
2017-02-11 00:21:19 -05:00
Ricardo N Feliciano
9ec7969c09 Add note to collections doc on hard-coded collections. 2017-02-11 00:09:16 -05:00
Frank Taillandier
48a94c4051 Merge branch 'master' into ruby-2.4.0 2017-02-11 05:36:23 +01:00
BlueberryFoxtrot
7414ab068a Update installation.md
It --> Jekyll.  
Avoids misreading that "it is possible to get [Windows] running on Windows."
2017-02-11 05:35:50 +01:00
Parker Moore
5bc67c1fb7 Convertible#validate_permalink!: ensure the return value of data["permalink"] is a string before asking if it is empty 2017-02-10 21:56:43 -05:00
jekyllbot
98e19c3cf5 Update history to reflect merge of #5834 [ci skip] 2017-02-10 21:16:58 -05:00
jekyllbot
2c1991fc16 Merge pull request #5834 from tomjohnson1492/patch-16
Merge pull request 5834
2017-02-10 21:16:57 -05:00
Parker Moore
23808c2ae6 Fix missing trailing comma to alleviate fmt errors
Offenses:

test/test_static_file.rb:151:9: C: [Corrected] Style/TrailingCommaInLiteral: Put a comma after the last item of a multiline hash.
        "collection"    => nil
        ^^^^^^^^^^^^^^^^^^^^^^
2017-02-10 21:16:25 -05:00
Parker Moore
ec234a4ef8 Bump Ruby 2.1 testing up to Ruby 2.1.10 2017-02-10 21:14:07 -05:00
jekyllbot
bcebf58cbd Update history to reflect merge of #5860 [ci skip] 2017-02-10 21:10:11 -05:00
jekyllbot
afe6e3622c Merge pull request #5860 from ashmaroli/exclude-patch
Merge pull request 5860
2017-02-10 21:10:09 -05:00
jekyllbot
7b58bcfc9e Update history to reflect merge of #5871 [ci skip] 2017-02-10 21:08:50 -05:00
jekyllbot
7ea53e0a3f Merge pull request #5871 from jekyll/static-file-drop
Merge pull request 5871
2017-02-10 21:08:49 -05:00
jekyllbot
bdf594317b Update history to reflect merge of #5876 [ci skip] 2017-02-10 14:26:16 -05:00
jekyllbot
5b7cc78912 Merge pull request #5876 from marcanuy/master
Merge pull request 5876
2017-02-10 14:26:15 -05:00
Marcelo Canina
1d44be5421 fix ial css classes in theme doc 2017-02-10 12:34:16 -03:00
Ben Balter
229769e249 add StaticFileDrop 2017-02-08 17:44:47 -05:00
Tom Johnson
755cc6c137 Fixes based on latest review
Mostly I added more detail in the Liquid section.
2017-02-05 20:55:16 -08:00
Ashwin Maroli
3745b24564 update comment for exclude array 2017-02-05 07:55:26 +05:30
Ashwin Maroli
eb36ea095f test overriding default excludes 2017-02-05 01:56:49 +05:30
Ashwin Maroli
2813b9c039 test exclusion of Gemfile 2017-02-05 01:49:38 +05:30
Ashwin Maroli
6316856773 comment out 'exclude:' in config file 2017-02-05 01:28:43 +05:30
Ashwin Maroli
4e40593a53 exclude Gemfile and its lockfile by default 2017-02-05 01:26:41 +05:30
jekyllbot
20d2eb2709 Update history to reflect merge of #5858 [ci skip] 2017-02-04 12:30:28 -05:00
jekyllbot
d41e5e1fc0 Merge pull request #5858 from desiredpersona/patch-1
Merge pull request 5858
2017-02-04 12:30:27 -05:00
Colin
7e45610379 Add the correct year to the 3.4.0 release date 2017-02-04 15:52:42 +00:00
Tom Johnson
4b325a65af updated based on review
I moved the section about liquid and yaml to the end and shortened it. i also clarified that isn't an order-of-interpretation issue why liquid doesn't render in yaml. I also fixed the type with HMTL.
2017-02-03 20:46:05 -08:00
jekyllbot
0c59ac3d29 Update history to reflect merge of #5837 [ci skip] 2017-01-31 10:12:47 -05:00
jekyllbot
4924f3ba90 Merge pull request #5837 from natebass/add-termux-troubleshooting
Merge pull request 5837
2017-01-31 10:12:46 -05:00
jekyllbot
1457359ce5 Update history to reflect merge of #5842 [ci skip] 2017-01-31 10:10:36 -05:00
jekyllbot
6f8c208cb2 Merge pull request #5842 from alfredmyers/patch-1
Merge pull request 5842
2017-01-31 10:10:34 -05:00
Alfred Myers
e0109633de Corrected date for version 3.4.0
Year should probably be 2017 instead of 2016
2017-01-31 13:05:26 -02:00
jekyllbot
78a4f20744 Update history to reflect merge of #5835 [ci skip] 2017-01-31 03:50:10 -05:00
jekyllbot
759f4b3d93 Merge pull request #5835 from ashmaroli/rubocop-patch
Merge pull request 5835
2017-01-31 03:50:09 -05:00
Nate
875486e8ae Add Termux section on troubleshooting 2017-01-30 22:13:05 -08:00
Ashwin Maroli
384be58b5e add missing comma 2017-01-31 08:40:06 +05:30
Tom Johnson
a7cba8a8a6 Made updates as suggested by reviewers 2017-01-30 11:45:24 -08:00
Tom Johnson
8bacf01c1b Add documentation about order of interpretation
This tutorial defines Jekyll's "order of interpretation," as @swizca called it in [#5808](https://github.com/jekyll/jekyll/pull/5698). This tutorial makes it clear how Jekyll processes files as it renders the static HTML output.

This order-of-interpretation info is important for troubleshooting and generally understanding Jekyll. It's important to know how Jekyll generates out the files, what rules it uses, what order it processes things, and so forth.

(Note: Please process 5698 before this request, because 5698 includes the tutorial collection/navigation that this tutorial fits into. I also need to update this commit to add a link in the Tutorials nav to this topic, but I'm waiting for 5698 to be merged so that menu becomes available.)

@jekyll/documentation
@dirtyf
2017-01-29 21:45:03 -08:00
Ashwin Maroli
3da459ef33 update rubygems version on travis 2017-01-28 22:15:34 +05:30
ashmaroli
a1d98bec82 Merge branch 'master' into ruby-2.4.0 2017-01-28 15:27:49 +05:30
jekyllbot
f1e13041b5 Merge pull request #5827 from DirtyF/filters-links
Merge pull request 5827
2017-01-27 15:25:33 -05:00
Frank Taillandier
f6dffecab7 fix broken links in release post 2017-01-27 20:51:56 +01:00
jekyllbot
966800fb1f Update history to reflect merge of #5817 [ci skip] 2017-01-27 11:37:05 -05:00
jekyllbot
1ff59026f1 Merge pull request #5817 from DirtyF/pull/installation
Merge pull request 5817
2017-01-27 11:37:03 -05:00
jekyllbot
c01b7e4a4a Update history to reflect merge of #4362 [ci skip] 2017-01-27 11:10:55 -05:00
jekyllbot
2cf685feb2 Merge pull request #4362 from jekyll/liquid-4
Merge pull request 4362
2017-01-27 11:10:53 -05:00
Tom Johnson
0a3916c07e Make links in sidebar for current page more prominent
When viewing a page, it's kind of hard to see what page you're viewing. The little triangle graphic pointing to the page is too subtle. Making the link to the current page orange (the same as the hover color) would make it visually more apparent where you are in the navigation. Here's a screenshot showing the change: [https://www.screencast.com/t/e6NKerSAUL](https://www.screencast.com/t/e6NKerSAUL). The link to the current page is orange even when I'm not hovering over the link with my mouse.
2017-01-25 10:06:57 -08:00
Tom Johnson
a6adfa8358 added cross-reference to the data files topic within the navigation topic 2017-01-25 09:49:36 -08:00
Tom Johnson
c7db12bad8 fixed link in datafiles.md to point to navigation.md location in new tutorials collection 2017-01-25 06:50:23 -08:00
Frank Taillandier
65a3891ca2 ought to -> should
props @pnn
2017-01-25 14:10:19 +01:00
Tom Johnson
2e9a32edd2 Added tutorials as a new collection, similar to Docs. Also added tutorial sidebar, tutorial link in primary nav, and tutorial overview page. 2017-01-24 22:58:04 -08:00
Tom Johnson
a05e64c9d3 moved navigation under new collection called tutorial 2017-01-24 15:38:17 -08:00
Frank Taillandier
7397f305c2 Add Ubuntu section on troubleshooting 2017-01-24 20:23:01 +01:00
Frank Taillandier
b1edaea7e8 Add a note about troubleshooting on installation page 2017-01-24 20:21:34 +01:00
Frank Taillandier
84e9ea82d1 Merge branch 'master' into patch-1 2017-01-19 18:12:05 +01:00
Parker Moore
2c19264d08 Add a philosophy doc. 2017-01-17 18:51:49 -05:00
Tom Johnson
6d9633e364 making edits from reviews 2017-01-12 23:28:56 -08:00
Tom Johnson
7efeb3d4af made updates as requested from latest review 2017-01-12 23:03:56 -08:00
BlueberryFoxtrot
335c8fcf62 Update installation.md
1. Addition of *Running Jekyll on Ubuntu* section, to address Ubuntu stumbling block as per https://github.com/jekyll/jekyll/issues/5719.
2. Restructuring, and I hope I understood correctly when NodeJS/Python are/aren't required.
3. Gentler wording – it's probably not a good idea to tell punters who hit this page because they ran into trouble that installing Jekyll *is* easy and straight-forward; it *ought to be* straight-forward. (There's always the potential for pain and confusion if not all dependencies are in place.)
2017-01-12 17:28:32 +01:00
Frank Taillandier
31178bfe69 Merge branch 'master' into liquid-4 2017-01-10 20:01:04 +01:00
Tom Johnson
5166ead2e0 Made updates with indentation 2017-01-04 10:14:41 -08:00
Tom Johnson
75c40edff8 Added link to new navigation page
This just links to the new page I added about navigation.
2017-01-02 17:30:37 +01:00
Tom Johnson
972dc8c2dd Include navigation page in doc list
Include the navigation page in the sidebar doc list.
2017-01-02 17:26:52 +01:00
Parker Moore
02056f7b15 Merge pull request #5679 from jekyll/liquid-4-utils
[liquid 4] Utils
2016-12-28 21:55:55 -08:00
Tom Johnson
845580a258 Documentation on how to build navigation
I added a documentation page on how to build navigation for your site. This topic is primarily intended for users who have a lot of pages on their site (such as for documentation websites), and want to build a more robust sidebar navigation.

Jekyll combines Liquid with YAML in interesting ways that aren't really documented clearly in the existing docs, except for a brief reference [here](http://jekyllrb.com/docs/datafiles/#the-data-folder). You can read about Liquid on Shopify and YAML in YAML's docs, but exactly how you store YAML files in a Jekyll project and iterate through them using Liquid loops and filters to generate lists of pages is something that isn't clear to a lot of people. (You can see origins of these questions in [previous help issues](https://github.com/jekyll/jekyll-help/issues/266).)  The documentation on navigation would fit well into the Jekyll docs.
2016-12-26 23:15:22 -08:00
Ashwin Maroli
e463813416 use compatible versions of gems
- json: "~> 2.0"
    # https://github.com/flori/json/issues/303#issuecomment-259426660

  - pygments.rb: "~> 1.1"
2016-12-25 11:48:06 +05:30
Ashwin Maroli
2133397412 test against ruby-2.4.0 2016-12-25 10:08:49 +05:30
Pat Hawks
72a56d9eb7 Check for to_time 2016-12-22 19:18:43 -06:00
Pat Hawks
f7edcceb70 Check return value of to_date 2016-12-22 16:15:09 -06:00
Pat Hawks
2eb8469936 Never throw on sample 2016-12-22 15:48:03 -06:00
Pat Hawks
607ab66707 Use Liquid's own to_integer 2016-12-22 15:32:55 -06:00
Pat Hawks
c42eb7fc3a Take advantage of Liquid::Utils.to_date 2016-12-22 15:32:45 -06:00
Parker Moore
7862f731b6 grouping filters: use Liquid::ParseContext to create variable. 2016-12-16 15:38:19 -08:00
Parker Moore
793405c00c Liquid v4 has been released. 2016-12-16 15:37:22 -08:00
Florian Thomas
dde0441b3a find keys also in assigned collections 2016-12-16 15:37:10 -08:00
Florian Thomas
dbea1ca80b parse expressions before passing it to Liquid::Condition 2016-12-16 15:37:04 -08:00
Parker Moore
191f5e5fd8 Update to Liquid 4.0.0.rc3 2016-12-16 15:36:59 -08:00
Parker Moore
db8356b065 Liquid 4.0 rc2 2016-12-16 15:36:53 -08:00
Parker Moore
d24ea03acf Update highlight block test to conform with v4 API. 2016-12-16 15:36:48 -08:00
Parker Moore
b6120edeae Try out Liquid v4.0.0.rc1 2016-12-16 15:36:42 -08:00
484 changed files with 20801 additions and 9910 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
@@ -28,7 +25,7 @@ Whether you're a developer, a designer, or just a Jekyll devotee, there are lots
* The more information, the better. Make judicious use of the pull request body. Describe what changes were made, why you made them, and what impact they will have for users.
* Pull request are easy and fun. If this is your first pull request, it may help to [understand GitHub Flow](https://guides.github.com/introduction/flow/).
* If this is your first pull request, it may help to [understand GitHub Flow](https://guides.github.com/introduction/flow/).
* If you're submitting a code contribution, be sure to read the [code contributions](#code-contributions) section below.
@@ -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

@@ -1,82 +0,0 @@
<!--
Hi! Thanks for considering to file a bug with Jekyll. Please take the time to
answer the basic questions. You can convert `[ ]` into `[x]` to check boxes (or submit
and check.) If there is no need for certain fields like output and redirection, please delete
those headers before submitting. We know not all tickets require those steps.
Otherwise, please try to be as detailed as possible.
If you are unsure this is a bug in Jekyll, or this is a bug caused
by a plugin that isn't directly related to Jekyll, or if this is just
a generic usage question, please consider asking your question at
https://talk.jekyllrb.com where non-bug questions go.
Please make sure to mention an affinity team whose responsibilities
most closely align with your issue.
Thanks!
-->
- [ ] I believe this to be a bug, not a question about using Jekyll.
- [ ] I updated to the latest Jekyll (or) if on GitHub Pages to the latest `github-pages`
- [ ] I read the CONTRIBUTION file at https://jekyllrb.com/docs/contributing/
- [ ] This is a feature request.
---
- [ ] I am on (or have tested on) ***macOS*** 10+
- [ ] I am on (or have tested on) ***Debian/Ubuntu*** GNU/Linux
- [ ] I am on (or have tested on) ***Fedora*** GNU/Linux
- [ ] I am on (or have tested on) ***Arch*** GNU/Linux
- [ ] I am on (or have tested on) ***Other*** GNU/Linux
- [ ] I am on (or have tested on) ***Windows*** 10+
<!--
Other GNU/Linux includes Scientific GNU/Linux, CentOS GNU/Linux, and others.
If you are on a minor sub-distro (such as ElementaryOS which does not diverge from
Ubuntu much, please check the parent distro. Kubuntu, Edubuntu, Lubuntu should
also be flagged as Ubuntu as their packages come from upstream Ubuntu.
-->
---
- [ ] I was trying to install.
- [ ] There is a broken Plugin API.
- [ ] I had an error on GitHub Pages, and I have reproduced it locally.
- [ ] I had an error on GitHub Pages, and GitHub Support said it was a Jekyll Bug.
- [ ] I had an error on GitHub Pages and I did not test it locally.
- [ ] I was trying to build.
- [ ] It was another bug.
## My Reproduction Steps
<!--
If this error occured on GitHub Pages, please try to provide us with logs,
and look at them yourself, to determine if this is an actual Jekyll bug. In
the event you are unsure, file a ticket, however, when you do please provide
the logs (strip them of personal information.)
If you have trouble finding your logs, please email support@github.com and
they will happily help you. If you cannot find logs, please try your best to
replicate it locally because we cannot fix a problem if we do not know
exactly what caused it, or within a relatively close distance.
-->
<!--
Insert the steps you took to for this problem to exist. Such as the
directories you created and, the full command you ran, and include any
plugins you have installed, this is very important.
If your steps are complicated, you can also submit a GitHub
repository (please no zips, they will be removed and rejected by maintainers,)
and just supply a command for us to reproduce it ourselves.
-->
## The Output I Wanted
<!--
Insert the output from the command. Alter it as little as you can.
The minimum should be personal information. Though we normally don't log
anything like that so there should be no need to alter it.
-->
/cc include any Jekyll affinity teams here (see https://teams.jekyllrb.com/ for more info)

67
.github/ISSUE_TEMPLATE/bug_report.md vendored Normal file
View File

@@ -0,0 +1,67 @@
---
name: Bug Report
about: Is something not working as expected?
---
<!--
Hi! Thanks for considering to file a bug with Jekyll. Please take the time to
answer the basic questions. Please try to be as detailed as possible.
If you are unsure this is a bug in Jekyll, or this is a bug caused
by a plugin that isn't directly related to Jekyll, or if this is just
a generic usage question, please consider asking your question at
https://talk.jekyllrb.com where non-bug questions go.
Thanks!
-->
<!--
Make sure that you've done all of these. If you're sure that the bug you're
reporting is only apparent in a previous version of Jekyll, please say so explicitly
in your description.
- I updated to the latest Jekyll (or) if on GitHub Pages to the latest `github-pages`
- I ran `jekyll doctor` to check my configuration
- I read the contributing document at https://jekyllrb.com/docs/contributing/
-->
## My Environment
<!--
Replace the values in the Version(s) column with the ones in your build. If you're not
using `github-pages`, just replace it with "No".
-->
| Software | Version(s) |
| ---------------- | ---------- |
| Operating System | |
| `jekyll` | Latest |
| `github-pages` | Latest |
---
## Expected Behaviour
<!--
What is it you expected to happen? This should be a description of how the
functionality you tried to use is supposed to work.
-->
## Current Behavior
<!--
Describe the details of the bug. Be sure to include any steps you took for the
problem to exist, such as the directories you created and the full command
you ran. Include any plugins you have installed (this is very important!).
You can include any logs you think relevant here. If you're using GitHub pages
and you're not sure where your logs are, please email support@github.com and
they will happily help you.
-->
## Code Sample
<!--
Please provide a code repository, gist, code snippet or sample files to
reproduce the issue.
-->

20
.github/ISSUE_TEMPLATE/documentation.md vendored Normal file
View File

@@ -0,0 +1,20 @@
---
name: Documentation
about: Found a typo or something that isn't crystal clear in our docs?
---
<!-- Thanks for taking the time to open an issue and help us make Jekyll better! -->
## Motivation
<!-- Why should we update our docs? -->
## Suggestion
<!-- What should we do instead? -->
<!-- Thanks for taking the time to open an issue and help us make Jekyll better! -->

View File

@@ -0,0 +1,69 @@
---
name: Feature Request
about: Want us to add any features to Jekyll?
---
<!--
Hi! Thanks for considering to file a feature request with Jekyll. Please take the time to
answer the basic questions. Please try to be as detailed as possible.
Thanks!
-->
## Summary
<!--
A one-paragraph explanation of the feature.
-->
## Motivation
<!--
Why do you want to see this feature in Jekyll? What makes you sure that it should not be
implemented at the plugin level, but in Jekyll core? What use cases does it support?
NOTE: Please be mindful of the Jekyll philosophy (https://jekyllrb.com/philosophy/),
particularily Section 5. Think about if 90% of the users would benefit from your
feature request, and whether your feature would be better off in a plugin.
-->
## Guide-level explanation
<!--
Explain the proposal as if it was already included in the project and you
were teaching it to another programmer. That generally means:
- Introducing new named concepts.
- Explaining the feature largely in terms of examples.
- If applicable, provide sample error messages, deprecation warnings, or
migration guidance.
If this is a small feature, you may omit this section.
-->
## Reference-level explanation
<!--
This is the technical portion of the feature request. Explain the design in
sufficient detail that:
- Its interaction with other features is clear.
- It is reasonably clear how the feature would be implemented.
- Corner cases are dissected by example.
If you do not know how to answer this, you can omit it. No worries!
-->
## Drawbacks
<!--
Why should we *not* do this?
-->
## Unresolved Questions
<!--
What related issues do you consider out of scope for this feature that could be
addressed in the future independently of the solution that comes out of this
feature?
-->

11
.github/ISSUE_TEMPLATE/question.md vendored Normal file
View File

@@ -0,0 +1,11 @@
---
name: Question
about: Have any questions about how Jekyll works?
---
<!--
The Jekyll issue tracker IS NOT for usage questions! Please post your
question on our dedicated forum at https://talk.jekyllrb.com.
Thank you!
-->

43
.github/PULL_REQUEST_TEMPLATE.md vendored Normal file
View File

@@ -0,0 +1,43 @@
<!--
Thanks for creating a Pull Request! Before you submit, please make sure
you've done the following:
- I read the contributing document at https://jekyllrb.com/docs/contributing/
-->
<!--
Make our lives easier! Choose one of the following by uncommenting it:
-->
<!-- This is a 🐛 bug fix. -->
<!-- This is a 🙋 feature or enhancement. -->
<!-- This is a 🔦 documentation change. -->
<!--
Before you submit this pull request, make sure to have a look at the following
checklist. If you don't know how to do some of these, that's fine! Submit
your pull request and we will help you out on the way.
- I've added tests (if it's a bug, feature or enhancement)
- I've adjusted the documentation (if it's a feature or enhancement)
- The test suite passes (run `script/cibuild` to verify this)
-->
## Summary
<!--
Provide a description of what your pull request changes.
-->
## Context
<!--
Is this related to any GitHub issue(s)?
-->
## Semver Changes
<!--
Which semantic version change would you recommend?
If you don't know, feel free to omit it.
-->

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

30
.gitignore vendored
View File

@@ -1,23 +1,29 @@
*.gem
*.swp
*~
.DS_Store
.analysis
# Jekyll
_site/
.jekyll-cache
.jekyll-metadata
.sass-cache
# Ruby
.bundle/
.byebug_history
.jekyll-metadata
.ruby-gemset
.ruby-version
.sass-cache
/test/source/file_name.txt
/vendor
*.gem
Gemfile.lock
_site/
bin/
# Files
.analysis
.DS_Store
*.swp
*~
# Folders
/vendor
bbin/
bin/
coverage
gh-pages/
pkg/
site/_site/
test/dest
tmp/*

View File

@@ -1,21 +1,48 @@
---
require:
- ./rubocop/jekyll
Jekyll/NoPutsAllowed:
Exclude:
- rake/*.rake
AllCops:
TargetRubyVersion: 2.0
TargetRubyVersion: 2.3
Include:
- lib/**/*.rb
- test/**/*.rb
Exclude:
- lib/jekyll/renderer.rb
- bin/**/*
- exe/**/*
- benchmark/**/*
- script/**/*
- vendor/**/*
Lint/EndAlignment:
- tmp/**/*
Layout/AlignHash:
EnforcedHashRocketStyle: table
Layout/IndentationWidth:
Severity: error
Layout/IndentArray:
EnforcedStyle: consistent
Layout/IndentHash:
EnforcedStyle: consistent
Layout/MultilineMethodCallIndentation:
EnforcedStyle: indented
Layout/MultilineOperationIndentation:
EnforcedStyle: indented
Lint/NestedPercentLiteral:
Exclude:
- test/test_site.rb
Layout/EmptyComment:
Enabled: false
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:
@@ -23,20 +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
Max: 90
- Gemfile
Max: 100
Severity: warning
Metrics/MethodLength:
CountComments: false
@@ -48,6 +81,20 @@ Metrics/ParameterLists:
Max: 4
Metrics/PerceivedComplexity:
Max: 8
Naming/FileName:
Enabled: false
Naming/HeredocDelimiterNaming:
Exclude:
- test/**/*.rb
Naming/MemoizedInstanceVariableName:
Exclude:
- lib/jekyll/convertible.rb
- lib/jekyll/drops/site_drop.rb
- lib/jekyll/drops/unified_payload_drop.rb
- lib/jekyll/page_without_a_file.rb
Naming/UncommunicativeMethodParamName:
AllowedNames:
- _
Security/MarshalLoad:
Exclude:
- !ruby/regexp /test\/.*.rb$/
@@ -56,58 +103,34 @@ Security/YAMLLoad:
Exclude:
- !ruby/regexp /features\/.*.rb/
- !ruby/regexp /test\/.*.rb$/
Style/AccessModifierDeclarations:
Enabled: false
Style/Alias:
Enabled: false
Style/AlignArray:
Enabled: false
Style/AlignHash:
EnforcedHashRocketStyle: table
Style/AlignParameters:
Enabled: false
EnforcedStyle: with_fixed_indentation
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/EmptyLinesAroundAccessModifier:
Enabled: false
Style/EmptyLinesAroundModuleBody:
Enabled: false
Style/ExtraSpacing:
AllowForAlignment: true
Style/FileName:
Enabled: false
Style/FirstParameterIndentation:
EnforcedStyle: consistent
Style/FormatStringToken:
Exclude:
- lib/jekyll/utils/ansi.rb
Style/GuardClause:
Enabled: false
Style/HashSyntax:
EnforcedStyle: hash_rockets
Severity: error
Style/IfUnlessModifier:
Enabled: false
Style/IndentArray:
EnforcedStyle: consistent
Style/IndentHash:
EnforcedStyle: consistent
Style/IndentationWidth:
Severity: error
Style/MixinUsage:
Exclude:
- test/helper.rb
Style/ModuleFunction:
Enabled: false
Style/MultilineMethodCallIndentation:
EnforcedStyle: indented
Style/MultilineOperationIndentation:
EnforcedStyle: indented
Style/MultilineTernaryOperator:
Severity: error
Style/PercentLiteralDelimiters:
@@ -119,27 +142,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/SpaceAroundOperators:
Enabled: false
Style/SpaceInsideBrackets:
Enabled: false
Style/StringLiterals:
EnforcedStyle: double_quotes
Style/StringLiteralsInInterpolation:
EnforcedStyle: double_quotes
Style/TrailingCommaInLiteral:
Style/SymbolArray:
EnforcedStyle: brackets
Style/TrailingCommaInArrayLiteral:
EnforcedStyleForMultiline: consistent_comma
Style/TrailingCommaInHashLiteral:
EnforcedStyleForMultiline: consistent_comma
Style/UnneededCapitalW:
Enabled: false

View File

@@ -5,17 +5,19 @@ language: ruby
sudo: false
rvm:
- &ruby1 2.3.3
- &ruby2 2.2.6
- &ruby3 2.1.9
- &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
name: "🏠️ Default Site"
exclude:
- rvm: *jruby
env: TEST_SUITE=cucumber
@@ -28,6 +30,8 @@ branches:
only:
- master
- themes
- /^.*-stable/
- /.*backport.*/
notifications:
slack:
@@ -48,3 +52,7 @@ addons:
# regular test configuration
after_success:
- bundle exec codeclimate-test-reporter
before_install:
- gem update --system
- gem install bundler

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

View File

@@ -1,49 +0,0 @@
# Code of Conduct
As contributors and maintainers of this project, and in the interest of
fostering an open and welcoming community, we pledge to respect all people who
contribute through reporting issues, posting feature requests, updating
documentation, submitting pull requests or patches, and other activities.
We are committed to making participation in this project a harassment-free
experience for everyone, regardless of level of experience, gender, gender
identity and expression, sexual orientation, disability, personal appearance,
body size, race, ethnicity, age, religion, or nationality.
Examples of unacceptable behavior by participants include:
* The use of sexualized language or imagery
* Personal attacks
* Trolling or insulting/derogatory comments
* Public or private harassment
* Publishing other's private information, such as physical or electronic
addresses, without explicit permission
* Other unethical or unprofessional conduct
Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.
By adopting this Code of Conduct, project maintainers commit themselves to
fairly and consistently applying these principles to every aspect of managing
this project. Project maintainers who do not follow or enforce the Code of
Conduct may be permanently removed from the project team.
This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community.
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by opening an issue or contacting a project maintainer. All complaints
will be reviewed and investigated and will result in a response that is deemed
necessary and appropriate to the circumstances. Maintainers are obligated to
maintain confidentiality with regard to the reporter of an incident.
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 1.3.0, available at
[http://contributor-covenant.org/version/1/3/0/][version]
[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/3/0/

32
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,16 @@ end
group :test do
gem "codeclimate-test-reporter", "~> 1.0.5"
gem "cucumber", "~> 2.1"
gem "cucumber", "~> 3.0"
gem "httpclient"
gem "jekyll_test_plugin"
gem "jekyll_test_plugin_malicious"
gem "nokogiri"
gem "nokogiri", "~> 1.7"
gem "rspec"
gem "rspec-mocks"
gem "rubocop", "~> 0.47"
gem "test-theme", :path => File.expand_path("./test/fixtures/test-theme", File.dirname(__FILE__))
gem "rubocop", "~> 0.60.0"
gem "test-dependency-theme", :path => File.expand_path("test/fixtures/test-dependency-theme", __dir__)
gem "test-theme", :path => File.expand_path("test/fixtures/test-theme", __dir__)
gem "jruby-openssl" if RUBY_ENGINE == "jruby"
end
@@ -34,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
@@ -63,21 +63,19 @@ group :jekyll_optional_dependencies do
gem "coderay", "~> 1.1.0"
gem "jekyll-coffeescript"
gem "jekyll-docs", :path => "../docs" if Dir.exist?("../docs") && ENV["JEKYLL_VERSION"]
gem "jekyll-feed"
gem "jekyll-feed", "~> 0.9"
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.4"
end
# Windows does not include zoneinfo files, so bundle the tzinfo-data gem

View File

@@ -1,4 +1,780 @@
## 3.4.0 / 2016-01-27
## HEAD
* Textile is only supported through a converter plugin (#7003)
* Add info how to deploy using pre-push git hook (#7179)
* chore(release): reflect latest patched releases (#7262)
### 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)
* Corrected sample usage of postfiles (#7181)
* Add missing html end tag for code example in section &#39;For loops&#39; (#7199)
* Resolve &#34;Unable to locate package ruby2.4&#34; error (#7196)
* installation instructions for Fedora (#7198)
* New docs (#7205)
* Correct stylesheet url in tutorial step 7 (#7210)
* Add some minor improvements to image loading in Showcase page (#7214)
* Fix minor grammatical error (#7215)
* Add developer.spotify.com to the Jekyll Showcase (#7217)
* removes quotes from markdown for assets (#7223)
* clarified front matter requirement (#7234)
* Minor whitespace fixes (#7238)
* explicit location of where to create blog.html (#7241)
* Fix a small grammar error/typo in the docs (#7260)
* environments.md: reference the build command options that allows multiple config files (#7266)
* Update 10-deployment.md (#7268)
* Add more issue template(s) and pull request template (#7269)
* Suggest sites use OpenSSL instead of GnuTLS for their site&#39;s CI (#7010)
* Fix broken Contributors link in README.markdown (#7200)
* Docs: Add title tag to item in RSS template (#7282)
* Docs: more inclusive writing (#7283)
* Document converter methods (#7289)
* Docs: Add link tag to item in RSS template (#7291)
* Add Isomer to showcase (#7300)
* Added missing semicolon (#7306)
* &#34;This restricts you...&#34; to &#34;This restricts your&#34; (#7307)
* Add a link to Giraffe Academy&#39;s tutorial (#7325)
* grammar correction (#7327)
* docs: list all standard liquid filters (#7333)
* Document Jekyll Filters with YAML data (#7335)
* Remove redundant instruction comment (#7342)
* docs: minimize rendering count (#7343)
### 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)
* Add support for `*.xhtml` files (#6854)
* Cache matched defaults sets for given parameters (#6888)
* Ignore permission error of /proc/version (#7267)
* Strip extra slashes via `Jekyll.sanitized_path` (#7182)
* Site template: remove default config for markdown (#7285)
* Cache: Do not dump undumpable objects (#7190)
* Optimize rendering Liquid templates (#7136)
* Automatically load _config.toml (#7299)
* feat: enhance --blank scaffolding (#7310)
* Skip processing posts that can not be read (#7302)
* Memoize Site#post_attr_hash (#7276)
* Load config file from within current theme-gem (#7304)
* Memoize the return value of Site#documents (#7273)
### 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)
* Drop support for pygments as syntax-highlighter (#7118)
* Add Cache class (#7169)
* Cache converted markdown (#7159)
* Ignore cache directory (#7184)
* Incorporate `relative_url` filter in `link` tag (#6727)
### Development Fixes
* Remove unnecessary Jekyll::Page constant (#6770)
* Loggers should accept both numbers and symbols (#6967)
* Update instructions for releasing docs Gem (#6975)
* yajl-ruby update to v1.4.0 (#6976)
* 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)
* Replace regex arg to :gsub with a string arg (#7189)
* Interpolate Jekyll::Page subclass on inspection (#7203)
* Small benchmark refactoring (#7211)
* Add cucumber feature to test include_relative tag (#7213)
* Bump Rubocop to v0.59.0 (#7237)
* update yajl-ruby (#7278)
* Drop support for `jekyll-watch-1.4.0` and older (#7287)
* CI(Appveyor): shallow clone with 5 last commits (#7312)
* Bump RuboCop to v0.60.x (#7338)
### Bug Fixes
* Add call to unused method `validate_options` in `commands/serve.rb` (#7122)
* Security: fix `include` bypass of `EntryFilter#filter` symlink check (#7226)
* Check if scope applies to type before given path (#7263)
* Document two methods, simplify one of the methods (#7270)
* Check key in collections only if it isn&#39;t &#34;posts&#34; (#7277)
* Revert &#34;Cache converter in renderer&#34; (#7326)
* Measure the no. of times a template gets rendered (#7316)
* Re-implement handling Liquid blocks in excerpts (#7250)
### feature
* Disable Liquid via front matter (#6824)
* Do not process Liquid in post excerpt when disabled in front matter (#7146)
### Site Enhancements
* Add Release Post for v3.6.3, v3.7.4 and v3.8.4 (#7259)
## 3.8.5 / 2018-11-04
### Bug Fixes
* Re-implement handling Liquid blocks in excerpts (#7250)
## 3.8.4 / 2018-09-18
### Bug Fixes
* 3.8.x: security: fix `include` bypass of `EntryFilter#filter` symlink check (#7228)
## 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.4 / 2018-09-07
### Bug Fixes
* Security: fix `include` bypass of EntryFilter#filter symlink check (#7224)
## 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.3 / 2018-09-18
### Bug Fixes
* 3.6.x: security: fix `include` bypass of `EntryFilter#filter` symlink check (#7229)
## 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
* Ignore final newline in folded YAML string (#6054)
* Add URL checks to Doctor (#5760)
* Fix serving files that clash with directories (#6222) (#6231)
* Bump supported Ruby version to `>= 2.1.0` (#6220)
* set `LiquidError#template_name` for errors in included file (#6206)
* Access custom config array throughout session (#6200)
* Add support for Rouge 2, in addition to Rouge 1 (#5919)
* Allow `yield` to logger methods &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)
* 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 front matter (#6334)
* Docs: `site.url` behavior on development and production environments (#6270)
* Fix typo in site.url section of variables.md :-[ (#6337)
* Docs: updates (#6343)
* Fix precedence docs (#6346)
* add note to contributing docs about `script/console` (#6349)
* Docs: Fix permalink example (#6375)
### Site Enhancements
* Adding DevKit helpers (#6225)
* Customizing url in collection elements clarified (#6264)
* Plugins is the new gems (#6326)
### Development Fixes
* Strip unnecessary leading whitespace in template (#6228)
* Users should be installing patch versions. (#6198)
* Fix tests (#6240)
* Define path with `__dir__` (#6087)
* exit site.process sooner (#6239)
* make flakey test more robust (#6277)
* Add a quick test for DataReader (#6284)
* script/backport-pr: commit message no longer includes the `#` (#6289)
* Add Add CODEOWNERS file to help automate reviews. (#6320)
* Fix builds on codeclimate (#6333)
* Bump rubies on Travis (#6366)
## 3.5.2 / 2017-08-12
### Bug Fixes
* Backport #6281 for v3.5.x: Fix `Drop#key?` so it can handle a nil argument (#6288)
* Backport #6280 for v3.5.x: Guard against type error in `absolute_url` (#6287)
* Backport #6266 for v3.5.x: Memoize the return value of `Document#url` (#6301)
* Backport #6273 for v3.5.x: delegate `StaticFile#to_json` to `StaticFile#to_liquid` (#6302)
* Backport #6226 for v3.5.x: `Reader#read_directories`: guard against an entry not being a directory (#6304)
* Backport #6247 for v3.5.x: kramdown: symbolize keys in-place (#6303)
## 3.5.1 / 2017-07-17
### Minor Enhancements
* Use Warn for deprecation messages (#6192)
* site template: Use plugins key instead of gems (#6045)
### Bug Fixes
* Backward compatiblize URLFilters module (#6163)
* Static files contain front matter default keys when `to_liquid`'d (#6162)
* Always normalize the result of the `relative_url` filter (#6185)
### Documentation
* Update reference to trouble with OS X/macOS (#6139)
* added BibSonomy plugin (#6143)
* add plugins for multiple page pagination (#6055)
* Update minimum Ruby version in installation.md (#6164)
* Add information about finding a collection in `site.collections` (#6165)
* Add `{% raw %}` to Liquid example on site (#6179)
* Added improved Pug plugin - removed 404 Jade plugin (#6174)
* Linking the link (#6210)
* Small correction in documentation for includes (#6193)
* Fix docs site page margin (#6214)
### Development Fixes
* Add jekyll doctor to GitHub Issue Template (#6169)
* Test with Ruby 2.4.1-1 on AppVeyor (#6176)
* set minimum requirement for jekyll-feed (#6184)
## 3.5.0 / 2017-06-18
### Minor Enhancements
* Upgrade to Liquid v4 (#4362)
* Convert StaticFile liquid representation to a Drop & add front matter defaults support to StaticFiles (#5871)
* Add support for Tab-Separated Values data files (`*.tsv`) (#5985)
* Specify version constraint in subcommand error message. (#5974)
* Add a template for custom 404 page (#5945)
* Require `runtime_dependencies` of a Gem-based theme from its `.gemspec` file (#5914)
* Don't raise an error if URL contains a colon (#5889)
* Date filters should never raise an exception (#5722)
* add `plugins` config key as replacement for `gems` (#5130)
* create configuration from options only once in the boot process (#5487)
* Add option to fail a build with front matter syntax errors (#5832)
* Disable default layouts for documents with a `layout: none` declaration (#5933)
* In `jekyll new`, make copied site template user-writable (#6072)
* Add top-level `layout` liquid variable to Documents (#6073)
* Address reading non-binary static files in themes (#5918)
* Allow filters to sort & select based on subvalues (#5622)
* Add strip_index filter (#6075)
### Documentation
* Install troubleshooting on Ubuntu (#5817)
* Add Termux section on troubleshooting (#5837)
* fix ial css classes in theme doc (#5876)
* Update installation.md (#5880)
* Update Aerobatic docs (#5883)
* Add note to collections doc on hard-coded collections. (#5882)
* Makes uri_escape template docs more specific. (#5887)
* Remove duplicate footnote_nr from default config (#5891)
* Fixed tutorial for publishing gem to include repo. (#5900)
* update broken links (#5905)
* Fix typo in contribution information (#5910)
* update plugin repo URL to reflect repo move (#5916)
* Update exclude array in configuration.md (#5947)
* Fixed path in "Improve this page" link in Tutorials section (#5951)
* Corrected permalink (#5949)
* Included more details about adding defaults to static files (#5971)
* Create buddyworks (#5962)
* added (buddyworks) to ci list (#5965)
* Add a tutorial on serving custom Error 404 page (#5946)
* add custom 404 to tutorial navigation (#5978)
* Add link to order of interpretation tutorial in Tutorials nav (#5952)
* Document Jekyll's Philosophy (#5792)
* Require Ruby > 2.1.0 (#5983)
* Fix broken link (#5994)
* Default options for script/proof (#5995)
* Mention Bash on Ubuntu on Windows (#5960)
* Document `--unpublished` flag introduced in 91e9ecf (#5959)
* Update upgrading.md to mention usage of `bundle update` (#5604)
* Fix missing quotation mark (#6002)
* New tutorial: Convert an HTML site to Jekyll (#5881)
* Revamp Permalink section (#5912)
* Fixup tutorial on creating theme from existing HTML templates (#6006)
* Standardise on "URLs" without apostrophe in docs (#6018)
* Added txtpen in tutorial (#6021)
* fix typo using past participle (#6026)
* changed formatting to fit the style of the documentation (#6027)
* doc fix typo word usage (#6028)
* corrected reference to layout in index.md (#6032)
* (Minor) Update MathJax CDN (#6013)
* Add MvvmCross to samples (#6035)
* Update travis-ci.md to correct procedure (#6043)
* fix sentence in documentation (#6048)
* rephrase a sentence in posts.md to be more direct (#6049)
* Compress Website Sass output (#6009)
* doc correct spelling error (#6050)
* adjusted date-format in sitemap (#6053)
* Typo fix (welcomed change -> welcome change). (#6070)
* Fixed documentation inconsistency (#6068)
* Add own plugin -> Jekyll Brand Social Wall (#6064)
* Added plugin jekyll-analytics (#6042)
* Use more precise language when explaining links (#6078)
* Update plugins.md (#6088)
* windows 10 tutorial (#6100)
* Explain how to override theme styles (#6107)
* updated Bash on Ubuntu on Windows link in tutorial (#6111)
* Fix wording in `_docs/templates.md` links section (#6114)
* Update windows.md (#6115)
* Added windows to docs.yml (#6109)
* Be more specific on what to upload (#6119)
* Remove Blank Newlines from "Jekyll on Windows" Page (#6126)
* Link the troubleshooting page in the quickstart page (#6134)
* add documentation about the &#34;pinned&#34; label (#6147)
* docs(JekyllOnWindows): Add a new Installation way (#6141)
* corrected windows.md (#6149)
* Refine documentation for Windows (#6153)
### Development Fixes
* Rubocop: add missing comma (#5835)
* Appease classifier-reborn (#5934)
* Allow releases & development on `*-stable` branches (#5926)
* Add script/backport-pr (#5925)
* Prefer .yaml over .toml (#5966)
* Fix Appveyor with DST-aware cucumber steps (#5961)
* Use Rubocop v0.47.1 till we're ready for v0.48 (#5989)
* Test against Ruby 2.4.0 (#5687)
* rubocop: lib/jekyll/renderer.rb complexity fixes (#5052)
* Use yajl-ruby 1.2.2 (now with 2.4 support) (#6007)
* Bump Rubocop to v0.48 (#5997)
* doc use example.com (#6031)
* fix typo (#6040)
* Fix CI (#6044)
* Remove `ruby RUBY_VERSION` from generated Gemfile (#5803)
* Test if hidden collections output a document with a future date (#6103)
* Add test for uri_escape on reserved characters (#6086)
* Allow you to specify the rouge version via an environment variable for testing (#6138)
* Bump Rubocop to 0.49.1 (#6093)
* Lock nokogiri to 1.7.x for Ruby 2.1 (#6140)
### Site Enhancements
* Corrected date for version 3.4.0 (#5842)
* Add the correct year to the 3.4.0 release date (#5858)
* Add documentation about order of interpretation (#5834)
* Documentation on how to build navigation (#5698)
* Navigation has been moved out from docs (#5927)
* Make links in sidebar for current page more prominent (#5820)
* Update normalize.css to v6.0.0 (#6008)
* Docs: rename `gems` to `plugins` (#6082)
* plugins -> gems (#6110)
* Document difference between cgi_escape and uri_escape #5970 (#6081)
### 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)
* Allow abbreviated post dates (#5920)
* Remove dependency on include from default about.md (#5903)
* Allow colons in `uri_escape` filter (#5957)
* Re-surface missing public methods in `Jekyll::Document` (#5975)
* absolute_url should not mangle URL if called more than once (#5789)
* patch URLFilters to prevent `//` (#6058)
* add test to ensure variables work in `where_exp` condition (#5315)
* Read explicitly included dot-files in collections. (#6092)
* Default `baseurl` to `nil` instead of empty string (#6137)
* Filters#time helper: Duplicate time before calling #localtime. (#5996)
## 3.4.5 / 2017-06-30
* Backport #6185 for v3.4.x: Always normalize the result of the `relative_url` filter (#6186)
## 3.4.4 / 2017-06-17
* Backport #6137 for v3.4.x: Default `baseurl` to `nil` instead of empty string (#6146)
## 3.4.3 / 2017-03-21
* Backport #5957 for v3.4.x: Allow colons in `uri_escape` filter (#5968)
## 3.4.2 / 2017-03-09
* Backport #5871 for v3.4.x: Convert StaticFile liquid representation to a Drop & add front matter defaults support to StaticFiles (#5940)
## 3.4.1 / 2017-03-02
* Backport #5920 for v3.4.x: Allow abbreviated post dates (#5924)
## 3.4.0 / 2017-01-27
### Minor Enhancements
@@ -27,7 +803,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)
@@ -88,7 +864,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)
@@ -220,10 +996,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)
@@ -232,7 +1008,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)
@@ -242,9 +1018,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)
@@ -288,7 +1064,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)
@@ -297,7 +1073,7 @@
* Add `show_dir_listing` option for serve command and fix index file names (#4533)
* Site Template: write a Gemfile which is educational to the new site (#4542)
* Site template: add explanation of site variables in the example `_config.yml` (#4704)
* Adds `link` Liquid tag to make generation of URL's easier (#4624)
* Adds `link` Liquid tag to make generation of URLs easier (#4624)
* Allow static files to be symlinked in unsafe mode or non-prod environments (#4640)
* Add `:after_init` hook & add `Site#config=` to make resetting config easy (#4703)
* DocumentDrop: add `#<=>` which sorts by date (falling back to path) (#4741)
@@ -432,7 +1208,7 @@
* Fix typo on Chocolatey name in Windows documentation (#4686)
* Use the correct URL, Fixes #4698 (#4699)
* Add jekyll-paspagon plugin (#4700)
* Bold-italicize note in assets documentation about needing yaml front matter (#4706)
* Bold-italicize note in assets documentation about needing front matter (#4706)
* Highlight the `script/` calls in the Contributing documentation (#4712)
* Add Hawkins to the list of third-party plugins (#4755)
* Fix a typo in pagination doc (#4763)
@@ -536,7 +1312,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)
@@ -597,14 +1373,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)
* Allow custom file extensions if defined in `permalink` 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
@@ -803,7 +1579,7 @@
* Internal: trigger hooks by owner symbol (#3871)
* Update MIME types from mime-db (#3933)
* Add header to site template `_config.yml` for clarity & direction (#3997)
* Site template: add timezone offset to post date frontmatter (#4001)
* Site template: add timezone offset to post date front matter (#4001)
* Make a constant for the regex to find hidden files (#4032)
* Site template: refactor github & twitter icons into includes (#4049)
* Site template: add background to Kramdown Rouge-ified backtick code blocks (#4053)
@@ -820,7 +1596,7 @@
* Fix nav items alignment when on multiple rows (#3264)
* Highlight: Only Strip Newlines/Carriage Returns, not Spaces (#3278)
* Find variables in front matter defaults by searching with relative file path. (#2774)
* Allow variables (e.g `:categories`) in YAML front matter permalinks (#3320)
* Allow variables (e.g `:categories`) in front matter permalinks (#3320)
* Handle nil URL placeholders in permalinks (#3325)
* Template: Fix nav items alignment when in "burger" mode (#3329)
* Template: Remove `!important` from nav SCSS introduced in #3329 (#3375)
@@ -837,7 +1613,7 @@
* Add WOFF2 font MIME type to Jekyll server MIME types (#3647)
* Be smarter about extracting the extname in `StaticFile` (#3632)
* Process metadata for all dependencies (#3608)
* Show error message if the YAML front matter on a page/post is invalid. (#3643)
* Show error message if the front matter on a page/post is invalid. (#3643)
* Upgrade redcarpet to 3.2 (Security fix: OSVDB-120415) (#3652)
* Create #mock_expects that goes directly to RSpec Mocks. (#3658)
* Open `.jekyll-metadata` in binary mode to read binary Marshal data (#3713)
@@ -915,7 +1691,7 @@
* Add a Resources link to tutorial on building dynamic navbars (#3185)
* Semantic structure improvements to the post and page layouts (#3251)
* Add new AsciiDoc plugin to list of third-party plugins. (#3277)
* Specify that all transformable collection documents must contain YAML front matter (#3271)
* Specify that all transformable collection documents must contain front matter (#3271)
* Assorted accessibility fixes (#3256)
* Update configuration docs to mention `keep_files` for `destination` (#3288, #3296)
* Break when we successfully generate nav link to save CPU cycles. (#3291)
@@ -943,7 +1719,7 @@
* Add a link on all the docs pages to "Improve this page". (#3510)
* Add jekyll-auto-image generator to the list of third-party plugins (#3489)
* Replace link to the proposed `picture` element spec (#3530)
* Add frontmatter date formatting information (#3469)
* Add front matter date formatting information (#3469)
* Improve consistency and clarity of plugins options note (#3546)
* Add permalink warning to pagination docs (#3551)
* Fix grammar in Collections docs API stability warning (#3560)
@@ -1006,7 +1782,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)
@@ -1080,7 +1856,7 @@
* Fix Rouge's RedCarpet plugin interface integration (#2951)
* Remove `--watch` from the site template blog post since it defaults to watching in in 2.4.0 (#2922)
* Fix code for media query mixin in site template (#2946)
* Allow post URL's to have `.htm` extensions (#2925)
* Allow post URLs to have `.htm` extensions (#2925)
* `Utils.slugify`: Don't create new objects when gsubbing (#2997)
* The jsonify filter should deep-convert to Liquid when given an Array. (#3032)
* Apply `jsonify` filter to Hashes deeply and effectively (#3063)
@@ -1452,7 +2228,7 @@
* Clean up the `<head>` in the site template (#2186)
* Permit YAML blocks to end with three dots to better conform with the YAML spec (#2110)
* Use `File.exist?` instead of deprecated `File.exists?` (#2214)
* Require newline after start of YAML Front Matter header (#2211)
* Require newline after start of front matter header (#2211)
* Add the ability for pages to be marked as `published: false` (#1492)
* Add `Jekyll::LiquidExtensions` with `.lookup_variable` method for easy looking up of variable values in a Liquid context. (#2253)
* Remove literal lang name from class (#2292)
@@ -2130,7 +2906,7 @@
* Bullet-proof `limit_posts` option (#1004)
* Read in YAML as UTF-8 to accept non-ASCII chars (#836)
* Fix the CLI option `--plugins` to actually accept dirs and files (#993)
* Allow 'excerpt' in YAML front matter to override the extracted excerpt (#946)
* Allow 'excerpt' in front matter to override the extracted excerpt (#946)
* Fix cascade problem with site.baseurl, site.port and site.host. (#935)
* Filter out directories with valid post names (#875)
* Fix symlinked static files not being correctly built in unsafe mode (#909)
@@ -2142,7 +2918,7 @@
* Patch for multibyte URI problem with `jekyll serve` (#723)
* Order plugin execution by priority (#864)
* Fixed Page#dir and Page#url for edge cases (#536)
* Fix broken `post_url` with posts with a time in their YAML front matter (#831)
* Fix broken `post_url` with posts with a time in their front matter (#831)
* Look for plugins under the source directory (#654)
* Tumblr Migrator: finds `_posts` dir correctly, fixes truncation of long post names (#775)
* Force Categories to be Strings (#767)
@@ -2333,7 +3109,7 @@
* Bug Fixes
* Require redcloth >= 4.2.1 in tests (#92)
* Don't break on triple dashes in yaml front matter (#93)
* Don't break on triple dashes in front matter (#93)
### Minor Enhancements
@@ -2365,7 +3141,7 @@
* 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)
* Posts can now have an empty YAML front matter or none at all (@ bahuvrihi)
* Posts can now have an empty front matter or none at all (@ bahuvrihi)
* Bug Fixes
* 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)
@@ -2373,7 +3149,7 @@
* 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)
* Allow CRLFs in front matter (@juretta)
* Added Date#xmlschema for Ruby versions < 1.9
## 0.5.1 / 2009-05-06
@@ -2452,7 +3228,7 @@
* 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)
* Merge Post's YAML front matter into its to_liquid payload (@remi)
* Merge Post's 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)

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,9 +22,7 @@ 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 El Capitan?
See: https://jekyllrb.com/docs/troubleshooting/#jekyll-amp-mac-os-x-1011
See: https://jekyllrb.com/philosophy
## Getting Started
@@ -34,25 +32,51 @@ See: https://jekyllrb.com/docs/troubleshooting/#jekyll-amp-mac-os-x-1011
* [Fork](https://github.com/jekyll/jekyll/fork) and [Contribute](https://jekyllrb.com/docs/contributing/) your own modifications
* Have questions? Check out our official forum community [Jekyll Talk](https://talk.jekyllrb.com/) or [`#jekyll` on irc.freenode.net](https://botbot.me/freenode/jekyll/)
## Diving In
* [Migrate](http://import.jekyllrb.com/docs/home/) from your previous system
* Learn how [Front Matter](https://jekyllrb.com/docs/front-matter/) works
* Put information on your site with [Variables](https://jekyllrb.com/docs/variables/)
* Customize the [Permalinks](https://jekyllrb.com/docs/permalinks/) your posts are generated with
* 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
* Watch [video tutorials from Giraffe Academy](https://jekyllrb.com/tutorials/video-walkthroughs/)
## Need help?
If you don't find the answer to your problem in our [docs](https://jekyllrb.com/docs/), or in the [troubleshooting section](https://jekyllrb.com/docs/troubleshooting/), ask the [community](https://jekyllrb.com/docs/community/) for help.
## 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
## Credits
* [Migrate](http://import.jekyllrb.com/docs/home/) from your previous system
* Learn how the [YAML Front Matter](https://jekyllrb.com/docs/frontmatter/) works
* Put information on your site with [Variables](https://jekyllrb.com/docs/variables/)
* Customize the [Permalinks](https://jekyllrb.com/docs/permalinks/) your posts are generated with
* 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
### 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

View File

@@ -1,10 +1,12 @@
# frozen_string_literal: true
require "rubygems"
require "rake"
require "rdoc"
require "date"
require "yaml"
$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "lib"))
$LOAD_PATH.unshift File.expand_path("lib", __dir__)
require "jekyll/version"
Dir.glob("rake/**.rake").each { |f| import f }
@@ -44,19 +46,13 @@ def normalize_bullets(markdown)
end
def linkify_prs(markdown)
markdown.gsub(%r!#(\d+)!) do |word|
markdown.gsub(%r!(?<\!&)#(\d+)!) do |word|
"[#{word}]({{ site.repository }}/issues/#{word.delete("#")})"
end
end
def linkify_users(markdown)
markdown.gsub(%r!(@\w+)!) do |username|
"[#{username}](https://github.com/#{username.delete("@")})"
end
end
def linkify(markdown)
linkify_users(linkify_prs(markdown))
linkify_prs(markdown)
end
def liquid_escape(markdown)
@@ -70,11 +66,11 @@ def custom_release_header_anchors(markdown)
_, major, minor, patch = *release_notes.match(header_regexp)
release_notes
.gsub(header_regexp, "\\0\n{: #v\\1-\\2-\\3}")
.gsub(section_regexp) { |section| "#{section}\n{: ##{sluffigy(section)}-v#{major}-#{minor}-#{patch}}" }
.gsub(section_regexp) { |section| "#{section}\n{: ##{slugify(section)}-v#{major}-#{minor}-#{patch}}" }
end.join("\n## ")
end
def sluffigy(header)
def slugify(header)
header.delete("#").strip.downcase.gsub(%r!\s+!, "-")
end
@@ -99,14 +95,14 @@ 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
front_matter = {
"title" => title,
"permalink" => "/docs/#{slug}/",
"note" => "This file is autogenerated. Edit /#{file} instead."
"note" => "This file is autogenerated. Edit /#{file} instead.",
}.merge(overrides_front_matter)
contents = "#{front_matter.to_yaml}---\n\n#{content_for(file)}"
File.write("#{docs_folder}/_docs/#{slug}.md", contents)

View File

@@ -1,6 +1,6 @@
version: "{build}"
clone_depth: 10
clone_depth: 5
branches:
only:
@@ -9,28 +9,26 @@ branches:
build: off
install:
- SET PATH=C:\Ruby%RUBY_FOLDER_VER%\bin;%PATH%
- bundle install --retry 5 --jobs=%NUMBER_OF_PROCESSORS% --clean --path vendor\bundle
environment:
BUNDLE_WITHOUT: "benchmark:site:development"
matrix:
- RUBY_FOLDER_VER: "23"
- RUBY_FOLDER_VER: "25"
TEST_SUITE: "test"
- RUBY_FOLDER_VER: "23"
- RUBY_FOLDER_VER: "25"
TEST_SUITE: "cucumber"
- RUBY_FOLDER_VER: "23"
TEST_SUITE: "fmt"
- RUBY_FOLDER_VER: "23"
- RUBY_FOLDER_VER: "25"
TEST_SUITE: "default-site"
- RUBY_FOLDER_VER: "23-x64"
- RUBY_FOLDER_VER: "25-x64"
TEST_SUITE: "test"
- RUBY_FOLDER_VER: "22"
- RUBY_FOLDER_VER: "24"
TEST_SUITE: "test"
- RUBY_FOLDER_VER: "21"
- RUBY_FOLDER_VER: "23"
TEST_SUITE: "test"
install:
- SET PATH=C:\Ruby%RUBY_FOLDER_VER%\bin;%PATH%
- bundle install --retry 5 --jobs=%NUMBER_OF_PROCESSORS% --clean --path vendor\bundle
test_script:
- ruby --version
- gem --version
@@ -38,5 +36,5 @@ test_script:
- bash ./script/cibuild
cache:
# If one of the files after the right arrow changes, cache will be skipped
# If one of the files after the right arrow changes, cache will be invalidated
- 'vendor\bundle -> appveyor.yml,Gemfile,jekyll.gemspec'

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

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,110 @@
#!/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!
def test_property(property, meta_key)
Benchmark.ips do |x|
x.config(time: 10, warmup: 5)
x.report("sort_by_property_directly with #{property} property") do
sort_by_property_directly(site_docs, meta_key)
end
x.report("schwartzian_transform with #{property} property") do
schwartzian_transform(site_docs, meta_key)
end
x.compare!
end
end
# First, test with a property only a handful of documents have.
test_property('sparse', 'redirect_from')
# Next, test with a property they all have.
test_property('non-sparse', 'title')

1
docs/.gitignore vendored
View File

@@ -1,4 +1,5 @@
_site/
.idea/
*.swp
pkg/
test/

View File

@@ -1,56 +1,48 @@
markdown: kramdown
highlighter: rouge
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
---
version: 3.8.5
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: post
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
- .jekyll-cache
- CNAME
- readme.md

View File

@@ -1,52 +0,0 @@
- title: Getting Started
docs:
- home
- quickstart
- installation
- usage
- structure
- configuration
- title: Your Content
docs:
- frontmatter
- posts
- drafts
- pages
- static-files
- variables
- collections
- datafiles
- assets
- migrations
- title: Customization
docs:
- templates
- includes
- permalinks
- pagination
- plugins
- themes
- extras
- title: Deployment
docs:
- github-pages
- deployment-methods
- continuous-integration
- title: Miscellaneous
docs:
- troubleshooting
- sites
- resources
- upgrading/0-to-2
- upgrading/2-to-3
- title: Meta
docs:
- contributing
- maintaining
- conduct
- history

36
docs/_data/docs_nav.yml Normal file
View File

@@ -0,0 +1,36 @@
- title: Getting Started
items:
- link: /docs/
- link: /docs/ruby-101/
- link: /docs/installation/
- link: /docs/community/
- link: /docs/step-by-step/01-setup/
- title: Build
items:
- link: /docs/usage/
- link: /docs/configuration/
- title: Content
items:
- link: /docs/pages/
- link: /docs/posts/
- link: /docs/front-matter/
- link: /docs/collections/
- link: /docs/datafiles/
- link: /docs/assets/
- link: /docs/static-files/
- title: Site Structure
items:
- link: /docs/structure/
- link: /docs/liquid/
- link: /docs/variables/
- link: /docs/includes/
- link: /docs/layouts/
- link: /docs/permalinks/
- link: /docs/themes/
- link: /docs/pagination/
- title: Guides
items:
- link: /docs/plugins/
- link: /docs/migrations/
- link: /docs/upgrading/
- link: /docs/deployment/

View File

@@ -0,0 +1,298 @@
#
# ---------------------------------------------------------------------------------------
# List of Liquid Filters provided by Jekyll Core that will be utilized for their
# documentation.
#
# To document a new filter, create a new "list-item" below with the following keys:
# name: : [REQUIRED] A string label that identifies the filter
# description: : [REQUIRED] A short description of what to expect from the filter
# version_badge: : [OPTIONAL] Jekyll version that introduced the filter
# examples: : [REQUIRED] A 'nested list' comprised of inputs and outputs
# input: : [REQUIRED] The filter syntax and usage
# output: : [OPTIONAL] The output from the filter
#
# Tip: Use YAML Block notations to "fold" a long string, or to "break" a long string
# to the following line. Block notations can also be used to avoid having to use
# backslashes to escape quotes.
# ---------------------------------------------------------------------------------------
#
- name: Relative URL
description: >-
Prepend the <code>baseurl</code> value to the input. Useful if
your site is hosted at a subpath rather than the root of the domain.
examples:
- input: '{{ "/assets/style.css" | relative_url }}'
output: '/my-baseurl/assets/style.css'
#
- name: Absolute URL
description: Prepend the <code>url</code> and <code>baseurl</code> value to the input.
examples:
- input: '{{ "/assets/style.css" | absolute_url }}'
output: 'http://example.com/my-baseurl/assets/style.css'
#
- name: Date to XML Schema
description: Convert a Date into XML Schema (ISO 8601) format.
examples:
- input: '{{ site.time | date_to_xmlschema }}'
output: '2008-11-07T13:07:54-08:00'
#
- name: Date to RFC-822 Format
description: Convert a Date into the RFC-822 format used for RSS feeds.
examples:
- input: '{{ site.time | date_to_rfc822 }}'
output: 'Mon, 07 Nov 2008 13:07:54 -0800'
#
- name: Date to String
description: Convert a date to short format.
examples:
- input: '{{ site.time | date_to_string }}'
output: '07 Nov 2008'
#
- name: Date to String in ordinal US style
description: 'Format a date to ordinal, US, short format.'
version_badge: 3.8.0
examples:
- input: '{{ site.time | date_to_string: "ordinal", "US" }}'
output: 'Nov 7th, 2008'
#
- name: Date to Long String
description: Format a date to long format.
examples:
- input: '{{ site.time | date_to_long_string }}'
output: '07 November 2008'
#
- name: Date to Long String in ordinal UK style
description: 'Format a date to ordinal, UK, long format.'
version_badge: 3.8.0
examples:
- input: '{{ site.time | date_to_long_string: "ordinal" }}'
output: '7th November 2008'
#
- name: Where
description: Select all the objects in an array where the key has the given value.
examples:
- input: '{{ site.members | where:"graduation_year","2014" }}'
output:
#
- name: Where Expression
description: Select all the objects in an array where the expression is true.
version_badge: 3.2.0
examples:
- input: |-
{{ site.members | where_exp:"item",
"item.graduation_year == 2014" }}
output:
- input: |-
{{ site.members | where_exp:"item",
"item.graduation_year < 2014" }}
output:
- input: |-
{{ site.members | where_exp:"item",
"item.projects contains 'foo'" }}
output:
#
- name: Group By
description: Group an array's items by a given property.
examples:
- input: '{{ site.members | group_by:"graduation_year" }}'
output: |-
[{"name"=>"2013", "items"=>[...]},
{"name"=>"2014", "items"=>[...]}]
#
- name: Group By Expression
description: Group an array's items using a Liquid expression.
version_badge: 3.4.0
examples:
- input: |-
{{ site.members | group_by_exp: "item",
"item.graduation_year | truncate 3, ''" }}
output: |-
[{"name"=>"201...", "items"=>[...]},
{"name"=>"200...", "items"=>[...]}]
#
- name: XML Escape
description: Escape some text for use in XML.
examples:
- input: '{{ page.content | xml_escape }}'
output:
#
- name: CGI Escape
description: >-
CGI escape a string for use in a URL. Replaces any special characters
with appropriate <code>%XX</code> replacements. CGI escape normally
replaces a space with a plus <code>+</code> sign.
examples:
- input: '{{ "foo, bar; baz?" | cgi_escape }}'
output: 'foo%2C+bar%3B+baz%3F'
#
- name: URI Escape
description: >-
Percent encodes any special characters in a URI.
URI escape normally replaces a space with <code>%20</code>.
<a href="https://en.wikipedia.org/wiki/Percent-encoding#Types_of_URI_characters">Reserved characters</a>
will not be escaped.
examples:
- input: '{{ "http://foo.com/?q=foo, \bar?" | uri_escape }}'
output: 'http://foo.com/?q=foo,%20%5Cbar?'
#
- name: Number of Words
description: Count the number of words in some text.
examples:
- input: '{{ page.content | number_of_words }}'
output: 1337
#
- name: Array to Sentence
description: >-
Convert an array into a sentence. Useful for listing tags.
Optional argument for connector.
examples:
- input: '{{ page.tags | array_to_sentence_string }}'
output: 'foo, bar, and baz'
- input: '{{ page.tags | array_to_sentence_string: "or" }}'
output: 'foo, bar, or baz'
#
- name: Markdownify
description: Convert a Markdown-formatted string into HTML.
examples:
- input: '{{ page.excerpt | markdownify }}'
output:
#
- name: Smartify
description: 'Convert "quotes" into &ldquo;smart quotes.&rdquo;'
examples:
- input: '{{ page.title | smartify }}'
output:
#
- name: Converting Sass/SCSS
description: Convert a Sass- or SCSS-formatted string into CSS.
examples:
- input: '{{ some_sass | sassify }}'
output:
- input: '{{ some_scss | scssify }}'
output:
#
- name: Slugify
description: Convert a string into a lowercase URL "slug". See below for options.
examples:
- input: '{{ "The _config.yml file" | slugify }}'
output: 'the-config-yml-file'
- input: '{{ "The _config.yml file" | slugify: "pretty" }}'
output: 'the-_config.yml-file'
- input: '{{ "The _cönfig.yml file" | slugify: "ascii" }}'
output: 'the-c-nfig-yml-file'
- input: '{{ "The cönfig.yml file" | slugify: "latin" }}'
output: 'the-config-yml-file'
#
- name: Data To JSON
description: Convert Hash or Array to JSON.
examples:
- input: '{{ site.data.projects | jsonify }}'
output:
#
- name: Normalize Whitespace
description: Replace any occurrence of whitespace with a single space.
examples:
- input: '{{ "a \n b" | normalize_whitespace }}'
output:
#
- name: Sort
description: >-
Sort an array. Optional arguments for hashes
1.&nbsp;property name
2.&nbsp;nils order (<em>first</em> or <em>last</em>).
examples:
- input: '{{ page.tags | sort }}'
output:
- input: '{{ site.posts | sort: "author" }}'
output:
- input: '{{ site.pages | sort: "title", "last" }}'
output:
#
- name: Sample
description: 'Pick a random value from an array. Optionally, pick multiple values.'
examples:
- input: '{{ site.pages | sample }}'
output:
- input: '{{ site.pages | sample: 2 }}'
output:
#
- name: To Integer
description: Convert a string or boolean to integer.
examples:
- input: '{{ some_var | to_integer }}'
output:
#
- name: Array Filters
description: >-
Push, pop, shift, and unshift elements from an Array.
These are <strong>NON-DESTRUCTIVE</strong>, i.e. they do not mutate the array,
but rather make a copy and mutate that.
examples:
- input: '{{ page.tags | push: "Spokane" }}'
output: '["Seattle", "Tacoma", "Spokane"]'
- input: '{{ page.tags | pop }}'
output: '["Seattle"]'
- input: '{{ page.tags | shift }}'
output: '["Tacoma"]'
- input: '{{ page.tags | unshift: "Olympia" }}'
output: '["Olympia", "Seattle", "Tacoma"]'
#
- name: Inspect
description: Convert an object into its String representation for debugging.
examples:
- input: '{{ some_var | inspect }}'
output:

View File

@@ -0,0 +1,162 @@
# Variables provided by Jekyll core
#
# name: : name of the variable
# description: : content returned by the varialble
global:
- name: site
description: >-
Site wide information + configuration settings from <code>_config.yml</code>.
See below for details.
- name: page
description: >-
Page specific information + the <a href="/docs/front-matter/">front matter</a>.
Custom variables set via the front matter will be available here. See below for details.
- name: layout
description: >-
Layout specific information + the <a href="/docs/front-matter/">front matter</a>.
Custom variables set via front matter in layouts will be available here.
- name: content
description: >-
In layout files, the rendered content of the Post or Page being wrapped.
Not defined in Post or Page files.
- name: paginator
description: >-
When the <code>paginate</code> configuration option is set, this variable becomes available
for use. See <a href="../pagination/">Pagination</a> for details.
site:
- name: site.time
description: >-
The current time (when you run the <code>jekyll</code> command).
- name: site.pages
description: >-
A list of all Pages.
- name: site.posts
description: >-
A reverse chronological list of all Posts.
- name: site.related_posts
description: >-
If the page being processed is a Post, this contains a list of up to ten related Posts.
By default, these are the ten most recent posts. For high quality but slow to compute
results, run the <code>jekyll</code> command with the <code>--lsi</code>
(<a href="https://en.wikipedia.org/wiki/Latent_semantic_analysis#Latent_semantic_indexing">latent semantic indexing</a>)
option. Also note GitHub Pages does not support the
<code>lsi</code> option when generating sites.
- name: site.static_files
description: >-
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 five properties: <code>path</code>, <code>modified_time</code>,
<code>name</code>, <code>basename</code> and <code>extname</code>.
- name: site.html_pages
description: >-
A subset of `site.pages` listing those which end in `.html`.
- name: site.html_files
description: >-
A subset of `site.static_files` listing those which end in `.html`.
- name: site.collections
description: >-
A list of all the collections (including posts).
- name: site.data
description: >-
A list containing the data loaded from the YAML files located in the <code>_data</code>
directory.
- name: site.documents
description: >-
A list of all the documents in every collection.
- name: site.categories.CATEGORY
description: >-
The list of all Posts in category <code>CATEGORY</code>.
- name: site.tags.TAG
description: >-
The list of all Posts with tag <code>TAG</code>.
- name: site.url
description: >-
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>.
- name: "site.[CONFIGURATION_DATA]"
description: >-
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>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.
page:
- name: page.content
description: >-
The content of the Page, rendered or un-rendered depending upon
what Liquid is being processed and what <code>page</code> is.
- name: page.title
description: >-
The title of the Page.
- name: page.excerpt
description: >-
The un-rendered excerpt of a document.
- name: page.url
description: >-
The URL of the Post without the domain, but with a leading slash, e.g.
<code>/2008/12/14/my-post.html</code>
- name: page.date
description: >-
The Date assigned to the Post. This can be overridden in a Posts front matter by specifying
a new date/time in the format <code>YYYY-MM-DD HH:MM:SS</code> (assuming UTC), or
<code>YYYY-MM-DD HH:MM:SS +/-TTTT</code> (to specify a time zone using an offset from UTC.
e.g. <code>2008-12-14 10:30:00 +0900</code>).
- name: page.id
description: >-
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>
- name: page.categories
description: >-
The list of categories to which this post belongs. Categories are derived from the directory
structure above the <code>_posts</code> directory. For example, a post at
<code>/work/code/_posts/2008-12-24-closures.md</code> would have this field set to
<code>['work', 'code']</code>. These can also be specified in the
<a href="/docs/front-matter/">front matter</a>.
- name: page.tags
description: >-
The list of tags to which this post belongs. These can be specified in the
<a href="/docs/front-matter/">front matter</a>.
- name: page.path
description: >-
The path to the raw post or page. Example usage: Linking back to the page or posts source
on GitHub. This can be overridden in the <a href="/docs/front-matter/">front matter</a>.
- name: page.next
description: >-
The next post relative to the position of the current post in <code>site.posts</code>.
Returns <code>nil</code> for the last entry.
- name: page.previous
description: >-
The previous post relative to the position of the current post in <code>site.posts</code>.
Returns <code>nil</code> for the first entry.
paginator:
- name: paginator.page
description: The number of the current page
- name: paginator.per_page
description: Number of posts per page
- name: paginator.posts
description: Posts available for the current page
- name: paginator.total_posts
description: Total number of posts
- name: paginator.total_pages
description: Total number of pages
- name: paginator.previous_page
description: >-
The number of the previous page, or <code>nil</code> if no previous page exists
- name: paginator.previous_page_path
description: >-
The path to the previous page, or <code>nil</code> if no previous page exists
- name: paginator.next_page
description: >-
The number of the next page, or <code>nil</code> if no subsequent page exists
- name: paginator.next_page_path
description: >-
The path to the next page, or <code>nil</code> if no subsequent page exists

View File

@@ -53,7 +53,7 @@
year: 2016
- speaker: Amy Johnston
twitter_handle: amybeukenex
twitter_handle: AmyJohnstonXL
youtube_id: HR12JiUI2Zc
topic: Jekyll for Technical Documentation
year: 2016
@@ -83,7 +83,7 @@
year: 2016
- speaker: Julio Faerman
twitter_handle: jmfaerman
twitter_handle: juliodevrel
youtube_id: SOMonG8Iqak
topic: Jekyll on AWS
year: 2016
@@ -131,7 +131,7 @@
year: 2016
- speaker: Nils Borchers
twitter_handle: nilsborchers
twitter_handle: nilsbo
youtube_id: DtNMjuv6Rbo
topic: Building a living brand guide with Jekyll and Hologram
year: 2016

View File

@@ -0,0 +1,15 @@
- title: Home
link: /
show_on_mobile: true
- title: Docs
link: /docs/
show_on_mobile: true
- title: Resources
link: /resources/
show_on_mobile: true
- title: Showcase
link: /showcase/
show_on_mobile: false
- title: News
link: /news/
show_on_mobile: true

241
docs/_data/showcase.yml Normal file
View File

@@ -0,0 +1,241 @@
- name: Tom Preston Werner Blog
url: http://tom.preston-werner.com/
categories:
- personal
- blog
- name: GitHub On Demand Training
url: https://services.github.com/on-demand/
categories:
- software
- knowledgebase
- name: Vesterheim Norwegian-American Museum
url: http://vesterheim.org/
categories:
- marketing-site
- name: KOTN
url: https://kotn.com/
categories:
- marketing-site
- name: MvvmCross
url: https://www.mvvmcross.com/
categories:
- software
- marketing-site
- name: Vidgrid
url: https://www.vidgrid.com/
categories:
- software
- marketing-site
- name: Bitcoin
url: https://bitcoin.org/en/
categories:
- software
- marketing-site
- name: Mapwize
url: https://www.mapwize.io/
categories:
- software
- marketing-site
- name: Auth0 Blog
url: https://auth0.com/blog/
categories:
- software
- blog
- name: AWS Amplify
url: https://aws-amplify.github.io/
categories:
- open-source
- marketing-site
- name: Yeoman
url: http://yeoman.io/
categories:
- open-source
- marketing-site
- name: Ionic Framwork
url: https://ionicframework.com/
categories:
- software
- marketing-site
- name: Release Management Blog
url: https://release.mozilla.org/
categories:
- software
- blog
- name: Freedom of Information Act
url: https://www.foia.gov/
categories:
- government
- name: Art & About Sydney
url: https://www.artandabout.com.au/
categories:
- government
- name: Passbolt Help
url: https://help.passbolt.com/
categories:
- knowledgebase
- name: We are COLLINS
url: https://www.wearecollins.com/
categories:
- agency
- name: Light Burn
url: https://lightburn.co/
categories:
- agency
- name: italia.it
url: https://developers.italia.it/
categories:
- community
- name: Sydney New Years Eve
url: https://www.sydneynewyearseve.com/
categories:
- government
- name: Login.gov
url: https://login.gov/
categories:
- government
- name: plainlanguage.gov
url: https://plainlanguage.gov/
categories:
- government
- name: U.S. Web Design Standards
url: https://standards.usa.gov/
categories:
- government
- name: Grantmaker Search
url: https://www.grantmakers.io/
categories:
- marketing-site
- name: Rehan Butt
url: http://rehanbutt.com/
categories:
- personal
- portfolio
- name: The Markdown Guide
url: https://www.markdownguide.org/
categories:
- knowledgebase
- name: PROBOT
url: https://probot.github.io/
categories:
- documentation
- name: Matt Grey
url: https://himatt.com/
categories:
- personal
- portfolio
- name: frame.ai
url: https://frame.ai/
categories:
- software
- marketing-site
- name: AdHawk
url: https://www.tryadhawk.com/
categories:
- agency
- name: City of Boston Budget
url: https://budget.boston.gov/
categories:
- government
- name: Lattice
url: https://latticehq.com/
categories:
- software
- marketing-site
- name: MailTape
url: https://www.mailta.pe/
categories:
- other
- name: Digital Democracy
url: http://www.digital-democracy.org/
categories:
- other
- name: HTML Reference
url: http://htmlreference.io/
categories:
- documentation
- name: CSS Reference
url: http://cssreference.io/
categories:
- documentation
- name: Chain
url: https://chain.com/
categories:
- marketing-site
- name: Boxy Suite
url: https://www.boxysuite.com/
categories:
- marketing-site
- software
- name: Pattern Lab
url: http://patternlab.io/
categories:
- documentation
- name: IBM MobileFirst Foundation
url: https://mobilefirstplatform.ibmcloud.com/
categories:
- documentation
- name: 18F
url: https://18f.gsa.gov/
categories:
- agency
- government
- name: Mapbox
url: https://mapbox.com/
categories:
- marketing-site
- name: Development Seed
url: https://developmentseed.org/
categories:
- agency
- name: Isomer - Singapore Government Static Websites
url: https://isomer.gov.sg/
categories:
- government
- name: SiteLeaf
url: https://siteleaf.com
categories:
- software
- marketing-site
- name: CloudCannon
url: https://cloudcannon.com/
categories:
- software
- marketing-site
- name: Ruby on Rails
url: http://rubyonrails.org/
categories:
- marketing-site
- documentation
- name: White House Social and Behavioral Sciences Team
url: https://sbst.gov/
categories:
- government
- name: UN World Statistics
url: https://worldstatisticsday.org
categories:
- government
- name: Sketch App
url: https://sketchapp.com/
categories:
- software
- marketing-site
- name: Netflix Devices
url: https://devices.netflix.com/en/
categories:
- marketing-site
- name: TwitchCon
url: https://www.twitchcon.com/
categories:
- marketing-site
- conference
- name: Twitch Developer Documentation
url: https://dev.twitch.tv/
categories:
- marketing-site
- documentation
- name: Spotify for Developers
url: https://developer.spotify.com
categories:
- marketing-site
- documentation
- software

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

@@ -0,0 +1,9 @@
- name: Forestry.io
image: /img/forestry.svg
url: https://forestry.io/?utm_campaign=jekyllsponsor&utm_medium=banner&utm_source=jekyllrb.com
- name: CloudCannon
image: /img/cloudcannon.svg
url: https://cloudcannon.com
- name: Siteleaf
image: /img/siteleaf.svg
url: https://siteleaf.com

View File

@@ -0,0 +1,9 @@
- title: Tutorials
items:
- link: /tutorials/
- link: /tutorials/video-walkthroughs/
- link: /tutorials/navigation/
- link: /tutorials/order-of-interpretation/
- link: /tutorials/custom-404-page/
- link: /tutorials/convert-site-to-jekyll/
- link: /tutorials/using-jekyll-with-bundler/

View File

@@ -3,10 +3,11 @@ title: Assets
permalink: /docs/assets/
---
Jekyll provides built-in support for Sass and can work with CoffeeScript via
a Ruby gem. In order to use them, you must first create a file with the
proper extension name (one of `.sass`, `.scss`, or `.coffee`) and ***start the
file with two lines of triple dashes***, like this:
Jekyll provides built-in support for [Sass](https://sass-lang.com/)
and can work with [CoffeeScript](https://coffeescript.org/) via a Ruby gem.
In order to use them, you must first create a file with the proper extension
name (one of `.sass`, `.scss`, or `.coffee`) and
***start the file with two lines of triple dashes***, like this:
```sass
---
@@ -23,14 +24,11 @@ have a file named `css/styles.scss` in your site's source folder, Jekyll
will process it and put it in your site's destination folder under
`css/styles.css`.
<div class="note info">
<h5>Jekyll processes all Liquid filters and tags in asset files</h5>
<p>If you are using <a href="https://mustache.github.io">Mustache</a>
or another JavaScript templating language that conflicts with
the <a href="/docs/templates/">Liquid template syntax</a>, you
will need to place <code>{&#37; raw &#37;}</code> and
<code>{&#37; endraw &#37;}</code> tags around your code.</p>
</div>
If you are using [Mustache](https://mustache.github.io)
or another JavaScript templating language that conflicts with
the [Liquid template syntax](/docs/templates/), you
will need to place <code>{&#37; raw &#37;}</code> and
<code>{&#37; endraw &#37;}</code> tags around your code.
## Sass/SCSS
@@ -42,8 +40,7 @@ them to be in the output file, such as `<source>/css`. For an example, take
a look at [this example site using Sass support in Jekyll][example-sass].
If you are using Sass `@import` statements, you'll need to ensure that your
`sass_dir` is set to the base directory that contains your Sass files. You
can do that thusly:
`sass_dir` is set to the base directory that contains your Sass files:
```yaml
sass:
@@ -53,20 +50,14 @@ 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>
<p>
Note that the <code>sass_dir</code> becomes the load path for Sass imports,
nothing more. This means that Jekyll does not know about these files
directly, so any files here should not contain the YAML Front Matter as
described above nor will they be transformed as described above. This
folder should only contain imports.
</p>
</div>
Note that the `sass_dir` becomes the load path for Sass imports,
nothing more. This means that Jekyll does not know about these files
directly, so any files here should not contain the front matter as
described above nor will they be transformed as described above. This
folder should only contain imports.
{: .warning }
You may also specify the output style with the `style` option in your
`_config.yml` file:
@@ -88,6 +79,6 @@ To enable Coffeescript in Jekyll 3.0 and up you must
* Ensure that your `_config.yml` is up-to-date and includes the following:
```yaml
gems:
- jekyll-coffeescript
plugins:
- jekyll-coffeescript
```

View File

@@ -0,0 +1,52 @@
---
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
---
## 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

View File

@@ -3,56 +3,45 @@ title: Collections
permalink: /docs/collections/
---
Not everything is a post or a page. Maybe you want to document the various
methods in your open source project, members of a team, or talks at a
conference. Collections allow you to define a new type of document that behave
like Pages or Posts do normally, but also have their own unique properties and
namespace.
Collections are a great way to group related content like members of a team or
talks at a conference.
## Using Collections
## Setup
To start using collections, follow these 3 steps:
* [Step 1: Tell Jekyll to read in your collection](#step1)
* [Step 2: Add your content](#step2)
* [Step 3: Optionally render your collection's documents into independent files](#step3)
### Step 1: Tell Jekyll to read in your collection {#step1}
Add the following to your site's `_config.yml` file, replacing `my_collection`
with the name of your collection:
To use a Collection you first need to define it in your `_config.yml`. For
example here's a collection of staff members:
```yaml
collections:
- my_collection
- staff_members
```
You can optionally specify metadata for your collection in the configuration:
```yaml
collections:
my_collection:
foo: bar
staff_members:
people: true
```
Default attributes can also be set for a collection:
## Add content
```yaml
defaults:
- scope:
path: ""
type: my_collection
values:
layout: page
```
### Step 2: Add your content {#step2}
Create a corresponding folder (e.g. `<source>/_my_collection`) and add
documents. YAML front matter is processed if the front matter exists, and everything
after the front matter is pushed into the document's `content` attribute. If no YAML front
Create a corresponding folder (e.g. `<source>/_staff_members`) and add
documents. Front matter is processed if the front matter exists, and everything
after the front matter is pushed into the document's `content` attribute. If no front
matter is provided, Jekyll will not generate the file in your collection.
For example here's how you would add a staff member to the collection set above.
The filename is `./_staff_members/jane.md` with the following content:
```markdown
---
name: Jane Doe
position: Developer
---
Jane has worked on Jekyll for the past *five years*.
```
<div class="note info">
<h5>Be sure to name your directories correctly</h5>
<p>
@@ -61,189 +50,68 @@ your <code>_config.yml</code> file, with the addition of the preceding <code>_</
</p>
</div>
### Step 3: Optionally render your collection's documents into independent files {#step3}
## Output
If you'd like Jekyll to create a public-facing, rendered version of each
document in your collection, set the `output` key to `true` in your collection
metadata in your `_config.yml`:
Now you can iterate over `site.staff_members` on a page and output the content
for each staff member. Similar to posts, the body of the document is accessed
using the `content` variable:
{% raw %}
```liquid
{% for staff_member in site.staff_members %}
<h2>{{ staff_member.name }} - {{ staff_member.position }}</h2>
<p>{{ staff_member.content | markdownify }}</p>
{% endfor %}
```
{% endraw %}
If you'd like Jekyll to create a rendered page for each document in your
collection, you can set the `output` key to `true` in your collection
metadata in `_config.yml`:
```yaml
collections:
my_collection:
staff_members:
output: true
```
This will produce a file for each document in the collection.
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`.
You can link to the generated page using the `url` attribute:
<div class="note info">
<h5>Don't forget to add YAML for processing</h5>
<p>
Files in collections that do not have front matter are treated as
<a href="/docs/static-files">static files</a> and simply copied to their
output location without processing.
</p>
</div>
## Configuring permalinks for collections {#permalinks}
You can customize the [Permalinks](../permalinks/) for your collection's documents by setting `permalink` property in the collection's configuration as follows:
```yaml
collections:
my_collection:
output: true
permalink: /awesome/:path/:title.:output_ext
{% raw %}
```liquid
{% for staff_member in site.staff_members %}
<h2>
<a href="{{ staff_member.url }}">
{{ staff_member.name }} - {{ staff_member.position }}
</a>
</h2>
<p>{{ staff_member.content | markdownify }}</p>
{% endfor %}
```
{% endraw %}
In this example, the collection documents will the have the URL of `awesome` followed by the path to the document and its file extension.
## Permalinks
Collections have the following template variables available for permalinks:
There are special [permalink variables for collections](/docs/permalinks/) to
help you control the output url for the entire collection.
<div class="mobile-side-scroller">
<table>
<thead>
<tr>
<th>Variable</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<p><code>collection</code></p>
</td>
<td>
<p>Label of the containing collection.</p>
</td>
</tr>
<tr>
<td>
<p><code>path</code></p>
</td>
<td>
<p>Path to the document relative to the collection's directory.</p>
</td>
</tr>
<tr>
<td>
<p><code>name</code></p>
</td>
<td>
<p>The document's base filename, with every sequence of spaces
and non-alphanumeric characters replaced by a hyphen.</p>
</td>
</tr>
<tr>
<td>
<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>
</td>
</tr>
<tr>
<td>
<p><code>output_ext</code></p>
</td>
<td>
<p>Extension of the output file.</p>
</td>
</tr>
</tbody>
</table>
</div>
## Custom Collection directory
You can optionally specify a directory to store all your collections in the same place with `collections_dir: my_collections`.
## Permalink examples for collections
Then Jekyll will look in `my_collections/_books` for the `books` collection, and
in `my_collections/_recipes` for the `recipes` collection.
Depending on how you declare the permalinks in your configuration file, the permalinks and paths get written differently in the `_site` folder. A few examples will help clarify the options.
The name of your collections directory cannot start with an `_`.
Let's say your collection is called `apidocs` with `doc1.md` in your collection. `doc1.md` is grouped inside a folder called `mydocs`. Your project's source directory for the collection looks this:
```
├── \_apidocs
│   └── mydocs
│   └── doc1.md
```
Based on this scenario, here are a few permalink options.
**Permalink configuration 1**: [Nothing configured] <br/>
**Output**:
```
├── apidocs
│   └── mydocs
│   └── doc1.html
```
**Permalink configuration 2**: `/:collection/:path/:title:output_ext` <br/>
**Output**:
```
├── apidocs
│   └── mydocs
│   └── doc1.html
```
**Permalink configuration 3**: No collection permalinks configured, but `pretty` configured for pages/posts. <br/>
**Output**:
```
├── apidocs
│   └── mydocs
│   └── doc1
│   └── index.html
```
**Permalink configuration 4**: `/awesome/:path/:title.html` <br/>
**Output**:
```
├── awesome
│   └── mydocs
│   └── doc1.html
```
**Permalink configuration 5**: `/awesome/:path/:title/` <br/>
**Output**:
```
├── awesome
│   └── mydocs
│   └── doc1
│   └── index.html
```
**Permalink configuration 6**: `/awesome/:title.html` <br/>
**Output**:
```
├── awesome
│   └── doc1.html
```
**Permalink configuration 7**: `:title.html`
**Output**:
```
├── doc1.html
```
You will need to move your `_drafts` and `_posts` to your `collection_dir`
{: .warning }
## Liquid Attributes
### Collections
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`.
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.
The collections are also available under `site.collections`, with the metadata
Collections are also available under `site.collections`, with the metadata
you specified in your `_config.yml` (if present) and the following information:
<div class="mobile-side-scroller">
@@ -321,10 +189,35 @@ you specified in your `_config.yml` (if present) and the following information:
</table>
</div>
<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
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>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
In addition to any YAML Front Matter provided in the document's corresponding
In addition to any front matter provided in the document's corresponding
file, each document has the following attributes:
<div class="mobile-side-scroller">
@@ -342,9 +235,9 @@ file, each document has the following attributes:
</td>
<td>
<p>
The (unrendered) content of the document. If no YAML Front Matter is
The (unrendered) content of the document. If no front matter is
provided, Jekyll will not generate the file in your collection. If
YAML Front Matter is used, then this is all the contents of the file
front matter is used, then this is all the contents of the file
after the terminating
`---` of the front matter.
</p>
@@ -414,51 +307,3 @@ file, each document has the following attributes:
</tbody>
</table>
</div>
## Accessing Collection Attributes
Attributes from the YAML front matter can be accessed as data anywhere in the
site. Using the above example for configuring a collection as `site.albums`,
you might have front matter in an individual file structured as follows (which
must use a supported markup format, and cannot be saved with a `.yaml`
extension):
```yaml
title: "Josquin: Missa De beata virgine and Missa Ave maris stella"
artist: "The Tallis Scholars"
director: "Peter Phillips"
works:
- title: "Missa De beata virgine"
composer: "Josquin des Prez"
tracks:
- title: "Kyrie"
duration: "4:25"
- title: "Gloria"
duration: "9:53"
- title: "Credo"
duration: "9:09"
- title: "Sanctus & Benedictus"
duration: "7:47"
- title: "Agnus Dei I, II & III"
duration: "6:49"
```
Every album in the collection could be listed on a single page with a template:
```html
{% raw %}
{% for album in site.albums %}
<h2>{{ album.title }}</h2>
<p>Performed by {{ album.artist }}{% if album.director %}, directed by {{ album.director }}{% endif %}</p>
{% for work in album.works %}
<h3>{{ work.title }}</h3>
<p>Composed by {{ work.composer }}</p>
<ul>
{% for track in work.tracks %}
<li>{{ track.title }} ({{ track.duration }})</li>
{% endfor %}
</ul>
{% endfor %}
{% endfor %}
{% endraw %}
```

View File

@@ -0,0 +1,8 @@
---
title: Report a bug
permalink: "/docs/community/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).

View File

@@ -0,0 +1,38 @@
---
title: Community
permalink: /docs/community/
redirect_from: "/help/index.html"
---
## Jekyll Contributor Code of Conduct
As contributors and maintainers of this project, and in the interest of fostering an open and welcoming community, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
[Read the full code of conduct](/docs/conduct/)
## Where to get support
If you're looking for support for Jekyll, there are a lot of options:
* Read [Jekyll Documentation](https://jekyllrb.com/docs/)
* If you have a question about using Jekyll, start a discussion on [the 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.
**Reminder: Jekyll's issue tracker is not a support forum.**
## Ways to contribute
* [How to Contribute](/docs/contributing/)
* [How to file a bug](/docs/community/bug/)
* [Guide for maintaining Jekyll](/docs/maintaining/)
## Jekyllconf
[Watch videos](/jekyllconf/) from members of the Jekyll community speak about interesting use cases, tricks theyve learned or meta Jekyll topics.
## Jekyll on Twitter
The [official Jekyll Twitter account](https://twitter.com/jekyllrb).

View File

@@ -3,779 +3,16 @@ title: Configuration
permalink: /docs/configuration/
---
Jekyll allows you to concoct your sites in any way you can dream up, and its
thanks to the powerful and flexible configuration options that this is possible.
These options can either be specified in a `_config.yml` file placed in your
sites root directory, or can be specified as flags for the `jekyll` executable
in the terminal.
## Configuration Settings
### Global Configuration
The table below lists the available settings for Jekyll, and the various <code
class="option">options</code> (specified in the configuration file) and <code
class="flag">flags</code> (specified on the command-line) that control them.
<div class="mobile-side-scroller">
<table>
<thead>
<tr>
<th>Setting</th>
<th>
<span class="option">Options</span> and <span class="flag">Flags</span>
</th>
</tr>
</thead>
<tbody>
<tr class="setting">
<td>
<p class="name"><strong>Site Source</strong></p>
<p class="description">Change the directory where Jekyll will read files</p>
</td>
<td class="align-center">
<p><code class="option">source: DIR</code></p>
<p><code class="flag">-s, --source DIR</code></p>
</td>
</tr>
<tr class="setting">
<td>
<p class="name"><strong>Site Destination</strong></p>
<p class="description">Change the directory where Jekyll will write files</p>
</td>
<td class="align-center">
<p><code class="option">destination: DIR</code></p>
<p><code class="flag">-d, --destination DIR</code></p>
</td>
</tr>
<tr class="setting">
<td>
<p class="name"><strong>Safe</strong></p>
<p class="description">Disable <a href="../plugins/">custom plugins, and ignore symbolic links</a>.</p>
</td>
<td class="align-center">
<p><code class="option">safe: BOOL</code></p>
<p><code class="flag">--safe</code></p>
</td>
</tr>
<tr class="setting">
<td>
<p class="name"><strong>Exclude</strong></p>
<p class="description">
Exclude directories and/or files from the
conversion. These exclusions are relative to the site's
source directory and cannot be outside the source directory.
</p>
</td>
<td class="align-center">
<p><code class="option">exclude: [DIR, FILE, ...]</code></p>
</td>
</tr>
<tr class="setting">
<td>
<p class="name"><strong>Include</strong></p>
<p class="description">
Force inclusion of directories and/or files in the conversion.
<code>.htaccess</code> is a good example since dotfiles are excluded
by default.
</p>
</td>
<td class="align-center">
<p><code class="option">include: [DIR, FILE, ...]</code></p>
</td>
</tr>
<tr class="setting">
<td>
<p class="name"><strong>Keep files</strong></p>
<p class="description">
When clobbering the site destination, keep the selected files.
Useful for files that are not generated by jekyll; e.g. files or
assets that are generated by your build tool.
The paths are relative to the <code>destination</code>.
</p>
</td>
<td class="align-center">
<p><code class="option">keep_files: [DIR, FILE, ...]</code></p>
</td>
</tr>
<tr class="setting">
<td>
<p class="name"><strong>Time Zone</strong></p>
<p class="description">
Set the time zone for site generation. This sets the <code>TZ</code>
environment variable, which Ruby uses to handle time and date
creation and manipulation. Any entry from the
<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.
</p>
</td>
<td class="align-center">
<p><code class="option">timezone: TIMEZONE</code></p>
</td>
</tr>
<tr class="setting">
<td>
<p class="name"><strong>Encoding</strong></p>
<p class="description">
Set the encoding of files by name (only available for Ruby
1.9 or later).
The default value is <code>utf-8</code> starting in 2.0.0,
and <code>nil</code> before 2.0.0, which will yield the Ruby
default of <code>ASCII-8BIT</code>.
Available encodings can be shown by the
command <code>ruby -e 'puts Encoding::list.join("\n")'</code>.
</p>
</td>
<td class="align-center">
<p><code class="option">encoding: ENCODING</code></p>
</td>
</tr>
<tr>
<td>
<p class='name'><strong>Defaults</strong></p>
<p class='description'>
Set defaults for <a href="../frontmatter/" title="YAML Front Matter">YAML Front Matter</a>
variables.
</p>
</td>
<td class='align-center'>
<p>see <a href="#front-matter-defaults" title="details">below</a></p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="note warning">
<h5>Destination folders are cleaned on site builds</h5>
<p>
The contents of <code>&lt;destination&gt;</code> are automatically
cleaned, by default, when the site is built. Files or folders that are not
created by your site will be removed. Some files could be retained
by specifying them within the <code>&lt;keep_files&gt;</code> configuration directive.
</p>
<p>
Do not use an important location for <code>&lt;destination&gt;</code>; instead, use it as
a staging area and copy files from there to your web server.
</p>
</div>
### Build Command Options
<div class="mobile-side-scroller">
<table>
<thead>
<tr>
<th>Setting</th>
<th><span class="option">Options</span> and <span class="flag">Flags</span></th>
</tr>
</thead>
<tbody>
<tr class="setting">
<td>
<p class="name"><strong>Regeneration</strong></p>
<p class="description">Enable auto-regeneration of the site when files are modified.</p>
</td>
<td class="align-center">
<p><code class="flag">-w, --[no-]watch</code></p>
</td>
</tr>
<tr class="setting">
<td>
<p class="name"><strong>Configuration</strong></p>
<p class="description">Specify config files instead of using <code>_config.yml</code> automatically. Settings in later files override settings in earlier files.</p>
</td>
<td class="align-center">
<p><code class="flag">--config FILE1[,FILE2,...]</code></p>
</td>
</tr>
<tr class="setting">
<td>
<p class="name"><strong>Drafts</strong></p>
<p class="description">Process and render draft posts.</p>
</td>
<td class="align-center">
<p><code class="option">show_drafts: BOOL</code></p>
<p><code class="flag">--drafts</code></p>
</td>
</tr>
<tr class="setting">
<td>
<p class="name"><strong>Environment</strong></p>
<p class="description">Use a specific environment value in the build.</p>
</td>
<td class="align-center">
<p><code class="flag">JEKYLL_ENV=production</code></p>
</td>
</tr>
<tr class="setting">
<td>
<p class="name"><strong>Future</strong></p>
<p class="description">Publish posts or collection documents with a future date.</p>
</td>
<td class="align-center">
<p><code class="option">future: BOOL</code></p>
<p><code class="flag">--future</code></p>
</td>
</tr>
<tr class="setting">
<td>
<p class="name"><strong>Unpublished</strong></p>
<p class="description">Render posts that were marked as unpublished.</p>
</td>
<td class="align-center">
<p><code class="option">unpublished: BOOL</code></p>
<p><code class="flag">--unpublished</code></p>
</td>
</tr>
<tr class="setting">
<td>
<p class="name"><strong>LSI</strong></p>
<p class="description">Produce an index for related posts. Requires the <a href="http://www.classifier-reborn.com/">classifier-reborn</a> plugin.</p>
</td>
<td class="align-center">
<p><code class="option">lsi: BOOL</code></p>
<p><code class="flag">--lsi</code></p>
</td>
</tr>
<tr class="setting">
<td>
<p class="name"><strong>Limit Posts</strong></p>
<p class="description">Limit the number of posts to parse and publish.</p>
</td>
<td class="align-center">
<p><code class="option">limit_posts: NUM</code></p>
<p><code class="flag">--limit_posts NUM</code></p>
</td>
</tr>
<tr class="setting">
<td>
<p class="name"><strong>Force polling</strong></p>
<p class="description">Force watch to use polling.</p>
</td>
<td class="align-center">
<p><code class="flag">--force_polling</code></p>
</td>
</tr>
<tr class="setting">
<td>
<p class="name"><strong>Verbose output</strong></p>
<p class="description">Print verbose output.</p>
</td>
<td class="align-center">
<p><code class="flag">-V, --verbose</code></p>
</td>
</tr>
<tr class="setting">
<td>
<p class="name"><strong>Silence Output</strong></p>
<p class="description">Silence the normal output from Jekyll
during a build</p>
</td>
<td class="align-center">
<p><code class="flag">-q, --quiet</code></p>
</td>
</tr>
<tr class="setting">
<td>
<p class="name"><strong>Incremental build</strong></p>
<p class="description">
Enable the experimental incremental build feature. Incremental build only
re-builds posts and pages that have changed, resulting in significant performance
improvements for large sites, but may also break site generation in certain
cases.
</p>
</td>
<td class="align-center">
<p><code class="option">incremental: BOOL</code></p>
<p><code class="flag">-I, --incremental</code></p>
</td>
</tr>
<tr class="setting">
<td>
<p class="name"><strong>Liquid profiler</strong></p>
<p class="description">
Generate a Liquid rendering profile to help you identify performance bottlenecks.
</p>
</td>
<td class="align-center">
<p><code class="option">profile: BOOL</code></p>
<p><code class="flag">--profile</code></p>
</td>
</tr>
</tbody>
</table>
</div>
### Serve Command Options
In addition to the options below, the `serve` sub-command can accept any of the options
for the `build` sub-command, which are then applied to the site build which occurs right
before your site is served.
<div class="mobile-side-scroller">
<table>
<thead>
<tr>
<th>Setting</th>
<th><span class="option">Options</span> and <span class="flag">Flags</span></th>
</tr>
</thead>
<tbody>
<tr class="setting">
<td>
<p class="name"><strong>Local Server Port</strong></p>
<p class="description">Listen on the given port.</p>
</td>
<td class="align-center">
<p><code class="option">port: PORT</code></p>
<p><code class="flag">--port PORT</code></p>
</td>
</tr>
<tr class="setting">
<td>
<p class="name"><strong>Local Server Hostname</strong></p>
<p class="description">Listen at the given hostname.</p>
</td>
<td class="align-center">
<p><code class="option">host: HOSTNAME</code></p>
<p><code class="flag">--host HOSTNAME</code></p>
</td>
</tr>
<tr class="setting">
<td>
<p class="name"><strong>Base URL</strong></p>
<p class="description">Serve the website from the given base URL</p>
</td>
<td class="align-center">
<p><code class="option">baseurl: URL</code></p>
<p><code class="flag">--baseurl URL</code></p>
</td>
</tr>
<tr class="setting">
<td>
<p class="name"><strong>Detach</strong></p>
<p class="description">Detach the server from the terminal</p>
</td>
<td class="align-center">
<p><code class="option">detach: BOOL</code></p>
<p><code class="flag">-B, --detach</code></p>
</td>
</tr>
<tr class="setting">
<td>
<p class="name"><strong>Skips the initial site build.</strong></p>
<p class="description">Skips the initial site build which occurs before the server is started.</p>
</td>
<td class="align-center">
<p><code class="flag">--skip-initial-build</code></p>
</td>
</tr>
<tr class="setting">
<td>
<p class="name"><strong>X.509 (SSL) Private Key</strong></p>
<p class="description">SSL Private Key.</p>
</td>
<td class="align-center">
<p><code class="flag">--ssl-key</code></p>
</td>
</tr>
<tr class="setting">
<td>
<p class="name"><strong>X.509 (SSL) Certificate</strong></p>
<p class="description">SSL Public certificate.</p>
</td>
<td class="align-center">
<p><code class="flag">--ssl-cert</code></p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="note warning">
<h5>Do not use tabs in configuration files</h5>
<p>
This will either lead to parsing errors, or Jekyll will revert to the
default settings. Use spaces instead.
</p>
</div>
## Custom WEBrick Headers
You can provide custom headers for your site by adding them to `_config.yml`
```yaml
# File: _config.yml
webrick:
headers:
My-Header: My-Value
My-Other-Header: My-Other-Value
```
### Defaults
We provide by default `Content-Type` and `Cache-Control` response headers: one
dynamic in order to specify the nature of the data being served, the other
static in order to disable caching so that you don't have to fight with Chrome's
aggressive caching when you are in development mode.
## Specifying a Jekyll environment at build time
In the build (or serve) arguments, you can specify a Jekyll environment and value. The build will then apply this value in any conditional statements in your content.
For example, suppose you set this conditional statement in your code:
```liquid
{% raw %}
{% if jekyll.environment == "production" %}
{% include disqus.html %}
{% endif %}
{% endraw %}
```
When you build your Jekyll site, the content inside the `if` statement won't be run unless you also specify a `production` environment in the build command, like this:
```sh
JEKYLL_ENV=production jekyll build
```
Specifying an environment value allows you to make certain content available only within specific environments.
The default value for `JEKYLL_ENV` is `development`. Therefore if you omit `JEKYLL_ENV` from the build arguments, the default value will be `JEKYLL_ENV=development`. Any content inside `{% raw %}{% if jekyll.environment == "development" %}{% endraw %}` tags will automatically appear in the build.
Your environment values can be anything you want (not just `development` or `production`). Some elements you might want to hide in development environments include Disqus comment forms or Google Analytics. Conversely, you might want to expose an "Edit me in GitHub" button in a development environment but not include it in production environments.
By specifying the option in the build command, you avoid having to change values in your configuration files when moving from one environment to another.
## Front Matter defaults
Using [YAML Front Matter](../frontmatter/) is one way that you can specify configuration in the pages and posts for your site. Setting things like a default layout, or customizing the title, or specifying a more precise date/time for the post can all be added to your page or post front matter.
Often times, you will find that you are repeating a lot of configuration options. Setting the same layout in each file, adding the same category - or categories - to a post, etc. You can even add custom variables like author names, which might be the same for the majority of posts on your blog.
Instead of repeating this configuration each time you create a new post or page, Jekyll provides a way to set these defaults in the site configuration. To do this, you can specify site-wide defaults using the `defaults` key in the `_config.yml` file in your project's root directory.
The `defaults` key holds an array of scope/values pairs that define what defaults should be set for a particular file path, and optionally, a file type in that path.
Let's say that you want to add a default layout to all pages and posts in your site. You would add this to your `_config.yml` file:
```yaml
defaults:
-
scope:
path: "" # an empty string here means all files in the project
values:
layout: "default"
```
<div class="note info">
<h5>Please stop and rerun `jekyll serve` command.</h5>
<p>
The <code>_config.yml</code> master configuration file contains global configurations
and variable definitions that are read once at execution time. Changes made to <code>_config.yml</code>
during automatic regeneration are not loaded until the next execution.
</p>
<p>
Note <a href="../datafiles">Data Files</a> are included and reloaded during automatic regeneration.
</p>
</div>
Here, we are scoping the `values` to any file that exists in the path `scope`. Since the path is set as an empty string, it will apply to **all files** in your project. You probably don't want to set a layout on every file in your project - like css files, for example - so you can also specify a `type` value under the `scope` key.
```yaml
defaults:
-
scope:
path: "" # an empty string here means all files in the project
type: "posts" # previously `post` in Jekyll 2.2.
values:
layout: "default"
```
Now, this will only set the layout for files where the type is `posts`.
The different types that are available to you are `pages`, `posts`, `drafts` or any collection in your site. While `type` is optional, you must specify a value for `path` when creating a `scope/values` pair.
As mentioned earlier, you can set multiple scope/values pairs for `defaults`.
```yaml
defaults:
-
scope:
path: ""
type: "posts"
values:
layout: "my-site"
-
scope:
path: "projects"
type: "pages" # previously `page` in Jekyll 2.2.
values:
layout: "project" # overrides previous default layout
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`.
```yaml
collections:
my_collection:
output: true
defaults:
-
scope:
path: ""
type: "my_collection" # a collection in your site, in plural form
values:
layout: "default"
```
In this example, the `layout` is set to `default` inside the
[collection](../collections/) with the name `my_collection`.
### 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.
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:
```yaml
# In _config.yml
...
defaults:
-
scope:
path: "projects"
type: "pages"
values:
layout: "project"
author: "Mr. Hyde"
category: "project"
...
```
```yaml
# In projects/foo_project.md
---
author: "John Smith"
layout: "foobar"
---
The post text goes here...
```
The `projects/foo_project.md` would have the `layout` set to `foobar` instead
of `project` and the `author` set to `John Smith` instead of `Mr. Hyde` when
the site is built.
## Default Configuration
Jekyll runs with the following configuration options by default. Alternative
settings for these options can be explicitly specified in the configuration
file or on the command-line.
<div class="note warning">
<h5>There are two unsupported kramdown options</h5>
<p>
Please note that both <code>remove_block_html_tags</code> and
<code>remove_span_html_tags</code> are currently unsupported in Jekyll due
to the fact that they are not included within the kramdown HTML converter.
</p>
</div>
```yaml
# Where things are
source: .
destination: ./_site
plugins_dir: _plugins
layouts_dir: _layouts
data_dir: _data
includes_dir: _includes
collections:
posts:
output: true
# Handling Reading
safe: false
include: [".htaccess"]
exclude: ["node_modules", "vendor/bundle/", "vendor/cache/", "vendor/gems/", "vendor/ruby/"]
keep_files: [".git", ".svn"]
encoding: "utf-8"
markdown_ext: "markdown,mkdown,mkdn,mkd,md"
# Filtering Content
show_drafts: null
limit_posts: 0
future: false
unpublished: false
# Plugins
whitelist: []
gems: []
# Conversion
markdown: kramdown
highlighter: rouge
lsi: false
excerpt_separator: "\n\n"
incremental: false
# Serving
detach: false
port: 4000
host: 127.0.0.1
baseurl: "" # does not include hostname
show_dir_listing: false
# Outputting
permalink: date
paginate_path: /page:num
timezone: null
quiet: false
verbose: false
defaults: []
liquid:
error_mode: warn
# Markdown Processors
rdiscount:
extensions: []
redcarpet:
extensions: []
kramdown:
auto_ids: true
footnote_nr: 1
entity_output: as_char
toc_levels: 1..6
smart_quotes: lsquo,rsquo,ldquo,rdquo
input: GFM
hard_wrap: false
footnote_nr: 1
```
## Liquid Options
Liquid's response to errors can be configured by setting `error_mode`. The
options are
- `lax` --- Ignore all errors.
- `warn` --- Output a warning on the console for each error.
- `strict` --- Output an error message and stop the build.
## Markdown Options
The various Markdown renderers supported by Jekyll sometimes have extra options
available.
### Redcarpet
Redcarpet can be configured by providing an `extensions` sub-setting, whose
value should be an array of strings. Each string should be the name of one of
the `Redcarpet::Markdown` class's extensions; if present in the array, it will
set the corresponding extension to `true`.
Jekyll handles two special Redcarpet extensions:
- `no_fenced_code_blocks` --- By default, Jekyll sets the `fenced_code_blocks`
extension (for delimiting code blocks with triple tildes or triple backticks)
to `true`, probably because GitHub's eager adoption of them is starting to make
them inescapable. Redcarpet's normal `fenced_code_blocks` extension is inert
when used with Jekyll; instead, you can use this inverted version of the
extension for disabling fenced code.
Note that you can also specify a language for highlighting after the first
delimiter:
```ruby
# ...ruby code
```
With both fenced code blocks and highlighter enabled, this will statically
highlight the code; without any syntax highlighter, it will add a
`class="LANGUAGE"` attribute to the `<code>` element, which can be used as a
hint by various JavaScript code highlighting libraries.
- `smart` --- This pseudo-extension turns on SmartyPants, which converts
straight quotes to curly quotes and runs of hyphens to em (`---`) and en (`--`) dashes.
All other extensions retain their usual names from Redcarpet, and no renderer
options aside from `smart` can be specified in Jekyll. [A list of available
extensions can be found in the Redcarpet README file.][redcarpet_extensions]
Make sure you're looking at the README for the right version of
Redcarpet: Jekyll currently uses v3.2.x. The most commonly used
extensions are:
- `tables`
- `no_intra_emphasis`
- `autolink`
[redcarpet_extensions]: https://github.com/vmg/redcarpet/blob/v3.2.2/README.markdown#and-its-like-really-simple-to-use
### Custom Markdown Processors
If you're interested in creating a custom markdown processor, you're in luck! Create a new class in the `Jekyll::Converters::Markdown` namespace:
```ruby
class Jekyll::Converters::Markdown::MyCustomProcessor
def initialize(config)
require 'funky_markdown'
@config = config
rescue LoadError
STDERR.puts 'You are missing a library required for Markdown. Please run:'
STDERR.puts ' $ [sudo] gem install funky_markdown'
raise FatalException.new("Missing dependency: funky_markdown")
end
def convert(content)
::FunkyMarkdown.new(content).convert
end
end
```
Once you've created your class and have it properly set up either as a plugin
in the `_plugins` folder or as a gem, specify it in your `_config.yml`:
```yaml
markdown: MyCustomProcessor
```
## Incremental Regeneration
<div class="note warning">
<h5>Incremental regeneration is still an experimental feature</h5>
<p>
While incremental regeneration will work for the most common cases, it will
not work correctly in every scenario. Please be extremely cautious when
using the feature, and report any problems not listed below by
<a href="https://github.com/jekyll/jekyll/issues/new">opening an issue on GitHub</a>.
</p>
</div>
Incremental regeneration helps shorten build times by only generating documents
and pages that were updated since the previous build. It does this by keeping
track of both file modification times and inter-document dependencies in the
`.jekyll-metadata` file.
Under the current implementation, incremental regeneration will only generate a
document or page if either it, or one of its dependencies, is modified. Currently,
the only types of dependencies tracked are includes (using the
{% raw %}`{% include %}`{% endraw %} tag) and layouts. This means that plain
references to other documents (for example, the common case of iterating over
`site.posts` in a post listings page) will not be detected as a dependency.
To remedy some of these shortfalls, putting `regenerate: true` in the front-matter
of a document will force Jekyll to regenerate it regardless of whether it has been
modified. Note that this will generate the specified document only; references
to other documents' contents will not work since they won't be re-rendered.
Incremental regeneration can be enabled via the `--incremental` flag (`-I` for
short) from the command-line or by setting `incremental: true` in your
configuration file.
Jekyll gives you a lot of flexibility to customize how it builds your site. These
options can either be specified in a `_config.yml` or `_config.toml` file placed
in your sites root directory, or can be specified as flags for the `jekyll`
executable in the terminal.
* [Configuration Options](/docs/configuration/options/)
* [Default Configuration](/docs/configuration/default/)
* [Front Matter Defaults](/docs/configuration/front-matter-defaults/)
* [Environments](/docs/configuration/environments/)
* [Markdown Options](/docs/configuration/markdown/)
* [Liquid Options](/docs/configuration/liquid/)
* [Webrick Options](/docs/configuration/webrick/)
* [Incremental Regeneration](/docs/configuration/incremental-regeneration/)

View File

@@ -0,0 +1,86 @@
---
title: Default Configuration
permalink: "/docs/configuration/default/"
---
Jekyll runs with the following configuration options by default. Alternative
settings for these options can be explicitly specified in the configuration
file or on the command-line.
```yaml
# Where things are
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"
strict_front_matter : false
# Filtering Content
show_drafts : null
limit_posts : 0
future : false
unpublished : false
# Plugins
whitelist : []
plugins : []
# Conversion
markdown : kramdown
highlighter : rouge
lsi : false
excerpt_separator : "\n\n"
incremental : false
# Serving
detach : false
port : 4000
host : 127.0.0.1
baseurl : "" # does not include hostname
show_dir_listing : false
# Outputting
permalink : date
paginate_path : /page:num
timezone : null
quiet : false
verbose : false
defaults : []
liquid:
error_mode : warn
strict_filters : false
strict_variables : false
# Markdown Processors
rdiscount:
extensions : []
redcarpet:
extensions : []
kramdown:
auto_ids : true
entity_output : as_char
toc_levels : 1..6
smart_quotes : lsquo,rsquo,ldquo,rdquo
input : GFM
hard_wrap : false
footnote_nr : 1
show_warnings : false
```

View File

@@ -0,0 +1,49 @@
---
title: Environments
permalink: "/docs/configuration/environments/"
---
In the `build` (or `serve`) arguments, you can specify a Jekyll environment
and value. The build will then apply this value in any conditional statements
in your content.
For example, suppose you set this conditional statement in your code:
{% raw %}
```liquid
{% if jekyll.environment == "production" %}
{% include disqus.html %}
{% endif %}
```
{% endraw %}
When you build your Jekyll site, the content inside the `if` statement won't be
run unless you also specify a `production` environment in the build command,
like this:
```sh
JEKYLL_ENV=production jekyll build
```
Specifying an environment value allows you to make certain content available
only within specific environments.
The default value for `JEKYLL_ENV` is `development`. Therefore if you omit
`JEKYLL_ENV` from the build arguments, the default value will be
`JEKYLL_ENV=development`. Any content inside
{% raw %}`{% if jekyll.environment == "development" %}`{% endraw %} tags will
automatically appear in the build.
Your environment values can be anything you want (not just `development` or
`production`). Some elements you might want to hide in development
environments include Disqus comment forms or Google Analytics. Conversely,
you might want to expose an "Edit me in GitHub" button in a development
environment but not include it in production environments.
By specifying the option in the build command, you avoid having to change
values in your configuration files when moving from one environment to another.
<div class="note info">
<p>
To switch part of your config settings depending on the environment, use the <a href="/docs/configuration/options/#build-command-options">build command option</a>, for example <code>--config _config.yml,_config_development.yml</code>. Settings in later files override settings in earlier files.
</p>
</div>

View File

@@ -0,0 +1,140 @@
---
title: Front Matter Defaults
permalink: "/docs/configuration/front-matter-defaults/"
---
Using [front matter](/docs/front-matter/) is one way that you can specify configuration in the pages and posts for your site. Setting things like a default layout, or customizing the title, or specifying a more precise date/time for the post can all be added to your page or post front matter.
Often times, you will find that you are repeating a lot of configuration options. Setting the same layout in each file, adding the same category - or categories - to a post, etc. You can even add custom variables like author names, which might be the same for the majority of posts on your blog.
Instead of repeating this configuration each time you create a new post or page, Jekyll provides a way to set these defaults in the site configuration. To do this, you can specify site-wide defaults using the `defaults` key in the `_config.yml` file in your project's root directory.
The `defaults` key holds an array of scope/values pairs that define what defaults should be set for a particular file path, and optionally, a file type in that path.
Let's say that you want to add a default layout to all pages and posts in your site. You would add this to your `_config.yml` file:
```yaml
defaults:
-
scope:
path: "" # an empty string here means all files in the project
values:
layout: "default"
```
`_config.yml` is only read when Jekyll first starts. For changes to take effect you'll need to restart Jekyll.
{: .warning }
Here, we are scoping the `values` to any file that exists in the path `scope`. Since the path is set as an empty string, it will apply to **all files** in your project. You probably don't want to set a layout on every file in your project - like css files, for example - so you can also specify a `type` value under the `scope` key.
```yaml
defaults:
-
scope:
path: "" # an empty string here means all files in the project
type: "posts" # previously `post` in Jekyll 2.2.
values:
layout: "default"
```
Now, this will only set the layout for files where the type is `posts`.
The different types that are available to you are `pages`, `posts`, `drafts` or any collection in your site. While `type` is optional, you must specify a value for `path` when creating a `scope/values` pair.
As mentioned earlier, you can set multiple scope/values pairs for `defaults`.
```yaml
defaults:
-
scope:
path: ""
type: "pages"
values:
layout: "my-site"
-
scope:
path: "projects"
type: "pages" # previously `page` in Jekyll 2.2.
values:
layout: "project" # overrides previous default layout
author: "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](/docs/variables/) set to `Mr. Hyde`.
```yaml
collections:
my_collection:
output: true
defaults:
-
scope:
path: ""
type: "my_collection" # a collection in your site, in plural form
values:
layout: "default"
```
In this example, the `layout` is set to `default` inside the
[collection](/docs/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"
```
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.
{: .warning }
### Precedence
Jekyll will apply all of the configuration settings you specify in the `defaults` section of your `_config.yml` file. 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 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:
```yaml
# In _config.yml
...
defaults:
-
scope:
path: "projects"
type: "pages"
values:
layout: "project"
author: "Mr. Hyde"
category: "project"
...
```
```yaml
# In projects/foo_project.md
---
author: "John Smith"
layout: "foobar"
---
The post text goes here...
```
The `projects/foo_project.md` would have the `layout` set to `foobar` instead
of `project` and the `author` set to `John Smith` instead of `Mr. Hyde` when
the site is built.

View File

@@ -0,0 +1,34 @@
---
title: Default Configuration
permalink: "/docs/configuration/incremental-regeneration/"
---
## Incremental Regeneration
While incremental regeneration will work for the most common cases, it will
not work correctly in every scenario. Please be extremely cautious when
using the feature, and report any problems not listed below by
[opening an issue on GitHub](https://github.com/jekyll/jekyll/issues/new).
{: .warning }
Incremental regeneration helps shorten build times by only generating documents
and pages that were updated since the previous build. It does this by keeping
track of both file modification times and inter-document dependencies in the
`.jekyll-metadata` file.
Under the current implementation, incremental regeneration will only generate a
document or page if either it, or one of its dependencies, is modified. Currently,
the only types of dependencies tracked are includes (using the
{% raw %}`{% include %}`{% endraw %} tag) and layouts. This means that plain
references to other documents (for example, the common case of iterating over
`site.posts` in a post listings page) will not be detected as a dependency.
To remedy some of these shortfalls, putting `regenerate: true` in the front-matter
of a document will force Jekyll to regenerate it regardless of whether it has been
modified. Note that this will generate the specified document only; references
to other documents' contents will not work since they won't be re-rendered.
Incremental regeneration can be enabled via the `--incremental` flag (`-I` for
short) from the command-line or by setting `incremental: true` in your
configuration file.

View File

@@ -0,0 +1,18 @@
---
title: Liquid Options
permalink: "/docs/configuration/liquid/"
---
Liquid's response to errors can be configured by setting `error_mode`. The
options are
- `lax` --- Ignore all errors.
- `warn` --- Output a warning on the console for each error.
- `strict` --- Output an error message and stop the build.
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.

View File

@@ -0,0 +1,119 @@
---
title: Markdown Options
permalink: "/docs/configuration/markdown/"
---
The various Markdown renderers supported by Jekyll sometimes have extra options
available.
### Kramdown
Kramdown is the default Markdown renderer for Jekyll. Below is a list of the
currently supported options:
* **auto_id_prefix** - Prefix used for automatically generated header IDs
* **auto_id_stripping** - Strip all formatting from header text for automatic ID generation
* **auto_ids** - Use automatic header ID generation
* **coderay_bold_every** - Defines how often a line number should be made bold
* **coderay_css** - Defines how the highlighted code gets styled
* **coderay_default_lang** - Sets the default language for highlighting code blocks
* **coderay_line_number_start** - The start value for the line numbers
* **coderay_line_numbers** - Defines how and if line numbers should be shown
* **coderay_tab_width** - The tab width used in highlighted code
* **coderay_wrap** - Defines how the highlighted code should be wrapped
* **enable_coderay** - Use coderay for syntax highlighting
* **entity_output** - Defines how entities are output
* **footnote_backlink** - Defines the text that should be used for the footnote backlinks
* **footnote_backlink_inline** - Specifies whether the footnote backlink should always be inline
* **footnote_nr** - The number of the first footnote
* **gfm_quirks** - Enables a set of GFM specific quirks
* **hard_wrap** - Interprets line breaks literally
* **header_offset** - Sets the output offset for headers
* **html_to_native** - Convert HTML elements to native elements
* **line_width** - Defines the line width to be used when outputting a document
* **link_defs** - Pre-defines link definitions
* **math_engine** - Set the math engine
* **math_engine_opts** - Set the math engine options
* **parse_block_html** - Process kramdown syntax in block HTML tags
* **parse_span_html** - Process kramdown syntax in span HTML tags
* **smart_quotes** - Defines the HTML entity names or code points for smart quote output
* **syntax_highlighter** - Set the syntax highlighter
* **syntax_highlighter_opts** - Set the syntax highlighter options
* **toc_levels** - Defines the levels that are used for the table of contents
* **transliterated_header_ids** - Transliterate the header text before generating the ID
* **typographic_symbols** - Defines a mapping from typographical symbol to output characters
Please note that both `remove_block_html_tags` and
`remove_span_html_tags` are currently unsupported in Jekyll due
to the fact that they are not included within the kramdown HTML converter.
{: .warning }
For more details about these options have a look at the [Kramdown configuration documentation](https://kramdown.gettalong.org/options.html).
### Redcarpet
Redcarpet can be configured by providing an `extensions` sub-setting, whose
value should be an array of strings. Each string should be the name of one of
the `Redcarpet::Markdown` class's extensions; if present in the array, it will
set the corresponding extension to `true`.
Jekyll handles two special Redcarpet extensions:
- `no_fenced_code_blocks` --- By default, Jekyll sets the `fenced_code_blocks`
extension (for delimiting code blocks with triple tildes or triple backticks)
to `true`, probably because GitHub's eager adoption of them is starting to make
them inescapable. Redcarpet's normal `fenced_code_blocks` extension is inert
when used with Jekyll; instead, you can use this inverted version of the
extension for disabling fenced code.
Note that you can also specify a language for highlighting after the first
delimiter:
```ruby
# ...ruby code
```
With both fenced code blocks and highlighter enabled, this will statically
highlight the code; without any syntax highlighter, it will add a
`class="LANGUAGE"` attribute to the `<code>` element, which can be used as a
hint by various JavaScript code highlighting libraries.
- `smart` --- This pseudo-extension turns on SmartyPants, which converts
straight quotes to curly quotes and runs of hyphens to em (`---`) and en (`--`) dashes.
All other extensions retain their usual names from Redcarpet, and no renderer
options aside from `smart` can be specified in Jekyll. [A list of available
extensions can be found in the Redcarpet README file.](https://github.com/vmg/redcarpet/blob/v3.2.2/README.markdown#and-its-like-really-simple-to-use)
Make sure you're looking at the README for the right version of
Redcarpet: Jekyll currently uses v3.2.x. The most commonly used
extensions are:
- `tables`
- `no_intra_emphasis`
- `autolink`
### Custom Markdown Processors
If you're interested in creating a custom markdown processor, you're in luck! Create a new class in the `Jekyll::Converters::Markdown` namespace:
```ruby
class Jekyll::Converters::Markdown::MyCustomProcessor
def initialize(config)
require 'funky_markdown'
@config = config
rescue LoadError
STDERR.puts 'You are missing a library required for Markdown. Please run:'
STDERR.puts ' $ [sudo] gem install funky_markdown'
raise FatalException.new("Missing dependency: funky_markdown")
end
def convert(content)
::FunkyMarkdown.new(content).convert
end
end
```
Once you've created your class and have it properly set up either as a plugin
in the `_plugins` folder or as a gem, specify it in your `_config.yml`:
```yaml
markdown: MyCustomProcessor
```

View File

@@ -0,0 +1,388 @@
---
title: Configuration Options
permalink: "/docs/configuration/options/"
---
The tables below list the available settings for Jekyll, and the various <code
class="option">options</code> (specified in the configuration file) and <code
class="flag">flags</code> (specified on the command-line) that control them.
Remember, configuration files are YAML so use spaces for indention not tabs.
### Global Configuration
<div class="mobile-side-scroller">
<table>
<thead>
<tr>
<th>Setting</th>
<th>
<span class="option">Options</span> and <span class="flag">Flags</span>
</th>
</tr>
</thead>
<tbody>
<tr class="setting">
<td>
<p class="name"><strong>Site Source</strong></p>
<p class="description">Change the directory where Jekyll will read files</p>
</td>
<td class="align-center">
<p><code class="option">source: DIR</code></p>
<p><code class="flag">-s, --source DIR</code></p>
</td>
</tr>
<tr class="setting">
<td>
<p class="name"><strong>Site Destination</strong></p>
<p class="description">Change the directory where Jekyll will write files. Files or folders in this directory that are not created by your site will be removed. Some files could be retained
by specifying them within the <code>&lt;keep_files&gt;</code> configuration directive.</p>
</td>
<td class="align-center">
<p><code class="option">destination: DIR</code></p>
<p><code class="flag">-d, --destination DIR</code></p>
</td>
</tr>
<tr class="setting">
<td>
<p class="name"><strong>Safe</strong></p>
<p class="description">Disable <a href="/docs/plugins/">custom plugins, and ignore symbolic links</a>.</p>
</td>
<td class="align-center">
<p><code class="option">safe: BOOL</code></p>
<p><code class="flag">--safe</code></p>
</td>
</tr>
<tr class="setting">
<td>
<p class="name"><strong>Exclude</strong></p>
<p class="description">
Exclude directories and/or files from the
conversion. These exclusions are relative to the site's
source directory and cannot be outside the source directory.
</p>
</td>
<td class="align-center">
<p><code class="option">exclude: [DIR, FILE, ...]</code></p>
</td>
</tr>
<tr class="setting">
<td>
<p class="name"><strong>Include</strong></p>
<p class="description">
Force inclusion of directories and/or files in the conversion.
<code>.htaccess</code> is a good example since dotfiles are excluded
by default.
</p>
</td>
<td class="align-center">
<p><code class="option">include: [DIR, FILE, ...]</code></p>
</td>
</tr>
<tr class="setting">
<td>
<p class="name"><strong>Keep files</strong></p>
<p class="description">
When clobbering the site destination, keep the selected files.
Useful for files that are not generated by jekyll; e.g. files or
assets that are generated by your build tool.
The paths are relative to the <code>destination</code>.
</p>
</td>
<td class="align-center">
<p><code class="option">keep_files: [DIR, FILE, ...]</code></p>
</td>
</tr>
<tr class="setting">
<td>
<p class="name"><strong>Time Zone</strong></p>
<p class="description">
Set the time zone for site generation. This sets the <code>TZ</code>
environment variable, which Ruby uses to handle time and date
creation and manipulation. Any entry from the
<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>. 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">
<p><code class="option">timezone: TIMEZONE</code></p>
</td>
</tr>
<tr class="setting">
<td>
<p class="name"><strong>Encoding</strong></p>
<p class="description">
Set the encoding of files by name (only available for Ruby
1.9 or later).
The default value is <code>utf-8</code> starting in 2.0.0,
and <code>nil</code> before 2.0.0, which will yield the Ruby
default of <code>ASCII-8BIT</code>.
</p>
</td>
<td class="align-center">
<p><code class="option">encoding: ENCODING</code></p>
</td>
</tr>
<tr>
<td>
<p class='name'><strong>Defaults</strong></p>
<p class='description'>
Set defaults for <a href="/docs/front-matter/" title="front matter">front matter</a>
variables.
</p>
</td>
<td class='align-center'>
<p>see <a href="/docs/configuration/front-matter-defaults/" title="details">below</a></p>
</td>
</tr>
</tbody>
</table>
</div>
### Build Command Options
<div class="mobile-side-scroller">
<table>
<thead>
<tr>
<th>Setting</th>
<th><span class="option">Options</span> and <span class="flag">Flags</span></th>
</tr>
</thead>
<tbody>
<tr class="setting">
<td>
<p class="name"><strong>Regeneration</strong></p>
<p class="description">Enable auto-regeneration of the site when files are modified.</p>
</td>
<td class="align-center">
<p><code class="flag">-w, --[no-]watch</code></p>
</td>
</tr>
<tr class="setting">
<td>
<p class="name"><strong>Configuration</strong></p>
<p class="description">Specify config files instead of using <code>_config.yml</code> automatically. Settings in later files override settings in earlier files.</p>
</td>
<td class="align-center">
<p><code class="flag">--config FILE1[,FILE2,...]</code></p>
</td>
</tr>
<tr class="setting">
<td>
<p class="name"><strong>Drafts</strong></p>
<p class="description">Process and render draft posts.</p>
</td>
<td class="align-center">
<p><code class="option">show_drafts: BOOL</code></p>
<p><code class="flag">--drafts</code></p>
</td>
</tr>
<tr class="setting">
<td>
<p class="name"><strong>Environment</strong></p>
<p class="description">Use a specific environment value in the build.</p>
</td>
<td class="align-center">
<p><code class="flag">JEKYLL_ENV=production</code></p>
</td>
</tr>
<tr class="setting">
<td>
<p class="name"><strong>Future</strong></p>
<p class="description">Publish posts or collection documents with a future date.</p>
</td>
<td class="align-center">
<p><code class="option">future: BOOL</code></p>
<p><code class="flag">--future</code></p>
</td>
</tr>
<tr class="setting">
<td>
<p class="name"><strong>Unpublished</strong></p>
<p class="description">Render posts that were marked as unpublished.</p>
</td>
<td class="align-center">
<p><code class="option">unpublished: BOOL</code></p>
<p><code class="flag">--unpublished</code></p>
</td>
</tr>
<tr class="setting">
<td>
<p class="name"><strong>LSI</strong></p>
<p class="description">Produce an index for related posts. Requires the <a href="http://www.classifier-reborn.com/">classifier-reborn</a> plugin.</p>
</td>
<td class="align-center">
<p><code class="option">lsi: BOOL</code></p>
<p><code class="flag">--lsi</code></p>
</td>
</tr>
<tr class="setting">
<td>
<p class="name"><strong>Limit Posts</strong></p>
<p class="description">Limit the number of posts to parse and publish.</p>
</td>
<td class="align-center">
<p><code class="option">limit_posts: NUM</code></p>
<p><code class="flag">--limit_posts NUM</code></p>
</td>
</tr>
<tr class="setting">
<td>
<p class="name"><strong>Force polling</strong></p>
<p class="description">Force watch to use polling.</p>
</td>
<td class="align-center">
<p><code class="flag">--force_polling</code></p>
</td>
</tr>
<tr class="setting">
<td>
<p class="name"><strong>Verbose output</strong></p>
<p class="description">Print verbose output.</p>
</td>
<td class="align-center">
<p><code class="flag">-V, --verbose</code></p>
</td>
</tr>
<tr class="setting">
<td>
<p class="name"><strong>Silence Output</strong></p>
<p class="description">Silence the normal output from Jekyll
during a build</p>
</td>
<td class="align-center">
<p><code class="flag">-q, --quiet</code></p>
</td>
</tr>
<tr class="setting">
<td>
<p class="name"><strong>Incremental build</strong></p>
<p class="description">
Enable the experimental incremental build feature. Incremental build only
re-builds posts and pages that have changed, resulting in significant performance
improvements for large sites, but may also break site generation in certain
cases.
</p>
</td>
<td class="align-center">
<p><code class="option">incremental: BOOL</code></p>
<p><code class="flag">-I, --incremental</code></p>
</td>
</tr>
<tr class="setting">
<td>
<p class="name"><strong>Liquid profiler</strong></p>
<p class="description">
Generate a Liquid rendering profile to help you identify performance bottlenecks.
</p>
</td>
<td class="align-center">
<p><code class="option">profile: BOOL</code></p>
<p><code class="flag">--profile</code></p>
</td>
</tr>
<tr class="setting">
<td>
<p class="name"><strong>Strict Front Matter</strong></p>
<p class="description">
Cause a build to fail if there is a YAML syntax error in a page's front matter.
</p>
</td>
<td class="align-center">
<p><code class="option">strict_front_matter: BOOL</code></p>
<p><code class="flag">--strict_front_matter</code></p>
</td>
</tr>
</tbody>
</table>
</div>
### Serve Command Options
In addition to the options below, the `serve` sub-command can accept any of the options
for the `build` sub-command, which are then applied to the site build which occurs right
before your site is served.
<div class="mobile-side-scroller">
<table>
<thead>
<tr>
<th>Setting</th>
<th><span class="option">Options</span> and <span class="flag">Flags</span></th>
</tr>
</thead>
<tbody>
<tr class="setting">
<td>
<p class="name"><strong>Local Server Port</strong></p>
<p class="description">Listen on the given port.</p>
</td>
<td class="align-center">
<p><code class="option">port: PORT</code></p>
<p><code class="flag">--port PORT</code></p>
</td>
</tr>
<tr class="setting">
<td>
<p class="name"><strong>Local Server Hostname</strong></p>
<p class="description">Listen at the given hostname.</p>
</td>
<td class="align-center">
<p><code class="option">host: HOSTNAME</code></p>
<p><code class="flag">--host HOSTNAME</code></p>
</td>
</tr>
<tr class="setting">
<td>
<p class="name"><strong>Base URL</strong></p>
<p class="description">Serve the website from the given base URL</p>
</td>
<td class="align-center">
<p><code class="option">baseurl: URL</code></p>
<p><code class="flag">--baseurl URL</code></p>
</td>
</tr>
<tr class="setting">
<td>
<p class="name"><strong>Detach</strong></p>
<p class="description">Detach the server from the terminal</p>
</td>
<td class="align-center">
<p><code class="option">detach: BOOL</code></p>
<p><code class="flag">-B, --detach</code></p>
</td>
</tr>
<tr class="setting">
<td>
<p class="name"><strong>Skips the initial site build.</strong></p>
<p class="description">Skips the initial site build which occurs before the server is started.</p>
</td>
<td class="align-center">
<p><code class="flag">--skip-initial-build</code></p>
</td>
</tr>
<tr class="setting">
<td>
<p class="name"><strong>X.509 (SSL) Private Key</strong></p>
<p class="description">SSL Private Key.</p>
</td>
<td class="align-center">
<p><code class="flag">--ssl-key</code></p>
</td>
</tr>
<tr class="setting">
<td>
<p class="name"><strong>X.509 (SSL) Certificate</strong></p>
<p class="description">SSL Public certificate.</p>
</td>
<td class="align-center">
<p><code class="flag">--ssl-cert</code></p>
</td>
</tr>
</tbody>
</table>
</div>

View File

@@ -0,0 +1,20 @@
---
title: WEBrick Options
permalink: "/docs/configuration/webrick/"
---
You can provide custom headers for your site by adding them to `_config.yml`
```yaml
# File: _config.yml
webrick:
headers:
My-Header: My-Value
My-Other-Header: My-Other-Value
```
### Defaults
Jekyll provides by default `Content-Type` and `Cache-Control` response
headers: one dynamic in order to specify the nature of the data being served,
the other static in order to disable caching so that you don't have to fight
with Chrome's aggressive caching when you are in development mode.

View File

@@ -0,0 +1,60 @@
---
title: "Buddy"
---
[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.
[buddy-homepage]: https://buddy.works
[docker-homepage]: https://www.docker.com/
[github-homepage]: https://github.com
[bitbucket-homepage]: https://bitbucket.org/
[gitlab-homepage]: https://gitlab.com
## 1. Getting started
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
## 2. How it works
Whenever you make a push to the selected branch, the Jekyll action runs `jekyll build` in an isolated [Jekyll Docker image][jekyll-docker-image]. The output is generated to the `/filesystem` directory, and can be further deployed to FTP/SFTP and IaaS services. You can add your own commands, install additional packages, attach services, and run Selenium tests, as well as add other actions down the pipeline, eg. a Slack notification or an SSH script that will restart your server.
[jekyll-docker-image]: https://hub.docker.com/r/jekyll/jekyll/
## 3. Using YAML for configuration
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:
```yaml
- pipeline: "Build and Deploy Jekyll site"
trigger_mode: "ON_EVERY_PUSH"
ref_name: "master"
actions:
- action: "Execute: jekyll build"
type: "BUILD"
docker_image_name: "jekyll/jekyll"
docker_image_tag: "latest"
execute_commands:
- "chown jekyll:jekyll $WORKING_DIR"
- "jekyll build"
```
## 4. Setting up on-premises server
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
[bw-aws-ec2]: https://buddy.works/knowledge/standalone/installation-amazon-ec2
[bw-digitalocean]: https://buddy.works/knowledge/standalone/installation-digitalocean
[bw-azure]: https://buddy.works/knowledge/standalone/installation-azure
## 5. Questions?
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-buddy]: https://github.com/jekyll/jekyll/edit/master/docs/_docs/continuous-integration/buddyworks.md
[jekyll-help]: https://jekyllrb.com/help/
[buddy-forum]: http://forum.buddy.works/

View File

@@ -12,7 +12,7 @@ Building, testing, and deploying your Jekyll-generated website can quickly be do
To start building your project on CircleCI, all you need to do is 'follow' your project from CircleCI's website:
1. Visit the 'Add Projects' page: <https://circleci.com/add-projects>
1. Visit the 'Add Projects' page
1. From the GitHub or Bitbucket tab on the left, choose a user or organization.
1. Find your project in the list and click 'Build project' on the right.
1. The first build will start on its own. You can start telling CircleCI how to build your project by creating a [circle.yml][3] file in the root of your repository.
@@ -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'
@@ -38,9 +38,9 @@ CircleCI detects when `Gemfile` is present is will automatically run `bundle ins
## 3. Testing
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.
The most basic test that can be run is 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

@@ -1,9 +0,0 @@
---
title: Continuous Integration
permalink: /docs/continuous-integration/
---
Continuous Integration (CI) enables you to publish your Jekyll generated website with confidence by automating the quality assurance and deployment processes. You can quickly get started using CI with one of the providers below:
* [Travis CI](travis-ci)
* [CircleCI](circleci)

View File

@@ -2,7 +2,7 @@
title: "Travis CI"
---
You can easily test your website build against one or more versions of Ruby.
You can test your website build against one or more versions of Ruby.
The following guide will show you how to set up a free build environment on
[Travis][travis], with [GitHub][github] integration for pull requests.
@@ -11,18 +11,17 @@ The following guide will show you how to set up a free build environment on
## 1. Enabling Travis and GitHub
Enabling Travis builds for your GitHub repository is pretty simple:
To enable Travis builds for your GitHub repository:
1. Go to your profile on travis-ci.org: https://travis-ci.org/profile/username
2. Find the repository for which you're interested in enabling builds.
3. Click the slider on the right so it says "ON" and is a dark grey.
3. Flick the repository switch on so that it turns blue.
4. Optionally configure the build by clicking on the gear icon. Further
configuration happens in your `.travis.yml` file. More details on that
below.
configuration happens via your `.travis.yml` file. More details below.
## 2. The Test Script
The simplest test script simply runs `jekyll build` and ensures that Jekyll
The simplest test script runs `jekyll build` and ensures that Jekyll
doesn't fail to build the site. It doesn't check the resulting site, but it
does ensure things are built properly.
@@ -50,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
@@ -77,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"
@@ -91,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,7 +109,18 @@ env:
global:
- NOKOGIRI_USE_SYSTEM_LIBRARIES=true # speeds up installation of html-proofer
addons:
apt:
packages:
- libcurl4-openssl-dev
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:
@@ -124,12 +134,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:
@@ -211,6 +222,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
@@ -228,3 +256,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
@@ -32,7 +29,7 @@ Whether you're a developer, a designer, or just a Jekyll devotee, there are lots
* The more information, the better. Make judicious use of the pull request body. Describe what changes were made, why you made them, and what impact they will have for users.
* Pull request are easy and fun. If this is your first pull request, it may help to [understand GitHub Flow](https://guides.github.com/introduction/flow/).
* If this is your first pull request, it may help to [understand GitHub Flow](https://guides.github.com/introduction/flow/).
* If you're submitting a code contribution, be sure to read the [code contributions](#code-contributions) section below.
@@ -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

@@ -18,9 +18,8 @@ Plugins/themes can also leverage Data Files to set configuration variables.
## The Data Folder
As explained on the [directory structure](../structure/) page, the `_data`
folder is where you can store additional data for Jekyll to use when generating
your site. These files must be YAML, JSON, or CSV files (using either
The `_data` folder is where you can store additional data for Jekyll to use when
generating your site. These files must be YAML, JSON, or CSV files (using either
the `.yml`, `.yaml`, `.json` or `.csv` extension), and they will be
accessible via `site.data`.
@@ -56,8 +55,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,10 +66,10 @@ You can now render the list of members in a template:
</li>
{% endfor %}
</ul>
{% endraw %}
```
{% endraw %}
## Example: Organizations
## Subfolders
Data files can also be placed in sub-folders of the `_data` folder. Each folder
level will be added to a variable's namespace. The example below shows how
@@ -103,8 +102,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] %}
@@ -116,8 +115,8 @@ file name:
</li>
{% endfor %}
</ul>
{% endraw %}
```
{% endraw %}
## Example: Accessing a specific author
@@ -131,10 +130,10 @@ dave:
twitter: DavidSilvaSmith
```
The author can then be specified as a page variable in a post's frontmatter:
The author can then be specified as a page variable in a post's front matter:
```html
{% raw %}
```liquid
---
title: sample post
author: dave
@@ -146,6 +145,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

@@ -1,208 +0,0 @@
---
title: Deployment methods
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.
## 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 generated `_site` folder to the root folder of your hosting account. This is most likely to be the `httpdocs` or `public_html` folder on most hosting providers.
## Self-managed web server
If you have direct access to the deployment web server, the process is essentially the same, except you might have other methods available to you (such as `scp`, or even direct filesystem access) for transferring the files. Just remember to make sure the contents of the generated `_site` folder get placed in the appropriate web root directory for your web server.
## Automated methods
There are also a number of ways to easily automate the deployment of a Jekyll site. If youve got another method that isnt listed below, wed love it if you [contributed](../contributing/) so that everyone else can benefit too.
### Git post-update hook
If you store your Jekyll site in [Git](https://git-scm.com/) (you are using
version control, right?), its pretty easy to automate the
deployment process by setting up a post-update hook in your Git
repository, [like
this](http://web.archive.org/web/20091223025644/http://www.taknado.com/en/2009/03/26/deploying-a-jekyll-generated-site/).
### Git post-receive hook
To have a remote server handle the deploy for you every time you push changes using Git, you can create a user account which has all the public keys that are authorized to deploy in its `authorized_keys` file. With that in place, setting up the post-receive hook is done as follows:
```sh
laptop$ ssh deployer@example.com
server$ mkdir myrepo.git
server$ cd myrepo.git
server$ git --bare init
server$ cp hooks/post-receive.sample hooks/post-receive
server$ mkdir /var/www/myrepo
```
Next, add the following lines to hooks/post-receive and be sure Jekyll is
installed on the server:
```sh
GIT_REPO=$HOME/myrepo.git
TMP_GIT_CLONE=$HOME/tmp/myrepo
PUBLIC_WWW=/var/www/myrepo
git clone $GIT_REPO $TMP_GIT_CLONE
jekyll build -s $TMP_GIT_CLONE -d $PUBLIC_WWW
rm -Rf $TMP_GIT_CLONE
exit
```
Finally, run the following command on any users laptop that needs to be able to
deploy using this hook:
```sh
laptops$ git remote add deploy deployer@example.com:~/myrepo.git
```
Deploying is now as easy as telling nginx or Apache to look at
`/var/www/myrepo` and running the following:
```sh
laptops$ git push deploy master
```
### Static Publisher
[Static Publisher](https://github.com/static-publisher/static-publisher) is another automated deployment option with a server listening for webhook posts, though it's not tied to GitHub specifically. It has a one-click deploy to Heroku, it can watch multiple projects from one server, it has an easy to user admin interface and can publish to either S3 or to a git repository (e.g. gh-pages).
### Rake
Another way to deploy your Jekyll site is to use [Rake](https://github.com/ruby/rake), [HighLine](https://github.com/JEG2/highline), and
[Net::SSH](https://github.com/net-ssh/net-ssh). A more complex example of deploying Jekyll with Rake that deals with multiple branches can be found in [Git Ready](https://github.com/gitready/gitready/blob/cdfbc4ec5321ff8d18c3ce936e9c749dbbc4f190/Rakefile).
### scp
Once youve generated the `_site` directory, you can easily scp it using a
`tasks/deploy` shell script similar to [this deploy script][]. Youd obviously
need to change the values to reflect your sites details. There is even [a
matching TextMate command][] that will help you run this script.
[this deploy script]: https://github.com/henrik/henrik.nyh.se/blob/master/script/deploy
[a matching TextMate command]: https://gist.github.com/henrik/214959
### rsync
Once youve generated the `_site` directory, you can easily rsync it using a `tasks/deploy` shell script similar to [this deploy script here](https://github.com/vitalyrepin/vrepinblog/blob/master/transfer.sh). Youd obviously need to change the values to reflect your sites details.
Certificate-based authorization is another way to simplify the publishing
process. It makes sense to restrict rsync access only to the directory which it is supposed to sync. This can be done using rrsync.
#### Step 1: Install rrsync to your home folder (server-side)
If it is not already installed by your host, you can do it yourself:
- [Download rrsync](https://ftp.samba.org/pub/unpacked/rsync/support/rrsync)
- Place it in the `bin` subdirectory of your home folder (`~/bin`)
- Make it executable (`chmod +x`)
#### Step 2: Set up certificate-based SSH access (server side)
This [process](https://wiki.gentoo.org/wiki/SSH#Passwordless_Authentication) is
described in several places online. What is different from the typical approach
is to put the restriction to certificate-based authorization in
`~/.ssh/authorized_keys`. Then, launch `rrsync` and supply
it with the folder it shall have read-write access to:
```sh
command="$HOME/bin/rrsync <folder>",no-agent-forwarding,no-port-forwarding,no-pty,no-user-rc,no-X11-forwarding ssh-rsa <cert>
```
`<folder>` is the path to your site. E.g., `~/public_html/you.org/blog-html/`.
#### Step 3: Rsync (client-side)
Add the `deploy` script to the site source folder:
```sh
#!/bin/sh
rsync -crvz --rsh='ssh -p2222' --delete-after --delete-excluded <folder> <user>@<site>:
```
Command line parameters are:
- `--rsh=ssh -p2222` &mdash; The port for SSH access. It is required if
your host uses a different port than the default (e.g, HostGator)
- `<folder>` &mdash; The name of the local output folder (defaults to `_site`)
- `<user>` &mdash; The username for your hosting account
- `<site>` &mdash; Your hosting server
Using this setup, you might run the following command:
```sh
rsync -crvz --rsh='ssh -p2222' --delete-after --delete-excluded _site/ hostuser@example.org:
```
Don't forget the column `:` after server name!
#### Step 4 (Optional): Exclude the transfer script from being copied to the output folder.
This step is recommended if you use these instructions to deploy your site. If
you put the `deploy` script in the root folder of your project, Jekyll will
copy it to the output folder. This behavior can be changed in `_config.yml`.
Just add the following line:
```yaml
# Do not copy these files to the output directory
exclude: ["deploy"]
```
Alternatively, you can use an `rsync-exclude.txt` file to control which files will be transferred to your server.
#### Done!
Now it's possible to publish your website simply by running the `deploy`
script. If your SSH certificate is [passphrase-protected](https://martin.kleppmann.com/2013/05/24/improving-security-of-ssh-private-keys.html), you will be asked to enter it when the
script executes.
## Rack-Jekyll
[Rack-Jekyll](https://github.com/adaoraul/rack-jekyll/) is an easy way to deploy your site on any Rack server such as Amazon EC2, Slicehost, Heroku, and so forth. It also can run with [shotgun](https://github.com/rtomayko/shotgun/), [rackup](https://github.com/rack/rack), [mongrel](https://github.com/mongrel/mongrel), [unicorn](https://github.com/defunkt/unicorn/), and [others](https://github.com/adaoraul/rack-jekyll#readme).
Read [this post](http://andycroll.com/ruby/serving-a-jekyll-blog-using-heroku/) on how to deploy to Heroku using Rack-Jekyll.
## Jekyll-Admin for Rails
If you want to maintain Jekyll inside your existing Rails app, [Jekyll-Admin](https://github.com/zkarpinski/Jekyll-Admin) contains drop in code to make this possible. See Jekyll-Admins [README](https://github.com/zkarpinski/Jekyll-Admin/blob/master/README) for more details.
## Amazon S3
If you want to host your site in Amazon S3, you can do so by
using the [s3_website](https://github.com/laurilehmijoki/s3_website)
application. It will push your site to Amazon S3 where it can be served like
any web server,
dynamically scaling to almost unlimited traffic. This approach has the
benefit of being about the cheapest hosting option available for
low-volume blogs as you only pay for what you use.
## OpenShift
If you'd like to deploy your site to an OpenShift gear, there's [a cartridge
for that](https://github.com/openshift-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) is an add-on for Bitbucket that brings GitHub Pages style functionality to Bitbucket users. It includes continuous deployment, custom domains with a wildcard SSL cert, CDN, basic auth, and staging branches all in the box.
Automating the build and deployment of a Jekyll site is just as simple as GitHub Pages - push your changes to your repo (excluding the `_site` directory) and within seconds a build will be triggered and your built site deployed to our highly- available, globally distributed hosting service. The build process will even install and execute custom Ruby plugins. See our [Jekyll docs](https://www.aerobatic.com/docs/static-generators#jekyll) for more details.

11
docs/_docs/deployment.md Normal file
View File

@@ -0,0 +1,11 @@
---
title: Deployment
permalink: /docs/deployment/
redirect_from: "/docs/deployment-methods/index.html"
---
Sites built using Jekyll can be deployed in a large number of ways due to the static nature of the generated output. Here's some of the most common ways:
* [Manually](/docs/deployment/manual/)
* [Automated](/docs/deployment/automated/)
* [Third Party](/docs/deployment/third-party/)

View File

@@ -0,0 +1,63 @@
---
title: Automated Deployment
permalink: /docs/deployment/automated/
---
There are a number of ways to easily automate the deployment of a Jekyll site.
## Continuous Integration Service
One of the easiest ways to set up an automated deployment flow is by using a
CI.
These services run a script when there's a commit on your Git repository.
You might want this script to build the site, run tests over the output then deploy it to the
service of your choice.
We have guides for the following providers:
* [Travis CI](/docs/continuous-integration/travis-ci/)
* [CircleCI](/docs/continuous-integration/circleci/)
* [Buddy](/docs/continuous-integration/buddyworks/)
## Git post-receive hook
To have a remote server handle the deploy for you every time you push changes using Git, you can create a user account which has all the public keys that are authorized to deploy in its `authorized_keys` file. With that in place, setting up the post-receive hook is done as follows:
```sh
laptop$ ssh deployer@example.com
server$ mkdir myrepo.git
server$ cd myrepo.git
server$ git --bare init
server$ cp hooks/post-receive.sample hooks/post-receive
server$ mkdir /var/www/myrepo
```
Next, add the following lines to hooks/post-receive and be sure Jekyll is
installed on the server:
```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
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
```
Finally, run the following command on any users laptop that needs to be able to
deploy using this hook:
```sh
laptops$ git remote add deploy deployer@example.com:~/myrepo.git
```
Deploying is now as easy as telling nginx or Apache to look at
`/var/www/myrepo` and running the following:
```sh
laptops$ git push deploy master
```

View File

@@ -0,0 +1,37 @@
---
title: Manual Deployment
permalink: /docs/deployment/manual/
---
Jekyll generates your static site to the `_site` directory by default. You can
transfer the contents of this directory to almost any hosting provider to get
your site live. Here are some manual ways of achieving this:
## rsync
Rsync is similar to scp except it can be faster as it will only send changed
parts of files as opposed to the entire file. You can learn more about using
rsync in the [Digital Ocean tutorial](https://www.digitalocean.com/community/tutorials/how-to-use-rsync-to-sync-local-and-remote-directories-on-a-vps).
## Amazon S3
If you want to host your site in Amazon S3, you can do so by
using the [s3_website](https://github.com/laurilehmijoki/s3_website)
application. It will push your site to Amazon S3 where it can be served like
any web server,
dynamically scaling to almost unlimited traffic. This approach has the
benefit of being about the cheapest hosting option available for
low-volume blogs as you only pay for what you use.
## FTP
Most traditional web hosting provider let you upload files to their servers over FTP. To upload a Jekyll site to a web host using FTP, 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.
## scp
If you have direct access to the deployment web server, the process is essentially the same, except you might have other methods available to you (such as `scp`, or even direct filesystem access) for transferring the files. Remember to make sure the contents of the generated `_site` folder get placed in the appropriate web root directory for your web server.
## Rack-Jekyll
[Rack-Jekyll](https://github.com/adaoraul/rack-jekyll/) allows you to deploy your site on any Rack server such as Amazon EC2, Slicehost, Heroku, and so forth. It also can run with [shotgun](https://github.com/rtomayko/shotgun/), [rackup](https://github.com/rack/rack), [mongrel](https://github.com/mongrel/mongrel), [unicorn](https://github.com/defunkt/unicorn/), and [others](https://github.com/adaoraul/rack-jekyll#readme).

View File

@@ -0,0 +1,39 @@
---
title: 3rd Party
permalink: /docs/deployment/third-party/
---
## 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.
## CloudCannon
[CloudCannon](https://cloudcannon.com) has everything you need to build, host
and update Jekyll websites. Take advantage of our global CDN, automated SSL,
continuous deployment and [more](https://cloudcannon.com/features/).
## GitHub Pages
Sites on 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 [host your Jekyll-powered website for free](/docs/github-pages/).
## Kickster
Use [Kickster](http://kickster.nielsenramon.com/) for 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.
Install the Kickster 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).
## 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.
## Static Publisher
[Static Publisher](https://github.com/static-publisher/static-publisher) is another automated deployment option with a server listening for webhook posts, though it's not tied to GitHub specifically. It has a one-click deploy to Heroku, it can watch multiple projects from one server, it has an easy to user admin interface and can publish to either S3 or to a git repository (e.g. gh-pages).

View File

@@ -1,19 +0,0 @@
---
title: Working with drafts
permalink: /docs/drafts/
---
Drafts are posts without a date. 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:
```text
|-- _drafts/
| |-- a-draft-post.md
```
To preview your site with drafts, simply run `jekyll serve` or `jekyll build`
with the `--drafts` switch. Each will be assigned the value modification time
of the draft file for its date, and thus you will see currently edited drafts
as the latest posts.

View File

@@ -1,21 +0,0 @@
---
title: Extras
permalink: /docs/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.
## Math Support
Kramdown comes with optional support for LaTeX to PNG rendering via [MathJax](https://www.mathjax.org) within math blocks. See the Kramdown documentation on [math blocks](http://kramdown.gettalong.org/syntax.html#math-blocks) and [math support](http://kramdown.gettalong.org/converter/html.html#math-support) for more details. MathJax requires you to include JavaScript or CSS to render the LaTeX, e.g.
```html
<script src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML" type="text/javascript"></script>
```
For more information about getting started, check out [this excellent blog post](http://gastonsanchez.com/visually-enforced/opinion/2014/02/16/Mathjax-with-jekyll/).
## Alternative Markdown Processors
See the Markdown section on the [configuration page](/docs/configuration/#markdown-options) for instructions on how to use and configure alternative Markdown processors, as well as how to create [custom processors](/docs/configuration/#custom-markdown-processors).

View File

@@ -1,13 +1,13 @@
---
title: Front Matter
permalink: /docs/frontmatter/
permalink: /docs/front-matter/
redirect_from: /docs/frontmatter/index.html
---
The front matter is where Jekyll starts to get really cool. Any file that
contains a [YAML](http://yaml.org/) front matter block will be processed by
Jekyll as a special file. The front matter must be the first thing in the file
and must take the form of valid YAML set between triple-dashed lines. Here is a
basic example:
Any file that contains a [YAML](http://yaml.org/) front matter block will be
processed by Jekyll as a special file. The front matter must be the first thing
in the file and must take the form of valid YAML set between triple-dashed
lines. Here is a basic example:
```yaml
---
@@ -22,25 +22,16 @@ then be available to you to access using Liquid tags both further down in the
file and also in any layouts or includes that the page or post in question
relies on.
<div class="note warning">
<h5>UTF-8 Character Encoding Warning</h5>
<p>
If you use UTF-8 encoding, make sure that no <code>BOM</code> header
characters exist in your files or very, very bad things will happen to
Jekyll. This is especially relevant if youre running
<a href="../windows/">Jekyll on Windows</a>.
</p>
</div>
If you want to use [Liquid tags and variables](/docs/variables/)
but dont need anything in your front matter, just leave it empty. The set
of triple-dashed lines with nothing in between will still get Jekyll to
process your file. (This is useful for things like CSS and RSS feeds)
If you use UTF-8 encoding, make sure that no `BOM` header
characters exist in your files or very, very bad things will happen to
Jekyll. This is especially relevant if youre running
<a href="">[Jekyll on Windows](/docs/installation/windows/).
<div class="note">
<h5>ProTip™: Front Matter Variables Are Optional</h5>
<p>
If you want to use <a href="../variables/">Liquid tags and variables</a>
but dont need anything in your front matter, just leave it empty! The set
of triple-dashed lines with nothing in between will still get Jekyll to
process your file. (This is useful for things like CSS and RSS feeds!)
</p>
</div>
## Predefined Global Variables
@@ -68,6 +59,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. This is overridden if the file is a post/document and has a
layout defined in the <a href="/docs/configuration/front-matter-defaults/">
front matter 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 front matter defaults.
Using <code>none</code> in a page will cause Jekyll to attempt to
use a layout named "none".
</li>
</ul>
</td>
</tr>
<tr>
@@ -91,7 +96,8 @@ front matter of a page or post.
<td>
<p>
Set to false if you dont want a specific post to show up when the
site is generated.
site is generated. To preview unpublished pages, run `jekyll serve`
or `jekyll build` with the `--unpublished` switch.
</p>
</td>
</tr>
@@ -99,23 +105,20 @@ front matter of a page or post.
</table>
</div>
## Custom Variables
Any variables in the front matter that are not predefined are mixed into the
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:
You can also set your own front matter variables you can access in Liquid. For
instance, if you set a variable called `food`, you can use that in your page:
```html
<!DOCTYPE HTML>
<html>
<head>
<title>{% raw %}{{ page.title }}{% endraw %}</title>
</head>
<body>
...
{% raw %}
```liquid
---
food: Pizza
---
<h1>{{ page.food }}</h1>
```
{% endraw %}
## Predefined Variables for Posts
@@ -145,7 +148,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>
@@ -180,12 +183,6 @@ These are available out-of-the-box to be used in the front matter for a post.
</table>
</div>
<div class="note">
<h5>ProTip™: Don't repeat yourself</h5>
<p>
If you don't want to repeat your frequently used front matter variables
over and over, just define <a href="../configuration/#front-matter-defaults" title="Front Matter defaults">defaults</a>
for them and only override them where necessary (or not at all). This works
both for predefined and custom variables.
</p>
</div>
## Defaults
[Front matter defaults](/docs/configuration/front-matter-defaults/) help you to reduce repetition for things like `layouts` which is often the same across multiple pages.

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 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 URL's.
branch to GitHub. 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 the handy [URL filters](/docs/liquid/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 URL's 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,21 +119,22 @@ 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>
the <a href="/docs/configuration/>“Site Source”</a>
configuration value, so if you locate your files anywhere other than the
root directory, your site may not build correctly.
</p>
</div>
<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="/docs/installation/windows/">Windows-specific docs page</a>.
</p>
</div>

File diff suppressed because it is too large Load Diff

View File

@@ -5,19 +5,60 @@ 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.
### Including files relative to another file
## Parameters
Includes can take parameters which is especially useful for reducing repetition across your Jekyll site.
To use parameters you pass a list of key/values to the include:
{% raw %}
```liquid
{% include note.html style="big" content="This is my sample note." %}
```
{% endraw %}
The parameters are available in the include under the `include` variable:
{% raw %}
```liquid
<div class="my-note {{ include.style }}">
{{ include.content }}
</div>
```
{% endraw %}
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/).
If you need to modify a variable before sending it to the include, you can save it to an intermediate variable. For example this is one way to prepend a string to variable used in an include:
{% raw %}
```liquid
{% capture download_note %}
The latest version of {{ site.product_name }} is now available.
{% endcapture %}
{% include note.html style="big" content=download_note %}
```
{% endraw %}
## Including files relative to another file
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,
@@ -29,7 +70,7 @@ Note that you cannot use the `../` syntax to specify an include location that re
All the other capabilities of the `include` tag are available to the `include_relative` tag,
such as variables.
### Using variables names for the include file
## Include file by variable
The name of the file you want to embed can be specified as a variable instead of an actual file name. For example, suppose you defined a variable in your page's front matter like this:
@@ -42,126 +83,10 @@ 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.
### Passing parameters to includes
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:
```liquid
{% raw %}<div markdown="span" class="alert alert-info" role="alert">
<i class="fa fa-info-circle"></i> <b>Note:</b>
{{ include.content }}
</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:
```liquid
{% raw %}{% 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.
Passing parameters to includes is especially helpful when you want to hide away complex formatting from your Markdown content.
For example, suppose you have a special image syntax with complex formatting, and you don't want your authors to remember the complex formatting. As a result, you decide to simplify the formatting by using an include with parameters. Here's an example of the special image syntax you might want to populate with an include:
```html
<figure>
<a href="http://jekyllrb.com">
<img src="logo.png" style="max-width: 200px;"
alt="Jekyll logo" />
<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:
```liquid
{% raw %}<figure>
<a href="{{ include.url }}">
<img src="{{ include.file }}" style="max-width: {{ include.max-width }};"
alt="{{ include.alt }}"/>
<figcaption>{{ include.caption }}</figcaption>
</figure>{% endraw %}
```
This include contains 5 parameters:
* `url`
* `max-width`
* `file`
* `alt`
* `caption`
Here's an example that passes all the parameters to this include (the include file is named `image.html`):
```liquid
{% raw %}{% include image.html url="http://jekyllrb.com"
max-width="200px" file="logo.png" alt="Jekyll logo"
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).
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.)
### Passing parameter variables to includes
Suppose the parameter you want to pass to the include is a variable rather than a string. For example, you might be using {% raw %}`{{ site.product_name }}`{% endraw %} to refer to every instance of your product rather than the actual hard-coded name. (In this case, your `_config.yml` file would have a key called `product_name` with a value of your product's name.)
The string you pass to your include parameter can't contain curly braces. For example, you can't pass a parameter that contains this: {% raw %}`"The latest version of {{ site.product_name }} is now available."`{% endraw %}
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:
```liquid
{% raw %}{% 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):
```liquid
{% raw %}{% include note.html content=download_note %}{% endraw %}
```
### Passing references to YAML files as parameter values
Instead of passing string variables to the include, you can pass a reference to a YAML data file stored in the `_data` folder.
Here's an example. In the `_data` folder, suppose you have a YAML file called `profiles.yml`. Its content looks like this:
```yaml
- name: John Doe
login_age: old
image: johndoe.jpg
- name: Jane Doe
login_age: new
image: janedoe.jpg
```
In the `_includes` folder, assume you have a file called `spotlight.html` with this code:
```liquid
{% raw %}{% for person in {{ include.participants }} %}
{% if person.login_age == "new" %}
{{ person.name }}
{% endif %}
{% endfor %}{% endraw %}
```
Now when you insert the `spotlight.html` include file, you can submit the YAML file as a parameter:
```
{% raw %}{% include spotlight.html participants=site.data.profiles %}{% 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

@@ -1,56 +1,38 @@
---
title: Welcome
permalink: /docs/home/
redirect_from: /docs/index.html
title: Quickstart
permalink: /docs/
redirect_from:
- /docs/home/
- /docs/quickstart/
- /docs/extras/
---
Jekyll is a simple, extendable, static site generator. You give it text written
in your favorite markup language and it churns through layouts to create a
static website. Throughout that process you can tweak how you want the site URLs
to look, what data gets displayed in the layout, and more.
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.
## Instructions
## So what is Jekyll, exactly?
1. Install a full [Ruby development environment](/docs/installation/)
2. Install Jekyll and [bundler](/docs/ruby-101/#bundler) [gems](/docs/ruby-101/#gems)
```
gem install jekyll bundler
```
3. Create a new Jekyll site at `./myblog`
```
jekyll new myblog
```
4. Change into your new directory
```
cd myblog
```
5. Build the site and make it available on a local server
```
bundle exec jekyll serve
```
6. Now browse to [http://localhost:4000](http://localhost:4000){:target="_blank"}
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**.
## Helpful Hints
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.
<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>
</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>
</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>
</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>
</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 encounter any unexpected errors during the above, please refer to the
[troubleshooting](/docs/troubleshooting/#configuration-problems) page or the
already-mentioned [requirements](/docs/installation/#requirements) page, as
you might be missing development headers or other prerequisites.

View File

@@ -1,127 +1,22 @@
---
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](/docs/ruby-101/#gems) that can be installed on most systems.
### Requirements
## Requirements
Installing Jekyll is easy and straight-forward, but there are a few
requirements youll need to make sure your system has before you start.
* [Ruby](https://www.ruby-lang.org/en/downloads/) version 2.2.5 or above, including all development headers (ruby version 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)
- [Ruby](https://www.ruby-lang.org/en/downloads/) (including development
headers, v1.9.3 or above for Jekyll 2 and v2 or above for Jekyll 3)
- [RubyGems](https://rubygems.org/pages/download)
- Linux, Unix, or macOS
- [NodeJS](https://nodejs.org/), or another JavaScript runtime (Jekyll 2 and
earlier, for CoffeeScript support).
- [Python 2.7](https://www.python.org/downloads/) (for Jekyll 2 and earlier)
- [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)
## Guides
<div class="note info">
<h5>Running Jekyll on Windows</h5>
<p>
While Windows is not officially supported, it is possible to get it running
on Windows. Special instructions can be found on our
<a href="../windows/#installation">Windows-specific docs page</a>.
</p>
</div>
For detailed install instructions have a look at the guide for your operating system.
## 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:
```sh
$ gem install jekyll
```
All of Jekylls gem dependencies are automatically installed by the above
command, so you wont have to worry about them at all. If you have problems
installing Jekyll, check out the [troubleshooting](../troubleshooting/) page or
[report an issue]({{ site.repository }}/issues/new) so the Jekyll
community can improve the experience for everyone.
<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>
## Pre-releases
In order to install a pre-release, make sure you have all the requirements
installed properly and run:
```sh
gem install jekyll --pre
```
This will install the latest pre-release. If you want a particular pre-release,
use the `-v` switch to indicate the version you'd like to install:
```sh
gem install jekyll -v '2.0.0.alpha.1'
```
If you'd like to install a development version of Jekyll, the process is a bit
more involved. This gives you the advantage of having the latest and greatest,
but may be unstable.
```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
```
Now that youve got everything up-to-date and installed, lets get to work!
* [macOS](/docs/installation/macos/)
* [Ubuntu Linux](/docs/installation/ubuntu/)
* [Other Linux distros](/docs/installation/other-linux)
* [Windows](/docs/installation/windows/)

View File

@@ -0,0 +1,69 @@
---
title: Jekyll on macOS
permalink: /docs/installation/macos/
---
First, you need to install the command-line tools to be able to compile native extensions, open a terminal and run:
```sh
xcode-select --install
```
## Set up Ruby included with the OS
Check your Ruby version meets our requirements. Jekyll requires Ruby 2.2.5 or above. If you're running an older version you'll need to [install a more recent Ruby version via Homebrew](#homebrew).
```sh
ruby -v
2.3.3
```
Now install Jekyll and [Bundler](/docs/ruby-101/#bundler).
```sh
gem install bundler jekyll
```
### Install a newer Ruby version via Homebrew {#homebrew}
If you wish to install the latest version of Ruby and get faster builds, we recommend doing 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]
```
### 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 your colleagues/collaborators.
```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.
### Problems?
Check out the [troubleshooting](/docs/troubleshooting/) page or [ask for help on our forum](https://talk.jekyllrb.com).

View File

@@ -0,0 +1,19 @@
---
title: Jekyll on Linux
permalink: /docs/installation/other-linux/
---
Installation on other Linux distributions works similarly as on [Ubuntu](../ubuntu/).
On Fedora, the dependencies can be installed as follows:
```sh
sudo dnf install ruby ruby-devel @development-tools
```
On Debian:
```sh
sudo apt-get install ruby-full build-essential
```
The rest works the same as on [Ubuntu](../ubuntu/).

View File

@@ -0,0 +1,30 @@
---
title: Jekyll on Ubuntu
permalink: /docs/installation/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.

View File

@@ -0,0 +1,122 @@
---
title: Jekyll on Windows
permalink: /docs/installation/windows/
redirect_from:
- /docs/windows/
---
While Windows is not an officially-supported platform, it can be used to run Jekyll with the proper tweaks. This page aims to collect some of the general knowledge and lessons that have been unearthed by Windows users.
## Installing Jekyll
The easiest way to run Jekyll is by using the [RubyInstaller](https://rubyinstaller.org/) for Windows.
### Installation via RubyInstaller
[RubyInstaller](https://rubyinstaller.org/) 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](https://github.com/oneclick/rubyinstaller/wiki/Development-Kit) manually.
1. Download and Install a **Ruby+Devkit** version from [RubyInstaller Downloads](https://rubyinstaller.org/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 use Jekyll!
### 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.
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
```
### 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.
Jekyll now uses a rubygem to internally configure Timezone based on established [IANA Timezone Database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
While 'new' blogs created with Jekyll v3.4 and greater, will have the following added to their `Gemfile` by default, existing sites *will* have to update their `Gemfile` (and installed) to enable development on Windows:
```ruby
# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]
```
### Auto Regeneration
Jekyll uses the `listen` gem to watch for changes when the `--watch` switch is specified during a build or serve. While `listen` has built-in support for UNIX systems, it may require an extra gem for compatibility with Windows.
Add the following to the `Gemfile` for your site if you have issues with auto-regeneration on Windows alone:
```ruby
gem 'wdm', '~> 0.1.1' if Gem.win_platform?
```
You have to use a [Ruby+Devkit](https://rubyinstaller.org/downloads/) version of the RubyInstaller.
## Installation via Bash on Windows 10
If you are using Windows 10 version 1607 or later, another option to run Jekyll is by [installing](https://msdn.microsoft.com/en-us/commandline/wsl/install_guide) the Windows Subsystem for Linux.
*Note:* You must have [Windows Subsystem for Linux](https://msdn.microsoft.com/en-us/commandline/wsl/about) 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.5 ruby2.5-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!**
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.

131
docs/_docs/layouts.md Normal file
View File

@@ -0,0 +1,131 @@
---
title: Layouts
description: placeholder
permalink: /docs/layouts/
---
Layouts are templates that wrap around your content. They allow you to have the
source code for your template in one place so you don't have to repeat things
like your navigation and footer on every page.
Layouts live in the `_layouts` directory. The convention is to have a base
template called `default.html` and have other layouts [inherit](#inheritance)
from this as needed.
## Usage
The first step is to put the template source code in `default.html`. `content`
is a special variable, the value is the rendered content of the post or page
being wrapped.
{% raw %}
```
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>{{ page.title }}</title>
<link rel="stylesheet" href="/css/style.css">
</head>
<body>
<nav>
<a href="/">Home</a>
<a href="/blog/">Blog</a>
</nav>
<h1>{{ page.title }}</h1>
<section>
{{ content }}
</section>
<footer>
&copy; to me
</footer>
</body>
</html>
```
{% endraw %}
You have full access to the front matter of the origin. In the
example above, `page.title` comes from the page front matter.
Next you need to specify what layout you're using in your page's front matter.
You can also use
[front matter defaults](/docs/configuration/front-matter-defaults/) to save you
from having to set this on every page.
```
---
title: My First Page
layout: default
---
This is the content of my page
```
The rendered output of this page is:
```
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>My First Page</title>
<link rel="stylesheet" href="/css/style.css">
</head>
<body>
<nav>
<a href="/">Home</a>
<a href="/blog/">Blog</a>
</nav>
<h1>My First Page</h1>
<section>
This is the content of my page
</section>
<footer>
&copy; to me
</footer>
</body>
</html>
```
## Inheritance
Layout inheritance is useful when you want to add something to an existing
layout for a portion of documents on your site. A common example of this is
blog posts, you might want a post to display the date and author but otherwise
be identical to your base layout.
To achieve this you need to create another layout which specifies your original
layout in front matter. For example this layout will live at
`_layouts/post.html`:
{% raw %}
```
---
layout: default
---
<p>{{ page.date }} - Written by {{ page.author }}</p>
{{ content }}
```
{% endraw %}
Now posts can use this layout while the rest of the pages use the default.
## Variables
You can set front matter in layouts, the only difference is when you're
using in Liquid, you need to use the `layout` variable instead of `page`. For
example:
{% raw %}
```
---
city: San Francisco
---
<p>{{ layout.city }}</p>
{{ content }}
```
{% endraw %}

19
docs/_docs/liquid.md Normal file
View File

@@ -0,0 +1,19 @@
---
title: Liquid
permalink: /docs/liquid/
redirect_from: "/docs/templates/"
---
Jekyll uses the [Liquid](https://shopify.github.io/liquid/) templating language
to process templates.
Generally in Liquid you output content using two curly braces e.g.
{% raw %}`{{ variable }}`{% endraw %} and perform logic statements by
surrounding them in a curly brace percentage sign e.g.
{% raw %}`{% if statement %}`{% endraw %}. To learn more about Liquid, check
out the [official Liquid Documentation](https://shopify.github.io/liquid/).
Jekyll provides a number of useful Liquid additions to help you build your site:
* [Filters](/docs/liquid/filters/)
* [Tags](/docs/liquid/tags/)

View File

@@ -0,0 +1,113 @@
---
title: Liquid Filters
permalink: "/docs/liquid/filters/"
shopify_filter_url: https://shopify.github.io/liquid/filters/
shopify_filters:
- abs
- append
- at_least
- at_most
- capitalize
- ceil
- compact
- concat
- date
- default
- divided_by
- downcase
- escape
- escape_once
- first
- floor
- join
- last
- lstrip
- map
- minus
- modulo
- newline_to_br
- plus
- prepend
- remove
- remove_first
- replace
- replace_first
- reverse
- round
- rstrip
- size
- slice
- sort
- sort_natural
- split
- strip
- strip_html
- strip_newlines
- times
- truncate
- truncatewords
- uniq
- upcase
- url_decode
- url_encode
---
All of the standard Liquid [filters](#standard-liquid-filters) are supported (see below).
To make common tasks easier, Jekyll even adds a few handy filters of its own,
all of which you can find on this page. You can also create your own filters
using [plugins](/docs/plugins/).
<div class="mobile-side-scroller">
<table>
<thead>
<tr>
<th>Description</th>
<th><span class="filter">Filter</span> and <span class="output">Output</span></th>
</tr>
</thead>
<tbody>
{% for filter in site.data.jekyll_filters %}
<tr>
<td>
<p class="name"><strong>{{ filter.name }}</strong></p>
<p>
{{- filter.description -}}
{%- if filter.version_badge %}
<span class="version-badge" title="This filter is available from version {{ filter.version_badge }}">
{{- filter.version_badge -}}
</span>
{% endif -%}
</p>
</td>
<td class="align-center">
{%- for example in filter.examples %}
<p><code class="filter">{{ example.input }}</code></p>
{% if example.output %}<p><code class="output">{{ example.output }}</code></p>{% endif %}
{% endfor -%}
</td>
</tr>
{% endfor %}
</tbody>
</table>
</div>
### Options for the `slugify` filter
The `slugify` filter accepts an option, each specifying what to filter.
The default is `default`. They are as follows (with what they filter):
- `none`: no characters
- `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" -%}.
### Standard Liquid Filters
For your convenience, here is the list of all [Liquid filters]({{ page.shopify_filter_url }}) with links to examples in the official Liquid documentation.
{% for filter in page.shopify_filters %}
- [{{ filter }}]({{ filter | prepend: page.shopify_filter_url | append: '/' }})
{% endfor %}

147
docs/_docs/liquid/tags.md Normal file
View File

@@ -0,0 +1,147 @@
---
title: Tags Filters
permalink: "/docs/liquid/tags/"
---
All of the standard Liquid
[tags](https://shopify.github.io/liquid/tags/control-flow/) are supported.
Jekyll has a few built in tags to help you build your site. You can also create
your own tags using [plugins](/docs/plugins/).
## Includes
If you have page snippets that you use repeatedly across your site, an
[include](/docs/includes/) is the perfect way to make this more maintainable.
## Code snippet highlighting
Jekyll has built in support for syntax highlighting of over 100 languages
thanks to [Rouge](http://rouge.jneen.net). Rouge is the default highlighter
in Jekyll 3 and above. To use it in Jekyll 2, set `highlighter` to `rouge`
and ensure the `rouge` gem is installed properly.
Alternatively, you can use [Pygments](http://pygments.org) to highlight your
code snippets in Jekyll 3.x and below. To use Pygments, you must have Python
installed on your system, have the `pygments.rb` gem installed and set
`highlighter` to `pygments` in your site's configuration file. Pygments
supports [over 100 languages](http://pygments.org/languages/)
<div class="note info">
<p>Using Pygments has been deprecated and will not be officially supported in
Jekyll 4, meaning that the configuration setting <code>highlighter: pygments</code>
will automatically fall back to using <em>Rouge</em> which is written in Ruby
and 100% compatible with stylesheets for Pygments.</p>
</div>
To render a code block with syntax highlighting, surround your code as follows:
{% raw %}
```liquid
{% highlight ruby %}
def foo
puts 'foo'
end
{% endhighlight %}
```
{% 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
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/).
### Raw
Surround a block of code in <code>{&#37; raw &#37;}</code> will ignore Liquid until
<code>{&#37; endraw &#37;}</code>. This is useful if you're using a language that
contains curly braces or you're documenting Liquid.
### Line numbers
There is a second argument to `highlight` called `linenos` that is optional.
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:
{% raw %}
```liquid
{% highlight ruby linenos %}
def foo
puts 'foo'
end
{% endhighlight %}
```
{% endraw %}
### Stylesheets for syntax highlighting
In order for the highlighting to show up, youll need to include a highlighting
stylesheet. For Pygments or Rouge you can use a stylesheet for Pygments, you
can find an example gallery [here](http://help.farbox.com/pygments.html).
## Links
### Linking to pages {#link}
To link to a post, a page, collection item, or file, the `link` tag will generate the correct permalink URL for the path you specify. For example, if you use the `link` tag to link to `mypage.html`, even if you change your permalink style to include the file extension or omit it, the URL formed by the `link` tag will always be valid.
You must include the file's original extension when using the `link` tag. Here are some examples:
{% 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 %}
You can also use the `link` tag to create a link in Markdown as follows:
{% 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 %}
(Including `{% raw %}{{ site.baseurl }}{% endraw %}` is optional &mdash; it depends on whether you want to preface the page URL with the `baseurl` value.)
The path to the post, page, or collection is defined as the path relative to the root directory (where your config file is) to the file, not the path from your existing page to the other page.
For example, suppose you're creating a link in `page_a.md` (stored in `pages/folder1/folder2`) to `page_b.md` (stored in `pages/folder1`). Your path in the link would not be `../page_b.html`. Instead, it would be `/pages/folder1/page_b.md`.
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` 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.
### Linking to posts
If you want to include a link to a post on your site, the `post_url` tag will generate the correct permalink URL for the post you specify.
{% raw %}
```liquid
{{ site.baseurl }}{% post_url 2010-07-21-name-of-post %}
```
{% endraw %}
If you organize your posts in subdirectories, you need to include subdirectory path to the post:
{% raw %}
```liquid
{{ site.baseurl }}{% post_url /subdir/2010-07-21-name-of-post %}
```
{% 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:
{% raw %}
```liquid
[Name of Link]({{ site.baseurl }}{% post_url 2010-07-21-name-of-post %})
```
{% endraw %}

View File

@@ -17,11 +17,11 @@ Each affinity team has a few captains who manage the issues and pull requests fo
Just ask! Feel free to open an issue on `jekyll/jekyll` and add `/cc @jekyll/core`. We can add you. :smile:
Alternatively, you can email or otherwise reach out to [@parkr](https://github.com/parkr) directly if you prefer the more private route.
Alternatively, you can email or otherwise reach out to [@oe](https://github.com/oe) directly if you prefer the more private route.
## Ugh, I'm tired and don't have time to be a captain anymore. What now?
No sweat at all! Email [@parkr](https://github.com/parkr) and ask to be removed. Alternatively, you should be able to go to your team's page on GitHub.com (go to https://github.com/jekyll, click "Teams", click the link to your team) and change your status to either "member" or leave the team.
No sweat at all! Email [@oe](https://github.com/oe) and ask to be removed. Alternatively, you should be able to go to your team's page on GitHub.com (go to https://github.com/jekyll, click "Teams", click the link to your team) and change your status to either "member" or leave the team.
We realize that being a captain is no easy feat so we want to make it a great experience. As always, communicate as much as you can with us about what is working, and what isn't. Thanks for dedicating some time to Jekyll! :sparkles:

View File

@@ -5,21 +5,21 @@ title: "Avoiding Burnout"
**This guide is for maintainers.** These special people have **write access** to one or more of Jekyll's repositories and help merge the contributions of others. You may find what is written here interesting, but its definitely not for everyone.
{: .note .info }
# 1. Use Jekyll
## 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
## 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.
# 3. Prioritise Maintainers Over Users
## 3. Prioritise Maintainers Over Users
It's important to be user-focused but ultimately, as long as you follow #1 above, Jekyll's minimum number of users will be the number of maintainers. However, if Jekyll has no maintainers it will quickly become useless to all users and the project will die. As a result, no user complaint, behaviour or need takes priority over the burnout of maintainers. If users do not like the direction of the project, the easiest way to influence it is to make significant, high-quality code contributions and become a maintainer.
# 4. Learn To Say No
## 4. Learn To Say No
Jekyll gets a lot of feature requests, non-reproducible bug reports, usage questions and PRs we won't accept. These should be closed out as soon as we realise that they aren't going to be resolved or merged. This is kinder than deciding this after a long period of review. Our issue tracker should reflect work to be done.

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

@@ -7,7 +7,7 @@ title: "Merging a Pull Request"
## Code Review
All pull requests should be subject to code review. Code review is a [foundational value](https://blog.fullstory.com/what-we-learned-from-google-code-reviews-arent-just-for-catching-bugs-b125a13aa292) of good engineering teams. Besides providing validation of correctness, it promotes a sense of community and gives other maintainers understanding of all parts of the code base. In short, code review is crucial to a healthy open source project.
All pull requests should be subject to code review. Code review is a [foundational value](https://blog.fullstory.com/what-we-learned-from-google-code-reviews-arent-just-for-catching-bugs/) of good engineering teams. Besides providing validation of correctness, it promotes a sense of community and gives other maintainers understanding of all parts of the code base. In short, code review is crucial to a healthy open source project.
**Read our guide for [Reviewing a pull request](../reviewing-a-pull-request) before merging.** Notably, the change must have tests if for code, and at least two maintainers must give it an OK.
@@ -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

@@ -18,3 +18,7 @@ These labels are used to indicate that the Git state of a pull request must chan
## `stale`
This label is automatically added and removed by @jekyllbot based on activity on an issue or pull request. The rules for this label are laid out in [Triaging an Issue: Staleness and automatic closure](../triaging-an-issue/#staleness-and-automatic-closure).
## `pinned`
This label is for @jekyllbot to ignore the age of the issue, which means that the `stale` label won't be automatically added, and the issue won't be closed after a while. This needs to be set manually, and should be set with care. (The `has-pull-request` label does the same thing, but shouldn't be used to _only_ keep an issue open)

View File

@@ -51,4 +51,4 @@ Is what they wanted to get something we want to happen? Sometimes a bug report i
### Staleness and automatic closure
@jekyllbot will automatically mark issues as `stale` if no activity occurs for at least one month. @jekyllbot leaves a comment asking for information about reproducibility in current versions. If no one responds after another month, the issue is automatically closed.
@jekyllbot will automatically mark issues as `stale` if no activity occurs for at least one month. @jekyllbot leaves a comment asking for information about reproducibility in current versions. If no one responds after another month, the issue is automatically closed. This behavior can be suppressed by setting the [`pinned` label](/docs/maintaining/special-labels/#pinned).

View File

@@ -0,0 +1,6 @@
---
title: Markdown 101
permalink: /docs/markdown-101/
---
# TO WRITE

View File

@@ -1,5 +1,5 @@
---
title: Blog migrations
title: Blog Migrations
permalink: /docs/migrations/
---

View File

@@ -1,74 +1,27 @@
---
title: Creating pages
title: Pages
permalink: /docs/pages/
---
In addition to [writing posts](../posts/), you might also want to add static pages (content that isn't date-based) to your Jekyll site. By taking advantage of the way Jekyll copies files and directories, this is easy to do.
Pages are the most basic building block for content. They're useful for standalone
content (content which is not date based or is not a group of content such as staff
members or recipes).
## Homepage
Just about every web server configuration you come across will look for an HTML
file called `index.html` (by convention) in the site's root folder and display
that as the homepage. Unless the web server youre using is configured to look
for some different filename as the default, this file will turn into the
homepage of your Jekyll-generated site.
<div class="note">
<h5>ProTip™: Use layouts on your homepage</h5>
<p>
Any HTML file on your site can use layouts and/or includes, even the
homepage. Common content, like headers and footers, make excellent
candidates for extraction into a layout.
</p>
</div>
## Where additional pages live
Where you put HTML or [Markdown](https://daringfireball.net/projects/markdown/)
files for pages depends on how you want the pages to work. There are two main ways of creating pages:
- Place named HTML or [Markdown](https://daringfireball.net/projects/markdown/)
files for each page in your site's root folder.
- Place pages inside folders and subfolders named whatever you want.
Both methods work fine (and can be used in conjunction with each other),
with the only real difference being the resulting URLs. By default, pages retain the same folder structure in `_site` as they do in the source directory.
### Named HTML files
The simplest way of adding a page is just to add an HTML file in the root
directory with a suitable name for the page you want to create. For a site with
The simplest way of adding a page is to add an HTML file in the root
directory with a suitable filename. You can also write a page in Markdown using
a `.md` extension which converts to HTML on build. For a site with
a homepage, an about page, and a contact page, heres what the root directory
and associated URLs might look like:
```sh
.
|-- _config.yml
|-- _includes/
|-- _layouts/
|-- _posts/
|-- _site/
|-- about.html # => http://example.com/about.html
|-- about.md # => http://example.com/about.html
|-- index.html # => http://example.com/
|-- other.md # => http://example.com/other.html
└── contact.html # => http://example.com/contact.html
```
If you have a lot of pages, you can organize those pages into subfolders. The same subfolders that are used to group your pages in our project's source will exist in the `_site` folder when your site builds.
If you have a lot of pages, you can organize them into subfolders. The same subfolders that are used to group your pages in our project's source will exist in the `_site` folder when your site builds.
## Flattening pages from subfolders into the root directory
## Changing the output URL
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:
```
---
title: My page
permalink: mypageurl.html
---
```
### Named folders containing index HTML files
If you don't want file extensions (`.html`) to appear in your page URLs (file extensions are the default), you can choose a [permalink style](../permalinks/#builtinpermalinkstyles) that has a trailing slash instead of a file extension.
Note if you want to view your site offline *without the Jekyll preview server*, your browser will need the file extension to display the page, and all assets will need to be relative links that function without the server baseurl.
You might want to have a particular folder structure for your source files that changes for the built site. With [permalinks](/docs/permalinks) you have full control of the output URL.

View File

@@ -9,22 +9,18 @@ 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
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
<code>paginate_path</code> configuration value.
</p>
</div>
Pagination does not work from within Markdown files from
your Jekyll site. Pagination works when called from within the HTML
file, named `index.html`, which optionally may reside in and
produce pagination from within a subdirectory, via the
`paginate_path` configuration value.
{: .warning }
## 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
@@ -42,111 +38,41 @@ paginate_path: "/blog/page:num/"
This will read in `blog/index.html`, send it each pagination page in Liquid as
`paginator` and write the output to `blog/page:num/`, where `:num` is the
pagination page number, starting with `2`. If a site has 12 posts and specifies
`paginate: 5`, Jekyll will write `blog/index.html` with the first 5 posts, `blog/page2/index.html` with the next 5 posts
and `blog/page3/index.html` with the last 2 posts into the destination
directory.
pagination page number, starting with `2`. <br/>
If a site has 12 posts and specifies `paginate: 5`, Jekyll will write `blog/index.html`
with the first 5 posts, `blog/page2/index.html` with the next 5 posts and
`blog/page3/index.html` with the last 2 posts into the destination directory.
<div class="note warning">
<h5>Don't set a permalink</h5>
<p>
Setting a permalink in the front matter of your blog page will cause
pagination to break. Just omit the permalink.
</p>
</div>
Setting a permalink in the front matter of your blog page will cause pagination to break. Just omit the permalink.
{: .warning }
## Liquid Attributes Available
The pagination plugin exposes the `paginator` liquid object with the following
attributes:
<div class="mobile-side-scroller">
<table>
<thead>
<tr>
<th>Attribute</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><p><code>page</code></p></td>
<td><p>current page number</p></td>
</tr>
<tr>
<td><p><code>per_page</code></p></td>
<td><p>number of posts per page</p></td>
</tr>
<tr>
<td><p><code>posts</code></p></td>
<td><p>a list of posts for the current page</p></td>
</tr>
<tr>
<td><p><code>total_posts</code></p></td>
<td><p>total number of posts in the site</p></td>
</tr>
<tr>
<td><p><code>total_pages</code></p></td>
<td><p>number of pagination pages</p></td>
</tr>
<tr>
<td><p><code>previous_page</code></p></td>
<td>
<p>
page number of the previous pagination page,
or <code>nil</code> if no previous page exists
</p>
</td>
</tr>
<tr>
<td><p><code>previous_page_path</code></p></td>
<td>
<p>
path of previous pagination page,
or <code>nil</code> if no previous page exists
</p>
</td>
</tr>
<tr>
<td><p><code>next_page</code></p></td>
<td>
<p>
page number of the next pagination page,
or <code>nil</code> if no subsequent page exists
</p>
</td>
</tr>
<tr>
<td><p><code>next_page_path</code></p></td>
<td>
<p>
path of next pagination page,
or <code>nil</code> if no subsequent page exists
</p>
</td>
</tr>
</tbody>
</table>
</div>
{% include docs_variables_table.html scope=site.data.jekyll_variables.paginator %}
<div class="note info">
<h5>Pagination does not support tags or categories</h5>
<p>Pagination pages through every post in the <code>posts</code>
variable unless a post has <code>hidden: true</code> in its YAML Front Matter.
It does not currently allow paging over groups of posts linked
by a common tag or category. It cannot include any collection of
documents because it is restricted to posts.</p>
</div>
## Tags and Categories
Pagination pages through every post in the `posts`
variable unless a post has `hidden: true` in its front matter.
It does not currently allow paging over groups of posts linked
by a common tag or category. It cannot include any collection of documents because it is restricted to posts.
[jekyll-paginate-v2](https://github.com/sverrirs/jekyll-paginate-v2) is an unofficial successor of jekyll-paginate which supports more features.
## Render the paginated Posts
The next thing you need to do is to actually display your posts in a list using
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
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
@@ -166,38 +92,37 @@ title: My Blog
<!-- Pagination links -->
<div class="pagination">
{% if paginator.previous_page %}
<a href="{{ paginator.previous_page_path }}" class="previous">Previous</a>
<a href="{{ paginator.previous_page_path }}" class="previous">
Previous
</a>
{% else %}
<span class="previous">Previous</span>
{% endif %}
<span class="page_number ">Page: {{ paginator.page }} of {{ paginator.total_pages }}</span>
<span class="page_number ">
Page: {{ paginator.page }} of {{ paginator.total_pages }}
</span>
{% if paginator.next_page %}
<a href="{{ paginator.next_page_path }}" class="next">Next</a>
{% else %}
<span class="next ">Next</span>
{% endif %}
</div>
{% endraw %}
```
{% endraw %}
<div class="note warning">
<h5>Beware the page one edge-case</h5>
<p>
Jekyll does not generate a page1 folder, so the above code will not work
when a <code>/page1</code> link is produced. See below for a way to handle
this if its a problem for you.
</p>
</div>
The following HTML snippet should handle page one, and render a list of each
page with links to all but the current page.
Jekyll does not generate a `page1` folder, so the above code will not work
when a `/page1` link is produced. See below for a way to handle
this if its a problem for you:
```html
{% raw %}
```liquid
{% if paginator.total_pages > 1 %}
<div class="pagination">
{% if paginator.previous_page %}
<a href="{{ paginator.previous_page_path | prepend: site.baseurl | replace: '//', '/' }}">&laquo; Prev</a>
<a href="{{ paginator.previous_page_path | relative_url }}">
&laquo; Prev
</a>
{% else %}
<span>&laquo; Prev</span>
{% endif %}
@@ -206,18 +131,24 @@ page with links to all but the current page.
{% if page == paginator.page %}
<em>{{ page }}</em>
{% elsif page == 1 %}
<a href="{{ paginator.previous_page_path | prepend: site.baseurl | replace: '//', '/' }}">{{ page }}</a>
<a href="{{ paginator.previous_page_path | relative_url }}">
{{ page }}
</a>
{% else %}
<a href="{{ site.paginate_path | prepend: site.baseurl | replace: '//', '/' | replace: ':num', page }}">{{ page }}</a>
<a href="{{ site.paginate_path | relative_url | replace: ':num', page }}">
{{ page }}
</a>
{% endif %}
{% endfor %}
{% if paginator.next_page %}
<a href="{{ paginator.next_page_path | prepend: site.baseurl | replace: '//', '/' }}">Next &raquo;</a>
<a href="{{ paginator.next_page_path | relative_url }}">
Next &raquo;
</a>
{% else %}
<span>Next &raquo;</span>
{% endif %}
</div>
{% endif %}
{% endraw %}
```
{% endraw %}

View File

@@ -3,54 +3,48 @@ title: Permalinks
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.
Permalinks are the output path for your pages, posts, or collections. They
allow you to structure the directories of your source code different from the
directories in your output.
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.
## Front Matter
## Where to configure permalinks
The simplest way to set a permalink is using front matter. You set the
`permalink` variable in front matter to the output path you'd like.
You can configure your site's permalinks through the [Configuration]({% link _docs/configuration.md %}) file or in the [Front Matter]({% link _docs/frontmatter.md %}) for each post, page, or collection.
For example, you might have a page on your site located at
`/my_pages/about-me.html` and you want the output url to be `/about/`. In
front matter the page you would set:
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
```
If you don't specify any permalink setting, Jekyll uses the above pattern as the default.
The permalink can also be set using a built-in permalink style:
```yaml
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.
Setting the permalink in your post, page, or collection's front matter overrides any global settings. Here's an example:
```yaml
---
title: My page title
permalink: /mypageurl/
permalink: /about/
---
```
Even if your configuration file specifies the `date` style, the URL for this page would be `http://somedomain.com/mypageurl/`.
## Global
When you use permalinks that omit the `.html` file extension (called "pretty URLs") Jekyll builds the file as index.html placed inside a folder with the page's name. For example:
Setting a permalink in front matter for every page on your site is no fun.
Luckily, Jekyll let's you set in globally in your `_config.yml`.
```
├── mypageurl
│   └── index.html
To set a global permalink, you use the `permalink` variable in `_config.yml`.
You can use placeholders to your desired output. For example:
```yaml
permalink: /:categories/:year/:month/:day/:title:output_ext
```
With a URL such as `/mypageurl/`, servers automatically load the index.html file inside the folder, so users can simply navigate to `http://somedomain.com/mypageurl/` to get to `mypageurl/index.html`.
Note that pages and collections don't have time or categories, these aspects of
the permalink style are ignored for the output.
## Template variables for permalinks {#template-variables}
For example, a permalink style of
`/:categories/:year/:month/:day/:title:output_ext` for posts becomes
`/:title.html` for pages and collections.
### Placeholders
Here's the full list of placeholders available:
The following table lists the template variables available for permalinks. You can use these variables in the `permalink` property in your config file.
<div class="mobile-side-scroller">
<table>
@@ -66,7 +60,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> front matter
</p>
</td>
</tr>
<tr>
@@ -74,7 +71,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> front matter
</p>
</td>
</tr>
<tr>
@@ -82,7 +82,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> front matter
</p>
</td>
</tr>
<tr>
@@ -90,7 +93,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> front matter
</p>
</td>
</tr>
<tr>
@@ -98,7 +104,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> 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 +123,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> front matter
</p>
</td>
</tr>
<tr>
@@ -115,7 +135,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>
@@ -146,7 +167,7 @@ The following table lists the template variables available for permalinks. You c
<td>
<p>
Title from the documents filename. May be overridden via
the documents <code>slug</code> YAML front matter.
the documents <code>slug</code> front matter.
</p>
</td>
</tr>
@@ -158,7 +179,7 @@ The following table lists the template variables available for permalinks. You c
<p>
Slugified title from the documents filename (any character
except numbers and letters is replaced as hyphen). May be
overridden via the documents <code>slug</code> YAML front matter.
overridden via the documents <code>slug</code> front matter.
</p>
</td>
</tr>
@@ -179,11 +200,9 @@ The following table lists the template variables available for permalinks. You c
</table>
</div>
Note that all template variables relating to time or categories are available to posts only.
### Built-in formats
## Built-in permalink styles {#builtinpermalinkstyles}
Although you can specify a custom permalink pattern using [template variables](#template-variables), Jekyll also provides the following built-in styles for convenience.
For posts, Jekyll also provides the following built-in styles for convenience. Note, these aren't recognized when setting the permalink in front matter.
<div class="mobile-side-scroller">
<table>
@@ -199,7 +218,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 +234,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,145 +242,83 @@ 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>
</table>
</div>
Rather than typing `permalink: /:categories/:year/:month/:day/:title/`, you can just type `permalink: pretty`.
### Collections
<div class="note info">
<h5>Specifying permalinks through the YAML Front Matter</h5>
<p>Built-in permalink styles are not recognized in YAML Front Matter. As a result, <code>permalink: pretty</code> will not work.</p>
</div>
For collections, you have the option to override the global permalink in the
collection configuration in `_config.yml`:
## Permalink style examples with posts {#permalink-style-examples}
```yaml
collections:
my_collection:
output: true
permalink: /:collection/:name
```
Here are a few examples to clarify how permalink styles get applied with posts.
Given a post named: `/2009-04-29-slap-chop.md`
Collections have the following placeholders available:
<div class="mobile-side-scroller">
<table>
<thead>
<tr>
<th>URL Template</th>
<th>Resulting Permalink URL</th>
<th>Variable</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<p>None specified, or <code>permalink: date</code></p>
<p><code>:collection</code></p>
</td>
<td>
<p><code>/2009/04/29/slap-chop.html</code></p>
<p>Label of the containing collection.</p>
</td>
</tr>
<tr>
<td>
<p><code>pretty</code></p>
<p><code>:path</code></p>
</td>
<td>
<p><code>/2009/04/29/slap-chop/</code></p>
<p>Path to the document relative to the collection's directory.</p>
</td>
</tr>
<tr>
<td>
<p><code>/:month-:day-:year/:title.html</code></p>
<p><code>:name</code></p>
</td>
<td>
<p><code>/04-29-2009/slap-chop.html</code></p>
<p>The document's base filename, with every sequence of spaces
and non-alphanumeric characters replaced by a hyphen.</p>
</td>
</tr>
<tr>
<td>
<p><code>/blog/:year/:month/:day/:title/</code></p>
<p><code>:title</code></p>
</td>
<td>
<p><code>/blog/2009/04/29/slap-chop/</code></p>
<p>
The <code>:title</code> template variable will take the
<code>slug</code> <a href="/docs/front-matter/">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>
<td>
<p><code>/:year/:month/:title</code></p>
<p>See <a href="#extensionless-permalinks">Extensionless permalinks with no trailing slashes</a> for details.</p>
<p><code>:output_ext</code></p>
</td>
<td>
<p><code>/2009/04/slap-chop</code></p>
<p>Extension of the output file. (Included by default and usually unnecessary.)</p>
</td>
</tr>
</tbody>
</table>
</div>
## Permalink settings for pages and collections {#pages-and-collections}
The permalink setting in your configuration file specifies the permalink style used for posts, pages, and collections. However, because pages and collections don't have time or categories, these aspects of the permalink style are ignored with pages and collections.
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 `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.
## Permalinks and default paths
The path to the post or page in the built site differs for posts, pages, and collections:
### Posts
The subfolders into which you may have organized your posts inside the `_posts` directory will not be part of the permalink.
If you use a permalink style that omits the `.html` file extension, each post is rendered as an `index.html` file inside a folder with the post's name (for example, `categoryname/2016/12/01/mypostname/index.html`).
### Pages
Unlike posts, pages by default mimic the source directory structure exactly. (The only exception is if your page has a `permalink` declared its front matter &mdash; in that case, the structure honors the permalink setting instead of the source folder structure.)
As with posts, if you use a permalink style that omits the `.html` file extension, each page is rendered as an `index.html` file inserted inside a folder with the page's name (for example, `mypage/index.html`).
### Collections
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.
## 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:
```
---
title: My page
permalink: mypageurl.html
---
```
## Extensionless permalinks with no trailing slashes {#extensionless-permalinks}
Jekyll supports permalinks that contain neither a trailing slash nor a file extension, but this requires additional support from the web server to properly serve. When using these types of permalinks, output files written to disk will still have the proper file extension (typically `.html`), so the web server must be able to map requests without file extensions to these files.
Both [GitHub Pages](../github-pages/) and the Jekyll's built-in WEBrick server handle these requests properly without any additional work.
### Apache
The Apache web server has extensive support for content negotiation and can handle extensionless URLs by setting the [multiviews](https://httpd.apache.org/docs/current/content-negotiation.html#multiviews) option in your `httpd.conf` or `.htaccess` file:
{% highlight apache %}
Options +MultiViews
{% endhighlight %}
### Nginx
The [try_files](http://nginx.org/en/docs/http/ngx_http_core_module.html#try_files) directive allows you to specify a list of files to search for to process a request. The following configuration will instruct nginx to search for a file with an `.html` extension if an exact match for the requested URI is not found.
{% highlight nginx %}
try_files $uri $uri.html $uri/ =404;
{% endhighlight %}
## Linking without regard to permalink styles
You can create links in your topics to other posts, pages, or collection items in a way that is valid no matter what permalink configuration you choose. By using the `link` tag, if you change your permalinks, your links won't break. See [Linking to pages](../templates#link) in Templates for more details.

View File

@@ -7,936 +7,11 @@ Jekyll has a plugin system with hooks that allow you to create custom generated
content specific to your site. You can run custom code for your site without
having to modify the Jekyll source itself.
<div class="note info">
<h5>Plugins on GitHub Pages</h5>
<p>
<a href="https://pages.github.com/">GitHub Pages</a> is powered by Jekyll.
However, all Pages sites are generated using the <code>--safe</code> option
to disable custom plugins for security reasons. Unfortunately, this means
your plugins wont work if youre deploying to GitHub Pages.<br><br>
You can still use GitHub Pages to publish your site, but youll need to
convert the site locally and push the generated static files to your GitHub
repository instead of the Jekyll source files.
</p>
</div>
## Installing a plugin
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 `gems` and the
values of the gem names of the plugins you'd like to use. An example:
gems: [jekyll-coffeescript, jekyll-watch, jekyll-assets]
# This will require each of these gems automatically.
Then install your plugins using `gem install jekyll-coffeescript jekyll-watch jekyll-assets`
3. Add the relevant plugins to a Bundler group in your `Gemfile`. An
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`
<div class="note info">
<h5>
<code>_plugins</code>, <code>_config.yml</code> and <code>Gemfile</code>
can be used simultaneously
</h5>
<p>
You may use any of the aforementioned plugin options simultaneously in the
same site if you so choose. Use of one does not restrict the use of the
others.
</p>
</div>
In general, plugins you make will fall into one of five categories:
1. [Generators](#generators)
2. [Converters](#converters)
3. [Commands](#commands)
4. [Tags](#tags)
5. [Hooks](#hooks)
## Generators
You can create a generator when you need Jekyll to create additional content
based on your own rules.
A generator is a subclass of `Jekyll::Generator` that defines a `generate`
method, which receives an instance of
[`Jekyll::Site`]({{ site.repository }}/blob/master/lib/jekyll/site.rb). The
return value of `generate` is ignored.
Generators run after Jekyll has made an inventory of the existing content, and
before the site is generated. Pages with YAML Front Matters are stored as
instances of
[`Jekyll::Page`]({{ site.repository }}/blob/master/lib/jekyll/page.rb)
and are available via `site.pages`. Static files become instances of
[`Jekyll::StaticFile`]({{ site.repository }}/blob/master/lib/jekyll/static_file.rb)
and are available via `site.static_files`. See
[the Variables documentation page](/docs/variables/) and
[`Jekyll::Site`]({{ site.repository }}/blob/master/lib/jekyll/site.rb)
for more details.
For instance, a generator can inject values computed at build time for template
variables. In the following example the template `reading.html` has two
variables `ongoing` and `done` that we fill in the generator:
```ruby
module Reading
class Generator < Jekyll::Generator
def generate(site)
ongoing, done = Book.all.partition(&:ongoing?)
reading = site.pages.detect {|page| page.name == 'reading.html'}
reading.data['ongoing'] = ongoing
reading.data['done'] = done
end
end
end
```
This is a more complex generator that generates new pages:
```ruby
module Jekyll
class CategoryPage < Page
def initialize(site, base, dir, category)
@site = site
@base = base
@dir = dir
@name = 'index.html'
self.process(@name)
self.read_yaml(File.join(base, '_layouts'), 'category_index.html')
self.data['category'] = category
category_title_prefix = site.config['category_title_prefix'] || 'Category: '
self.data['title'] = "#{category_title_prefix}#{category}"
end
end
class CategoryPageGenerator < Generator
safe true
def generate(site)
if site.layouts.key? 'category_index'
dir = site.config['category_dir'] || 'categories'
site.categories.each_key do |category|
site.pages << CategoryPage.new(site, site.source, File.join(dir, category), category)
end
end
end
end
end
```
In this example, our generator will create a series of files under the
`categories` directory for each category, listing the posts in each category
using the `category_index.html` layout.
Generators are only required to implement one method:
<div class="mobile-side-scroller">
<table>
<thead>
<tr>
<th>Method</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<p><code>generate</code></p>
</td>
<td>
<p>Generates content as a side-effect.</p>
</td>
</tr>
</tbody>
</table>
</div>
## Converters
If you have a new markup language youd like to use with your site, you can
include it by implementing your own converter. Both the Markdown and
[Textile](https://github.com/jekyll/jekyll-textile-converter) markup
languages are implemented using this method.
<div class="note info">
<h5>Remember your YAML Front Matter</h5>
<p>
Jekyll will only convert files that have a YAML header at the top, even for
converters you add using a plugin.
</p>
</div>
Below is a converter that will take all posts ending in `.upcase` and process
them using the `UpcaseConverter`:
```ruby
module Jekyll
class UpcaseConverter < Converter
safe true
priority :low
def matches(ext)
ext =~ /^\.upcase$/i
end
def output_ext(ext)
".html"
end
def convert(content)
content.upcase
end
end
end
```
Converters should implement at a minimum 3 methods:
<div class="mobile-side-scroller">
<table>
<thead>
<tr>
<th>Method</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<p><code>matches</code></p>
</td>
<td><p>
Does the given extension match this converters list of acceptable
extensions? Takes one argument: the files extension (including the
dot). Must return <code>true</code> if it matches, <code>false</code>
otherwise.
</p></td>
</tr>
<tr>
<td>
<p><code>output_ext</code></p>
</td>
<td><p>
The extension to be given to the output file (including the dot).
Usually this will be <code>".html"</code>.
</p></td>
</tr>
<tr>
<td>
<p><code>convert</code></p>
</td>
<td><p>
Logic to do the content conversion. Takes one argument: the raw content
of the file (without YAML Front Matter). Must return a String.
</p></td>
</tr>
</tbody>
</table>
</div>
In our example, `UpcaseConverter#matches` checks if our filename extension is
`.upcase`, and will render using the converter if it is. It will call
`UpcaseConverter#convert` to process the content. In our simple converter were
simply uppercasing the entire content string. Finally, when it saves the page,
it will do so with a `.html` extension.
## Commands
As of version 2.5.0, Jekyll can be extended with plugins which provide
subcommands for the `jekyll` executable. This is possible by including the
relevant plugins in a `Gemfile` group called `:jekyll_plugins`:
```ruby
group :jekyll_plugins do
gem "my_fancy_jekyll_plugin"
end
```
Each `Command` must be a subclass of the `Jekyll::Command` class and must
contain one class method: `init_with_program`. An example:
```ruby
class MyNewCommand < Jekyll::Command
class << self
def init_with_program(prog)
prog.command(:new) do |c|
c.syntax "new [options]"
c.description 'Create a new Jekyll site.'
c.option 'dest', '-d DEST', 'Where the site should go.'
c.action do |args, options|
Jekyll::Site.new_site_at(options['dest'])
end
end
end
end
end
```
Commands should implement this single class method:
<div class="mobile-side-scroller">
<table>
<thead>
<tr>
<th>Method</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<p><code>init_with_program</code></p>
</td>
<td><p>
This method accepts one parameter, the
<code><a href="https://github.com/jekyll/mercenary#readme">Mercenary::Program</a></code>
instance, which is the Jekyll program itself. Upon the program,
commands may be created using the above syntax. For more details,
visit the Mercenary repository on GitHub.com.
</p></td>
</tr>
</tbody>
</table>
</div>
## Tags
If youd like to include custom liquid tags in your site, you can do so by
hooking into the tagging system. Built-in examples added by Jekyll include the
`highlight` and `include` tags. Below is an example of a custom liquid tag that
will output the time the page was rendered:
```ruby
module Jekyll
class RenderTimeTag < Liquid::Tag
def initialize(tag_name, text, tokens)
super
@text = text
end
def render(context)
"#{@text} #{Time.now}"
end
end
end
Liquid::Template.register_tag('render_time', Jekyll::RenderTimeTag)
```
At a minimum, liquid tags must implement:
<div class="mobile-side-scroller">
<table>
<thead>
<tr>
<th>Method</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<p><code>render</code></p>
</td>
<td>
<p>Outputs the content of the tag.</p>
</td>
</tr>
</tbody>
</table>
</div>
You must also register the custom tag with the Liquid template engine as
follows:
```ruby
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 %}
<p>{% render_time page rendered at: %}</p>
{% endraw %}
```
And we would get something like this on the page:
```html
<p>page rendered at: Tue June 22 23:38:47 0500 2010</p>
```
### Liquid filters
You can add your own filters to the Liquid template system much like you can
add tags above. Filters are simply modules that export their methods to liquid.
All methods will have to take at least one parameter which represents the input
of the filter. The return value will be the output of the filter.
```ruby
module Jekyll
module AssetFilter
def asset_url(input)
"http://www.example.com/#{input}?#{Time.now.to_i}"
end
end
end
Liquid::Template.register_filter(Jekyll::AssetFilter)
```
<div class="note">
<h5>ProTip™: Access the site object using Liquid</h5>
<p>
Jekyll lets you access the <code>site</code> object through the
<code>context.registers</code> feature of Liquid at <code>context.registers[:site]</code>. For example, you can
access the global configuration file <code>_config.yml</code> using
<code>context.registers[:site].config</code>.
</p>
</div>
### Flags
There are two flags to be aware of when writing a plugin:
<div class="mobile-side-scroller">
<table>
<thead>
<tr>
<th>Flag</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<p><code>safe</code></p>
</td>
<td>
<p>
A boolean flag that informs Jekyll whether this plugin may be safely
executed in an environment where arbitrary code execution is not
allowed. This is used by GitHub Pages to determine which core plugins
may be used, and which are unsafe to run. If your plugin does not
allow for arbitrary code execution, set this to <code>true</code>.
GitHub Pages still wont load your plugin, but if you submit it for
inclusion in core, its best for this to be correct!
</p>
</td>
</tr>
<tr>
<td>
<p><code>priority</code></p>
</td>
<td>
<p>
This flag determines what order the plugin is loaded in. Valid values
are: <code>:lowest</code>, <code>:low</code>, <code>:normal</code>,
<code>:high</code>, and <code>:highest</code>. Highest priority
matches are applied first, lowest priority are applied last.
</p>
</td>
</tr>
</tbody>
</table>
</div>
To use one of the example plugins above as an illustration, here is how youd
specify these two flags:
```ruby
module Jekyll
class UpcaseConverter < Converter
safe true
priority :low
...
end
end
```
## Hooks
Using hooks, your plugin can exercise fine-grained control over various aspects
of the build process. If your plugin defines any hooks, Jekyll will call them
at pre-defined points.
Hooks are registered to a container and an event name. To register one, you
call Jekyll::Hooks.register, and pass the container, event name, and code to
call whenever the hook is triggered. For example, if you want to execute some
custom functionality every time Jekyll renders a post, you could register a
hook like this:
```ruby
Jekyll::Hooks.register :posts, :post_render do |post|
# code to call after Jekyll renders a post
end
```
Jekyll provides hooks for <code>:site</code>, <code>:pages</code>,
<code>:posts</code>, and <code>:documents</code>. In all cases, Jekyll calls
your hooks with the container object as the first callback parameter. However,
all `:pre_render` hooks and the`:site, :post_render` hook will also provide a
payload hash as a second parameter. In the case of `:pre_render`, the payload
gives you full control over the variables that are available while rendering.
In the case of `:site, :post_render`, the payload contains final values after
rendering all the site (useful for sitemaps, feeds, etc).
The complete list of available hooks is below:
<div class="mobile-side-scroller">
<table>
<thead>
<tr>
<th>Container</th>
<th>Event</th>
<th>Called</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<p><code>:site</code></p>
</td>
<td>
<p><code>:after_init</code></p>
</td>
<td>
<p>Just after the site initializes, but before setup & render. Good
for modifying the configuration of the site.</p>
</td>
</tr>
<tr>
<td>
<p><code>:site</code></p>
</td>
<td>
<p><code>:after_reset</code></p>
</td>
<td>
<p>Just after site reset</p>
</td>
</tr>
<tr>
<td>
<p><code>:site</code></p>
</td>
<td>
<p><code>:post_read</code></p>
</td>
<td>
<p>After site data has been read and loaded from disk</p>
</td>
</tr>
<tr>
<td>
<p><code>:site</code></p>
</td>
<td>
<p><code>:pre_render</code></p>
</td>
<td>
<p>Just before rendering the whole site</p>
</td>
</tr>
<tr>
<td>
<p><code>:site</code></p>
</td>
<td>
<p><code>:post_render</code></p>
</td>
<td>
<p>After rendering the whole site, but before writing any files</p>
</td>
</tr>
<tr>
<td>
<p><code>:site</code></p>
</td>
<td>
<p><code>:post_write</code></p>
</td>
<td>
<p>After writing the whole site to disk</p>
</td>
</tr>
<tr>
<td>
<p><code>:pages</code></p>
</td>
<td>
<p><code>:post_init</code></p>
</td>
<td>
<p>Whenever a page is initialized</p>
</td>
</tr>
<tr>
<td>
<p><code>:pages</code></p>
</td>
<td>
<p><code>:pre_render</code></p>
</td>
<td>
<p>Just before rendering a page</p>
</td>
</tr>
<tr>
<td>
<p><code>:pages</code></p>
</td>
<td>
<p><code>:post_render</code></p>
</td>
<td>
<p>After rendering a page, but before writing it to disk</p>
</td>
</tr>
<tr>
<td>
<p><code>:pages</code></p>
</td>
<td>
<p><code>:post_write</code></p>
</td>
<td>
<p>After writing a page to disk</p>
</td>
</tr>
<tr>
<td>
<p><code>:posts</code></p>
</td>
<td>
<p><code>:post_init</code></p>
</td>
<td>
<p>Whenever a post is initialized</p>
</td>
</tr>
<tr>
<td>
<p><code>:posts</code></p>
</td>
<td>
<p><code>:pre_render</code></p>
</td>
<td>
<p>Just before rendering a post</p>
</td>
</tr>
<tr>
<td>
<p><code>:posts</code></p>
</td>
<td>
<p><code>:post_render</code></p>
</td>
<td>
<p>After rendering a post, but before writing it to disk</p>
</td>
</tr>
<tr>
<td>
<p><code>:posts</code></p>
</td>
<td>
<p><code>:post_write</code></p>
</td>
<td>
<p>After writing a post to disk</p>
</td>
</tr>
<tr>
<td>
<p><code>:documents</code></p>
</td>
<td>
<p><code>:post_init</code></p>
</td>
<td>
<p>Whenever a document is initialized</p>
</td>
</tr>
<tr>
<td>
<p><code>:documents</code></p>
</td>
<td>
<p><code>:pre_render</code></p>
</td>
<td>
<p>Just before rendering a document</p>
</td>
</tr>
<tr>
<td>
<p><code>:documents</code></p>
</td>
<td>
<p><code>:post_render</code></p>
</td>
<td>
<p>After rendering a document, but before writing it to disk</p>
</td>
</tr>
<tr>
<td>
<p><code>:documents</code></p>
</td>
<td>
<p><code>:post_write</code></p>
</td>
<td>
<p>After writing a document to disk</p>
</td>
</tr>
</tbody>
</table>
</div>
## Available Plugins
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.
- [Pageless Redirect Generator by Nick Quinlan](https://github.com/nquinlan/jekyll-pageless-redirects): Generates redirects based on files in the Jekyll root, with support for htaccess style redirects.
- [RssGenerator by Assaf Gelber](https://github.com/agelber/jekyll-rss): Automatically creates an RSS 2.0 feed from your posts.
- [Monthly archive generator by Shigeya Suzuki](https://github.com/shigeya/jekyll-monthly-archive-plugin): Generator and template which renders monthly archive like MovableType style, based on the work by Ilkka Laukkanen and others above.
- [Category archive generator by Shigeya Suzuki](https://github.com/shigeya/jekyll-category-archive-plugin): Generator and template which renders category archive like MovableType style, based on Monthly archive generator.
- [Emoji for Jekyll](https://github.com/yihangho/emoji-for-jekyll): Seamlessly enable emoji for all posts and pages.
- [Compass integration for Jekyll](https://github.com/mscharley/jekyll-compass): Easily integrate Compass and Sass with your Jekyll website.
- [Pages Directory by Ben Baker-Smith](https://github.com/bbakersmith/jekyll-pages-directory): Defines a `_pages` directory for page files which routes its output relative to the project root.
- [Page Collections by Jeff Kolesky](https://github.com/jeffkole/jekyll-page-collections): Generates collections of pages with functionality that resembles posts.
- [Windows 8.1 Live Tile Generation by Matt Sheehan](https://github.com/sheehamj13/jekyll-live-tiles): Generates Internet Explorer 11 config.xml file and Tile Templates for pinning your site to Windows 8.1.
- [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.
- [Jekyll Flickr Plugin](https://github.com/lawmurray/indii-jekyll-flickr) by [Lawrence Murray](http://www.indii.org): Generates posts for photos uploaded to a Flickr photostream.
- [Jekyll::Paginate::Category](https://github.com/midnightSuyama/jekyll-paginate-category): Pagination Generator for Jekyll Category.
- [AMP-Jekyll by Juuso Mikkonen](https://github.com/juusaw/amp-jekyll): Generate [Accelerated Mobile Pages](https://www.ampproject.org) of Jekyll posts.
- [Jekyll Art Gallery plugin](https://github.com/alexivkin/Jekyll-Art-Gallery-Plugin): An advanced art/photo gallery generation plugin for creating galleries from a set of image folders. Supports image tagging, thumbnails, sorting, image rotation, post-processing (remove EXIF, add watermark), multiple collections and much more.
- [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.
#### Converters
- [Textile converter](https://github.com/jekyll/jekyll-textile-converter): Convert `.textile` files into HTML. Also includes the `textilize` Liquid filter.
- [Slim plugin](https://github.com/slim-template/jekyll-slim): Slim converter and includes for Jekyll with support for Liquid tags.
- [Jade plugin by John Papandriopoulos](https://github.com/snappylabs/jade-jekyll-plugin): Jade converter for Jekyll.
- [Pug plugin by Josh Waller](https://github.com/mdxprograms/pug-jekyll-plugin): Pug (previously Jade) converter for Jekyll.
- [HAML plugin by Sam Z](https://gist.github.com/517556): HAML converter for Jekyll.
- [HAML-Sass Converter by Adam Pearson](https://gist.github.com/481456): Simple HAML-Sass converter for Jekyll. [Fork](https://gist.github.com/528642) by Sam X.
- [Sass SCSS Converter by Mark Wolfe](https://gist.github.com/960150): Sass converter which uses the new CSS compatible syntax, based Sam 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/).
- [Lazy Tweet Embedding](https://github.com/takuti/jekyll-lazy-tweet-embedding): Automatically convert tweet urls into twitter cards.
- [jekyll-commonmark](https://github.com/pathawks/jekyll-commonmark): Markdown converter that uses [libcmark](https://github.com/jgm/CommonMark), the reference parser for CommonMark.
#### Filters
- [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.
- [Table of Content Generator](https://github.com/dafi/jekyll-toc-generator): Generate the HTML code containing a table of content (TOC), the TOC can be customized in many way, for example you can decide which pages can be without TOC.
- [jekyll-toc](https://github.com/toshimaru/jekyll-toc): A liquid filter plugin for Jekyll which generates a table of contents.
- [jekyll-humanize](https://github.com/23maverick23/jekyll-humanize): This is a port of the Django app humanize which adds a "human touch" to data. Each method represents a Fluid type filter that can be used in your Jekyll site templates. Given that Jekyll produces static sites, some of the original methods do not make logical sense to port (e.g. naturaltime).
- [Jekyll-Ordinal](https://github.com/PatrickC8t/Jekyll-Ordinal): Jekyll liquid filter to output a date ordinal such as "st", "nd", "rd", or "th".
- [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/).
- [Jekyll Email Protect](https://github.com/vwochnik/jekyll-email-protect): Email protection liquid filter for Jekyll
- [Jekyll Uglify Filter](https://github.com/mattg/jekyll-uglify-filter): A Liquid filter that runs your JavaScript through UglifyJS.
- [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.
#### Tags
- [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.
- [Jekyll Responsive Image](https://github.com/wildlyinaccurate/jekyll-responsive-image): Responsive images for Jekyll. Automatically resizes images, supports all responsive methods (`<picture>`, `srcset`, Imager.js, etc), super-flexible configuration.
- [Ditaa Tag](https://github.com/matze/jekyll-ditaa) by [matze](https://github.com/matze): Renders ASCII diagram art into PNG images and inserts a figure tag.
- [Jekyll Suggested Tweet](https://github.com/davidensinger/jekyll-suggested-tweet) by [David Ensinger](https://github.com/davidensinger/): A Liquid tag for Jekyll that allows for the embedding of suggested tweets via Twitters Web Intents API.
- [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.
- [Jekyll Project Version Tag](https://github.com/rob-murray/jekyll-version-plugin): A Liquid tag plugin that renders a version identifier for your Jekyll site sourced from the git repository containing your code.
- [Piwigo Gallery](https://github.com/AlessandroLorenzi/piwigo_gallery) by [Alessandro Lorenzi](http://blog.alorenzi.eu/): Jekyll plugin to generate thumbnails from a Piwigo gallery and display them with a Liquid tag
- [mathml.rb](https://github.com/tmthrgd/jekyll-plugins) by Tom Thorogood: A plugin to convert TeX mathematics into MathML for display.
- [webmention_io.rb](https://github.com/aarongustafson/jekyll-webmention_io) by [Aaron Gustafson](http://aaron-gustafson.com/): A plugin to enable [webmention](https://indieweb.org/webmention) integration using [Webmention.io](https://webmention.io/). Includes an optional JavaScript for updating webmentions automatically between publishes and, if available, in realtime using WebSockets.
- [Jekyll 500px Embed](https://github.com/lkorth/jekyll-500px-embed) by Luke Korth. A Liquid tag plugin that embeds [500px](https://500px.com/) photos.
- [inline\_highlight](https://github.com/bdesham/inline_highlight): A tag for inline syntax highlighting.
- [jekyll-mermaid](https://github.com/jasonbellamy/jekyll-mermaid): Simplify the creation of mermaid diagrams and flowcharts in your posts and pages.
- [twa](https://github.com/Ezmyrelda/twa): Twemoji Awesome plugin for Jekyll. Liquid tag allowing you to use twitter emoji in your jekyll pages.
- [Fetch remote file content](https://github.com/dimitri-koenig/jekyll-plugins) by [Dimitri König](https://www.dimitrikoenig.net/): Using `remote_file_content` tag you can fetch the content of a remote file and include it as if you would put the content right into your markdown file yourself. Very useful for including code from github repo's to always have a current repo version.
- [jekyll-asciinema](https://github.com/mnuessler/jekyll-asciinema): A tag for embedding asciicasts recorded with [asciinema](https://asciinema.org) in your Jekyll pages.
- [Jekyll-Youtube](https://github.com/dommmel/jekyll-youtube) A Liquid tag that embeds Youtube videos. The default emded markup is responsive but you can also specify your own by using an include/partial.
- [Jekyll Flickr Plugin](https://github.com/lawmurray/indii-jekyll-flickr) by [Lawrence Murray](http://www.indii.org): Embeds Flickr photosets (albums) as a gallery of thumbnails, with lightbox links to larger images.
- [jekyll-figure](https://github.com/paulrobertlloyd/jekyll-figure): A liquid tag for Jekyll that generates `<figure>` elements.
- [Jekyll Video Embed](https://github.com/eug/jekyll-video-embed): It provides several tags to easily embed videos (e.g. Youtube, Vimeo, UStream and Ted Talks)
- [jekyll-i18n_tags](https://github.com/KrzysiekJ/jekyll-i18n_tags): Translate your templates.
- [Jekyll Ideal Image Slider](https://github.com/xHN35RQ/jekyll-ideal-image-slider): Liquid tag plugin to create image sliders using [Ideal Image Slider](https://github.com/gilbitron/Ideal-Image-Slider).
- [Jekyll Tags List Plugin](https://github.com/crispgm/jekyll-tags-list-plugin): A Liquid tag plugin that creates tags list in specific order.
- [Jekyll Maps](https://github.com/ayastreb/jekyll-maps) by [Anatoliy Yastreb](https://github.com/ayastreb): A Jekyll plugin to easily embed maps with filterable locations.
- [Jekyll Cloudinary](https://nhoizey.github.io/jekyll-cloudinary/) by [Nicolas Hoizey](https://nicolas-hoizey.com/): a Jekyll plugin adding a Liquid tag to ease the use of Cloudinary for responsive images in your Markdown/Kramdown posts.
- [jekyll-include-absolute-plugin](https://github.com/tnhu/jekyll-include-absolute-plugin) by [Tan Nhu](https://github.com/tnhu): A Jekyll plugin to include a file from its path relative to Jekyll's source folder.
- [Jekyll Download Tag](https://github.com/mattg/jekyll-download-tag): A Liquid tag that acts like `include`, but for external resources.
#### Collections
- [Jekyll Plugins by Recursive Design](https://github.com/recurser/jekyll-plugins): Plugins to generate Project pages from GitHub readmes, a Category page, and a Sitemap generator.
- [Company website and blog plugins](https://github.com/flatterline/jekyll-plugins) by Flatterline, a Ruby on Rails development company: Portfolio/project page generator, team/individual page generator, an author bio liquid tag for use on posts, and a few other smaller plugins.
- [Jekyll plugins by Aucor](https://github.com/aucor/jekyll-plugins): Plugins for trimming unwanted newlines/whitespace and sorting pages by weight attribute.
#### Other
- [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.
- [grunt-jekyll](https://github.com/dannygarcia/grunt-jekyll): A straightforward [Grunt](http://gruntjs.com/) plugin for Jekyll.
- [jekyll-postfiles](https://github.com/indirect/jekyll-postfiles): Add `_postfiles` directory and {% raw %}`{{ postfile }}`{% endraw %} tag so the files a post refers to will always be right there inside your repo.
- [A layout that compresses HTML](http://jch.penibelst.de/): GitHub Pages compatible, configurable way to compress HTML files on site build.
- [Jekyll CO₂](https://github.com/wdenton/jekyll-co2): Generates HTML showing the monthly change in atmospheric CO₂ at the Mauna Loa observatory in Hawaii.
- [remote-include](http://www.northfieldx.co.uk/remote-include/): Includes files using remote URLs
- [jekyll-minifier](https://github.com/digitalsparky/jekyll-minifier): Minifies HTML, XML, CSS, and Javascript both inline and as separate files utilising yui-compressor and htmlcompressor.
- [Jekyll views router](https://bitbucket.org/nyufac/jekyll-views-router): Simple router between generator plugins and templates.
- [Jekyll Language Plugin](https://github.com/vwochnik/jekyll-language-plugin): Jekyll 3.0-compatible multi-language plugin for posts, pages and includes.
- [Jekyll Deploy](https://github.com/vwochnik/jekyll-deploy): Adds a `deploy` sub-command to Jekyll.
- [Official Contentful Jekyll Plugin](https://github.com/contentful/jekyll-contentful-data-import): Adds a `contentful` sub-command to Jekyll to import data from Contentful.
- [jekyll-paspagon](https://github.com/KrzysiekJ/jekyll-paspagon): Sell your posts in various formats for cryptocurrencies.
- [Hawkins](https://github.com/awood/hawkins): Adds a `liveserve` sub-command to Jekyll that incorporates [LiveReload](http://livereload.com/) into your pages while you preview them. No more hitting the refresh button in your browser!
- [Jekyll Autoprefixer](https://github.com/vwochnik/jekyll-autoprefixer): Autoprefixer integration for Jekyll
- [Jekyll-breadcrumbs](https://github.com/git-no/jekyll-breadcrumbs): Creates breadcrumbs for Jekyll 3.x, includes features like SEO optimization, optional breadcrumb item translation and more.
- [generator-jekyllized](https://github.com/sondr3/generator-jekyllized): A Yeoman generator for rapidly developing sites with Gulp. Live reload your site, automatically minify and optimize your assets and much more.
- [Jekyll-Spotify](https://github.com/MertcanGokgoz/Jekyll-Spotify): Easily output Spotify Embed Player for jekyll
- [jekyll-menus](https://github.com/forestryio/jekyll-menus): Hugo style menus for your Jekyll site... recursive menus included.
- [jekyll-data](https://github.com/ashmaroli/jekyll-data): Read data files within Jekyll Theme Gems.
- [jekyll-pinboard](https://github.com/snaptortoise/jekyll-pinboard-plugin): Access your Pinboard bookmarks within your Jekyll theme.
- [jekyll-migrate-permalink](https://github.com/mpchadwick/jekyll-migrate-permalink): Adds a `migrate-permalink` sub-command to help deal with side effects of changing your permalink.
- [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.
<div class="note info">
<h5>Jekyll Plugins Wanted</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
out how to make that happen.
</p>
</div>
* [Installation](/docs/plugins/installation/) - How to install plugins
* [Your first plugin](/docs/plugins/your-first-plugin/) - How to write plugins
* [Generators](/docs/plugins/generators/) - Create additional content on your site
* [Converters](/docs/plugins/converters/) - Change a markup language into another format
* [Commands](/docs/plugins/commands/) - Extend the `jekyll` executable with subcommands
* [Tags](/docs/plugins/tags) - Create custom Liquid tags
* [Filters](/docs/plugins/filters/) - Create custom Liquid filters
* [Hooks](/docs/plugins/hooks/) - Fine-grained control to extend the build process

View File

@@ -0,0 +1,62 @@
---
title: Commands
permalink: /docs/plugins/commands/
---
Jekyll can be extended with plugins which provide
subcommands for the `jekyll` executable. This is possible by including the
relevant plugins in a `Gemfile` group called `:jekyll_plugins`:
```ruby
group :jekyll_plugins do
gem "my_fancy_jekyll_plugin"
end
```
Each `Command` must be a subclass of the `Jekyll::Command` class and must
contain one class method: `init_with_program`. An example:
```ruby
class MyNewCommand < Jekyll::Command
class << self
def init_with_program(prog)
prog.command(:new) do |c|
c.syntax "new [options]"
c.description 'Create a new Jekyll site.'
c.option 'dest', '-d DEST', 'Where the site should go.'
c.action do |args, options|
Jekyll::Site.new_site_at(options['dest'])
end
end
end
end
end
```
Commands should implement this single class method:
<div class="mobile-side-scroller">
<table>
<thead>
<tr>
<th>Method</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<p><code>init_with_program</code></p>
</td>
<td><p>
This method accepts one parameter, the
<code><a href="https://github.com/jekyll/mercenary#readme">Mercenary::Program</a></code>
instance, which is the Jekyll program itself. Upon the program,
commands may be created using the above syntax. For more details,
visit the Mercenary repository on GitHub.com.
</p></td>
</tr>
</tbody>
</table>
</div>

View File

@@ -0,0 +1,91 @@
---
title: Converters
permalink: /docs/plugins/converters/
---
If you have a new markup language youd like to use with your site, you can
include it by implementing your own converter. Both the Markdown and
[Textile](https://github.com/jekyll/jekyll-textile-converter) markup
languages are implemented using this method.
<div class="note info">
<h5>Remember your Front Matter</h5>
<p>
Jekyll will only convert files that have a YAML header at the top, even for
converters you add using a plugin.
</p>
</div>
Below is a converter that will take all posts ending in `.upcase` and process
them using the `UpcaseConverter`:
```ruby
module Jekyll
class UpcaseConverter < Converter
safe true
priority :low
def matches(ext)
ext =~ /^\.upcase$/i
end
def output_ext(ext)
".html"
end
def convert(content)
content.upcase
end
end
end
```
Converters should implement at a minimum 3 methods:
<div class="mobile-side-scroller">
<table>
<thead>
<tr>
<th>Method</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<p><code>matches</code></p>
</td>
<td><p>
Does the given extension match this converters list of acceptable
extensions? Takes one argument: the files extension (including the
dot). Must return <code>true</code> if it matches, <code>false</code>
otherwise.
</p></td>
</tr>
<tr>
<td>
<p><code>output_ext</code></p>
</td>
<td><p>
The extension to be given to the output file (including the dot).
Usually this will be <code>".html"</code>.
</p></td>
</tr>
<tr>
<td>
<p><code>convert</code></p>
</td>
<td><p>
Logic to do the content conversion. Takes one argument: the raw content
of the file (without front matter). Must return a String.
</p></td>
</tr>
</tbody>
</table>
</div>
In our example, `UpcaseConverter#matches` checks if our filename extension is
`.upcase`, and will render using the converter if it is. It will call
`UpcaseConverter#convert` to process the content. In our simple converter were
simply uppercasing the entire content string. Finally, when it saves the page,
it will do so with a `.html` extension.

View File

@@ -0,0 +1,27 @@
---
title: Filters
permalink: /docs/plugins/filters/
---
Filters are modules that export their methods to liquid.
All methods will have to take at least one parameter which represents the input
of the filter. The return value will be the output of the filter.
```ruby
module Jekyll
module AssetFilter
def asset_url(input)
"http://www.example.com/#{input}?#{Time.now.to_i}"
end
end
end
Liquid::Template.register_filter(Jekyll::AssetFilter)
```
## Access the site object in Liquid
Jekyll lets you access the `site` object through the
`context.registers` feature of Liquid at `context.registers[:site]`. For example, you can
access the global configuration file `_config.yml` using
`context.registers[:site].config`.

View File

@@ -0,0 +1,103 @@
---
title: Generators
permalink: /docs/plugins/generators/
---
You can create a generator when you need Jekyll to create additional content
based on your own rules.
A generator is a subclass of `Jekyll::Generator` that defines a `generate`
method, which receives an instance of
[`Jekyll::Site`]({{ site.repository }}/blob/master/lib/jekyll/site.rb). The
return value of `generate` is ignored.
Generators run after Jekyll has made an inventory of the existing content, and
before the site is generated. Pages with front matter are stored as
instances of
[`Jekyll::Page`]({{ site.repository }}/blob/master/lib/jekyll/page.rb)
and are available via `site.pages`. Static files become instances of
[`Jekyll::StaticFile`]({{ site.repository }}/blob/master/lib/jekyll/static_file.rb)
and are available via `site.static_files`. See
[the Variables documentation page](/docs/variables/) and
[`Jekyll::Site`]({{ site.repository }}/blob/master/lib/jekyll/site.rb)
for more details.
For instance, a generator can inject values computed at build time for template
variables. In the following example the template `reading.html` has two
variables `ongoing` and `done` that we fill in the generator:
```ruby
module Reading
class Generator < Jekyll::Generator
def generate(site)
ongoing, done = Book.all.partition(&:ongoing?)
reading = site.pages.detect {|page| page.name == 'reading.html'}
reading.data['ongoing'] = ongoing
reading.data['done'] = done
end
end
end
```
This is a more complex generator that generates new pages:
```ruby
module Jekyll
class CategoryPage < Page
def initialize(site, base, dir, category)
@site = site
@base = base
@dir = dir
@name = 'index.html'
self.process(@name)
self.read_yaml(File.join(base, '_layouts'), 'category_index.html')
self.data['category'] = category
category_title_prefix = site.config['category_title_prefix'] || 'Category: '
self.data['title'] = "#{category_title_prefix}#{category}"
end
end
class CategoryPageGenerator < Generator
safe true
def generate(site)
if site.layouts.key? 'category_index'
dir = site.config['category_dir'] || 'categories'
site.categories.each_key do |category|
site.pages << CategoryPage.new(site, site.source, File.join(dir, category), category)
end
end
end
end
end
```
In this example, our generator will create a series of files under the
`categories` directory for each category, listing the posts in each category
using the `category_index.html` layout.
Generators are only required to implement one method:
<div class="mobile-side-scroller">
<table>
<thead>
<tr>
<th>Method</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<p><code>generate</code></p>
</td>
<td>
<p>Generates content as a side-effect.</p>
</td>
</tr>
</tbody>
</table>
</div>

244
docs/_docs/plugins/hooks.md Normal file
View File

@@ -0,0 +1,244 @@
---
title: Hooks
permalink: /docs/plugins/hooks/
---
Using hooks, your plugin can exercise fine-grained control over various aspects
of the build process. If your plugin defines any hooks, Jekyll will call them
at pre-defined points.
Hooks are registered to a container and an event name. To register one, you
call Jekyll::Hooks.register, and pass the container, event name, and code to
call whenever the hook is triggered. For example, if you want to execute some
custom functionality every time Jekyll renders a post, you could register a
hook like this:
```ruby
Jekyll::Hooks.register :posts, :post_render do |post|
# code to call after Jekyll renders a post
end
```
Jekyll provides hooks for <code>:site</code>, <code>:pages</code>,
<code>:posts</code>, and <code>:documents</code>. In all cases, Jekyll calls
your hooks with the container object as the first callback parameter.
All `:pre_render` hooks and the`:site, :post_render` hook will also provide a
payload hash as a second parameter. In the case of `:pre_render`, the payload
gives you full control over the variables that are available while rendering.
In the case of `:site, :post_render`, the payload contains final values after
rendering all the site (useful for sitemaps, feeds, etc).
The complete list of available hooks is below:
<div class="mobile-side-scroller">
<table>
<thead>
<tr>
<th>Container</th>
<th>Event</th>
<th>Called</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<p><code>:site</code></p>
</td>
<td>
<p><code>:after_init</code></p>
</td>
<td>
<p>Just after the site initializes, but before setup & render. Good
for modifying the configuration of the site.</p>
</td>
</tr>
<tr>
<td>
<p><code>:site</code></p>
</td>
<td>
<p><code>:after_reset</code></p>
</td>
<td>
<p>Just after site reset</p>
</td>
</tr>
<tr>
<td>
<p><code>:site</code></p>
</td>
<td>
<p><code>:post_read</code></p>
</td>
<td>
<p>After site data has been read and loaded from disk</p>
</td>
</tr>
<tr>
<td>
<p><code>:site</code></p>
</td>
<td>
<p><code>:pre_render</code></p>
</td>
<td>
<p>Just before rendering the whole site</p>
</td>
</tr>
<tr>
<td>
<p><code>:site</code></p>
</td>
<td>
<p><code>:post_render</code></p>
</td>
<td>
<p>After rendering the whole site, but before writing any files</p>
</td>
</tr>
<tr>
<td>
<p><code>:site</code></p>
</td>
<td>
<p><code>:post_write</code></p>
</td>
<td>
<p>After writing the whole site to disk</p>
</td>
</tr>
<tr>
<td>
<p><code>:pages</code></p>
</td>
<td>
<p><code>:post_init</code></p>
</td>
<td>
<p>Whenever a page is initialized</p>
</td>
</tr>
<tr>
<td>
<p><code>:pages</code></p>
</td>
<td>
<p><code>:pre_render</code></p>
</td>
<td>
<p>Just before rendering a page</p>
</td>
</tr>
<tr>
<td>
<p><code>:pages</code></p>
</td>
<td>
<p><code>:post_render</code></p>
</td>
<td>
<p>After rendering a page, but before writing it to disk</p>
</td>
</tr>
<tr>
<td>
<p><code>:pages</code></p>
</td>
<td>
<p><code>:post_write</code></p>
</td>
<td>
<p>After writing a page to disk</p>
</td>
</tr>
<tr>
<td>
<p><code>:posts</code></p>
</td>
<td>
<p><code>:post_init</code></p>
</td>
<td>
<p>Whenever a post is initialized</p>
</td>
</tr>
<tr>
<td>
<p><code>:posts</code></p>
</td>
<td>
<p><code>:pre_render</code></p>
</td>
<td>
<p>Just before rendering a post</p>
</td>
</tr>
<tr>
<td>
<p><code>:posts</code></p>
</td>
<td>
<p><code>:post_render</code></p>
</td>
<td>
<p>After rendering a post, but before writing it to disk</p>
</td>
</tr>
<tr>
<td>
<p><code>:posts</code></p>
</td>
<td>
<p><code>:post_write</code></p>
</td>
<td>
<p>After writing a post to disk</p>
</td>
</tr>
<tr>
<td>
<p><code>:documents</code></p>
</td>
<td>
<p><code>:post_init</code></p>
</td>
<td>
<p>Whenever a document is initialized</p>
</td>
</tr>
<tr>
<td>
<p><code>:documents</code></p>
</td>
<td>
<p><code>:pre_render</code></p>
</td>
<td>
<p>Just before rendering a document</p>
</td>
</tr>
<tr>
<td>
<p><code>:documents</code></p>
</td>
<td>
<p><code>:post_render</code></p>
</td>
<td>
<p>After rendering a document, but before writing it to disk</p>
</td>
</tr>
<tr>
<td>
<p><code>:documents</code></p>
</td>
<td>
<p><code>:post_write</code></p>
</td>
<td>
<p>After writing a document to disk</p>
</td>
</tr>
</tbody>
</table>
</div>

View File

@@ -0,0 +1,66 @@
---
title: Plugins
permalink: /docs/plugins/installation/
---
There are three 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` (or `gems` for Jekyll < `3.5.0`) and the
values of the gem names of the plugins you'd like to use. An example:
```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-gist jekyll-coffeescript jekyll-assets another-jekyll-plugin`
3. Add the relevant plugins to a Bundler group in your `Gemfile`. An
example:
```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`.
## Plugins on GitHub Pages
[GitHub Pages](https://pages.github.com/) is powered by Jekyll.
All Pages sites are generated using the `--safe` option
to disable plugins (with the exception of some
[whitelisted plugins](https://pages.github.com/versions)) for
security reasons. Unfortunately, this means
your plugins wont work if youre deploying to GitHub Pages.
You can still use GitHub Pages to publish your site, but youll need to
convert the site locally and push the generated static files to your GitHub
repository instead of the Jekyll source files.
## 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.
Gems included in the `:jekyll-plugins` group are activated
regardless of the `--safe` mode setting. Be aware of what
gems are included under this group!
{: .warning }

View File

@@ -0,0 +1,72 @@
---
title: Tags
permalink: /docs/plugins/tags/
---
If youd like to include custom liquid tags in your site, you can do so by
hooking into the tagging system. Built-in examples added by Jekyll include the
`highlight` and `include` tags. Below is an example of a custom liquid tag that
will output the time the page was rendered:
```ruby
module Jekyll
class RenderTimeTag < Liquid::Tag
def initialize(tag_name, text, tokens)
super
@text = text
end
def render(context)
"#{@text} #{Time.now}"
end
end
end
Liquid::Template.register_tag('render_time', Jekyll::RenderTimeTag)
```
At a minimum, liquid tags must implement:
<div class="mobile-side-scroller">
<table>
<thead>
<tr>
<th>Method</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<p><code>render</code></p>
</td>
<td>
<p>Outputs the content of the tag.</p>
</td>
</tr>
</tbody>
</table>
</div>
You must also register the custom tag with the Liquid template engine as
follows:
```ruby
Liquid::Template.register_tag('render_time', Jekyll::RenderTimeTag)
```
In the example above, we can place the following tag anywhere in one of our
pages:
{% raw %}
```ruby
<p>{% render_time page rendered at: %}</p>
```
{% endraw %}
And we would get something like this on the page:
```html
<p>page rendered at: Tue June 22 23:38:47 0500 2010</p>
```

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