jekyll-docs 3.9.0 → 4.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (225) hide show
  1. checksums.yaml +4 -4
  2. data/lib/jekyll-docs.rb +3 -3
  3. data/site/404.html +10 -7
  4. data/site/css/screen.css +3 -1
  5. data/site/css/screen.css.map +28 -0
  6. data/site/docs/assets/index.html +412 -453
  7. data/site/docs/code_of_conduct/index.html +447 -501
  8. data/site/docs/collections/index.html +487 -674
  9. data/site/docs/community/bug/index.html +603 -0
  10. data/site/docs/community/index.html +635 -0
  11. data/site/docs/conduct/index.html +447 -515
  12. data/site/docs/configuration/default/index.html +682 -0
  13. data/site/docs/configuration/environments/index.html +641 -0
  14. data/site/docs/configuration/front-matter-defaults/index.html +738 -0
  15. data/site/docs/configuration/incremental-regeneration/index.html +631 -0
  16. data/site/docs/configuration/index.html +405 -1230
  17. data/site/docs/configuration/liquid/index.html +616 -0
  18. data/site/docs/configuration/markdown/index.html +766 -0
  19. data/site/docs/configuration/options/index.html +1011 -0
  20. data/site/docs/configuration/webrick/index.html +615 -0
  21. data/site/docs/continuous-integration/buddyworks/index.html +393 -479
  22. data/site/docs/continuous-integration/circleci/index.html +465 -481
  23. data/site/docs/continuous-integration/travis-ci/index.html +450 -507
  24. data/site/docs/contributing/index.html +425 -514
  25. data/site/docs/datafiles/index.html +411 -453
  26. data/site/docs/deployment-methods/index.html +9 -871
  27. data/site/docs/deployment/automated/index.html +663 -0
  28. data/site/docs/deployment/index.html +607 -0
  29. data/site/docs/deployment/manual/index.html +631 -0
  30. data/site/docs/deployment/third-party/index.html +639 -0
  31. data/site/docs/drafts/index.html +9 -634
  32. data/site/docs/extras/index.html +9 -687
  33. data/site/docs/front-matter/index.html +799 -0
  34. data/site/docs/frontmatter/index.html +9 -819
  35. data/site/docs/github-pages/index.html +407 -475
  36. data/site/docs/history/index.html +1370 -1154
  37. data/site/docs/home/index.html +9 -627
  38. data/site/docs/includes/index.html +425 -501
  39. data/site/docs/index.html +630 -9
  40. data/site/docs/installation/index.html +403 -540
  41. data/site/docs/installation/macos/index.html +716 -0
  42. data/site/docs/installation/other-linux/index.html +613 -0
  43. data/site/docs/installation/ubuntu/index.html +623 -0
  44. data/site/docs/installation/windows/index.html +733 -0
  45. data/site/docs/layouts/index.html +726 -0
  46. data/site/docs/liquid/filters/index.html +1169 -0
  47. data/site/docs/liquid/index.html +615 -0
  48. data/site/docs/liquid/tags/index.html +728 -0
  49. data/site/docs/maintaining/affinity-team-captain/index.html +395 -479
  50. data/site/docs/maintaining/avoiding-burnout/index.html +391 -475
  51. data/site/docs/maintaining/becoming-a-maintainer/index.html +391 -475
  52. data/site/docs/maintaining/index.html +391 -486
  53. data/site/docs/maintaining/merging-a-pull-request/index.html +406 -490
  54. data/site/docs/maintaining/releasing-a-new-version/index.html +409 -485
  55. data/site/docs/maintaining/reviewing-a-pull-request/index.html +392 -476
  56. data/site/docs/maintaining/special-labels/index.html +397 -481
  57. data/site/docs/maintaining/triaging-an-issue/index.html +394 -478
  58. data/site/docs/markdown-101/index.html +601 -0
  59. data/site/docs/migrations/index.html +396 -440
  60. data/site/docs/pages/index.html +408 -482
  61. data/site/docs/pagination/index.html +450 -509
  62. data/site/docs/permalinks/index.html +552 -587
  63. data/site/docs/plugins/commands/index.html +656 -0
  64. data/site/docs/plugins/converters/index.html +685 -0
  65. data/site/docs/plugins/filters/index.html +624 -0
  66. data/site/docs/plugins/generators/index.html +697 -0
  67. data/site/docs/plugins/hooks/index.html +838 -0
  68. data/site/docs/plugins/index.html +415 -1565
  69. data/site/docs/plugins/installation/index.html +681 -0
  70. data/site/docs/plugins/tags/index.html +699 -0
  71. data/site/docs/plugins/your-first-plugin/index.html +741 -0
  72. data/site/docs/posts/index.html +491 -627
  73. data/site/docs/quickstart/index.html +9 -645
  74. data/site/docs/resources/index.html +9 -761
  75. data/site/docs/ruby-101/index.html +640 -0
  76. data/site/docs/sites/index.html +9 -696
  77. data/site/docs/static-files/index.html +401 -433
  78. data/site/docs/step-by-step/01-setup/index.html +771 -0
  79. data/site/docs/step-by-step/02-liquid/index.html +756 -0
  80. data/site/docs/step-by-step/03-front-matter/index.html +730 -0
  81. data/site/docs/step-by-step/04-layouts/index.html +770 -0
  82. data/site/docs/step-by-step/05-includes/index.html +768 -0
  83. data/site/docs/step-by-step/06-data-files/index.html +738 -0
  84. data/site/docs/step-by-step/07-assets/index.html +773 -0
  85. data/site/docs/step-by-step/08-blogging/index.html +835 -0
  86. data/site/docs/step-by-step/09-collections/index.html +932 -0
  87. data/site/docs/step-by-step/10-deployment/index.html +842 -0
  88. data/site/docs/structure/index.html +411 -430
  89. data/site/docs/support/index.html +392 -476
  90. data/site/docs/templates/index.html +9 -1232
  91. data/site/docs/themes/index.html +487 -521
  92. data/site/docs/troubleshooting/index.html +443 -520
  93. data/site/docs/upgrading/0-to-2/index.html +437 -523
  94. data/site/docs/upgrading/2-to-3/index.html +422 -507
  95. data/site/docs/upgrading/3-to-4/index.html +765 -0
  96. data/site/docs/upgrading/index.html +395 -478
  97. data/site/docs/usage/index.html +409 -506
  98. data/site/docs/variables/index.html +504 -652
  99. data/site/docs/windows/index.html +9 -784
  100. data/site/feed.xml +269 -188
  101. data/site/feed/release.xml +324 -0
  102. data/site/fonts/lato-v14-latin-300.woff +0 -0
  103. data/site/fonts/lato-v14-latin-300.woff2 +0 -0
  104. data/site/fonts/lato-v14-latin-300italic.woff +0 -0
  105. data/site/fonts/lato-v14-latin-300italic.woff2 +0 -0
  106. data/site/fonts/lato-v14-latin-700.woff +0 -0
  107. data/site/fonts/lato-v14-latin-700.woff2 +0 -0
  108. data/site/fonts/lato-v14-latin-700italic.woff +0 -0
  109. data/site/fonts/lato-v14-latin-700italic.woff2 +0 -0
  110. data/site/fonts/lato-v14-latin-900.woff +0 -0
  111. data/site/fonts/lato-v14-latin-900.woff2 +0 -0
  112. data/site/fonts/lato-v14-latin-900italic.woff +0 -0
  113. data/site/fonts/lato-v14-latin-900italic.woff2 +0 -0
  114. data/site/fonts/lato-v14-latin-italic.woff +0 -0
  115. data/site/fonts/lato-v14-latin-italic.woff2 +0 -0
  116. data/site/fonts/lato-v14-latin-regular.woff +0 -0
  117. data/site/fonts/lato-v14-latin-regular.woff2 +0 -0
  118. data/site/help/index.html +9 -247
  119. data/site/img/forestry-logo.svg +19 -0
  120. data/site/img/jekyll-og.png +0 -0
  121. data/site/img/spacer.gif +0 -0
  122. data/site/index.html +56 -29
  123. data/site/jekyllconf/index.html +62 -35
  124. data/site/latest_version.txt +1 -1
  125. data/site/news/2013/05/05/jekyll-1-0-0-released/index.html +180 -115
  126. data/site/news/2013/05/08/jekyll-1-0-1-released/index.html +182 -117
  127. data/site/news/2013/05/12/jekyll-1-0-2-released/index.html +183 -118
  128. data/site/news/2013/06/07/jekyll-1-0-3-released/index.html +184 -119
  129. data/site/news/2013/07/14/jekyll-1-1-0-released/index.html +183 -118
  130. data/site/news/2013/07/24/jekyll-1-1-1-released/index.html +180 -115
  131. data/site/news/2013/07/25/jekyll-1-0-4-released/index.html +182 -117
  132. data/site/news/2013/07/25/jekyll-1-1-2-released/index.html +182 -117
  133. data/site/news/2013/09/06/jekyll-1-2-0-released/index.html +185 -120
  134. data/site/news/2013/09/14/jekyll-1-2-1-released/index.html +183 -118
  135. data/site/news/2013/10/28/jekyll-1-3-0-rc1-released/index.html +180 -115
  136. data/site/news/2013/11/04/jekyll-1-3-0-released/index.html +189 -124
  137. data/site/news/2013/11/26/jekyll-1-3-1-released/index.html +181 -116
  138. data/site/news/2013/12/07/jekyll-1-4-0-released/index.html +181 -116
  139. data/site/news/2013/12/09/jekyll-1-4-1-released/index.html +180 -115
  140. data/site/news/2013/12/16/jekyll-1-4-2-released/index.html +182 -117
  141. data/site/news/2014/01/13/jekyll-1-4-3-released/index.html +181 -116
  142. data/site/news/2014/03/24/jekyll-1-5-0-released/index.html +181 -116
  143. data/site/news/2014/03/27/jekyll-1-5-1-released/index.html +181 -116
  144. data/site/news/2014/05/06/jekyll-turns-2-0-0/index.html +184 -119
  145. data/site/news/2014/05/08/jekyll-2-0-3-released/index.html +180 -115
  146. data/site/news/2014/06/04/jekyll-stickers-1-dollar-stickermule/index.html +181 -116
  147. data/site/news/2014/06/28/jekyll-turns-21-i-mean-2-1-0/index.html +185 -120
  148. data/site/news/2014/07/01/jekyll-2-1-1-released/index.html +182 -117
  149. data/site/news/2014/07/29/jekyll-2-2-0-released/index.html +181 -116
  150. data/site/news/2014/08/10/jekyll-2-3-0-released/index.html +189 -124
  151. data/site/news/2014/09/09/jekyll-2-4-0-released/index.html +187 -122
  152. data/site/news/2014/11/05/jekylls-midlife-crisis-jekyll-turns-2-5-0/index.html +188 -123
  153. data/site/news/2014/11/09/jekyll-2-5-1-released/index.html +180 -115
  154. data/site/news/2014/11/12/jekyll-2-5-2-released/index.html +182 -117
  155. data/site/news/2014/12/17/alfredxing-welcome-to-jekyll-core/index.html +179 -114
  156. data/site/news/2014/12/22/jekyll-2-5-3-released/index.html +180 -115
  157. data/site/news/2015/01/20/jekyll-meet-and-greet/index.html +179 -114
  158. data/site/news/2015/01/24/jekyll-3-0-0-beta1-released/index.html +180 -115
  159. data/site/news/2015/02/26/introducing-jekyll-talk/index.html +180 -115
  160. data/site/news/2015/10/26/jekyll-3-0-released/index.html +185 -120
  161. data/site/news/2015/11/17/jekyll-3-0-1-released/index.html +184 -119
  162. data/site/news/2016/01/20/jekyll-3-0-2-released/index.html +182 -117
  163. data/site/news/2016/01/24/jekyll-3-1-0-released/index.html +186 -121
  164. data/site/news/2016/01/28/jekyll-3-1-1-released/index.html +183 -118
  165. data/site/news/2016/02/08/jekyll-3-0-3-released/index.html +181 -116
  166. data/site/news/2016/02/19/jekyll-3-1-2-released/index.html +182 -117
  167. data/site/news/2016/03/10/making-it-easier-to-contribute-to-jekyll/index.html +179 -114
  168. data/site/news/2016/04/19/jekyll-3-0-4-released/index.html +181 -116
  169. data/site/news/2016/04/19/jekyll-3-1-3-released/index.html +181 -116
  170. data/site/news/2016/04/26/jekyll-3-0-5-released/index.html +180 -115
  171. data/site/news/2016/05/18/jekyll-3-1-4-released/index.html +186 -121
  172. data/site/news/2016/05/18/jekyll-3-1-5-released/index.html +181 -116
  173. data/site/news/2016/05/19/jekyll-3-1-6-released/index.html +181 -116
  174. data/site/news/2016/06/03/update-on-jekyll-s-google-summer-of-code-projects/index.html +179 -114
  175. data/site/news/2016/07/26/jekyll-3-2-0-released/index.html +184 -119
  176. data/site/news/2016/08/02/jekyll-3-2-1-released/index.html +180 -115
  177. data/site/news/2016/08/24/jekyll-admin-initial-release/index.html +179 -114
  178. data/site/news/2016/10/06/jekyll-3-3-is-here/index.html +207 -142
  179. data/site/news/2016/11/14/jekyll-3-3-1-released/index.html +181 -116
  180. data/site/news/2017/01/18/jekyll-3-4-0-released/index.html +183 -118
  181. data/site/news/2017/03/02/jekyll-3-4-1-released/index.html +181 -116
  182. data/site/news/2017/03/09/jekyll-3-4-2-released/index.html +189 -124
  183. data/site/news/2017/03/21/jekyll-3-4-3-released/index.html +190 -125
  184. data/site/news/2017/06/15/jekyll-3-5-0-released/index.html +187 -122
  185. data/site/news/2017/07/17/jekyll-3-5-1-released/index.html +182 -117
  186. data/site/news/2017/08/12/jekyll-3-5-2-released/index.html +185 -120
  187. data/site/news/2017/09/21/jekyll-3-6-0-released/index.html +181 -116
  188. data/site/news/2017/10/19/diversity-open-source/index.html +181 -116
  189. data/site/news/2017/10/21/jekyll-3-6-2-released/index.html +183 -118
  190. data/site/news/2018/01/02/jekyll-3-7-0-released/index.html +184 -119
  191. data/site/news/2018/01/25/jekyll-3-7-2-released/index.html +189 -124
  192. data/site/news/2018/02/19/meet-jekyll-s-new-lead-developer/index.html +180 -115
  193. data/site/news/2018/02/24/jekyll-3-7-3-released/index.html +185 -120
  194. data/site/news/2018/04/19/development-update/index.html +699 -0
  195. data/site/news/2018/04/19/jekyll-3-8-0-released/index.html +715 -0
  196. data/site/news/2018/05/01/jekyll-3-8-1-released/index.html +182 -117
  197. data/site/news/2018/05/19/jekyll-3-8-2-released/index.html +181 -116
  198. data/site/news/2018/06/05/jekyll-3-8-3-released/index.html +183 -118
  199. data/site/news/2018/08/01/jekyll-sponsoring/index.html +748 -0
  200. data/site/news/2018/09/19/security-fixes-for-3-6-3-7-3-8/index.html +692 -0
  201. data/site/news/2018/11/04/jekyll-3-8-5-released/index.html +682 -0
  202. data/site/news/2019/03/18/jekyll-4-0-0-pre-alpha1-released/index.html +710 -0
  203. data/site/news/2019/07/02/jekyll-3-8-6-released/index.html +180 -115
  204. data/site/news/2019/07/20/jekyll-4-0-0-pre-beta1-released/index.html +11 -0
  205. data/site/news/2019/08/04/jekyll-4-0-0-pre-beta1-released/index.html +708 -0
  206. data/site/news/2019/08/20/jekyll-4-0-0-released/index.html +809 -0
  207. data/site/news/index.html +976 -326
  208. data/site/news/releases/index.html +820 -321
  209. data/site/{philosophy.html → philosophy/index.html} +1 -1
  210. data/site/redirects.json +1 -1
  211. data/site/resources/index.html +332 -0
  212. data/site/showcase/index.html +844 -0
  213. data/site/sitemap.xml +256 -81
  214. data/site/team/index.html +63 -77
  215. data/site/tutorials/cache-api/index.html +418 -0
  216. data/site/tutorials/convert-site-to-jekyll/index.html +155 -124
  217. data/site/tutorials/custom-404-page/index.html +76 -43
  218. data/site/tutorials/home/index.html +64 -37
  219. data/site/tutorials/navigation/index.html +186 -103
  220. data/site/tutorials/orderofinterpretation/index.html +80 -53
  221. data/site/tutorials/using-jekyll-with-bundler/index.html +80 -51
  222. data/site/tutorials/video-walkthroughs/index.html +62 -35
  223. metadata +102 -13
  224. data/site/community/index.html +0 -11
  225. data/site/docs/continuous-integration/index.html +0 -681
