jekyll-docs 3.3.1 → 3.4.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (125) hide show
  1. checksums.yaml +4 -4
  2. data/site/404.html +3 -3
  3. data/site/community/index.html +5 -5
  4. data/site/css/screen.css +7 -6
  5. data/site/docs/assets/index.html +13 -5
  6. data/site/docs/collections/index.html +132 -29
  7. data/site/docs/conduct/index.html +16 -5
  8. data/site/docs/configuration/index.html +26 -8
  9. data/site/docs/continuous-integration/circleci/index.html +761 -0
  10. data/site/docs/continuous-integration/index.html +25 -245
  11. data/site/docs/continuous-integration/travis-ci/index.html +916 -0
  12. data/site/docs/contributing/index.html +41 -5
  13. data/site/docs/datafiles/index.html +14 -6
  14. data/site/docs/deployment-methods/index.html +17 -7
  15. data/site/docs/drafts/index.html +13 -5
  16. data/site/docs/extras/index.html +17 -6
  17. data/site/docs/frontmatter/index.html +13 -5
  18. data/site/docs/github-pages/index.html +68 -47
  19. data/site/docs/history/index.html +132 -9
  20. data/site/docs/home/index.html +13 -5
  21. data/site/docs/includes/index.html +824 -0
  22. data/site/docs/installation/index.html +16 -6
  23. data/site/docs/maintaining/affinity-team-captain/index.html +16 -5
  24. data/site/docs/maintaining/avoiding-burnout/index.html +16 -5
  25. data/site/docs/maintaining/becoming-a-maintainer/index.html +17 -6
  26. data/site/docs/maintaining/index.html +16 -5
  27. data/site/docs/maintaining/merging-a-pull-request/index.html +21 -6
  28. data/site/docs/maintaining/reviewing-a-pull-request/index.html +16 -5
  29. data/site/docs/maintaining/special-labels/index.html +16 -5
  30. data/site/docs/maintaining/triaging-an-issue/index.html +16 -5
  31. data/site/docs/migrations/index.html +13 -5
  32. data/site/docs/pages/index.html +33 -50
  33. data/site/docs/pagination/index.html +16 -5
  34. data/site/docs/permalinks/index.html +148 -66
  35. data/site/docs/plugins/index.html +39 -14
  36. data/site/docs/posts/index.html +32 -5
  37. data/site/docs/quickstart/index.html +57 -18
  38. data/site/docs/resources/index.html +21 -10
  39. data/site/docs/sites/index.html +18 -7
  40. data/site/docs/static-files/index.html +15 -7
  41. data/site/docs/structure/index.html +47 -32
  42. data/site/docs/templates/index.html +85 -89
  43. data/site/docs/themes/index.html +214 -63
  44. data/site/docs/troubleshooting/index.html +16 -5
  45. data/site/docs/upgrading/0-to-2/index.html +16 -5
  46. data/site/docs/upgrading/2-to-3/index.html +17 -6
  47. data/site/docs/upgrading/index.html +16 -5
  48. data/site/docs/usage/index.html +21 -6
  49. data/site/docs/variables/index.html +14 -6
  50. data/site/docs/windows/index.html +35 -10
  51. data/site/feed.xml +41 -22
  52. data/site/fonts/FontAwesome.eot +0 -0
  53. data/site/fonts/FontAwesome.svg +12 -0
  54. data/site/fonts/FontAwesome.ttf +0 -0
  55. data/site/fonts/FontAwesome.woff +0 -0
  56. data/site/help/index.html +3 -3
  57. data/site/icomoon-selection.json +96 -0
  58. data/site/index.html +3 -3
  59. data/site/latest_version.txt +1 -1
  60. data/site/news/2013/05/05/jekyll-1-0-0-released/index.html +12 -8
  61. data/site/news/2013/05/08/jekyll-1-0-1-released/index.html +11 -7
  62. data/site/news/2013/05/12/jekyll-1-0-2-released/index.html +11 -7
  63. data/site/news/2013/06/07/jekyll-1-0-3-released/index.html +11 -7
  64. data/site/news/2013/07/14/jekyll-1-1-0-released/index.html +11 -7
  65. data/site/news/2013/07/24/jekyll-1-1-1-released/index.html +12 -8
  66. data/site/news/2013/07/25/jekyll-1-0-4-released/index.html +11 -7
  67. data/site/news/2013/07/25/jekyll-1-1-2-released/index.html +11 -7
  68. data/site/news/2013/09/06/jekyll-1-2-0-released/index.html +11 -7
  69. data/site/news/2013/09/14/jekyll-1-2-1-released/index.html +11 -7
  70. data/site/news/2013/10/28/jekyll-1-3-0-rc1-released/index.html +11 -7
  71. data/site/news/2013/11/04/jekyll-1-3-0-released/index.html +11 -7
  72. data/site/news/2013/11/26/jekyll-1-3-1-released/index.html +11 -7
  73. data/site/news/2013/12/07/jekyll-1-4-0-released/index.html +11 -7
  74. data/site/news/2013/12/09/jekyll-1-4-1-released/index.html +11 -7
  75. data/site/news/2013/12/16/jekyll-1-4-2-released/index.html +11 -7
  76. data/site/news/2014/01/13/jekyll-1-4-3-released/index.html +11 -7
  77. data/site/news/2014/03/24/jekyll-1-5-0-released/index.html +11 -7
  78. data/site/news/2014/03/27/jekyll-1-5-1-released/index.html +11 -7
  79. data/site/news/2014/05/06/jekyll-turns-2-0-0/index.html +11 -7
  80. data/site/news/2014/05/08/jekyll-2-0-3-released/index.html +11 -7
  81. data/site/news/2014/06/04/jekyll-stickers-1-dollar-stickermule/index.html +12 -8
  82. data/site/news/2014/06/28/jekyll-turns-21-i-mean-2-1-0/index.html +12 -8
  83. data/site/news/2014/07/01/jekyll-2-1-1-released/index.html +11 -7
  84. data/site/news/2014/07/29/jekyll-2-2-0-released/index.html +11 -7
  85. data/site/news/2014/08/10/jekyll-2-3-0-released/index.html +11 -7
  86. data/site/news/2014/09/09/jekyll-2-4-0-released/index.html +11 -7
  87. data/site/news/2014/11/05/jekylls-midlife-crisis-jekyll-turns-2-5-0/index.html +11 -7
  88. data/site/news/2014/11/09/jekyll-2-5-1-released/index.html +11 -7
  89. data/site/news/2014/11/12/jekyll-2-5-2-released/index.html +11 -7
  90. data/site/news/2014/12/17/alfredxing-welcome-to-jekyll-core/index.html +12 -8
  91. data/site/news/2014/12/22/jekyll-2-5-3-released/index.html +11 -7
  92. data/site/news/2015/01/20/jekyll-meet-and-greet/index.html +11 -7
  93. data/site/news/2015/01/24/jekyll-3-0-0-beta1-released/index.html +11 -7
  94. data/site/news/2015/02/26/introducing-jekyll-talk/index.html +11 -7
  95. data/site/news/2015/10/26/jekyll-3-0-released/index.html +11 -7
  96. data/site/news/2015/11/17/jekyll-3-0-1-released/index.html +11 -7
  97. data/site/news/2016/01/20/jekyll-3-0-2-released/index.html +11 -7
  98. data/site/news/2016/01/24/jekyll-3-1-0-released/index.html +11 -7
  99. data/site/news/2016/01/28/jekyll-3-1-1-released/index.html +11 -7
  100. data/site/news/2016/02/08/jekyll-3-0-3-released/index.html +11 -7
  101. data/site/news/2016/02/19/jekyll-3-1-2-released/index.html +11 -7
  102. data/site/news/2016/03/10/making-it-easier-to-contribute-to-jekyll/index.html +11 -7
  103. data/site/news/2016/04/19/jekyll-3-0-4-released/index.html +11 -7
  104. data/site/news/2016/04/19/jekyll-3-1-3-released/index.html +11 -8
  105. data/site/news/2016/04/26/jekyll-3-0-5-released/index.html +11 -7
  106. data/site/news/2016/05/18/jekyll-3-1-4-released/index.html +11 -7
  107. data/site/news/2016/05/18/jekyll-3-1-5-released/index.html +11 -7
  108. data/site/news/2016/05/19/jekyll-3-1-6-released/index.html +11 -7
  109. data/site/news/2016/06/03/update-on-jekyll-s-google-summer-of-code-projects/index.html +11 -7
  110. data/site/news/2016/07/26/jekyll-3-2-0-released/index.html +11 -7
  111. data/site/news/2016/08/02/jekyll-3-2-1-released/index.html +11 -7
  112. data/site/news/2016/08/24/jekyll-admin-initial-release/index.html +12 -8
  113. data/site/news/2016/10/06/jekyll-3-3-is-here/index.html +12 -8
  114. data/site/news/2016/11/14/jekyll-3-3-1-released/index.html +11 -7
  115. data/site/news/2017/01/18/jekyll-3-4-0-released/index.html +570 -0
  116. data/site/news/index.html +81 -15
  117. data/site/news/releases/index.html +78 -12
  118. data/site/readme.md +9 -2
  119. data/site/sitemap.xml +59 -43
  120. metadata +14 -10
  121. data/site/fonts/fontawesome-webfont.eot +0 -0
  122. data/site/fonts/fontawesome-webfont.svg +0 -640
  123. data/site/fonts/fontawesome-webfont.ttf +0 -0
  124. data/site/fonts/fontawesome-webfont.woff +0 -0
  125. data/site/fonts/fontawesome-webfont.woff2 +0 -0
