Compare commits

..

1507 Commits

Author SHA1 Message Date
Ashwin Maroli
33faf349c1 Debug Jekyll issue - 7328 2018-10-30 15:17:04 +05:30
Frank Taillandier
cc52cac81a Release 💎 3.8.4 2018-09-18 23:50:26 +02:00
Frank Taillandier
91abe9f741 Release 💎 3.8.4 2018-09-18 23:49:03 +02:00
Parker Moore
d9a2758ff6 3.8.x: security: fix include bypass of EntryFilter#filter symlink check (#7228)
Merge pull request 7228
2018-09-18 12:24:15 -04: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
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
Pat Hawks
d22b8ee392 Release 💎 3.8.2 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
Pat Hawks
3ed4dbd227 Release 💎 3.8.1 2018-05-01 15:00:40 -05: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
43de0b694f Update history to reflect merge of #6970 [ci skip] 2018-04-30 19:55:26 -05:00
Pat Hawks
a89bba3712 Fix rendering Liquid constructs in excerpts (#6970)
Merge pull request 6970
2018-04-30 20:49:16 -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
Parker Moore
76feebd2d2 Release 💎 3.4.0 2017-01-27 11:06:00 -05:00
Parker Moore
5183bde7b8 Update release date of 3.4.0 2017-01-27 11:05:55 -05:00
Parker Moore
eca4b94c3a Remove jona as contributor. 2017-01-26 16:26:39 -05:00
Parker Moore
6d34cf18fb New list of contributors 2017-01-26 16:24:53 -05:00
Parker Moore
7c1aae3e30 Update history on website to reflect new things merged 2017-01-26 16:24:45 -05:00
Parker Moore
d266354e42 Merge branch 'master' into release-3-4-0
* master: (39 commits)
  Update history to reflect merge of #5798 [ci skip]
  Update history to reflect merge of #5822 [ci skip]
  use logger.info
  run codeclimate after success
  Update history to reflect merge of #5819 [ci skip]
  Fixed inaccuracy in "Built-in permalink styles" docs [skip ci]
  Update history to reflect merge of #5802 [ci skip]
  Update history to reflect merge of #5811 [ci skip]
  Update history to reflect merge of #5690 [ci skip]
  Update history to reflect merge of #5815 [ci skip]
  Review CI pages
  Rework CI doc to include multiple providers.
  Update history to reflect merge of #5812 [ci skip]
  Add jekyll-ga plug-in
  Update configuration.md
  Add mention of classifier-reborn for LSI
  Update history to reflect merge of #5810 [ci skip]
  Got that diaper money?
  Added note about --blank flag
  Update history to reflect merge of #5797 [ci skip]
  ...
2017-01-26 16:15:07 -05:00
jekyllbot
f0dcc9415b Update history to reflect merge of #5798 [ci skip] 2017-01-26 15:53:46 -05:00
jekyllbot
17ccfdca4f Merge pull request #5798 from DirtyF/bump-codeclimate-test-reporter
Merge pull request 5798
2017-01-26 15:53:44 -05:00
jekyllbot
4a781f23f3 Update history to reflect merge of #5822 [ci skip] 2017-01-26 15:52:26 -05:00
jekyllbot
27482899e7 Merge pull request #5822 from joelmeyerhamme/patch-1
Merge pull request 5822
2017-01-26 15:52:24 -05:00
Joel Meyer-Hamme
4b19e93f09 use logger.info
Imo running `--lsi` should use `Jekyll.logger.info`, so it can be made `--quiet`.
2017-01-26 16:02:08 +00: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
Frank Taillandier
ef8779dbfd run codeclimate after success 2017-01-25 14:06:27 +01:00
jekyllbot
e56d809298 Update history to reflect merge of #5819 [ci skip] 2017-01-25 07:29:43 -05:00
jekyllbot
7a4c58c4b7 Merge pull request #5819 from arogachev/patch-1
Merge pull request 5819
2017-01-25 07:29:42 -05:00
Alexey Rogachev
ecdc8a5bf2 Fixed inaccuracy in "Built-in permalink styles" docs [skip ci]
Must be either:

> Rather than typing `permalink: /:categories/:year/:month/:day/:title/`, you can just type `permalink: pretty`.

or:

> Rather than typing `permalink: /:categories/:year/:month/:day/:title.html`, you can just type `permalink: date`.

I guess the former was meant to write because the latter was already mentioned in "Where to configure permalinks" section.
2017-01-25 15:22:26 +06: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
penny
92c0890fbd let's not use my deadname 2017-01-24 21:09:08 +01:00
Frank Taillandier
452b0cf29d mention documentation improvements 2017-01-24 20:59:07 +01:00
Frank Taillandier
886de9f37d Group all documentation related changes 2017-01-24 20:53:27 +01:00
Frank Taillandier
9eef1d9f5a add contributors 2017-01-24 20:52:34 +01: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
jekyllbot
6b08c14ccc Update history to reflect merge of #5802 [ci skip] 2017-01-24 12:51:25 -05:00
jekyllbot
15728936a9 Merge pull request #5802 from ajaykarwal/master
Merge pull request 5802
2017-01-24 12:51:23 -05:00
jekyllbot
770ef586f5 Update history to reflect merge of #5811 [ci skip] 2017-01-24 10:45:27 -05:00
jekyllbot
4ced56d0c8 Merge pull request #5811 from nhoizey/patch-3
Merge pull request 5811
2017-01-24 10:45:26 -05:00
jekyllbot
b0a7c4df0a Update history to reflect merge of #5690 [ci skip] 2017-01-24 10:41:13 -05:00
jekyllbot
f552652780 Merge pull request #5690 from tomjohnson1492/patch-4
Merge pull request 5690
2017-01-24 10:41:12 -05:00
jekyllbot
451fd8e15f Update history to reflect merge of #5815 [ci skip] 2017-01-24 10:39:54 -05:00
jekyllbot
e97cd0d4c7 Merge pull request #5815 from felicianotech/expand-ci-section
Merge pull request 5815
2017-01-24 10:39:53 -05:00
Parker Moore
e19acd99dc Include more verbiage to the 3.4.0 release post. 2017-01-23 20:08:44 -05:00
Ricardo N Feliciano
62fa0c54bc Merge pull request #2 from DirtyF/expand-ci-section
Review CI pages
2017-01-23 19:56:28 -05:00
Frank Taillandier
aefec6654d Review CI pages 2017-01-24 01:42:53 +01:00
Ricardo N Feliciano
3a3ceff150 Rework CI doc to include multiple providers. 2017-01-23 16:59:39 -05:00
Frank Taillandier
2662319641 typo 2017-01-23 19:58:20 +01:00
jekyllbot
2a56e9ce0d Update history to reflect merge of #5812 [ci skip] 2017-01-23 11:53:13 -05:00
jekyllbot
9792eda1c6 Merge pull request #5812 from jhabdas/jekyll-ga-generator
Merge pull request 5812
2017-01-23 11:53:12 -05:00
Josh Habdas
2a2602cf61 Add jekyll-ga plug-in 2017-01-23 18:03:18 +08:00
Nicolas Hoizey
e6392ea6dd Update configuration.md 2017-01-23 10:06:24 +01:00
Nicolas Hoizey
03722f022e Add mention of classifier-reborn for LSI
classifier-reborn is mandatory for LSI since Jekyll 3.0
2017-01-22 22:12:58 +01:00
jekyllbot
c1b542e066 Update history to reflect merge of #5810 [ci skip] 2017-01-22 12:00:29 -05:00
jekyllbot
658f827d17 Merge pull request #5810 from jhabdas/jekyll-money
Merge pull request 5810
2017-01-22 12:00:28 -05:00
Josh Habdas
f7186c86c4 Got that diaper money? 2017-01-22 22:33:21 +08:00
Ajay Karwal
eb54e270f9 Added note about --blank flag
Added instructions about installing Jekyll with a blank slate using the --blank flag.
2017-01-21 00:17:14 +00:00
jekyllbot
9fe73be101 Update history to reflect merge of #5797 [ci skip] 2017-01-20 13:59:19 -05:00
jekyllbot
cf606191ee Merge pull request #5797 from DirtyF/bump-rdoc
Merge pull request 5797
2017-01-20 13:59:17 -05:00
Frank Taillandier
12201d4f1b update excluded paths 2017-01-20 09:59:06 +01:00
jekyllbot
4804806266 Update history to reflect merge of #5799 [ci skip] 2017-01-20 03:42:02 -05:00
jekyllbot
a6b9482abd Merge pull request #5799 from sparanoid/patch-2
Merge pull request 5799
2017-01-20 03:42:00 -05:00
Tunghsiao Liu
4ed4c43044 Add match_regex and replace_regex filters 2017-01-20 15:14:23 +08:00
Frank Taillandier
5ed22d0b3e Now we must execute SimpleCov 2017-01-19 22:39:39 +01:00
Frank Taillandier
6ec2145c0c bump codeclimate-test-reporter to v1.0.5 2017-01-19 22:15:07 +01:00
Frank Taillandier
63dfe080db bump rdoc to v5.0 2017-01-19 22:06:37 +01:00
Frank Taillandier
84e9ea82d1 Merge branch 'master' into patch-1 2017-01-19 18:12:05 +01:00
jekyllbot
60ba3fc0c9 Update history to reflect merge of #5736 [ci skip] 2017-01-19 08:55:04 -05:00
jekyllbot
4697ddabec Merge pull request #5736 from DirtyF/fix-broken-links
Merge pull request 5736
2017-01-19 08:55:02 -05:00
Frank Taillandier
02f092809a Merge branch 'master' into fix-broken-links 2017-01-19 14:14:12 +01:00
Parker Moore
b7f44e6eca Queue up a 3.4 deploy with unfinished release post. 2017-01-18 16:54:36 -05:00
jekyllbot
b2d93913d0 Update history to reflect merge of #5694 [ci skip] 2017-01-18 15:36:13 -05:00
jekyllbot
036d447f68 Merge pull request #5694 from tomjohnson1492/patch-8
Merge pull request 5694
2017-01-18 15:36:11 -05:00
Parker Moore
b6bc85ec7c Correct 2 Style/TrailingCommaInLiteral rubocop offenses in test_filters.rb 2017-01-18 14:16:08 -05:00
jekyllbot
0599c22425 Update history to reflect merge of #5640 [ci skip] 2017-01-18 14:15:13 -05:00
jekyllbot
477b2f0f3e Merge pull request #5640 from jekyll/jekyll-utils-exec
Merge pull request 5640
2017-01-18 14:15:11 -05:00
jekyllbot
402eb0dfa5 Update history to reflect merge of #5542 [ci skip] 2017-01-17 20:21:49 -05:00
jekyllbot
76e9b8d266 Merge pull request #5542 from ashmaroli/url-slash
Merge pull request 5542
2017-01-17 20:21:48 -05:00
jekyllbot
0b4a097a40 Update history to reflect merge of #5753 [ci skip] 2017-01-17 20:20:36 -05:00
jekyllbot
20c6aec88f Merge pull request #5753 from DirtyF/docs-merge-categories
Merge pull request 5753
2017-01-17 20:20:35 -05:00
jekyllbot
a9c7e14d60 Update history to reflect merge of #5780 [ci skip] 2017-01-17 18:59:39 -05:00
jekyllbot
b5d1be4dcf Merge pull request #5780 from jekyll/dont-include-in-load-path-if-nil
Merge pull request 5780
2017-01-17 18:59:38 -05:00
Parker Moore
2c19264d08 Add a philosophy doc. 2017-01-17 18:51:49 -05:00
Parker Moore
130159dda4 Fix rubocop error. 2017-01-17 17:05:14 -05:00
Parker Moore
023476049b Remove superfluous self. 2017-01-17 16:21:28 -05:00
Parker Moore
e0d63c8aa9 Add test to ensure that if the includes dir isn't in the theme that it won't break the site 2017-01-17 16:19:47 -05:00
Parker Moore
ad8fb9b927 Add theme_dir() helper func 2017-01-17 16:19:26 -05:00
jekyllbot
2052280ccd Update history to reflect merge of #5791 [ci skip] 2017-01-17 14:56:00 -05:00
jekyllbot
aa9cb1524c Merge pull request #5791 from DirtyF/fix-note
Merge pull request 5791
2017-01-17 14:55:59 -05:00
Frank Taillandier
e1f4d92d02 add missing class 2017-01-17 18:22:28 +01:00
jekyllbot
39c4054cd1 Update history to reflect merge of #5784 [ci skip] 2017-01-17 04:34:19 -05:00
jekyllbot
3a9cb90a08 Merge pull request #5784 from ashmaroli/bump-rvm
Merge pull request 5784
2017-01-17 04:34:18 -05:00
Ashwin Maroli
bfb6cf1ca9 bump rubies 2017-01-17 14:35:33 +05:30
jekyllbot
b9dedb3477 Update history to reflect merge of #5312 [ci skip] 2017-01-17 03:34:05 -05:00
jekyllbot
321364e3cc Merge pull request #5312 from DirtyF/docs-usage-help
Merge pull request 5312
2017-01-17 03:34:04 -05:00
Frank Taillandier
492a510538 Merge branch 'master' into docs-usage-help 2017-01-17 09:32:48 +01:00
jekyllbot
9c72903395 Update history to reflect merge of #5781 [ci skip] 2017-01-17 03:24:08 -05:00
jekyllbot
8d4cce9335 Merge pull request #5781 from DirtyF/bump-htmlproofer
Merge pull request 5781
2017-01-17 03:24:06 -05:00
jekyllbot
4ea770e995 Update history to reflect merge of #5782 [ci skip] 2017-01-17 03:22:44 -05:00
jekyllbot
5d5b24d3d1 Merge pull request #5782 from DirtyF/bump-jemoji
Merge pull request 5782
2017-01-17 03:22:43 -05:00
jekyllbot
5460e71176 Update history to reflect merge of #5731 [ci skip] 2017-01-16 21:48:20 -05:00
jekyllbot
bf7e24cc99 Merge pull request #5731 from zdroid/gcc-make
Merge pull request 5731
2017-01-16 21:48:19 -05:00
jekyllbot
67ab159606 Update history to reflect merge of #5691 [ci skip] 2017-01-16 21:38:56 -05:00
jekyllbot
16d71b1f4b Merge pull request #5691 from tomjohnson1492/patch-5
Merge pull request 5691
2017-01-16 21:38:55 -05:00
Frank Taillandier
c39414a17b use latest jemoji gem 2017-01-17 02:59:57 +01:00
Frank Taillandier
cd8836cf6e bump htmlproofer 2017-01-17 02:34:15 +01:00
Parker Moore
9a5307c3f9 Don't include the theme's includes_path if it is nil. 2017-01-16 19:17:45 -05:00
jekyllbot
e509cf2139 Update history to reflect merge of #5767 [ci skip] 2017-01-16 18:38:35 -05:00
jekyllbot
6c4699bd54 Merge pull request #5767 from Crunch09/issue-5756
Merge pull request 5767
2017-01-16 18:38:34 -05:00
jekyllbot
448b6ba08e Update history to reflect merge of #5779 [ci skip] 2017-01-16 17:03:42 -05:00
jekyllbot
71dab94a97 Merge pull request #5779 from jekyll/fix-flaky-plugins-path-test
Merge pull request 5779
2017-01-16 17:03:41 -05:00
Parker Moore
aa7e47a30d Remove calls to Dir.chdir without a block.
This removes the necessity to initialize Jekyll::Configuration::DEFAULTS manually.
2017-01-16 16:43:25 -05:00
Parker Moore
567a7952dd test/helper: fix flaky plugin path test by initializing Configuration::DEFAULTS at start of tests
If we do a Dir.chdir before Configuration::DEFAULTS is initialized, then its source and destination values will not be what we expect.
We expect that Dir.pwd should stay as the root of the repo but there are some errant calls to Dir.chdir without a block that are still
not yet cleaned up.
2017-01-16 16:25:09 -05:00
jekyllbot
9d70bbba44 Update history to reflect merge of #5768 [ci skip] 2017-01-16 16:00:07 -05:00
jekyllbot
750fb32ca3 Merge pull request #5768 from DirtyF/rubocop-47
Merge pull request 5768
2017-01-16 16:00:06 -05:00
jekyllbot
036dd3ccc9 Update history to reflect merge of #5769 [ci skip] 2017-01-16 11:05:25 -05:00
jekyllbot
941e8f85dd Merge pull request #5769 from diev/patch-1
Merge pull request 5769
2017-01-16 11:05:24 -05:00
Dmitrii Evdokimov
55993c6c5d Fix a markdown link to look properly on the web 2017-01-16 17:53:04 +03:00
Frank Taillandier
d790477d6d Add security rules 2017-01-16 10:43:07 +01:00
Frank Taillandier
a30d81ceb8 bump Rubocop to v47 2017-01-16 10:26:08 +01:00
Florian Thomas
ecd04badf0 throw IncludeTagError if error occurs in included file
fixes #5756
2017-01-15 20:35:10 +01:00
jekyllbot
becdcb5164 Update history to reflect merge of #5765 [ci skip] 2017-01-15 03:47:06 -05:00
jekyllbot
057365a578 Merge pull request #5765 from jekyll/bump-rubocop
Merge pull request 5765
2017-01-15 03:47:05 -05:00
Frank Taillandier
6f8bf2e950 appease rubocop 2017-01-14 20:11:30 +01:00
Frank Taillandier
39b7af3732 exclude rake tasks and gemspec from metrics
exclude from BlockLength and LineLength metrics
2017-01-14 20:05:11 +01:00
Frank Taillandier
5d52074d2d appease Rubocop 2017-01-14 20:01:41 +01:00
Frank Taillandier
44324828b4 bump Rubocop to latest version 2017-01-14 20:00:36 +01:00
jekyllbot
7d5f961dba Update history to reflect merge of #5764 [ci skip] 2017-01-14 07:41:25 -05:00
jekyllbot
da6830f021 Merge pull request #5764 from purplecarrot/patch-1
Merge pull request 5764
2017-01-14 07:41:24 -05:00
Purplecarrot
59cbdf5935 Correct minor typo 2017-01-14 10:36:55 +00:00
jekyllbot
b9ae94387f Update history to reflect merge of #5750 [ci skip] 2017-01-14 00:01:33 -05:00
jekyllbot
aa63deb2a9 Merge pull request #5750 from jekyll/no-implicit-conversion-of-nil-to-string
Merge pull request 5750
2017-01-14 00:01:31 -05:00
jekyllbot
a66fd1fa04 Update history to reflect merge of #5758 [ci skip] 2017-01-13 04:59:14 -05:00
jekyllbot
b8957ab607 Merge pull request #5758 from BlueberryFoxtrot/patch-2
Merge pull request 5758
2017-01-13 04:59:12 -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
jekyllbot
27ed81547b Update history to reflect merge of #5761 [ci skip] 2017-01-12 16:41:16 -08:00
jekyllbot
76410d16d1 Merge pull request #5761 from jekyll/pull/consistent_comma
Merge pull request 5761
2017-01-12 16:41:15 -08:00
Pat Hawks
1d885911bc Rubocop: Require consistent comma in multiline literals 2017-01-12 17:52:29 -06:00
BlueberryFoxtrot
2fc4fdfe79 Update quickstart.md 2017-01-12 17:39:21 +01: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
538cff15e9 report @parkr feedback 2017-01-11 20:57:34 +01:00
jekyllbot
8ae2673eba Update history to reflect merge of #5744 [ci skip] 2017-01-11 09:13:39 -08:00
jekyllbot
9b71cf7556 Merge pull request #5744 from DirtyF/pull/docs-use-defaults
Merge pull request 5744
2017-01-11 09:13:38 -08:00
Parker Moore
02858fdf08 include: improve boolean logic in #valid_include_file? 2017-01-11 12:05:56 -05:00
Frank Taillandier
d77ed5e608 Add missing merge labels for jekyllbot 2017-01-11 10:49:21 +01:00
jekyllbot
07d161c2ce Update history to reflect merge of #5752 [ci skip] 2017-01-11 01:42:10 -08:00
jekyllbot
fb450630ef Merge pull request #5752 from mpchadwick/jekyll-pre-commit
Merge pull request 5752
2017-01-11 01:42:08 -08:00
Max Chadwick
c198b08ee8 Add jekyll-pre-commit to plugins list 2017-01-10 22:50:30 -05:00
jekyllbot
4f84b522b5 Update history to reflect merge of #5621 [ci skip] 2017-01-10 12:05:59 -08:00
jekyllbot
bf33dc7f50 Merge pull request #5621 from rogerogden/patch-1
Merge pull request 5621
2017-01-10 12:05:58 -08:00
Frank Taillandier
31178bfe69 Merge branch 'master' into liquid-4 2017-01-10 20:01:04 +01:00
Parker Moore
22368896fb Rearrange some pieces of History.markdown. 2017-01-10 12:17:42 -05:00
Parker Moore
faa67bcd62 include: fix 'no implicit conversion of nil to String'
This is when either 'dir' or 'file' is nil.
2017-01-10 12:12:55 -05:00
jekyllbot
0210022c75 Update history to reflect merge of #5746 [ci skip] 2017-01-10 01:46:18 -08:00
jekyllbot
8a02606c09 Merge pull request #5746 from DirtyF/sort-gems
Merge pull request 5746
2017-01-10 01:46:17 -08:00
jekyllbot
f785d6f8d1 Update history to reflect merge of #5748 [ci skip] 2017-01-10 01:45:46 -08:00
jekyllbot
fe6d772b13 Merge pull request #5748 from yoostk/minor-fix
Merge pull request 5748
2017-01-10 01:45:44 -08:00
Frank Taillandier
c48daa9d5b normalize whitespace 2017-01-10 10:34:16 +01:00
yoostk
4ef69b948c Fix a minor grammatical mistake on themes' document 2017-01-10 15:03:46 +09:00
Frank Taillandier
6748f100d5 Merge branch 'master' into sort-gems 2017-01-09 23:14:21 +01:00
jekyllbot
47550935cb Update history to reflect merge of #5725 [ci skip] 2017-01-09 14:14:03 -08:00
jekyllbot
d2eb645386 Merge pull request #5725 from jekyll/pull/assert_nil
Merge pull request 5725
2017-01-09 14:14:01 -08:00
jekyllbot
fb83ebadf6 Update history to reflect merge of #5745 [ci skip] 2017-01-09 14:10:03 -08:00
jekyllbot
102ea9eed1 Merge pull request #5745 from DirtyF/rubocop-autocorrect
Merge pull request 5745
2017-01-09 14:10:02 -08:00
Frank Taillandier
335d9b3881 sort gems 2017-01-09 21:39:42 +01:00
Frank Taillandier
10b96b26bc Sort dependencies 2017-01-09 21:39:19 +01:00
Frank Taillandier
8bf9c37cf5 rubocop -a 2017-01-09 21:32:11 +01:00
Frank Taillandier
0c9c236c48 rubocup -a 2017-01-09 21:31:57 +01:00
Frank Taillandier
74e6ef83c9 Use defaults in config
All docs stored in _docs inherit from docs layout
All news items stored in _posts inherit from news-item layout
2017-01-09 21:10:24 +01:00
Frank Taillandier
f4ff88adb7 Merge branch 'master' into docs-usage-help 2017-01-09 19:52:06 +01:00
Zlatan Vasović
5ac3e0a866 Fix #5730: add gcc and make to the list of requirements 2017-01-09 17:45:28 +01:00
jekyllbot
86fc58491c Update history to reflect merge of #5473 [ci skip] 2017-01-09 06:36:52 -08:00
jekyllbot
1c4833c5ed Merge pull request #5473 from kentonh/patch-1
Merge pull request 5473
2017-01-09 06:36:51 -08:00
Frank Taillandier
e60769731a Report modifications to docs 2017-01-09 15:25:59 +01:00
Kenton Hansen
b1291605b3 Changes to 'bundle exec jekyll serve'
Updated to be consistent with the rest of documentation.
2017-01-09 15:19:46 +01:00
Kenton Hansen
8a5672fdff Addition of a sample "typical post"
So, I thought this section in the docs would be a good place to put the anatomy of a post .md file.
2017-01-09 15:19:46 +01:00
jekyllbot
74fe613072 Update history to reflect merge of #5740 [ci skip] 2017-01-09 05:16:12 -08:00
jekyllbot
45ad85b27d Merge pull request #5740 from KAndrsn/patch-1
Merge pull request 5740
2017-01-09 05:16:11 -08:00
Kurt Anderson
0ebc832e1b Remove duplicate paragraph. 2017-01-09 08:01:58 -05:00
Frank Taillandier
c3ff3e59fc Merge branch 'master' into fix-broken-links 2017-01-09 00:36:12 +01:00
jekyllbot
5ef6edb977 Update history to reflect merge of #5738 [ci skip] 2017-01-08 14:51:30 -08:00
jekyllbot
f26117f3e9 Merge pull request #5738 from Longwelwind/patch-1
Merge pull request 5738
2017-01-08 14:51:30 -08:00
Longwelwind
6cd388b2ab Replace a dead link with a web-archived one 2017-01-08 23:12:45 +01:00
Frank Taillandier
441b275af2 fix broken links in documentation 2017-01-08 16:43:59 +01:00
Frank Taillandier
02a8ce5585 add spaces to variables 2017-01-08 15:15:48 +01:00
jekyllbot
dd397b6c4b Update history to reflect merge of #5696 [ci skip] 2017-01-08 06:06:08 -08:00
jekyllbot
0bc4f2a28f Merge pull request #5696 from tomjohnson1492/patch-11
Merge pull request 5696
2017-01-08 06:06:08 -08:00
jekyllbot
0f9a4ac072 Update history to reflect merge of #5692 [ci skip] 2017-01-08 06:02:31 -08:00
jekyllbot
7df1adb4f8 Merge pull request #5692 from tomjohnson1492/patch-6
Merge pull request 5692
2017-01-08 06:02:30 -08:00
Frank Taillandier
234ed44db6 Fix format, corrections 2017-01-08 14:44:59 +01:00
jekyllbot
61e5aa7728 Update history to reflect merge of #5544 [ci skip] 2017-01-08 04:50:02 -08:00
jekyllbot
60a2396832 Merge pull request #5544 from jekyll/revert-5532-perma-docs
Merge pull request 5544
2017-01-08 04:50:01 -08:00
Frank Taillandier
870a57316c Merge branch 'master' into revert-5532-perma-docs 2017-01-08 13:38:05 +01:00
jekyllbot
e126d16135 Update history to reflect merge of #5726 [ci skip] 2017-01-07 03:37:48 -08:00
jekyllbot
214eedc87b Merge pull request #5726 from jekyll/pull/remove-deprecated
Merge pull request 5726
2017-01-07 03:37:47 -08:00
Pat Hawks
203be72c47 Remove unnecessary "rubocop:enable" 2017-01-06 05:57:21 -06:00
Pat Hawks
368294b2a9 Update tests to be position independent 2017-01-06 05:55:50 -06:00
Pat Hawks
0f2013114c Merge branch 'master' into jekyll-utils-exec 2017-01-06 05:42:15 -06:00
jekyllbot
08cec6889a Update history to reflect merge of #5720 [ci skip] 2017-01-06 02:14:53 -08:00
jekyllbot
6050b3566e Merge pull request #5720 from oakstudios/add-unpublished-to-docs
Merge pull request 5720
2017-01-06 02:14:52 -08:00
jekyllbot
91776d1dc7 Update history to reflect merge of #5688 [ci skip] 2017-01-06 01:56:29 -08:00
jekyllbot
b774147fe9 Merge pull request #5688 from muratayusuke/feature/jekyll-numbered-headings
Merge pull request 5688
2017-01-06 01:56:28 -08:00
Ashwin Maroli
ea9c303c95 Merge branch 'master' of https://github.com/jekyll/jekyll into url-slash 2017-01-06 12:02:34 +05:30
muratayusuke
657e502a72 Add jekyll-numbered-headings 2017-01-06 15:30:36 +09:00
Pat Hawks
1e4b779ab3 Escape # 2017-01-05 18:34:44 -06:00
Pat Hawks
5652c10305 Try to replace URI.escape with Addressable 2017-01-05 18:01:00 -06:00
Pat Hawks
6fb05e0799 Use Addressable instead of URI to decode 2017-01-05 17:44:54 -06:00
Pat Hawks
4b51c1da58 Use assert_nil 2017-01-05 17:08:04 -06:00
Skylar Challand
be12be3411 Add undocumented --unpublished build option
via 57fd5f887d/lib/jekyll/command.rb (L63-L64)
2017-01-05 15:04:42 -05:00
Tom Johnson
5166ead2e0 Made updates with indentation 2017-01-04 10:14:41 -08:00
jekyllbot
7cded91a7c Update history to reflect merge of #5713 [ci skip] 2017-01-03 00:30:54 -08:00
jekyllbot
8c01ff5fca Merge pull request #5713 from jekyll/bump-license
Merge pull request 5713
2017-01-03 00:30:52 -08:00
Frank Taillandier
9fb6355264 bump year
- Adding Jekyll contributors, following @benbalter advice.
2017-01-02 23:14:27 +01:00
jekyllbot
fb75f4031c Update history to reflect merge of #5693 [ci skip] 2017-01-02 08:59:24 -08:00
jekyllbot
da2899198d Merge pull request #5693 from tomjohnson1492/patch-7
Merge pull request 5693
2017-01-02 08:59:22 -08:00
Frank Taillandier
a44a1eff92 Merge branch 'master' into patch-7 2017-01-02 17:46:14 +01: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
jekyllbot
7dce4e4270 Update history to reflect merge of #5712 [ci skip] 2017-01-02 08:17:08 -08:00
jekyllbot
5b995425bb Merge pull request #5712 from yous/theme-license
Merge pull request 5712
2017-01-02 08:17:06 -08:00
Chayoung You
de6d62b2e3 Use the current year for the LICENSE of theme 2017-01-02 22:29:25 +09:00
jekyllbot
6ab6de7093 Update history to reflect merge of #5711 [ci skip] 2017-01-01 21:24:28 -08:00
jekyllbot
b75d3a8783 Merge pull request #5711 from Ch4s3/master
Merge pull request 5711
2017-01-01 21:24:27 -08:00
Chase
da1a36eff9 update Classifier-Reborn to 2.1.0 2017-01-01 18:20:45 -05:00
jekyllbot
b704df0245 Update history to reflect merge of #5683 [ci skip] 2017-01-01 06:51:40 -08:00
jekyllbot
0d62e7fb41 Merge pull request #5683 from Nursen/patch-1
Merge pull request 5683
2017-01-01 06:51:38 -08:00
jekyllbot
0197b65e71 Update history to reflect merge of #5705 [ci skip] 2016-12-31 13:44:17 -08:00
jekyllbot
d45ea7f493 Merge pull request #5705 from robcrocombe/robcrocombe-patch-1
Merge pull request 5705
2016-12-31 13:44:16 -08:00
jekyllbot
0014b1d9f0 Update history to reflect merge of #5689 [ci skip] 2016-12-29 19:02:54 -08:00
jekyllbot
817c9f6605 Merge pull request #5689 from tomjohnson1492/patch-3
Merge pull request 5689
2016-12-29 19:02:53 -08:00
Tom Johnson
c8ef313d03 fixing sentence in dispute 2016-12-29 09:31:30 -08:00
Tom Johnson
192e79ed1e reset permalinks to same state it was in in patch-3 branch. i couldn't seem to remove it from the previous commit. 2016-12-29 08:57:39 -08:00
Tom Johnson
57d6d5986f update quickstart.md
I must have just updated the wrong doc or branch in the last commit. i hope this fixes it.
2016-12-29 08:27:42 -08:00
Frank Taillandier
685a142a83 Rebase patch 10 on patch 11 2016-12-29 11:58:57 +01:00
Tom Johnson
acff6cd269 Removed erroneous liquid code, added back spacing
- removed erroneous liquid code with conditional include parameters
- added back spacing in {{ }} tags
2016-12-29 11:55:22 +01:00
Tom Johnson
56a7038a7e Updated to remove spacing from include variables
It turns out Liquid throws an error when you write `{% if {{ include.url }} %}` instead of `{% if {{include.url}} %}`. I updated the examples here to omit the spacing. To avoid inconsistency, I just omitted the spacing from all curly braces. Also added a note explaining the issue and put the blame on Liquid.
2016-12-29 11:55:22 +01:00
Tom Johnson
8289b61316 made requested updates
- made `{{ }}` formatting more readable by adding spacing. 
- added formatting to code samples to properly reflect line breaks for readability
2016-12-29 11:55:22 +01:00
Tom Johnson
240ea13576 Added new includes.md topic to docs
Added new includes.md topic.

See https://github.com/jekyll/jekyll/pull/5630 for more details on the update. 

@jekyll/documentation
@DirtyF
2016-12-29 11:55:22 +01:00
Rob Crocombe
6a2c7f2718 Add Jekyll-Post to plugins.md 2016-12-29 10:20:15 +00:00
Tom Johnson
caf5c00842 made requested updates 2016-12-29 00:29:45 -08:00
Tom Johnson
90da02b1fc made updates from Parkr's review
- most prominent update is example of how to override minima default
2016-12-29 00:15:52 -08:00
Tom Johnson
391bf5d33c made fixes
made requested fixes
2016-12-28 23:46:25 -08:00
Tom Johnson
b1b0d00c5a made updates
- made updates from Parkr's review
- update to Extensionless permalinks section
- update to note about not using built-in perm styles in front matter
- update for readability in places
2016-12-28 23:42:37 -08:00
Tom Johnson
2c8b826460 made requested change
**includes** --> *includes*
2016-12-28 23:00:06 -08:00
Parker Moore
02056f7b15 Merge pull request #5679 from jekyll/liquid-4-utils
[liquid 4] Utils
2016-12-28 21:55:55 -08:00
Parker Moore
1bc82b9c8a Fix script/stackprof & add some GC stats.
When running 'script/stackprof object', I noticed that it would be helpful to see
GC information. It appears we create a lot of junk -- a source of optimization if
we decide to go down that path.

An average Jekyll build doesn't run a GC, but auto-regeneration likely would eventually
require a GC run and it would be interesting to see if we can reduce how much we throw
away with each call to 'site.process'.
2016-12-28 22:54:37 -07:00
Tom Johnson
adc619ca6c added info about jekyll new --help 2016-12-28 15:21:57 -08:00
Tom Johnson
c317161942 fixed space 2016-12-28 08:15:20 -08:00
Tom Johnson
56ae6ed571 Removed erroneous liquid code, added back spacing
- removed erroneous liquid code with conditional include parameters
- added back spacing in {{ }} tags
2016-12-27 21:39:56 -08:00
Tom Johnson
f18363ea13 Updated to remove spacing from include variables
It turns out Liquid throws an error when you write `{% if {{ include.url }} %}` instead of `{% if {{include.url}} %}`. I updated the examples here to omit the spacing. To avoid inconsistency, I just omitted the spacing from all curly braces. Also added a note explaining the issue and put the blame on Liquid.
2016-12-27 11:03:23 -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
Tom Johnson
190ea160e5 Made updates as requested by reviewers
Made requested updates.
2016-12-26 20:40:07 -08:00
Tom Johnson
938388a6be Made updates requested by others in PR
I made various updates as requested by the reviewers.
2016-12-26 20:31:54 -08:00
Tom Johnson
6c5f6ce164 Made requested updates on this topic
Made minor grammar updates
2016-12-26 19:48:38 -08:00
Tom Johnson
b37b433b60 made requested updates
I made the requested updates. Mostly just small formatting improvements.
2016-12-26 18:48:42 -08:00
Tom Johnson
488ec5489c moved includes to appear after templates
made update based on review. moved includes topic after templates in nav list.
2016-12-26 18:36:39 -08:00
Tom Johnson
31de9ea484 made requested updates
- made `{{ }}` formatting more readable by adding spacing. 
- added formatting to code samples to properly reflect line breaks for readability
2016-12-26 18:28:27 -08:00
Tom Johnson
a6d357050a Updated to correct content
I previously had pasted in the wrong page here. Now it's fixed.
2016-12-25 23:03:22 -08:00
Tom Johnson
503420a9b4 Added new includes.md topic to docs
Added new includes.md topic.

See https://github.com/jekyll/jekyll/pull/5630 for more details on the update. 

@jekyll/documentation
@DirtyF
2016-12-25 20:44:35 -08:00
Tom Johnson
2d0df85b93 Add includes link to doc nav
I created more advanced details about includes and created a new page for it instead of putting all the info on the templates page.

See https://github.com/jekyll/jekyll/pull/5630 for more details on the update. 

@jekyll/documentation
@DirtyF
2016-12-25 20:42:16 -08:00
Tom Johnson
9e1c613818 Improve template docs
See https://github.com/jekyll/jekyll/pull/5630 for more details on the update. 

@jekyll/documentation
@DirtyF
2016-12-25 20:37:24 -08:00
Tom Johnson
93cd0cdb50 Improve permalinks docs
See https://github.com/jekyll/jekyll/pull/5630 for more details on the update. 

@jekyll/documentation
@DirtyF
2016-12-25 20:36:25 -08:00
Tom Johnson
91cd32ca49 Improve pages docs
See https://github.com/jekyll/jekyll/pull/5630 for more details on the update. 

@jekyll/documentation
@DirtyF
2016-12-25 20:35:31 -08:00
Tom Johnson
f5eb869e58 Improve collections docs
See https://github.com/jekyll/jekyll/pull/5630 for more details on the update. 

@jekyll/documentation
@DirtyF
2016-12-25 20:34:20 -08:00
Tom Johnson
11b4ae05e5 Improve theme docs
See https://github.com/jekyll/jekyll/pull/5630 for more details on the update. 

@jekyll/documentation
@DirtyF
2016-12-25 20:33:09 -08:00
Tom Johnson
317eae5580 Improve quickstart docs
See https://github.com/jekyll/jekyll/pull/5630 for more details on the update. 

@jekyll/documentation
@DirtyF
2016-12-25 20:31:32 -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
Nursen
d442c4fe13 Update windows.md 2016-12-24 02:16:20 -08:00
Nursen
80d3c7a204 Update windows.md
fixing typo
2016-12-24 01:25:03 -08:00
Nursen
467f0a1371 Update windows.md
revising terminology to avoid ambiguity and moving in relation to alternative install instructions.
2016-12-24 01:22:55 -08:00
Nursen
704910b297 Update windows.md
Added an update to installation instructions, as a cert authority change in Ruby causes problems with the prior recommended version of Ruby.
2016-12-23 14:08:54 -08:00
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
jekyllbot
52c2645abb Update history to reflect merge of #5671 [ci skip] 2016-12-20 02:15:57 -08:00
jekyllbot
f4d1176199 Merge pull request #5671 from DirtyF/rubocop-gemfile
Merge pull request 5671
2016-12-20 02:15:56 -08:00
jekyllbot
6eca7e101a Update history to reflect merge of #5670 [ci skip] 2016-12-20 00:38:18 -08:00
jekyllbot
4d9e4a9bd8 Merge pull request #5670 from DirtyF/bump-rake
Merge pull request 5670
2016-12-20 00:38:17 -08:00
Frank Taillandier
00f2fe3abc fix typo 2016-12-20 09:27:44 +01:00
Frank Taillandier
8a0d44eedc please Rubocop 🤖
- Reorder gems
 - use double quotes
2016-12-19 23:50:16 +01:00
Frank Taillandier
f09e1b15d8 bump to rake 12.0 2016-12-19 23:42:30 +01:00
jekyllbot
79adb49676 Update history to reflect merge of #5668 [ci skip] 2016-12-19 12:40:10 -08:00
jekyllbot
85d89c3f03 Merge pull request #5668 from kainjow/patch-1
Merge pull request 5668
2016-12-19 12:40:09 -08:00
Kevin Wojniak
2fc800ebd2 Use each instead of map to actually return nothing 2016-12-18 17:32:19 -08:00
jekyllbot
53db36c43a Update history to reflect merge of #5666 [ci skip] 2016-12-18 02:02:42 -08:00
jekyllbot
7231088e5c Merge pull request #5666 from DirtyF/rubocop-jekyll
Merge pull request 5666
2016-12-18 02:02:41 -08:00
Frank Taillandier
48f7a155c3 reindent attributes 2016-12-18 08:55:05 +01:00
Frank Taillandier
d134afcd4a ran rubocop -a 2016-12-18 07:22:36 +01:00
Frank Taillandier
de56b977b6 ran rubocop -a
#5665
2016-12-18 07:22:11 +01:00
jekyllbot
38a50e49de Update history to reflect merge of #5655 [ci skip] 2016-12-17 21:59:26 -08:00
jekyllbot
e21d35a474 Merge pull request #5655 from ashmaroli/fontawesome-docs
Merge pull request 5655
2016-12-17 21:59:25 -08:00
Ashwin Maroli
109dceee3d move changes to /.github/ and regenerate site 2016-12-18 07:45:08 +05:30
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
jekyllbot
25f58fe8f8 Update history to reflect merge of #5658 [ci skip] 2016-12-13 23:47:28 -08:00
jekyllbot
f560a4e226 Merge pull request #5658 from idmit/patch-1
Merge pull request 5658
2016-12-13 23:47:27 -08:00
Ivan Dmitrievsky
96fee68da4 Fix a couple of typos in the docs 2016-12-14 02:11:49 +03:00
jekyllbot
2856fd3ac7 Update history to reflect merge of #5657 [ci skip] 2016-12-13 05:42:17 -08:00
jekyllbot
fa32e14e7f Merge pull request #5657 from Kraymer/patch-1
Merge pull request 5657
2016-12-13 05:42:16 -08:00
Fabrice Laporte
86d45a5989 Update variables.md
Fix typo 'page' => 'layout'
2016-12-13 11:14:16 +01:00
Ashwin Maroli
8a89f033ad fix errors. 2016-12-11 19:52:22 +05:30
jekyllbot
4f0a7439aa Update history to reflect merge of #5653 [ci skip] 2016-12-11 03:49:39 -08:00
jekyllbot
360c82c95a Merge pull request #5653 from kimbaudi/patch-1
Merge pull request 5653
2016-12-11 03:49:39 -08:00
Ashwin Maroli
f5f387711a update documentation on updating FontAwesome Iconset 2016-12-11 15:35:46 +05:30
kimbaudi
b99013cc3d Improve Permalinks documentation.
Add special note: built-in permalink styles are not recognized in the YAML Front Matter.
2016-12-10 23:03:59 -08:00
jekyllbot
c09221205a Update history to reflect merge of #5652 [ci skip] 2016-12-10 12:17:00 -08:00
jekyllbot
b6b0fdc05b Merge pull request #5652 from jekyll/pull/assert_nil
Merge pull request 5652
2016-12-10 12:16:59 -08:00
Pat Hawks
69c4a8a1aa Use assert_nil instead of assert_equal nil
Fixes #5648
2016-12-10 11:31:04 -06:00
jekyllbot
b02f306f0a Update history to reflect merge of #5513 [ci skip] 2016-12-09 16:01:22 -08:00
jekyllbot
8ed324007a Merge pull request #5513 from thiagoarrais/5415-group_by_exp-filter
Merge pull request 5513
2016-12-09 16:01:21 -08:00
Thiago Arrais
d4c8d7fd2b Ignore symlinked file in windows 2016-12-09 13:15:16 -03:00
jekyllbot
43af0aa21b Update history to reflect merge of #5612 [ci skip] 2016-12-08 20:09:01 -08:00
jekyllbot
1049802499 Merge pull request #5612 from ashmaroli/win-tz
Merge pull request 5612
2016-12-08 20:09:01 -08:00
jekyllbot
81f6f1e404 Update history to reflect merge of #5643 [ci skip] 2016-12-08 04:14:43 -08:00
jekyllbot
5ba930bba8 Merge pull request #5643 from hugomd/master
Merge pull request 5643
2016-12-08 04:14:43 -08:00
Hugo
50bfdf181f Update Core team list in README 2016-12-08 23:08:43 +11:00
jekyllbot
4c6bbe7d0e Update history to reflect merge of #5641 [ci skip] 2016-12-07 23:25:42 -08:00
jekyllbot
d9288b5aa6 Merge pull request #5641 from daattali/patch-1
Merge pull request 5641
2016-12-07 23:25:41 -08:00
Parker Moore
3c139a09f1 Care about things. 2016-12-07 18:00:47 -08:00
Parker Moore
18c2b0827e Appease rubocop. 2016-12-07 17:53:45 -08:00
Parker Moore
6e2449b482 Write Jekyll::Utils::Exec.run for running shell commands. 2016-12-07 17:38:22 -08:00
Dean Attali
f3300c1772 use backticks for Gemfile for consistency since in the next sentence _config.yml file has backtick 2016-12-07 19:45:19 -05:00
Ashwin Maroli
c6fe7ec57f add a set of steps in site_configuration.feature
this set of steps allow the test to pass when DST in not currently active.
They may fail when DST becomes active.
2016-12-06 22:19:07 +05:30
Ashwin Maroli
d70b4d0682 update documentation for Windows 2016-12-06 15:38:19 +05:30
Ashwin Maroli
f8456e02c1 narrow it down to only Windows 2016-12-06 15:38:18 +05:30
Ashwin Maroli
1b4ab418ba revert and adjust site_configuration.feature 2016-12-06 15:38:18 +05:30
Ashwin Maroli
31eeb1a561 add 'tzinfo-data' gem to generated Gemfile 2016-12-06 15:38:18 +05:30
Ashwin Maroli
ee5266602e add 'tzinfo-data' gem to Jekyll Gemfile 2016-12-06 15:38:18 +05:30
Ashwin Maroli
c4142c4c77 add a utility submodule to define 'TZ' on Windows 2016-12-06 15:38:18 +05:30
jekyllbot
4382b2467b Update history to reflect merge of #5632 [ci skip] 2016-12-05 06:45:16 -08:00
jekyllbot
ccbef6bd27 Merge pull request #5632 from arogachev/patch-1
Merge pull request 5632
2016-12-05 06:45:15 -08:00
Alexey Rogachev
8d4950d6e4 Fixed typo 2016-12-05 13:31:47 +06:00
Roger Ogden
7b73abcdd9 Deleted trailing whitespace on line 22 2016-12-02 17:18:30 -07:00
Roger Ogden
ed9520cd3b Fixes #5498
Updated data_reader.rb comments to more accurately reflect read() and read_data_to() functionality.
2016-12-02 16:58:31 -07:00
Parker Moore
d219b9f6c5 Describe #5614 better. 2016-12-02 14:28:32 -08:00
jekyllbot
e38ec839a8 Update history to reflect merge of #5614 [ci skip] 2016-12-02 14:27:31 -08:00
jekyllbot
e87214c096 Merge pull request #5614 from XhmikosR/patch-1
Merge pull request 5614
2016-12-02 14:27:30 -08:00
XhmikosR
abf20bad30 Update _font-awesome.scss
Move .woff file before .ttf so that it's preferred by supported browsers.
2016-12-01 11:57:10 +02:00
Thiago Arrais
91f0b91d6a Rename for more idiomatic Ruby 2016-11-30 18:16:25 -03:00
Thiago Arrais
4ed41558d1 Whoops! 2016-11-30 17:54:59 -03:00
jekyllbot
24eff43795 Update history to reflect merge of #5611 [ci skip] 2016-11-29 15:50:30 -08:00
jekyllbot
805dd4b0f1 Merge pull request #5611 from XhmikosR/https
Merge pull request 5611
2016-11-29 15:50:29 -08:00
jekyllbot
0107341eed Update history to reflect merge of #5530 [ci skip] 2016-11-29 14:37:33 -08:00
jekyllbot
293b6f1c77 Merge pull request #5530 from XhmikosR/site-font-awesome
Merge pull request 5530
2016-11-29 14:37:32 -08:00
jekyllbot
35c5e07362 Update history to reflect merge of #5609 [ci skip] 2016-11-29 14:33:53 -08:00
jekyllbot
c8c6c6c0e3 Merge pull request #5609 from fene/fix-date-file-name
Merge pull request 5609
2016-11-29 14:33:51 -08:00
XhmikosR
d9cf97e9c6 Switch to https when possible.
Also, remove two 404 links.
2016-11-29 23:39:23 +02:00
--global
6cbcaa99ad fix collection cucumber for windows 2016-11-29 14:17:56 +01:00
--global
d7cdab16e2 fix cucumber tests 2016-11-29 14:07:07 +01:00
jona
4f4a628df8 fix tests 2016-11-29 13:37:10 +01:00
XhmikosR
dc4e77c1e2 Use only the used Font Awesome icons.
The font is generated with https://icomoon.io/app/.

This saves ~50KB.
2016-11-29 10:41:49 +02:00
jona
fac041933c fix date parsing in file names 2016-11-29 09:14:03 +01:00
jekyllbot
4bd6240a1d Update history to reflect merge of #5384 [ci skip] 2016-11-28 21:38:17 -08:00
jekyllbot
a2367900fc Merge pull request #5384 from ashmaroli/theme-gem-feature
Merge pull request 5384
2016-11-28 21:38:16 -08:00
jekyllbot
65b845470e Update history to reflect merge of #5573 [ci skip] 2016-11-28 21:26:47 -08:00
jekyllbot
e762b4fe43 Merge pull request #5573 from ashmaroli/directory-docs
Merge pull request 5573
2016-11-28 21:26:47 -08:00
jekyllbot
5c69924484 Update history to reflect merge of #5587 [ci skip] 2016-11-28 21:25:11 -08:00
jekyllbot
ec7378a2ac Merge pull request #5587 from happycollision/patch-1
Merge pull request 5587
2016-11-28 21:25:10 -08:00
jekyllbot
bf3134f5cf Update history to reflect merge of #5600 [ci skip] 2016-11-28 21:24:29 -08:00
jekyllbot
aac5de7aca Merge pull request #5600 from mpchadwick/mpchadwick-patch-2
Merge pull request 5600
2016-11-28 21:24:28 -08:00
jekyllbot
6bf1522de9 Update history to reflect merge of #5608 [ci skip] 2016-11-28 21:16:24 -08:00
jekyllbot
90fa8d34e1 Merge pull request #5608 from ashmaroli/clean-test-names
Merge pull request 5608
2016-11-28 21:16:24 -08:00
Ashwin Maroli
d175ba2cb8 clean unit-test-names 2016-11-28 23:09:53 +05:30
jekyllbot
4c634d1d66 Update history to reflect merge of #5605 [ci skip] 2016-11-28 09:25:12 -08:00
jekyllbot
c3bf59c72c Merge pull request #5605 from Lunderberg/master
Merge pull request 5605
2016-11-28 09:25:11 -08:00
Eldritch Cheese
467bd5bb32 Updated test name, using single quotes for cleanliness. 2016-11-28 07:35:48 -05:00
Eldritch Cheese
875d55002b Increased number of posts in test_generated_site to account for special chars test 2016-11-27 07:59:56 -05:00
Eldritch Cheese
a55760d4ad Added unit test for special character, fixed error that it exposed. 2016-11-26 22:31:03 -05:00
Eldritch Cheese
bbdeb32f38 Escaped regular expressions when using post_url.
Previously, the post_url function would give error messages when the
post being listed contained special characters for use in regular
expressions.  These special characters are now escaped using
Regexp.escape.
2016-11-26 16:51:01 -05:00
jekyllbot
ce67da0f80 Update history to reflect merge of #5597 [ci skip] 2016-11-23 08:23:02 -08:00
jekyllbot
7044549ae1 Merge pull request #5597 from thetimbanks/add_array_connector_param
Merge pull request 5597
2016-11-23 08:23:01 -08:00
Max Chadwick
fabce98c54 Add jekyll-migrate-permalink 2016-11-23 05:52:51 -05:00
Tim Banks
5c965d6a20 Add connector param to array_to_sentence_string filter 2016-11-22 17:38:33 -06:00
jekyllbot
8a08bb417e Update history to reflect merge of #5435 [ci skip] 2016-11-20 15:06:46 -08:00
jekyllbot
1936c216ff Merge pull request #5435 from alexmalik/github-pages-backticks
Merge pull request 5435
2016-11-20 15:06:46 -08:00
alexmalik
df80f6fd2a Replace html links with markdown links 2016-11-20 13:46:55 -06:00
alexmalik
9cd71aaea9 add empty div with markdown="1" attribute
an empty div is necessary in order for the code blocks to render
correctly when not displayed on the jekyllrb site.
2016-11-20 13:42:49 -06:00
alexmalik
2009749e58 add new style rule for .code-block class
as suggested by @ashmaroli
2016-11-20 13:42:49 -06:00
alexmalik
a41b46ff35 replace {% %} with bacticks for nested code-block
uses Kramdown with the markdown="1" attribute, as suggested by
@mmistakes. This allows rendering of code blocks which are nested
inside HTML tags.
2016-11-20 13:42:49 -06:00
alexmalik
c47ae465ad Replace p and code tags with {% highlight %} 2016-11-20 13:42:49 -06:00
alexmalik
127704ad17 Replace backticks with HTML tags
Prior to the change backticks were used in an attempt to create a
code block. The problem is that inside block level HTML tags Markdown
is not supported. I have replaced the backticks with a combination of
HTML tags in order to approximately simulate the appearance of a code
block. The docs suggest possible use of span tags in place of the
surrounding div tags as a solution to getting the Markdown to render.
I tried this but no success.

This change improves the readers understanding of the information,
because the reader doesn't have to make sense of raw markdown.
2016-11-20 13:42:49 -06:00
jekyllbot
8d4803eb6d Update history to reflect merge of #5592 [ci skip] 2016-11-20 11:21:53 -08:00
jekyllbot
7338191f2b Merge pull request #5592 from brainscript/patch-1
Merge pull request 5592
2016-11-20 11:21:53 -08:00
brainscript
195770f7f6 Fix example URL inconsistency
In case of the GitHub example links like `<a href="https://github.com/{{ org.username }}">` with the full URL plus the variable were used, but for the Twitter example link only the `{{  author.name }}` was set as `href`.
2016-11-20 13:43:36 +01:00
Don Denton
52742e0496 Fix bad config YAML in collections example
If you add the previous version to your config file, you'd get an error on build/serve.
2016-11-17 01:12:41 -06:00
jekyllbot
575c23e547 Update history to reflect merge of #5582 [ci skip] 2016-11-15 13:55:41 -08:00
jekyllbot
a8a29b63ca Merge pull request #5582 from DirtyF/docs-windows
Merge pull request 5582
2016-11-15 13:55:41 -08:00
Frank Taillandier
5defc4782a remove instructions for Jekyll 2 2016-11-15 20:35:48 +01:00
Ashwin Maroli
365ecb7c37 a few more edits 2016-11-13 07:41:50 +05:30
Frank Taillandier
5d1f2bceea update directory structure documentation 2016-11-12 20:56:14 +01:00
Ashwin Maroli
15bdd81499 bring docs on 'structure' up-to-date 2016-11-12 23:37:45 +05:30
Frank Taillandier
830836e314 appease script/proof --disable-external
appease script/proof --disable-external
2016-11-10 00:30:39 +01:00
Frank Taillandier
820b704e3f appease script/proof --disable-external 2016-11-10 00:00:26 +01:00
Frank Taillandier
47e400549a [docs] info about the help command usage 2016-11-09 22:46:26 +01:00
Thiago Arrais
7ac9653f4e RDoc for group_by_exp 2016-11-04 18:32:52 -03:00
Thiago Arrais
7f18ac8f99 Group using arbitraty Liquid expressions 2016-11-04 18:16:46 -03:00
Parker Moore
8d1e043306 Set docs permalink in config 2016-11-03 15:49:21 -07:00
Parker Moore
da762eaa42 Revert "Add permalinks to docs in '/maintaining/'" 2016-11-03 15:48:37 -07:00
Ashwin Maroli
9192e66b7b assert instead of refuting 2016-11-04 01:17:54 +05:30
Ashwin Maroli
894d2a0415 test double slash when input = '/' 2016-11-04 00:50:54 +05:30
Ashwin Maroli
f636067661 remove 'css' subdirectory from assets folder 2016-09-30 15:34:46 +05:30
Ashwin Maroli
87a03f6c1a replace zero exit status steps 2016-09-30 15:23:08 +05:30
Ashwin Maroli
1fb4dce2f5 add a step to check contents in assets directory 2016-09-29 06:47:29 +05:30
Ashwin Maroli
1b4b51236a add theme-gem feature for bonafide theme gems
this cucumber feature follows the likely steps a theme designer would take
to build a Rubygem of his theme starting from the scaffolding generated by
`jekyll new-theme` command and further checks if the gem built actually
has the files he planned to include.
2016-09-29 06:36:24 +05:30
414 changed files with 15220 additions and 3535 deletions

View File

@@ -3,6 +3,7 @@ engines:
enabled: false
rubocop:
enabled: true
channel: rubocop-0-54
exclude_paths:
- .codeclimate.yml
@@ -23,11 +24,13 @@ exclude_paths:
- features/**/*
- script/**/*
- site/**/*
- docs/**/*
- spec/**/*
- 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/).
* Pull requests are easy and fun. If this is your first pull request, it may help to [understand GitHub Flow](https://guides.github.com/introduction/flow/).
* If you're submitting a code contribution, be sure to read the [code contributions](#code-contributions) section below.
@@ -66,6 +63,26 @@ You can find the documentation for jekyllrb.com in the [docs](https://github.com
One gotcha, all pull requests should be directed at the `master` branch (the default branch).
### Updating FontAwesome iconset for jekyllrb.com
We use a custom version of FontAwesome which contains just the icons we use.
If you ever need to update our documentation with an icon that is not already available in our custom iconset, you'll have to regenerate the iconset using Icomoon's Generator:
1. Go to <https://icomoon.io/app/>.
2. Click `Import Icons` on the top-horizontal-bar and upload the existing `<jekyll>/docs/icomoon-selection.json`.
3. Click `Add Icons from Library..` further down on the page, and add 'Font Awesome'.
4. Select the required icon(s) from the Library (make sure its the 'FontAwesome' library instead of 'IcoMoon-Free' library).
5. Click `Generate Font` on the bottom-horizontal-bar.
6. Inspect the included icons and proceed by clicking `Download`.
7. Extract the font files and adapt the CSS to the paths we use in Jekyll:
- Copy the entire `fonts` directory over and overwrite existing ones at `<jekyll>/docs/`.
- Copy the contents of `selection.json` and overwrite existing content inside `<jekyll>/docs/icomoon-selection.json`.
- Copy the entire `@font-face {}` declaration and only the **new-icon(s)' css declarations** further below, to update the
`<jekyll>/docs/_sass/_font-awesome.scss` sass partial.
- Fix paths in the `@font-face {}` declaration by adding `../` before `fonts/FontAwesome.*` like so:
`('../fonts/Fontawesome.woff?9h6hxj')`.
### Adding plugins
If you want to add your plugin to the [list of plugins](https://jekyllrb.com/docs/plugins/#available-plugins), please submit a pull request modifying the [plugins page source file](https://github.com/jekyll/jekyll/blob/master/docs/_docs/plugins.md) by adding a link to your plugin under the proper subheading depending upon its type.
@@ -94,25 +111,37 @@ If your contribution changes any Jekyll behavior, make sure to update the docume
* Don't bump the Gem version in your pull request (if you don't know what that means, you probably didn't).
* You can use the command `script/console` to start a REPL to explore the result of
Jekyll's methods. It also provides you with helpful methods to quickly create a
site or configuration. [Feel free to check it out!](https://github.com/jekyll/jekyll/blob/master/script/console)
## Running tests locally
### Test Dependencies
To run the test suite and build the gem you'll need to install Jekyll's dependencies by running the following command:
<pre class="highlight"><code>$ script/bootstrap</code></pre>
```sh
script/bootstrap
```
Before you make any changes, run the tests and make sure that they pass (to confirm your environment is configured properly):
<pre class="highlight"><code>$ script/cibuild</code></pre>
```sh
script/cibuild
```
If you are only updating a file in `test/`, you can use the command:
<pre class="highlight"><code>$ script/test test/blah_test.rb</code></pre>
```sh
script/test test/blah_test.rb
```
If you are only updating a `.feature` file, you can use the command:
<pre class="highlight"><code>$ script/cucumber features/blah.feature</code></pre>
```sh
script/cucumber features/blah.feature
```
Both `script/test` and `script/cucumber` can be run without arguments to
run its entire respective suite.

View File

@@ -10,14 +10,12 @@
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 ran `jekyll doctor` to check my configuration
- [ ] I read the CONTRIBUTION file at https://jekyllrb.com/docs/contributing/
- [ ] This is a feature request.
@@ -50,7 +48,7 @@
## My Reproduction Steps
<!--
If this error occured on GitHub Pages, please try to provide us with logs,
If this error occurred on GitHub Pages, please try to provide us with logs,
and look at them yourself, to determine if this is an actual Jekyll bug. In
the event you are unsure, file a ticket, however, when you do please provide
the logs (strip them of personal information.)
@@ -78,5 +76,3 @@
The minimum should be personal information. Though we normally don't log
anything like that so there should be no need to alter it.
-->
/cc include any Jekyll affinity teams here (see https://teams.jekyllrb.com/ for more info)

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

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

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

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

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

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

View File

@@ -1,27 +1,72 @@
---
require:
- ./rubocop/jekyll
Jekyll/NoPutsAllowed:
Exclude:
- rake/*.rake
AllCops:
TargetRubyVersion: 2.0
TargetRubyVersion: 2.1
Include:
- lib/**/*.rb
Exclude:
- lib/jekyll/renderer.rb
- bin/**/*
- exe/**/*
- benchmark/**/*
- script/**/*
- vendor/**/*
Lint/EndAlignment:
- tmp/**/*
Layout/AlignArray:
Enabled: false
Layout/AlignHash:
EnforcedHashRocketStyle: table
Layout/AlignParameters:
Enabled: false
Layout/EmptyLinesAroundAccessModifier:
Enabled: false
Layout/EmptyLinesAroundModuleBody:
Enabled: false
Layout/EndOfLine:
EnforcedStyle: native
Layout/ExtraSpacing:
AllowForAlignment: true
Layout/FirstParameterIndentation:
EnforcedStyle: consistent
Layout/IndentationWidth:
Severity: error
Layout/IndentArray:
EnforcedStyle: consistent
Layout/IndentHash:
EnforcedStyle: consistent
Layout/IndentHeredoc:
Enabled: false
Layout/MultilineMethodCallIndentation:
EnforcedStyle: indented
Layout/MultilineOperationIndentation:
EnforcedStyle: indented
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:
Enabled: false
Metrics/AbcSize:
Max: 21
Metrics/BlockLength:
Exclude:
- test/**/*.rb
- lib/jekyll/configuration.rb
- rake/*.rake
- jekyll.gemspec
Metrics/ClassLength:
Exclude:
- !ruby/regexp /features\/.*.rb$/
@@ -32,6 +77,10 @@ Metrics/CyclomaticComplexity:
Metrics/LineLength:
Exclude:
- !ruby/regexp /features\/.*.rb/
- Rakefile
- rake/*.rake
- Gemfile
- jekyll.gemspec
Max: 90
Severity: warning
Metrics/MethodLength:
@@ -44,39 +93,45 @@ Metrics/ParameterLists:
Max: 4
Metrics/PerceivedComplexity:
Max: 8
Naming/FileName:
Enabled: false
Naming/HeredocDelimiterNaming:
Enabled: false
Naming/MemoizedInstanceVariableName:
Exclude:
- lib/jekyll/page_without_a_file.rb
- lib/jekyll/drops/unified_payload_drop.rb
- lib/jekyll/drops/site_drop.rb
Naming/UncommunicativeMethodParamName:
AllowedNames:
- _
Security/MarshalLoad:
Exclude:
- !ruby/regexp /test\/.*.rb$/
- lib/jekyll/regenerator.rb
Security/YAMLLoad:
Exclude:
- !ruby/regexp /features\/.*.rb/
- !ruby/regexp /test\/.*.rb$/
Style/Alias:
Enabled: false
Style/AlignArray:
Enabled: false
Style/AlignHash:
EnforcedHashRocketStyle: table
Style/AlignParameters:
Enabled: false
EnforcedStyle: with_fixed_indentation
Style/AndOr:
Severity: error
Style/Attr:
Enabled: false
Style/BracesAroundHashParameters:
Enabled: false
Style/ClassAndModuleChildren:
Enabled: false
Style/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:
@@ -84,18 +139,13 @@ Style/HashSyntax:
Severity: error
Style/IfUnlessModifier:
Enabled: false
Style/IndentArray:
EnforcedStyle: consistent
Style/IndentHash:
EnforcedStyle: consistent
Style/IndentationWidth:
Severity: error
Style/InverseMethods:
Enabled: false
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,13 +169,13 @@ Style/SignalException:
EnforcedStyle: only_raise
Style/SingleLineMethods:
Enabled: false
Style/SpaceAroundOperators:
Enabled: false
Style/SpaceInsideBrackets:
Enabled: false
Style/StringLiterals:
EnforcedStyle: double_quotes
Style/StringLiteralsInInterpolation:
EnforcedStyle: double_quotes
Style/UnneededCapitalW:
Style/SymbolArray:
Enabled: false
Style/TrailingCommaInArrayLiteral:
EnforcedStyleForMultiline: consistent_comma
Style/TrailingCommaInHashLiteral:
EnforcedStyleForMultiline: consistent_comma

View File

@@ -5,10 +5,11 @@ language: ruby
sudo: false
rvm:
- &ruby1 2.3.1
- &ruby2 2.2.5
- &ruby3 2.1.9
- &jruby jruby-9.1.2.0
- &ruby1 2.5.1
- &ruby2 2.4.4
- &ruby3 2.3.7
- &ruby4 2.2.10
- &jruby jruby-9.1.16.0
matrix:
include:
@@ -16,6 +17,8 @@ matrix:
env: TEST_SUITE=fmt
- rvm: *ruby1
env: TEST_SUITE=default-site
- rvm: *ruby1
env: ROUGE_VERSION=1.11.1 # runs everything with this version
exclude:
- rvm: *jruby
env: TEST_SUITE=cucumber
@@ -28,6 +31,7 @@ branches:
only:
- master
- themes
- /*-stable/
notifications:
slack:
@@ -45,3 +49,10 @@ addons:
DA4vsRURfABU0fIhwYkQuZqEcA3d8TL36BZcGEshG6MQ2AmnYsmFiTcxqV5bmlElHEqQuT\
5SUFXLafgZPBnL0qDwujQcHukID41sE=\
"
# regular test configuration
after_success:
- bundle exec codeclimate-test-reporter
before_install:
- gem update --system
- gem install bundler

72
Gemfile
View File

@@ -1,10 +1,14 @@
# frozen_string_literal: true
source "https://rubygems.org"
gemspec :name => "jekyll"
gem "rake", "~> 11.0"
gem "rake", "~> 12.0"
gem "rouge", ENV["ROUGE"] if ENV["ROUGE"]
# 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'
gem "activesupport", "~> 4.2", :groups => [:test_legacy, :site] if RUBY_VERSION < "2.2.2"
group :development do
gem "launchy", "~> 2.3"
@@ -18,15 +22,18 @@ end
#
group :test do
gem "rubocop", "~> 0.44.1"
gem "cucumber", "~> 2.1"
gem "codeclimate-test-reporter", "~> 1.0.5"
gem "cucumber", RUBY_VERSION >= "2.2" ? "~> 3.0" : "3.0.1"
gem "httpclient"
gem "jekyll_test_plugin"
gem "jekyll_test_plugin_malicious"
gem "codeclimate-test-reporter", "~> 0.6.0"
gem "rspec-mocks"
gem "nokogiri"
# nokogiri v1.8 does not work with ruby 2.1 and below
gem "nokogiri", RUBY_VERSION >= "2.2" ? "~> 1.7" : "~> 1.7.0"
gem "rspec"
gem "test-theme", path: File.expand_path("./test/fixtures/test-theme", File.dirname(__FILE__))
gem "rspec-mocks"
gem "rubocop", "~> 0.56.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,63 +41,66 @@ end
#
group :test_legacy do
if RUBY_PLATFORM =~ /cygwin/ || RUBY_VERSION.start_with?("2.2")
gem 'test-unit'
if RUBY_PLATFORM =~ %r!cygwin! || RUBY_VERSION.start_with?("2.2")
gem "test-unit"
end
gem "redgreen"
gem "simplecov"
gem "minitest-reporters"
gem "minitest-profile"
gem "minitest"
gem "minitest-profile"
gem "minitest-reporters"
gem "shoulda"
gem "simplecov"
end
#
group :benchmark do
if ENV["BENCHMARK"]
gem "ruby-prof"
gem "benchmark-ips"
gem "stackprof"
gem "rbtrace"
gem "ruby-prof"
gem "stackprof"
end
end
#
group :jekyll_optional_dependencies do
gem "toml", "~> 0.1.0"
gem "coderay", "~> 1.1.0"
gem "jekyll-docs", :path => '../docs' if Dir.exist?('../docs') && ENV['JEKYLL_VERSION']
gem "jekyll-gist"
gem "jekyll-feed"
gem "jekyll-coffeescript"
gem "jekyll-redirect-from"
gem "jekyll-docs", :path => "../docs" if Dir.exist?("../docs") && ENV["JEKYLL_VERSION"]
gem "jekyll-feed", "~> 0.9"
gem "jekyll-gist"
gem "jekyll-paginate"
gem "jekyll-redirect-from"
gem "kramdown", "~> 1.14"
gem "mime-types", "~> 3.0"
gem "kramdown", "~> 1.9"
gem "rdoc", "~> 4.2"
gem "rdoc", RUBY_VERSION >= "2.2.2" ? "~> 6.0" : "~> 5.1"
gem "tomlrb", "~> 1.2"
platform :ruby, :mswin, :mingw, :x64_mingw do
gem "rdiscount", "~> 2.0"
gem "pygments.rb", "~> 0.6.0"
gem "redcarpet", "~> 3.2", ">= 3.2.3"
gem "classifier-reborn", "~> 2.0"
gem "classifier-reborn", "~> 2.2.0"
gem "liquid-c", "~> 3.0"
gem "pygments.rb", "~> 1.0"
gem "rdiscount", "~> 2.0"
gem "redcarpet", "~> 3.2", ">= 3.2.3"
gem "yajl-ruby", "~> 1.3.1"
end
# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
gem "tzinfo-data", :platforms => [:mingw, :mswin, :x64_mingw, :jruby]
end
#
group :site do
if ENV["PROOF"]
gem "html-proofer", "~> 2.0"
gem "html-proofer", "~> 3.4"
end
gem "jemoji", "0.5.1"
gem "jekyll-sitemap"
gem "jekyll-seo-tag"
gem "jekyll-avatar"
gem "jekyll-mentions"
gem "jekyll-seo-tag"
gem "jekyll-sitemap"
gem "jemoji"
end

View File

@@ -1,3 +1,698 @@
## 3.8.4 / 2018-09-18
### Bug Fixes
* 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.3 / 2018-02-25
### Bug Fixes
* Do not hardcode locale unless certainly necessary (#6791)
## 3.7.2 / 2018-01-25
### Development Fixes
* CI: Test against Ruby 2.5.0 (#6664)
* Bump rdoc to 6.0 (#6600)
* Lint file and bump theme dependencies (#6698)
* Write a Rubocop Cop to ensure no `#p` or `#puts` calls get committed to master. (#6615)
* Remove redgreen gem (#6720)
### Site Enhancements
* Display latest version in header (#6676)
* Update version in `config.yml` via YAML load / dump (#6677)
### Documentation
* Fix: Add note about posts in context of collections_dir (#6680)
* Update deploy-script in documentation (#6666)
* Add note about naming of collections_dir (#6703)
* Update installation.md (#6694)
* Add `jekyll-html` to plugins. (#6654)
* Update plugins.md (#6716)
* Release v3.7.1 (#6695)
### Bug Fixes
* inform that symlinks are not allowed in safe mode (#6670)
* Glob scope path only if configured with a pattern (#6692)
* Add gem &#34;wdm&#34; to all newly generated Gemfiles (#6711)
* Fix timezone inconsistencies between different ruby version (#6697)
* Refactor collections_dir feature for consistency (#6685)
### Minor Enhancements
* Require external library only if necessary (#6596)
## 3.7.0 / 2018-01-02
### Minor Enhancements
* Add LiveReload functionality to Jekyll. (#5142)
* Add Utils::Internet.connected? to determine whether host machine has internet connection. (#5870)
* Disable default layouts for Pages with a `layout: none` declaration (#6182)
* Scope path glob (#6268)
* Allow the user to set collections_dir to put all collections under one subdirectory (#6331)
* Upgrade to Rouge 3 (#6381)
* Allow URL filters to work directly with documents (#6478)
* filter relative_url should keep absolute urls with scheme/authority (#6490)
* `.sass-cache` doesn&#39;t *always* land in `options[&#39;source&#39;]` (#6500)
* Allow plugins to modify the obsolete files. (#6502)
* Add latin mode to `slugify` (#6509)
* Log Kramdown warnings if log level is WARN (#6522)
* Add an option to configure kramdown warning output (#6554)
* Add `json` extension to list of directory indices (#6550)
* Dependency: Bump jekyll-watch to 2.0 (#6589)
* Remove paginate check (#6606)
* update classifier-reborn to 2.2.0 (#6631)
* Switch to an actively-maintained TOML parser. (#6652)
* Do not coerce layout paths in theme-gem to the source directory (#6603)
### Bug Fixes
* Raise when theme root directory is not available (#6455)
* Avoid block parser warning in SmartyPants (#6565)
* Fail gracefully if &#34;sass&#34; gem cannot be loaded (#6573)
* return correct file in dir if dir has same name as file (#6569)
* Register reload hooks in Server#process (#6605)
* Memoize path to metadata file (#6602)
* Use `require_relative` to load Jekyll classes (#6609)
### Development Fixes
* Added direct collection access to future collection item feature test(#6151)
* add failing test for non-utf8 encoding (#6339)
* Upgrade to Cucumber 3.0 (#6395)
* Provide a better default hash for tracking liquid stats (#6417)
* Add configuration for first-timers bot (#6431)
* Do not linkify escaped characters as PRs in History (#6468)
* Rely on jekyll-mentions for linking usernames (#6469)
* Update first-timers-issue-template.md (#6472)
* Enable `Lint/RescueWithoutErrorClass` Cop (#6482)
* Clean up Rubocop config (#6495)
* Use Gem to discover the location of bundler (#6499)
* Remove unnecessary encoding comment (#6513)
* Suggest using Rubocop to automatically fix errors (#6514)
* Assert raising Psych::SyntaxError when`&#34;strict_front_matter&#34;=&gt;true` (#6520)
* Use Kernel#Array instead of explicit Array check (#6525)
* RuboCop: Enable `Style/UnneededCapitalW` cop (#6526)
* Refactor method to reduce ABC Metric size (#6529)
* Remove parentheses around arguments to raise (#6532)
* Use double-quotes around gem name (#6535)
* Dependencies: upgrade to toml 0.2.0 (#6541)
* Lock to cucumber 3.0.1 on Ruby 2.1 (#6546)
* Bump JRuby version in Travis config (#6561)
* Rescue from Psych::SyntaxError instead of SyntaxError after parsing YAML(#5828)
* Drop forwarding to private methods by exposing those methods as public(#6577)
* Upgrade pygments to v1.x (#5937)
* Bump yajl-ruby (#6582)
* Cleanup test_redcarpet.rb (#6584)
* Add PageWithoutAFile class from jekyll plugins (#6556)
* Cleanup LiveReloadReactor (#6607)
### Documentation
* Add formester to the list of saas form backend (#6059)
* GitHub Pages instructions (#6384)
* Improve documentation for theme-gem installation (#6387)
* Fix diff syntax-highlighting (#6388)
* Update instructions (#6396)
* Fix code-block highlighting in docs (#6398)
* Filtering Posts with categories, tags, or other variables (#6399)
* Fixes formatting on pre-formatted text. (#6405)
* Added new tutorial to tutorials section on docs (#6406)
* Updates (#6407)
* Fix `collections_dir` example (#6408)
* Renaming duplicate of &#34;Scenario 6&#34; to &#34;Scenario 7&#34; (#6411)
* Mark `collection_dir` as unreleased (#6412)
* Fix link to SUPPORT (#6415)
* Fix list appearance by adding missing `ol` tag (#6421)
* Explain how to override output collection index page (#6424)
* Added github-cards to the list of plugins (#6425)
* CoC violation correspondants (#6429)
* Add a note about Liquid and syntax highlighting (#6466)
* Remove `sudo` from macOS troubleshooting instructions (#6486)
* Add a note on `:jekyll_plugins` group in the docs (#6488)
* Updated custom-404-page.md (#6489)
* Fix a few minor issues in the docs (#6494)
* Add jekyll-pwa-plugin (#6533)
* Remove Jekyll-Smartify from plugins directory (#6548)
* Updated Jekyll-Pug listing to include official website (#6555)
* Remove link to severely outdated asset plugin (#6613)
* Default time zone depends upon server (#6617)
* Add `disqus-for-jekyll` to plugins. (#6618)
* Update &#34;Requirements&#34; for Ruby version (#6623)
* Fix: Update link to i18n_filter plugin (#6638)
* Correct WordPress capitalization (#6645)
* Add Tweetsert, Stickyposts, Paginate::Content (#6651)
* Post: Jekyll 3.7.0 released (#6634)
### Site Enhancements
* Add special styling for code-blocks run in shell (#6389)
* Add post about diversity (#6447)
* Update list of files excluded from Docs site (#6457)
* Update site History (#6460)
* Add default twitter card image (#6476)
* Update normalize.css to v7.0.0 (#6491)
* Optimize images (#6519)
* Back to original main navigation (#6544)
* Styles: mobile-docs select element (#6545)
* Search with DocSearch by @Algolia (#6557)
* Site header redesign (#6567)
* Move logo above site navigation on small screens (#6570)
* Docs: Include version badge for latest features (#6574)
* Use version-badge on an existing feature intro (#6575)
* Add jekyll-category-pages plugin (#6632)
* Improve docs styling for code to be run in shell (#6641)
* Fix permalink icon markup in news-item layout (#6639)
## 3.6.2 / 2017-10-21
### Development Fixes
* Update Rubocop to 0.51.0 (#6444)
* Add test for layout as string (#6445)
### Bug Fixes
* Problematic UTF+bom files (#6322)
* Always treat `data.layout` as a string (#6442)
## 3.6.1 / 2017-10-20
### Documentation
* Doc y_day in docs/permalinks (#6244)
* Update frontmatter.md (#6371)
* Elaborate on excluding items from processing (#6136)
* Style lists in tables (#6379)
* Remove duplicate &#34;available&#34; (#6380)
### Development Fixes
* Bump rubocop to use `v0.50.x` (#6368)
## 3.6.0 / 2017-09-21
### Minor Enhancements
* 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 YAML front matter (#6334)
* Docs: `site.url` behavior on development and production environments (#6270)
* Fix typo in site.url section of variables.md :-[ (#6337)
* Docs: updates (#6343)
* Fix precedence docs (#6346)
* add note to contributing docs about `script/console` (#6349)
* Docs: Fix permalink example (#6375)
### Site Enhancements
* Adding DevKit helpers (#6225)
* Customizing url in collection elements clarified (#6264)
* Plugins is the new gems (#6326)
### Development Fixes
* Strip unnecessary leading whitespace in template (#6228)
* Users should be installing patch versions. (#6198)
* Fix tests (#6240)
* Define path with `__dir__` (#6087)
* exit site.process sooner (#6239)
* make flakey test more robust (#6277)
* Add a quick test for DataReader (#6284)
* script/backport-pr: commit message no longer includes the `#` (#6289)
* Add Add CODEOWNERS file to help automate reviews. (#6320)
* Fix builds on codeclimate (#6333)
* Bump rubies on Travis (#6366)
## 3.5.2 / 2017-08-12
### Bug Fixes
* Backport #6281 for v3.5.x: Fix `Drop#key?` so it can handle a nil argument (#6288)
* Backport #6280 for v3.5.x: Guard against type error in `absolute_url` (#6287)
* Backport #6266 for v3.5.x: Memoize the return value of `Document#url` (#6301)
* Backport #6273 for v3.5.x: delegate `StaticFile#to_json` to `StaticFile#to_liquid` (#6302)
* Backport #6226 for v3.5.x: `Reader#read_directories`: guard against an entry not being a directory (#6304)
* Backport #6247 for v3.5.x: kramdown: symbolize keys in-place (#6303)
## 3.5.1 / 2017-07-17
### Minor Enhancements
* 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
* Add connector param to `array_to_sentence_string` filter (#5597)
* Adds `group_by_exp` filter (#5513)
* Use Addressable instead of URI to decode (#5726)
* throw IncludeTagError if error occurs in included file (#5767)
* Write Jekyll::Utils::Exec.run for running shell commands. (#5640)
* Use the current year for the LICENSE of theme (#5712)
* Update License (#5713)
### Bug Fixes
* Escaped regular expressions when using `post_url`. (#5605)
* fix date parsing in file names to be stricter (#5609)
* Add a module to re-define `ENV["TZ"]` in Windows (#5612)
* Use each instead of map to actually return nothing (#5668)
* include: fix 'no implicit conversion of nil to String' (#5750)
* Don't include the theme's includes_path if it is nil. (#5780)
* test double slash when input = '/' (#5542)
* use logger.info for related posts (#5822)
### Site Enhancements
* Use only the used Font Awesome icons. (#5530)
* Switch to `https` when possible. (#5611)
* Update `_font-awesome.scss` to move .woff file before .ttf (#5614)
* Update documentation on updating FontAwesome Iconset (#5655)
* Use defaults for docs and news-items (#5744)
* Sort gems in `docs/_config.yml` (#5746)
* Add missing class (#5791)
* Improve template docs (#5694)
### Development Fixes
* clean unit-test names in `test/test_tags.rb` (#5608)
* Add cucumber feature to test for bonafide theme gems (#5384)
* Use `assert_nil` instead of `assert_equal nil` (#5652)
* Rubocop -a on lib/jekyll (#5666)
* Bump to rake 12.0 (#5670)
* Rubocop Gemfile (#5671)
* update Classifier-Reborn to 2.1.0 (#5711)
* Rubocop: fix Rakefile and gemspec (#5745)
* Use `assert_nil` (#5725)
* Sort gems in `jekyll.gemspec` (#5746)
* Rubocop: Require consistent comma in multiline literals (#5761)
* Bump rubocop (#5765)
* New rubocop security checks (#5768)
* test/helper: fix flaky plugin path test by removing calls to Dir.chdir without a block (#5779)
* Use latest jemoji gem (#5782)
* Bump htmlproofer (#5781)
* Bump rubies we test against (#5784)
* Bump rdoc to v5.0 (#5797)
* Bump codeclimate-test-reporter to v1.0.5 (#5798)
### Documentation
* Improve quickstart docs (#5689)
* Add Jekyll-Post to list of plugins (#5705)
* Add jekyll-numbered-headings (#5688)
* Docs: move permalinks from documents into config (#5544)
* Improve collections docs (#5691)
* Fix #5730: add gcc and make to the list of requirements (#5731)
* Remove instructions to install Jekyll 2 on Windows (#5582)
* Fix example URL inconsistency (#5592)
* Replace backticks within HTML blocks with HTML tags (#5435)
* Add jekyll-migrate-permalink (#5600)
* Fix bad config YAML in collections example (#5587)
* Bring documentation on 'Directory Structure' up-to-date (#5573)
* Fixed typo (#5632)
* use backticks for Gemfile for consistency since in the next sentence … (#5641)
* Update Core team list in the README file (#5643)
* Improve Permalinks documentation. (#5653)
* Fix typo in Variables doc page (#5657)
* Fix a couple of typos in the docs (#5658)
* Update windows.md (#5683)
* Improve permalinks docs (#5693)
* Document --unpublished build option (#5720)
* Improve pages docs (#5692)
* Added new includes.md topic to docs (#5696)
* Replace a dead link with a web-archived one (#5738)
* Remove duplicate paragraph. (#5740)
* Addition of a sample "typical post" (#5473)
* Fix a minor grammatical mistake on themes' document ### -dev (#5748)
* Correct comments in data_reader.rb (#5621)
* Add jekyll-pre-commit to plugins list (#5752)
* Update quickstart.md (#5758)
* Correct minor typo (#5764)
* Fix a markdown link to look properly on the web (#5769)
* 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)
* Got that diaper money? (#5810)
* Sort content by popularity using Google Analytics (#5812)
* Rework CI doc to include multiple providers. (#5815)
* Improve theme docs (#5690)
* Add mention of classifier-reborn for LSI (#5811)
* Added note about --blank flag (#5802)
* Fixed inaccuracy in "Built-in permalink styles" docs (#5819)
## 3.3.1 / 2016-11-14
### Minor Enhancements
@@ -118,10 +813,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)
@@ -130,7 +825,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)
@@ -140,9 +835,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)
@@ -186,7 +881,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)
@@ -195,7 +890,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)
@@ -434,7 +1129,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)
@@ -495,14 +1190,14 @@
* utils/drops: update Drop to support `Utils.deep_merge_hashes` (#4289)
* Make sure jekyll/drops/drop is loaded first. (#4292)
* Convertible/Page/Renderer: use payload hash accessor & setter syntax for backwards-compatibility (#4311)
* Drop: fix hash setter precendence (#4312)
* Drop: fix hash setter precedence (#4312)
* utils: `has_yaml_header?` should accept files with extraneous spaces (#4290)
* Escape html from site.title and page.title in site template (#4307)
* Allow custom file extensions if defined in `permalink` YAML front matter (#4314)
* Fix deep_merge_hashes! handling of drops and hashes (#4359)
* Page should respect output extension of its permalink (#4373)
* Disable auto-regeneration when running server detached (#4376)
* Drop#[]: only use public_send for keys in the content_methods array (#4388)
* Drop#: only use public_send for keys in the content_methods array (#4388)
* Extract title from filename successfully when no date. (#4195)
### Development Fixes
@@ -904,7 +1599,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)
@@ -978,7 +1673,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)

View File

@@ -1,6 +1,6 @@
The MIT License (MIT)
Copyright (c) 2008-2016 Tom Preston-Werner
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,8 +3,8 @@
[![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]
[![Maintainability](https://api.codeclimate.com/v1/badges/8ba0cb5b17bb9848e128/maintainability)](codeclimate)
[![Test Coverage](https://api.codeclimate.com/v1/badges/8ba0cb5b17bb9848e128/test_coverage)](coverage)
[![Dependency Status](https://img.shields.io/gemnasium/jekyll/jekyll.svg)][gemnasium]
[![Security](https://hakiri.io/github/jekyll/jekyll/master.svg)][hakiri]
@@ -22,9 +22,11 @@ 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/philosophy
See: https://jekyllrb.com/docs/troubleshooting/#jekyll-amp-mac-os-x-1011
## Having trouble?
See: https://jekyllrb.com/docs/troubleshooting/
## Getting Started
@@ -37,14 +39,13 @@ See: https://jekyllrb.com/docs/troubleshooting/#jekyll-amp-mac-os-x-1011
## 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), or [@mattr-](https://github.com/mattr-)) know
and we will address it as soon as possible.
these terms, please let one of our core team members [Olivia](mailto:olivia@jekyllrb.com?subject=Jekyll%20CoC%20Violation), [Pat](mailto:pat@jekyllrb.com?subject=Jekyll%20CoC%20Violation), [Matt](mailto:matt@jekyllrb.com?subject=Jekyll%20CoC%20Violation) or [Parker](mailto:parker@jekyllrb.com?subject=Jekyll%20CoC%20Violation) know and we will address it as soon as possible.
## Diving In

View File

@@ -1,13 +1,15 @@
require 'rubygems'
require 'rake'
require 'rdoc'
require 'date'
require 'yaml'
# frozen_string_literal: true
$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), *%w[lib]))
require 'jekyll/version'
require "rubygems"
require "rake"
require "rdoc"
require "date"
require "yaml"
Dir.glob('rake/**.rake').each { |f| import f }
$LOAD_PATH.unshift File.expand_path("lib", __dir__)
require "jekyll/version"
Dir.glob("rake/**.rake").each { |f| import f }
#############################################################################
#
@@ -36,50 +38,44 @@ def gemspec_file
end
def gem_file
"#{name}-#{Gem::Version.new(version).to_s}.gem"
"#{name}-#{Gem::Version.new(version)}.gem"
end
def normalize_bullets(markdown)
markdown.gsub(/\n\s{2}\*{1}/, "\n-")
markdown.gsub(%r!\n\s{2}\*{1}!, "\n-")
end
def linkify_prs(markdown)
markdown.gsub(/#(\d+)/) do |word|
markdown.gsub(%r!(?<\!&)#(\d+)!) do |word|
"[#{word}]({{ site.repository }}/issues/#{word.delete("#")})"
end
end
def linkify_users(markdown)
markdown.gsub(/(@\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)
markdown.gsub(/(`{[{%].+[}%]}`)/, "{% raw %}\\1{% endraw %}")
markdown.gsub(%r!(`{[{%].+[}%]}`)!, "{% raw %}\\1{% endraw %}")
end
def custom_release_header_anchors(markdown)
header_regexp = /^(\d{1,2})\.(\d{1,2})\.(\d{1,2}) \/ \d{4}-\d{2}-\d{2}/
section_regexp = /^### \w+ \w+$/
markdown.split(/^##\s/).map do |release_notes|
header_regexp = %r!^(\d{1,2})\.(\d{1,2})\.(\d{1,2}) \/ \d{4}-\d{2}-\d{2}!
section_regexp = %r!^### \w+ \w+$!
markdown.split(%r!^##\s!).map do |release_notes|
_, 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)
header.gsub(/#/, '').strip.downcase.gsub(/\s+/, '-')
def slugify(header)
header.delete("#").strip.downcase.gsub(%r!\s+!, "-")
end
def remove_head_from_history(markdown)
index = markdown =~ /^##\s+\d+\.\d+\.\d+/
index = markdown =~ %r!^##\s+\d+\.\d+\.\d+!
markdown[index..-1]
end
@@ -88,22 +84,25 @@ def converted_history(markdown)
custom_release_header_anchors(
liquid_escape(
linkify(
normalize_bullets(markdown)))))
normalize_bullets(markdown)
)
)
)
)
end
def siteify_file(file, overrides_front_matter = {})
abort "You seem to have misplaced your #{file} file. I can haz?" unless File.exists?(file)
abort "You seem to have misplaced your #{file} file. I can haz?" unless File.exist?(file)
title = begin
File.read(file).match(/\A# (.*)$/)[1]
rescue
File.read(file).match(%r!\A# (.*)$!)[1]
rescue NoMethodError
File.basename(file, ".*").downcase.capitalize
end
slug = File.basename(file, ".markdown").downcase
front_matter = {
"title" => title,
"layout" => "docs",
"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)
@@ -115,7 +114,7 @@ def content_for(file)
when "History.markdown"
converted_history(contents)
else
contents.gsub(/\A# .*\n\n?/, "")
contents.gsub(%r!\A# .*\n\n?!, "")
end
end
@@ -128,23 +127,23 @@ end
multitask :default => [:test, :features]
task :spec => :test
require 'rake/testtask'
require "rake/testtask"
Rake::TestTask.new(:test) do |test|
test.libs << 'lib' << 'test'
test.pattern = 'test/**/test_*.rb'
test.libs << "lib" << "test"
test.pattern = "test/**/test_*.rb"
test.verbose = true
end
require 'rdoc/task'
require "rdoc/task"
Rake::RDocTask.new do |rdoc|
rdoc.rdoc_dir = 'rdoc'
rdoc.rdoc_dir = "rdoc"
rdoc.title = "#{name} #{version}"
rdoc.rdoc_files.include('README*')
rdoc.rdoc_files.include('lib/**/*.rb')
rdoc.rdoc_files.include("README*")
rdoc.rdoc_files.include("lib/**/*.rb")
end
begin
require 'cucumber/rake/task'
require "cucumber/rake/task"
Cucumber::Rake::Task.new(:features) do |t|
t.profile = "travis"
end
@@ -152,9 +151,9 @@ begin
t.profile = "html_report"
end
rescue LoadError
desc 'Cucumber rake task not available'
desc "Cucumber rake task not available"
task :features do
abort 'Cucumber rake task is not available. Be sure to install cucumber as a gem or plugin'
abort "Cucumber rake task is not available. Be sure to install cucumber as a gem or plugin"
end
end

View File

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

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

View File

@@ -1,7 +1,7 @@
#!/usr/bin/env ruby
require 'benchmark/ips'
url = "http://jekyllrb.com"
url = "https://jekyllrb.com"
Benchmark.ips do |x|
x.report('+=') { url += '/' }

1
docs/.gitignore vendored
View File

@@ -2,3 +2,4 @@ _site/
*.swp
pkg/
test/
.idea/

View File

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

View File

@@ -1,40 +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
collections:
docs:
output: true
posts:
permalink: /news/:year/:month/:day/:title/
output: true
---
version: 3.8.4
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-feed
- jekyll-redirect-from
- jemoji
- jekyll-sitemap
- jekyll-seo-tag
- jekyll-avatar
- jekyll-mentions
logo: "/img/logo-2x.png"
google_analytics_id: UA-50755011-1
google_site_verification: onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY
collections:
docs:
permalink: "/:collection/:path/"
output: true
posts:
permalink: "/news/:year/:month/:day/:title/"
output: true
tutorials:
output: true
defaults:
- scope:
path: _docs
type: docs
values:
layout: docs
- scope:
path: _posts
type: posts
values:
layout: news_item
image: "/img/twitter-card.png"
plugins:
- jekyll-avatar
- jekyll-feed
- jekyll-mentions
- jekyll-redirect-from
- jekyll-seo-tag
- jekyll-sitemap
- jemoji
sass:
style: compressed
exclude:
- README.md
- .gitignore
- ".gitignore"
- CNAME
- icomoon-selection.json
- readme.md

View File

@@ -3,6 +3,7 @@
- home
- quickstart
- installation
- windows
- usage
- structure
- configuration
@@ -23,6 +24,7 @@
- title: Customization
docs:
- templates
- includes
- permalinks
- pagination
- plugins

13
docs/_data/tutorials.yml Normal file
View File

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

View File

@@ -1,5 +1,4 @@
---
layout: docs
title: Assets
permalink: /docs/assets/
---
@@ -54,7 +53,7 @@ sass:
The Sass converter will default the `sass_dir` configuration option to
`_sass`.
[example-sass]: https://github.com/jekyll/jekyll-sass-converter/tree/master/example
[example-sass]: https://github.com/jekyll/jekyll-sass-converter/tree/master/docs
<div class="note info">
<h5>The <code>sass_dir</code> is only used by Sass</h5>
@@ -89,6 +88,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:
plugins:
- jekyll-coffeescript
```

View File

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

View File

@@ -1,5 +1,4 @@
---
layout: docs
title: Collections
permalink: /docs/collections/
---
@@ -12,7 +11,13 @@ namespace.
## Using Collections
### Step 1: Tell Jekyll to read in your collection
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:
@@ -41,12 +46,27 @@ defaults:
layout: page
```
### Step 2: Add your content
<div class="note">
<h5>Gather your collections {%- include docs_version_badge.html version="3.7.0" -%}</h5>
<p>You can optionally specify a directory to store all your collections in the same place with <code>collections_dir: my_collections</code>.</p>
<p>Then Jekyll will look in <code>my_collections/_books</code> for the <code>books</code> collection, and
in <code>my_collections/_recipes</code> for the <code>recipes</code> collection.</p>
</div>
<div class="note warning">
<h5>Be sure to move posts into custom collections directory</h5>
<p>If you specify a directory to store all your collections in the same place with <code>collections_dir: my_collections</code>, then you will need to move your <code>_posts</code> directory to <code>my_collections/_posts</code>. Note that, the name of your collections directory cannot start with an underscore (`_`).</p>
</div>
### Step 2: Add your content {#step2}
Create a corresponding folder (e.g. `<source>/_my_collection`) and add
documents. YAML Front Matter is read in as data if it exists, and everything
after it is stuck in the Document's `content` attribute. If no YAML Front
Matter is provided, Jekyll will not generate the file in your collection.
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
matter is provided, Jekyll will not generate the file in your collection.
<div class="note info">
<h5>Be sure to name your directories correctly</h5>
@@ -56,7 +76,7 @@ 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
### Step 3: Optionally render your collection's documents into independent files {#step3}
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
@@ -73,18 +93,19 @@ 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`.
As for posts with [Permalinks](../permalinks/), the document
URL can be customized by setting `permalink` metadata for the collection:
If you wish a specific page to be shown when accessing `/my_collection/`,
simply add `permalink: /my_collection/index.html` to a page.
To list items from the collection, on that page or any other, you can use:
```yaml
collections:
my_collection:
output: true
permalink: /awesome/:path/
{% raw %}
```liquid
{% for item in site.my_collection %}
<h2>{{ item.title }}</h2>
<p>{{ item.description }}</p>
<p><a href="{{ item.url }}">{{ item.title }}</a></p>
{% endfor %}
```
For example, if you have `_my_collection/some_subdir/some_doc.md`, it will be
written out to `<dest>/awesome/some_subdir/some_doc/index.html`.
{% endraw %}
<div class="note info">
<h5>Don't forget to add YAML for processing</h5>
@@ -95,6 +116,78 @@ written out to `<dest>/awesome/some_subdir/some_doc/index.html`.
</p>
</div>
## Configuring permalinks for collections {#permalinks}
If you wish to specify a custom pattern for the URLs where your Collection pages
will reside, you may do so with the [`permalink` property](../permalinks/):
```yaml
collections:
my_collection:
output: true
permalink: /:collection/:name
```
### Examples
For a collection with the following source file structure,
```
_my_collection/
└── some_subdir
└── some_doc.md
```
each of the following `permalink` configurations will produce the document structure shown below it.
* **Default**
Same as `permalink: /:collection/:path`.
```
_site/
├── my_collection
│   └── some_subdir
│   └── some_doc.html
...
```
* `permalink: pretty`
Same as `permalink: /:collection/:path/`.
```
_site/
├── my_collection
│   └── some_subdir
│   └── some_doc
│   └── index.html
...
```
* `permalink: /doc/:path`
```
_site/
├── doc
│   └── some_subdir
│   └── some_doc.html
...
```
* `permalink: /doc/:name`
```
_site/
├── doc
│   └── some_doc.html
...
```
* `permalink: /:name`
```
_site/
├── some_doc.html
...
```
### Template Variables
<div class="mobile-side-scroller">
<table>
<thead>
@@ -106,7 +199,7 @@ written out to `<dest>/awesome/some_subdir/some_doc/index.html`.
<tbody>
<tr>
<td>
<p><code>collection</code></p>
<p><code>:collection</code></p>
</td>
<td>
<p>Label of the containing collection.</p>
@@ -114,7 +207,7 @@ written out to `<dest>/awesome/some_subdir/some_doc/index.html`.
</tr>
<tr>
<td>
<p><code>path</code></p>
<p><code>:path</code></p>
</td>
<td>
<p>Path to the document relative to the collection's directory.</p>
@@ -122,7 +215,7 @@ written out to `<dest>/awesome/some_subdir/some_doc/index.html`.
</tr>
<tr>
<td>
<p><code>name</code></p>
<p><code>:name</code></p>
</td>
<td>
<p>The document's base filename, with every sequence of spaces
@@ -131,18 +224,24 @@ written out to `<dest>/awesome/some_subdir/some_doc/index.html`.
</tr>
<tr>
<td>
<p><code>title</code></p>
<p><code>:title</code></p>
</td>
<td>
<p>The document's lowercase title (as defined in its <a href="/docs/frontmatter/">front matter</a>), with every sequence of spaces and non-alphanumeric characters replaced by a hyphen. If the document does not define a title in its <a href="/docs/frontmatter/">front matter</a>, this is equivalent to <code>name</code>.</p>
<p>
The <code>:title</code> template variable will take the
<code>slug</code> <a href="/docs/frontmatter/">front matter</a>
variable value if any is present in the document; if none is
defined then <code>:title</code> will be equivalent to
<code>:name</code>, aka the slug generated from the filename.
</p>
</td>
</tr>
<tr>
<td>
<p><code>output_ext</code></p>
<p><code>:output_ext</code></p>
</td>
<td>
<p>Extension of the output file.</p>
<p>Extension of the output file. (Included by default and usually unnecessary.)</p>
</td>
</tr>
</tbody>
@@ -153,11 +252,12 @@ written out to `<dest>/awesome/some_subdir/some_doc/index.html`.
### Collections
Each collection is accessible via the `site` Liquid variable. For example, if
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 below for how to access attributes of those documents.
`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
you specified in your `_config.yml` (if present) and the following information:
@@ -237,6 +337,31 @@ 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>However documents are attempted to be written to disk only if the concerned collection
metadata has <code>output: true</code>. Additionally, future-dated documents are only written if
<code>site.future</code> <em>is also true</em>.
</p>
<p>More fine-grained control over documents being written to disk can be exercised by setting
<code>published: false</code> (<em><code>true</code> by default</em>) in the document's front matter.
</p>
</div>
### Documents
@@ -335,7 +460,7 @@ file, each document has the following 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`,
one might have front matter in an individual file structured as follows (which
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):
@@ -361,7 +486,7 @@ works:
Every album in the collection could be listed on a single page with a template:
```html
```liquid
{% raw %}
{% for album in site.albums %}
<h2>{{ album.title }}</h2>

View File

@@ -1,6 +1,5 @@
---
title: Code of Conduct
layout: docs
permalink: "/docs/conduct/"
note: This file is autogenerated. Edit /CONDUCT.markdown instead.
redirect_from: "/conduct/index.html"

View File

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

View File

@@ -0,0 +1,62 @@
---
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 Build](https://buddy.works/data/blog/_images/buddyworks-jekyll-small.png)
[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

@@ -0,0 +1,92 @@
---
title: "CircleCI"
---
Building, testing, and deploying your Jekyll-generated website can quickly be done with [CircleCI][0], a continuous integration & delivery tool. CircleCI supports [GitHub][1] and [Bitbucket][2], and you can get started for free using an open-source or private repository.
[0]: https://circleci.com/
[1]: https://github.com/
[2]: https://bitbucket.org/
## 1. Follow Your Project on CircleCI
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. 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.
[3]: https://circleci.com/docs/configuration/
## 2. Dependencies
The easiest way to manage dependencies for a Jekyll project (with or without CircleCI) is via a [Gemfile][4]. You'd want to have Jekyll, any Jekyll plugins, [HTML Proofer](#html-proofer), and any other gems that you are using in the `Gemfile`. Don't forget to version `Gemfile.lock` as well. Here's an example `Gemfile`:
[4]: http://bundler.io/gemfile.html
```ruby
source 'https://rubygems.org'
ruby '2.4.0'
gem 'jekyll'
gem 'html-proofer'
```
CircleCI detects when `Gemfile` is present is will automatically run `bundle install` for you in the `dependencies` phase.
## 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.
```yaml
dependencies:
post:
- bundle exec jekyll build
```
### HTML Proofer
With your site built, it's useful to run tests to check for valid HTML, broken links, etc. There's a few tools out there but [HTML Proofer][5] is popular amongst Jekyll users. We'll run it in the `test` phase with a few preferred flags. Check out the `html-proofer` [README][6] for all available flags, or run `htmlproofer --help` locally.
[5]: https://github.com/gjtorikian/html-proofer
[6]: https://github.com/gjtorikian/html-proofer/blob/master/README.md#configuration
```yaml
test:
post:
- bundle exec htmlproofer ./_site --check-html --disable-external
```
## Complete Example circle.yml File
When you put it all together, here's an example of what that `circle.yml` file could look like:
```yaml
machine:
environment:
NOKOGIRI_USE_SYSTEM_LIBRARIES: true # speeds up installation of html-proofer
dependencies:
post:
- bundle exec jekyll build
test:
post:
- bundle exec htmlproofer ./_site --allow-hash-href --check-favicon --check-html --disable-external
deployment:
prod:
branch: master
commands:
- rsync -va --delete ./_site username@my-website:/var/html
```
## 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.
[7]: https://github.com/jekyll/jekyll/edit/master/docs/_docs/continuous-integration/circleci.md
[8]: https://jekyllrb.com/help/
[9]: https://discuss.circleci.com

View File

@@ -0,0 +1,10 @@
---
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)
* [Buddy](buddyworks)

View File

@@ -1,16 +1,13 @@
---
layout: docs
title: Continuous Integration
permalink: /docs/continuous-integration/
title: "Travis CI"
---
You can easily 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][0], with [GitHub][1] integration for pull requests. Paid
alternatives exist for private repositories.
[Travis][travis], with [GitHub][github] integration for pull requests.
[0]: https://travis-ci.org/
[1]: https://github.com/
[travis]: https://travis-ci.org/
[github]: https://github.com/
## 1. Enabling Travis and GitHub
@@ -18,10 +15,9 @@ Enabling Travis builds for your GitHub repository is pretty simple:
1. Go to your profile on travis-ci.org: https://travis-ci.org/profile/username
2. Find the repository for which you're interested in enabling builds.
3. Click the slider on the right so it says "ON" and is a dark grey.
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
@@ -29,7 +25,7 @@ The simplest test script simply 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.
When testing Jekyll output, there is no better tool than [html-proofer][2].
When testing Jekyll output, there is no better tool than [html-proofer][html-proofer].
This tool checks your resulting site to ensure all links and images exist.
Utilize it either with the convenient `htmlproofer` command-line executable,
or write a Ruby script which utilizes the gem.
@@ -53,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
@@ -71,7 +67,7 @@ Options are given as a second argument to `.new`, and are encoded in a
symbol-keyed Ruby Hash. For more information about the configuration options,
check out `html-proofer`'s README file.
[2]: https://github.com/gjtorikian/html-proofer
[html-proofer]: https://github.com/gjtorikian/html-proofer
## 3. Configuring Your Travis Builds
@@ -94,7 +90,7 @@ Your `.travis.yml` file should look like this:
```yaml
language: ruby
rvm:
- 2.2.5
- 2.3.3
before_script:
- chmod +x ./script/cibuild # or do this locally and commit
@@ -127,7 +123,7 @@ access to Bundler, RubyGems, and a Ruby runtime.
```yaml
rvm:
- 2.2.5
- 2.3.3
```
RVM is a popular Ruby Version Manager (like rbenv, chruby, etc). This
@@ -229,5 +225,5 @@ an entry in the `.gitignore` file to avoid it from being checked in again.
This entire guide is open-source. Go ahead and [edit it][3] if you have a
fix or [ask for help][4] if you run into trouble and need some help.
[3]: https://github.com/jekyll/jekyll/edit/master/docs/_docs/continuous-integration.md
[3]: https://github.com/jekyll/jekyll/edit/master/docs/_docs/continuous-integration/travis-ci.md
[4]: https://jekyllrb.com/help/

View File

@@ -1,6 +1,5 @@
---
title: Contributing
layout: docs
permalink: "/docs/contributing/"
note: This file is autogenerated. Edit /.github/CONTRIBUTING.markdown instead.
---
@@ -9,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
@@ -33,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/).
* Pull requests are easy and fun. If this is your first pull request, it may help to [understand GitHub Flow](https://guides.github.com/introduction/flow/).
* If you're submitting a code contribution, be sure to read the [code contributions](#code-contributions) section below.
@@ -71,6 +67,26 @@ You can find the documentation for jekyllrb.com in the [docs](https://github.com
One gotcha, all pull requests should be directed at the `master` branch (the default branch).
### Updating FontAwesome iconset for jekyllrb.com
We use a custom version of FontAwesome which contains just the icons we use.
If you ever need to update our documentation with an icon that is not already available in our custom iconset, you'll have to regenerate the iconset using Icomoon's Generator:
1. Go to <https://icomoon.io/app/>.
2. Click `Import Icons` on the top-horizontal-bar and upload the existing `<jekyll>/docs/icomoon-selection.json`.
3. Click `Add Icons from Library..` further down on the page, and add 'Font Awesome'.
4. Select the required icon(s) from the Library (make sure its the 'FontAwesome' library instead of 'IcoMoon-Free' library).
5. Click `Generate Font` on the bottom-horizontal-bar.
6. Inspect the included icons and proceed by clicking `Download`.
7. Extract the font files and adapt the CSS to the paths we use in Jekyll:
- Copy the entire `fonts` directory over and overwrite existing ones at `<jekyll>/docs/`.
- Copy the contents of `selection.json` and overwrite existing content inside `<jekyll>/docs/icomoon-selection.json`.
- Copy the entire `@font-face {}` declaration and only the **new-icon(s)' css declarations** further below, to update the
`<jekyll>/docs/_sass/_font-awesome.scss` sass partial.
- Fix paths in the `@font-face {}` declaration by adding `../` before `fonts/FontAwesome.*` like so:
`('../fonts/Fontawesome.woff?9h6hxj')`.
### Adding plugins
If you want to add your plugin to the [list of plugins](https://jekyllrb.com/docs/plugins/#available-plugins), please submit a pull request modifying the [plugins page source file](https://github.com/jekyll/jekyll/blob/master/docs/_docs/plugins.md) by adding a link to your plugin under the proper subheading depending upon its type.
@@ -99,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

@@ -1,5 +1,4 @@
---
layout: docs
title: Data Files
permalink: /docs/datafiles/
---
@@ -57,8 +56,8 @@ determines the variable name).
You can now render the list of members in a template:
```html
{% raw %}
```liquid
<ul>
{% for member in site.data.members %}
<li>
@@ -68,8 +67,11 @@ You can now render the list of members in a template:
</li>
{% endfor %}
</ul>
{% endraw %}
```
{% endraw %}
{: .note .info }
If your Jekyll site has a lot of pages, such as with documentation websites, see the detailed examples in [how to build robust navigation for your site]({% link _tutorials/navigation.md %}).
## Example: Organizations
@@ -104,8 +106,8 @@ members:
The organizations can then be accessed via `site.data.orgs`, followed by the
file name:
```html
{% raw %}
```liquid
<ul>
{% for org_hash in site.data.orgs %}
{% assign org = org_hash[1] %}
@@ -117,8 +119,8 @@ file name:
</li>
{% endfor %}
</ul>
{% endraw %}
```
{% endraw %}
## Example: Accessing a specific author
@@ -134,8 +136,8 @@ dave:
The author can then be specified as a page variable in a post's frontmatter:
```html
{% raw %}
```liquid
---
title: sample post
author: dave
@@ -143,10 +145,11 @@ author: dave
{% assign author = site.data.people[page.author] %}
<a rel="author"
href="{{ author.twitter }}"
href="https://twitter.com/{{ author.twitter }}"
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,14 +1,38 @@
---
layout: docs
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.
<div class="note">
<h5>ProTip™: Use GitHub Pages for zero-hassle Jekyll hosting</h5>
<p>GitHub Pages are powered by Jekyll behind the scenes, so if youre looking for a zero-hassle, zero-cost solution, GitHub Pages are a great way to <a href="../github-pages/">host your Jekyll-powered website for free</a>.</p>
</div>
## Netlify
Netlify provides Global CDN, Continuous Deployment, one click HTTPS and [much more](https://www.netlify.com/features/), providing developers the most robust toolset available for modern web projects, without added complexity. Netlify supports custom plugins for Jekyll and has a free plan for open source projects.
Read this [Jekyll step-by-step guide](https://www.netlify.com/blog/2015/10/28/a-step-by-step-guide-jekyll-3.0-on-netlify/) to setup your Jekyll site on Netlify.
## Aerobatic
[Aerobatic](https://www.aerobatic.com) has custom domains, global CDN distribution, basic auth, CORS proxying, and a growing list of plugins all included.
Automating the deployment of a Jekyll site is simple. See their [Jekyll docs](https://www.aerobatic.com/docs/static-site-generators/#jekyll) for more details. Your built `_site` folder is deployed to their highly-available, globally distributed hosting service.
## Kickster
Use [Kickster](http://kickster.nielsenramon.com/) for easy (automated) deploys to GitHub Pages when using unsupported plugins on GitHub Pages.
Kickster provides a basic Jekyll project setup packed with web best practises and useful optimization tools increasing your overall project quality. Kickster ships with automated and worry-free deployment scripts for GitHub Pages.
Setting up Kickster is very easy, just install the gem and you are good to go. More documentation can here found [here](https://github.com/nielsenramon/kickster#kickster). If you do not want to use the gem or start a new project you can just copy paste the deployment scripts for [Travis CI](https://github.com/nielsenramon/kickster/tree/master/snippets/travis) or [Circle CI](https://github.com/nielsenramon/kickster#automated-deployment-with-circle-ci).
## Web hosting providers (FTP)
Just about any traditional web hosting provider will let you upload files to their servers over FTP. To upload a Jekyll site to a web host using FTP, simply run the `jekyll build` command and copy the 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.
Just about any traditional web hosting provider will let you upload files to their servers over FTP. To upload a Jekyll site to a web host using FTP, simply run the `jekyll build` command and copy the contents of the generated `_site` folder to the root folder of your hosting account. This is most likely to be the `httpdocs` or `public_html` folder on most hosting providers.
## Self-managed web server
@@ -42,13 +66,15 @@ server$ mkdir /var/www/myrepo
Next, add the following lines to hooks/post-receive and be sure Jekyll is
installed on the server:
```sh
```bash
GIT_REPO=$HOME/myrepo.git
TMP_GIT_CLONE=$HOME/tmp/myrepo
GEMFILE=$TMP_GIT_CLONE/Gemfile
PUBLIC_WWW=/var/www/myrepo
git clone $GIT_REPO $TMP_GIT_CLONE
jekyll build -s $TMP_GIT_CLONE -d $PUBLIC_WWW
BUNDLE_GEMFILE=$GEMFILE bundle install
BUNDLE_GEMFILE=$GEMFILE bundle exec jekyll build -s $TMP_GIT_CLONE -d $PUBLIC_WWW
rm -Rf $TMP_GIT_CLONE
exit
```
@@ -79,7 +105,7 @@ Another way to deploy your Jekyll site is to use [Rake](https://github.com/ruby/
### scp
Once youve generated the `_site` directory, you can easily scp it using a
Once youve generated the `_site` directory, you can easily scp its content 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.
@@ -90,7 +116,7 @@ matching TextMate command][] that will help you run this script.
### 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.
Once youve generated the `_site` directory, you can easily rsync its content 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.
@@ -168,7 +194,7 @@ script executes.
[Rack-Jekyll](https://github.com/adaoraul/rack-jekyll/) is an easy way to deploy your site on any Rack server such as Amazon EC2, Slicehost, Heroku, and so forth. It also can run with [shotgun](https://github.com/rtomayko/shotgun/), [rackup](https://github.com/rack/rack), [mongrel](https://github.com/mongrel/mongrel), [unicorn](https://github.com/defunkt/unicorn/), and [others](https://github.com/adaoraul/rack-jekyll#readme).
Read [this post](http://andycroll.com/ruby/serving-a-jekyll-blog-using-heroku) on how to deploy to Heroku using Rack-Jekyll.
Read [this post](http://andycroll.com/ruby/serving-a-jekyll-blog-using-heroku/) on how to deploy to Heroku using Rack-Jekyll.
## Jekyll-Admin for Rails
@@ -188,23 +214,3 @@ low-volume blogs as you only pay for what you use.
If you'd like to deploy your site to an OpenShift gear, there's [a cartridge
for that](https://github.com/openshift-quickstart/jekyll-openshift).
<div class="note">
<h5>ProTip™: Use GitHub Pages for zero-hassle Jekyll hosting</h5>
<p>GitHub Pages are powered by Jekyll behind the scenes, so if youre looking for a zero-hassle, zero-cost solution, GitHub Pages are a great way to <a href="../github-pages/">host your Jekyll-powered website for free</a>.</p>
</div>
## Kickster
Use [Kickster](http://kickster.nielsenramon.com/) for easy (automated) deploys to GitHub Pages when using unsupported plugins on GitHub Pages.
Kickster provides a basic Jekyll project setup packed with web best practises and useful optimization tools increasing your overall project quality. Kickster ships with automated and worry-free deployment scripts for GitHub Pages.
Setting up Kickster is very easy, just install the gem and you are good to go. More documentation can here found [here](https://github.com/nielsenramon/kickster#kickster). If you do not want to use the gem or start a new project you can just copy paste the deployment scripts for [Travis CI](https://github.com/nielsenramon/kickster/tree/master/snippets/travis) or [Circle CI](https://github.com/nielsenramon/kickster#automated-deployment-with-circle-ci).
## Aerobatic
[Aerobatic](https://www.aerobatic.com) 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.

View File

@@ -1,5 +1,4 @@
---
layout: docs
title: Working with drafts
permalink: /docs/drafts/
---

View File

@@ -1,5 +1,4 @@
---
layout: docs
title: Extras
permalink: /docs/extras/
---
@@ -7,15 +6,25 @@ 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.
## Web Highlights and Commenting
Register your site with [txtpen](https://txtpen.com). Then append
```html
<script src="https://txtpen.com/embed.js?site=<your site name>"></script>
```
to your template files in `/_layout` folder.
## 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>
<script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/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/opinion/2014/02/16/Mathjax-with-jekyll/).
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

View File

@@ -1,5 +1,4 @@
---
layout: docs
title: Front Matter
permalink: /docs/frontmatter/
---
@@ -69,6 +68,20 @@ front matter of a page or post.
<code>_layouts</code> directory.
</p>
<ul>
<li>
Using <code>null</code> will produce a file without using a layout
file. However this is overridden if the file is a post/document and has a
layout defined in the <a href="../configuration/#front-matter-defaults">
frontmatter defaults</a>.
</li>
<li>
Starting from version 3.5.0, using <code>none</code> in a post/document will
produce a file without using a layout file regardless of frontmatter defaults.
Using <code>none</code> in a page, however, will cause Jekyll to attempt to
use a layout named "none".
</li>
</ul>
</td>
</tr>
<tr>
@@ -100,6 +113,14 @@ front matter of a page or post.
</table>
</div>
<div class="note">
<h5>ProTip™: Render Posts Marked As Unpublished</h5>
<p>
To preview unpublished pages, simply run `jekyll serve` or `jekyll build`
with the `--unpublished` switch. Jekyll also has a handy <a href="../drafts/">drafts</a>
feature tailored specifically for blog posts.
</p>
</div>
## Custom Variables
@@ -108,14 +129,14 @@ data that is sent to the Liquid templating engine during the conversion. For
instance, if you set a title, you can use that in your layout to set the page
title:
```html
```liquid
<!DOCTYPE HTML>
<html>
<head>
<title>{% raw %}{{ page.title }}{% endraw %}</title>
</head>
<body>
...
```
## Predefined Variables for Posts
@@ -146,7 +167,7 @@ These are available out-of-the-box to be used in the front matter for a post.
</tr>
<tr>
<td>
<p style="margin-bottom: 5px;"><code>category</code></p>
<p><code>category</code></p>
<p><code>categories</code></p>
</td>
<td>

View File

@@ -1,102 +1,90 @@
---
layout: docs
title: GitHub Pages
permalink: /docs/github-pages/
---
[GitHub Pages](https://pages.github.com) are public web pages for users,
organizations, and repositories, that are freely hosted on GitHub's
`github.io` domain or on a custom domain name of your choice. GitHub Pages are
powered by Jekyll behind the scenes, so in addition to supporting regular HTML
content, theyre also a great way to host your Jekyll-powered website for free.
organizations, and repositories, that are freely hosted on GitHub's `github.io`
domain or on a custom domain name of your choice. GitHub Pages are powered by
Jekyll behind the scenes, so they're a great way to host your Jekyll-powered
website for free.
Your site is automatically generated by GitHub Pages when you push your source
files. Note that GitHub Pages works equally well for regular HTML content,
simply because Jekyll treats files without YAML front matter as static assets.
So if you only need to push generated HTML, you're good to go without any
further setup.
Never built a website with GitHub Pages before? [See this marvelous guide by
Jonathan McGlone to get you up and running](http://jmcglone.com/guides/github-pages/).
This guide will teach you what you need to know about Git, GitHub, and Jekyll to
create your very own website on GitHub Pages.
Jonathan McGlone](http://jmcglone.com/guides/github-pages/) to get you up and
running. This guide will teach you what you need to know about Git, GitHub, and
Jekyll to create your very own website on GitHub Pages.
## The github-pages gem
Our friends at GitHub have provided the
[github-pages](https://github.com/github/pages-gem) gem which is used to manage
[Jekyll and its dependencies on GitHub Pages](https://pages.github.com/versions/).
Using it in your projects means that when you deploy your site to GitHub Pages,
you will not be caught by unexpected differences between various versions of the
gems.
Note that GitHub Pages runs in `safe` mode and only allows [a set of whitelisted
plugins](https://help.github.com/articles/configuring-jekyll-plugins/#default-plugins).
To use the currently-deployed version of the gem in your project, add the
following to your `Gemfile`:
```ruby
source "https://rubygems.org"
gem "github-pages", group: :jekyll_plugins
```
Be sure to run `bundle update` often.
<div class="note">
<h5>GitHub Pages Documentation, Help, and Support</h5>
<p>
For more information about what you can do with GitHub Pages, as well as for
troubleshooting guides, you should check out
<a href="https://help.github.com/categories/github-pages-basics/">GitHubs Pages Help section</a>.
If all else fails, you should contact <a href="https://github.com/contact">GitHub Support</a>.
</p>
</div>
### Project Page URL Structure
Sometimes it's nice to preview your Jekyll site before you push your `gh-pages`
branch to GitHub. However, the subdirectory-like URL structure GitHub uses for
Project Pages complicates the proper resolution of URLs. In order to assure your
site builds properly, use `site.github.url` in your URL's.
site builds properly, use the handy [URL filters](../templates/#filters):
```html
{% raw %}
<!-- Useful for styles with static names... -->
<link href="{{ site.github.url }}/path/to/css.css" rel="stylesheet">
<!-- and for documents/pages whose URL's can change... -->
<a href="{{ page.url | prepend: site.github.url }}">{{ page.title }}</a>
{% 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">
<h5>Use the <code>github-pages</code> gem</h5>
<p>
Our friends at GitHub have provided the
<a href="https://github.com/github/pages-gem">github-pages</a>
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 <code>Gemfile</code>:
```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']
```
This will ensure that when you run <code>bundle install</code>, you
have the correct version of the <code>github-pages</code> gem.
If that fails, simplify it:
```ruby
source 'https://rubygems.org'
gem 'github-pages'
```
And be sure to run <code>bundle update</code> often.
If you like to install <code>pages-gem</code> on Windows you can find instructions by Jens Willmer on <a href="http://jwillmer.de/blog/tutorial/how-to-install-jekyll-and-pages-gem-on-windows-10-x46#github-pages-and-plugins">how to install github-pages gem on Windows (x64)</a>.
</p>
</div>
<div class="note info">
<h5>Installing <code>github-pages</code> gem on Windows</h5>
<p>
While Windows is not officially supported, it is possible
to install <code>github-pages</code> gem on Windows.
Special instructions can be found on our
<a href="../windows/#installation">Windows-specific docs page</a>.
</p>
</div>
### User and Organization Pages
User and organization pages live in a special GitHub repository dedicated to
only the GitHub Pages files. This repository must be named after the account
name. For example, [@mojombos user page
repository](https://github.com/mojombo/mojombo.github.io) has the name
name. For example, [@mojombos user page repository](https://github.com/mojombo/mojombo.github.io) has the name
`mojombo.github.io`.
Content from the `master` branch of your repository will be used to build and
@@ -120,18 +108,18 @@ stored in a specially named `gh-pages` branch or in a `docs` folder on the
will become available under a subpath of your user pages subdomain, such as
`username.github.io/project` (unless a custom domain is specified).
The Jekyll project repository itself is a perfect example: the
[master branch]({{ site.repository }}) contains the actual software project
for Jekyll, however the Jekyll website (that youre looking at right now) is
contained in the [docs folder]({{ site.repository }}/tree/master/docs) of the
same repository.
The Jekyll project repository itself is a perfect example of this branch
structure—the [master branch]({{ site.repository }}) contains the
actual software project for Jekyll, and the Jekyll website that youre
looking at right now is contained in the [docs
folder]({{ site.repository }}/tree/master/docs) of the same repository.
Please refer to GitHub official documentation on
[user, organization and projets pages](https://help.github.com/articles/user-organization-and-project-pages/)
[user, organization and project pages](https://help.github.com/articles/user-organization-and-project-pages/)
to see more detailed examples.
<div class="note warning">
<h5>Source Files Must be in the Root Directory</h5>
<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>
@@ -140,13 +128,13 @@ to see more detailed examples.
</p>
</div>
<div class="note">
<h5>GitHub Pages Documentation, Help, and Support</h5>
<div class="note info">
<h5>Installing the <code>github-pages</code> gem on Windows</h5>
<p>
For more information about what you can do with GitHub Pages, as well as for
troubleshooting guides, you should check out <a
href="https://help.github.com/categories/github-pages-basics/">GitHubs Pages Help
section</a>. If all else fails, you should contact <a
href="https://github.com/contact">GitHub Support</a>.
While Windows is not officially supported, it is possible
to install the <code>github-pages</code> gem on Windows.
Special instructions can be found on our
<a href="../windows/#installation">Windows-specific docs page</a>.
</p>
</div>

File diff suppressed because it is too large Load Diff

190
docs/_docs/includes.md Normal file
View File

@@ -0,0 +1,190 @@
---
title: Includes
permalink: /docs/includes/
---
The `include` tag allows you to include the content from another file stored in the `_includes` folder:
{% raw %}
```liquid
{% 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
You can choose to include file fragments relative to the current file by using the `include_relative` tag:
{% raw %}
```liquid
{% 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,
if `_posts/2014-09-03-my-file.markdown` uses the `include_relative` tag, the included file
must be within the `_posts` directory or one of its subdirectories.
Note that you cannot use the `../` syntax to specify an include location that refers to a higher-level directory.
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
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:
```yaml
---
title: My page
my_variable: footer_company_a.html
---
```
You could then reference that variable in your include:
{% raw %}
```liquid
{% 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:
{% raw %}
```liquid
<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:
{% raw %}
```liquid
{% 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:
{% raw %}
```liquid
<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`):
{% raw %}
```liquid
{% 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://shopify.github.io/liquid/filters/default/).
Overall, you can create includes that act as templates for a variety of uses &mdash; inserting audio or video clips, alerts, special formatting, and more. However, note that you should avoid using too many includes, as this will slow down the build time of your site. For example, don't use includes every time you insert an image. (The above technique shows a use case for special images.)
### 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:
{% raw %}
```liquid
{% capture download_note %}
The latest version of {{ site.product_name }} is now available.
{% endcapture %}
```
{% endraw %}
Then pass this captured variable into the parameter for the include. Omit the quotation marks around the parameter content because it's no longer a string (it's a variable):
{% raw %}
```liquid
{% 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:
{% raw %}
```liquid
{% 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 %}
```liquid
{% 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,57 +1,41 @@
---
layout: docs
title: Welcome
permalink: /docs/home/
redirect_from: /docs/index.html
---
This site aims to be a comprehensive guide to Jekyll. Well cover topics such
as getting your site up and running, creating and managing your content,
customizing the way your site works and looks, deploying to various
environments, and give you some advice on participating in the future
development of Jekyll itself.
This site aims to be a comprehensive guide to Jekyll. Well cover topics such as getting your site up and running, creating and managing content, customizing your build, and deploying.
## So what is Jekyll, exactly?
## What is Jekyll, exactly?
Jekyll is a simple, blog-aware, static site generator. It takes a template
directory containing raw text files in various formats, runs it through
a converter (like [Markdown](https://daringfireball.net/projects/markdown/))
and our [Liquid](https://github.com/Shopify/liquid/wiki) renderer, and
spits out a complete, ready-to-publish static website suitable
for serving with your favorite web server. Jekyll also happens to be the engine
behind [GitHub Pages](https://pages.github.com), which means you can use Jekyll
to host your projects page, blog, or website from GitHubs servers **for
free**.
Jekyll is a simple, blog-aware, static site generator.
## Helpful Hints
You create your content as text files ([Markdown](https://daringfireball.net/projects/markdown/)), and organize them into folders. Then, you build the shell of your site using [Liquid](https://shopify.github.io/liquid/)-enhanced HTML templates. Jekyll automatically stitches the content and templates together, generating a website made entirely of static assets, suitable for uploading to any server.
Throughout this guide there are a number of small-but-handy pieces of
information that can make using Jekyll easier, more interesting, and less
hazardous. Heres what to look out for.
Jekyll happens to be the engine behind [GitHub Pages](https://pages.github.com), so you can host your projects Jekyll page/blog/website on GitHubs servers **for free**.
## Navigating the Guide
Throughout this guide, you'll see these special sections that help you get the most out of Jekyll:
<div class="note">
<h5>ProTips™ help you get more from Jekyll</h5>
<p>These are tips and tricks that will help you be a Jekyll wizard!</p>
<h5>ProTips™</h5>
<p>Tips and tricks that'll make you a Jekyll wizard!</p>
</div>
<div class="note info">
<h5>Notes are handy pieces of information</h5>
<p>These are for the extra tidbits sometimes necessary to understand
Jekyll.</p>
<h5>Notes</h5>
<p>Extra tidbits that are sometimes necessary to understand Jekyll.</p>
</div>
<div class="note warning">
<h5>Warnings help you not blow things up</h5>
<p>Be aware of these messages if you wish to avoid certain death.</p>
<h5>Warnings</h5>
<p>Common pitfalls to avoid.</p>
</div>
<div class="note unreleased">
<h5>You'll see this by a feature that hasn't been released</h5>
<p>Some pieces of this website are for future versions of Jekyll that
are not yet released.</p>
<h5>Unreleased</h5>
<p>Features planned for future versions of Jekyll, but not available yet.</p>
</div>
If you come across anything along the way that we havent covered, or if you
know of a tip you think others would find handy, please [file an
issue]({{ site.repository }}/issues/new) and well see about
including it in this guide.
If you find anything we havent covered, or would like to share a tip that others might find handy, please [file an issue]({{ site.repository }}/issues/new) and well see about adding it to the guide.

View File

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

View File

@@ -1,7 +1,5 @@
---
title: Affinity Team Captains
layout: docs
permalink: /docs/maintaining/affinity-team-captain/
---
**This guide is for affinity team captains.** These special people are **team maintainers** of one of our [affinity teams][] and help triage and evaluate the issues and contributions of others. You may find what is written here interesting, but its definitely not for everyone.

View File

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

View File

@@ -1,7 +1,5 @@
---
title: "Becoming a Maintainer"
layout: docs
permalink: /docs/maintaining/becoming-a-maintainer/
---
**This guide is for contributors.** These special people have contributed to one or more of Jekyll's repositories, but do not yet have write access to any. You may find what is written here interesting, but its definitely not for everyone.
@@ -37,4 +35,4 @@ We would love to expand the team and look forward to many more community members
# Helping Out Elsewhere
In addition to maintainers of our core and plugin code, the Jekyll team is comprised of moderators for our forums. These helpful community members take a look at the topics posted to https://talk.jekyllrb.com and ensure they are properly categorized and are acceptable under our Code of Conduct. If you would like to be a moderator, email one of the maintainers with links to where you have answered questions and a request to be added as a moderator. More help is always welcome.
In addition to maintainers of our core and plugin code, the Jekyll team is comprised of moderators for our forums. These helpful community members take a look at the topics posted to [https://talk.jekyllrb.com](https://talk.jekyllrb.com) and ensure they are properly categorized and are acceptable under our Code of Conduct. If you would like to be a moderator, email one of the maintainers with links to where you have answered questions and a request to be added as a moderator. More help is always welcome.

View File

@@ -1,5 +1,4 @@
---
layout: docs
title: Maintaining Jekyll
permalink: /docs/maintaining/
---
@@ -9,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

@@ -1,7 +1,5 @@
---
title: "Merging a Pull Request"
layout: docs
permalink: /docs/maintaining/merging-a-pull-request/
---
**This guide is for maintainers.** These special people have **write access** to one or more of Jekyll's repositories and help merge the contributions of others. You may find what is written here interesting, but its definitely not for everyone.
@@ -18,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:
@@ -32,15 +30,17 @@ 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. Site Enhancements (`+site`) changes to the source of https://jekyllrb.com, found in `site/`
5. Development Fixes (`+dev`) changes which do not affect user-facing functionality or documentation, such as test fixes or bumping internal dependencies
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/`
6. Development Fixes (`+dev`) changes which do not affect user-facing functionality or documentation, such as test fixes or bumping internal dependencies
7. Forward Ports (`+port`) — bug fixes applied to a previous version of Jekyll pulled onto `master`, e.g. cherry-picked commits from `3-1-stable` to `master`
Once @jekyllbot has merged the pull request, you should see three things:

View File

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

@@ -1,7 +1,5 @@
---
title: "Reviewing a Pull Request"
layout: docs
permalink: /docs/maintaining/reviewing-a-pull-request/
---
**This guide is for maintainers.** These special people have **write access** to one or more of Jekyll's repositories and help merge the contributions of others. You may find what is written here interesting, but its definitely not for everyone.

View File

@@ -1,7 +1,5 @@
---
title: "Special Labels"
layout: docs
permalink: /docs/maintaining/special-labels/
---
**This guide is for maintainers.** These special people have **write access** to one or more of Jekyll's repositories and help merge the contributions of others. You may find what is written here interesting, but its definitely not for everyone.
@@ -20,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

@@ -1,7 +1,5 @@
---
title: "Triaging an Issue"
layout: docs
permalink: /docs/maintaining/triaging-an-issue/
---
**This guide is for maintainers.** These special people have **write access** to one or more of Jekyll's repositories and help merge the contributions of others. You may find what is written here interesting, but its definitely not for everyone.
@@ -53,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 behaviour can be suppressed by setting the [`pinned` label](../maintaining/special-labels.md/#pinned).

View File

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

View File

@@ -1,12 +1,9 @@
---
layout: docs
title: Creating pages
permalink: /docs/pages/
---
In addition to [writing posts](../posts/), another thing you may want to do
with your Jekyll site is create static pages. By taking advantage of the way
Jekyll copies files and directories, this is easy to do.
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.
## Homepage
@@ -28,16 +25,14 @@ homepage of your Jekyll-generated site.
## 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:
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.
- Create a folder in the site's root for each page, and place an index.html
or index.md file in each page 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.
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
@@ -59,42 +54,21 @@ and associated URLs might look like:
└── contact.html # => http://example.com/contact.html
```
### Named folders containing index HTML files
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.
There is nothing wrong with the above method. However, some people like to keep
their URLs free from things like filename extensions. To achieve clean URLs for
pages using Jekyll, you simply need to create a folder for each top-level page
you want, and then place an `index.html` file in each pages folder. This way
the page URL ends up being the folder name, and the web server will serve up
the respective `index.html` file. Here's an example of what this structure
might look like:
## Flattening pages from subfolders into the root directory
```sh
.
├── _config.yml
├── _includes/
├── _layouts/
├── _posts/
├── _site/
├── about/
| └── index.html # => http://example.com/about/
├── contact/
| └── index.html # => http://example.com/contact/
|── other/
| └── index.md # => http://example.com/other/
└── index.html # => http://example.com/
If you have pages organized into subfolders in your source folder and want to flatten them in the root folder on build, you must add the [permalink]({% link _docs/permalinks.md %}) property directly in your page's front matter like this:
```yaml
---
title: My page
permalink: mypageurl.html
---
```
This approach may not suit everyone, but for people who like clean URLs its
simple and it works. In the end, the decision is yours!
### Named folders containing index HTML files
<div class="note">
<h5>ProTip™: Use permalink Front Matter Variable</h5>
<p>
Clean URLs can also be achieved using the <code>permalink</code> front
matter variable. In the example above, using the first method, you can
get URL <code>http://example.com/other</code> for the file
<code>other.md</code> by setting this at the top of the file:
<code>permalink: /other</code>
</p>
</div>
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.

View File

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

View File

@@ -1,20 +1,56 @@
---
layout: docs
title: Permalinks
permalink: /docs/permalinks/
---
Jekyll supports a flexible way to build your sites URLs. You can specify the
permalinks for your site through the [Configuration](../configuration/) or in
the [YAML Front Matter](../frontmatter/) for each post. Youre free to choose
one of the built-in styles to create your links or craft your own. The default
style is `date`.
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 constructed by creating a template URL where dynamic elements
are represented by colon-prefixed keywords. For example, the default `date`
permalink is defined according to the format `/:categories/:year/:month/:day/:title.html`.
You construct permalinks by creating a template URL where dynamic elements are represented by colon-prefixed keywords. The default template permalink is `/:categories/:year/:month/:day/:title:output_ext`. Each of the colon-prefixed keywords is a template variable.
## Template variables
## Where to configure permalinks
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.
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:output_ext
```
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:output_ext`, the default. See [Built-in Permalink Styles](#builtinpermalinkstyles) below for more options.
Setting the permalink in your post, page, or collection's front matter overrides any global settings. Here's an example:
```yaml
---
title: My page title
permalink: /mypageurl/
---
```
Even if your configuration file specifies the `date` style, the URL for this page would be `http://somedomain.com/mypageurl/`.
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:
```
├── mypageurl
│   └── index.html
```
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`.
## Template variables for permalinks {#template-variables}
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>
@@ -30,7 +66,10 @@ permalink is defined according to the format `/:categories/:year/:month/:day/:ti
<p><code>year</code></p>
</td>
<td>
<p>Year from the Posts filename</p>
<p>
Year from the post's filename. May be overridden via the documents
<code>date</code> YAML front matter
</p>
</td>
</tr>
<tr>
@@ -38,7 +77,10 @@ permalink is defined according to the format `/:categories/:year/:month/:day/:ti
<p><code>month</code></p>
</td>
<td>
<p>Month from the Posts filename</p>
<p>
Month from the post's filename. May be overridden via the documents
<code>date</code> YAML front matter
</p>
</td>
</tr>
<tr>
@@ -46,7 +88,10 @@ permalink is defined according to the format `/:categories/:year/:month/:day/:ti
<p><code>i_month</code></p>
</td>
<td>
<p>Month from the Posts filename without leading zeros.</p>
<p>
Month without leading zeros from the post's filename. May be
overridden via the documents <code>date</code> YAML front matter
</p>
</td>
</tr>
<tr>
@@ -54,7 +99,10 @@ permalink is defined according to the format `/:categories/:year/:month/:day/:ti
<p><code>day</code></p>
</td>
<td>
<p>Day from the Posts filename</p>
<p>
Day from the post's filename. May be overridden via the documents
<code>date</code> YAML front matter
</p>
</td>
</tr>
<tr>
@@ -62,7 +110,18 @@ permalink is defined according to the format `/:categories/:year/:month/:day/:ti
<p><code>i_day</code></p>
</td>
<td>
<p>Day from the Posts filename without leading zeros.</p>
<p>
Day without leading zeros from the post's filename. May be overridden
via the documents <code>date</code> YAML front matter
</p>
</td>
</tr>
<tr>
<td>
<p><code>y_day</code></p>
</td>_
<td>
<p>Day of the year from the post's filename, with leading zeros.</p>
</td>
</tr>
<tr>
@@ -70,7 +129,10 @@ permalink is defined according to the format `/:categories/:year/:month/:day/:ti
<p><code>short_year</code></p>
</td>
<td>
<p>Year from the Posts filename without the century.</p>
<p>
Year without the century from the post's filename. May be overridden
via the documents <code>date</code> YAML front matter
</p>
</td>
</tr>
<tr>
@@ -79,7 +141,8 @@ permalink is defined according to the format `/:categories/:year/:month/:day/:ti
</td>
<td>
<p>
Hour of the day, 24-hour clock, zero-padded from the posts <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>
@@ -89,7 +152,7 @@ permalink is defined according to the format `/:categories/:year/:month/:day/:ti
</td>
<td>
<p>
Minute of the hour from the posts <code>date</code> front matter. (00..59)
Minute of the hour from the post's <code>date</code> front matter. (00..59)
</p>
</td>
</tr>
@@ -99,7 +162,7 @@ permalink is defined according to the format `/:categories/:year/:month/:day/:ti
</td>
<td>
<p>
Second of the minute from the posts <code>date</code> front matter. (00..59)
Second of the minute from the post's <code>date</code> front matter. (00..59)
</p>
</td>
</tr>
@@ -120,8 +183,8 @@ permalink is defined according to the format `/:categories/:year/:month/:day/:ti
</td>
<td>
<p>
Slugified title from the documents filename ( any character
except numbers and letters is replaced as hyphen ). May be
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.
</p>
</td>
@@ -132,7 +195,7 @@ permalink is defined according to the format `/:categories/:year/:month/:day/:ti
</td>
<td>
<p>
The specified categories for this Post. If a post has multiple
The specified categories for this post. If a post has multiple
categories, Jekyll will create a hierarchy (e.g. <code>/category1/category2</code>).
Also Jekyll automatically parses out double slashes in the URLs,
so if no categories are present, it will ignore this.
@@ -143,10 +206,11 @@ permalink is defined according to the format `/:categories/:year/:month/:day/:ti
</table>
</div>
## Built-in permalink styles
Note that all template variables relating to time or categories are available to posts only.
While you can specify a custom permalink style using [template variables](#template-variables),
Jekyll also provides the following built-in styles for convenience.
## 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.
<div class="mobile-side-scroller">
<table>
@@ -162,7 +226,7 @@ Jekyll also provides the following built-in styles for convenience.
<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>
@@ -178,7 +242,7 @@ Jekyll also provides the following built-in styles for convenience.
<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>
@@ -186,33 +250,23 @@ Jekyll also provides the following built-in styles for convenience.
<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>
## Pages and collections
Rather than typing `permalink: /:categories/:year/:month/:day/:title/`, you can just type `permalink: pretty`.
The `permalink` configuration setting specifies the permalink style used for
posts. Pages and collections each have their own default permalink style; the
default style for pages is `/:path/:basename` and the default for collections is
`/:collection/:path`.
<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>
These styles are modified to match the suffix style specified in the post
permalink setting. For example, a permalink style of `pretty`, which contains a
trailing slash, will update page permalinks to also contain a trailing slash:
`/:path/:basename/`. A permalink style of `date`, which contains a trailing
file extension, will update page permalinks to also contain a file extension:
`/:path/:basename:output_ext`. The same is true for any custom permalink style.
## Permalink style examples with posts {#permalink-style-examples}
The permalink for an individual page or collection document can always be
overridden in the [YAML Front Matter](../frontmatter/) for the page or document.
Additionally, permalinks for a given collection can be customized [in the
collections configuration](../collections/).
## Permalink style examples
Here are a few examples to clarify how permalink styles get applied with posts.
Given a post named: `/2009-04-29-slap-chop.md`
@@ -243,7 +297,7 @@ Given a post named: `/2009-04-29-slap-chop.md`
</tr>
<tr>
<td>
<p><code>/:month-:day-:year/:title.html</code></p>
<p><code>/:month-:day-:year/:title:output_ext</code></p>
</td>
<td>
<p><code>/04-29-2009/slap-chop.html</code></p>
@@ -260,7 +314,7 @@ Given a post named: `/2009-04-29-slap-chop.md`
<tr>
<td>
<p><code>/:year/:month/:title</code></p>
<p>See <a href="#extensionless-permalinks">extensionless permalinks</a> for details.</p>
<p>See <a href="#extensionless-permalinks">Extensionless permalinks with no trailing slashes</a> for details.</p>
</td>
<td>
<p><code>/2009/04/slap-chop</code></p>
@@ -270,24 +324,58 @@ Given a post named: `/2009-04-29-slap-chop.md`
</table>
</div>
## Extensionless permalinks
## Permalink settings for pages and collections {#pages-and-collections}
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 extensionless 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.
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.
Both [GitHub Pages](../github-pages/) and the Jekyll's built-in WEBrick server
handle these requests properly without any additional work.
For example:
* A permalink style of `/:categories/:year/:month/:day/:title:output_ext` for posts becomes `/:title.html` for pages and collections.
* A permalink style of `pretty` (or `/:categories/:year/:month/:day/:title/`), which omits the file extension and contains a trailing slash, will update page and collection permalinks to also omit the file extension and contain a trailing slash: `/:title/`.
* A permalink style of `date`, which contains a trailing file extension, will update page permalinks to also contain a trailing file extension: `/:title.html`. But no time or category information will be included.
## 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 (such as `path` and `output_ext`). See the [Configuring permalinks for collections](../collections/#permalinks) in Collections for more information.
## Flattening pages in \_site on build
If you want to flatten your pages (pull them out of subfolders) in the `_site` directory when your site builds (similar to posts), add the `permalink` property to the front matter of each page, with no path specified:
```yaml
---
title: My page
permalink: mypageurl.html
---
```
## 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 very extensive support for content negotiation and can
handle extensionless URLs by setting the [multiviews][] option in your
`httpd.conf` or `.htaccess` file:
[multiviews]: https://httpd.apache.org/docs/current/content-negotiation.html#multiviews
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
@@ -295,13 +383,12 @@ Options +MultiViews
### Nginx
The [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.
[try_files]: http://nginx.org/en/docs/http/ngx_http_core_module.html#try_files
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

@@ -1,5 +1,4 @@
---
layout: docs
title: Plugins
permalink: /docs/plugins/
---
@@ -26,27 +25,36 @@ having to modify the Jekyll source itself.
You have 3 options for installing plugins:
1. In your site source root, make a `_plugins` directory. Place your plugins
here. Any file ending in `*.rb` inside this directory will be loaded before
Jekyll generates your site.
2. In your `_config.yml` file, add a new array with the key `gems` and the
values of the gem names of the plugins you'd like to use. An example:
here. Any file ending in `*.rb` inside this directory will be loaded before
Jekyll generates your site.
2. In your `_config.yml` file, add a new array with the key `plugins` (or `gems` for Jekyll < `3.5.0`) and the
values of the gem names of the plugins you'd like to use. An example:
gems: [jekyll-coffeescript, jekyll-watch, jekyll-assets]
# This will require each of these gems automatically.
```yaml
# This will require each of these plugins automatically.
plugins:
- jekyll-gist
- jekyll-coffeescript
- jekyll-assets
- another-jekyll-plugin
```
Then install your plugins using `gem install jekyll-coffeescript jekyll-watch jekyll-assets`
Then install your plugins using `gem install jekyll-gist jekyll-coffeescript jekyll-assets another-jekyll-plugin`
3. Add the relevant plugins to a Bundler group in your `Gemfile`. An
example:
example:
group :jekyll_plugins do
gem "my-jekyll-plugin"
gem "another-jekyll-plugin"
end
Now you need to install all plugins from your Bundler group by running single command `bundle install`
```ruby
group :jekyll_plugins do
gem "jekyll-gist"
gem "jekyll-coffeescript"
gem "jekyll-assets"
gem "another-jekyll-plugin"
end
```
Now you need to install all plugins from your Bundler group by running single command `bundle install`.
<div class="note info">
<h5>
@@ -60,7 +68,25 @@ values of the gem names of the plugins you'd like to use. An example:
</p>
</div>
In general, plugins you make will fall into one of five categories:
### The jekyll_plugins group
Jekyll gives this particular group of gems in your `Gemfile` a different
treatment. Any gem included in this group is loaded before Jekyll starts
processing the rest of your source directory.
A gem included here will be activated even if its not explicitly listed under
the `plugins:` key in your site's config file.
<div class="note warning">
<p>
Gems included in the <code>:jekyll-plugins</code> group are activated
regardless of the <code>--safe</code> mode setting. Be aware of what
gems are included under this group!
</p>
</div>
In general, plugins you make will fall broadly into one of five categories:
1. [Generators](#generators)
2. [Converters](#converters)
@@ -68,6 +94,12 @@ In general, plugins you make will fall into one of five categories:
4. [Tags](#tags)
5. [Hooks](#hooks)
See the bottom of the page for a [list of available plugins](#available-plugins).
For further information on how to develop your own plugins, check out the [Liquid documentation](https://github.com/Shopify/liquid/wiki/Liquid-for-Programmers) as well.
If you never developed a Jekyll plugin [check this useful wrap-up](https://ayastreb.me/writing-a-jekyll-plugin/) by @ayastreb to get started.
## Generators
You can create a generator when you need Jekyll to create additional content
@@ -111,7 +143,6 @@ This is a more complex generator that generates new pages:
```ruby
module Jekyll
class CategoryPage < Page
def initialize(site, base, dir, category)
@site = site
@@ -140,7 +171,6 @@ module Jekyll
end
end
end
end
```
@@ -379,11 +409,11 @@ Liquid::Template.register_tag('render_time', Jekyll::RenderTimeTag)
In the example above, we can place the following tag anywhere in one of our
pages:
```ruby
{% raw %}
```ruby
<p>{% render_time page rendered at: %}</p>
{% endraw %}
```
{% endraw %}
And we would get something like this on the page:
@@ -727,10 +757,6 @@ You can find a few useful plugins at the following locations:
#### Generators
- [ArchiveGenerator by Ilkka Laukkanen](https://gist.github.com/707909): Uses [this archive page](https://gist.github.com/707020) to generate archives.
- [LESS.js Generator by Andy Fowler](https://gist.github.com/642739): Renders
LESS.js files during generation.
- [Version Reporter by Blake Smith](https://gist.github.com/449491): Creates a version.html file containing the Jekyll version.
- [Sitemap.xml Generator by Michael Levin](https://github.com/kinnetica/jekyll-plugins): Generates a sitemap.xml file by traversing all of the available posts and pages.
- [Full-text search by Pascal Widdershoven](https://github.com/PascalW/jekyll_indextank): Adds full-text search to your Jekyll site with a plugin and a bit of JavaScript.
- [AliasGenerator by Thomas Mango](https://github.com/tsmango/jekyll_alias_generator): Generates redirect pages for posts when an alias is specified in the YAML Front Matter.
@@ -746,7 +772,6 @@ LESS.js files during generation.
- [Typescript Generator by Matt Sheehan](https://github.com/sheehamj13/jekyll_ts): Generate Javascript on build from your Typescript.
- [Jekyll::AutolinkEmail by Ivan Tse](https://github.com/ivantsepp/jekyll-autolink_email): Autolink your emails.
- [Jekyll::GitMetadata by Ivan Tse](https://github.com/ivantsepp/jekyll-git_metadata): Expose Git metadata for your templates.
- [Jekyll Http Basic Auth Plugin](https://gist.github.com/snrbrnjna/422a4b7e017192c284b3): Plugin to manage http basic auth for jekyll generated pages and directories.
- [Jekyll Auto Image by Merlos](https://github.com/merlos/jekyll-auto-image): Gets the first image of a post. Useful to list your posts with images or to add [twitter cards](https://dev.twitter.com/cards/overview) to your site.
- [Jekyll Portfolio Generator by Shannon Babincsak](https://github.com/codeinpink/jekyll-portfolio-generator): Generates project pages and computes related projects out of project data files.
- [Jekyll-Umlauts by Arne Gockeln](https://github.com/webchef/jekyll-umlauts): This generator replaces all german umlauts (äöüß) case sensitive with html.
@@ -754,27 +779,23 @@ LESS.js files during generation.
- [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.
- [jekyll-multi-paginate](https://github.com/fadhilnapis/jekyll-multi-paginate): Simple Jekyll paginator for multiple page. Ease you to make pagination on multiple page especially like multiple language.
- [jekyll-category-pages](https://github.com/field-theory/jekyll-category-pages): Easy-to-use category index pages with and without pagination. Supports non-URL-safe category keywords and has extensive documentation and test coverage.
- [Tweetsert](https://github.com/ibrado/jekyll-tweetsert): Imports tweets (Twitter statuses) as new posts. Features multiple timeline support, hashtag import, filtering, automatic category and/or tags, optional retweets and replies.
- [Stickyposts](https://github.com/ibrado/jekyll-stickyposts): Moves or copies (pins) posts marked `sticky: true` to the top of the list. Perfect for keeping important announcements on the home page, or giving collections a descriptive entry. Paginator friendly.
- [Jekyll::Paginate::Content](https://github.com/ibrado/jekyll-paginate-content): Content paginator in the style of jekyll-paginator-v2 that splits pages, posts, and collection entries into several pages. Specify a separator or use HTML &lt;h1&gt; etc. headers. Automatic splitting, single-page view, pager/trail, self-adjusting links, multipage TOC, SEO support.
- [Premonition](https://github.com/amedia/premonition): Adds block-styled side content to your page. For example summary, notes, hints or warning boxes.
- [jekyll-fontello](https://github.com/ericcornelissen/jekyll-fontello): A Jekyll plugin that automatically downloads your webfont from Fontello.
#### Converters
- [Pug plugin by Doug Beney](http://jekyll-pug.dougie.io): Use the popular Pug (previously Jade) templating language in Jekyll. Complete with caching, includes support, and much more.
- [Textile converter](https://github.com/jekyll/jekyll-textile-converter): Convert `.textile` files into HTML. Also includes the `textilize` Liquid filter.
- [Slim plugin](https://github.com/slim-template/jekyll-slim): Slim converter and includes for Jekyll with support for Liquid tags.
- [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-plugin](https://github.com/dsanson/jekyll-pandoc-plugin): Use pandoc for rendering markdown.
- [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/).
@@ -783,12 +804,9 @@ LESS.js files during generation.
#### Filters
- [Truncate HTML](https://github.com/MattHall/truncatehtml) by [Matt Hall](http://codebeef.com): A Jekyll filter that truncates HTML while preserving markup structure.
- [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.
@@ -799,42 +817,34 @@ LESS.js files during generation.
- [Deprecated articles keeper](https://github.com/kzykbys/JekyllPlugins) by [Kazuya Kobayashi](http://blog.kazuya.co/): A simple Jekyll filter which monitor how old an article is.
- [Jekyll-jalali](https://github.com/mehdisadeghi/jekyll-jalali) by [Mehdi Sadeghi](http://mehdix.ir): A simple Gregorian to Jalali date converter filter.
- [Jekyll Thumbnail Filter](https://github.com/matallo/jekyll-thumbnail-filter): Related posts thumbnail filter.
- [Jekyll-Smartify](https://github.com/pathawks/jekyll-smartify): SmartyPants filter. Make &quot;quotes&quot; &ldquo;curly&rdquo;
- [liquid-md5](https://github.com/pathawks/liquid-md5): Returns an MD5 hash. Helpful for generating Gravatars in templates.
- [jekyll-roman](https://github.com/paulrobertlloyd/jekyll-roman): A liquid filter for Jekyll that converts numbers into Roman numerals.
- [jekyll-typogrify](https://github.com/myles/jekyll-typogrify): A Jekyll plugin that brings the functions of [typogruby](http://avdgaag.github.io/typogruby/).
- [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.
- [jekyll-random](https://github.com/codecalm/jekyll-random) by [codecalm](https://nodecalm.net): A Jekyll plugin that generates pseudo-random data. Very useful when you want to generate a large amount of random data.
#### Tags
You can find a few useful plugins at the following locations:
- [Jekyll-gist](https://github.com/jekyll/jekyll-gist): Use the `gist` tag to easily embed a GitHub Gist onto your site. This works with public or secret gists.
- [Asset Path Tag](https://github.com/samrayner/jekyll-asset-path-plugin) by [Sam Rayner](http://www.samrayner.com/): Allows organisation of assets into subdirectories by outputting a path for a given file relative to the current post or page.
- [Delicious Plugin by Christian Hellsten](https://github.com/christianhellsten/jekyll-plugins): Fetches and renders bookmarks from delicious.com.
- [Ultraviolet Plugin by Steve Alex](https://gist.github.com/480380): Jekyll tag for the [Ultraviolet](https://github.com/grosser/ultraviolet) code highligher.
- [Tag Cloud Plugin by Ilkka Laukkanen](https://gist.github.com/710577): Generate a tag cloud that links to tag pages.
- [GIT Tag by Alexandre Girard](https://gist.github.com/730347): Add Git activity inside a list.
- [MathJax Liquid Tags by Jessy Cowan-Sharp](https://gist.github.com/834610): Simple liquid tags for Jekyll that convert inline math and block equations to the appropriate MathJax script tags.
- [Non-JS Gist Tag by Brandon Tilley](https://gist.github.com/1027674) A Liquid tag that embeds Gists and shows code for non-JavaScript enabled browsers and readers.
- [Render Time Tag by Blake Smith](https://gist.github.com/449509): Displays the time a Jekyll page was generated.
- [Status.net/OStatus Tag by phaer](https://gist.github.com/912466): Displays the notices in a given status.net/ostatus feed.
- [Embed.ly client by Robert Böhnke](https://github.com/robb/jekyll-embedly-client): Autogenerate embeds from URLs using oEmbed.
- [Logarithmic Tag Cloud](https://gist.github.com/2290195): Flexible. Logarithmic distribution. Documentation inline.
- [oEmbed Tag by Tammo van Lessen](https://gist.github.com/1455726): Enables easy content embedding (e.g. from YouTube, Flickr, Slideshare) via oEmbed.
- [FlickrSetTag by Thomas Mango](https://github.com/tsmango/jekyll_flickr_set_tag): Generates image galleries from Flickr sets.
- [Tweet Tag by Scott W. Bradley](https://github.com/scottwb/jekyll-tweet-tag): Liquid tag for [Embedded Tweets](https://dev.twitter.com/docs/embedded-tweets) using 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](http://code.google.com/p/swfobject/).
- [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.
@@ -843,15 +853,13 @@ LESS.js files during generation.
- [Jekyll Date Chart](https://github.com/GSI/jekyll_date_chart) by [GSI](https://github.com/GSI): Block that renders date line charts based on textile-formatted tables.
- [Jekyll Image Encode](https://github.com/GSI/jekyll_image_encode) by [GSI](https://github.com/GSI): Tag that renders base64 codes of images fetched from the web.
- [Jekyll Quick Man](https://github.com/GSI/jekyll_quick_man) by [GSI](https://github.com/GSI): Tag that renders pretty links to man page sources on the internet.
- [jekyll-font-awesome](https://gist.github.com/23maverick23/8532525): Quickly and easily add Font Awesome icons to your posts.
- [Lychee Gallery Tag](https://gist.github.com/tobru/9171700) by [tobru](https://github.com/tobru): Include [Lychee](http://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://www.alorenzi.eu/): Jekyll plugin to generate thumbnails from a Piwigo gallery and display them with a Liquid tag
- [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](http://indiewebcamp.com/webmention) integration using [Webmention.io](http://webmention.io). Includes an optional JavaScript for updating webmentions automatically between publishes and, if available, in realtime using WebSockets.
- [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.
@@ -863,38 +871,42 @@ LESS.js files during generation.
- [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 Ideal Image Slider](https://github.com/jekylltools/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.
- [Jekyll Brand Social Wall](https://github.com/MediaComem/jekyll-brand-social-wall): A jekyll plugin to generate a social wall with your favorite social networks
- [Jekyll If File Exists](https://github.com/k-funk/jekyll-if-file-exists): A Jekyll Plugin that checks if a file exists with an if/else block.
- [BibSonomy](https://github.com/rjoberon/bibsonomy-jekyll): Jekyll
plugin to generate publication lists from [BibSonomy](https://www.bibsonomy.org/).
- [github-cards](https://github.com/edward-shen/github-cards): Creates styleable Github cards for your Github projects.
- [disqus-for-jekyll](https://github.com/kacperduras/disqus-for-jekyll): A Jekyll plugin to view the comments powered by Disqus.
- [jekyll-html](https://github.com/kacperduras/jekyll-html): A Jekyll plugin to use HTML tags in Jekyll pages, posts and collections.
- [jekyll-onebox](https://github.com/rriemann/jekyll-onebox): Liquid tag for displaying HTML previews (embeds) for links to popular domains. Plugin is based on [Onebox](https://github.com/discourse/onebox) that powers link previews in [Discourse](http://github.com/discourse/discourse) forums.
- [jekyll-w2m](https://github.com/kacperduras/jekyll-w2m): A Jekyll plugin to liberate content from Microsoft Word documents (powered by [word-to-markdown](https://github.com/benbalter/word-to-markdown)).
#### 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](http://flatterline.com/): Portfolio/project page generator, team/individual page generator, an author bio liquid tag for use on posts, and a few other smaller plugins.
- [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
- [Analytics for Jekyll](https://github.com/hendrikschneider/jekyll-analytics) by Hendrik Schneider: An effortless way to add various trackers like Google Analytics, Matomo (formerly Piwik), mPulse, etc. to your site.
- [ditaa-ditaa](https://github.com/tmthrgd/ditaa-ditaa) by Tom Thorogood: a drastic revision of jekyll-ditaa that renders diagrams drawn using ASCII art into PNG images.
- [Pygments Cache Path by Raimonds Simanovskis](https://github.com/rsim/blog.rayapps.com/blob/master/_plugins/pygments_cache_patch.rb): Plugin to cache syntax-highlighted code from Pygments.
- [Draft/Publish Plugin by Michael Ivey](https://gist.github.com/49630): Save posts as drafts.
- [Growl Notification Generator by Tate Johnson](https://gist.github.com/490101): Send Jekyll notifications to Growl.
- [Growl Notification Hook by Tate Johnson](https://gist.github.com/525267): Better alternative to the above, but requires his “hook” fork.
- [Related Posts by Lawrence Woodman](https://github.com/LawrenceWoodman/related_posts-jekyll_plugin): Overrides `site.related_posts` to use categories to assess relationship.
- [jekyll-tagging-related_posts](https://github.com/toshimaru/jekyll-tagging-related_posts): Jekyll related_posts function based on tags (works on Jekyll3).
- [Tiered Archives by Eli Naeher](https://gist.github.com/88cda643aa7e3b0ca1e5): Create tiered template variable that allows you to group archives by year and month.
- [Jekyll-localization](https://github.com/blackwinter/jekyll-localization): Jekyll plugin that adds localization features to the rendering engine.
- [Jekyll-rendering](https://github.com/blackwinter/jekyll-rendering): Jekyll plugin to provide alternative rendering engines.
- [Jekyll-pagination](https://github.com/blackwinter/jekyll-pagination): Jekyll plugin to extend the pagination generator.
- [Jekyll-tagging](https://github.com/pattex/jekyll-tagging): Jekyll plugin to automatically generate a tag cloud and tag pages.
- [Jekyll-scholar](https://github.com/inukshuk/jekyll-scholar): Jekyll extensions for the blogging scholar.
- [Jekyll-asset_bundler](https://github.com/moshen/jekyll-asset_bundler): Bundles and minifies JavaScript and CSS.
- [Jekyll-assets](http://ixti.net/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).
- [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.
@@ -917,20 +929,17 @@ LESS.js files during generation.
- [jekyll-menus](https://github.com/forestryio/jekyll-menus): Hugo style menus for your Jekyll site... recursive menus included.
- [jekyll-data](https://github.com/ashmaroli/jekyll-data): Read data files within Jekyll Theme Gems.
- [jekyll-pinboard](https://github.com/snaptortoise/jekyll-pinboard-plugin): Access your Pinboard bookmarks within your Jekyll theme.
#### Editors
- [sublime-jekyll](https://github.com/23maverick23/sublime-jekyll): A Sublime Text package for Jekyll static sites. This package should help creating Jekyll sites and posts easier by providing access to key template tags and filters, as well as common completions and a current date/datetime command (for dating posts). You can install this package manually via GitHub, or via [Package Control](https://packagecontrol.io/packages/Jekyll).
- [vim-jekyll](https://github.com/parkr/vim-jekyll): A vim plugin to generate
new posts and run `jekyll build` all without leaving vim.
- [markdown-writer](https://atom.io/packages/markdown-writer): An Atom package for Jekyll. It can create new posts/drafts, manage tags/categories, insert link/images and add many useful key mappings.
- [Wordpress2Jekyll](https://wordpress.org/plugins/wp2jekyll/): A Wordpress plugin that allows you to use Wordpress as your editor and (automatically) export content in to Jekyll. WordPress2Jekyll attempts to marry these two systems together in order to make a site that can be easily managed from all devices.
- [jekyll-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.
- [jekyll-pwa-plugin](https://github.com/lavas-project/jekyll-pwa): A plugin provides PWA support for Jekyll. It generates a service worker in Jekyll build process and makes precache and runtime cache available in the runtime with Google Workbox.
- [jekyll-algolia](https://community.algolia.com/jekyll-algolia/): Add fast and relevant search to your Jekyll site through the Algolia API.
<div class="note info">
<h5>Jekyll Plugins Wanted</h5>
<h5>Submit your gem plugins</h5>
<p>
If you have a Jekyll plugin that you would like to see added to this list,
you should <a href="../contributing/">read the contributing page</a> to find
You're encouraged to add your Jekyll gem plugins to this list, <a href="../contributing/">read the contributing page</a> to find
out how to make that happen.
</p>
</div>

View File

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

View File

@@ -1,28 +1,51 @@
---
layout: docs
title: Quick-start guide
permalink: /docs/quickstart/
---
For the impatient, here's how to get a boilerplate Jekyll site up and running.
If you already have a full [Ruby](https://www.ruby-lang.org/en/downloads/) development environment with all headers and [RubyGems](https://rubygems.org/pages/download) installed (see Jekyll's [requirements](/docs/installation/#requirements)), you can create a new Jekyll site by doing the following:
```sh
~ $ gem install jekyll bundler
~ $ jekyll new myblog
~ $ cd myblog
~/myblog $ bundle exec jekyll serve
# => Now browse to http://localhost:4000
# Install Jekyll and Bundler gems through RubyGems
gem install jekyll bundler
# Create a new Jekyll site at ./myblog
jekyll new myblog
# Change into your new directory
cd myblog
# Build the site on the preview server
bundle exec jekyll serve
# Now browse to http://localhost:4000
```
The `jekyll new` command now automatically initiates `bundle install` and installs the dependencies required. To skip this, pass `--skip-bundle` option like so `jekyll new myblog --skip-bundle`.
If you 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.
If you wish to install jekyll into an existing directory, you can do so by running `jekyll new .` from within the directory instead of creating a new one. If the existing directory isn't empty, you'll also have to pass the `--force` option like so `jekyll new . --force`.
## About Bundler
That's nothing, though. The real magic happens when you start creating blog
posts, using the front matter to control templates and layouts, and taking
advantage of all the awesome configuration options Jekyll makes available.
`gem install jekyll bundler` installs the [jekyll](https://rubygems.org/gems/jekyll/) and [bundler](https://rubygems.org/gems/bundler) gems through [RubyGems](https://rubygems.org/). You need only to install the gems one time &mdash; not every time you create a new Jekyll project. Here are some additional details:
If you're running into problems, ensure you have all the [requirements
installed][Installation].
* `bundler` is a gem that manages other Ruby gems. It makes sure your gems and gem versions are compatible, and that you have all necessary dependencies each gem requires.
* The `Gemfile` and `Gemfile.lock` files inform Bundler about the gem requirements in your site. If your site doesn't have these Gemfiles, you can omit `bundle exec` and just run `jekyll serve`.
[Installation]: /docs/installation/
* When you run `bundle exec jekyll serve`, Bundler uses the gems and versions as specified in `Gemfile.lock` to ensure your Jekyll site builds with no compatibility or dependency conflicts.
## Options for creating a new site with Jekyll
`jekyll new <PATH>` installs a new Jekyll site at the path specified (relative to current directory). In this case, Jekyll will be installed in a directory called `myblog`. Here are some additional details:
* To install the Jekyll site into the directory you're currently in, run `jekyll new .` If the existing directory isn't empty, you can pass the `--force` option with `jekyll new . --force`.
* `jekyll new` automatically initiates `bundle install` to install the dependencies required. (If you don't want Bundler to install the gems, use `jekyll new myblog --skip-bundle`.)
* By default, the Jekyll site installed by `jekyll new` uses a gem-based theme called [Minima](https://github.com/jekyll/minima). With [gem-based themes](../themes), some of the directories and files are stored in the theme-gem, hidden from your immediate view.
* We recommend setting up Jekyll with a gem-based theme but if you want to start with a blank slate, use `jekyll new myblog --blank`
* To learn about other parameters you can include with `jekyll new`, type `jekyll new --help`.
When in doubt, use the <code>help</code> command to remind you of all available options and usage, it also works with the <code>new</code>, <code>build</code> and <code>serve</code> subcommands, e.g. <code>jekyll help new</code> or <code>jekyll help build</code>.
{: .note .info }
## Next steps
Building a Jekyll site with the default theme is just the first step. The real magic happens when you start creating blog posts, using the front matter to control templates and layouts, and taking advantage of all the awesome configuration options Jekyll makes available.

View File

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

View File

@@ -1,5 +1,4 @@
---
layout: docs
title: Sites using Jekyll
permalink: /docs/sites/
---
@@ -10,10 +9,12 @@ learning purposes.
- [Tom Preston-Werner](http://tom.preston-werner.com/)
([source](https://github.com/mojombo/mojombo.github.io))
- [GitHub Official Teaching Materials](http://training.github.com)
- [GitHub Official Teaching Materials](https://services.github.com/training/)
([source](https://github.com/github/training-kit))
- [Rasmus Andersson](http://rsms.me/)
- [Rasmus Andersson](https://rsms.me/)
([source](https://github.com/rsms/rsms.github.com))
- [MvvmCross](https://mvvmcross.github.io/MvvmCross/)
([source](https://github.com/MvvmCross/MvvmCross/tree/master/docs))
If you would like to explore more examples, you can find a list of sites
and their sources on the ["Sites" page in the Jekyll wiki][jekyll-sites].

View File

@@ -1,5 +1,4 @@
---
layout: docs
title: Static Files
permalink: /docs/static-files/
---
@@ -26,7 +25,7 @@ following metadata:
<td><p><code>file.path</code></p></td>
<td><p>
The relative path to the file, e.g <code>/assets/img/image.jpg</code>
The relative path to the file, e.g. <code>/assets/img/image.jpg</code>
</p></td>
</tr>
@@ -34,7 +33,7 @@ following metadata:
<td><p><code>file.modified_time</code></p></td>
<td><p>
The `Time` the file was last modified, e.g <code>2016-04-01 16:35:26 +0200</code>
The `Time` the file was last modified, e.g. <code>2016-04-01 16:35:26 +0200</code>
</p></td>
</tr>
@@ -66,3 +65,36 @@ following metadata:
</tbody>
</table>
</div>
Note that in the above table, `file` can be anything. It's simply an arbitrarily set variable used in your own logic (such as in a for loop). It isn't a global site or page variable.
## Add front matter to static files
Although you can't directly add front matter values to static files, you can set front matter values through the [defaults property](../configuration/#front-matter-defaults) in your configuration file. When Jekyll builds the site, it will use the front matter values you set.
Here's an example:
In your `_config.yml` file, add the following values to the `defaults` property:
```yaml
defaults:
- scope:
path: "assets/img"
values:
image: true
```
This assumes that your Jekyll site has a folder path of `assets/img` where you have images (static files) stored. When Jekyll builds the site, it will treat each image as if it had the front matter value of `image: true`.
Suppose you want to list all your image assets as contained in `assets/img`. You could use this for loop to look in the `static_files` object and get all static files that have this front matter property:
{% raw %}
```liquid
{% assign image_files = site.static_files | where: "image", true %}
{% for myimage in image_files %}
{{ myimage.path }}
{% endfor %}
```
{% endraw %}
When you build your site, the output will list the path to each file that meets this front matter condition.

View File

@@ -1,5 +1,4 @@
---
layout: docs
title: Directory structure
permalink: /docs/structure/
---
@@ -17,6 +16,8 @@ A basic Jekyll site usually looks something like this:
```sh
.
├── _config.yml
├── _data
| └── members.yml
├── _drafts
| ├── begin-with-the-crazy-ideas.md
| └── on-simplicity-in-technology.md
@@ -29,13 +30,25 @@ A basic Jekyll site usually looks something like this:
├── _posts
| ├── 2007-10-29-why-every-programmer-should-play-nethack.md
| └── 2009-04-26-barcamp-boston-4-roundup.md
├── _data
| ── members.yml
├── _sass
| ── _base.scss
| └── _layout.scss
├── _site
├── .jekyll-metadata
└── index.html
└── index.html # can also be an 'index.md' with valid YAML Frontmatter
```
<div class="note info">
<h5>Directory structure of Jekyll sites using gem-based themes</h5>
<p>
Starting <strong>Jekyll 3.2</strong>, a new Jekyll project bootstrapped with <code>jekyll new</code> uses <a href="../themes/">gem-based themes</a> to define the look of the site. This results in a lighter default directory structure : <code>_layouts</code>, <code>_includes</code> and <code>_sass</code> are stored in the theme-gem, by default.
</p>
<br />
<p>
<a href="https://github.com/jekyll/minima">minima</a> is the current default theme, and <code>bundle show minima</code> will show you where minima theme's files are stored on your computer.
</p>
</div>
An overview of what each of these does:
<div class="mobile-side-scroller">
@@ -53,11 +66,9 @@ An overview of what each of these does:
</td>
<td>
<p>
Stores <a href="../configuration/">configuration</a> data. Many of
these options can be specified from the command line executable but
its easier to specify them here so you dont have to remember them.
</p>
</td>
</tr>
@@ -67,11 +78,9 @@ An overview of what each of these does:
</td>
<td>
<p>
Drafts are unpublished posts. The format of these files is without a
date: <code>title.MARKUP</code>. Learn how to <a href="../drafts/">
work with drafts</a>.
</p>
</td>
</tr>
@@ -81,13 +90,11 @@ An overview of what each of these does:
</td>
<td>
<p>
These are the partials that can be mixed and matched by your layouts
and posts to facilitate reuse. The liquid tag
<code>{% raw %}{% include file.ext %}{% endraw %}</code>
can be used to include the partial in
<code>_includes/file.ext</code>.
</p>
</td>
</tr>
@@ -97,14 +104,12 @@ An overview of what each of these does:
</td>
<td>
<p>
These are the templates that wrap posts. Layouts are chosen on a
post-by-post basis in the
<a href="../frontmatter/">YAML Front Matter</a>,
which is described in the next section. The liquid tag
<code>{% raw %}{{ content }}{% endraw %}</code>
is used to inject content into the web page.
</p>
</td>
</tr>
@@ -114,14 +119,12 @@ An overview of what each of these does:
</td>
<td>
<p>
Your dynamic content, so to speak. The naming convention of these
files is important, and must follow the format:
<code>YEAR-MONTH-DAY-title.MARKUP</code>.
The <a href="../permalinks/">permalinks</a> can be customized for
each post, but the date and markup language are determined solely by
the file name.
</p>
</td>
</tr>
@@ -131,15 +134,25 @@ An overview of what each of these does:
</td>
<td>
<p>
Well-formatted site data should be placed here. The Jekyll engine
will autoload all YAML files in this directory (using either the
<code>.yml</code>, <code>.yaml</code>, <code>.json</code> or
<code>.csv</code> formats and extensions) and they will be
will autoload all data files (using either the <code>.yml</code>,
<code>.yaml</code>, <code>.json</code> or <code>.csv</code>
formats and extensions) in this directory, and they will be
accessible via `site.data`. If there's a file
<code>members.yml</code> under the directory, then you can access
contents of the file through <code>site.data.members</code>.
</p>
</td>
</tr>
<tr>
<td>
<p><code>_sass</code></p>
</td>
<td>
<p>
These are sass partials that can be imported into your <code>main.scss</code>
which will then be processed into a single stylesheet
<code>main.css</code> that defines the styles to be used by your site.
</p>
</td>
</tr>
@@ -149,11 +162,9 @@ An overview of what each of these does:
</td>
<td>
<p>
This is where the generated site will be placed (by default) once
Jekyll is done transforming it. Its probably a good idea to add this
to your <code>.gitignore</code> file.
</p>
</td>
</tr>
@@ -163,29 +174,26 @@ An overview of what each of these does:
</td>
<td>
<p>
This helps Jekyll keep track of which files have not been modified
since the site was last built, and which files will need to be
regenerated on the next build. This file will not be included in the
generated site. Its probably a good idea to add this to your
<code>.gitignore</code> file.
</p>
</td>
</tr>
<tr>
<td>
<p><code>index.html</code> and other HTML, Markdown, Textile files</p>
<p><code>index.html</code> or <code>index.md</code> and other HTML,
Markdown, Textile files</p>
</td>
<td>
<p>
Provided that the file has a <a href="../frontmatter/">YAML Front
Matter</a> section, it will be transformed by Jekyll. The same will
happen for any <code>.html</code>, <code>.markdown</code>,
<code>.md</code>, or <code>.textile</code> file in your sites root
directory or directories not listed above.
</p>
</td>
</tr>
@@ -195,14 +203,12 @@ An overview of what each of these does:
</td>
<td>
<p>
Every other directory and file except for those listed above—such as
<code>css</code> and <code>images</code> folders,
<code>favicon.ico</code> files, and so forth—will be copied verbatim
to the generated site. There are plenty of <a href="../sites/">sites
already using Jekyll</a> if youre curious to see how theyre laid
out.
</p>
</td>
</tr>

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

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

View File

@@ -1,14 +1,14 @@
---
layout: docs
title: Templates
permalink: /docs/templates/
---
Jekyll uses the [Liquid](https://shopify.github.io/liquid/) templating language to
process templates. All of the standard Liquid [tags](https://shopify.github.io/liquid/tags/) and
[filters](https://shopify.github.io/liquid/filters/) are
supported. Jekyll even adds a few handy filters and tags of its own to make
common tasks easier.
process templates. All of the standard Liquid [tags](https://shopify.github.io/liquid/tags/control-flow/) and
[filters](https://shopify.github.io/liquid/filters/abs/) are
supported. To make common tasks easier, Jekyll even adds a few handy filters
and tags of its own, all of which you can find on this page. Jekyll even lets
you come up with your own tags via plugins.
## Filters
@@ -91,6 +91,20 @@ common tasks easier.
</p>
</td>
</tr>
<tr>
<td>
<p class="name"><strong>Date to String in ordinal US style</strong></p>
<p>Format a date to ordinal, US, short format.</p>
</td>
<td class="align-center">
<p>
<code class="filter">{% raw %}{{ site.time | date_to_string: "ordinal", "US" }}{% endraw %}</code>
</p>
<p>
<code class="output">Nov 7th, 2008</code>
</p>
</td>
</tr>
<tr>
<td>
<p class="name"><strong>Date to Long String</strong></p>
@@ -105,6 +119,20 @@ common tasks easier.
</p>
</td>
</tr>
<tr>
<td>
<p class="name"><strong>Date to Long String in ordinal UK style</strong></p>
<p>Format a date to ordinal, UK, long format.</p>
</td>
<td class="align-center">
<p>
<code class="filter">{% raw %}{{ site.time | date_to_long_string: "ordinal" }}{% endraw %}</code>
</p>
<p>
<code class="output">7th November 2008</code>
</p>
</td>
</tr>
<tr>
<td>
<p class="name"><strong>Where</strong></p>
@@ -147,6 +175,22 @@ common tasks easier.
</p>
</td>
</tr>
<tr>
<td>
<p class="name"><strong>Group By Expression</strong></p>
<p>Group an array's items using a Liquid expression.</p>
</td>
<td class="align-center">
<p>
<code class="filter">{% raw %}{{ site.members | group_by_exp:"item",
"item.graduation_year | truncate: 3, \"\"" }}{% endraw %}</code>
</p>
<p>
<code class="output">[{"name"=>"201...", "items"=>[...]},
{"name"=>"200...", "items"=>[...]}]</code>
</p>
</td>
</tr>
<tr>
<td>
<p class="name"><strong>XML Escape</strong></p>
@@ -163,15 +207,15 @@ common tasks easier.
<p class="name"><strong>CGI Escape</strong></p>
<p>
CGI escape a string for use in a URL. Replaces any special characters
with appropriate %XX replacements.
with appropriate <code>%XX</code> replacements. CGI escape normally replaces a space with a plus <code>+</code> sign.
</p>
</td>
<td class="align-center">
<p>
<code class="filter">{% raw %}{{ "foo,bar;baz?" | cgi_escape }}{% endraw %}</code>
<code class="filter">{% raw %}{{ "foo, bar; baz?" | cgi_escape }}{% endraw %}</code>
</p>
<p>
<code class="output">foo%2Cbar%3Bbaz%3F</code>
<code class="output">foo%2C+bar%3B+baz%3F</code>
</p>
</td>
</tr>
@@ -179,15 +223,15 @@ common tasks easier.
<td>
<p class="name"><strong>URI Escape</strong></p>
<p>
URI escape a string.
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.
</p>
</td>
<td class="align-center">
<p>
<code class="filter">{% raw %}{{ "foo, bar \baz?" | uri_escape }}{% endraw %}</code>
<code class="filter">{% raw %}{{ "http://foo.com/?q=foo, \bar?" | uri_escape }}{% endraw %}</code>
</p>
<p>
<code class="output">foo,%20bar%20%5Cbaz?</code>
<code class="output">http://foo.com/?q=foo,%20%5Cbar?</code>
</p>
</td>
</tr>
@@ -208,7 +252,7 @@ common tasks easier.
<tr>
<td>
<p class="name"><strong>Array to Sentence</strong></p>
<p>Convert an array into a sentence. Useful for listing tags.</p>
<p>Convert an array into a sentence. Useful for listing tags. Optional argument for connector.</p>
</td>
<td class="align-center">
<p>
@@ -217,6 +261,12 @@ common tasks easier.
<p>
<code class="output">foo, bar, and baz</code>
</p>
<p>
<code class="filter">{% raw %}{{ page.tags | array_to_sentence_string: 'or' }}{% endraw %}</code>
</p>
<p>
<code class="output">foo, bar, or baz</code>
</p>
</td>
</tr>
<tr>
@@ -271,6 +321,18 @@ common tasks easier.
<p>
<code class="output">the-_config.yml-file</code>
</p>
<p>
<code class="filter">{% raw %}{{ "The _cönfig.yml file" | slugify: 'ascii' }}{% endraw %}</code>
</p>
<p>
<code class="output">the-c-nfig-yml-file</code>
</p>
<p>
<code class="filter">{% raw %}{{ "The cönfig.yml file" | slugify: 'latin' }}{% endraw %}</code>
</p>
<p>
<code class="output">the-config-yml-file</code>
</p>
</td>
</tr>
<tr>
@@ -394,61 +456,29 @@ The default is `default`. They are as follows (with what they filter):
- `raw`: spaces
- `default`: spaces and non-alphanumeric characters
- `pretty`: spaces and non-alphanumeric characters except for `._~!$&'()+,;=@`
- `ascii`: spaces, non-alphanumeric, and non-ASCII characters
- `latin`: like `default`, except Latin characters are first transliterated (e.g. `àèïòü` to `aeiou`) {%- include docs_version_badge.html version="3.7.0" -%}
## Tags
* [Includes](#includes)
* [Code snippet highlighting](#code-snippet-highlighting)
* [Linking to pages, collections and posts (the new and improved way)](#links)
* [Linking to posts (the old way)](#linking-to-posts)
### Includes
If you have small page fragments that you wish to include in multiple places on
your site, you can use the `include` tag.
If you have small page snippets that you want to include in multiple places on your site, save the snippets as *include files* and insert them where required, by using the `include` tag:
{% raw %}
```liquid
{% raw %}{% include footer.html %}{% endraw %}
{% include footer.html %}
```
{% endraw %}
Jekyll expects all include files to be placed in an `_includes` directory at the
root of your source directory. This will embed the contents of
`<source>/_includes/footer.html` into the calling file.
Jekyll expects all *include files* to be placed in an `_includes` directory at the root of your source directory. In the above example, this will embed the contents of `_includes/footer.html` into the calling file.
<div class="note">
<h5>ProTip™: Use variables as file name</h5>
<p>
The name of the file you wish to embed can be literal (as in the example above),
or you can use a variable, using liquid-like variable syntax as in
<code>{% raw %}{% include {{my_variable}} %}{% endraw %}</code>.
</p>
</div>
You can also pass parameters to an include. Omit the quotation marks to send a variable's value. Liquid curly brackets should not be used here:
```liquid
{% raw %}{% include footer.html param="value" variable-param=page.variable %}{% endraw %}
```
These parameters are available via Liquid in the include:
```liquid
{% raw %}{{ include.param }}{% endraw %}
```
#### Including files relative to another file
You can also choose to include file fragments relative to the current file:
```liquid
{% raw %}{% 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,
if `_posts/2014-09-03-my-file.markdown` uses the `include_relative` tag, the included file
must be within the `_posts` directory, or one of its subdirectories. You cannot include
files in other locations.
All the other capabilities of the `include` tag are available to the `include_relative` tag,
such as using variables.
For more advanced information on using includes, see [Includes](../includes).
### Code snippet highlighting
@@ -465,15 +495,15 @@ languages](http://pygments.org/languages/)
To render a code block with syntax highlighting, surround your code as follows:
```liquid
{% raw %}
```liquid
{% highlight ruby %}
def foo
puts 'foo'
end
{% endhighlight %}
{% endraw %}
```
{% endraw %}
The argument to the `highlight` tag (`ruby` in the example above) is the
language identifier. To find the appropriate identifier to use for the language
@@ -481,6 +511,13 @@ you want to highlight, look for the “short name” on the [Rouge
wiki](https://github.com/jayferd/rouge/wiki/List-of-supported-languages-and-lexers)
or the [Pygments' Lexers page](http://pygments.org/docs/lexers/).
<div class="note info">
<h5>Jekyll processes all Liquid filters in code blocks</h5>
<p>If you are using a language that contains curly braces, you
will likely need to place <code>{&#37; raw &#37;}</code> and
<code>{&#37; endraw &#37;}</code> tags around your code.</p>
</div>
#### Line numbers
There is a second argument to `highlight` called `linenos` that is optional.
@@ -488,15 +525,15 @@ Including the `linenos` argument will force the highlighted code to include line
numbers. For instance, the following code block would include line numbers next
to each line:
```liquid
{% raw %}
```liquid
{% highlight ruby linenos %}
def foo
puts 'foo'
end
{% endhighlight %}
{% endraw %}
```
{% endraw %}
#### Stylesheets for syntax highlighting
@@ -508,82 +545,71 @@ site. If you use `linenos`, you might want to include an additional CSS class
definition for the `.lineno` class in `syntax.css` to distinguish the line
numbers from the highlighted code.
### Link
If you want to include a link to a collection's document, a post, a page
or a file the `link` tag will generate the correct permalink URL for the path
you specify.
## Links
You must include the file extension when using the `link` tag.
### 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:
```liquid
{% raw %}
```liquid
{{ site.baseurl }}{% link _collection/name-of-document.md %}
{{ site.baseurl }}{% link _posts/2016-07-26-name-of-post.md %}
{{ site.baseurl }}{% link news/index.html %}
{{ site.baseurl }}{% link /assets/files/doc.pdf %}
{% endraw %}
```
{% endraw %}
You can also use this tag to create a link in Markdown as follows:
You can also use the `link` tag to create a link in Markdown as follows:
```liquid
{% raw %}
```liquid
[Link to a document]({{ site.baseurl }}{% link _collection/name-of-document.md %})
[Link to a post]({{ site.baseurl }}{% link _posts/2016-07-26-name-of-post.md %})
[Link to a page]({{ site.baseurl }}{% link news/index.html %})
[Link to a file]({{ site.baseurl }}{% link /assets/files/doc.pdf %})
{% endraw %}
```
{% endraw %}
### Post URL
(Including `{% raw %}{{ site.baseurl }}{% endraw %}` is optional &mdash; it depends on whether you want to preface the page URL with the `baseurl` value.)
If you would like to include a link to a post on your site, the `post_url` tag
will generate the correct permalink URL for the post you specify.
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.
```liquid
{% raw %}
```liquid
{{ site.baseurl }}{% post_url 2010-07-21-name-of-post %}
{% endraw %}
```
{% endraw %}
If you organize your posts in subdirectories, you need to include subdirectory
path to the post:
If you organize your posts in subdirectories, you need to include subdirectory path to the post:
```liquid
{% raw %}
```liquid
{{ site.baseurl }}{% post_url /subdir/2010-07-21-name-of-post %}
{% endraw %}
```
{% endraw %}
There is no need to include the file extension when using the `post_url` tag.
You can also use this tag to create a link to a post in Markdown as follows:
```liquid
{% raw %}
```liquid
[Name of Link]({{ site.baseurl }}{% post_url 2010-07-21-name-of-post %})
{% endraw %}
```
### Gist
Use the `gist` tag to easily embed a GitHub Gist onto your site. This works
with public or secret gists:
```liquid
{% raw %}
{% gist parkr/931c1c8d465a04042403 %}
{% endraw %}
```
You may also optionally specify the filename in the gist to display:
```liquid
{% raw %}
{% gist parkr/931c1c8d465a04042403 jekyll-private-gist.markdown %}
{% endraw %}
```
To use the `gist` tag, you'll need to add the
[jekyll-gist](https://github.com/jekyll/jekyll-gist) gem to your project.

View File

@@ -1,83 +1,275 @@
---
layout: docs
title: Themes
permalink: /docs/themes/
---
Jekyll has an extensive theme system, which allows you to leverage community-maintained templates and styles to customize your site's presentation. Jekyll themes package layouts, includes, and stylesheets in a way that can be overridden by your site's content.
Jekyll has an extensive theme system that allows you to leverage community-maintained templates and styles to customize your site's presentation. Jekyll themes specify plugins and package up assets, layouts, includes, and stylesheets in a way that can be overridden by your site's content.
## Installing a theme
## Understanding gem-based themes
1. To install a theme, first, add the theme to your site's `Gemfile`:
When you [create a new Jekyll site](/docs/quickstart) (by running the `jekyll new <PATH>` command), Jekyll installs a site that uses a gem-based theme called [Minima](https://github.com/jekyll/minima).
gem 'my-awesome-jekyll-theme'
With gem-based themes, some of the site's directories (such as the `assets`, `_layouts`, `_includes`, and `_sass` directories) are stored in the theme's gem, hidden from your immediate view. Yet all of the necessary directories will be read and processed during Jekyll's build process.
2. Save the changes to your `Gemfile`
3. Run the command `bundle install` to install the theme
4. Finally, activate the theme by adding the following to your site's `_config.yml`:
In the case of Minima, you see only the following files in your Jekyll site directory:
theme: my-awesome-jekyll-theme
```
├── Gemfile
├── Gemfile.lock
├── _config.yml
├── _posts
│ └── 2016-12-04-welcome-to-jekyll.markdown
├── about.md
└── index.md
```
You can have multiple themes listed in your site's Gemfile, but only one theme can be selected in your site's `_config.yml`.
{: .note .info }
The `Gemfile` and `Gemfile.lock` files are used by Bundler to keep track of the required gems and gem versions you need to build your Jekyll site.
Gem-based themes make it easy for theme developers to make updates available to anyone who has the theme gem. When there's an update, theme developers push the update to RubyGems.
If you have the theme gem, you can (if you desire) run `bundle update` to update all gems in your project. Or you can run `bundle update <THEME>`, replacing `<THEME>` with the theme name, such as `minima`, to just update the theme gem. Any new files or updates the theme developer has made (such as to stylesheets or includes) will be pulled into your project automatically.
The goal of gem-based themes is to allow you to get all the benefits of a robust, continually updated theme without having all the theme's files getting in your way and over-complicating what might be your primary focus: creating content.
## Overriding theme defaults
Jekyll themes set default layouts, includes, and stylesheets, that can be overridden by your site's content. For example, if your selected theme has a `page` layout, you can override the theme's layout by creating your own `page` layout in the `_layouts` folder (e.g., `_layouts/page.html`).
Jekyll themes set default layouts, includes, and stylesheets. However, you can override any of the theme defaults with your own site content.
Jekyll will look first to your site's content, before looking to the theme's defaults, for any requested file in the following folders:
To replace layouts or includes in your theme, make a copy in your `_layouts` or `_includes` directory of the specific file you wish to modify, or create the file from scratch giving it the same name as the file you wish to override.
* `/assets`
* `/_layouts`
* `/_includes`
* `/_sass`
For example, if your selected theme has a `page` layout, you can override the theme's layout by creating your own `page` layout in the `_layouts` directory (that is, `_layouts/page.html`).
To locate a theme's files on your computer:
1. Run `bundle show` followed by the name of the theme's gem, e.g., `bundle show minima` for Jekyll's default theme.
This returns the location of the gem-based theme files. For example, the Minima theme's files might be located in `/usr/local/lib/ruby/gems/2.3.0/gems/minima-2.1.0` on macOS.
2. Open the theme's directory in Finder or Explorer:
```sh
# On MacOS
open $(bundle show minima)
# On Windows
explorer /usr/local/lib/ruby/gems/2.3.0/gems/minima-2.1.0
```
A Finder or Explorer window opens showing the theme's files and directories. The Minima theme gem contains these files:
```
├── LICENSE.txt
├── README.md
├── _includes
│   ├── disqus_comments.html
│   ├── footer.html
│   ├── google-analytics.html
│   ├── head.html
│   ├── header.html
│   ├── icon-github.html
│   ├── icon-github.svg
│   ├── icon-twitter.html
│   └── icon-twitter.svg
├── _layouts
│   ├── default.html
│   ├── home.html
│   ├── page.html
│   └── post.html
├── _sass
│   ├── minima
│   │   ├── _base.scss
│   │   ├── _layout.scss
│   │   └── _syntax-highlighting.scss
│   └── minima.scss
└── assets
└── main.scss
```
With a clear understanding of the theme's files, you can now override any theme file by creating a similarly named file in your Jekyll site directory.
Let's say, for a second example, you want to override Minima's footer. In your Jekyll site, create an `_includes` folder and add a file in it called `footer.html`. Jekyll will now use your site's `footer.html` file instead of the `footer.html` file from the Minima theme gem.
To modify any stylesheet you must take the extra step of also copying the main sass file (`_sass/minima.scss` in the Minima theme) into the `_sass` directory in your site's source.
Jekyll will look first to your site's content before looking to the theme's defaults for any requested file in the following folders:
- `/assets`
- `/_layouts`
- `/_includes`
- `/_sass`
Note that making copies of theme files will prevent you from receiving any theme updates on those files. An alternative, to continue getting theme updates on all stylesheets, is to use higher specificity CSS selectors in your own additional, originally named CSS files.
Refer to your selected theme's documentation and source repository for more information on what files you can override.
{: .note .info}
To locate theme's files on your computer, run `bundle show` followed by
the name of the theme's gem, e.g. `bundle show minima` for default Jekyll's
theme. Then copy the files you want to override, from the returned path to your root folder.
## Converting gem-based themes to regular themes
## Creating a theme
Suppose you want to get rid of the gem-based theme and convert it to a regular theme, where all files are present in your Jekyll site directory, with nothing stored in the theme gem.
Jekyll themes are distributed as Ruby gems. Don't worry, Jekyll will help you scaffold a new theme with the `new-theme` command. Just run `jekyll new-theme` with the theme name as an argument:
To do this, copy the files from the theme gem's directory into your Jekyll site directory. (For example, copy them to `/myblog` if you created your Jekyll site at `/myblog`. See the previous section for details.)
```sh
jekyll new-theme my-awesome-theme
create /path/to/my-awesome-theme/_layouts
create /path/to/my-awesome-theme/_includes
create /path/to/my-awesome-theme/_sass
create /path/to/my-awesome-theme/_layouts/page.html
create /path/to/my-awesome-theme/_layouts/post.html
create /path/to/my-awesome-theme/_layouts/default.html
create /path/to/my-awesome-theme/Gemfile
create /path/to/my-awesome-theme/my-awesome-theme.gemspec
create /path/to/my-awesome-theme/README.md
create /path/to/my-awesome-theme/LICENSE.txt
initialize /path/to/my-awesome-theme/.git
create /path/to/my-awesome-theme/.gitignore
Your new Jekyll theme, my-awesome-theme, is ready for you in /path/to/my-awesome-theme!
For help getting started, read /path/to/my-awesome-theme/README.md.
Then you must tell Jekyll about the plugins that were referenced by the theme. You can find these plugins in the theme's gemspec file as runtime dependencies. If you were converting the Minima theme, for example, you might see:
```
spec.add_runtime_dependency "jekyll-feed", "~> 0.9"
spec.add_runtime_dependency "jekyll-seo-tag", "~> 2.1"
```
Add your template files in the corresponding folders, complete the `.gemspec` and the README files according to your needs.
You should include these references in the `Gemfile` in one of two ways.
You could list them individually in both `Gemfile` and `_config.yml`.
```ruby
# ./Gemfile
gem "jekyll-feed", "~> 0.9"
gem "jekyll-seo-tag", "~> 2.1"
```
```yaml
# ./_config.yml
plugins:
- jekyll-feed
- jekyll-seo-tag
```
Or you could list them explicitly as Jekyll plugins in your Gemfile, and not update `_config.yml`, like this:
```ruby
# ./Gemfile
group :jekyll_plugins do
gem "jekyll-feed", "~> 0.9"
gem "jekyll-seo-tag", "~> 2.1"
end
```
Either way, don't forget to `bundle update`.
However, if you're publishing on GitHub Pages you should update only your `_config.yml` as GitHub Pages doesn't load plugins via Bundler.
Finally, remove references to the theme gem in `Gemfile` and configuration. For example, to remove `minima`:
- Open `Gemfile` and remove `gem "minima", "~> 2.0"`.
- Open `_config.yml` and remove `theme: minima`.
Now `bundle update` will no longer get updates for the theme gem.
## Installing a gem-based theme {#installing-a-theme}
The `jekyll new <PATH>` command isn't the only way to create a new Jekyll site with a gem-based theme. You can also find gem-based themes online and incorporate them into your Jekyll project.
For example, search for [jekyll theme on RubyGems](https://rubygems.org/search?utf8=%E2%9C%93&query=jekyll-theme) to find other gem-based themes. (Note that not all themes are using `jekyll-theme` as a convention in the theme name.)
To install a gem-based theme:
1. Add the theme to your site's `Gemfile`:
```ruby
# ./Gemfile
gem "jekyll-theme-awesome"
```
Or if you've started with the `jekyll new` command, replace `gem "minima", "~> 2.0"` with your theme-gem:
```diff
# ./Gemfile
- gem "minima", "~> 2.0"
+ gem "jekyll-theme-awesome"
```
2. Install the theme:
```sh
bundle install
```
3. Add the following to your site's `_config.yml` to activate the theme:
```yaml
theme: jekyll-theme-awesome
```
4. Build your site:
```sh
bundle exec jekyll serve
```
You can have multiple themes listed in your site's `Gemfile`, but only one theme can be selected in your site's `_config.yml`.
{: .note .info }
If you're publishing your Jekyll site on [GitHub Pages](https://pages.github.com/), note that GitHub Pages supports only some gem-based themes. See [Supported Themes](https://pages.github.com/themes/) in GitHub's documentation to see which themes are supported.
## Creating a gem-based theme
If you're a Jekyll theme developer (rather than just a consumer of themes), you can package up your theme in RubyGems and allow users to install it through Bundler.
If you're unfamiliar with creating Ruby gems, don't worry. Jekyll will help you scaffold a new theme with the `new-theme` command. Run `jekyll new-theme` with the theme name as an argument.
Here is an example:
```sh
jekyll new-theme jekyll-theme-awesome
create /path/to/jekyll-theme-awesome/_layouts
create /path/to/jekyll-theme-awesome/_includes
create /path/to/jekyll-theme-awesome/_sass
create /path/to/jekyll-theme-awesome/_layouts/page.html
create /path/to/jekyll-theme-awesome/_layouts/post.html
create /path/to/jekyll-theme-awesome/_layouts/default.html
create /path/to/jekyll-theme-awesome/Gemfile
create /path/to/jekyll-theme-awesome/jekyll-theme-awesome.gemspec
create /path/to/jekyll-theme-awesome/README.md
create /path/to/jekyll-theme-awesome/LICENSE.txt
initialize /path/to/jekyll-theme-awesome/.git
create /path/to/jekyll-theme-awesome/.gitignore
Your new Jekyll theme, jekyll-theme-awesome, is ready for you in /path/to/jekyll-theme-awesome!
For help getting started, read /path/to/jekyll-theme-awesome/README.md.
```
Add your template files in the corresponding folders. Then complete the `.gemspec` and the README files according to your needs.
### Layouts and includes
Theme layouts and includes work just like they work in any Jekyll site. Place layouts in your theme's `/_layouts` folder, and place includes in your themes `/_includes` folder.
For example, if your theme has a `/_layouts/page.html` file, and a page has `layout: page` in its YAML front matter, Jekyll will first look to the site's `_layouts` folder for a the `page` layout, and if none exists, will use your theme's `page` layout.
For example, if your theme has a `/_layouts/page.html` file, and a page has `layout: page` in its YAML front matter, Jekyll will first look to the site's `_layouts` folder for the `page` layout, and if none exists, will use your theme's `page` layout.
### Assets
Any file in `/assets` will be copied over to the user's site upon build unless they have a file with the same relative path. You may ship any kind of asset here: SCSS, an image, a webfont, etc. These files behave just like pages and static files in Jekyll: if the file has [YAML front matter]({{ site.baseurl }}/docs/frontmatter/) at the top, then it will be rendered. If it does not have YAML front matter, it will simply be copied over into the resulting site. This allows theme creators to ship a default `/assets/styles.scss` file which their layouts can depend on as `/assets/styles.css`.
Any file in `/assets` will be copied over to the user's site upon build unless they have a file with the same relative path. You can ship any kind of asset here: SCSS, an image, a webfont, etc. These files behave like pages and static files in Jekyll:
- If the file has [YAML front matter](/docs/frontmatter/) at the top, it will be rendered.
- If the file does not have YAML front matter, it will simply be copied over into the resulting site.
This allows theme creators to ship a default `/assets/styles.scss` file which their layouts can depend on as `/assets/styles.css`.
All files in `/assets` will be output into the compiled site in the `/assets` folder just as you'd expect from using Jekyll on your sites.
### Stylesheets
Your theme's stylesheets should be placed in your theme's `/_sass` folder, again, just as you would when authoring a Jekyll site. Your theme's styles can be included in the user's stylesheet using the `@import` directive.
Your theme's stylesheets should be placed in your theme's `_sass` folder, again, just as you would when authoring a Jekyll site.
```
_sass
├── jekyll-theme-awesome.scss
```
Your theme's styles can be included in the user's stylesheet using the `@import` directive.
{% raw %}
```css
@import "{{ site.theme }}";
```
{% endraw %}
### Theme-gem dependencies {%- include docs_version_badge.html version="3.5.0" -%}
Jekyll will automatically require all whitelisted `runtime_dependencies` of your theme-gem even if they're not explicitly included under the `plugins` array in the site's config file. (Note: whitelisting is only required when building or serving with the `--safe` option.)
With this, the end-user need not keep track of the plugins required to be included in their config file for their theme-gem to work as intended.
### Documenting your theme
@@ -85,7 +277,7 @@ Your theme should include a `/README.md` file, which explains how site authors c
### Adding a screenshot
Themes are visual. Show users what your theme looks like by including a screenshot as `/screenshot.png` within your theme's repository where it can be retrieved programatically. You can also include this screenshot within your theme's documentation.
Themes are visual. Show users what your theme looks like by including a screenshot as `/screenshot.png` within your theme's repository where it can be retrieved programmatically. You can also include this screenshot within your theme's documentation.
### Previewing your theme
@@ -96,15 +288,26 @@ If you do preview your theme locally, be sure to add `/_site` to your theme's `.
### Publishing your theme
Themes are published via [RubyGems.org](https://rubygems.org). You'll need a RubyGems account, which you can [create for free](https://rubygems.org/sign_up).
Themes are published via [RubyGems.org](https://rubygems.org). You will need a RubyGems account, which you can [create for free](https://rubygems.org/sign_up).
1. First, package your theme, by running the following command, replacing `my-awesome-jekyll-theme` with the name of your theme:
1. First, you need to have it in a git repository:
gem build my-awesome-jekyll-theme.gemspec
```sh
git init # Only the first time
git add -A
git commit -m "Init commit"
```
2. Next, push your packaged theme up to the RubyGems service, by running the following command, again replacing `my-awesome-jekyll-theme` with the name of your theme:
2. Next, package your theme, by running the following command, replacing `jekyll-theme-awesome` with the name of your theme:
gem push my-awesome-jekyll-theme-*.gem
```sh
gem build jekyll-theme-awesome.gemspec
```
3. To release a new version of your theme, simply update the version number in the gemspec file, ( `my-awesome-jekyll-theme.gemspec` in this example ), and then repeat Steps 1 & 2 above.
We recommend that you follow [Semantic Versioning](http://semver.org/) while bumping your theme-version.
3. Finally, push your packaged theme up to the RubyGems service, by running the following command, again replacing `jekyll-theme-awesome` with the name of your theme:
```sh
gem push jekyll-theme-awesome-*.gem
```
4. To release a new version of your theme, update the version number in the gemspec file, ( `jekyll-theme-awesome.gemspec` in this example ), and then repeat Steps 1 - 3 above. We recommend that you follow [Semantic Versioning](http://semver.org/) while bumping your theme-version.

View File

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

View File

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

View File

@@ -1,5 +1,4 @@
---
layout: docs
title: Upgrading from 0.x to 2.x
permalink: /docs/upgrading/0-to-2/
---
@@ -10,7 +9,7 @@ and 2.0 that you'll want to know about.
Before we dive in, go ahead and fetch the latest version of Jekyll:
```sh
$ gem update jekyll
gem update jekyll
```
<div class="note feature">

View File

@@ -1,23 +1,23 @@
---
layout: docs
title: Upgrading from 2.x to 3.x
permalink: /docs/upgrading/2-to-3/
---
Upgrading from an older version of Jekyll? A few things have changed in 3.0
Upgrading from an older version of Jekyll? A few things have changed in Jekyll 3
that you'll want to know about.
Before we dive in, go ahead and fetch the latest version of Jekyll:
```sh
$ gem update jekyll
gem update jekyll
```
Please note: Jekyll 3 requires Ruby version >= 2.0.0.
Since v3.2 Jekyll requires Ruby version >= 2.1
{: .note .warning }
<div class="note feature">
<h5 markdown="1">Diving in</h5>
<p markdown="1">Want to get a new Jekyll site up and running quickly? Simply
<h5>Diving in</h5>
<p>Want to get a new Jekyll site up and running quickly? Simply
run <code>jekyll new SITENAME</code> to create a new folder with a bare bones
Jekyll site.</p>
</div>
@@ -69,7 +69,7 @@ generate when running `jekyll build` or `jekyll serve`.
<h5>Future Posts on GitHub Pages</h5>
<p>
An exception to the above rule are GitHub Pages sites, where the <code>--future</code> flag remains <em>enabled</em>
by default to maintain historical consistency for those sites.
by default to maintain historical consistency for those sites.
</p>
</div>
@@ -100,7 +100,7 @@ error when trying to **serve** or **build**:
```text
Since v3.0, permalinks for pages in subfolders must be relative to the site
source directory, not the parent directory. Check
http://jekyllrb.com/docs/upgrading/ for more info.
https://jekyllrb.com/docs/upgrading/ for more info.
```
This can be fixed by removing the following line from your `_config.yml` file:

View File

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

View File

@@ -1,5 +1,4 @@
---
layout: docs
title: Variables
permalink: /docs/variables/
---
@@ -186,17 +185,32 @@ following is a reference of the available data.
</p></td>
</tr>
<tr>
<td><p><code>site.url</code></p></td>
<td><p>
Contains the url of your site as it is configured in the <code>_config.yml</code>.
For example, if you have <code>url: http://mysite.com</code>
in your configuration file, then it will be accessible in Liquid as
<code>site.url</code>. For the development environment there is
<a href="/news/#3-siteurl-is-set-by-the-development-server">an exception</a>,
if you are running <code>jekyll serve</code> in a development environment
<code>site.url</code> will be set to the value of <code>host</code>,
<code>port</code>, and SSL-related options. This defaults to
<code>url: http://localhost:4000</code>.
</p></td>
</tr>
<tr>
<td><p><code>site.[CONFIGURATION_DATA]</code></p></td>
<td><p>
All the variables set via the command line and your
<code>_config.yml</code> are available through the <code>site</code>
variable. For example, if you have <code>url: http://mysite.com</code>
in your configuration file, then in your Posts and Pages it will be
stored in <code>site.url</code>. Jekyll does not parse changes to
<code>_config.yml</code> in <code>watch</code> mode, you must restart
Jekyll to see changes to variables.
variable. For example, if you have <code>foo: bar</code>
in your configuration file, then it will be accessible in Liquid as <code>site.foo</code>.
Jekyll does not parse changes to <code>_config.yml</code> in
<code>watch</code> mode, you must restart Jekyll to see changes to variables.
</p></td>
</tr>
@@ -236,7 +250,7 @@ following is a reference of the available data.
<td><p><code>page.excerpt</code></p></td>
<td><p>
The un-rendered excerpt of the Page.
The un-rendered excerpt of a document.
</p></td>
</tr>
@@ -266,8 +280,9 @@ following is a reference of the available data.
<td><p><code>page.id</code></p></td>
<td><p>
An identifier unique to the Post (useful in RSS feeds). e.g.
An identifier unique to a document in a Collection or a Post (useful in RSS feeds). e.g.
<code>/2008/12/14/my-post</code>
<code>/my-collection/my-document</code>
</p></td>
</tr>
@@ -339,7 +354,7 @@ following is a reference of the available data.
If you specify front matter in a layout, access that via <code>layout</code>.
For example, if you specify <code>class: full_page</code>
in a pages front matter, that value will be available as
in a layouts front matter, that value will be available as
<code>layout.class</code> in the layout and its parents.
</p>

View File

@@ -1,59 +1,107 @@
---
layout: docs
title: Jekyll on Windows
permalink: /docs/windows/
---
While Windows is not an officially-supported platform, it can be used to run
Jekyll with the proper tweaks. This page aims to collect some of the general
knowledge and lessons that have been unearthed by Windows users.
While Windows is not an officially-supported platform, it can be used to run Jekyll with the proper tweaks. This page aims to collect some of the general knowledge and lessons that have been unearthed by Windows users.
## Installation
A quick way to install Jekyll is to follow the [installation instructions by David Burela](https://davidburela.wordpress.com/2015/11/28/easily-install-jekyll-on-windows-with-3-command-prompt-entries-and-chocolatey/):
## Installing Jekyll
1. Install a package manager for Windows called [Chocolatey](https://chocolatey.org/install)
If you are using Windows 10 Anniversary Update, the easiest way to run Jekyll is by [installing][WSL-Guide] the new Bash on Ubuntu on Windows.
### Installation via Bash on Windows 10
*Note:* You must have [Bash on Ubuntu on Windows][BASH-WSL] enabled.
First let's make sure all our packages / repositories are up to date. Open a new Command Prompt instance, and type the following:
```sh
bash
```
Your Command Prompt instance should now be a Bash instance. Now we must update our repo lists and packages.
```sh
sudo apt-get update -y && sudo apt-get upgrade -y
```
Now we can install Ruby. To do this we will use a repository from [BrightBox](https://www.brightbox.com/docs/ruby/ubuntu/), which hosts optimized versions of Ruby for Ubuntu.
```sh
sudo apt-add-repository ppa:brightbox/ruby-ng
sudo apt-get update
sudo apt-get install ruby2.3 ruby2.3-dev build-essential dh-autoreconf
```
Next let's update our Ruby gems:
```sh
sudo gem update
```
Now all that is left to do is install Jekyll.
```sh
sudo gem install jekyll bundler
```
Check if Jekyll installed properly by running:
```sh
jekyll -v
```
**And that's it!**
To start a new project named `my_blog`, just run:
```sh
jekyll new my_blog
```
You can make sure time management is working properly by inspecting your `_posts` folder. You should see a markdown file with the current date in the filename.
<div class="note info">
<h5>Non-superuser account issues</h5>
<p>If the `jekyll new` command prints the error "Your user account isn't allowed to install to the system RubyGems", see the "Running Jekyll as Non-Superuser" instructions in <a href="/docs/troubleshooting/#no-sudo">Troubleshooting</a>.</p>
</div>
**Note:** Bash on Ubuntu on Windows is still under development, so you may run into issues.
[WSL-Guide]: https://msdn.microsoft.com/en-us/commandline/wsl/install_guide
[BASH-WSL]: https://msdn.microsoft.com/en-us/commandline/wsl/about
### Installation via RubyInstaller
[RubyInstaller][] is a self-contained Windows-based installer that includes the Ruby language, an execution environment, important documentation, and more.
1. Download and Install a package manager version from [RubyInstaller Downloads][RubyInstaller-downloads].
2. Install Jekyll and Bundler via a command prompt window: `gem install jekyll bundler`
3. Check if Jekyll installed properly: `jekyll -v`
[RubyInstaller]: https://rubyinstaller.org/
[RubyInstaller-downloads]: https://rubyinstaller.org/downloads/
### Installation via Chocolatey
A quick way to install Jekyll using Chocolatey is to follow the [installation instructions by David Burela](https://davidburela.wordpress.com/2015/11/28/easily-install-jekyll-on-windows-with-3-command-prompt-entries-and-chocolatey/):
1. Install a package manager for Windows called [Chocolatey][]
2. Install Ruby via Chocolatey: `choco install ruby -y`
3. Reopen a command prompt and install Jekyll: `gem install jekyll`
For a more conventional way of installing Jekyll you can follow the [installation instructions by Sverrir Sigmundarson][windows-installjekyll3]. These instructions are for newer versions of Ruby 2.2.5 and Jekyll 3.
Updates in the infrastructure of Ruby may cause SSL errors when attempting to use `gem install` with versions of the RubyGems package older than 2.6. (The RubyGems package installed via the Chocolatey tool is version 2.3) If you have installed an older version, you can update the RubyGems package using the directions [here][ssl-certificate-update].
For instructions for older versions of Ruby 2.0.0 ([prior to 2.2][hitimes-issue]) and Jekyll 2 and older you should follow the [installation instruction by Julian Thilo][windows-installation].
[ssl-certificate-update]: http://guides.rubygems.org/ssl-certificate-update/#installing-using-update-packages
## Encoding
If you use UTF-8 encoding, make sure that no `BOM` header
characters exist in your files or very, very bad things will happen to
Jekyll. This is especially relevant if you're running Jekyll on Windows.
Additionally, you might need to change the code page of the console window to UTF-8
in case you get a "Liquid Exception: Incompatible character encoding" error during
the site generation process. It can be done with the following command:
```sh
$ chcp 65001
```
[windows-installation]: http://jekyll-windows.juthilo.com/
[windows-installjekyll3]: https://labs.sverrirs.com/jekyll/
[hitimes-issue]: https://github.com/copiousfreetime/hitimes/issues/40
## Auto-regeneration
As of v1.3.0, Jekyll uses the `listen` gem to watch for changes when the
`--watch` switch is specified during a build or serve. While `listen` has
built-in support for UNIX systems, it requires an extra gem for compatibility
with Windows. Add the following to the Gemfile for your site:
```ruby
gem 'wdm', '~> 0.1.0' if Gem.win_platform?
```
### How to install github-pages
### Installing *github-pages* via Chocolatey
This section is part of an article written by [Jens Willmer][jwillmerPost]. To follow the instructions you need to have [Chocolatey][] installed on your system. If you already have a version of Ruby installed you need to uninstall it before you can continue.
#### Install Ruby and Ruby development kit
Open a command prompt and execute the following commands:
@@ -61,6 +109,7 @@ Open a command prompt and execute the following commands:
* `choco install ruby -version 2.2.4`
* `choco install ruby2.devkit` - _needed for compilation of json gem_
#### Configure Ruby development kit
The development kit did not set the environment path for Ruby so we need to do it.
@@ -70,22 +119,21 @@ The development kit did not set the environment path for Ruby so we need to do i
* Edit the `config.yml` file and include the path to Ruby `- C:/tools/ruby22`
* Execute the following command to set the path: `ruby dk.rb install`
#### Nokogiri gem installation
This gem is also needed in the github-pages and to get it running on Windows x64 we have to install a few things.
**Note:** In the current [pre release][nokogiriFails] it works out of the box with Windows x64 but this version is not referenced in the github-pages.
```sh
choco install libxml2 -Source "https://www.nuget.org/api/v2/"
`choco install libxml2 -Source "https://www.nuget.org/api/v2/"`{:.language-ruby}
choco install libxslt -Source "https://www.nuget.org/api/v2/"
`choco install libxslt -Source "https://www.nuget.org/api/v2/"`{:.language-ruby}
choco install libiconv -Source "https://www.nuget.org/api/v2/
`choco install libiconv -Source "https://www.nuget.org/api/v2/"`{:.language-ruby}
```ruby
gem install nokogiri --^
gem install nokogiri --^
--with-xml2-include=C:\Chocolatey\lib\libxml2.2.7.8.7\build\native\include^
--with-xml2-lib=C:\Chocolatey\lib\libxml2.redist.2.7.8.7\build\native\bin\v110\x64\Release\dynamic\cdecl^
--with-iconv-include=C:\Chocolatey\lib\libiconv.1.14.0.11\build\native\include^
@@ -96,27 +144,75 @@ This gem is also needed in the github-pages and to get it running on Windows x64
#### Install github-pages
* Open command prompt and install [Bundler][]: `gem install bundler`
* Create a file called `Gemfile` without any extension in your root directory of your blog
* Copy & paste the two lines into the file:
* Open command prompt and install [Bundler][]: `gem install bundler`
* Create a file called `Gemfile` without any extension in your root directory of your blog
* Copy & paste the two lines into the file:
```ruby
source 'http://rubygems.org'
gem 'github-pages'
source 'https://rubygems.org'
gem 'github-pages', group: :jekyll_plugins
```
* **Note:** We use an unsecure connection because SSL throws exceptions in the version of Ruby
* Open a command prompt, target your local blog repository root, and install github-pages: `bundle install`
After this process you should have github-pages installed on your system and you can host your blog again with `jekyll s`. \\
After this process you should have github-pages installed on your system and you can host your blog again with `jekyll s`.
There will be a warning on startup that you should include `gem 'wdm', '>= 0.1.0' if Gem.win_platform?` to your `Gemfile` but I could not get `jekyll s` working if I include that line so for the moment I ignore that warning.
In the future the installation process of the github-pages should be as simple as the setup of the blog. But as long as the new version of the Nokogiri ([v1.6.8][nokogiriReleases]) is not stable and referenced, it is work to get it up and running on Windows.
[jwillmerPost]: http://jwillmer.de/blog/tutorial/how-to-install-jekyll-and-pages-gem-on-windows-10-x46 "Installation instructions by Jens Willmer"
[jwillmerPost]: https://jwillmer.de/blog/tutorial/how-to-install-jekyll-and-pages-gem-on-windows-10-x46 "Installation instructions by Jens Willmer"
[Chocolatey]: https://chocolatey.org/install "Package manager for Windows"
[nokogiriFails]: https://github.com/sparklemotion/nokogiri/issues/1456#issuecomment-206481794 "Nokogiri fails to install on Ruby 2.3 for Windows"
[Bundler]: http://bundler.io/ "Ruby Dependencie Manager"
[nokogiriReleases]: https://github.com/sparklemotion/nokogiri/releases "Nokogiri Releases"
[nokogiriFails]: https://github.com/sparklemotion/nokogiri/issues/1456#issuecomment-206481794 "Nokogiri fails to install on Ruby 2.3 for Windows"
For a more conventional way of installing Jekyll you can follow this [complete guide to install Jekyll 3 on Windows by Sverrir Sigmundarson][windows-installjekyll3].
Optionally you can use [Autoinstall Jekyll for Windows][fastjekyll-autoinstall].
[windows-installjekyll3]: https://labs.sverrirs.com/jekyll/
[fastjekyll-autoinstall]: https://github.com/KeJunMao/fastjekyll#autoinstall-jekyll-for-windows
## Encoding
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][IANA-database].
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]
```
[IANA-database]: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
## 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 may first have to download and install the [Ruby DevKit](https://rubyinstaller.org/downloads/) by following [the instructions here](https://github.com/oneclick/rubyinstaller/wiki/Development-Kit).

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@@ -0,0 +1,39 @@
{% comment %}
Map grabs the tutorials sections, giving us an array of arrays. Join, flattens all
the items to a comma delimited string. Split turns it into an array again.
{% endcomment %}
{% assign tutorials = site.data.tutorials | map: 'tutorials' | join: ',' | split: ',' %}
{% comment %}
Because this is built for every page, lets find where we are in the ordered
document list by comparing url strings. Then if there's something previous or
next, lets build a link to it.
{% endcomment %}
{% for tutorial in tutorials %}
{% assign tutorial_url = tutorial | prepend:"/tutorials/" | append:"/" %}
{% if tutorial_url == page.url %}
<div class="section-nav">
<div class="left align-right">
{% if forloop.first %}
<span class="prev disabled">Back</span>
{% else %}
{% assign previous = forloop.index0 | minus: 1 %}
{% assign previous_page = tutorials[previous] | prepend:"/tutorials/" | append:"/" %}
<a href="{{ previous_page }}" class="prev">Back</a>
{% endif %}
</div>
<div class="right align-left">
{% if forloop.last %}
<span class="next disabled">Next</span>
{% else %}
{% assign next = forloop.index0 | plus: 1 %}
{% assign next_page = tutorials[next] | prepend:"/tutorials/" | append:"/" %}
<a href="{{ next_page }}" class="next">Next</a>
{% endif %}
</div>
</div>
<div class="clear"></div>
{% break %}
{% endif %}
{% endfor %}

View File

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

View File

@@ -0,0 +1,10 @@
<div class="unit one-fifth hide-on-mobiles">
<aside>
{% for section in site.data.tutorials %}
<h4>{{ section.title }}</h4>
{% include tutorials_ul.html items=section.tutorials %}
{% endfor %}
</aside>
</div>

View File

@@ -0,0 +1,10 @@
<div class="docs-nav-mobile unit whole show-on-mobiles">
<select onchange="if (this.value) window.location.href=this.value">
<option value="">Navigate the tutorials…</option>
{% for section in site.data.tutorials %}
<optgroup label="{{ section.title }}">
{% include tutorials_option.html items=section.tutorials %}
</optgroup>
{% endfor %}
</select>
</div>

View File

@@ -0,0 +1,5 @@
{% for item in include.items %}
{% assign item_url = item | prepend:"/tutorials/" | append:"/" %}
{% assign tutorial = site.tutorials | where: "url", item_url | first %}
<option value="{{ tutorial.url }}">{{ tutorial.title }}</option>
{% endfor %}

View File

@@ -0,0 +1,7 @@
<ul>
{% for item in include.items %}
{% assign item_url = item | prepend:"/tutorials/" | append:"/" %}
{% assign p = site.tutorials | where:"url", item_url | first %}
<li class="{% if item_url == page.url %}current{% endif %}"><a href="{{ p.url }}">{{ p.title }}</a></li>
{% endfor %}
</ul>

View File

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

View File

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

View File

@@ -0,0 +1,27 @@
---
layout: default
---
<section class="docs">
<div class="grid">
{% include tutorials_contents_mobile.html %}
<div class="unit four-fifths">
<article>
<div class="improve right hide-on-mobiles">
<a href="https://github.com/jekyll/jekyll/edit/master/docs/{{ page.path }}"><i
class="fa fa-pencil"></i> &nbsp;Improve this page</a>
</div>
<h1>{{ page.title }}</h1>
{{ content }}
{% include section_nav_tutorials.html %}
</article>
</div>
{% include tutorials_contents.html %}
<div class="clear"></div>
</div>
</section>

View File

@@ -1,5 +1,4 @@
---
layout: news_item
title: "Jekyll 1.0.0 Released"
date: "2013-05-06 02:12:52 +0200"
author: parkr
@@ -10,7 +9,7 @@ categories: [release]
Hey! After many months of hard work by Jekyll's contributors, we're excited
to announce the first major release of the project in a long while. v1.0.0 is
finally here! While the list of improvements and bug fixes is [quite lengthy][history],
here are the highlights (thanks to [@benbalter](http://twitter.com/BenBalter) for the
here are the highlights (thanks to [@benbalter](https://twitter.com/BenBalter) for the
examples and for compiling this list):
- Support for the Gist tag for easily embedding Gists ([example](https://gist.github.com/benbalter/5555251))

View File

@@ -1,5 +1,4 @@
---
layout: news_item
title: "Jekyll 1.0.1 Released"
date: "2013-05-08 23:46:11 +0200"
author: parkr

View File

@@ -1,5 +1,4 @@
---
layout: news_item
title: "Jekyll 1.0.2 Released"
date: "2013-05-12 14:45:00 +0200"
author: parkr

View File

@@ -1,5 +1,4 @@
---
layout: news_item
title: "Jekyll 1.0.3 Released"
date: "2013-06-07 21:02:13 +0200"
author: parkr

View File

@@ -1,5 +1,4 @@
---
layout: news_item
title: "Jekyll 1.1.0 Released"
date: "2013-07-14 19:38:02 +0200"
author: parkr

View File

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

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