@@ -3,32 +3,35 @@
3
3
  <head>
4
4
  <meta charset="UTF-8">
5
5
  <meta name="viewport" content="width=device-width,initial-scale=1">
6
- <meta name="generator" content="Jekyll v3.9.0">
6
+ <meta name="generator" content="Jekyll v4.0.0">
7
7
  <link type="application/atom+xml" rel="alternate" href="https://jekyllrb.com/feed.xml" title="Jekyll • Simple, blog-aware, static sites" />
8
+ <link type="application/atom+xml" rel="alternate" href="/feed/release.xml" title="Jekyll releases posts" />
8
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">
9
- <link rel="preconnect" href="https://fonts.gstatic.com/" crossorigin>
10
- <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Lato:300,300italic,400,400italic,700,700italic,900">
11
- <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css" />
10
+ <link rel="preload" href="/fonts/lato-v14-latin-300.woff2" as="font" type="font/woff2" crossorigin />
11
+ <link rel="preload" href="/fonts/lato-v14-latin-700.woff2" as="font" type="font/woff2" crossorigin />
12
+ <link rel="preload" href="/css/screen.css" as="style">
12
13
  <link rel="stylesheet" href="/css/screen.css">
13
14
  <link rel="icon" type="image/x-icon" href="/favicon.ico">
14
15
  <!-- Begin Jekyll SEO tag v2.6.1 -->
15
16
  <title>Configuration | Jekyll • Simple, blog-aware, static sites</title>
16
- <meta name="generator" content="Jekyll v3.9.0" />
17
+ <meta name="generator" content="Jekyll v4.0.0" />
17
18
  <meta property="og:title" content="Configuration" />
18
19
  <meta property="og:locale" content="en_US" />
19
- <meta name="description" content="Jekyll allows you to concoct your sites in any way you can dream up, and it’s thanks to the powerful and flexible configuration options that this is possible. These options can either be specified in a _config.yml file placed in your site’s root directory, or can be specified as flags for the jekyll executable in the terminal." />
20
- <meta property="og:description" content="Jekyll allows you to concoct your sites in any way you can dream up, and it’s thanks to the powerful and flexible configuration options that this is possible. These options can either be specified in a _config.yml file placed in your site’s root directory, or can be specified as flags for the jekyll executable in the terminal." />
20
+ <meta name="description" content="Jekyll gives you a lot of flexibility to customize how it builds your site. These options can either be specified in a _config.yml or _config.toml file placed in your site’s root directory, or can be specified as flags for the jekyll executable in the terminal." />
21
+ <meta property="og:description" content="Jekyll gives you a lot of flexibility to customize how it builds your site. These options can either be specified in a _config.yml or _config.toml file placed in your site’s root directory, or can be specified as flags for the jekyll executable in the terminal." />
21
22
  <link rel="canonical" href="https://jekyllrb.com/docs/configuration/" />
22
23
  <meta property="og:url" content="https://jekyllrb.com/docs/configuration/" />
23
24
  <meta property="og:site_name" content="Jekyll • Simple, blog-aware, static sites" />
25
+ <meta property="og:image" content="https://jekyllrb.com/img/jekyll-og.png" />
24
26
  <meta property="og:type" content="article" />
25
- <meta property="article:published_time" content="2020-08-05T11:55:36-07:00" />
26
- <meta name="twitter:card" content="summary" />
27
+ <meta property="article:published_time" content="2019-09-11T07:30:27-07:00" />
28
+ <meta name="twitter:card" content="summary_large_image" />
29
+ <meta property="twitter:image" content="https://jekyllrb.com/img/jekyll-og.png" />
27
30
  <meta property="twitter:title" content="Configuration" />
28
31
  <meta name="twitter:site" content="@jekyllrb" />
29
32
  <meta name="google-site-verification" content="onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY" />
30
33
  <script type="application/ld+json">
31
- {"url":"https://jekyllrb.com/docs/configuration/","headline":"Configuration","dateModified":"2020-08-05T11:55:36-07:00","datePublished":"2020-08-05T11:55:36-07:00","publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://jekyllrb.com/img/logo-2x.png"}},"description":"Jekyll allows you to concoct your sites in any way you can dream up, and it’s thanks to the powerful and flexible configuration options that this is possible. These options can either be specified in a _config.yml file placed in your site’s root directory, or can be specified as flags for the jekyll executable in the terminal.","mainEntityOfPage":{"@type":"WebPage","@id":"https://jekyllrb.com/docs/configuration/"},"@type":"BlogPosting","@context":"https://schema.org"}</script>
34
+ {"description":"Jekyll gives you a lot of flexibility to customize how it builds your site. These options can either be specified in a _config.yml or _config.toml file placed in your site’s root directory, or can be specified as flags for the jekyll executable in the terminal.","@type":"BlogPosting","mainEntityOfPage":{"@type":"WebPage","@id":"https://jekyllrb.com/docs/configuration/"},"headline":"Configuration","dateModified":"2019-09-11T07:30:27-07:00","url":"https://jekyllrb.com/docs/configuration/","datePublished":"2019-09-11T07:30:27-07:00","image":"https://jekyllrb.com/img/jekyll-og.png","publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://jekyllrb.com/img/logo-2x.png"}},"@context":"https://schema.org"}</script>
32
35
  <!-- End Jekyll SEO tag -->
33
36
 
34
37
  <!--[if lt IE 9]>
@@ -51,18 +54,27 @@
51
54
  </div>
52
55
  <nav class="main-nav hide-on-mobiles">
53
56
  <ul>
54
- <li class="">
57
+
58
+ <li>
55
59
  <a href="/">Home</a>
56
60
  </li>
61
+
57
62
  <li class="current">
58
- <a href="/docs/home/">Docs</a>
63
+ <a href="/docs/">Docs</a>
59
64
  </li>
60
- <li class="">
61
- <a href="/news/">News</a>
65
+
66
+ <li>
67
+ <a href="/resources/">Resources</a>
68
+ </li>
69
+
70
+ <li>
71
+ <a href="/showcase/">Showcase</a>
62
72
  </li>
63
- <li class="">
64
- <a href="/help/">Help</a>
73
+
74
+ <li>
75
+ <a href="/news/">News</a>
65
76
  </li>
77
+
66
78
  </ul>
67
79
 
68
80
  </nav>