@@ -4,7 +4,7 @@
4
4
  <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
  <meta charset="UTF-8">
6
6
  <meta name="viewport" content="width=device-width,initial-scale=1">
7
- <meta name="generator" content="Jekyll v3.3.1">
7
+ <meta name="generator" content="Jekyll v3.4.0">
8
8
  <link type="application/atom+xml" rel="alternate" href="https://jekyllrb.com/feed.xml" title="Jekyll • Simple, blog-aware, static sites">
9
9
  <link rel="alternate" type="application/atom+xml" title="Recent commits to Jekyll’s master branch" href="https://github.com/jekyll/jekyll/commits/master.atom">
10
10
  <link rel="stylesheet" href="//fonts.googleapis.com/css?family=Lato:300,300italic,400,400italic,700,700italic,900">
@@ -19,7 +19,7 @@
19
19
  <meta property="og:url" content="https://jekyllrb.com/docs/plugins/">
20
20
  <meta property="og:site_name" content="Jekyll • Simple, blog-aware, static sites">
21
21
  <meta property="og:type" content="article">
22
- <meta property="article:published_time" content="2017-01-20T13:17:57-08:00">
22
+ <meta property="article:published_time" content="2017-03-22T08:06:48-07:00">
23
23
  <meta name="twitter:card" content="summary">
24
24
  <meta name="twitter:site" content="@jekyllrb">
25
25
  <meta name="google-site-verification" content="onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY">
