Compare commits

...

504 Commits

Author SHA1 Message Date
Parker Moore
e0d49e2c01 Release 💎 3.4.5 2017-06-30 22:14:44 -04:00
Ben Balter
001ad63a60 Always normalize the result of the relative_url filter (3.4.x backport) (#6186)
* always normalize the result of the relative_url filter

* add test
2017-06-30 22:13:09 -04:00
Parker Moore
c8ad29e459 Release 💎 3.4.4 2017-06-17 21:43:12 -04:00
Parker Moore
981f4175fe Bump to v3.4.4 2017-06-17 21:43:06 -04:00
Parker Moore
d7e70c4751 Backport #6137 for v3.4.x: Default baseurl to nil. 2017-06-17 21:43:06 -04:00
Parker Moore
628d62b4c6 Backport baseurl-set-to-nil from #6137 to 3.4-stable [merge conflicts] (#6146) 2017-06-17 21:41:14 -04:00
Pat Hawks
610d461346 Release 💎 3.4.3 2017-03-21 08:38:37 -05:00
Pat Hawks
93a6ee6b7d Merge pull request #5968 from jekyll/pull/3.4-escape_colon
Backport #5957 to 3.4.x
2017-03-21 08:13:17 -05:00
Parker Moore
bc1f5bb6e9 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-03-21 08:09:12 -05:00
Pat Hawks
dc377aeaed Rename test for clarity 2017-03-20 21:07:15 -05:00
Pat Hawks
35eb9dfd09 Allow colons in uri_escape filter
Fixes #5954
2017-03-20 21:07:14 -05:00
Parker Moore
e159fb4b80 Release 💎 3.4.2 2017-03-09 15:36:56 -05:00
Parker Moore
48f604fabd Release 💎 3.4.2 2017-03-09 15:36:10 -05:00
Parker Moore
fce731ea45 Merge pull request #5940 from jekyll/3.4-stable-backport-5871
Backport #5871 for v3.4.x: Convert StaticFile liquid representation to a Drop & add front matter defaults support to StaticFiles
2017-03-09 15:33:25 -05:00
jekyllbot
b8cecdfd0e Backport static-file-drop from #5871 to 3.4-stable 2017-03-08 10:42:12 -05:00
Parker Moore
313ad449cd Release 💎 3.4.1 2017-03-02 12:48:31 -05:00
Parker Moore
f4a1d9ce6a rake/release: allow releases from *-stable branches. 2017-03-02 12:47:46 -05:00
Parker Moore
1f931b3e30 Merge pull request #5924 from jekyll/3.4-stable-backport-5920
Backport #5920 for v3.4.x: Allow abbreviated post dates
2017-03-02 12:41:52 -05:00
Parker Moore
06a14739db This might allow regexp, actually. Build *all* backport branches too. 2017-03-02 12:41:19 -05:00
Parker Moore
622f37ecc8 Also build 3.4-stable branch. 2017-03-02 12:40:44 -05:00
jekyllbot
0cdd14eb1e Backport allow-brief-post-dates from #5920 to 3.4-stable 2017-03-02 12:33:35 -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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
Parker Moore
7c44c5a56d Release 💎 3.3.1 2016-11-14 14:36:05 -08:00
jekyllbot
cd3831296a Update history to reflect merge of #5572 [ci skip] 2016-11-14 14:28:37 -08:00
jekyllbot
88a338d345 Merge pull request #5572 from jekyll/fix-underscore-in-permalink
Merge pull request 5572
2016-11-14 14:28:36 -08:00
Parker Moore
d3e387d146 Fix typo. 2016-11-14 13:30:14 -08: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
Parker Moore
cb6724046d Dates are _the worst_ 2016-11-11 16:30:53 -08:00
Parker Moore
ff012e795a Fix fmt error. 2016-11-11 16:30:53 -08:00
Parker Moore
d50ef0e3dd Add useful comment. 2016-11-11 16:30:53 -08:00
Parker Moore
347651e571 URL#generate_url_from_drop: be smarter about replacing *just* the keys 2016-11-11 16:30:53 -08:00
Parker Moore
9f8f031469 Whoops, an *actually useful* failing test. 2016-11-11 16:30:53 -08:00
Parker Moore
f27eb77d0b Add failing test for permalink templates with trailing underscores 2016-11-11 16:30:53 -08:00
jekyllbot
51d04cbd00 Update history to reflect merge of #5571 [ci skip] 2016-11-10 15:22:13 -08:00
jekyllbot
2713716d55 Merge pull request #5571 from DirtyF/docs-github-pages
Merge pull request 5571
2016-11-10 15:22:13 -08:00
jekyllbot
07d4333579 Update history to reflect merge of #5464 [ci skip] 2016-11-10 15:05:42 -08:00
jekyllbot
f8ec71af3b Merge pull request #5464 from jekyll/allow-regular-windows-watchers
Merge pull request 5464
2016-11-10 15:05:41 -08:00
jekyllbot
dbfe0cdf56 Update history to reflect merge of #5570 [ci skip] 2016-11-10 14:50:39 -08:00
jekyllbot
1e0697a258 Merge pull request #5570 from DirtyF/fix-pinboard-plugin-link
Merge pull request 5570
2016-11-10 14:50:39 -08:00
Frank Taillandier
3e504f0837 mention docs folder to deploy on GitHub Pages
fix #5543
2016-11-10 23:42:01 +01:00
jekyllbot
262ebbb9f0 Update history to reflect merge of #5559 [ci skip] 2016-11-10 14:32:55 -08:00
jekyllbot
810f0e93d0 Merge pull request #5559 from ryandesign/use-baseurl-before-link-tag
Merge pull request 5559
2016-11-10 14:32:54 -08:00
Frank Taillandier
e515ddeb29 fix link to jekyll-pinboard plugin 2016-11-10 23:13:34 +01:00
Parker Moore
d050f6de10 Update history to reflect merge of #5493 [ci skip] 2016-11-10 13:18:17 -08:00
Parker Moore
b7cbfc0fb7 Merge branch 'mattg-master'
* mattg-master:
  Add two plugins to the plugins page
2016-11-10 13:16:27 -08:00
Parker Moore
09ec7c81f2 Update history to reflect merge of #5507 2016-11-10 13:15:57 -08:00
Parker Moore
09548c3d96 Merge branch 'spencerbyw-patch-3'
* spencerbyw-patch-3:
  Update 2-to-3.md
2016-11-10 13:15:31 -08:00
Parker Moore
fcbbc4d0bc Update history to reflect merge of #5514 2016-11-10 13:15:20 -08:00
Parker Moore
6744921f69 Merge branch 'georgemandis-patch-1'
* georgemandis-patch-1:
  Added jekyll-pinboard.
2016-11-10 13:14:14 -08:00
Parker Moore
6110002d1e Fix history reference to #5532. 2016-11-10 13:13:11 -08:00
Parker Moore
bafe37cc9d Update history to reflect merge of #5520 2016-11-10 13:12:29 -08:00
Parker Moore
cc3197856b Merge branch 'clorichel-patch-1'
* clorichel-patch-1:
  no more invalid US-ASCII on lines 30 and 97
2016-11-10 13:11:29 -08:00
jekyllbot
fc66991243 Update history to reflect merge of #5526 [ci skip] 2016-11-10 13:02:49 -08:00
jekyllbot
3e1fad273b Merge pull request #5526 from ashmaroli/fix-win-tests
Merge pull request 5526
2016-11-10 13:02:48 -08:00
jekyllbot
4268301071 Update history to reflect merge of #5546 [ci skip] 2016-11-10 13:02:10 -08:00
jekyllbot
1254ffc593 Merge pull request #5546 from ashmaroli/win-cucumber
Merge pull request 5546
2016-11-10 13:02:09 -08:00
jekyllbot
2d1a50c212 Update history to reflect merge of #5564 [ci skip] 2016-11-10 13:00:40 -08:00
jekyllbot
c7b301709c Merge pull request #5564 from jekyll/vendor-bundle
Merge pull request 5564
2016-11-10 13:00:39 -08:00
Parker Moore
df45f26187 Builder.watch: only warn for Bash on Windows, still try watching. 2016-11-10 12:55:00 -08:00
Jordon Bedwell
d71dff74ae Fix #5462: Only shutdown watch in Bash On Windows. 2016-11-10 12:55:00 -08:00
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
Parker Moore
7bf4627046 Add vendor/gems to the list of excluded & do some refactoring. 2016-11-09 09:42:26 -08:00
Parker Moore
b194211a32 Be much more specific about ignoring vendored directories. 2016-11-09 09:42:26 -08:00
Parker Moore
74a5297c19 Lock to codeclimate-test-reporter ~> 0.6.0. /cc #5565 2016-11-09 09:42:01 -08:00
jekyllbot
0de653d186 Update history to reflect merge of #5524 [ci skip] 2016-11-08 17:05:19 -08:00
jekyllbot
f10c914fd5 Merge pull request #5524 from fene/nomethoderror
Merge pull request 5524
2016-11-08 17:05:18 -08:00
jekyllbot
ca3aaec7b5 Update history to reflect merge of #5557 [ci skip] 2016-11-08 12:35:43 -08:00
jekyllbot
3d1a7efe26 Merge pull request #5557 from 10by10pixel/patch-1
Merge pull request 5557
2016-11-08 12:35:42 -08:00
Ryan Schmidt
92354fa7fc Use site.baseurl before post_url tag 2016-11-07 23:29:49 -06:00
Ryan Schmidt
70fae19b88 Use site.baseurl before link tag 2016-11-07 23:27:33 -06:00
Owen Walters
3035806826 R.I.P. Startups 2016-11-07 11:29:03 -05:00
Ashwin Maroli
1bafbd91fa create orphan files with touch method 2016-11-05 16:03:30 +05:30
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
Ashwin Maroli
7314e4a5db collections.feature: conditional steps 2016-11-04 12:29:48 +05:30
Ashwin Maroli
2c68069a41 TestSite: consider dive-letter in Windows
The array of plugins will contain current drive-letter in Windows
2016-11-04 09:20:46 +05:30
Ashwin Maroli
1852e54d10 add and use 'skip_if_windows' helper method
- add a new helper method to skip tests if on Windows platform
  - skip those tests that fail due to lack of support for symlinked files
    on Windows.
2016-11-04 09:20:46 +05:30
Parker Moore
57a6847165 Fix some external links. 2016-11-03 16:29:50 -07:00
Parker Moore
7af41649e9 Fix internal links. 2016-11-03 16:26:21 -07:00
Parker Moore
9824c3103b Allow us to specify other options to pass to htmlproofer. 2016-11-03 16:26:16 -07:00
Parker Moore
8157d53af0 Update contributing documentation based on .github/CONTRIBUTING.md 2016-11-03 15:53:00 -07: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
jekyllbot
e1eff52cd2 Update history to reflect merge of #5536 [ci skip] 2016-11-03 15:22:56 -07:00
jekyllbot
4399dbbd3d Merge pull request #5536 from malaterre/patch-1
Merge pull request 5536
2016-11-03 15:22:55 -07:00
Parker Moore
2dafd50664 Remove freenode.txt from jekyllrb.com.
Fixes #5539.
2016-11-03 13:32:20 -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
jekyllbot
b30c499196 Update history to reflect merge of #5540 [ci skip] 2016-11-03 09:53:43 -07:00
jekyllbot
c0341ad9f4 Merge pull request #5540 from matthewdu/patch-1
Merge pull request 5540
2016-11-03 09:53:43 -07:00
jekyllbot
7298da6de4 Update history to reflect merge of #5533 [ci skip] 2016-11-03 08:38:28 -07:00
jekyllbot
7d2b2961ef Merge pull request #5533 from crispgm/fix-link
Merge pull request 5533
2016-11-03 08:38:27 -07:00
jekyllbot
5237040b44 Update history to reflect merge of #5538 [ci skip] 2016-11-03 08:37:46 -07:00
jekyllbot
ebd40da4a6 Merge pull request #5538 from DirtyF/script-proof
Merge pull request 5538
2016-11-03 08:37:45 -07:00
Matthew Du
d55cfe5154 Update doc about categories and tags 2016-11-03 22:02:46 +08:00
Frank Taillandier
52e189c46a update source in script/proof 2016-11-03 14:54:11 +01:00
Mathieu Malaterre
55887194cd Fix HTML rendering
Previously the YAML example would contains the string 'yaml' at the top of the file. Very confusing for newcomers.
2016-11-03 10:00:35 +01:00
David Zhang
0a17b0ab0a Fix broken links 2016-11-03 10:49:40 +08:00
jekyllbot
e523b22510 Update history to reflect merge of #5532 [ci skip] 2016-11-02 18:55:48 -07:00
jekyllbot
b9a17e05dc Merge pull request #5532 from ashmaroli/perma-docs
Merge pull request 5532
2016-11-02 18:55:47 -07:00
Ashwin Maroli
acc00e41fb add permalinks to docs in '/maintaining/' 2016-11-03 07:00:55 +05:30
Parker Moore
3e2139e894 Fix 'Improve this page' link.
Fixes #5529
2016-11-02 15:09:46 -07:00
jekyllbot
2adac58b41 Update history to reflect merge of #5459 [ci skip] 2016-11-02 14:48:06 -07:00
jekyllbot
2115b73cb5 Merge pull request #5459 from jekyll/docs-folder
Merge pull request 5459
2016-11-02 14:48:05 -07:00
Parker Moore
1669f944d1 Move posts-specific permalink into collections metadata. Way better. 💫 2016-11-02 14:12:03 -07:00
Parker Moore
8b2a35dc50 Instead of a sleep hack, just use a Jekyll hook! 😄 2016-11-02 14:11:40 -07:00
Parker Moore
b108f4c87e Move docs/development to docs/maintaining 2016-11-02 14:03:08 -07:00
Sverrir Sigmundarson
db4c571020 Updating install instruction link
Adding a link to updated installation instructions for Jekyll 3 and Ruby 2.2.5. These instructions were adapted and significantly updated from the earlier work of Julian Thilo which is now outdated.
2016-11-02 13:51:14 -07:00
Ben Balter
6be62def90 move site to docs folder 2016-11-02 13:51:14 -07:00
Ben Balter
a087d34ece update rake task to use docs folder 2016-11-02 13:51:13 -07:00
Ben Balter
8b9391da98 abstract one last site reference 2016-11-02 13:51:13 -07:00
Ben Balter
3eedfd8fe0 abstract site directory to variable 2016-11-02 13:51:13 -07:00
jekyllbot
16217b2ed7 Update history to reflect merge of #5466 [ci skip] 2016-11-02 13:40:22 -07:00
jekyllbot
d9bf26bd9f Merge pull request #5466 from zdroid/patch-1
Merge pull request 5466
2016-11-02 13:40:21 -07:00
fen
e92dd2055d check for the urldrop key first 2016-11-02 21:30:23 +01:00
Ashwin Maroli
e6b9dd1cc1 TestFilters: adjust array size to ignore symlinks
Adjust the size of grouped-items array as it won't include symlinked
pages in Windows.
2016-11-02 22:55:12 +05:30
Ashwin Maroli
257e60b9a7 TestSite: add symlinked files only if not Windows
add symlinked files to "sorted_pages" array only when testing on
non-windows platforms.
2016-11-02 22:55:12 +05:30
Ashwin Maroli
0c234c90a9 TestGeneratedSite: add "|" to preserve newline
adding a pipe character ('|') preserves the formatting of
'expected_output' with a trailing newline bit, in windows.
2016-11-02 15:08:49 +05:30
fen
2d35364c02 implement warning about missing keys in url drops 2016-11-02 00:22:41 +01:00
fen
a2ffde8f14 rewrite test to only not throw error 2016-11-02 00:22:20 +01:00
fen
1bb2259a10 add failing test 2016-11-02 00:00:38 +01:00
Pierre-Alexandre
a856a948c9 no more invalid US-ASCII on lines 30 and 97
Avoiding errors on `jekyll serve`

```
# jekyll serve -H 0.0.0.0
Configuration file: /jekyll-offline-docs/site/_config.yml
Configuration file: /jekyll-offline-docs/site/_config.yml
            Source: /jekyll-offline-docs/site
       Destination: /jekyll-offline-docs/site/_site
 Incremental build: disabled. Enable with --incremental
      Generating...
  Conversion error: Jekyll::Converters::Scss encountered an error while converting 'css/screen.scss':
                    Invalid US-ASCII character "\xE2" on line 30
jekyll 3.3.0 | Error:  Invalid US-ASCII character "\xE2" on line 30
```

And line 97 when 30 is adjusted...
2016-10-30 11:41:15 +00:00
jekyllbot
a1bdd31249 Update history to reflect merge of #5519 [ci skip] 2016-10-30 02:49:26 -07:00
jekyllbot
99d12724f9 Merge pull request #5519 from neudabei/patch-1
Merge pull request 5519
2016-10-30 02:49:25 -07:00
Robert
26144645d8 Remove Glynn as deployment option
Remove Glynn as deployment option since that gem is no longer actively maintained. See notes on readme in repository: https://github.com/dmathieu/glynn and https://github.com/dmathieu/glynn/issues/67
2016-10-29 14:45:18 +01:00
George Mandis
762bf18d25 Added jekyll-pinboard.
Added link to my Jekyll plugin: https://github.com/snaptortoise/jekyll-pinboard-plugin. Interfaces with the Pinboard API to make data for specified tags available to the template, sort of similar to the built-in Data Files support.
2016-10-25 13:54:43 -07:00
jekyllbot
803c8827e3 Update history to reflect merge of #5512 [ci skip] 2016-10-25 12:06:24 -07:00
jekyllbot
142e12addc Merge pull request #5512 from 5jt/patch-1
Merge pull request 5512
2016-10-25 12:06:23 -07:00
5jt
fcec2a6af9 Update troubleshooting.md
`sudo apt-get install ruby2.0.0-dev` reports _Unable to locate package ruby2.0.0-dev_
2016-10-25 09:40:56 +02:00
jekyllbot
81535dc188 Update history to reflect merge of #5457 [ci skip] 2016-10-24 14:49:19 -07:00
jekyllbot
4896f54b87 Merge pull request #5457 from ashmaroli/dependency-template
Merge pull request 5457
2016-10-24 14:49:19 -07:00
jekyllbot
ce6f20f187 Update history to reflect merge of #5505 [ci skip] 2016-10-24 14:48:05 -07:00
jekyllbot
bc5e59ca3e Merge pull request #5505 from fene/master
Merge pull request 5505
2016-10-24 14:48:04 -07:00
jekyllbot
a87cfec587 Update history to reflect merge of #5511 [ci skip] 2016-10-23 18:52:47 -07:00
jekyllbot
26f775c210 Merge pull request #5511 from bksteiny/bksteiny-patch-1
Merge pull request 5511
2016-10-23 18:52:46 -07:00
Chris Stein
9bb242b44a fix _config.yml typo in site_template
Found a typo when going through a tutorial. Replacing `these this` with `this`
2016-10-23 15:26:50 -05:00
Spencer A. Bywater
3689844597 Update 2-to-3.md
I was reading through the "Upgrading from 2.x to 3.x" page in the docs and noticed some of the markdown was janky. I made these small edits to fix the formatting and conform with how it's done elsewhere.
2016-10-22 09:54:35 -07:00
fen
7729d12cdc include a hashbang for all benchmark scripts
this also makes every benchmark script executable
2016-10-22 03:13:30 +02:00
Matthew Gifford
8ed9863f07 Add two plugins to the plugins page 2016-10-20 22:50:55 -07:00
Zlatan Vasović
884962c20e Fix broken forum link
help.jekyllrb.com has been replaced with talk.jekyllrb.com 💥
2016-10-07 19:54:40 +02:00
Ashwin Maroli
08b30056b7 replace development_dependency with runtime_dependency 2016-10-06 23:42:16 +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
293 changed files with 3438 additions and 2336 deletions

View File

@@ -23,7 +23,7 @@ exclude_paths:
- features/**/*
- script/**/*
- site/**/*
- docs/**/*
- spec/**/*
- test/**/*
- vendor/**/*

View File

@@ -62,13 +62,33 @@ We want the Jekyll documentation to be the best it can be. We've open-sourced ou
### How to submit changes
You can find the documentation for jekyllrb.com in the [site](https://github.com/jekyll/jekyll/tree/master/site) directory. See the section above, [submitting a pull request](#submitting-a-pull-request) for information on how to propose a change.
You can find the documentation for jekyllrb.com in the [docs](https://github.com/jekyll/jekyll/tree/master/docs) directory. See the section above, [submitting a pull request](#submitting-a-pull-request) for information on how to propose a change.
One gotcha, all pull requests should be directed at the `master` branch (the default branch).
### 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/site/_docs/plugins.md) by adding a link to your plugin under the proper subheading depending upon its type.
If you want to add your plugin to the [list of plugins](https://jekyllrb.com/docs/plugins/#available-plugins), please submit a pull request modifying the [plugins page source file](https://github.com/jekyll/jekyll/blob/master/docs/_docs/plugins.md) by adding a link to your plugin under the proper subheading depending upon its type.
## Code Contributions
@@ -80,7 +100,7 @@ Any time you propose a code change, you should also include updates to the docum
#### Documentation
If your contribution changes any Jekyll behavior, make sure to update the documentation. Documentation lives in the `site/_docs` folder (spoiler alert: it's a Jekyll site!). If the docs are missing information, please feel free to add it in. Great docs make a great project. Include changes to the documentation within your pull request, and once merged, `jekyllrb.com` will be updated.
If your contribution changes any Jekyll behavior, make sure to update the documentation. Documentation lives in the `docs/_docs` folder (spoiler alert: it's a Jekyll site!). If the docs are missing information, please feel free to add it in. Great docs make a great project. Include changes to the documentation within your pull request, and once merged, `jekyllrb.com` will be updated.
#### Tests

View File

@@ -22,6 +22,8 @@ Metrics/BlockLength:
Exclude:
- test/**/*.rb
- lib/jekyll/configuration.rb
- rake/*.rake
- jekyll.gemspec
Metrics/ClassLength:
Exclude:
- !ruby/regexp /features\/.*.rb$/
@@ -32,6 +34,8 @@ Metrics/CyclomaticComplexity:
Metrics/LineLength:
Exclude:
- !ruby/regexp /features\/.*.rb/
- Rakefile
- rake/*.rake
Max: 90
Severity: warning
Metrics/MethodLength:
@@ -44,6 +48,14 @@ Metrics/ParameterLists:
Max: 4
Metrics/PerceivedComplexity:
Max: 8
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:
@@ -127,5 +139,7 @@ Style/StringLiterals:
EnforcedStyle: double_quotes
Style/StringLiteralsInInterpolation:
EnforcedStyle: double_quotes
Style/TrailingCommaInLiteral:
EnforcedStyleForMultiline: consistent_comma
Style/UnneededCapitalW:
Enabled: false

View File

@@ -5,10 +5,10 @@ language: ruby
sudo: false
rvm:
- &ruby1 2.3.1
- &ruby2 2.2.5
- &ruby1 2.3.3
- &ruby2 2.2.6
- &ruby3 2.1.9
- &jruby jruby-9.1.2.0
- &jruby jruby-9.1.7.0
matrix:
include:
@@ -28,6 +28,7 @@ branches:
only:
- master
- themes
- 3.4-stable*
notifications:
slack:
@@ -45,3 +46,6 @@ addons:
DA4vsRURfABU0fIhwYkQuZqEcA3d8TL36BZcGEshG6MQ2AmnYsmFiTcxqV5bmlElHEqQuT\
5SUFXLafgZPBnL0qDwujQcHukID41sE=\
"
# regular test configuration
after_success:
- bundle exec codeclimate-test-reporter

61
Gemfile
View File

@@ -1,10 +1,10 @@
source "https://rubygems.org"
gemspec :name => "jekyll"
gem "rake", "~> 11.0"
gem "rake", "~> 12.0"
# Dependency of jekyll-mentions. RubyGems in Ruby 2.1 doesn't shield us from this.
gem "activesupport", "~> 4.2", :groups => [:test_legacy, :site] if RUBY_VERSION < '2.2.2'
gem "activesupport", "~> 4.2", :groups => [:test_legacy, :site] if RUBY_VERSION < "2.2.2"
group :development do
gem "launchy", "~> 2.3"
@@ -18,15 +18,15 @@ end
#
group :test do
gem "rubocop", "~> 0.44.1"
gem "codeclimate-test-reporter", "~> 1.0.5"
gem "cucumber", "~> 2.1"
gem "jekyll_test_plugin"
gem "jekyll_test_plugin_malicious"
gem "codeclimate-test-reporter"
gem "rspec-mocks"
gem "nokogiri"
gem "rspec"
gem "test-theme", path: File.expand_path("./test/fixtures/test-theme", File.dirname(__FILE__))
gem "rspec-mocks"
gem "rubocop", "~> 0.47"
gem "test-theme", :path => File.expand_path("./test/fixtures/test-theme", File.dirname(__FILE__))
gem "jruby-openssl" if RUBY_ENGINE == "jruby"
end
@@ -34,63 +34,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 "redgreen"
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"
gem "jekyll-gist"
gem "jekyll-paginate"
gem "mime-types", "~> 3.0"
gem "jekyll-redirect-from"
gem "kramdown", "~> 1.9"
gem "rdoc", "~> 4.2"
gem "mime-types", "~> 3.0"
gem "rdoc", "~> 5.0"
gem "toml", "~> 0.1.0"
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.1.0"
gem "liquid-c", "~> 3.0"
gem "pygments.rb", "~> 0.6.0"
gem "rdiscount", "~> 2.0"
gem "redcarpet", "~> 3.2", ">= 3.2.3"
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,8 +1,146 @@
## HEAD
## 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 / 2016-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 / 2016-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
* Documentation: {% link %} tag (#5449)
* 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)
* [site] 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)
* [docs] 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
* Collapse `gsub` for performance (#5494)
* URL: warn if key doesn't exist in url drop (#5524)
### Bug Fixes
* Fix typo in `theme_template` README (#5472)
* Do not swallow all exceptions on render (#5495)
* Site template: fixed `_config.yml` comment typo (#5511)
* `jekyll new-theme` should specify Jekyll as a runtime dependency for the theme (#5457)
* Be much more specific about ignoring specific vendored directories. (#5564)
* Only warn about auto-regeneration bug on Bash On Windows. (#5464)
* Allow permalink template to have underscores (#5572)
### Site Enhancements
* Documentation: `link` Liquid tag (#5449)
* Updating install instruction link for Jekyll 3 on Windows (#5475)
* Update normalize.css to v5.0.0 (#5471)
* Add jekyll-data to the list of plugins (#5491)
@@ -10,21 +148,32 @@
* Add jekyll-include-absolute-plugin to list of third-party plugins (#5492)
* Remove jekyll-hook from deployment methods (#5502)
* Update deployment-methods.md (#5504)
### Bug Fixes
* Fix typo in theme_template README (#5472)
* Do not swallow all exceptions on render (#5495)
* Ubuntu users should install ruby2.3-dev (#5512)
* Remove Glynn as deployment option (#5519)
* Fix broken forum link (#5466)
* Move documentation to docs folder (#5459)
* Fix broken links in CONTRIBUTING (#5533)
* Update documentation on jekyllrb.com (#5540)
* Fix HTML rendering (#5536)
* Remove outdated deployment information (#5557)
* no more invalid US-ASCII on lines 30 and 97 (#5520)
* Add permalinks to docs in '/maintaining/' (#5532)
* Add jekyll-pinboard to list of third-party plugins (#5514)
* Fix formatting in 2-to-3.md (#5507)
* Add two plugins to the plugins page (#5493)
* Use site.baseurl before link and post_url tags (#5559)
* Fix link to jekyll-pinboard plugin (#5570)
* mention `docs` folder as a way to deploy on GitHub Pages (#5571)
### Development Fixes
* fix rubocop errors on testing with Rubocop 0.44 (#5489)
* script/test: add missing whitespace (#5479)
* Restrict Rubocop version (#5496)
### Minor Enhancements
* Collapse `gsub` (#5494)
* include a hashbang for all benchmark scripts & make them executable (#5505)
* Update source in script/proof (#5538)
* Collections.feature: conditional steps to have it pass on Windows (#5546)
* Fix tests to get script/test to pass on Windows (#5526)
## 3.3.0 / 2016-10-06

View File

@@ -1,6 +1,6 @@
The MIT License (MIT)
Copyright (c) 2008-2016 Tom Preston-Werner
Copyright (c) 2008-2017 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

@@ -43,8 +43,7 @@ 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 a maintainer ([@parkr](https://github.com/parkr), [@envygeeks](https://github.com/envygeeks), [@mattr-](https://github.com/mattr-), or [@alfredxing](https://github.com/alfredxing)) know and we will address it as soon as possible.
## Diving In

View File

@@ -1,13 +1,13 @@
require 'rubygems'
require 'rake'
require 'rdoc'
require 'date'
require 'yaml'
require "rubygems"
require "rake"
require "rdoc"
require "date"
require "yaml"
$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), *%w[lib]))
require 'jekyll/version'
$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "lib"))
require "jekyll/version"
Dir.glob('rake/**.rake').each { |f| import f }
Dir.glob("rake/**.rake").each { |f| import f }
#############################################################################
#
@@ -27,26 +27,30 @@ def docs_name
"#{name}-docs"
end
def docs_folder
"docs"
end
def gemspec_file
"#{name}.gemspec"
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|
markdown.gsub(%r!(@\w+)!) do |username|
"[#{username}](https://github.com/#{username.delete("@")})"
end
end
@@ -56,13 +60,13 @@ def linkify(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}")
@@ -71,11 +75,11 @@ def custom_release_header_anchors(markdown)
end
def sluffigy(header)
header.gsub(/#/, '').strip.downcase.gsub(/\s+/, '-')
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
@@ -84,25 +88,28 @@ 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]
File.read(file).match(%r!\A# (.*)$!)[1]
rescue
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."
}.merge(overrides_front_matter)
contents = "#{front_matter.to_yaml}---\n\n#{content_for(file)}"
File.write("site/_docs/#{slug}.md", contents)
File.write("#{docs_folder}/_docs/#{slug}.md", contents)
end
def content_for(file)
@@ -111,7 +118,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
@@ -124,23 +131,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
@@ -148,9 +155,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

1
benchmark/capture-assign.rb Normal file → Executable file
View File

@@ -1,3 +1,4 @@
#!/usr/bin/env ruby
require "liquid"
require "benchmark/ips"

1
benchmark/end-with-vs-regexp Normal file → Executable file
View File

@@ -1,3 +1,4 @@
#!/usr/bin/env ruby
require 'benchmark/ips'
Benchmark.ips do |x|

0
benchmark/file-dir-ensure-trailing-slash Normal file → Executable file
View File

1
benchmark/flat-map Normal file → Executable file
View File

@@ -1,3 +1,4 @@
#!/usr/bin/env ruby
require 'benchmark/ips'
enum = (0..50).to_a

1
benchmark/hash-fetch Normal file → Executable file
View File

@@ -1,3 +1,4 @@
#!/usr/bin/env ruby
require 'benchmark/ips'
h = {:bar => 'uco'}

0
benchmark/jekyll-sanitize-path Normal file → Executable file
View File

1
benchmark/proc-call-vs-yield Normal file → Executable file
View File

@@ -1,3 +1,4 @@
#!/usr/bin/env ruby
require 'benchmark/ips'
def fast

0
benchmark/regexp-vs-include.rb Normal file → Executable file
View File

1
benchmark/sequential-assignment Normal file → Executable file
View File

@@ -1,3 +1,4 @@
#!/usr/bin/env ruby
require 'benchmark/ips'
Benchmark.ips do |x|

3
benchmark/string-concat Normal file → Executable file
View File

@@ -1,6 +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
benchmark/string-replacement Normal file → Executable file
View File

@@ -1,3 +1,4 @@
#!/usr/bin/env ruby
require 'benchmark/ips'
def str

1
benchmark/symbol-to-proc Normal file → Executable file
View File

@@ -1,3 +1,4 @@
#!/usr/bin/env ruby
require 'benchmark/ips'
Benchmark.ips do |x|

View File

View File

@@ -1,6 +1,5 @@
markdown: kramdown
highlighter: rouge
permalink: /news/:year/:month/:day/:title/
gauges_id: 503c5af6613f5d0f19000027
google_analytics_id: UA-50755011-1
@@ -11,8 +10,27 @@ help_url: https://github.com/jekyll/jekyll-help
timezone: America/Los_Angeles
defaults:
-
scope:
path: "_docs"
type: "docs"
values:
layout: "docs"
-
scope:
path: "_posts"
type: "posts"
values:
layout: "news_item"
collections:
docs:
permalink: /:collection/:path/
output: true
posts:
permalink: /news/:year/:month/:day/:title/
output: true
name: Jekyll • Simple, blog-aware, static sites
@@ -25,14 +43,14 @@ twitter:
logo: /img/logo-2x.png
gems:
- jekyll-feed
- jekyll-redirect-from
- jemoji
- jekyll-sitemap
- jekyll-seo-tag
- jekyll-avatar
- jekyll-feed
- jekyll-mentions
- jekyll-redirect-from
- jekyll-seo-tag
- jekyll-sitemap
- jemoji
exclude:
- README.md
- .gitignore
- README.md

View File

@@ -23,6 +23,7 @@
- title: Customization
docs:
- templates
- includes
- permalinks
- pagination
- plugins
@@ -46,5 +47,6 @@
- title: Meta
docs:
- contributing
- maintaining
- conduct
- history

View File

@@ -1,5 +1,4 @@
---
layout: docs
title: Assets
permalink: /docs/assets/
---

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,12 @@ defaults:
layout: page
```
### Step 2: Add your content
### 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 +61,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,19 +78,6 @@ 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:
```yaml
collections:
my_collection:
output: true
permalink: /awesome/:path/
```
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`.
<div class="note info">
<h5>Don't forget to add YAML for processing</h5>
<p>
@@ -95,6 +87,21 @@ written out to `<dest>/awesome/some_subdir/some_doc/index.html`.
</p>
</div>
## Configuring permalinks for collections {#permalinks}
You can customize the [Permalinks](../permalinks/) for your collection's documents by setting `permalink` property in the collection's configuration as follows:
```yaml
collections:
my_collection:
output: true
permalink: /awesome/:path/:title.:output_ext
```
In this example, the collection documents will the have the URL of `awesome` followed by the path to the document and its file extension.
Collections have the following template variables available for permalinks:
<div class="mobile-side-scroller">
<table>
<thead>
@@ -149,15 +156,92 @@ written out to `<dest>/awesome/some_subdir/some_doc/index.html`.
</table>
</div>
## Permalink examples for collections
Depending on how you declare the permalinks in your configuration file, the permalinks and paths get written differently in the `_site` folder. A few examples will help clarify the options.
Let's say your collection is called `apidocs` with `doc1.md` in your collection. `doc1.md` is grouped inside a folder called `mydocs`. Your project's source directory for the collection looks this:
```
├── \_apidocs
│   └── mydocs
│   └── doc1.md
```
Based on this scenario, here are a few permalink options.
**Permalink configuration 1**: [Nothing configured] <br/>
**Output**:
```
├── apidocs
│   └── mydocs
│   └── doc1.html
```
**Permalink configuration 2**: `/:collection/:path/:title:output_ext` <br/>
**Output**:
```
├── apidocs
│   └── mydocs
│   └── doc1.html
```
**Permalink configuration 3**: No collection permalinks configured, but `pretty` configured for pages/posts. <br/>
**Output**:
```
├── apidocs
│   └── mydocs
│   └── doc1
│   └── index.html
```
**Permalink configuration 4**: `/awesome/:path/:title.html` <br/>
**Output**:
```
├── awesome
│   └── mydocs
│   └── doc1.html
```
**Permalink configuration 5**: `/awesome/:path/:title/` <br/>
**Output**:
```
├── awesome
│   └── mydocs
│   └── doc1
│   └── index.html
```
**Permalink configuration 6**: `/awesome/:title.html` <br/>
**Output**:
```
├── awesome
│   └── doc1.html
```
**Permalink configuration 7**: `:title.html`
**Output**:
```
├── doc1.html
```
## Liquid Attributes
### 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:
@@ -335,7 +419,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):

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/
---
@@ -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>
@@ -513,8 +522,8 @@ With these defaults, all posts would use the `my-site` layout. Any html files th
```yaml
collections:
- my_collection:
output: true
my_collection:
output: true
defaults:
-
@@ -594,7 +603,7 @@ collections:
# Handling Reading
safe: false
include: [".htaccess"]
exclude: ["node_modules", "vendor"]
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"

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

View File

@@ -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
@@ -29,7 +26,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.
@@ -71,7 +68,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 +91,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 +124,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 +226,5 @@ an entry in the `.gitignore` file to avoid it from being checked in again.
This entire guide is open-source. Go ahead and [edit it][3] if you have a
fix or [ask for help][4] if you run into trouble and need some help.
[3]: https://github.com/jekyll/jekyll/edit/master/site/_docs/continuous-integration.md
[3]: https://github.com/jekyll/jekyll/edit/master/docs/_docs/continuous-integration/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.
---
@@ -67,13 +66,33 @@ We want the Jekyll documentation to be the best it can be. We've open-sourced ou
### How to submit changes
You can find the documentation for jekyllrb.com in the [site](https://github.com/jekyll/jekyll/tree/master/site) directory. See the section above, [submitting a pull request](#submitting-a-pull-request) for information on how to propose a change.
You can find the documentation for jekyllrb.com in the [docs](https://github.com/jekyll/jekyll/tree/master/docs) directory. See the section above, [submitting a pull request](#submitting-a-pull-request) for information on how to propose a change.
One gotcha, all pull requests should be directed at the `master` branch (the default branch).
### 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/site/_docs/plugins.md) by adding a link to your plugin under the proper subheading depending upon its type.
If you want to add your plugin to the [list of plugins](https://jekyllrb.com/docs/plugins/#available-plugins), please submit a pull request modifying the [plugins page source file](https://github.com/jekyll/jekyll/blob/master/docs/_docs/plugins.md) by adding a link to your plugin under the proper subheading depending upon its type.
## Code Contributions
@@ -85,7 +104,7 @@ Any time you propose a code change, you should also include updates to the docum
#### Documentation
If your contribution changes any Jekyll behavior, make sure to update the documentation. Documentation lives in the `site/_docs` folder (spoiler alert: it's a Jekyll site!). If the docs are missing information, please feel free to add it in. Great docs make a great project. Include changes to the documentation within your pull request, and once merged, `jekyllrb.com` will be updated.
If your contribution changes any Jekyll behavior, make sure to update the documentation. Documentation lives in the `docs/_docs` folder (spoiler alert: it's a Jekyll site!). If the docs are missing information, please feel free to add it in. Great docs make a great project. Include changes to the documentation within your pull request, and once merged, `jekyllrb.com` will be updated.
#### Tests

View File

@@ -1,5 +1,4 @@
---
layout: docs
title: Data Files
permalink: /docs/datafiles/
---
@@ -125,6 +124,7 @@ file name:
Pages and posts can also access a specific data item. The example below shows how to access a specific item:
`_data/people.yml`:
```yaml
dave:
name: David Smith
@@ -142,7 +142,7 @@ 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>

View File

@@ -1,5 +1,4 @@
---
layout: docs
title: Deployment methods
permalink: /docs/deployment-methods/
---
@@ -10,11 +9,6 @@ Sites built using Jekyll can be deployed in a large number of ways due to the st
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.
### FTP using Glynn
There is a project called [Glynn](https://github.com/dmathieu/glynn), which lets you easily generate your Jekyll powered websites static files and
send them to your host through FTP.
## Self-managed web server
If you have direct access to the deployment web server, the process is essentially the same, except you might have other methods available to you (such as `scp`, or even direct filesystem access) for transferring the files. Just remember to make sure the contents of the generated `_site` folder get placed in the appropriate web root directory for your web server.
@@ -173,7 +167,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
@@ -212,13 +206,3 @@ Setting up Kickster is very easy, just install the gem and you are good to go. M
[Aerobatic](https://www.aerobatic.com) is an add-on for Bitbucket that brings GitHub Pages style functionality to Bitbucket users. It includes continuous deployment, custom domains with a wildcard SSL cert, CDN, basic auth, and staging branches all in the box.
Automating the build and deployment of a Jekyll site is just as simple as GitHub Pages - push your changes to your repo (excluding the `_site` directory) and within seconds a build will be triggered and your built site deployed to our highly- available, globally distributed hosting service. The build process will even install and execute custom Ruby plugins. See our [Jekyll docs](https://www.aerobatic.com/docs/static-generators#jekyll) for more details.
## PubStorm
[PubStorm](https://www.pubstorm.com) is a free front-end and static-site publishing platform built by [Nitrous](https://www.nitrous.io). PubStorm is distributed as a node package and can be installed by running `npm install -g pubstorm`. You can create a free account by running `storm signup`.
To publish your site, run `storm init` from the root of your project and enter `_site` as the project path when prompted. You can the run `jekyll build` to build your site and then run `storm deploy` to publish your site in seconds.
PubStorm offers a pre-configured CDN, free custom domains, SSL certs, rollbacks, collaboration and more. To configure additional features, [follow the instructions on the PubStorm help site](http://help.pubstorm.com).
You can also use the [Nitrous Jekyll Template](https://www.nitrous.io/quickstarts) to develop your Jekyll project and deploy to PubStorm directly from Nitrous. This is a great option for developing Jekyll projects on Windows.

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/
---
@@ -15,7 +14,7 @@ Kramdown comes with optional support for LaTeX to PNG rendering via [MathJax](ht
<script src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML" type="text/javascript"></script>
```
For more information about getting started, check out [this excellent blog post](http://gastonsanchez.com/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/
---
@@ -157,7 +156,7 @@ These are available out-of-the-box to be used in the front matter for a post.
the post will act as though it had been set with these categories
normally. Categories (plural key) can be specified as a <a
href="https://en.wikipedia.org/wiki/YAML#Basic_components">YAML list</a> or a
comma-separated string.
space-separated string.
</p>
</td>
@@ -172,7 +171,7 @@ These are available out-of-the-box to be used in the front matter for a post.
Similar to categories, one or multiple tags can be added to a post.
Also like categories, tags can be specified as a <a
href="https://en.wikipedia.org/wiki/YAML#Basic_components">YAML list</a> or a
comma-separated string.
space-separated string.
</p>
</td>

View File

@@ -1,5 +1,4 @@
---
layout: docs
title: GitHub Pages
permalink: /docs/github-pages/
---
@@ -12,22 +11,20 @@ content, theyre also a great way to host your Jekyll-powered website for free
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.
This guide will teach you what you need to know about Git, GitHub, and Jekyll to create your very own website on GitHub Pages.
### 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.
Project Pages complicates the proper resolution of URLs. In order to assure your site builds properly, use `site.github.url` in your URL's.
```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>
[{{ page.title }}]("{{ page.url | prepend: site.github.url }}")
{% endraw %}
```
@@ -42,17 +39,24 @@ There are two basic types available: user/organization pages 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>:
<div class="note protip" markdown="1">
<div markdown="1">
</div>
##### Use the `github-pages` gem
Our friends at GitHub have provided the
[github-pages](https://github.com/github/pages-gem)
gem which is used to manage Jekyll and its dependencies on
GitHub Pages. Using it in your projects means that when you deploy
your site to GitHub Pages, you will not be caught by unexpected
differences between various versions of the gems. To use the
currently-deployed version of the gem in your project, add the
following to your `Gemfile`:
<div class="code-block" markdown="1">
<div markdown="1">
</div>
```ruby
source 'https://rubygems.org'
@@ -63,22 +67,28 @@ versions = JSON.parse(open('https://pages.github.com/versions.json').read)
gem 'github-pages', versions['github-pages']
```
</div>
This will ensure that when you run <code>bundle install</code>, you
have the correct version of the <code>github-pages</code> gem.
This will ensure that when you run `bundle install`, you
have the correct version of the `github-pages` gem.
If that fails, simplify it:
If that fails, simplify it:
<div class="code-block" markdown="1">
<div markdown="1">
</div>
```ruby
source 'https://rubygems.org'
gem 'github-pages'
```
</div>
And be sure to run <code>bundle update</code> often.
And be sure to run `bundle update` 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>
If you like to install `pages-gem` on Windows you can find instructions by Jens Willmer on
[how to install github-pages gem on Windows (x64)](https://jwillmer.de/blog/tutorial/how-to-install-jekyll-and-pages-gem-on-windows-10-x46#github-pages-and-plugins).
</div>
<div class="note info">
@@ -95,8 +105,7 @@ gem 'github-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
@@ -115,21 +124,28 @@ publish the GitHub Pages site, so make sure your Jekyll site is stored there.
Unlike user and organization Pages, Project Pages are kept in the same
repository as the project they are for, except that the website content is
stored in a specially named `gh-pages` branch. The content of this branch will
be rendered using Jekyll, and the output will become available under a subpath
of your user pages subdomain, such as `username.github.io/project` (unless a
custom domain is specified—see below).
stored in a specially named `gh-pages` branch or in a `docs` folder on the
`master` branch. The content will be rendered using Jekyll, and the output
will become available under a subpath of your user pages subdomain, such as
`username.github.io/project` (unless a custom domain is specified).
The Jekyll project repository itself is a perfect example of this branch
structure—the [master branch]({{ site.repository }}) contains the
actual software project for Jekyll, however the Jekyll website (that youre
looking at right now) is contained in the [gh-pages
branch]({{ site.repository }}/tree/gh-pages) of the same repository.
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 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>
<p>
GitHub Pages <a href="https://help.github.com/articles/troubleshooting-github-pages-build-failures#source-setting">overrides</a> the <a href="/docs/configuration/#global-configuration">“Site Source”</a> configuration value, so if you locate your files anywhere other than the root directory, your site may not build correctly.
GitHub Pages <a href="https://help.github.com/articles/troubleshooting-github-pages-build-failures#source-setting">overrides</a>
the <a href="/docs/configuration/#global-configuration">“Site Source”</a>
configuration value, so if you locate your files anywhere other than the
root directory, your site may not build correctly.
</p>
</div>
@@ -137,9 +153,8 @@ GitHub Pages <a href="https://help.github.com/articles/troubleshooting-github-pa
<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>.
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>

View File

@@ -1,10 +1,196 @@
---
title: History
layout: docs
permalink: "/docs/history/"
note: This file is autogenerated. Edit /History.markdown instead.
---
## 3.4.3 / 2017-03-21
{: #v3-4-3}
- Backport [#5957]({{ site.repository }}/issues/5957) for v3.4.x: Allow colons in `uri_escape` filter ([#5968]({{ site.repository }}/issues/5968))
## 3.4.2 / 2017-03-09
{: #v3-4-2}
- Backport [#5871]({{ site.repository }}/issues/5871) for v3.4.x: Convert StaticFile liquid representation to
a Drop & add front matter defaults support to StaticFiles ([#5940]({{ site.repository }}/issues/5940))
## 3.4.1 / 2017-03-02
{: #v3-4-1}
- Backport [#5920]({{ site.repository }}/issues/5920) for v3.4.x: Allow abbreviated post dates ([#5924]({{ site.repository }}/issues/5924))
## 3.4.0 / 2016-01-27
{: #v3-4-0}
### Minor Enhancements
{: #minor-enhancements-v3-4-0}
- Add connector param to `array_to_sentence_string` filter ([#5597]({{ site.repository }}/issues/5597))
- Adds `group_by_exp` filter ([#5513]({{ site.repository }}/issues/5513))
- Use Addressable instead of URI to decode ([#5726]({{ site.repository }}/issues/5726))
- throw IncludeTagError if error occurs in included file ([#5767]({{ site.repository }}/issues/5767))
- Write Jekyll::Utils::Exec.run for running shell commands. ([#5640]({{ site.repository }}/issues/5640))
- Use the current year for the LICENSE of theme ([#5712]({{ site.repository }}/issues/5712))
- Update License ([#5713]({{ site.repository }}/issues/5713))
### Bug Fixes
{: #bug-fixes-v3-4-0}
- Escaped regular expressions when using `post_url`. ([#5605]({{ site.repository }}/issues/5605))
- fix date parsing in file names to be stricter ([#5609]({{ site.repository }}/issues/5609))
- Add a module to re-define `ENV["TZ"]` in Windows ([#5612]({{ site.repository }}/issues/5612))
- Use each instead of map to actually return nothing ([#5668]({{ site.repository }}/issues/5668))
- include: fix 'no implicit conversion of nil to String' ([#5750]({{ site.repository }}/issues/5750))
- Don't include the theme's includes_path if it is nil. ([#5780]({{ site.repository }}/issues/5780))
- test double slash when input = '/' ([#5542]({{ site.repository }}/issues/5542))
- use logger.info for related posts ([#5822]({{ site.repository }}/issues/5822))
### Site Enhancements
{: #site-enhancements-v3-4-0}
- Use only the used Font Awesome icons. ([#5530]({{ site.repository }}/issues/5530))
- Switch to `https` when possible. ([#5611]({{ site.repository }}/issues/5611))
- Update `_font-awesome.scss` to move .woff file before .ttf ([#5614]({{ site.repository }}/issues/5614))
- Update documentation on updating FontAwesome Iconset ([#5655]({{ site.repository }}/issues/5655))
- [site] Use defaults for docs and news-items ([#5744]({{ site.repository }}/issues/5744))
- Sort gems in `docs/_config.yml` ([#5746]({{ site.repository }}/issues/5746))
- Add missing class ([#5791]({{ site.repository }}/issues/5791))
- Improve template docs ([#5694]({{ site.repository }}/issues/5694))
### Development Fixes
{: #development-fixes-v3-4-0}
- clean unit-test names in `test/test_tags.rb` ([#5608]({{ site.repository }}/issues/5608))
- Add cucumber feature to test for bonafide theme gems ([#5384]({{ site.repository }}/issues/5384))
- Use `assert_nil` instead of `assert_equal nil` ([#5652]({{ site.repository }}/issues/5652))
- Rubocop -a on lib/jekyll ([#5666]({{ site.repository }}/issues/5666))
- Bump to rake 12.0 ([#5670]({{ site.repository }}/issues/5670))
- Rubocop Gemfile ([#5671]({{ site.repository }}/issues/5671))
- update Classifier-Reborn to 2.1.0 ([#5711]({{ site.repository }}/issues/5711))
- Rubocop: fix Rakefile and gemspec ([#5745]({{ site.repository }}/issues/5745))
- Use `assert_nil` ([#5725]({{ site.repository }}/issues/5725))
- Sort gems in `jekyll.gemspec` ([#5746]({{ site.repository }}/issues/5746))
- Rubocop: Require consistent comma in multiline literals ([#5761]({{ site.repository }}/issues/5761))
- Bump rubocop ([#5765]({{ site.repository }}/issues/5765))
- New rubocop security checks ([#5768]({{ site.repository }}/issues/5768))
- test/helper: fix flaky plugin path test by removing calls to Dir.chdir without a block ([#5779]({{ site.repository }}/issues/5779))
- Use latest jemoji gem ([#5782]({{ site.repository }}/issues/5782))
- Bump htmlproofer ([#5781]({{ site.repository }}/issues/5781))
- Bump rubies we test against ([#5784]({{ site.repository }}/issues/5784))
- Bump rdoc to v5.0 ([#5797]({{ site.repository }}/issues/5797))
- Bump codeclimate-test-reporter to v1.0.5 ([#5798]({{ site.repository }}/issues/5798))
### Documentation
- Improve quickstart docs ([#5689]({{ site.repository }}/issues/5689))
- Add Jekyll-Post to list of plugins ([#5705]({{ site.repository }}/issues/5705))
- Add jekyll-numbered-headings ([#5688]({{ site.repository }}/issues/5688))
- Docs: move permalinks from documents into config ([#5544]({{ site.repository }}/issues/5544))
- Improve collections docs ([#5691]({{ site.repository }}/issues/5691))
- Fix [#5730]({{ site.repository }}/issues/5730): add gcc and make to the list of requirements ([#5731]({{ site.repository }}/issues/5731))
- Remove instructions to install Jekyll 2 on Windows ([#5582]({{ site.repository }}/issues/5582))
- Fix example URL inconsistency ([#5592]({{ site.repository }}/issues/5592))
- Replace backticks within HTML blocks with HTML tags ([#5435]({{ site.repository }}/issues/5435))
- Add jekyll-migrate-permalink ([#5600]({{ site.repository }}/issues/5600))
- Fix bad config YAML in collections example ([#5587]({{ site.repository }}/issues/5587))
- Bring documentation on 'Directory Structure' up-to-date ([#5573]({{ site.repository }}/issues/5573))
- Fixed typo ([#5632]({{ site.repository }}/issues/5632))
- use backticks for Gemfile for consistency since in the next sentence … ([#5641]({{ site.repository }}/issues/5641))
- Update Core team list in the README file ([#5643]({{ site.repository }}/issues/5643))
- Improve Permalinks documentation. ([#5653]({{ site.repository }}/issues/5653))
- Fix typo in Variables doc page ([#5657]({{ site.repository }}/issues/5657))
- Fix a couple of typos in the docs ([#5658]({{ site.repository }}/issues/5658))
- Update windows.md ([#5683]({{ site.repository }}/issues/5683))
- Improve permalinks docs ([#5693]({{ site.repository }}/issues/5693))
- Document --unpublished build option ([#5720]({{ site.repository }}/issues/5720))
- Improve pages docs ([#5692]({{ site.repository }}/issues/5692))
- Added new includes.md topic to docs ([#5696]({{ site.repository }}/issues/5696))
- Replace a dead link with a web-archived one ([#5738]({{ site.repository }}/issues/5738))
- Remove duplicate paragraph. ([#5740]({{ site.repository }}/issues/5740))
- Addition of a sample "typical post" ([#5473]({{ site.repository }}/issues/5473))
- Fix a minor grammatical mistake on themes' document ### -dev ([#5748]({{ site.repository }}/issues/5748))
- Correct comments in data_reader.rb ([#5621]({{ site.repository }}/issues/5621))
- Add jekyll-pre-commit to plugins list ([#5752]({{ site.repository }}/issues/5752))
- Update quickstart.md ([#5758]({{ site.repository }}/issues/5758))
- Correct minor typo ([#5764]({{ site.repository }}/issues/5764))
- Fix a markdown link to look properly on the web ([#5769]({{ site.repository }}/issues/5769))
- [docs] Info about the help command usage ([#5312]({{ site.repository }}/issues/5312))
- Add missing merge labels for jekyllbot ([#5753]({{ site.repository }}/issues/5753))
- Fix broken links in documentation ([#5736]({{ site.repository }}/issues/5736))
- Docs: add `match_regex` and `replace_regex` filters ([#5799]({{ site.repository }}/issues/5799))
- Got that diaper money? ([#5810]({{ site.repository }}/issues/5810))
- Sort content by popularity using Google Analytics ([#5812]({{ site.repository }}/issues/5812))
- Rework CI doc to include multiple providers. ([#5815]({{ site.repository }}/issues/5815))
- Improve theme docs ([#5690]({{ site.repository }}/issues/5690))
- Add mention of classifier-reborn for LSI ([#5811]({{ site.repository }}/issues/5811))
- Added note about --blank flag ([#5802]({{ site.repository }}/issues/5802))
- Fixed inaccuracy in "Built-in permalink styles" docs ([#5819]({{ site.repository }}/issues/5819))
## 3.3.1 / 2016-11-14
{: #v3-3-1}
### Minor Enhancements
{: #minor-enhancements-v3-3-1}
- Collapse `gsub` for performance ([#5494]({{ site.repository }}/issues/5494))
- URL: warn if key doesn't exist in url drop ([#5524]({{ site.repository }}/issues/5524))
### Bug Fixes
{: #bug-fixes-v3-3-1}
- Fix typo in `theme_template` README ([#5472]({{ site.repository }}/issues/5472))
- Do not swallow all exceptions on render ([#5495]({{ site.repository }}/issues/5495))
- Site template: fixed `_config.yml` comment typo ([#5511]({{ site.repository }}/issues/5511))
- `jekyll new-theme` should specify Jekyll as a runtime dependency for the theme ([#5457]({{ site.repository }}/issues/5457))
- Be much more specific about ignoring specific vendored directories. ([#5564]({{ site.repository }}/issues/5564))
- Only warn about auto-regeneration bug on Bash On Windows. ([#5464]({{ site.repository }}/issues/5464))
- Allow permalink template to have underscores ([#5572]({{ site.repository }}/issues/5572))
### Site Enhancements
{: #site-enhancements-v3-3-1}
- Documentation: `link` Liquid tag ([#5449]({{ site.repository }}/issues/5449))
- Updating install instruction link for Jekyll 3 on Windows ([#5475]({{ site.repository }}/issues/5475))
- Update normalize.css to v5.0.0 ([#5471]({{ site.repository }}/issues/5471))
- Add jekyll-data to the list of plugins ([#5491]({{ site.repository }}/issues/5491))
- Add info about checking version + updating ([#5497]({{ site.repository }}/issues/5497))
- Add jekyll-include-absolute-plugin to list of third-party plugins ([#5492]({{ site.repository }}/issues/5492))
- Remove jekyll-hook from deployment methods ([#5502]({{ site.repository }}/issues/5502))
- Update deployment-methods.md ([#5504]({{ site.repository }}/issues/5504))
- Ubuntu users should install ruby2.3-dev ([#5512]({{ site.repository }}/issues/5512))
- Remove Glynn as deployment option ([#5519]({{ site.repository }}/issues/5519))
- Fix broken forum link ([#5466]({{ site.repository }}/issues/5466))
- Move documentation to docs folder ([#5459]({{ site.repository }}/issues/5459))
- Fix broken links in CONTRIBUTING ([#5533]({{ site.repository }}/issues/5533))
- Update documentation on jekyllrb.com ([#5540]({{ site.repository }}/issues/5540))
- Fix HTML rendering ([#5536]({{ site.repository }}/issues/5536))
- Remove outdated deployment information ([#5557]({{ site.repository }}/issues/5557))
- no more invalid US-ASCII on lines 30 and 97 ([#5520]({{ site.repository }}/issues/5520))
- Add permalinks to docs in '/maintaining/' ([#5532]({{ site.repository }}/issues/5532))
- Add jekyll-pinboard to list of third-party plugins ([#5514]({{ site.repository }}/issues/5514))
- Fix formatting in 2-to-3.md ([#5507]({{ site.repository }}/issues/5507))
- Add two plugins to the plugins page ([#5493]({{ site.repository }}/issues/5493))
- Use site.baseurl before link and post_url tags ([#5559]({{ site.repository }}/issues/5559))
- Fix link to jekyll-pinboard plugin ([#5570]({{ site.repository }}/issues/5570))
- mention `docs` folder as a way to deploy on GitHub Pages ([#5571]({{ site.repository }}/issues/5571))
### Development Fixes
{: #development-fixes-v3-3-1}
- fix rubocop errors on testing with Rubocop 0.44 ([#5489]({{ site.repository }}/issues/5489))
- script/test: add missing whitespace ([#5479]({{ site.repository }}/issues/5479))
- Restrict Rubocop version ([#5496]({{ site.repository }}/issues/5496))
- include a hashbang for all benchmark scripts & make them executable ([#5505]({{ site.repository }}/issues/5505))
- Update source in script/proof ([#5538]({{ site.repository }}/issues/5538))
- Collections.feature: conditional steps to have it pass on Windows ([#5546]({{ site.repository }}/issues/5546))
- Fix tests to get script/test to pass on Windows ([#5526]({{ site.repository }}/issues/5526))
## 3.3.0 / 2016-10-06
{: #v3-3-0}

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

@@ -0,0 +1,167 @@
---
title: Includes
permalink: /docs/includes/
---
The `include` tag allows you to include the content from another file stored in the `_includes` folder:
```liquid
{% raw %}{% 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:
```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.
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:
```liquid
{% raw %}{% include {{ page.my_variable }} %}{% endraw %}
```
In this example, the include would insert the file `footer_company_a.html` from the `_includes/footer_company_a.html` directory.
### Passing parameters to includes
You can also pass parameters to an include. For example, suppose you have a file called `note.html` in your `_includes` folder that contains this formatting:
```liquid
{% raw %}<div markdown="span" class="alert alert-info" role="alert">
<i class="fa fa-info-circle"></i> <b>Note:</b>
{{ include.content }}
</div>{% endraw %}
```
The `{% raw %}{{ include.content }}{% endraw %}` is a parameter that gets populated when you call the include and specify a value for that parameter, like this:
```liquid
{% raw %}{% include note.html content="This is my sample note." %} {% endraw %}
```
The value of `content` (which is `This is my sample note`) will be inserted into the {% raw %}`{{ include.content }}`{% endraw %} parameter.
Passing parameters to includes is especially helpful when you want to hide away complex formatting from your Markdown content.
For example, suppose you have a special image syntax with complex formatting, and you don't want your authors to remember the complex formatting. As a result, you decide to simplify the formatting by using an include with parameters. Here's an example of the special image syntax you might want to populate with an include:
```html
<figure>
<a href="http://jekyllrb.com">
<img src="logo.png" style="max-width: 200px;"
alt="Jekyll logo" />
<figcaption>This is the Jekyll logo</figcaption>
</figure>
```
You could templatize this content in your include and make each value available as a parameter, like this:
```liquid
{% raw %}<figure>
<a href="{{ include.url }}">
<img src="{{ include.file }}" style="max-width: {{ include.max-width }};"
alt="{{ include.alt }}"/>
<figcaption>{{ include.caption }}</figcaption>
</figure>{% endraw %}
```
This include contains 5 parameters:
* `url`
* `max-width`
* `file`
* `alt`
* `caption`
Here's an example that passes all the parameters to this include (the include file is named `image.html`):
```liquid
{% raw %}{% include image.html url="http://jekyllrb.com"
max-width="200px" file="logo.png" alt="Jekyll logo"
caption="This is the Jekyll logo." %} {% endraw %}
```
The result is the original HTML code shown earlier.
To safeguard situations where users don't supply a value for the parameter, you can use [Liquid's default filter](https://help.shopify.com/themes/liquid/filters/additional-filters#default).
Overall, you can create includes that act as templates for a variety of uses &mdash; inserting audio or video clips, alerts, special formatting, and more. However, note that you should avoid using too many includes, as this will slow down the build time of your site. For example, don't use includes every time you insert an image. (The above technique shows a use case for special images.)
### Passing parameter variables to includes
Suppose the parameter you want to pass to the include is a variable rather than a string. For example, you might be using {% raw %}`{{ site.product_name }}`{% endraw %} to refer to every instance of your product rather than the actual hard-coded name. (In this case, your `_config.yml` file would have a key called `product_name` with a value of your product's name.)
The string you pass to your include parameter can't contain curly braces. For example, you can't pass a parameter that contains this: {% raw %}`"The latest version of {{ site.product_name }} is now available."`{% endraw %}
If you want to include this variable in your parameter that you pass to an include, you need to store the entire parameter as a variable before passing it to the include. You can use `capture` tags to create the variable:
```liquid
{% raw %}{% capture download_note %}The latest version of
{{ site.product_name }} is now available.{% endcapture %}{% endraw %}
```
Then pass this captured variable into the parameter for the include. Omit the quotation marks around the parameter content because it's no longer a string (it's a variable):
```liquid
{% raw %}{% include note.html content=download_note %}{% endraw %}
```
### Passing references to YAML files as parameter values
Instead of passing string variables to the include, you can pass a reference to a YAML data file stored in the `_data` folder.
Here's an example. In the `_data` folder, suppose you have a YAML file called `profiles.yml`. Its content looks like this:
```yaml
- name: John Doe
login_age: old
image: johndoe.jpg
- name: Jane Doe
login_age: new
image: janedoe.jpg
```
In the `_includes` folder, assume you have a file called `spotlight.html` with this code:
```liquid
{% raw %}{% for person in {{ include.participants }} %}
{% if person.login_age == "new" %}
{{ person.name }}
{% endif %}
{% endfor %}{% endraw %}
```
Now when you insert the `spotlight.html` include file, you can submit the YAML file as a parameter:
```
{% raw %}{% include spotlight.html participants=site.data.profiles %}{% endraw %}
```
In this instance, `site.data.profiles` gets inserted in place of {% raw %}`{{ include.participants }}`{% endraw %} in the include file, and the Liquid logic processes. The result will be `Jane Doe`.

View File

@@ -1,5 +1,4 @@
---
layout: docs
title: Welcome
permalink: /docs/home/
redirect_from: /docs/index.html

View File

@@ -1,5 +1,4 @@
---
layout: docs
title: Installation
permalink: /docs/installation/
---
@@ -21,6 +20,7 @@ requirements youll need to make sure your system has before you start.
- [NodeJS](https://nodejs.org/), or another JavaScript runtime (Jekyll 2 and
earlier, for CoffeeScript support).
- [Python 2.7](https://www.python.org/downloads/) (for Jekyll 2 and earlier)
- [GCC](https://gcc.gnu.org/install/) and [Make](https://www.gnu.org/software/make/) (in case your system doesn't have them installed, which you can check by running `gcc -v` and `make -v` in your system's command line interface)
<div class="note info">
<h5>Running Jekyll on Windows</h5>
@@ -34,7 +34,7 @@ earlier, for CoffeeScript support).
## Install with RubyGems
The best way to install Jekyll is via
[RubyGems](http://rubygems.org/pages/download). At the terminal prompt,
[RubyGems](https://rubygems.org/pages/download). At the terminal prompt,
simply run the following command to install Jekyll:
```sh

View File

@@ -1,6 +1,9 @@
# Affinity Team Captains
---
title: Affinity Team Captains
---
**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.
{: .note .info }
## Affinity teams & their captains

View File

@@ -1,6 +1,9 @@
# Maintainers: Avoiding Burnout
---
title: "Avoiding Burnout"
---
**This guide is for maintainers.** These special people have **write access** to one or more of Jekyll's repositories and help merge the contributions of others. You may find what is written here interesting, but its definitely not for everyone.
{: .note .info }
# 1. Use Jekyll
@@ -24,4 +27,4 @@ Jekyll gets a lot of feature requests, non-reproducible bug reports, usage quest
Thanks to https://gist.github.com/ryanflorence/124070e7c4b3839d4573 which influenced this document.
Thanks to [Homebrew's "Avoiding Burnout" document](https://github.com/Homebrew/brew/blob/master/share/doc/homebrew/Maintainers-Avoiding-Burnout.md) for providing a perfect base for this document.
Thanks to [Homebrew's "Avoiding Burnout" document](https://github.com/Homebrew/brew/blob/master/docs/Maintainers-Avoiding-Burnout.md) for providing a perfect base for this document.

View File

@@ -1,6 +1,9 @@
# Contributors: Becoming a Maintainer
---
title: "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.
{: .note .info }
So you want to become a maintainer of a Jekyll project? We'd love to have you! Here are some things we like to see from community members before we promote them to maintainers.
@@ -10,7 +13,7 @@ You want to maintain Jekyll? Use it often. Do weird things with it. Do normal th
## 2. Help Triage Issues
Watch the repository you're interested in. Join [an Affinity Team](https://teams.jekyllrb.com) and receive mentions regarding a particular interest area of the project. When you receive a notification for an issue that has not been triaged by a maintainer, dive in. Can you reproduce the issue? Can you determine the fix? [More tips on Triaging an Issue in our maintainer guide](triaging-an-issue.md). Every maintainer loves an issue that is resolved before they get to it. :smiley:
Watch the repository you're interested in. Join [an Affinity Team](https://teams.jekyllrb.com) and receive mentions regarding a particular interest area of the project. When you receive a notification for an issue that has not been triaged by a maintainer, dive in. Can you reproduce the issue? Can you determine the fix? [More tips on Triaging an Issue in our maintainer guide](../triaging-an-issue). Every maintainer loves an issue that is resolved before they get to it. :smiley:
## 3. Write Documentation
@@ -22,7 +25,7 @@ As a maintainer, you will be reviewing pull requests which update code. You shou
## 5. Review Pull Requests
Start by reviewing one pull request a week. Leave detailed comments and [follow our guide for reviewing pull requests](reviewing-a-pull-request.md).
Start by reviewing one pull request a week. Leave detailed comments and [follow our guide for reviewing pull requests](../reviewing-a-pull-request).
## 6. Ask!
@@ -32,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://help.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

@@ -0,0 +1,20 @@
---
title: Maintaining Jekyll
permalink: /docs/maintaining/
---
**This guide is for Jekyll contributors and maintainers.** These special people contribute to one or more of Jekyll's repositories or help merge the contributions of others. You may find what is written here interesting, but its definitely not for everyone.
{: .note .info }
Hello! This is where we document various processes for maintaining Jekyll. Being a maintainer for any Jekyll project is a big responsibility, so we put together some helpful documentation for various tasks you might do as a maintainer.
1. [Affinity teams & their captains](affinity-team-captain/)
2. [Triaging and issue](triaging-an-issue/)
3. [Reviewing a pull request](reviewing-a-pull-request/)
4. [Merging a pull request](merging-a-pull-request/)
5. [Avoiding burnout](avoiding-burnout/)
6. [Special Labels](special-labels/)
Interested in becoming a maintainer? Here is some documentation for **contributors**:
1. [Becoming a maintainer](becoming-a-maintainer/)

View File

@@ -1,12 +1,15 @@
# Maintainers: Merging a Pull Request
---
title: "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.
{: .note .info }
## Code Review
All pull requests should be subject to code review. Code review is a [foundational value](https://blog.fullstory.com/what-we-learned-from-google-code-reviews-arent-just-for-catching-bugs-b125a13aa292) of good engineering teams. Besides providing validation of correctness, it promotes a sense of community and gives other maintainers understanding of all parts of the code base. In short, code review is crucial to a healthy open source project.
**Read our guide for [Reviewing a pull request](reviewing-a-pull-request.md) before merging.** Notably, the change must have tests if for code, and at least two maintainers must give it an OK.
**Read our guide for [Reviewing a pull request](../reviewing-a-pull-request) before merging.** Notably, the change must have tests if for code, and at least two maintainers must give it an OK.
## Merging
@@ -34,8 +37,10 @@ The categories match the H3's in the history/changelog file, and they are:
1. Major Enhancements (`+major`) major updates or breaking changes to the code which necessitate a major version bump (v3 ~> v4)
2. Minor Enhancements (`+minor`) minor updates (feature, enhancement) which necessitate a minor version bump (v3.1 ~> v3.2)
3. Bug Fixes (`+bug`) corrections to code which do not change or add functionality, which necessitate a patch version bump (v3.1.0 ~> v3.1.1)
4. Site Enhancements (`+site`) changes to the source of https://jekyllrb.com, found in `site/`
5. Development Fixes (`+dev`) changes which do not affect user-facing functionality or documentation, such as test fixes or bumping internal dependencies
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

@@ -1,10 +1,13 @@
# Maintainers: Reviewing a Pull Request
---
title: "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.
{: .note .info }
## Respond Kindly
Above all else, please review a pull request kindly. Our community can only be strong if we make it a welcoming and inclusive environment. To further promote this, the Jekyll community is governed by a [Code of Conduct](../CONDUCT.markdown) by which all community members must abide.
Above all else, please review a pull request kindly. Our community can only be strong if we make it a welcoming and inclusive environment. To further promote this, the Jekyll community is governed by a [Code of Conduct](/docs/conduct/) by which all community members must abide.
Use emoji liberally :heart: :tada: :sparkles: :confetti_ball: and feel free to be emotive!! Contributions keep this project moving forward and we're always happy to receive them, even if the pull request isn't ultimately merged.
@@ -41,4 +44,3 @@ A pull request may be merged once two maintainers have reviewed the pull request
## Think Security
We owe it to our users to ensure that using a theme from the community or building someone else's site doesn't come with built-in security vulnerabilities. Things like where files may be read from and written to are important to keep secure. Jekyll is also the basis for hosted services such as [GitHub Pages](https://pages.github.com), which cannot upgrade when security issues are introduced.

View File

@@ -1,6 +1,9 @@
# Maintainers: Special Labels
---
title: "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.
{: .note .info }
We use a series of "special labels" on GitHub.com to automate handling of some parts of the pull request and issue process. @jekyllbot may automatically apply or remove certain labels based on actions taken by users or maintainers. Below are the labels and how they work:
@@ -14,4 +17,4 @@ 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.md#staleness-and-automatic-closure).
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).

View File

@@ -1,6 +1,9 @@
# Maintainers: Triaging an Issue
---
title: "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.
{: .note .info }
Before evaluating an issue, it is important to identify if it is a feature
request or a bug. For the Jekyll project the following definitions are used

View File

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

74
docs/_docs/pages.md Normal file
View File

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

View File

@@ -1,5 +1,4 @@
---
layout: docs
title: Pagination
permalink: /docs/pagination/
---

367
docs/_docs/permalinks.md Normal file
View File

@@ -0,0 +1,367 @@
---
title: Permalinks
permalink: /docs/permalinks/
---
Permalinks refer to the URLs (excluding the domain name or directory folder) for your pages, posts, or collections.
Jekyll supports a flexible way to build permalinks, allowing you to leverage various template variables or choose built-in permalink styles (such as `date`) that automatically use a template-variable pattern.
You construct permalinks by creating a template URL where dynamic elements are represented by colon-prefixed keywords. The default template permalink is `/:categories/:year/:month/:day/:title.html`. Each of the colon-prefixed keywords is a template variable.
## 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.html
```
If you don't specify any permalink setting, Jekyll uses the above pattern as the default.
The permalink can also be set using a built-in permalink style:
```yaml
permalink: date
```
`date` is the same as `:categories/:year/:month/:day/:title.html`, the default. See [Built-in Permalink Styles](#builtinpermalinkstyles) below for more options.
Setting the permalink in your post, page, or collection's front matter overrides any global settings. Here's an example:
```yaml
---
title: My page title
permalink: /mypageurl/
---
```
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>
<thead>
<tr>
<th>Variable</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<p><code>year</code></p>
</td>
<td>
<p>Year from the post's filename</p>
</td>
</tr>
<tr>
<td>
<p><code>month</code></p>
</td>
<td>
<p>Month from the post's filename</p>
</td>
</tr>
<tr>
<td>
<p><code>i_month</code></p>
</td>
<td>
<p>Month from the post's filename without leading zeros.</p>
</td>
</tr>
<tr>
<td>
<p><code>day</code></p>
</td>
<td>
<p>Day from the post's filename</p>
</td>
</tr>
<tr>
<td>
<p><code>i_day</code></p>
</td>
<td>
<p>Day from the post's filename without leading zeros.</p>
</td>
</tr>
<tr>
<td>
<p><code>short_year</code></p>
</td>
<td>
<p>Year from the post's filename without the century.</p>
</td>
</tr>
<tr>
<td>
<p><code>hour</code></p>
</td>
<td>
<p>
Hour of the day, 24-hour clock, zero-padded from the post's <code>date</code> front matter. (00..23)
</p>
</td>
</tr>
<tr>
<td>
<p><code>minute</code></p>
</td>
<td>
<p>
Minute of the hour from the post's <code>date</code> front matter. (00..59)
</p>
</td>
</tr>
<tr>
<td>
<p><code>second</code></p>
</td>
<td>
<p>
Second of the minute from the post's <code>date</code> front matter. (00..59)
</p>
</td>
</tr>
<tr>
<td>
<p><code>title</code></p>
</td>
<td>
<p>
Title from the documents filename. May be overridden via
the documents <code>slug</code> YAML front matter.
</p>
</td>
</tr>
<tr>
<td>
<p><code>slug</code></p>
</td>
<td>
<p>
Slugified title from the documents filename (any character
except numbers and letters is replaced as hyphen). May be
overridden via the documents <code>slug</code> YAML front matter.
</p>
</td>
</tr>
<tr>
<td>
<p><code>categories</code></p>
</td>
<td>
<p>
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.
</p>
</td>
</tr>
</tbody>
</table>
</div>
Note that all template variables relating to time or categories are available to posts only.
## 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>
<thead>
<tr>
<th>Permalink Style</th>
<th>URL Template</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<p><code>date</code></p>
</td>
<td>
<p><code>/:categories/:year/:month/:day/:title.html</code></p>
</td>
</tr>
<tr>
<td>
<p><code>pretty</code></p>
</td>
<td>
<p><code>/:categories/:year/:month/:day/:title/</code></p>
</td>
</tr>
<tr>
<td>
<p><code>ordinal</code></p>
</td>
<td>
<p><code>/:categories/:year/:y_day/:title.html</code></p>
</td>
</tr>
<tr>
<td>
<p><code>none</code></p>
</td>
<td>
<p><code>/:categories/:title.html</code></p>
</td>
</tr>
</tbody>
</table>
</div>
Rather than typing `permalink: /:categories/:year/:month/:day/:title/`, you can just type `permalink: pretty`.
<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>
## Permalink style examples with posts {#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`
<div class="mobile-side-scroller">
<table>
<thead>
<tr>
<th>URL Template</th>
<th>Resulting Permalink URL</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<p>None specified, or <code>permalink: date</code></p>
</td>
<td>
<p><code>/2009/04/29/slap-chop.html</code></p>
</td>
</tr>
<tr>
<td>
<p><code>pretty</code></p>
</td>
<td>
<p><code>/2009/04/29/slap-chop/</code></p>
</td>
</tr>
<tr>
<td>
<p><code>/:month-:day-:year/:title.html</code></p>
</td>
<td>
<p><code>/04-29-2009/slap-chop.html</code></p>
</td>
</tr>
<tr>
<td>
<p><code>/blog/:year/:month/:day/:title/</code></p>
</td>
<td>
<p><code>/blog/2009/04/29/slap-chop/</code></p>
</td>
</tr>
<tr>
<td>
<p><code>/:year/:month/:title</code></p>
<p>See <a href="#extensionless-permalinks">Extensionless permalinks with no trailing slashes</a> for details.</p>
</td>
<td>
<p><code>/2009/04/slap-chop</code></p>
</td>
</tr>
</tbody>
</table>
</div>
## Permalink settings for pages and collections {#pages-and-collections}
The permalink setting in your configuration file specifies the permalink style used for posts, pages, and collections. However, because pages and collections don't have time or categories, these aspects of the permalink style are ignored with pages and collections.
For example:
* A permalink style of `/:categories/:year/:month/:day/:title.html` for posts becomes `/:title.html` for pages and collections.
* A permalink style of `pretty` (or `/:categories/:year/:month/:day/:title/`), which omits the file extension and contains a trailing slash, will update page and collection permalinks to also omit the file extension and contain a trailing slash: `/:title/`.
* A permalink style of `date`, which contains a trailing file extension, will update page permalinks to also contain a trailing file extension: `/:title.html`. But no time or category information will be included.
## Permalinks and default paths
The path to the post or page in the built site differs for posts, pages, and collections:
### Posts
The subfolders into which you may have organized your posts inside the `_posts` directory will not be part of the permalink.
If you use a permalink style that omits the `.html` file extension, each post is rendered as an `index.html` file inside a folder with the post's name (for example, `categoryname/2016/12/01/mypostname/index.html`).
### Pages
Unlike posts, pages by default mimic the source directory structure exactly. (The only exception is if your page has a `permalink` declared its front matter &mdash; in that case, the structure honors the permalink setting instead of the source folder structure.)
As with posts, if you use a permalink style that omits the `.html` file extension, each page is rendered as an `index.html` file inserted inside a folder with the page's name (for example, `mypage/index.html`).
### Collections
By default, collections follow a similar structure in the `_site` folder as pages, except that the path is prefaced by the collection name. For example: `collectionname/mypage.html`. For permalink settings that omit the file extension, the path would be `collection_name/mypage/index.html`.
Collections have their own way of setting permalinks. Additionally, collections have unique template variables available available (such as `path` and `output_ext`). See the [Configuring permalinks for collections](../collections/#permalinks) in Collections for more information.
## Flattening pages in \_site on build
If you want to flatten your pages (pull them out of subfolders) in the `_site` directory when your site builds (similar to posts), add the `permalink` property to the front matter of each page, with no path specified:
```
---
title: My page
permalink: mypageurl.html
---
```
## Extensionless permalinks with no trailing slashes {#extensionless-permalinks}
Jekyll supports permalinks that contain neither a trailing slash nor a file extension, but this requires additional support from the web server to properly serve. When using these types of permalinks, output files written to disk will still have the proper file extension (typically `.html`), so the web server must be able to map requests without file extensions to these files.
Both [GitHub Pages](../github-pages/) and the Jekyll's built-in WEBrick server handle these requests properly without any additional work.
### Apache
The Apache web server has extensive support for content negotiation and can handle extensionless URLs by setting the [multiviews](https://httpd.apache.org/docs/current/content-negotiation.html#multiviews) option in your `httpd.conf` or `.htaccess` file:
{% highlight apache %}
Options +MultiViews
{% endhighlight %}
### Nginx
The [try_files](http://nginx.org/en/docs/http/ngx_http_core_module.html#try_files) directive allows you to specify a list of files to search for to process a request. The following configuration will instruct nginx to search for a file with an `.html` extension if an exact match for the requested URI is not found.
{% highlight nginx %}
try_files $uri $uri.html $uri/ =404;
{% endhighlight %}
## Linking without regard to permalink styles
You can create links in your topics to other posts, pages, or collection items in a way that is valid no matter what permalink configuration you choose. By using the `link` tag, if you change your permalinks, your links won't break. See [Linking to pages](../templates#link) in Templates for more details.

View File

@@ -1,5 +1,4 @@
---
layout: docs
title: Plugins
permalink: /docs/plugins/
---
@@ -754,6 +753,7 @@ 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.
#### Converters
@@ -771,7 +771,6 @@ LESS.js files during generation.
- [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.
@@ -783,7 +782,7 @@ 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.
@@ -804,6 +803,10 @@ LESS.js files during generation.
- [jekyll-roman](https://github.com/paulrobertlloyd/jekyll-roman): A liquid filter for Jekyll that converts numbers into Roman numerals.
- [jekyll-typogrify](https://github.com/myles/jekyll-typogrify): A Jekyll plugin that brings the functions of [typogruby](http://avdgaag.github.io/typogruby/).
- [Jekyll Email Protect](https://github.com/vwochnik/jekyll-email-protect): Email protection liquid filter for Jekyll
- [Jekyll Uglify Filter](https://github.com/mattg/jekyll-uglify-filter): A Liquid filter that runs your JavaScript through UglifyJS.
- [match_regex](https://github.com/sparanoid/match_regex): A Liquid filter to perform regex match.
- [replace_regex](https://github.com/sparanoid/replace_regex): A Liquid filter to perform regex replace.
- [Jekyll Money](https://rubygems.org/gems/jekyll-money): A Jekyll plugin for dealing with money. Because we all have to at some point.
#### Tags
@@ -833,7 +836,7 @@ LESS.js files during generation.
- [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,14 +846,14 @@ LESS.js files during generation.
- [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/)
- [Lychee Gallery Tag](https://gist.github.com/tobru/9171700) by [tobru](https://github.com/tobru): Include [Lychee](https://lychee.electerious.com/) albums into a post. For an introduction, see [Jekyll meets Lychee - A Liquid Tag plugin](https://tobrunet.ch/articles/jekyll-meets-lychee-a-liquid-tag-plugin/)
- [Image Set/Gallery Tag](https://github.com/callmeed/jekyll-image-set) by [callmeed](https://github.com/callmeed): Renders HTML for an image gallery from a folder in your Jekyll site. Just pass it a folder name and class/tag options.
- [jekyll_figure](https://github.com/lmullen/jekyll_figure): Generate figures and captions with links to the figure in a variety of formats
- [Jekyll GitHub Sample Tag](https://github.com/bwillis/jekyll-github-sample): A liquid tag to include a sample of a github repo file in your Jekyll site.
- [Jekyll Project Version Tag](https://github.com/rob-murray/jekyll-version-plugin): A Liquid tag plugin that renders a version identifier for your Jekyll site sourced from the git repository containing your code.
- [Piwigo Gallery](https://github.com/AlessandroLorenzi/piwigo_gallery) by [Alessandro Lorenzi](http://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.
@@ -867,11 +870,12 @@ LESS.js files during generation.
- [Jekyll Maps](https://github.com/ayastreb/jekyll-maps) by [Anatoliy Yastreb](https://github.com/ayastreb): A Jekyll plugin to easily embed maps with filterable locations.
- [Jekyll Cloudinary](https://nhoizey.github.io/jekyll-cloudinary/) by [Nicolas Hoizey](https://nicolas-hoizey.com/): a Jekyll plugin adding a Liquid tag to ease the use of Cloudinary for responsive images in your Markdown/Kramdown posts.
- [jekyll-include-absolute-plugin](https://github.com/tnhu/jekyll-include-absolute-plugin) by [Tan Nhu](https://github.com/tnhu): A Jekyll plugin to include a file from its path relative to Jekyll's source folder.
- [Jekyll Download Tag](https://github.com/mattg/jekyll-download-tag): A Liquid tag that acts like `include`, but for external resources.
#### Collections
- [Jekyll Plugins by Recursive Design](https://github.com/recurser/jekyll-plugins): Plugins to generate Project pages from GitHub readmes, a Category page, and a Sitemap generator.
- [Company website and blog plugins](https://github.com/flatterline/jekyll-plugins) by Flatterline, a [Ruby on Rails development company](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
@@ -890,7 +894,7 @@ LESS.js files during generation.
- [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.
@@ -914,6 +918,11 @@ LESS.js files during generation.
- [Jekyll-Spotify](https://github.com/MertcanGokgoz/Jekyll-Spotify): Easily output Spotify Embed Player for jekyll
- [jekyll-menus](https://github.com/forestryio/jekyll-menus): Hugo style menus for your Jekyll site... recursive menus included.
- [jekyll-data](https://github.com/ashmaroli/jekyll-data): Read data files within Jekyll Theme Gems.
- [jekyll-pinboard](https://github.com/snaptortoise/jekyll-pinboard-plugin): Access your Pinboard bookmarks within your Jekyll theme.
- [jekyll-migrate-permalink](https://github.com/mpchadwick/jekyll-migrate-permalink): Adds a `migrate-permalink` sub-command to help deal with side effects of changing your permalink.
- [Jekyll-Post](https://github.com/robcrocombe/jekyll-post): A CLI tool to easily draft, edit, and publish Jekyll posts.
- [jekyll-numbered-headings](https://github.com/muratayusuke/jekyll-numbered-headings): Adds ordered number to headings.
- [jekyll-pre-commit](https://github.com/mpchadwick/jekyll-pre-commit): A framework for running checks against your posts using a git pre-commit hook before you publish them.
#### Editors

View File

@@ -1,5 +1,4 @@
---
layout: docs
title: Writing posts
permalink: /docs/posts/
---
@@ -111,6 +110,24 @@ Linking to a PDF for readers to download:
</p>
</div>
## A typical post
Jekyll can handle many different iterations of the idea you might associate with a "post," however a standard blog style post, including an Title, Layout, Publishing Date, and Categories might look like this:
```
---
layout: post
title: "Welcome to Jekyll!"
date: 2015-11-17 16:16:01 -0600
categories: jekyll update
---
Youll find this post in your `_posts` directory. Go ahead and edit it and re-build the site to see your changes. You can rebuild the site in many different ways, but the most common way is to run `bundle exec jekyll serve`, which launches a web server and auto-regenerates your site when a file is updated.
To add new posts, simply add a file in the `_posts` directory that follows the convention `YYYY-MM-DD-name-of-post.ext` and includes the necessary front matter. Take a look at the source for this post to get an idea about how it works.
```
Everything in between the first and second `---` are part of the YAML Front Matter, and everything after the second `---` will be rendered with Markdown and show up as "Content."
## Displaying an index of posts
Its all well and good to have posts in a folder, but a blog is no use unless

51
docs/_docs/quickstart.md Normal file
View File

@@ -0,0 +1,51 @@
---
title: Quick-start guide
permalink: /docs/quickstart/
---
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
# 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
~/myblog $ bundle exec jekyll serve
# Now browse to http://localhost:4000
```
If you encounter any unexpected errors during the above, please refer to the already-mentioned [requirements](/docs/installation/#requirements/) page, as you might be missing development headers or other prerequisites.
## About Bundler
`gem install jekyll bundler` installs the [jekyll](https://rubygems.org/gems/jekyll/) and [bundler](https://rubygems.org/gems/bundler) gems through [RubyGems](https://rubygems.org/). You need only to install the gems one time &mdash; not every time you create a new Jekyll project. Here are some additional details:
* `bundler` is a gem that manages other Ruby gems. It makes sure your gems and gem versions are compatible, and that you have all necessary dependencies each gem requires.
* The `Gemfile` and `Gemfile.lock` files inform Bundler about the gem requirements in your site. If your site doesn't have these Gemfiles, you can omit `bundle exec` and just run `jekyll serve`.
* When you run `bundle exec jekyll serve`, Bundler uses the gems and versions as specified in `Gemfile.lock` to ensure your Jekyll site builds with no compatibility or dependency conflicts.
## 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,5 +1,4 @@
---
layout: docs
title: Resources
permalink: /docs/resources/
---
@@ -9,19 +8,19 @@ Jekylls growing use is producing a wide variety of tutorials, frameworks, ext
### Useful Guides
- [Jekyll Tips](http://jekyll.tips) is a set of resources created by [CloudCannon](https://cloudcannon.com) to help folks get up and running with Jekyll. They cover all skill levels, and even include some great video tutorials.
- [Jekyll Cheatsheet](http://cheat.jekyll.tips) is a single-page resource for Jekyll filters, variables, and the like.
- [Jekyll Cheatsheet](http://jekyll.tips/jekyll-cheat-sheet/) is a single-page resource for Jekyll filters, variables, and the like.
- [“Creating and Hosting a Personal Site on GitHub”](http://jmcglone.com/guides/github-pages/)
- [Build A Blog With Jekyll And GitHub Pages on Smashing Magazine](http://www.smashingmagazine.com/2014/08/01/build-blog-jekyll-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
- Use a saas service as a backend for forms (contact forms, hiring forms, etc.)
- [Formspree (also open source)](http://formspree.io/)
- [Formspree (also 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/)

View File

@@ -1,5 +1,4 @@
---
layout: docs
title: Sites using Jekyll
permalink: /docs/sites/
---
@@ -10,9 +9,9 @@ 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))
If you would like to explore more examples, you can find a list of 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>

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>

View File

@@ -1,5 +1,4 @@
---
layout: docs
title: Templates
permalink: /docs/templates/
---
@@ -147,6 +146,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>
@@ -208,7 +223,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 +232,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>
@@ -399,56 +420,15 @@ The default is `default`. They are as follows (with what they filter):
### 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:
```liquid
{% raw %}{% 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
@@ -508,64 +488,6 @@ site. If you use `linenos`, you might want to include an additional CSS class
definition for the `.lineno` class in `syntax.css` to distinguish the line
numbers from the highlighted code.
### Link
If you want to include a link to a collection's document, a post, a page
or a file the `link` tag will generate the correct permalink URL for the path
you specify.
You must include the file extension when using the `link` tag.
```liquid
{% raw %}
{% link _collection/name-of-document.md %}
{% link _posts/2016-07-26-name-of-post.md %}
{% link news/index.html %}
{% link /assets/files/doc.pdf %}
{% endraw %}
```
You can also use this tag to create a link in Markdown as follows:
```liquid
{% raw %}
[Link to a document]({% link _collection/name-of-document.md %})
[Link to a post]({% link _posts/2016-07-26-name-of-post.md %})
[Link to a page]({% link news/index.html %})
[Link to a file]({% link /assets/files/doc.pdf %})
{% endraw %}
```
### Post URL
If you would like to include a link to a post on your site, the `post_url` tag
will generate the correct permalink URL for the post you specify.
```liquid
{% raw %}
{% post_url 2010-07-21-name-of-post %}
{% endraw %}
```
If you organize your posts in subdirectories, you need to include subdirectory
path to the post:
```liquid
{% raw %}
{% post_url /subdir/2010-07-21-name-of-post %}
{% endraw %}
```
There is no need to include the file extension when using the `post_url` tag.
You can also use this tag to create a link to a post in Markdown as follows:
```liquid
{% raw %}
[Name of Link]({% 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
@@ -587,3 +509,71 @@ You may also optionally specify the filename in the gist to display:
To use the `gist` tag, you'll need to add the
[jekyll-gist](https://github.com/jekyll/jekyll-gist) gem to your project.
## Links
### Linking to pages {#link}
To link to a post, a page, collection item, or file, the `link` tag will generate the correct permalink URL for the path you specify. For example, if you use the `link` tag to link to `mypage.html`, even if you change your permalink style to include the file extension or omit it, the URL formed by the `link` tag will always be valid.
You must include the file's original extension when using the `link` tag. Here are some examples:
```liquid
{% raw %}
{{ site.baseurl }}{% link _collection/name-of-document.md %}
{{ site.baseurl }}{% link _posts/2016-07-26-name-of-post.md %}
{{ site.baseurl }}{% link news/index.html %}
{{ site.baseurl }}{% link /assets/files/doc.pdf %}
{% endraw %}
```
You can also use the `link` tag to create a link in Markdown as follows:
```liquid
{% raw %}
[Link to a document]({{ site.baseurl }}{% link _collection/name-of-document.md %})
[Link to a post]({{ site.baseurl }}{% link _posts/2016-07-26-name-of-post.md %})
[Link to a page]({{ site.baseurl }}{% link news/index.html %})
[Link to a file]({{ site.baseurl }}{% link /assets/files/doc.pdf %})
{% endraw %}
```
(Including `{% raw %}{{ site.baseurl }}{% endraw %}` is optional &mdash; it depends on whether you want to preface the page URL with the `baseurl` value.)
The path to the post, page, or collection is defined as the path relative to the root directory (where your config file is) to the file, not the path from your existing page to the other page.
For example, suppose you're creating a link `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` 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 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.
```liquid
{% raw %}
{{ site.baseurl }}{% post_url 2010-07-21-name-of-post %}
{% endraw %}
```
If you organize your posts in subdirectories, you need to include subdirectory path to the post:
```liquid
{% raw %}
{{ site.baseurl }}{% post_url /subdir/2010-07-21-name-of-post %}
{% endraw %}
```
There is no need to include the file extension when using the `post_url` tag.
You can also use this tag to create a link to a post in Markdown as follows:
```liquid
{% raw %}
[Name of Link]({{ site.baseurl }}{% post_url 2010-07-21-name-of-post %})
{% endraw %}
```

238
docs/_docs/themes.md Normal file
View File

@@ -0,0 +1,238 @@
---
title: Themes
permalink: /docs/themes/
---
Jekyll has an extensive theme system that allows you to leverage community-maintained templates and styles to customize your site's presentation. Jekyll themes package up layouts, includes, and stylesheets in a way that can be overridden by your site's content.
## Understanding gem-based themes
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).
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.
In the case of Minima, you see only the following files in your Jekyll site directory:
```
├── Gemfile
├── Gemfile.lock
├── _config.yml
├── _posts
│ └── 2016-12-04-welcome-to-jekyll.markdown
├── about.md
└── index.md
```
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. However, you can override any of the theme defaults with your own site 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` directory (that is, `_layouts/page.html`).
Jekyll will look first to your site's content before looking to the theme's defaults for any requested file in the following folders:
- `/assets`
- `/_layouts`
- `/_includes`
- `/_sass`
Refer to your selected theme's documentation and source repository for more information on what files you can override.
{: .note .info}
To locate theme's files on your computer:
1. Run `bundle show` followed by the name of the theme's gem, e.g., `bundle show minima` for default Jekyll's theme.
This returns the location of the gem-based theme files. For example, Minima theme's files are 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:
```shell
# 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 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.
## Converting gem-based themes to regular themes
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.
To do this, copy the files from the theme gem's directory into your Jekyll site directory. (For example, copy them to `/myblog` if you created your Jekyll site at `/myblog`. See the previous section for details.)
Then remove references to the theme gem in `Gemfile` and configuration. For example, to remove `minima`:
- 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`:
```sh
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:
```sh
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 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 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.
```
_sass
├── jekyll-theme-awesome.scss
```
Your theme's styles can be included in the user's stylesheet using the `@import` directive.
```css
{% raw %}@import "{{ site.theme }}";{% endraw %}
```
### Documenting your theme
Your theme should include a `/README.md` file, which explains how site authors can install and use your theme. What layouts are included? What includes? Do they need to add anything special to their site's configuration file?
### Adding a screenshot
Themes are visual. Show users what your theme looks like by including a screenshot as `/screenshot.png` within your theme's repository where it can be retrieved programatically. You can also include this screenshot within your theme's documentation.
### Previewing your theme
To preview your theme as you're authoring it, it may be helpful to add dummy content in, for example, `/index.html` and `/page.html` files. This will allow you to use the `jekyll build` and `jekyll serve` commands to preview your theme, just as you'd preview a Jekyll site.
If you do preview your theme locally, be sure to add `/_site` to your theme's `.gitignore` file to prevent the compiled site from also being included when you distribute your theme. {: .info .note}
### Publishing your theme
Themes are published via [RubyGems.org](https://rubygems.org). You 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 `jekyll-theme-awesome` with the name of your theme:
```sh
gem build jekyll-theme-awesome.gemspec
```
2. Next, 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
```
3. 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 & 2 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/
---
@@ -22,7 +21,7 @@ the header files for compiling extension modules for Ruby 2.0.0. This
can be done on Ubuntu or Debian by running:
```sh
sudo apt-get install ruby2.0.0-dev
sudo apt-get install ruby2.3-dev
```
On Red Hat, CentOS, and Fedora systems you can do this by running:

View File

@@ -1,5 +1,4 @@
---
layout: docs
title: Upgrading from 0.x to 2.x
permalink: /docs/upgrading/0-to-2/
---

View File

@@ -1,5 +1,4 @@
---
layout: docs
title: Upgrading from 2.x to 3.x
permalink: /docs/upgrading/2-to-3/
---
@@ -68,7 +67,7 @@ generate when running `jekyll build` or `jekyll serve`.
<div class="note info">
<h5>Future Posts on GitHub Pages</h5>
<p>
An exception to the above rule are GitHub Pages sites, where the `--future` flag remains _enabled_
An exception to the above rule are GitHub Pages sites, where the <code>--future</code> flag remains <em>enabled</em>
by default to maintain historical consistency for those sites.
</p>
</div>
@@ -100,7 +99,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/
---
@@ -60,7 +59,7 @@ $ jekyll serve
$ 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">
@@ -97,5 +96,12 @@ $ 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/
---
@@ -339,7 +338,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,5 +1,4 @@
---
layout: docs
title: Jekyll on Windows
permalink: /docs/windows/
---
@@ -16,8 +15,13 @@ A quick way to install Jekyll is to follow the [installation instructions by Dav
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 instruction by Julian Thilo][windows-installation]. The instructions were written for Ruby 2.0.0, but should work for later
versions [prior to 2.2][hitimes-issue].
Updates in the infrastructure of Ruby may cause SSL errors when attempting to use `gem install` with versions of the RubyGems package older than 2.6. (The RubyGems package installed via the Chocolatey tool is version 2.3) If you have installed an older version, you can update the RubyGems package using the directions [here][ssl-certificate-update].
[ssl-certificate-update]: http://guides.rubygems.org/ssl-certificate-update/#installing-using-update-packages
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].
[windows-installjekyll3]: https://labs.sverrirs.com/jekyll/
## Encoding
@@ -33,8 +37,18 @@ the site generation process. It can be done with the following command:
$ chcp 65001
```
[windows-installation]: http://jekyll-windows.juthilo.com/
[hitimes-issue]: https://github.com/copiousfreetime/hitimes/issues/40
## Timezone Management
Since Windows doesn't have a native source of zoneinfo data, the Ruby Interpreter would not understand IANA Timezones and hence using them had the `TZ` environment variable default to UTC/GMT 00:00.
Though Windows users could alternatively define their blog's timezone by setting the key to use POSIX format of defining timezones, it wasn't as user-friendly when it came to having the clock altered to changing DST-rules.
Jekyll now uses a rubygem to internally configure Timezone based on established [IANA Timezone Database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
While 'new' blogs created with Jekyll v3.4 and greater, will have the following added to their 'Gemfile' by default, existing sites *will* have to update their 'Gemfile' (and installed) to enable development on Windows:
```ruby
# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]
```
## Auto-regeneration
@@ -99,8 +113,8 @@ This gem is also needed in the github-pages and to get it running on Windows x64
```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
@@ -112,7 +126,7 @@ There will be a warning on startup that you should include `gem 'wdm', '>= 0.1.0
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"
[Bundler]: http://bundler.io/ "Ruby Dependencie Manager"
[nokogiriReleases]: https://github.com/sparklemotion/nokogiri/releases "Nokogiri Releases"

View File

@@ -1,5 +1,5 @@
{% if site.gauges_id %}
<!-- Gauges (http://gaug.es/) -->
<!-- Gauges (http://get.gaug.es/) -->
<script>
var _gauges = _gauges || [];
(function() {
@@ -16,7 +16,7 @@
{% 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),

View File

@@ -10,7 +10,7 @@ layout: default
<div class="unit four-fifths">
<article>
<div class="improve right hide-on-mobiles">
<a href="https://github.com/jekyll/jekyll/edit/master/site/{{ page.path }}"><i class="fa fa-pencil"></i> &nbsp;Improve this page</a>
<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 }}

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
@@ -27,5 +26,5 @@ See the [GitHub Release][] page for more a more detailed changelog for this rele
{% endfor %}
[GitHub Release]: {{ site.repository }}/releases/tag/v1.1.1
[gh_pages]: http://pages.github.com
[gh_pages]: https://pages.github.com/
[v1_1_0]: {{ site.repository }}/releases/tag/v1.1.0

View File

@@ -1,5 +1,4 @@
---
layout: news_item
title: "Jekyll 1.0.4 Released"
date: "2013-07-25 09:08:38 +0200"
author: mattr-

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