@@ -73,7 +85,7 @@
73
85
  <div class="meta hide-on-mobiles">
74
86
  <ul>
75
87
  <li>
76
- <a href="https://github.com/jekyll/jekyll/releases/tag/v3.9.0">v3.9.0</a>
88
+ <a href="https://github.com/jekyll/jekyll/releases/tag/v4.0.0">v4.0.0</a>
77
89
  </li>
78
90
  <li>
79
91
  <a href="https://github.com/jekyll/jekyll">GitHub</a>
@@ -83,18 +95,24 @@
83
95
  </div>
84
96
  <nav class="mobile-nav show-on-mobiles">
85
97
  <ul>
86
- <li class="">
87
- <a href="/">Home</a>
88
- </li>
89
- <li class="current">
90
- <a href="/docs/home/">Docs</a>
91
- </li>
92
- <li class="">
93
- <a href="/news/">News</a>
94
- </li>
95
- <li class="">
96
- <a href="/help/">Help</a>
97
- </li>
98
+
99
+ <li>
100
+ <a href="/">Home</a>
101
+ </li>
102
+
103
+ <li class="current">
104
+ <a href="/docs/">Docs</a>
105
+ </li>
106
+
107
+ <li>
108
+ <a href="/resources/">Resources</a>
109
+ </li>
110
+
111
+
112
+ <li>
113
+ <a href="/news/">News</a>
114
+ </li>
115
+
98
116
  <li>
99
117
  <a href="https://github.com/jekyll/jekyll">GitHub</a>
100
118
  </li>
@@ -113,176 +131,152 @@
113
131
 
114
132
  <optgroup label="Getting Started">
115
133
 
116
-
117
-
118
- <option value="/docs/home/">Welcome</option>
119
-
120
-
121
-
122
- <option value="/docs/quickstart/">Quick-start guide</option>
123
-
124
-
125
-
126
- <option value="/docs/installation/">Installation</option>
127
-
128
-
129
-
130
- <option value="/docs/windows/">Jekyll on Windows</option>
131
-
132
-
133
-
134
- <option value="/docs/usage/">Basic Usage</option>
135
-
136
-
137
-
138
- <option value="/docs/structure/">Directory structure</option>
139
-
140
-
141
-
142
- <option value="/docs/configuration/">Configuration</option>
143
-
144
-
145
- </optgroup>
146
-
147
- <optgroup label="Your Content">
134
+
135
+ <option value="/docs/">
136
+ Quickstart
137
+ </option>
138
+
139
+
140
+ <option value="/docs/ruby-101/">
141
+ Ruby 101
142
+ </option>
143
+
144
+
145
+ <option value="/docs/installation/">
146
+ Installation
147
+ </option>
148
+
149
+
150
+ <option value="/docs/community/">
151
+ Community
152
+ </option>
153
+
154
+
155
+ <option value="/docs/step-by-step/01-setup/">
156
+ Step by Step Tutorial
157
+ </option>
148
158
 
149
-
150
-
151
- <option value="/docs/frontmatter/">Front Matter</option>
152
-
153
-
154
-
155
- <option value="/docs/posts/">Writing posts</option>
156
-
157
-
158
-
159
- <option value="/docs/drafts/">Working with drafts</option>
160
-
161
-
162
-
163
- <option value="/docs/pages/">Creating pages</option>
164
-
165
-
166
-
167
- <option value="/docs/static-files/">Static Files</option>
168
-
169
-
170
-
171
- <option value="/docs/variables/">Variables</option>
172
-
173
-
174
-
175
- <option value="/docs/collections/">Collections</option>
176
-
177
-
178
-
179
- <option value="/docs/datafiles/">Data Files</option>
180
-
181
-
182
-
183
- <option value="/docs/assets/">Assets</option>
184
-
185
-
186
-
187
- <option value="/docs/migrations/">Blog migrations</option>
188
-
189
-
190
159
  </optgroup>
191
160
 
192
- <optgroup label="Customization">
161
+ <optgroup label="Build">
162
+
163
+
164
+ <option value="/docs/usage/">
165
+ Command Line Usage
166
+ </option>
167
+
168
+
169
+ <option value="/docs/configuration/">
170
+ Configuration
171
+ </option>
193
172
 
194
-
195
-
196
- <option value="/docs/templates/">Templates</option>
197
-
198
-
199
-
200
- <option value="/docs/includes/">Includes</option>
201
-
202
-
203
-
204
- <option value="/docs/permalinks/">Permalinks</option>
205
-
206
-
207
-
208
- <option value="/docs/pagination/">Pagination</option>
209
-
210
-
211
-
212
- <option value="/docs/plugins/">Plugins</option>
213
-
214
-
215
-
216
- <option value="/docs/themes/">Themes</option>
217
-
218
-
219
-
220
- <option value="/docs/extras/">Extras</option>
221
-
222
-
223
173
  </optgroup>
224
174
 
225
- <optgroup label="Deployment">
175
+ <optgroup label="Content">
176
+
177
+
178
+ <option value="/docs/pages/">
179
+ Pages
180
+ </option>
181
+
182
+
183
+ <option value="/docs/posts/">
184
+ Posts
185
+ </option>
186
+
187
+
188
+ <option value="/docs/front-matter/">
189
+ Front Matter
190
+ </option>
191
+
192
+
193
+ <option value="/docs/collections/">
194
+ Collections
195
+ </option>
196
+
197
+
198
+ <option value="/docs/datafiles/">
199
+ Data Files
200
+ </option>
201
+
202
+
203
+ <option value="/docs/assets/">
204
+ Assets
205
+ </option>
206
+
207
+
208
+ <option value="/docs/static-files/">
209
+ Static Files
210
+ </option>
226
211
 
227
-
228
-
229
- <option value="/docs/github-pages/">GitHub Pages</option>
230
-
231
-
232
-
233
- <option value="/docs/deployment-methods/">Deployment methods</option>
234
-
235
-
236
-
237
- <option value="/docs/continuous-integration/">Continuous Integration</option>
238
-
239
-
240
212
  </optgroup>
241
213
 
242
- <optgroup label="Miscellaneous">
214
+ <optgroup label="Site Structure">
215
+
216
+
217
+ <option value="/docs/structure/">
218
+ Directory Structure
219
+ </option>
220
+
221
+
222
+ <option value="/docs/liquid/">
223
+ Liquid
224
+ </option>
225
+
226
+
227
+ <option value="/docs/variables/">
228
+ Variables
229
+ </option>
230
+
231
+
232
+ <option value="/docs/includes/">
233
+ Includes
234
+ </option>
235
+
236
+
237
+ <option value="/docs/layouts/">
238
+ Layouts
239
+ </option>
240
+
241
+
242
+ <option value="/docs/permalinks/">
243
+ Permalinks
244
+ </option>
245
+
246
+
247
+ <option value="/docs/themes/">
248
+ Themes
249
+ </option>
250
+
251
+
252
+ <option value="/docs/pagination/">
253
+ Pagination
254
+ </option>
243
255
 
244
-
245
-
246
- <option value="/docs/troubleshooting/">Troubleshooting</option>
247
-
248
-
249
-
250
- <option value="/docs/sites/">Sites using Jekyll</option>
251
-
252
-
253
-
254
- <option value="/docs/resources/">Resources</option>
255
-
256
-
257
-
258
- <option value="/docs/upgrading/0-to-2/">Upgrading from 0.x to 2.x</option>
259
-
260
-
261
-
262
- <option value="/docs/upgrading/2-to-3/">Upgrading from 2.x to 3.x</option>
263
-
264
-
265
256
  </optgroup>
266
257
 
267
- <optgroup label="Meta">
258
+ <optgroup label="Guides">
259
+
260
+
261
+ <option value="/docs/plugins/">
262
+ Plugins
263
+ </option>
264
+
265
+
266
+ <option value="/docs/migrations/">
267
+ Blog Migrations
268
+ </option>
269
+
270
+
271
+ <option value="/docs/upgrading/">
272
+ Upgrading
273
+ </option>
274
+
275
+
276
+ <option value="/docs/deployment/">
277
+ Deployment
278
+ </option>
268
279
 
269
-
270
-
271
- <option value="/docs/contributing/">Contributing</option>
272
-
273
-
274
-
275
- <option value="/docs/maintaining/">Maintaining Jekyll</option>
276
-
277
-
278
-
279
- <option value="/docs/conduct/">Code of Conduct</option>
280
-
281
-
282
-
283
- <option value="/docs/history/">History</option>
284
-
285
-
286
280
  </optgroup>
287
281
 
288
282
  </select>
@@ -292,1065 +286,237 @@
292
286
  <div class="unit four-fifths">
293
287
  <article>
294
288
  <div class="improve right hide-on-mobiles">
295
- <a href="https://github.com/jekyll/jekyll/edit/master/docs/_docs/configuration.md"><i class="fa fa-pencil"></i>  Improve this page</a>
289
+ <a data-proofer-ignore href="https://github.com/jekyll/jekyll/edit/master/docs/_docs/configuration.md"><i class="fa fa-pencil"></i> &nbsp;Improve this page</a>
296
290
  </div>
297
291
  <h1>Configuration</h1>