@@ -27,7 +27,7 @@
27
27
  {"@context": "http://schema.org",
28
28
  "@type": "BlogPosting",
29
29
  "headline": "Plugins",
30
- "datePublished": "2017-01-20T13:17:57-08:00",
30
+ "datePublished": "2017-03-22T08:06:48-07:00",
31
31
  "description": "Jekyll has a plugin system with hooks that allow you to create custom generated content specific to your site. You can run custom code for your site without having to modify the Jekyll source itself.",
32
32
  "publisher": {"@type": "Organization",
33
33
  "logo": {"@type": "ImageObject",
@@ -192,6 +192,10 @@
192
192
 
193
193
 
194
194
 
195
+ <option value="/docs/includes/">Includes</option>
196
+
197
+
198
+
195
199
  <option value="/docs/permalinks/">Permalinks</option>
196
200
 
197
201
 
@@ -1086,6 +1090,8 @@ LESS.js files during generation.</li>
1086
1090
  <a href="https://github.com/juusaw/amp-jekyll">AMP-Jekyll by Juuso Mikkonen</a>: Generate <a href="https://www.ampproject.org">Accelerated Mobile Pages</a> of Jekyll posts.</li>
1087
1091
  <li>
1088
1092
  <a href="https://github.com/alexivkin/Jekyll-Art-Gallery-Plugin">Jekyll Art Gallery plugin</a>: 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.</li>
1093
+ <li>
1094
+ <a href="https://github.com/developmentseed/jekyll-ga">jekyll-ga</a>: A Jekyll plugin that downloads Google Analytics data and adds it to posts. Useful for making a site that lists “most popular” content. <a href="https://developmentseed.org/blog/google-analytics-jekyll-plugin/">Read the introduction</a> post on the developmentSEED blog.</li>
1089
1095
  </ul>
1090
1096
 
1091
1097
  <h4 id="converters-1">Converters</h4>
@@ -1120,8 +1126,6 @@ LESS.js files during generation.</li>
1120
1126
  <li>
1121
1127
  <a href="https://github.com/xdissent/jekyll-rst">ReStructuredText Converter</a>: Converts ReST documents to HTML with Pygments syntax highlighting.</li>
1122
1128
  <li>
1123
- <a href="https://github.com/dsanson/jekyll-pandoc-plugin">Jekyll-pandoc-plugin</a>: Use pandoc for rendering markdown.</li>
1124
- <li>
1125
1129
  <a href="https://github.com/fauno/jekyll-pandoc-multiple-formats">Jekyll-pandoc-multiple-formats</a> by <a href="https://github.com/edsl">edsl</a>: Use pandoc to generate your site in multiple formats. Supports pandoc’s markdown extensions.</li>
1126
1130
  <li>
1127
1131
  <a href="https://gist.github.com/1472645">Transform Layouts</a>: Allows HAML layouts (you need a HAML Converter plugin for this to work).</li>
@@ -1143,7 +1147,7 @@ LESS.js files during generation.</li>
1143
1147
 
1144
1148
  <ul>
1145
1149
  <li>
1146
- <a href="https://github.com/MattHall/truncatehtml">Truncate HTML</a> by <a href="http://codebeef.com">Matt Hall</a>: A Jekyll filter that truncates HTML while preserving markup structure.</li>
1150
+ <a href="https://github.com/MattHall/truncatehtml">Truncate HTML</a> by <a href="https://codebeef.com/">Matt Hall</a>: A Jekyll filter that truncates HTML while preserving markup structure.</li>
1147
1151
  <li>
1148
1152
  <a href="https://github.com/LawrenceWoodman/domain_name-liquid_filter">Domain Name Filter by Lawrence Woodman</a>: Filters the input text so that just the domain name is left.</li>
1149
1153
  <li>
@@ -1186,6 +1190,12 @@ LESS.js files during generation.</li>
1186
1190
  <a href="https://github.com/vwochnik/jekyll-email-protect">Jekyll Email Protect</a>: Email protection liquid filter for Jekyll</li>
1187
1191
  <li>
1188
1192
  <a href="https://github.com/mattg/jekyll-uglify-filter">Jekyll Uglify Filter</a>: A Liquid filter that runs your JavaScript through UglifyJS.</li>
1193
+ <li>
1194
+ <a href="https://github.com/sparanoid/match_regex">match_regex</a>: A Liquid filter to perform regex match.</li>
1195
+ <li>
1196
+ <a href="https://github.com/sparanoid/replace_regex">replace_regex</a>: A Liquid filter to perform regex replace.</li>
1197
+ <li>
1198
+ <a href="https://rubygems.org/gems/jekyll-money">Jekyll Money</a>: A Jekyll plugin for dealing with money. Because we all have to at some point.</li>
1189
1199
  </ul>
1190
1200
 
1191
1201
  <h4 id="tags-1">Tags</h4>
@@ -1244,7 +1254,7 @@ LESS.js files during generation.</li>
1244
1254
  <li>
1245
1255
  <a href="https://gist.github.com/Yexiaoxing/5891929">Youku and Tudou Embed</a>: Liquid plugin for embedding Youku and Tudou videos.</li>
1246
1256
  <li>
1247
- <a href="https://github.com/sectore/jekyll-swfobject">Jekyll-swfobject</a>: Liquid plugin for embedding Adobe Flash files (.swf) using <a href="http://code.google.com/p/swfobject/">SWFObject</a>.</li>
1257
+ <a href="https://github.com/sectore/jekyll-swfobject">Jekyll-swfobject</a>: Liquid plugin for embedding Adobe Flash files (.swf) using <a href="https://github.com/swfobject/swfobject">SWFObject</a>.</li>
1248
1258
  <li>
1249
1259
  <a href="https://github.com/robwierzbowski/jekyll-picture-tag">Jekyll Picture Tag</a>: Easy responsive images for Jekyll. Based on the proposed <a href="https://html.spec.whatwg.org/multipage/embedded-content.html#the-picture-element"><code class="highlighter-rouge">&lt;picture&gt;</code></a> element, polyfilled with Scott Jehl’s <a href="https://github.com/scottjehl/picturefill">Picturefill</a>.</li>
1250
1260
  <li>
@@ -1264,7 +1274,7 @@ LESS.js files during generation.</li>
1264
1274
  <li>
1265
1275
  <a href="https://gist.github.com/23maverick23/8532525">jekyll-font-awesome</a>: Quickly and easily add Font Awesome icons to your posts.</li>
1266
1276
  <li>
1267
- <a href="https://gist.github.com/tobru/9171700">Lychee Gallery Tag</a> by <a href="https://github.com/tobru">tobru</a>: Include <a href="http://lychee.electerious.com/">Lychee</a> albums into a post. For an introduction, see <a href="https://tobrunet.ch/articles/jekyll-meets-lychee-a-liquid-tag-plugin/">Jekyll meets Lychee - A Liquid Tag plugin</a>
1277
+ <a href="https://gist.github.com/tobru/9171700">Lychee Gallery Tag</a> by <a href="https://github.com/tobru">tobru</a>: Include <a href="https://lychee.electerious.com/">Lychee</a> albums into a post. For an introduction, see <a href="https://tobrunet.ch/articles/jekyll-meets-lychee-a-liquid-tag-plugin/">Jekyll meets Lychee - A Liquid Tag plugin</a>
1268
1278
  </li>
1269
1279
  <li>
1270
1280
  <a href="https://github.com/callmeed/jekyll-image-set">Image Set/Gallery Tag</a> by <a href="https://github.com/callmeed">callmeed</a>: Renders HTML for an image gallery from a folder in your Jekyll site. Just pass it a folder name and class/tag options.</li>
@@ -1275,11 +1285,11 @@ LESS.js files during generation.</li>
1275
1285
  <li>
1276
1286
  <a href="https://github.com/rob-murray/jekyll-version-plugin">Jekyll Project Version Tag</a>: A Liquid tag plugin that renders a version identifier for your Jekyll site sourced from the git repository containing your code.</li>
1277
1287
  <li>
1278
- <a href="https://github.com/AlessandroLorenzi/piwigo_gallery">Piwigo Gallery</a> by <a href="http://www.alorenzi.eu/">Alessandro Lorenzi</a>: Jekyll plugin to generate thumbnails from a Piwigo gallery and display them with a Liquid tag</li>
1288
+ <a href="https://github.com/AlessandroLorenzi/piwigo_gallery">Piwigo Gallery</a> by <a href="http://blog.alorenzi.eu/">Alessandro Lorenzi</a>: Jekyll plugin to generate thumbnails from a Piwigo gallery and display them with a Liquid tag</li>
1279
1289
  <li>
1280
1290
  <a href="https://github.com/tmthrgd/jekyll-plugins">mathml.rb</a> by Tom Thorogood: A plugin to convert TeX mathematics into MathML for display.</li>
1281
1291
  <li>
1282
- <a href="https://github.com/aarongustafson/jekyll-webmention_io">webmention_io.rb</a> by <a href="http://aaron-gustafson.com/">Aaron Gustafson</a>: A plugin to enable <a href="http://indiewebcamp.com/webmention">webmention</a> integration using <a href="http://webmention.io">Webmention.io</a>. Includes an optional JavaScript for updating webmentions automatically between publishes and, if available, in realtime using WebSockets.</li>
1292
+ <a href="https://github.com/aarongustafson/jekyll-webmention_io">webmention_io.rb</a> by <a href="http://aaron-gustafson.com/">Aaron Gustafson</a>: A plugin to enable <a href="https://indieweb.org/webmention">webmention</a> integration using <a href="https://webmention.io/">Webmention.io</a>. Includes an optional JavaScript for updating webmentions automatically between publishes and, if available, in realtime using WebSockets.</li>
1283
1293
  <li>
1284
1294
  <a href="https://github.com/lkorth/jekyll-500px-embed">Jekyll 500px Embed</a> by Luke Korth. A Liquid tag plugin that embeds <a href="https://500px.com/">500px</a> photos.</li>
1285
1295
  <li>
@@ -1322,7 +1332,7 @@ LESS.js files during generation.</li>
1322
1332
  <li>
1323
1333
  <a href="https://github.com/recurser/jekyll-plugins">Jekyll Plugins by Recursive Design</a>: Plugins to generate Project pages from GitHub readmes, a Category page, and a Sitemap generator.</li>
1324
1334
  <li>
1325
- <a href="https://github.com/flatterline/jekyll-plugins">Company website and blog plugins</a> by Flatterline, a <a href="http://flatterline.com/">Ruby on Rails development company</a>: Portfolio/project page generator, team/individual page generator, an author bio liquid tag for use on posts, and a few other smaller plugins.</li>
1335
+ <a href="https://github.com/flatterline/jekyll-plugins">Company website and blog plugins</a> 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.</li>
1326
1336
  <li>
1327
1337
  <a href="https://github.com/aucor/jekyll-plugins">Jekyll plugins by Aucor</a>: Plugins for trimming unwanted newlines/whitespace and sorting pages by weight attribute.</li>
1328
1338
  </ul>
@@ -1359,7 +1369,7 @@ LESS.js files during generation.</li>
1359
1369
  <li>
1360
1370
  <a href="https://github.com/moshen/jekyll-asset_bundler">Jekyll-asset_bundler</a>: Bundles and minifies JavaScript and CSS.</li>
1361
1371
  <li>
1362
- <a href="http://ixti.net/jekyll-assets/">Jekyll-assets</a> by <a href="https://github.com/ixti">ixti</a>: 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).</li>
1372
+ <a href="http://jekyll.github.io/jekyll-assets/">Jekyll-assets</a> by <a href="https://github.com/ixti">ixti</a>: 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).</li>
1363
1373
  <li>
1364
1374
  <a href="https://github.com/kitsched/japr">JAPR</a>: Jekyll Asset Pipeline Reborn - Powerful asset pipeline for Jekyll that collects, converts and compresses JavaScript and CSS assets.</li>
1365
1375
  <li>
@@ -1408,6 +1418,14 @@ LESS.js files during generation.</li>
1408
1418
  <a href="https://github.com/ashmaroli/jekyll-data">jekyll-data</a>: Read data files within Jekyll Theme Gems.</li>
1409
1419
  <li>
1410
1420
  <a href="https://github.com/snaptortoise/jekyll-pinboard-plugin">jekyll-pinboard</a>: Access your Pinboard bookmarks within your Jekyll theme.</li>
1421
+ <li>
1422
+ <a href="https://github.com/mpchadwick/jekyll-migrate-permalink">jekyll-migrate-permalink</a>: Adds a <code class="highlighter-rouge">migrate-permalink</code> sub-command to help deal with side effects of changing your permalink.</li>
1423
+ <li>
1424
+ <a href="https://github.com/robcrocombe/jekyll-post">Jekyll-Post</a>: A CLI tool to easily draft, edit, and publish Jekyll posts.</li>
1425
+ <li>
1426
+ <a href="https://github.com/muratayusuke/jekyll-numbered-headings">jekyll-numbered-headings</a>: Adds ordered number to headings.</li>
1427
+ <li>
1428
+ <a href="https://github.com/mpchadwick/jekyll-pre-commit">jekyll-pre-commit</a>: A framework for running checks against your posts using a git pre-commit hook before you publish them.</li>
1411
1429
  </ul>
1412
1430
 
1413
1431
  <h4 id="editors">Editors</h4>
@@ -1494,6 +1512,9 @@ new posts and run <code class="highlighter-rouge">jekyll build</code> all withou
1494
1512
 
1495
1513
 
1496
1514
 
1515
+
1516
+
1517
+
1497
1518
 
1498
1519
 
1499
1520
 
@@ -1607,6 +1628,10 @@ new posts and run <code class="highlighter-rouge">jekyll build</code> all withou
1607
1628
 
1608
1629
 
1609
1630
 
1631
+ <li class=""><a href="/docs/includes/">Includes</a></li>
1632
+
1633
+
1634
+
1610
1635
  <li class=""><a href="/docs/permalinks/">Permalinks</a></li>
1611
1636
 
1612
1637
 
@@ -1755,7 +1780,7 @@ new posts and run <code class="highlighter-rouge">jekyll build</code> all withou
1755
1780
  </script>
1756
1781
 
1757
1782
 
1758
- <!-- Gauges (http://gaug.es/) -->
1783
+ <!-- Gauges (http://get.gaug.es/) -->
1759
1784
  <script>
1760
1785
  var _gauges = _gauges || [];
1761
1786
  (function() {
@@ -1772,7 +1797,7 @@ new posts and run <code class="highlighter-rouge">jekyll build</code> all withou
1772
1797
 
1773
1798
 
1774
1799
 
1775
- <!-- Google Analytics (http://google.com/analytics) -->
1800
+ <!-- Google Analytics (https://www.google.com/analytics) -->
1776
1801
  <script>
1777
1802
  !function(j,e,k,y,l,L){j.GoogleAnalyticsObject=y,j[y]||(j[y]=function(){
1778
1803
  (j[y].q=j[y].q||[]).push(arguments)}),j[y].l=+new Date,l=e.createElement(k),
@@ -4,7 +4,7 @@
4
4
  <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
  <meta charset="UTF-8">
6
6
  <meta name="viewport" content="width=device-width,initial-scale=1">
7
- <meta name="generator" content="Jekyll v3.3.1">
7
+ <meta name="generator" content="Jekyll v3.4.0">
8
8
  <link type="application/atom+xml" rel="alternate" href="https://jekyllrb.com/feed.xml" title="Jekyll • Simple, blog-aware, static sites">
9
9
  <link rel="alternate" type="application/atom+xml" title="Recent commits to Jekyll’s master branch" href="https://github.com/jekyll/jekyll/commits/master.atom">
10
10
  <link rel="stylesheet" href="//fonts.googleapis.com/css?family=Lato:300,300italic,400,400italic,700,700italic,900">
@@ -19,7 +19,7 @@
19
19
  <meta property="og:url" content="https://jekyllrb.com/docs/posts/">
20
20
  <meta property="og:site_name" content="Jekyll • Simple, blog-aware, static sites">
21
21
  <meta property="og:type" content="article">
22
- <meta property="article:published_time" content="2017-01-20T13:17:57-08:00">
22
+ <meta property="article:published_time" content="2017-03-22T08:06:48-07:00">
23
23
  <meta name="twitter:card" content="summary">
24
24
  <meta name="twitter:site" content="@jekyllrb">
25
25
  <meta name="google-site-verification" content="onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY">
@@ -27,7 +27,7 @@
27
27
  {"@context": "http://schema.org",
28
28
  "@type": "BlogPosting",
29
29
  "headline": "Writing posts",
30
- "datePublished": "2017-01-20T13:17:57-08:00",
30
+ "datePublished": "2017-03-22T08:06:48-07:00",
31
31
  "description": "One of Jekyll’s best aspects is that it is “blog aware”. What does this mean, exactly? Well, simply put, it means that blogging is baked into Jekyll’s functionality. If you write articles and publish them online, you can publish and maintain a blog simply by managing a folder of text-files on your computer. Compared to the hassle of configuring and maintaining databases and web-based CMS systems, this will be a welcome change!",
32
32
  "publisher": {"@type": "Organization",
33
33
  "logo": {"@type": "ImageObject",
@@ -192,6 +192,10 @@
192
192
 
193
193
 
194
194
 
195
+ <option value="/docs/includes/">Includes</option>
196
+
197
+
198
+
195
199
  <option value="/docs/permalinks/">Permalinks</option>
196
200
 
197
201
 
@@ -397,6 +401,25 @@ variable in a post.</p>
397
401
  </p>
398
402
  </div>
399
403
 
404
+ <h2 id="a-typical-post">A typical post</h2>
405
+
406
+ <p>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:</p>
407
+
408
+ <div class="highlighter-rouge">
409
+ <pre class="highlight"><code>---
410
+ layout: post
411
+ title: "Welcome to Jekyll!"
412
+ date: 2015-11-17 16:16:01 -0600
413
+ categories: jekyll update
414
+ ---
415
+ You’ll 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.
416
+
417
+ 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.
418
+
419
+ </code></pre>
420
+ </div>
421
+ <p>Everything in between the first and second <code class="highlighter-rouge">---</code> are part of the YAML Front Matter, and everything after the second <code class="highlighter-rouge">---</code> will be rendered with Markdown and show up as “Content.”</p>
422
+
400
423
  <h2 id="displaying-an-index-of-posts">Displaying an index of posts</h2>
401
424
 
402
425
  <p>It’s all well and good to have posts in a folder, but a blog is no use unless
@@ -666,6 +689,10 @@ site.</p>
666
689
 
667
690
 
668
691
 
692
+ <li class=""><a href="/docs/includes/">Includes</a></li>
693
+
694
+
695
+
669
696
  <li class=""><a href="/docs/permalinks/">Permalinks</a></li>
670
697
 
671
698
 
@@ -814,7 +841,7 @@ site.</p>
814
841
  </script>
815
842
 
816
843
 
817
- <!-- Gauges (http://gaug.es/) -->
844
+ <!-- Gauges (http://get.gaug.es/) -->
818
845
  <script>
819
846
  var _gauges = _gauges || [];
820
847
  (function() {
@@ -831,7 +858,7 @@ site.</p>
831
858
 
832
859
 
833
860
 
834
- <!-- Google Analytics (http://google.com/analytics) -->
861
+ <!-- Google Analytics (https://www.google.com/analytics) -->
835
862
  <script>
836
863
  !function(j,e,k,y,l,L){j.GoogleAnalyticsObject=y,j[y]||(j[y]=function(){
837
864
  (j[y].q=j[y].q||[]).push(arguments)}),j[y].l=+new Date,l=e.createElement(k),
@@ -4,7 +4,7 @@
4
4
  <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
  <meta charset="UTF-8">
6
6
  <meta name="viewport" content="width=device-width,initial-scale=1">
7
- <meta name="generator" content="Jekyll v3.3.1">
7
+ <meta name="generator" content="Jekyll v3.4.0">
8
8
  <link type="application/atom+xml" rel="alternate" href="https://jekyllrb.com/feed.xml" title="Jekyll • Simple, blog-aware, static sites">
9
9
  <link rel="alternate" type="application/atom+xml" title="Recent commits to Jekyll’s master branch" href="https://github.com/jekyll/jekyll/commits/master.atom">
10
10
  <link rel="stylesheet" href="//fonts.googleapis.com/css?family=Lato:300,300italic,400,400italic,700,700italic,900">
@@ -13,13 +13,13 @@
13
13
  <!-- Begin Jekyll SEO tag v2.1.0 -->
14
14
  <title>Quick-start guide - Jekyll • Simple, blog-aware, static sites</title>
15
15
  <meta property="og:title" content="Quick-start guide">
16
- <meta name="description" content="For the impatient, here’s how to get a boilerplate Jekyll site up and running.">
17
- <meta property="og:description" content="For the impatient, here’s how to get a boilerplate Jekyll site up and running.">
16
+ <meta name="description" content="If you already have a full Ruby development environment with all headers and RubyGems installed (see Jekyll’s requirements), you can create a new Jekyll site by doing the following:">
17
+ <meta property="og:description" content="If you already have a full Ruby development environment with all headers and RubyGems installed (see Jekyll’s requirements), you can create a new Jekyll site by doing the following:">
18
18
  <link rel="canonical" href="https://jekyllrb.com/docs/quickstart/">
19
19
  <meta property="og:url" content="https://jekyllrb.com/docs/quickstart/">
20
20
  <meta property="og:site_name" content="Jekyll • Simple, blog-aware, static sites">
21
21
  <meta property="og:type" content="article">
22
- <meta property="article:published_time" content="2017-01-20T13:17:57-08:00">
22
+ <meta property="article:published_time" content="2017-03-22T08:06:48-07:00">
23
23
  <meta name="twitter:card" content="summary">
24
24
  <meta name="twitter:site" content="@jekyllrb">
25
25
  <meta name="google-site-verification" content="onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY">
@@ -27,8 +27,8 @@
27
27
  {"@context": "http://schema.org",
28
28
  "@type": "BlogPosting",
29
29
  "headline": "Quick-start guide",
30
- "datePublished": "2017-01-20T13:17:57-08:00",
31
- "description": "For the impatient, here’s how to get a boilerplate Jekyll site up and running.",
30
+ "datePublished": "2017-03-22T08:06:48-07:00",
31
+ "description": "If you already have a full Ruby development environment with all headers and RubyGems installed (see Jekyll’s requirements), you can create a new Jekyll site by doing the following:",
32
32
  "publisher": {"@type": "Organization",
33
33
  "logo": {"@type": "ImageObject",
34
34
  "url": "https://jekyllrb.com/img/logo-2x.png"}},
@@ -192,6 +192,10 @@
192
192
 
193
193
 
194
194
 
195
+ <option value="/docs/includes/">Includes</option>
196
+
197
+
198
+
195
199
  <option value="/docs/permalinks/">Permalinks</option>
196
200
 
197
201
 
@@ -286,28 +290,59 @@
286
290
  <a href="https://github.com/jekyll/jekyll/edit/master/docs/_docs/quickstart.md"><i class="fa fa-pencil"></i>  Improve this page</a>
287
291
  </div>
288
292
  <h1>Quick-start guide</h1>
289
- <p>For the impatient, here’s how to get a boilerplate Jekyll site up and running.</p>
293
+ <p>If you already have a full <a href="https://www.ruby-lang.org/en/downloads/">Ruby</a> development environment with all headers and <a href="https://rubygems.org/pages/download">RubyGems</a> installed (see Jekyll’s <a href="/docs/installation/#requirements/">requirements</a>), you can create a new Jekyll site by doing the following:</p>
290
294
 
291
295
  <div class="language-sh highlighter-rouge">
292
- <pre class="highlight"><code>~ <span class="nv">$ </span>gem install jekyll bundler
296
+ <pre class="highlight"><code><span class="c"># Install Jekyll and Bundler gems through RubyGems</span>
297
+ ~ <span class="nv">$ </span>gem install jekyll bundler
298
+
299
+ <span class="c"># Create a new Jekyll site at ./myblog</span>
293
300
  ~ <span class="nv">$ </span>jekyll new myblog
301
+
302
+ <span class="c"># Change into your new directory</span>
294
303
  ~ <span class="nv">$ </span><span class="nb">cd </span>myblog
304
+
305
+ <span class="c"># Build the site on the preview server</span>
295
306
  ~/myblog <span class="nv">$ </span>bundle <span class="nb">exec </span>jekyll serve
296
- <span class="c"># =&gt; Now browse to http://localhost:4000</span>
307
+
308
+ <span class="c"># Now browse to http://localhost:4000</span>
297
309
  </code></pre>
298
310
  </div>
299
311
 
300
- <p>The <code class="highlighter-rouge">jekyll new</code> command now automatically initiates <code class="highlighter-rouge">bundle install</code> and installs the dependencies required. To skip this, pass <code class="highlighter-rouge">--skip-bundle</code> option like so <code class="highlighter-rouge">jekyll new myblog --skip-bundle</code>.</p>
312
+ <p>If you encounter any unexpected errors during the above, please refer to the already-mentioned <a href="/docs/installation/#requirements/">requirements</a> page, as you might be missing development headers or other prerequisites.</p>
301
313
 
302
- <p>If you wish to install jekyll into an existing directory, you can do so by running <code class="highlighter-rouge">jekyll new .</code> from within the directory instead of creating a new one. If the existing directory isn’t empty, you’ll also have to pass the <code class="highlighter-rouge">--force</code> option like so <code class="highlighter-rouge">jekyll new . --force</code>.</p>
314
+ <h2 id="about-bundler">About Bundler</h2>
303
315
 
304
- <p>That’s nothing, though. The real magic happens when you start creating blog
305
- posts, using the front matter to control templates and layouts, and taking
306
- advantage of all the awesome configuration options Jekyll makes available.</p>
316
+ <p><code class="highlighter-rouge">gem install jekyll bundler</code> installs the <a href="https://rubygems.org/gems/jekyll/">jekyll</a> and <a href="https://rubygems.org/gems/bundler">bundler</a> gems through <a href="https://rubygems.org/">RubyGems</a>. You need only to install the gems one time — not every time you create a new Jekyll project. Here are some additional details:</p>
307
317
 
308
- <p>If you’re running into problems, ensure you have all the <a href="/docs/installation/">requirements
309
- installed</a>.</p>
318
+ <ul>
319
+ <li>
320
+ <code class="highlighter-rouge">bundler</code> 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.</li>
321
+ <li>
322
+ <p>The <code class="highlighter-rouge">Gemfile</code> and <code class="highlighter-rouge">Gemfile.lock</code> files inform Bundler about the gem requirements in your site. If your site doesn’t have these Gemfiles, you can omit <code class="highlighter-rouge">bundle exec</code> and just run <code class="highlighter-rouge">jekyll serve</code>.</p>
323
+ </li>
324
+ <li>When you run <code class="highlighter-rouge">bundle exec jekyll serve</code>, Bundler uses the gems and versions as specified in <code class="highlighter-rouge">Gemfile.lock</code> to ensure your Jekyll site builds with no compatibility or dependency conflicts.</li>
325
+ </ul>
310
326
 
327
+ <h2 id="options-for-creating-a-new-site-with-jekyll">Options for creating a new site with Jekyll</h2>
328
+
329
+ <p><code class="highlighter-rouge">jekyll new &lt;PATH&gt;</code> installs a new Jekyll site at the path specified (relative to current directory). In this case, Jekyll will be installed in a directory called <code class="highlighter-rouge">myblog</code>. Here are some additional details:</p>
330
+
331
+ <ul>
332
+ <li>To install the Jekyll site into the directory you’re currently in, run <code class="highlighter-rouge">jekyll new .</code> If the existing directory isn’t empty, you can pass the <code class="highlighter-rouge">--force</code> option with <code class="highlighter-rouge">jekyll new . --force</code>.</li>
333
+ <li>
334
+ <code class="highlighter-rouge">jekyll new</code> automatically initiates <code class="highlighter-rouge">bundle install</code> to install the dependencies required. (If you don’t want Bundler to install the gems, use <code class="highlighter-rouge">jekyll new myblog --skip-bundle</code>.)</li>
335
+ <li>By default, the Jekyll site installed by <code class="highlighter-rouge">jekyll new</code> uses a gem-based theme called <a href="https://github.com/jekyll/minima">Minima</a>. With <a href="../themes">gem-based themes</a>, some of the directories and files are stored in the theme-gem, hidden from your immediate view.</li>
336
+ <li>We recommend setting up Jekyll with a gem-based theme but if you want to start with a blank slate, use <code class="highlighter-rouge">jekyll new myblog --blank</code>
337
+ </li>
338
+ <li>To learn about other parameters you can include with <code class="highlighter-rouge">jekyll new</code>, type <code class="highlighter-rouge">jekyll new --help</code>.</li>
339
+ </ul>
340
+
341
+ <p class="note info">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>.</p>
342
+
343
+ <h2 id="next-steps">Next steps</h2>
344
+
345
+ <p>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.</p>
311
346
 
312
347
 
313
348
 
@@ -429,6 +464,10 @@ installed</a>.</p>
429
464
 
430
465
 
431
466
 
467
+ <li class=""><a href="/docs/includes/">Includes</a></li>
468
+
469
+
470
+
432
471
  <li class=""><a href="/docs/permalinks/">Permalinks</a></li>
433
472
 
434
473
 
@@ -577,7 +616,7 @@ installed</a>.</p>
577
616
  </script>
578
617
 
579
618
 
580
- <!-- Gauges (http://gaug.es/) -->
619
+ <!-- Gauges (http://get.gaug.es/) -->
581
620
  <script>
582
621
  var _gauges = _gauges || [];
583
622
  (function() {
@@ -594,7 +633,7 @@ installed</a>.</p>
594
633
 
595
634
 
596
635
 
597
- <!-- Google Analytics (http://google.com/analytics) -->
636
+ <!-- Google Analytics (https://www.google.com/analytics) -->
598
637
  <script>
599
638
  !function(j,e,k,y,l,L){j.GoogleAnalyticsObject=y,j[y]||(j[y]=function(){
600
639
  (j[y].q=j[y].q||[]).push(arguments)}),j[y].l=+new Date,l=e.createElement(k),
@@ -4,7 +4,7 @@
4
4
  <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
  <meta charset="UTF-8">
6
6
  <meta name="viewport" content="width=device-width,initial-scale=1">
7
- <meta name="generator" content="Jekyll v3.3.1">
7
+ <meta name="generator" content="Jekyll v3.4.0">
8
8
  <link type="application/atom+xml" rel="alternate" href="https://jekyllrb.com/feed.xml" title="Jekyll • Simple, blog-aware, static sites">
9
9
  <link rel="alternate" type="application/atom+xml" title="Recent commits to Jekyll’s master branch" href="https://github.com/jekyll/jekyll/commits/master.atom">
10
10
  <link rel="stylesheet" href="//fonts.googleapis.com/css?family=Lato:300,300italic,400,400italic,700,700italic,900">
@@ -19,7 +19,7 @@
19
19
  <meta property="og:url" content="https://jekyllrb.com/docs/resources/">
20
20
  <meta property="og:site_name" content="Jekyll • Simple, blog-aware, static sites">
21
21
  <meta property="og:type" content="article">
22
- <meta property="article:published_time" content="2017-01-20T13:17:57-08:00">
22
+ <meta property="article:published_time" content="2017-03-22T08:06:48-07:00">
23
23
  <meta name="twitter:card" content="summary">
24
24
  <meta name="twitter:site" content="@jekyllrb">
25
25
  <meta name="google-site-verification" content="onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY">
@@ -27,7 +27,7 @@
27
27
  {"@context": "http://schema.org",
28
28
  "@type": "BlogPosting",
29
29
  "headline": "Resources",
30
- "datePublished": "2017-01-20T13:17:57-08:00",
30
+ "datePublished": "2017-03-22T08:06:48-07:00",
31
31
  "description": "Jekyll’s growing use is producing a wide variety of tutorials, frameworks, extensions, examples, and other resources that can be very helpful. Below is a collection of links to some of the most popular Jekyll resources.",
32
32
  "publisher": {"@type": "Organization",
33
33
  "logo": {"@type": "ImageObject",
@@ -192,6 +192,10 @@
192
192
 
193
193
 
194
194
 
195
+ <option value="/docs/includes/">Includes</option>
196
+
197
+
198
+
195
199
  <option value="/docs/permalinks/">Permalinks</option>
196
200
 
197
201
 
@@ -294,11 +298,11 @@
294
298
  <li>
295
299
  <a href="http://jekyll.tips">Jekyll Tips</a> is a set of resources created by <a href="https://cloudcannon.com">CloudCannon</a> to help folks get up and running with Jekyll. They cover all skill levels, and even include some great video tutorials.</li>
296
300
  <li>
297
- <a href="http://cheat.jekyll.tips">Jekyll Cheatsheet</a> is a single-page resource for Jekyll filters, variables, and the like.</li>
301
+ <a href="http://jekyll.tips/jekyll-cheat-sheet/">Jekyll Cheatsheet</a> is a single-page resource for Jekyll filters, variables, and the like.</li>
298
302
  <li><a href="http://jmcglone.com/guides/github-pages/">“Creating and Hosting a Personal Site on GitHub”</a></li>
299
- <li><a href="http://www.smashingmagazine.com/2014/08/01/build-blog-jekyll-github-pages/">‘Build A Blog With Jekyll And GitHub Pages’ on Smashing Magazine</a></li>
303
+ <li><a href="https://www.smashingmagazine.com/2014/08/01/build-blog-jekyll-github-pages/">‘Build A Blog With Jekyll And GitHub Pages’ on Smashing Magazine</a></li>
300
304
  <li>Publishing to GitHub Pages? <a href="/docs/github-pages/">Check out our documentation page for just that purpose</a>.</li>
301
- <li><a href="http://metajack.im/2009/01/23/blogging-with-git-emacs-and-jekyll/">Blogging with Git, Emacs and Jekyll</a></li>
305
+ <li><a href="https://metajack.im/2009/01/23/blogging-with-git-emacs-and-jekyll/">Blogging with Git, Emacs and Jekyll</a></li>
302
306
  <li><a href="https://gist.github.com/jedschneider/2890453">Tips for working with GitHub Pages Integration</a></li>
303
307
  </ul>
304
308
 
@@ -307,9 +311,9 @@
307
311
  <ul>
308
312
  <li>Use a saas service as a backend for forms (contact forms, hiring forms, etc.)
309
313
  <ul>
310
- <li><a href="http://formspree.io/">Formspree (also open source)</a></li>
314
+ <li><a href="https://formspree.io/">Formspree (also open source)</a></li>
311
315
  <li><a href="https://formkeep.com/guides/contact-form-jekyll?utm_source=github&amp;utm_medium=jekyll-docs&amp;utm_campaign=contact-form-jekyll">FormKeep</a></li>
312
- <li><a href="http://getsimpleform.com/">Simple Form</a></li>
316
+ <li><a href="https://getsimpleform.com/">Simple Form</a></li>
313
317
  <li><a href="https://www.formingo.co/guides/jekyll?utm_source=github&amp;utm_medium=jekyll-docs&amp;utm_campaign=Jekyll%20Documentation">Formingo</a></li>
314
318
  </ul>
315
319
  </li>
@@ -434,6 +438,9 @@
434
438
 
435
439
 
436
440
 
441
+
442
+
443
+
437
444
 
438
445
 
439
446
 
@@ -547,6 +554,10 @@
547
554
 
548
555
 
549
556
 
557
+ <li class=""><a href="/docs/includes/">Includes</a></li>
558
+
559
+
560
+
550
561
  <li class=""><a href="/docs/permalinks/">Permalinks</a></li>
551
562
 
552
563
 
@@ -695,7 +706,7 @@
695
706
  </script>
696
707
 
697
708
 
698
- <!-- Gauges (http://gaug.es/) -->
709
+ <!-- Gauges (http://get.gaug.es/) -->
699
710
  <script>
700
711
  var _gauges = _gauges || [];
701
712
  (function() {
@@ -712,7 +723,7 @@
712
723
 
713
724
 
714
725
 
715
- <!-- Google Analytics (http://google.com/analytics) -->
726
+ <!-- Google Analytics (https://www.google.com/analytics) -->
716
727
  <script>
717
728
  !function(j,e,k,y,l,L){j.GoogleAnalyticsObject=y,j[y]||(j[y]=function(){
718
729
  (j[y].q=j[y].q||[]).push(arguments)}),j[y].l=+new Date,l=e.createElement(k),