jekyll-docs 3.9.0 → 4.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
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
data/site/docs/configuration/front-matter-defaults/index.html ADDED
@@ -0,0 +1,738 @@
1
+ <!DOCTYPE HTML>
2
+ <html lang="en-US">
3
+ <head>
4
+ <meta charset="UTF-8">
5
+ <meta name="viewport" content="width=device-width,initial-scale=1">
6
+ <meta name="generator" content="Jekyll v4.0.0">
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" />
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
+ <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">
13
+ <link rel="stylesheet" href="/css/screen.css">
14
+ <link rel="icon" type="image/x-icon" href="/favicon.ico">
15
+ <!-- Begin Jekyll SEO tag v2.6.1 -->
16
+ <title>Front Matter Defaults | Jekyll • Simple, blog-aware, static sites</title>
17
+ <meta name="generator" content="Jekyll v4.0.0" />
18
+ <meta property="og:title" content="Front Matter Defaults" />
19
+ <meta property="og:locale" content="en_US" />
20
+ <meta name="description" content="Using front matter is one way that you can specify configuration in the pages and posts for your site. Setting things like a default layout, or customizing the title, or specifying a more precise date/time for the post can all be added to your page or post front matter." />
21
+ <meta property="og:description" content="Using front matter is one way that you can specify configuration in the pages and posts for your site. Setting things like a default layout, or customizing the title, or specifying a more precise date/time for the post can all be added to your page or post front matter." />
22
+ <link rel="canonical" href="https://jekyllrb.com/docs/configuration/front-matter-defaults/" />
23
+ <meta property="og:url" content="https://jekyllrb.com/docs/configuration/front-matter-defaults/" />
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" />
26
+ <meta property="og:type" content="article" />
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" />
30
+ <meta property="twitter:title" content="Front Matter Defaults" />
31
+ <meta name="twitter:site" content="@jekyllrb" />
32
+ <meta name="google-site-verification" content="onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY" />
33
+ <script type="application/ld+json">
34
+ {"description":"Using front matter is one way that you can specify configuration in the pages and posts for your site. Setting things like a default layout, or customizing the title, or specifying a more precise date/time for the post can all be added to your page or post front matter.","@type":"BlogPosting","mainEntityOfPage":{"@type":"WebPage","@id":"https://jekyllrb.com/docs/configuration/front-matter-defaults/"},"headline":"Front Matter Defaults","dateModified":"2019-09-11T07:30:27-07:00","url":"https://jekyllrb.com/docs/configuration/front-matter-defaults/","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>
35
+ <!-- End Jekyll SEO tag -->
36
+
37
+ <!--[if lt IE 9]>
38
+ <script src="/js/html5shiv.min.js"></script>
39
+ <script src="/js/respond.min.js"></script>
40
+ <![endif]-->
41
+ </head>
42
+
43
+
44
+ <body class="wrap">
45
+ <header>
46
+ <div class="flexbox">
47
+ <div class="center-on-mobiles">
48
+ <h1>
49
+ <a href="/" class="logo">
50
+ <span class="sr-only">Jekyll</span>
51
+ <img src="/img/logo-2x.png" width="140" height="65" alt="Jekyll Logo">
52
+ </a>
53
+ </h1>
54
+ </div>
55
+ <nav class="main-nav hide-on-mobiles">
56
+ <ul>
57
+
58
+ <li>
59
+ <a href="/">Home</a>
60
+ </li>
61
+
62
+ <li class="current">
63
+ <a href="/docs/">Docs</a>
64
+ </li>
65
+
66
+ <li>
67
+ <a href="/resources/">Resources</a>
68
+ </li>
69
+
70
+ <li>
71
+ <a href="/showcase/">Showcase</a>
72
+ </li>
73
+
74
+ <li>
75
+ <a href="/news/">News</a>
76
+ </li>
77
+
78
+ </ul>
79
+
80
+ </nav>
81
+ <div class="search hide-on-mobiles">
82
+ <input type="text" id="docsearch-input" placeholder="Search the docs…">
83
+
84
+ </div>
85
+ <div class="meta hide-on-mobiles">
86
+ <ul>
87
+ <li>
88
+ <a href="https://github.com/jekyll/jekyll/releases/tag/v4.0.0">v4.0.0</a>
89
+ </li>
90
+ <li>
91
+ <a href="https://github.com/jekyll/jekyll">GitHub</a>
92
+ </li>
93
+ </ul>
94
+ </div>
95
+ </div>
96
+ <nav class="mobile-nav show-on-mobiles">
97
+ <ul>
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
+
116
+ <li>
117
+ <a href="https://github.com/jekyll/jekyll">GitHub</a>
118
+ </li>
119
+ </ul>
120
+
121
+ </nav>
122
+ </header>
123
+
124
+
125
+ <section class="docs">
126
+ <div class="grid">
127
+
128
+ <div class="docs-nav-mobile unit whole show-on-mobiles">
129
+ <select onchange="if (this.value) window.location.href=this.value">
130
+ <option value="">Navigate the docs…</option>
131
+
132
+ <optgroup label="Getting Started">
133
+
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>
158
+
159
+ </optgroup>
160
+
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>
172
+
173
+ </optgroup>
174
+
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>
211
+
212
+ </optgroup>
213
+
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>
255
+
256
+ </optgroup>
257
+
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>
279
+
280
+ </optgroup>
281
+
282
+ </select>
283
+ </div>
284
+
285
+
286
+ <div class="unit four-fifths">
287
+ <article>
288
+ <div class="improve right hide-on-mobiles">
289
+ <a data-proofer-ignore href="https://github.com/jekyll/jekyll/edit/master/docs/_docs/configuration/front-matter-defaults.md"><i class="fa fa-pencil"></i> &nbsp;Improve this page</a>
290
+ </div>
291
+ <h1>Front Matter Defaults</h1>
292
+ <p>Using <a href="/docs/front-matter/">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>
293
+
294
+ <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>
295
+
296
+ <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="highlighter-rouge">defaults</code> key in the <code class="highlighter-rouge">_config.yml</code> file in your project’s root directory.</p>
297
+
298
+ <p>The <code class="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>
299
+
300
+ <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="highlighter-rouge">_config.yml</code> file:</p>
301
+
302
+ <div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">defaults</span><span class="pi">:</span>
303
+ <span class="pi">-</span>
304
+ <span class="na">scope</span><span class="pi">:</span>
305
+ <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>
306
+ <span class="na">values</span><span class="pi">:</span>
307
+ <span class="na">layout</span><span class="pi">:</span> <span class="s2">"</span><span class="s">default"</span>
308
+ </code></pre></div></div>
309
+
310
+ <div class="note info">
311
+ <h5>Stop and rerun `jekyll serve` command.</h5>
312
+ <p>
313
+ The <code>_config.yml</code> master configuration file contains global configurations
314
+ and variable definitions that are read once at execution time. Changes made to <code>_config.yml</code>
315
+ during automatic regeneration are not loaded until the next execution.
316
+ </p>
317
+ <p>
318
+ Note <a href="/docs/datafiles">Data Files</a> are included and reloaded during automatic regeneration.
319
+ </p>
320
+ </div>
321
+
322
+ <p>Here, we are scoping the <code class="highlighter-rouge">values</code> to any file that exists in the path <code class="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="highlighter-rouge">type</code> value under the <code class="highlighter-rouge">scope</code> key.</p>
323
+
324
+ <div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">defaults</span><span class="pi">:</span>
325
+ <span class="pi">-</span>
326
+ <span class="na">scope</span><span class="pi">:</span>
327
+ <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>
328
+ <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>
329
+ <span class="na">values</span><span class="pi">:</span>
330
+ <span class="na">layout</span><span class="pi">:</span> <span class="s2">"</span><span class="s">default"</span>
331
+ </code></pre></div></div>
332
+
333
+ <p>Now, this will only set the layout for files where the type is <code class="highlighter-rouge">posts</code>.
334
+ The different types that are available to you are <code class="highlighter-rouge">pages</code>, <code class="highlighter-rouge">posts</code>, <code class="highlighter-rouge">drafts</code> or any collection in your site. While <code class="highlighter-rouge">type</code> is optional, you must specify a value for <code class="highlighter-rouge">path</code> when creating a <code class="highlighter-rouge">scope/values</code> pair.</p>
335
+
336
+ <p>As mentioned earlier, you can set multiple scope/values pairs for <code class="highlighter-rouge">defaults</code>.</p>
337
+
338
+ <div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">defaults</span><span class="pi">:</span>
339
+ <span class="pi">-</span>
340
+ <span class="na">scope</span><span class="pi">:</span>
341
+ <span class="na">path</span><span class="pi">:</span> <span class="s2">"</span><span class="s">"</span>
342
+ <span class="na">type</span><span class="pi">:</span> <span class="s2">"</span><span class="s">pages"</span>
343
+ <span class="na">values</span><span class="pi">:</span>
344
+ <span class="na">layout</span><span class="pi">:</span> <span class="s2">"</span><span class="s">my-site"</span>
345
+ <span class="pi">-</span>
346
+ <span class="na">scope</span><span class="pi">:</span>
347
+ <span class="na">path</span><span class="pi">:</span> <span class="s2">"</span><span class="s">projects"</span>
348
+ <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>
349
+ <span class="na">values</span><span class="pi">:</span>
350
+ <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>
351
+ <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>
352
+ </code></pre></div></div>
353
+
354
+ <p>With these defaults, all pages would use the <code class="highlighter-rouge">my-site</code> layout. Any html files that exist in the <code class="highlighter-rouge">projects/</code> folder will use the <code class="highlighter-rouge">project</code> layout, if it exists. Those files will also have the <code class="highlighter-rouge">page.author</code> <a href="/docs/variables/">liquid variable</a> set to <code class="highlighter-rouge">Mr. Hyde</code>.</p>
355
+
356
+ <div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">collections</span><span class="pi">:</span>
357
+ <span class="na">my_collection</span><span class="pi">:</span>
358
+ <span class="na">output</span><span class="pi">:</span> <span class="no">true</span>
359
+
360
+ <span class="na">defaults</span><span class="pi">:</span>
361
+ <span class="pi">-</span>
362
+ <span class="na">scope</span><span class="pi">:</span>
363
+ <span class="na">path</span><span class="pi">:</span> <span class="s2">"</span><span class="s">"</span>
364
+ <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>
365
+ <span class="na">values</span><span class="pi">:</span>
366
+ <span class="na">layout</span><span class="pi">:</span> <span class="s2">"</span><span class="s">default"</span>
367
+ </code></pre></div></div>
368
+
369
+ <p>In this example, the <code class="highlighter-rouge">layout</code> is set to <code class="highlighter-rouge">default</code> inside the
370
+ <a href="/docs/collections/">collection</a> with the name <code class="highlighter-rouge">my_collection</code>.</p>
371
+
372
+ <h3 id="glob-patterns-in-front-matter-defaults">Glob patterns in Front Matter defaults</h3>
373
+
374
+ <p>It is also possible to use glob patterns (currently limited to patterns that contain <code class="highlighter-rouge">*</code>) when matching defaults. For example, it is possible to set specific layout for each <code class="highlighter-rouge">special-page.html</code> in any subfolder of <code class="highlighter-rouge">section</code> folder.<span class="version-badge" title="This feature is available starting version 3.7.0">3.7.0</span></p>
375
+ <div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">collections</span><span class="pi">:</span>
376
+ <span class="na">my_collection</span><span class="pi">:</span>
377
+ <span class="na">output</span><span class="pi">:</span> <span class="no">true</span>
378
+
379
+ <span class="na">defaults</span><span class="pi">:</span>
380
+ <span class="pi">-</span>
381
+ <span class="na">scope</span><span class="pi">:</span>
382
+ <span class="na">path</span><span class="pi">:</span> <span class="s2">"</span><span class="s">section/*/special-page.html"</span>
383
+ <span class="na">values</span><span class="pi">:</span>
384
+ <span class="na">layout</span><span class="pi">:</span> <span class="s2">"</span><span class="s">specific-layout"</span>
385
+ </code></pre></div></div>
386
+
387
+ <div class="note warning">
388
+ <h5>Globbing and Performance</h5>
389
+ <p>
390
+ Please note that globbing a path is known to have a negative effect on
391
+ performance and is currently not optimized, especially on Windows.
392
+ Globbing a path will increase your build times in proportion to the size
393
+ of the associated collection directory.
394
+ </p>
395
+ </div>
396
+
397
+ <h3 id="precedence">Precedence</h3>
398
+
399
+ <p>Jekyll will apply all of the configuration settings you specify in the <code class="highlighter-rouge">defaults</code> section of your <code class="highlighter-rouge">_config.yml</code> file. You can choose to override settings from other scope/values pair by specifying a more specific path for the scope.</p>
400
+
401
+ <p>You can see that in the second to last example above. First, we set the default page layout to <code class="highlighter-rouge">my-site</code>. Then, using a more specific path, we set the default layout for pages in the <code class="highlighter-rouge">projects/</code> path to <code class="highlighter-rouge">project</code>. This can be done with any value that you would set in the page or post front matter.</p>
402
+
403
+ <p>Finally, if you set defaults in the site configuration by adding a <code class="highlighter-rouge">defaults</code> section to your <code class="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>
404
+
405
+ <div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="c1"># In _config.yml</span>
406
+ <span class="nn">...</span>
407
+ <span class="na">defaults</span><span class="pi">:</span>
408
+ <span class="pi">-</span>
409
+ <span class="na">scope</span><span class="pi">:</span>
410
+ <span class="na">path</span><span class="pi">:</span> <span class="s2">"</span><span class="s">projects"</span>
411
+ <span class="na">type</span><span class="pi">:</span> <span class="s2">"</span><span class="s">pages"</span>
412
+ <span class="na">values</span><span class="pi">:</span>
413
+ <span class="na">layout</span><span class="pi">:</span> <span class="s2">"</span><span class="s">project"</span>
414
+ <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>
415
+ <span class="na">category</span><span class="pi">:</span> <span class="s2">"</span><span class="s">project"</span>
416
+ <span class="nn">...</span>
417
+ </code></pre></div></div>
418
+
419
+ <div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="c1"># In projects/foo_project.md</span>
420
+ <span class="nn">---</span>
421
+ <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>
422
+ <span class="na">layout</span><span class="pi">:</span> <span class="s2">"</span><span class="s">foobar"</span>
423
+ <span class="nn">---</span>
424
+ <span class="s">The post text goes here...</span>
425
+ </code></pre></div></div>
426
+
427
+ <p>The <code class="highlighter-rouge">projects/foo_project.md</code> would have the <code class="highlighter-rouge">layout</code> set to <code class="highlighter-rouge">foobar</code> instead
428
+ of <code class="highlighter-rouge">project</code> and the <code class="highlighter-rouge">author</code> set to <code class="highlighter-rouge">John Smith</code> instead of <code class="highlighter-rouge">Mr. Hyde</code> when
429
+ the site is built.</p>
430
+
431
+ </article>
432
+ </div>
433
+
434
+ <div class="unit one-fifth hide-on-mobiles">
435
+ <aside>
436
+
437
+ <h4>Getting Started</h4>
438
+ <ul>
439
+
440
+
441
+ <li>
442
+ <a href="/docs/">
443
+ Quickstart
444
+ </a>
445
+ </li>
446
+
447
+
448
+ <li>
449
+ <a href="/docs/ruby-101/">
450
+ Ruby 101
451
+ </a>
452
+ </li>
453
+
454
+
455
+ <li>
456
+ <a href="/docs/installation/">
457
+ Installation
458
+ </a>
459
+ </li>
460
+
461
+
462
+ <li>
463
+ <a href="/docs/community/">
464
+ Community
465
+ </a>
466
+ </li>
467
+
468
+
469
+ <li>
470
+ <a href="/docs/step-by-step/01-setup/">
471
+ Step by Step Tutorial
472
+ </a>
473
+ </li>
474
+
475
+ </ul>
476
+
477
+ <h4>Build</h4>
478
+ <ul>
479
+
480
+
481
+ <li>
482
+ <a href="/docs/usage/">
483
+ Command Line Usage
484
+ </a>
485
+ </li>
486
+
487
+
488
+ <li>
489
+ <a href="/docs/configuration/">
490
+ Configuration
491
+ </a>
492
+ </li>
493
+
494
+ </ul>
495
+
496
+ <h4>Content</h4>
497
+ <ul>
498
+
499
+
500
+ <li>
501
+ <a href="/docs/pages/">
502
+ Pages
503
+ </a>
504
+ </li>
505
+
506
+
507
+ <li>
508
+ <a href="/docs/posts/">
509
+ Posts
510
+ </a>
511
+ </li>
512
+
513
+
514
+ <li>
515
+ <a href="/docs/front-matter/">
516
+ Front Matter
517
+ </a>
518
+ </li>
519
+
520
+
521
+ <li>
522
+ <a href="/docs/collections/">
523
+ Collections
524
+ </a>
525
+ </li>
526
+
527
+
528
+ <li>
529
+ <a href="/docs/datafiles/">
530
+ Data Files
531
+ </a>
532
+ </li>
533
+
534
+
535
+ <li>
536
+ <a href="/docs/assets/">
537
+ Assets
538
+ </a>
539
+ </li>
540
+
541
+
542
+ <li>
543
+ <a href="/docs/static-files/">
544
+ Static Files
545
+ </a>
546
+ </li>
547
+
548
+ </ul>
549
+
550
+ <h4>Site Structure</h4>
551
+ <ul>
552
+
553
+
554
+ <li>
555
+ <a href="/docs/structure/">
556
+ Directory Structure
557
+ </a>
558
+ </li>
559
+
560
+
561
+ <li>
562
+ <a href="/docs/liquid/">
563
+ Liquid
564
+ </a>
565
+ </li>
566
+
567
+
568
+ <li>
569
+ <a href="/docs/variables/">
570
+ Variables
571
+ </a>
572
+ </li>
573
+
574
+
575
+ <li>
576
+ <a href="/docs/includes/">
577
+ Includes
578
+ </a>
579
+ </li>
580
+
581
+
582
+ <li>
583
+ <a href="/docs/layouts/">
584
+ Layouts
585
+ </a>
586
+ </li>
587
+
588
+
589
+ <li>
590
+ <a href="/docs/permalinks/">
591
+ Permalinks
592
+ </a>
593
+ </li>
594
+
595
+
596
+ <li>
597
+ <a href="/docs/themes/">
598
+ Themes
599
+ </a>
600
+ </li>
601
+
602
+
603
+ <li>
604
+ <a href="/docs/pagination/">
605
+ Pagination
606
+ </a>
607
+ </li>
608
+
609
+ </ul>
610
+
611
+ <h4>Guides</h4>
612
+ <ul>
613
+
614
+
615
+ <li>
616
+ <a href="/docs/plugins/">
617
+ Plugins
618
+ </a>
619
+ </li>
620
+
621
+
622
+ <li>
623
+ <a href="/docs/migrations/">
624
+ Blog Migrations
625
+ </a>
626
+ </li>
627
+
628
+
629
+ <li>
630
+ <a href="/docs/upgrading/">
631
+ Upgrading
632
+ </a>
633
+ </li>
634
+
635
+
636
+ <li>
637
+ <a href="/docs/deployment/">
638
+ Deployment
639
+ </a>
640
+ </li>
641
+
642
+ </ul>
643
+
644
+ </aside>
645
+ </div>
646
+
647
+
648
+ <div class="clear"></div>
649
+
650
+ </div>
651
+ </section>
652
+
653
+
654
+ <footer>
655
+ <div class="grid">
656
+ <div class="unit one-third center-on-mobiles">
657
+ <p>Jekyll is lovingly maintained by the <a href="/team/">core team</a> of volunteers. </p>
658
+ <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>
659
+ </div>
660
+ <div class="unit two-thirds align-right center-on-mobiles">
661
+ <p>
662
+ Proudly hosted by
663
+ <a href="https://github.com">
664
+ <img src="/img/footer-logo.png" width="100" height="30" alt="GitHub • Social coding">
665
+ </a>
666
+ </p>
667
+ </div>
668
+ <div class="unit two-thirds align-right center-on-mobiles">
669
+ <p>
670
+ Jekyll is funded thanks to its
671
+ <a href="https://github.com/jekyll/jekyll#sponsors">
672
+ sponsors!
673
+ </a>
674
+ </p>
675
+ </div>
676
+ </div>
677
+ </footer>
678
+
679
+ <script>
680
+ var anchorForId = function (id) {
681
+ var anchor = document.createElement("a");
682
+ anchor.className = "header-link";
683
+ anchor.href = "#" + id;
684
+ anchor.innerHTML = "<span class=\"sr-only\">Permalink</span><i class=\"fa fa-link\"></i>";
685
+ anchor.title = "Permalink";
686
+ return anchor;
687
+ };
688
+
689
+ var linkifyAnchors = function (level, containingElement) {
690
+ var headers = containingElement.getElementsByTagName("h" + level);
691
+ for (var h = 0; h < headers.length; h++) {
692
+ var header = headers[h];
693
+
694
+ if (typeof header.id !== "undefined" && header.id !== "") {
695
+ header.appendChild(anchorForId(header.id));
696
+ }
697
+ }
698
+ };
699
+
700
+ document.onreadystatechange = function () {
701
+ if (this.readyState === "complete") {
702
+ var contentBlock = document.getElementsByClassName("docs")[0] || document.getElementsByClassName("news")[0];
703
+ if (!contentBlock) {
704
+ return;
705
+ }
706
+ for (var level = 1; level <= 6; level++) {
707
+ linkifyAnchors(level, contentBlock);
708
+ }
709
+ }
710
+ };
711
+ </script>
712
+
713
+
714
+ <!-- Google Analytics (https://www.google.com/analytics) -->
715
+ <script>
716
+ !function(j,e,k,y,l,L){j.GoogleAnalyticsObject=y,j[y]||(j[y]=function(){
717
+ (j[y].q=j[y].q||[]).push(arguments)}),j[y].l=+new Date,l=e.createElement(k),
718
+ L=e.getElementsByTagName(k)[0],l.src='https://www.google-analytics.com/analytics.js',
719
+ L.parentNode.insertBefore(l,L)}(window,document,'script','ga');
720
+
721
+ ga('create', 'UA-50755011-1', 'jekyllrb.com');
722
+ ga('send', 'pageview');
723
+
724
+ </script>
725
+
726
+
727
+ <script type="text/javascript" src="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.js"></script>
728
+ <script type="text/javascript"> docsearch({
729
+ apiKey: '50fe39c839958dfad797000f33e2ec17',
730
+ indexName: 'jekyllrb',
731
+ inputSelector: '#docsearch-input',
732
+ enhancedSearchInput: true,
733
+ debug: false // Set debug to true if you want to inspect the dropdown
734
+ });
735
+ </script>
736
+
737
+ </body>
738
+ </html>