298
- <p>Jekyll allows you to concoct your sites in any way you can dream up, and it’s
299
- thanks to the powerful and flexible configuration options that this is possible.
300
- These options can either be specified in a <code class="language-plaintext highlighter-rouge">_config.yml</code> file placed in your
301
- site’s root directory, or can be specified as flags for the <code class="language-plaintext highlighter-rouge">jekyll</code> executable
302
- in the terminal.</p>
303
-
304
- <h2 id="configuration-settings">Configuration Settings</h2>
305
-
306
- <h3 id="global-configuration">Global Configuration</h3>
307
-
308
- <p>The table below lists the available settings for Jekyll, and the various <code class="option">options</code> (specified in the configuration file) and <code class="flag">flags</code> (specified on the command-line) that control them.</p>
309
-
310
- <div class="mobile-side-scroller">
311
- <table>
312
- <thead>
313
- <tr>
314
- <th>Setting</th>
315
- <th>
316
- <span class="option">Options</span> and <span class="flag">Flags</span>
317
- </th>
318
- </tr>
319
- </thead>
320
- <tbody>
321
- <tr class="setting">
322
- <td>
323
- <p class="name"><strong>Site Source</strong></p>
324
- <p class="description">Change the directory where Jekyll will read files</p>
325
- </td>
326
- <td class="align-center">
327
- <p><code class="option">source: DIR</code></p>
328
- <p><code class="flag">-s, --source DIR</code></p>
329
- </td>
330
- </tr>
331
- <tr class="setting">
332
- <td>
333
- <p class="name"><strong>Site Destination</strong></p>
334
- <p class="description">Change the directory where Jekyll will write files</p>
335
- </td>
336
- <td class="align-center">
337
- <p><code class="option">destination: DIR</code></p>
338
- <p><code class="flag">-d, --destination DIR</code></p>
339
- </td>
340
- </tr>
341
- <tr class="setting">
342
- <td>
343
- <p class="name"><strong>Safe</strong></p>
344
- <p class="description">Disable <a href="../plugins/">custom plugins, and ignore symbolic links</a>.</p>
345
- </td>
346
- <td class="align-center">
347
- <p><code class="option">safe: BOOL</code></p>
348
- <p><code class="flag">--safe</code></p>
349
- </td>
350
- </tr>
351
- <tr class="setting">
352
- <td>
353
- <p class="name"><strong>Exclude</strong></p>
354
- <p class="description">
355
- Exclude directories and/or files from the
356
- conversion. These exclusions are relative to the site's
357
- source directory and cannot be outside the source directory.
358
- </p>
359
- </td>
360
- <td class="align-center">
361
- <p><code class="option">exclude: [DIR, FILE, ...]</code></p>
362
- </td>
363
- </tr>
364
- <tr class="setting">
365
- <td>
366
- <p class="name"><strong>Include</strong></p>
367
- <p class="description">
368
- Force inclusion of directories and/or files in the conversion.
369
- <code>.htaccess</code> is a good example since dotfiles are excluded
370
- by default.
371
- </p>
372
- </td>
373
- <td class="align-center">
374
- <p><code class="option">include: [DIR, FILE, ...]</code></p>
375
- </td>
376
- </tr>
377
- <tr class="setting">
378
- <td>
379
- <p class="name"><strong>Keep files</strong></p>
380
- <p class="description">
381
- When clobbering the site destination, keep the selected files.
382
- Useful for files that are not generated by jekyll; e.g. files or
383
- assets that are generated by your build tool.
384
- The paths are relative to the <code>destination</code>.
385
- </p>
386
- </td>
387
- <td class="align-center">
388
- <p><code class="option">keep_files: [DIR, FILE, ...]</code></p>
389
- </td>
390
- </tr>
391
- <tr class="setting">
392
- <td>
393
- <p class="name"><strong>Time Zone</strong></p>
394
- <p class="description">
395
- Set the time zone for site generation. This sets the <code>TZ</code>
396
- environment variable, which Ruby uses to handle time and date
397
- creation and manipulation. Any entry from the
398
- <a href="https://en.wikipedia.org/wiki/Tz_database">IANA Time Zone
399
- Database</a> is valid, e.g. <code>America/New_York</code>. A list of all
400
- available values can be found <a href="https://en.wikipedia.org/wiki/List_of_tz_database_time_zones">
401
- here</a>. When serving on a local machine, the default time zone is set by your operating system. But when served on a remote host/server, the default time zone depends on the server's setting or location.
402
- </p>
403
- </td>
404
- <td class="align-center">
405
- <p><code class="option">timezone: TIMEZONE</code></p>
406
- </td>
407
- </tr>
408
- <tr class="setting">
409
- <td>
410
- <p class="name"><strong>Encoding</strong></p>
411
- <p class="description">
412
- Set the encoding of files by name (only available for Ruby
413
- 1.9 or later).
414
- The default value is <code>utf-8</code> starting in 2.0.0,
415
- and <code>nil</code> before 2.0.0, which will yield the Ruby
416
- default of <code>ASCII-8BIT</code>.
417
- Available encodings can be shown by the
418
- command <code>ruby -e 'puts Encoding::list.join("\n")'</code>.
419
- </p>
420
- </td>
421
- <td class="align-center">
422
- <p><code class="option">encoding: ENCODING</code></p>
423
- </td>
424
- </tr>
425
- <tr>
426
- <td>
427
- <p class="name"><strong>Defaults</strong></p>
428
- <p class="description">
429
- Set defaults for <a href="../frontmatter/" title="YAML Front Matter">YAML Front Matter</a>
430
- variables.
431
- </p>
432
- </td>
433
- <td class="align-center">
434
- <p>see <a href="#front-matter-defaults" title="details">below</a></p>
435
- </td>
436
- </tr>
437
- </tbody>
438
- </table>
439
- </div>
440
-
441
- <div class="note warning">
442
- <h5>Destination folders are cleaned on site builds</h5>
443
- <p>
444
- The contents of <code>&lt;destination&gt;</code> are automatically
445
- cleaned, by default, when the site is built. Files or folders that are not
446
- created by your site will be removed. Some files could be retained
447
- by specifying them within the <code>&lt;keep_files&gt;</code> configuration directive.
448
- </p>
449
- <p>
450
- Do not use an important location for <code>&lt;destination&gt;</code>; instead, use it as
451
- a staging area and copy files from there to your web server.
452
- </p>
453
- </div>
454
-
455
- <h3 id="build-command-options">Build Command Options</h3>
456
-
457
- <div class="mobile-side-scroller">
458
- <table>
459
- <thead>
460
- <tr>
461
- <th>Setting</th>
462
- <th>
463
- <span class="option">Options</span> and <span class="flag">Flags</span>
464
- </th>
465
- </tr>
466
- </thead>
467
- <tbody>
468
- <tr class="setting">
469
- <td>
470
- <p class="name"><strong>Regeneration</strong></p>
471
- <p class="description">Enable auto-regeneration of the site when files are modified.</p>
472
- </td>
473
- <td class="align-center">
474
- <p><code class="flag">-w, --[no-]watch</code></p>
475
- </td>
476
- </tr>
477
- <tr class="setting">
478
- <td>
479
- <p class="name"><strong>Configuration</strong></p>
480
- <p class="description">Specify config files instead of using <code>_config.yml</code> automatically. Settings in later files override settings in earlier files.</p>
481
- </td>
482
- <td class="align-center">
483
- <p><code class="flag">--config FILE1[,FILE2,...]</code></p>
484
- </td>
485
- </tr>
486
- <tr class="setting">
487
- <td>
488
- <p class="name"><strong>Drafts</strong></p>
489
- <p class="description">Process and render draft posts.</p>
490
- </td>
491
- <td class="align-center">
492
- <p><code class="option">show_drafts: BOOL</code></p>
493
- <p><code class="flag">--drafts</code></p>
494
- </td>
495
- </tr>
496
- <tr class="setting">
497
- <td>
498
- <p class="name"><strong>Environment</strong></p>
499
- <p class="description">Use a specific environment value in the build.</p>
500
- </td>
501
- <td class="align-center">
502
- <p><code class="flag">JEKYLL_ENV=production</code></p>
503
- </td>
504
- </tr>
505
- <tr class="setting">
506
- <td>
507
- <p class="name"><strong>Future</strong></p>
508
- <p class="description">Publish posts or collection documents with a future date.</p>
509
- </td>
510
- <td class="align-center">
511
- <p><code class="option">future: BOOL</code></p>
512
- <p><code class="flag">--future</code></p>
513
- </td>
514
- </tr>
515
- <tr class="setting">
516
- <td>
517
- <p class="name"><strong>Unpublished</strong></p>
518
- <p class="description">Render posts that were marked as unpublished.</p>
519
- </td>
520
- <td class="align-center">
521
- <p><code class="option">unpublished: BOOL</code></p>
522
- <p><code class="flag">--unpublished</code></p>
523
- </td>
524
- </tr>
525
- <tr class="setting">
526
- <td>
527
- <p class="name"><strong>LSI</strong></p>
528
- <p class="description">Produce an index for related posts. Requires the <a href="http://www.classifier-reborn.com/">classifier-reborn</a> plugin.</p>
529
- </td>
530
- <td class="align-center">
531
- <p><code class="option">lsi: BOOL</code></p>
532
- <p><code class="flag">--lsi</code></p>
533
- </td>
534
- </tr>
535
- <tr class="setting">
536
- <td>
537
- <p class="name"><strong>Limit Posts</strong></p>
538
- <p class="description">Limit the number of posts to parse and publish.</p>
539
- </td>
540
- <td class="align-center">
541
- <p><code class="option">limit_posts: NUM</code></p>
542
- <p><code class="flag">--limit_posts NUM</code></p>
543
- </td>
544
- </tr>
545
- <tr class="setting">
546
- <td>
547
- <p class="name"><strong>Force polling</strong></p>
548
- <p class="description">Force watch to use polling.</p>
549
- </td>
550
- <td class="align-center">
551
- <p><code class="flag">--force_polling</code></p>
552
- </td>
553
- </tr>
554
- <tr class="setting">
555
- <td>
556
- <p class="name"><strong>Verbose output</strong></p>
557
- <p class="description">Print verbose output.</p>
558
- </td>
559
- <td class="align-center">
560
- <p><code class="flag">-V, --verbose</code></p>
561
- </td>
562
- </tr>
563
- <tr class="setting">
564
- <td>
565
- <p class="name"><strong>Silence Output</strong></p>
566
- <p class="description">Silence the normal output from Jekyll
567
- during a build</p>
568
- </td>
569
- <td class="align-center">
570
- <p><code class="flag">-q, --quiet</code></p>
571
- </td>
572
- </tr>
573
- <tr class="setting">
574
- <td>
575
- <p class="name"><strong>Incremental build</strong></p>
576
- <p class="description">
577
- Enable the experimental incremental build feature. Incremental build only
578
- re-builds posts and pages that have changed, resulting in significant performance
579
- improvements for large sites, but may also break site generation in certain
580
- cases.
581
- </p>
582
- </td>
583
- <td class="align-center">
584
- <p><code class="option">incremental: BOOL</code></p>
585
- <p><code class="flag">-I, --incremental</code></p>
586
- </td>
587
- </tr>
588
- <tr class="setting">
589
- <td>
590
- <p class="name"><strong>Liquid profiler</strong></p>
591
- <p class="description">
592
- Generate a Liquid rendering profile to help you identify performance bottlenecks.
593
- </p>
594
- </td>
595
- <td class="align-center">
596
- <p><code class="option">profile: BOOL</code></p>
597
- <p><code class="flag">--profile</code></p>
598
- </td>
599
- </tr>
600
- <tr class="setting">
601
- <td>
602
- <p class="name"><strong>Strict Front Matter</strong></p>
603
- <p class="description">
604
- Cause a build to fail if there is a YAML syntax error in a page's front matter.
605
- </p>
606
- </td>
607
- <td class="align-center">
608
- <p><code class="option">strict_front_matter: BOOL</code></p>
609
- <p><code class="flag">--strict_front_matter</code></p>
610
- </td>
611
- </tr>
612
- </tbody>
613
- </table>
614
- </div>
615
-
616
- <h3 id="serve-command-options">Serve Command Options</h3>
617
-
618
- <p>In addition to the options below, the <code class="language-plaintext highlighter-rouge">serve</code> sub-command can accept any of the options
619
- for the <code class="language-plaintext highlighter-rouge">build</code> sub-command, which are then applied to the site build which occurs right
620
- before your site is served.</p>
621
-
622
- <div class="mobile-side-scroller">
623
- <table>
624
- <thead>
625
- <tr>
626
- <th>Setting</th>
627
- <th>
628
- <span class="option">Options</span> and <span class="flag">Flags</span>
629
- </th>
630
- </tr>
631
- </thead>
632
- <tbody>
633
- <tr class="setting">
634
- <td>
635
- <p class="name"><strong>Local Server Port</strong></p>
636
- <p class="description">Listen on the given port.</p>
637
- </td>
638
- <td class="align-center">
639
- <p><code class="option">port: PORT</code></p>
640
- <p><code class="flag">--port PORT</code></p>
641
- </td>
642
- </tr>
643
- <tr class="setting">
644
- <td>
645
- <p class="name"><strong>Local Server Hostname</strong></p>
646
- <p class="description">Listen at the given hostname.</p>
647
- </td>
648
- <td class="align-center">
649
- <p><code class="option">host: HOSTNAME</code></p>
650
- <p><code class="flag">--host HOSTNAME</code></p>
651
- </td>
652
- </tr>
653
- <tr class="setting">
654
- <td>
655
- <p class="name"><strong>Base URL</strong></p>
656
- <p class="description">Serve the website from the given base URL</p>
657
- </td>
658
- <td class="align-center">
659
- <p><code class="option">baseurl: URL</code></p>
660
- <p><code class="flag">--baseurl URL</code></p>
661
- </td>
662
- </tr>
663
- <tr class="setting">
664
- <td>
665
- <p class="name"><strong>Detach</strong></p>
666
- <p class="description">Detach the server from the terminal</p>
667
- </td>
668
- <td class="align-center">
669
- <p><code class="option">detach: BOOL</code></p>
670
- <p><code class="flag">-B, --detach</code></p>
671
- </td>
672
- </tr>
673
- <tr class="setting">
674
- <td>
675
- <p class="name"><strong>Skips the initial site build.</strong></p>
676
- <p class="description">Skips the initial site build which occurs before the server is started.</p>
677
- </td>
678
- <td class="align-center">
679
- <p><code class="flag">--skip-initial-build</code></p>
680
- </td>
681
- </tr>
682
- <tr class="setting">
683
- <td>
684
- <p class="name"><strong>X.509 (SSL) Private Key</strong></p>
685
- <p class="description">SSL Private Key.</p>
686
- </td>
687
- <td class="align-center">
688
- <p><code class="flag">--ssl-key</code></p>
689
- </td>
690
- </tr>
691
- <tr class="setting">
692
- <td>
693
- <p class="name"><strong>X.509 (SSL) Certificate</strong></p>
694
- <p class="description">SSL Public certificate.</p>
695
- </td>
696
- <td class="align-center">
697
- <p><code class="flag">--ssl-cert</code></p>
698
- </td>
699
- </tr>
700
- </tbody>
701
- </table>
702
- </div>
703
-
704
- <div class="note warning">
705
- <h5>Do not use tabs in configuration files</h5>
706
- <p>
707
- This will either lead to parsing errors, or Jekyll will revert to the
708
- default settings. Use spaces instead.
709
- </p>
710
- </div>
711
-
712
- <h2 id="custom-webrick-headers">Custom WEBrick Headers</h2>
713
-
714
- <p>You can provide custom headers for your site by adding them to <code class="language-plaintext highlighter-rouge">_config.yml</code></p>
715
-
716
- <div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="c1"># File: _config.yml</span>
717
- <span class="na">webrick</span><span class="pi">:</span>
718
- <span class="na">headers</span><span class="pi">:</span>
719
- <span class="na">My-Header</span><span class="pi">:</span> <span class="s">My-Value</span>
720
- <span class="na">My-Other-Header</span><span class="pi">:</span> <span class="s">My-Other-Value</span>
721
- </code></pre></div></div>
722
-
723
- <h3 id="defaults">Defaults</h3>
724
-
725
- <p>We provide by default <code class="language-plaintext highlighter-rouge">Content-Type</code> and <code class="language-plaintext highlighter-rouge">Cache-Control</code> response headers: one
726
- dynamic in order to specify the nature of the data being served, the other
727
- static in order to disable caching so that you don’t have to fight with Chrome’s
728
- aggressive caching when you are in development mode.</p>
729
-
730
- <h2 id="specifying-a-jekyll-environment-at-build-time">Specifying a Jekyll environment at build time</h2>
731
-
732
- <p>In the build (or serve) arguments, you can specify a Jekyll environment and value. The build will then apply this value in any conditional statements in your content.</p>
733
-
734
- <p>For example, suppose you set this conditional statement in your code:</p>
735
-
736
- <div class="language-liquid highlighter-rouge"><div class="highlight"><pre class="highlight"><code>
737
- <span class="p">{%</span><span class="w"> </span><span class="kr">if</span><span class="w"> </span><span class="nv">jekyll</span><span class="p">.</span><span class="nv">environment</span><span class="w"> </span><span class="o">==</span><span class="w"> </span><span class="s2">"production"</span><span class="w"> </span><span class="p">%}</span>
738
- <span class="p">{%</span><span class="w"> </span><span class="nt">include</span><span class="w"> </span>disqus.html<span class="w"> </span><span class="p">%}</span>
739
- <span class="p">{%</span><span class="w"> </span><span class="kr">endif</span><span class="w"> </span><span class="p">%}</span>
740
-
741
- </code></pre></div></div>
742
-
743
- <p>When you build your Jekyll site, the content inside the <code class="language-plaintext highlighter-rouge">if</code> statement won’t be run unless you also specify a <code class="language-plaintext highlighter-rouge">production</code> environment in the build command, like this:</p>
744
-
745
- <div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">JEKYLL_ENV</span><span class="o">=</span>production jekyll build
746
- </code></pre></div></div>
747
-
748
- <p>Specifying an environment value allows you to make certain content available only within specific environments.</p>
749
-
750
- <p>The default value for <code class="language-plaintext highlighter-rouge">JEKYLL_ENV</code> is <code class="language-plaintext highlighter-rouge">development</code>. Therefore if you omit <code class="language-plaintext highlighter-rouge">JEKYLL_ENV</code> from the build arguments, the default value will be <code class="language-plaintext highlighter-rouge">JEKYLL_ENV=development</code>. Any content inside <code class="language-plaintext highlighter-rouge">{% if jekyll.environment == "development" %}</code> tags will automatically appear in the build.</p>
751
-
752
- <p>Your environment values can be anything you want (not just <code class="language-plaintext highlighter-rouge">development</code> or <code class="language-plaintext highlighter-rouge">production</code>). Some elements you might want to hide in development environments include Disqus comment forms or Google Analytics. Conversely, you might want to expose an “Edit me in GitHub” button in a development environment but not include it in production environments.</p>
753
-
754
- <p>By specifying the option in the build command, you avoid having to change values in your configuration files when moving from one environment to another.</p>
755
-
756
- <h2 id="front-matter-defaults">Front Matter defaults</h2>
757
-
758
- <p>Using <a href="../frontmatter/">YAML Front Matter</a> is one way that you can specify configuration in the pages and posts for your site. Setting things like a default layout, or customizing the title, or specifying a more precise date/time for the post can all be added to your page or post front matter.</p>
759
-
760
- <p>Often times, you will find that you are repeating a lot of configuration options. Setting the same layout in each file, adding the same category - or categories - to a post, etc. You can even add custom variables like author names, which might be the same for the majority of posts on your blog.</p>
761
-
762
- <p>Instead of repeating this configuration each time you create a new post or page, Jekyll provides a way to set these defaults in the site configuration. To do this, you can specify site-wide defaults using the <code class="language-plaintext highlighter-rouge">defaults</code> key in the <code class="language-plaintext highlighter-rouge">_config.yml</code> file in your project’s root directory.</p>
763
-
764
- <p>The <code class="language-plaintext highlighter-rouge">defaults</code> key holds an array of scope/values pairs that define what defaults should be set for a particular file path, and optionally, a file type in that path.</p>
765
-
766
- <p>Let’s say that you want to add a default layout to all pages and posts in your site. You would add this to your <code class="language-plaintext highlighter-rouge">_config.yml</code> file:</p>
767
-
768
- <div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">defaults</span><span class="pi">:</span>
769
- <span class="pi">-</span>
770
- <span class="na">scope</span><span class="pi">:</span>
771
- <span class="na">path</span><span class="pi">:</span> <span class="s2">"</span><span class="s">"</span> <span class="c1"># an empty string here means all files in the project</span>
772
- <span class="na">values</span><span class="pi">:</span>
773
- <span class="na">layout</span><span class="pi">:</span> <span class="s2">"</span><span class="s">default"</span>
774
- </code></pre></div></div>
775
-
776
- <div class="note info">
777
- <h5>Please stop and rerun `jekyll serve` command.</h5>
778
- <p>
779
- The <code>_config.yml</code> master configuration file contains global configurations
780
- and variable definitions that are read once at execution time. Changes made to <code>_config.yml</code>
781
- during automatic regeneration are not loaded until the next execution.
782
- </p>
783
- <p>
784
- Note <a href="../datafiles">Data Files</a> are included and reloaded during automatic regeneration.
785
- </p>
786
- </div>
787
-
788
- <p>Here, we are scoping the <code class="language-plaintext highlighter-rouge">values</code> to any file that exists in the path <code class="language-plaintext highlighter-rouge">scope</code>. Since the path is set as an empty string, it will apply to <strong>all files</strong> in your project. You probably don’t want to set a layout on every file in your project - like css files, for example - so you can also specify a <code class="language-plaintext highlighter-rouge">type</code> value under the <code class="language-plaintext highlighter-rouge">scope</code> key.</p>
789
-
790
- <div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">defaults</span><span class="pi">:</span>
791
- <span class="pi">-</span>
792
- <span class="na">scope</span><span class="pi">:</span>
793
- <span class="na">path</span><span class="pi">:</span> <span class="s2">"</span><span class="s">"</span> <span class="c1"># an empty string here means all files in the project</span>
794
- <span class="na">type</span><span class="pi">:</span> <span class="s2">"</span><span class="s">posts"</span> <span class="c1"># previously `post` in Jekyll 2.2.</span>
795
- <span class="na">values</span><span class="pi">:</span>
796
- <span class="na">layout</span><span class="pi">:</span> <span class="s2">"</span><span class="s">default"</span>
797
- </code></pre></div></div>
798
-
799
- <p>Now, this will only set the layout for files where the type is <code class="language-plaintext highlighter-rouge">posts</code>.
800
- The different types that are available to you are <code class="language-plaintext highlighter-rouge">pages</code>, <code class="language-plaintext highlighter-rouge">posts</code>, <code class="language-plaintext highlighter-rouge">drafts</code> or any collection in your site. While <code class="language-plaintext highlighter-rouge">type</code> is optional, you must specify a value for <code class="language-plaintext highlighter-rouge">path</code> when creating a <code class="language-plaintext highlighter-rouge">scope/values</code> pair.</p>
801
-
802
- <p>As mentioned earlier, you can set multiple scope/values pairs for <code class="language-plaintext highlighter-rouge">defaults</code>.</p>
803
-
804
- <div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">defaults</span><span class="pi">:</span>
805
- <span class="pi">-</span>
806
- <span class="na">scope</span><span class="pi">:</span>
807
- <span class="na">path</span><span class="pi">:</span> <span class="s2">"</span><span class="s">"</span>
808
- <span class="na">type</span><span class="pi">:</span> <span class="s2">"</span><span class="s">pages"</span>
809
- <span class="na">values</span><span class="pi">:</span>
810
- <span class="na">layout</span><span class="pi">:</span> <span class="s2">"</span><span class="s">my-site"</span>
811
- <span class="pi">-</span>
812
- <span class="na">scope</span><span class="pi">:</span>
813
- <span class="na">path</span><span class="pi">:</span> <span class="s2">"</span><span class="s">projects"</span>
814
- <span class="na">type</span><span class="pi">:</span> <span class="s2">"</span><span class="s">pages"</span> <span class="c1"># previously `page` in Jekyll 2.2.</span>
815
- <span class="na">values</span><span class="pi">:</span>
816
- <span class="na">layout</span><span class="pi">:</span> <span class="s2">"</span><span class="s">project"</span> <span class="c1"># overrides previous default layout</span>
817
- <span class="na">author</span><span class="pi">:</span> <span class="s2">"</span><span class="s">Mr.</span><span class="nv"> </span><span class="s">Hyde"</span>
818
- </code></pre></div></div>
819
-
820
- <p>With these defaults, all pages would use the <code class="language-plaintext highlighter-rouge">my-site</code> layout. Any html files that exist in the <code class="language-plaintext highlighter-rouge">projects/</code> folder will use the <code class="language-plaintext highlighter-rouge">project</code> layout, if it exists. Those files will also have the <code class="language-plaintext highlighter-rouge">page.author</code> <a href="../variables/">liquid variable</a> set to <code class="language-plaintext highlighter-rouge">Mr. Hyde</code>.</p>
821
-
822
- <div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">collections</span><span class="pi">:</span>
823
- <span class="na">my_collection</span><span class="pi">:</span>
824
- <span class="na">output</span><span class="pi">:</span> <span class="no">true</span>
825
-
826
- <span class="na">defaults</span><span class="pi">:</span>
827
- <span class="pi">-</span>
828
- <span class="na">scope</span><span class="pi">:</span>
829
- <span class="na">path</span><span class="pi">:</span> <span class="s2">"</span><span class="s">"</span>
830
- <span class="na">type</span><span class="pi">:</span> <span class="s2">"</span><span class="s">my_collection"</span> <span class="c1"># a collection in your site, in plural form</span>
831
- <span class="na">values</span><span class="pi">:</span>
832
- <span class="na">layout</span><span class="pi">:</span> <span class="s2">"</span><span class="s">default"</span>
833
- </code></pre></div></div>
834
-
835
- <p>In this example, the <code class="language-plaintext highlighter-rouge">layout</code> is set to <code class="language-plaintext highlighter-rouge">default</code> inside the
836
- <a href="../collections/">collection</a> with the name <code class="language-plaintext highlighter-rouge">my_collection</code>.</p>
837
-
838
- <h3 id="glob-patterns-in-front-matter-defaults">Glob patterns in Front Matter defaults</h3>
839
-
840
- <p>It is also possible to use glob patterns (currently limited to patterns that contain <code class="language-plaintext highlighter-rouge">*</code>) when matching defaults. For example, it is possible to set specific layout for each <code class="language-plaintext highlighter-rouge">special-page.html</code> in any subfolder of <code class="language-plaintext highlighter-rouge">section</code> folder.<span class="version-badge" title="This feature is available starting version 3.7.0">3.7.0</span></p>
841
- <div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">collections</span><span class="pi">:</span>
842
- <span class="na">my_collection</span><span class="pi">:</span>
843
- <span class="na">output</span><span class="pi">:</span> <span class="no">true</span>
844
-
845
- <span class="na">defaults</span><span class="pi">:</span>
846
- <span class="pi">-</span>
847
- <span class="na">scope</span><span class="pi">:</span>
848
- <span class="na">path</span><span class="pi">:</span> <span class="s2">"</span><span class="s">section/*/special-page.html"</span>
849
- <span class="na">values</span><span class="pi">:</span>
850
- <span class="na">layout</span><span class="pi">:</span> <span class="s2">"</span><span class="s">specific-layout"</span>
851
- </code></pre></div></div>
852
-
853
- <div class="note warning">
854
- <h5>Globbing and Performance</h5>
855
- <p>
856
- Please note that globbing a path is known to have a negative effect on
857
- performance and is currently not optimized, especially on Windows.
858
- Globbing a path will increase your build times in proportion to the size
859
- of the associated collection directory.
860
- </p>
861
- </div>
862
-
863
- <h3 id="precedence">Precedence</h3>
864
-
865
- <p>Jekyll will apply all of the configuration settings you specify in the <code class="language-plaintext highlighter-rouge">defaults</code> section of your <code class="language-plaintext highlighter-rouge">_config.yml</code> file. However, you can choose to override settings from other scope/values pair by specifying a more specific path for the scope.</p>
866
-
867
- <p>You can see that in the second to last example above. First, we set the default page layout to <code class="language-plaintext highlighter-rouge">my-site</code>. Then, using a more specific path, we set the default layout for pages in the <code class="language-plaintext highlighter-rouge">projects/</code> path to <code class="language-plaintext highlighter-rouge">project</code>. This can be done with any value that you would set in the page or post front matter.</p>
868
-
869
- <p>Finally, if you set defaults in the site configuration by adding a <code class="language-plaintext highlighter-rouge">defaults</code> section to your <code class="language-plaintext highlighter-rouge">_config.yml</code> file, you can override those settings in a post or page file. All you need to do is specify the settings in the post or page front matter. For example:</p>
870
-
871
- <div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="c1"># In _config.yml</span>
872
- <span class="nn">...</span>
873
- <span class="na">defaults</span><span class="pi">:</span>
874
- <span class="pi">-</span>
875
- <span class="na">scope</span><span class="pi">:</span>
876
- <span class="na">path</span><span class="pi">:</span> <span class="s2">"</span><span class="s">projects"</span>
877
- <span class="na">type</span><span class="pi">:</span> <span class="s2">"</span><span class="s">pages"</span>
878
- <span class="na">values</span><span class="pi">:</span>
879
- <span class="na">layout</span><span class="pi">:</span> <span class="s2">"</span><span class="s">project"</span>
880
- <span class="na">author</span><span class="pi">:</span> <span class="s2">"</span><span class="s">Mr.</span><span class="nv"> </span><span class="s">Hyde"</span>
881
- <span class="na">category</span><span class="pi">:</span> <span class="s2">"</span><span class="s">project"</span>
882
- <span class="nn">...</span>
883
- </code></pre></div></div>
884
-
885
- <div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="c1"># In projects/foo_project.md</span>
886
- <span class="nn">---</span>
887
- <span class="na">author</span><span class="pi">:</span> <span class="s2">"</span><span class="s">John</span><span class="nv"> </span><span class="s">Smith"</span>
888
- <span class="na">layout</span><span class="pi">:</span> <span class="s2">"</span><span class="s">foobar"</span>
889
- <span class="nn">---</span>
890
- <span class="s">The post text goes here...</span>
891
- </code></pre></div></div>
892
-
893
- <p>The <code class="language-plaintext highlighter-rouge">projects/foo_project.md</code> would have the <code class="language-plaintext highlighter-rouge">layout</code> set to <code class="language-plaintext highlighter-rouge">foobar</code> instead
894
- of <code class="language-plaintext highlighter-rouge">project</code> and the <code class="language-plaintext highlighter-rouge">author</code> set to <code class="language-plaintext highlighter-rouge">John Smith</code> instead of <code class="language-plaintext highlighter-rouge">Mr. Hyde</code> when
895
- the site is built.</p>
896
-
897
- <h2 id="default-configuration">Default Configuration</h2>
898
-
899
- <p>Jekyll runs with the following configuration options by default. Alternative
900
- settings for these options can be explicitly specified in the configuration
901
- file or on the command-line.</p>
902
-
903
- <div class="note warning">
904
- <h5>There are two unsupported kramdown options</h5>
905
- <p>
906
- Please note that both <code>remove_block_html_tags</code> and
907
- <code>remove_span_html_tags</code> are currently unsupported in Jekyll due
908
- to the fact that they are not included within the kramdown HTML converter.
909
- </p>
910
- </div>
911
-
912
- <div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="c1"># Where things are</span>
913
- <span class="na">source</span><span class="pi">:</span> <span class="s">.</span>
914
- <span class="na">destination</span><span class="pi">:</span> <span class="s">./_site</span>
915
- <span class="na">collections_dir</span><span class="pi">:</span> <span class="s">.</span>
916
- <span class="na">plugins_dir</span><span class="pi">:</span> <span class="s">_plugins</span>
917
- <span class="na">layouts_dir</span><span class="pi">:</span> <span class="s">_layouts</span>
918
- <span class="na">data_dir</span><span class="pi">:</span> <span class="s">_data</span>
919
- <span class="na">includes_dir</span><span class="pi">:</span> <span class="s">_includes</span>
920
- <span class="na">collections</span><span class="pi">:</span>
921
- <span class="na">posts</span><span class="pi">:</span>
922
- <span class="na">output</span><span class="pi">:</span> <span class="no">true</span>
923
-
924
- <span class="c1"># Handling Reading</span>
925
- <span class="na">safe</span><span class="pi">:</span> <span class="no">false</span>
926
- <span class="na">include</span><span class="pi">:</span> <span class="pi">[</span><span class="s2">"</span><span class="s">.htaccess"</span><span class="pi">]</span>
927
- <span class="na">exclude</span><span class="pi">:</span> <span class="pi">[</span><span class="s2">"</span><span class="s">Gemfile"</span><span class="pi">,</span> <span class="s2">"</span><span class="s">Gemfile.lock"</span><span class="pi">,</span> <span class="s2">"</span><span class="s">node_modules"</span><span class="pi">,</span> <span class="s2">"</span><span class="s">vendor/bundle/"</span><span class="pi">,</span> <span class="s2">"</span><span class="s">vendor/cache/"</span><span class="pi">,</span> <span class="s2">"</span><span class="s">vendor/gems/"</span><span class="pi">,</span> <span class="s2">"</span><span class="s">vendor/ruby/"</span><span class="pi">]</span>
928
- <span class="na">keep_files</span><span class="pi">:</span> <span class="pi">[</span><span class="s2">"</span><span class="s">.git"</span><span class="pi">,</span> <span class="s2">"</span><span class="s">.svn"</span><span class="pi">]</span>
929
- <span class="na">encoding</span><span class="pi">:</span> <span class="s2">"</span><span class="s">utf-8"</span>
930
- <span class="na">markdown_ext</span><span class="pi">:</span> <span class="s2">"</span><span class="s">markdown,mkdown,mkdn,mkd,md"</span>
931
- <span class="na">strict_front_matter</span><span class="pi">:</span> <span class="no">false</span>
932
-
933
- <span class="c1"># Filtering Content</span>
934
- <span class="na">show_drafts</span><span class="pi">:</span> <span class="no">null</span>
935
- <span class="na">limit_posts</span><span class="pi">:</span> <span class="m">0</span>
936
- <span class="na">future</span><span class="pi">:</span> <span class="no">false</span>
937
- <span class="na">unpublished</span><span class="pi">:</span> <span class="no">false</span>
938
-
939
- <span class="c1"># Plugins</span>
940
- <span class="na">whitelist</span><span class="pi">:</span> <span class="pi">[]</span>
941
- <span class="na">plugins</span><span class="pi">:</span> <span class="pi">[]</span>
942
-
943
- <span class="c1"># Conversion</span>
944
- <span class="na">markdown</span><span class="pi">:</span> <span class="s">kramdown</span>
945
- <span class="na">highlighter</span><span class="pi">:</span> <span class="s">rouge</span>
946
- <span class="na">lsi</span><span class="pi">:</span> <span class="no">false</span>
947
- <span class="na">excerpt_separator</span><span class="pi">:</span> <span class="s2">"</span><span class="se">\n\n</span><span class="s">"</span>
948
- <span class="na">incremental</span><span class="pi">:</span> <span class="no">false</span>
949
-
950
- <span class="c1"># Serving</span>
951
- <span class="na">detach</span><span class="pi">:</span> <span class="no">false</span>
952
- <span class="na">port</span><span class="pi">:</span> <span class="m">4000</span>
953
- <span class="na">host</span><span class="pi">:</span> <span class="s">127.0.0.1</span>
954
- <span class="na">baseurl</span><span class="pi">:</span> <span class="s2">"</span><span class="s">"</span> <span class="c1"># does not include hostname</span>
955
- <span class="na">show_dir_listing</span><span class="pi">:</span> <span class="no">false</span>
956
-
957
- <span class="c1"># Outputting</span>
958
- <span class="na">permalink</span><span class="pi">:</span> <span class="s">date</span>
959
- <span class="na">paginate_path</span><span class="pi">:</span> <span class="s">/page:num</span>
960
- <span class="na">timezone</span><span class="pi">:</span> <span class="no">null</span>
961
-
962
- <span class="na">quiet</span><span class="pi">:</span> <span class="no">false</span>
963
- <span class="na">verbose</span><span class="pi">:</span> <span class="no">false</span>
964
- <span class="na">defaults</span><span class="pi">:</span> <span class="pi">[]</span>
965
-
966
- <span class="na">liquid</span><span class="pi">:</span>
967
- <span class="na">error_mode</span><span class="pi">:</span> <span class="s">warn</span>
968
- <span class="na">strict_filters</span><span class="pi">:</span> <span class="no">false</span>
969
- <span class="na">strict_variables</span><span class="pi">:</span> <span class="no">false</span>
970
-
971
- <span class="c1"># Markdown Processors</span>
972
- <span class="na">rdiscount</span><span class="pi">:</span>
973
- <span class="na">extensions</span><span class="pi">:</span> <span class="pi">[]</span>
974
-
975
- <span class="na">redcarpet</span><span class="pi">:</span>
976
- <span class="na">extensions</span><span class="pi">:</span> <span class="pi">[]</span>
977
-
978
- <span class="na">kramdown</span><span class="pi">:</span>
979
- <span class="na">auto_ids</span><span class="pi">:</span> <span class="no">true</span>
980
- <span class="na">entity_output</span><span class="pi">:</span> <span class="s">as_char</span>
981
- <span class="na">toc_levels</span><span class="pi">:</span> <span class="s">1..6</span>
982
- <span class="na">smart_quotes</span><span class="pi">:</span> <span class="s">lsquo,rsquo,ldquo,rdquo</span>
983
- <span class="na">input</span><span class="pi">:</span> <span class="s">GFM</span>
984
- <span class="na">hard_wrap</span><span class="pi">:</span> <span class="no">false</span>
985
- <span class="na">footnote_nr</span><span class="pi">:</span> <span class="m">1</span>
986
- <span class="na">show_warnings</span><span class="pi">:</span> <span class="no">false</span>
987
- </code></pre></div></div>
988
-
989
- <h2 id="liquid-options">Liquid Options</h2>
990
-
991
- <p>Liquid’s response to errors can be configured by setting <code class="language-plaintext highlighter-rouge">error_mode</code>. The
992
- options are</p>
993
-
994
- <ul>
995
- <li>
996
- <code class="language-plaintext highlighter-rouge">lax</code> — Ignore all errors.</li>
997
- <li>
998
- <code class="language-plaintext highlighter-rouge">warn</code> — Output a warning on the console for each error.</li>
999
- <li>
1000
- <code class="language-plaintext highlighter-rouge">strict</code> — Output an error message and stop the build.</li>
1001
- </ul>
1002
-
1003
- <p>You can also configure Liquid’s renderer to catch non-assigned variables and
1004
- non-existing filters by setting <code class="language-plaintext highlighter-rouge">strict_variables</code> and / or <code class="language-plaintext highlighter-rouge">strict_filters</code>
1005
- to <code class="language-plaintext highlighter-rouge">true</code> respectively. <span class="version-badge" title="This feature is available starting version 3.8.0">3.8.0</span></p>
1006
-
1007
- <p>Do note that while <code class="language-plaintext highlighter-rouge">error_mode</code> configures Liquid’s parser, the <code class="language-plaintext highlighter-rouge">strict_variables</code>
1008
- and <code class="language-plaintext highlighter-rouge">strict_filters</code> options configure Liquid’s renderer and are consequently,
1009
- mutually exclusive.</p>
1010
-
1011
- <h2 id="markdown-options">Markdown Options</h2>
1012
-
1013
- <p>The various Markdown renderers supported by Jekyll sometimes have extra options
1014
- available.</p>
1015
-
1016
- <h3 id="redcarpet">Redcarpet</h3>
1017
-
1018
- <p>Redcarpet can be configured by providing an <code class="language-plaintext highlighter-rouge">extensions</code> sub-setting, whose
1019
- value should be an array of strings. Each string should be the name of one of
1020
- the <code class="language-plaintext highlighter-rouge">Redcarpet::Markdown</code> class’s extensions; if present in the array, it will
1021
- set the corresponding extension to <code class="language-plaintext highlighter-rouge">true</code>.</p>
1022
-
1023
- <p>Jekyll handles two special Redcarpet extensions:</p>
292
+ <p>Jekyll gives you a lot of flexibility to customize how it builds your site. These
293
+ options can either be specified in a <code class="highlighter-rouge">_config.yml</code> or <code class="highlighter-rouge">_config.toml</code> file placed
294
+ in your site’s root directory, or can be specified as flags for the <code class="highlighter-rouge">jekyll</code>
295
+ executable in the terminal.</p>
1024
296
 
1025
297
  <ul>
1026
- <li>
1027
- <code class="language-plaintext highlighter-rouge">no_fenced_code_blocks</code> — By default, Jekyll sets the <code class="language-plaintext highlighter-rouge">fenced_code_blocks</code>
1028
- extension (for delimiting code blocks with triple tildes or triple backticks)
1029
- to <code class="language-plaintext highlighter-rouge">true</code>, probably because GitHub’s eager adoption of them is starting to make
1030
- them inescapable. Redcarpet’s normal <code class="language-plaintext highlighter-rouge">fenced_code_blocks</code> extension is inert
1031
- when used with Jekyll; instead, you can use this inverted version of the
1032
- extension for disabling fenced code.</li>
298
+ <li><a href="/docs/configuration/options/">Configuration Options</a></li>
299
+ <li><a href="/docs/configuration/default/">Default Configuration</a></li>
300
+ <li><a href="/docs/configuration/front-matter-defaults/">Front Matter Defaults</a></li>
301
+ <li><a href="/docs/configuration/environments/">Environments</a></li>
302
+ <li><a href="/docs/configuration/markdown/">Markdown Options</a></li>
303
+ <li><a href="/docs/configuration/liquid/">Liquid Options</a></li>
304
+ <li><a href="/docs/configuration/webrick/">Webrick Options</a></li>
305
+ <li><a href="/docs/configuration/incremental-regeneration/">Incremental Regeneration</a></li>
1033
306
  </ul>
1034
307
 
1035
- <p>Note that you can also specify a language for highlighting after the first
1036
- delimiter:</p>
1037
-
1038
- <div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code> ```ruby
1039
- # ...ruby code
1040
- ```
1041
- </code></pre></div></div>
1042
-
1043
- <p>With both fenced code blocks and highlighter enabled, this will statically
1044
- highlight the code; without any syntax highlighter, it will add a
1045
- <code class="language-plaintext highlighter-rouge">class="LANGUAGE"</code> attribute to the <code class="language-plaintext highlighter-rouge">&lt;code&gt;</code> element, which can be used as a
1046
- hint by various JavaScript code highlighting libraries.</p>
1047
-
1048
- <ul>
1049
- <li>
1050
- <code class="language-plaintext highlighter-rouge">smart</code> — This pseudo-extension turns on SmartyPants, which converts
1051
- straight quotes to curly quotes and runs of hyphens to em (<code class="language-plaintext highlighter-rouge">---</code>) and en (<code class="language-plaintext highlighter-rouge">--</code>) dashes.</li>
1052
- </ul>
1053
-
1054
- <p>All other extensions retain their usual names from Redcarpet, and no renderer
1055
- options aside from <code class="language-plaintext highlighter-rouge">smart</code> can be specified in Jekyll. <a href="https://github.com/vmg/redcarpet/blob/v3.2.2/README.markdown#and-its-like-really-simple-to-use">A list of available
1056
- extensions can be found in the Redcarpet README file.</a>
1057
- Make sure you’re looking at the README for the right version of
1058
- Redcarpet: Jekyll currently uses v3.2.x. The most commonly used
1059
- extensions are:</p>
1060
-
1061
- <ul>
1062
- <li><code class="language-plaintext highlighter-rouge">tables</code></li>
1063
- <li><code class="language-plaintext highlighter-rouge">no_intra_emphasis</code></li>
1064
- <li><code class="language-plaintext highlighter-rouge">autolink</code></li>
1065
- </ul>
1066
-
1067
- <h3 id="custom-markdown-processors">Custom Markdown Processors</h3>
1068
-
1069
- <p>If you’re interested in creating a custom markdown processor, you’re in luck! Create a new class in the <code class="language-plaintext highlighter-rouge">Jekyll::Converters::Markdown</code> namespace:</p>
1070
-
1071
- <div class="language-ruby highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="k">class</span> <span class="nc">Jekyll::Converters::Markdown::MyCustomProcessor</span>
1072
- <span class="k">def</span> <span class="nf">initialize</span><span class="p">(</span><span class="n">config</span><span class="p">)</span>
1073
- <span class="nb">require</span> <span class="s1">'funky_markdown'</span>
1074
- <span class="vi">@config</span> <span class="o">=</span> <span class="n">config</span>
1075
- <span class="k">rescue</span> <span class="no">LoadError</span>
1076
- <span class="no">STDERR</span><span class="p">.</span><span class="nf">puts</span> <span class="s1">'You are missing a library required for Markdown. Please run:'</span>
1077
- <span class="no">STDERR</span><span class="p">.</span><span class="nf">puts</span> <span class="s1">' $ [sudo] gem install funky_markdown'</span>
1078
- <span class="k">raise</span> <span class="no">FatalException</span><span class="p">.</span><span class="nf">new</span><span class="p">(</span><span class="s2">"Missing dependency: funky_markdown"</span><span class="p">)</span>
1079
- <span class="k">end</span>
1080
-
1081
- <span class="k">def</span> <span class="nf">convert</span><span class="p">(</span><span class="n">content</span><span class="p">)</span>
1082
- <span class="o">::</span><span class="no">FunkyMarkdown</span><span class="p">.</span><span class="nf">new</span><span class="p">(</span><span class="n">content</span><span class="p">).</span><span class="nf">convert</span>
1083
- <span class="k">end</span>
1084
- <span class="k">end</span>
1085
- </code></pre></div></div>
1086
-
1087
- <p>Once you’ve created your class and have it properly set up either as a plugin
1088
- in the <code class="language-plaintext highlighter-rouge">_plugins</code> folder or as a gem, specify it in your <code class="language-plaintext highlighter-rouge">_config.yml</code>:</p>
1089
-
1090
- <div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">markdown</span><span class="pi">:</span> <span class="s">MyCustomProcessor</span>
1091
- </code></pre></div></div>
1092
-
1093
- <h2 id="incremental-regeneration">Incremental Regeneration</h2>
1094
- <div class="note warning">
1095
- <h5>Incremental regeneration is still an experimental feature</h5>
1096
- <p>
1097
- While incremental regeneration will work for the most common cases, it will
1098
- not work correctly in every scenario. Please be extremely cautious when
1099
- using the feature, and report any problems not listed below by
1100
- <a href="https://github.com/jekyll/jekyll/issues/new">opening an issue on GitHub</a>.
1101
- </p>
1102
- </div>
1103
-
1104
- <p>Incremental regeneration helps shorten build times by only generating documents
1105
- and pages that were updated since the previous build. It does this by keeping
1106
- track of both file modification times and inter-document dependencies in the
1107
- <code class="language-plaintext highlighter-rouge">.jekyll-metadata</code> file.</p>
1108
-
1109
- <p>Under the current implementation, incremental regeneration will only generate a
1110
- document or page if either it, or one of its dependencies, is modified. Currently,
1111
- the only types of dependencies tracked are includes (using the
1112
- <code class="language-plaintext highlighter-rouge">{% include %}</code> tag) and layouts. This means that plain
1113
- references to other documents (for example, the common case of iterating over
1114
- <code class="language-plaintext highlighter-rouge">site.posts</code> in a post listings page) will not be detected as a dependency.</p>
1115
-
1116
- <p>To remedy some of these shortfalls, putting <code class="language-plaintext highlighter-rouge">regenerate: true</code> in the front-matter
1117
- of a document will force Jekyll to regenerate it regardless of whether it has been
1118
- modified. Note that this will generate the specified document only; references
1119
- to other documents’ contents will not work since they won’t be re-rendered.</p>
1120
-
1121
- <p>Incremental regeneration can be enabled via the <code class="language-plaintext highlighter-rouge">--incremental</code> flag (<code class="language-plaintext highlighter-rouge">-I</code> for
1122
- short) from the command-line or by setting <code class="language-plaintext highlighter-rouge">incremental: true</code> in your
1123
- configuration file.</p>
1124
-
1125
-
1126
-
1127
-
1128
-
1129
-
1130
-
1131
-
1132
-
1133
-
1134
-
1135
-
1136
-
1137
-
1138
-
1139
-
1140
-
1141
-
1142
-
1143
-
1144
-
1145
-
1146
-
1147
-
1148
-
1149
-
1150
-
1151
- <div class="section-nav">
1152
- <div class="left align-right">
1153
-
1154
-
1155
-
1156
- <a href="/docs/structure/" class="prev">Back</a>
1157
-
1158
- </div>
1159
- <div class="right align-left">
1160
-
1161
-
1162
-
1163
- <a href="/docs/frontmatter/" class="next">Next</a>
1164
-
1165
- </div>
1166
- </div>
1167
- <div class="clear"></div>
1168
-
1169
308
  </article>
1170
309
  </div>
1171
310
 
1172
311
  <div class="unit one-fifth hide-on-mobiles">
1173
312
  <aside>
1174
313
 
1175
- <h4>Getting Started</h4>
1176
- <ul>
1177
-
1178
-
1179
-
1180
- <li class=""><a href="/docs/home/">Welcome</a></li>
1181
-
1182
-
1183
-
1184
- <li class=""><a href="/docs/quickstart/">Quick-start guide</a></li>
1185
-
1186
-
1187
-
1188
- <li class=""><a href="/docs/installation/">Installation</a></li>
1189
-
1190
-
1191
-
1192
- <li class=""><a href="/docs/windows/">Jekyll on Windows</a></li>
1193
-
1194
-
1195
-
1196
- <li class=""><a href="/docs/usage/">Basic Usage</a></li>
1197
-
1198
-
1199
-
1200
- <li class=""><a href="/docs/structure/">Directory structure</a></li>
1201
-
1202
-
1203
-
1204
- <li class="current"><a href="/docs/configuration/">Configuration</a></li>
1205
-
1206
- </ul>
1207
-
1208
-
1209
- <h4>Your Content</h4>
1210
- <ul>
1211
-
1212
-
1213
-
1214
- <li class=""><a href="/docs/frontmatter/">Front Matter</a></li>
1215
-
1216
-
1217
-
1218
- <li class=""><a href="/docs/posts/">Writing posts</a></li>
1219
-
1220
-
1221
-
1222
- <li class=""><a href="/docs/drafts/">Working with drafts</a></li>
1223
-
1224
-
1225
-
1226
- <li class=""><a href="/docs/pages/">Creating pages</a></li>
1227
-
1228
-
1229
-
1230
- <li class=""><a href="/docs/static-files/">Static Files</a></li>
1231
-
1232
-
1233
-
1234
- <li class=""><a href="/docs/variables/">Variables</a></li>
1235
-
1236
-
1237
-
1238
- <li class=""><a href="/docs/collections/">Collections</a></li>
1239
-
1240
-
1241
-
1242
- <li class=""><a href="/docs/datafiles/">Data Files</a></li>
1243
-
1244
-
1245
-
1246
- <li class=""><a href="/docs/assets/">Assets</a></li>
1247
-
1248
-
1249
-
1250
- <li class=""><a href="/docs/migrations/">Blog migrations</a></li>
1251
-
1252
- </ul>
1253
-
314
+ <h4>Getting Started</h4>
315
+ <ul>
316
+
317
+
318
+ <li>
319
+ <a href="/docs/">
320
+ Quickstart
321
+ </a>
322
+ </li>
323
+
324
+
325
+ <li>
326
+ <a href="/docs/ruby-101/">
327
+ Ruby 101
328
+ </a>
329
+ </li>
330
+
331
+
332
+ <li>
333
+ <a href="/docs/installation/">
334
+ Installation
335
+ </a>
336
+ </li>
337
+
338
+
339
+ <li>
340
+ <a href="/docs/community/">
341
+ Community
342
+ </a>
343
+ </li>
344
+
345
+
346
+ <li>
347
+ <a href="/docs/step-by-step/01-setup/">
348
+ Step by Step Tutorial
349
+ </a>
350
+ </li>
351
+
352
+ </ul>
1254
353
 
1255
- <h4>Customization</h4>
1256
- <ul>
1257
-
1258
-
1259
-
1260
- <li class=""><a href="/docs/templates/">Templates</a></li>
1261
-
1262
-
1263
-
1264
- <li class=""><a href="/docs/includes/">Includes</a></li>
1265
-
1266
-
1267
-
1268
- <li class=""><a href="/docs/permalinks/">Permalinks</a></li>
1269
-
1270
-
1271
-
1272
- <li class=""><a href="/docs/pagination/">Pagination</a></li>
1273
-
1274
-
1275
-
1276
- <li class=""><a href="/docs/plugins/">Plugins</a></li>
1277
-
1278
-
1279
-
1280
- <li class=""><a href="/docs/themes/">Themes</a></li>
1281
-
1282
-
1283
-
1284
- <li class=""><a href="/docs/extras/">Extras</a></li>
1285
-
1286
- </ul>
1287
-
354
+ <h4>Build</h4>
355
+ <ul>
356
+
357
+
358
+ <li>
359
+ <a href="/docs/usage/">
360
+ Command Line Usage
361
+ </a>
362
+ </li>
363
+
364
+
365
+ <li class="current">
366
+ <a href="/docs/configuration/">
367
+ Configuration
368
+ </a>
369
+ </li>
370
+
371
+ </ul>
1288
372
 
1289
- <h4>Deployment</h4>
1290
- <ul>
1291
-
1292
-
1293
-
1294
- <li class=""><a href="/docs/github-pages/">GitHub Pages</a></li>
1295
-
1296
-
1297
-
1298
- <li class=""><a href="/docs/deployment-methods/">Deployment methods</a></li>
1299
-
1300
-
1301
-
1302
- <li class=""><a href="/docs/continuous-integration/">Continuous Integration</a></li>
1303
-
1304
- </ul>
1305
-
373
+ <h4>Content</h4>
374
+ <ul>
375
+
376
+
377
+ <li>
378
+ <a href="/docs/pages/">
379
+ Pages
380
+ </a>
381
+ </li>
382
+
383
+
384
+ <li>
385
+ <a href="/docs/posts/">
386
+ Posts
387
+ </a>
388
+ </li>
389
+
390
+
391
+ <li>
392
+ <a href="/docs/front-matter/">
393
+ Front Matter
394
+ </a>
395
+ </li>
396
+
397
+
398
+ <li>
399
+ <a href="/docs/collections/">
400
+ Collections
401
+ </a>
402
+ </li>
403
+
404
+
405
+ <li>
406
+ <a href="/docs/datafiles/">
407
+ Data Files
408
+ </a>
409
+ </li>
410
+
411
+
412
+ <li>
413
+ <a href="/docs/assets/">
414
+ Assets
415
+ </a>
416
+ </li>
417
+
418
+
419
+ <li>
420
+ <a href="/docs/static-files/">
421
+ Static Files
422
+ </a>
423
+ </li>
424
+
425
+ </ul>
1306
426
 
1307
- <h4>Miscellaneous</h4>
1308
- <ul>
1309
-
1310
-
1311
-
1312
- <li class=""><a href="/docs/troubleshooting/">Troubleshooting</a></li>
1313
-
1314
-
1315
-
1316
- <li class=""><a href="/docs/sites/">Sites using Jekyll</a></li>
1317
-
1318
-
1319
-
1320
- <li class=""><a href="/docs/resources/">Resources</a></li>
1321
-
1322
-
1323
-
1324
- <li class=""><a href="/docs/upgrading/0-to-2/">Upgrading from 0.x to 2.x</a></li>
1325
-
1326
-
1327
-
1328
- <li class=""><a href="/docs/upgrading/2-to-3/">Upgrading from 2.x to 3.x</a></li>
1329
-
1330
- </ul>
1331
-
427
+ <h4>Site Structure</h4>
428
+ <ul>
429
+
430
+
431
+ <li>
432
+ <a href="/docs/structure/">
433
+ Directory Structure
434
+ </a>
435
+ </li>
436
+
437
+
438
+ <li>
439
+ <a href="/docs/liquid/">
440
+ Liquid
441
+ </a>
442
+ </li>
443
+
444
+
445
+ <li>
446
+ <a href="/docs/variables/">
447
+ Variables
448
+ </a>
449
+ </li>
450
+
451
+
452
+ <li>
453
+ <a href="/docs/includes/">
454
+ Includes
455
+ </a>
456
+ </li>
457
+
458
+
459
+ <li>
460
+ <a href="/docs/layouts/">
461
+ Layouts
462
+ </a>
463
+ </li>
464
+
465
+
466
+ <li>
467
+ <a href="/docs/permalinks/">
468
+ Permalinks
469
+ </a>
470
+ </li>
471
+
472
+
473
+ <li>
474
+ <a href="/docs/themes/">
475
+ Themes
476
+ </a>
477
+ </li>
478
+
479
+
480
+ <li>
481
+ <a href="/docs/pagination/">
482
+ Pagination
483
+ </a>
484
+ </li>
485
+
486
+ </ul>
1332
487
 
1333
- <h4>Meta</h4>
1334
- <ul>
1335
-
1336
-
1337
-
1338
- <li class=""><a href="/docs/contributing/">Contributing</a></li>
1339
-
1340
-
1341
-
1342
- <li class=""><a href="/docs/maintaining/">Maintaining Jekyll</a></li>
1343
-
1344
-
1345
-
1346
- <li class=""><a href="/docs/conduct/">Code of Conduct</a></li>
1347
-
1348
-
1349
-
1350
- <li class=""><a href="/docs/history/">History</a></li>
1351
-
1352
- </ul>
1353
-
488
+ <h4>Guides</h4>
489
+ <ul>
490
+
491
+
492
+ <li>
493
+ <a href="/docs/plugins/">
494
+ Plugins
495
+ </a>
496
+ </li>
497
+
498
+
499
+ <li>
500
+ <a href="/docs/migrations/">
501
+ Blog Migrations
502
+ </a>
503
+ </li>
504
+
505
+
506
+ <li>
507
+ <a href="/docs/upgrading/">
508
+ Upgrading
509
+ </a>
510
+ </li>
511
+
512
+
513
+ <li>
514
+ <a href="/docs/deployment/">
515
+ Deployment
516
+ </a>
517
+ </li>
518
+
519
+ </ul>
1354
520
 
1355
521
  </aside>
1356
522
  </div>
@@ -1365,7 +531,8 @@ configuration file.</p>
1365
531
  <footer>
1366
532
  <div class="grid">
1367
533
  <div class="unit one-third center-on-mobiles">
1368
- <p>The contents of this website are <br>© 2020 under the terms of the <a href="https://github.com/jekyll/jekyll/blob/master/LICENSE">MIT License</a>.</p>
534
+ <p>Jekyll is lovingly maintained by the <a href="/team/">core team</a> of volunteers. </p>
535
+ <p>The contents of this website are <br />&copy;&nbsp;2019 under the terms of the <a href="https://github.com/jekyll/jekyll/blob/master/LICENSE">MIT&nbsp;License</a>.</p>
1369
536
  </div>
1370
537
  <div class="unit two-thirds align-right center-on-mobiles">
1371
538
  <p>
@@ -1375,6 +542,14 @@ configuration file.</p>
1375
542
  </a>
1376
543
  </p>
1377
544
  </div>
545
+ <div class="unit two-thirds align-right center-on-mobiles">
546
+ <p>
547
+ Jekyll is funded thanks to its
548
+ <a href="https://github.com/jekyll/jekyll#sponsors">
549
+ sponsors!
550
+ </a>
551
+ </p>
552
+ </div>
1378
553
  </div>
1379
554
  </footer>
1380
555