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
@@ -1,821 +1,11 @@
1
- <!DOCTYPE HTML>
1
+ <!DOCTYPE html>
2
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 v3.9.0">
7
- <link type="application/atom+xml" rel="alternate" href="https://jekyllrb.com/feed.xml" title="Jekyll • Simple, blog-aware, static sites" />
8
- <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" />
12
- <link rel="stylesheet" href="/css/screen.css">
13
- <link rel="icon" type="image/x-icon" href="/favicon.ico">
14
- <!-- Begin Jekyll SEO tag v2.6.1 -->
15
- <title>Front Matter | Jekyll • Simple, blog-aware, static sites</title>
16
- <meta name="generator" content="Jekyll v3.9.0" />
17
- <meta property="og:title" content="Front Matter" />
18
- <meta property="og:locale" content="en_US" />
19
- <meta name="description" content="The front matter is where Jekyll starts to get really cool. Any file that contains a YAML front matter block will be processed by Jekyll as a special file. The front matter must be the first thing in the file and must take the form of valid YAML set between triple-dashed lines. Here is a basic example:" />
20
- <meta property="og:description" content="The front matter is where Jekyll starts to get really cool. Any file that contains a YAML front matter block will be processed by Jekyll as a special file. The front matter must be the first thing in the file and must take the form of valid YAML set between triple-dashed lines. Here is a basic example:" />
21
- <link rel="canonical" href="https://jekyllrb.com/docs/frontmatter/" />
22
- <meta property="og:url" content="https://jekyllrb.com/docs/frontmatter/" />
23
- <meta property="og:site_name" content="Jekyll • Simple, blog-aware, static sites" />
24
- <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="twitter:title" content="Front Matter" />
28
- <meta name="twitter:site" content="@jekyllrb" />
29
- <meta name="google-site-verification" content="onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY" />
30
- <script type="application/ld+json">
31
- {"url":"https://jekyllrb.com/docs/frontmatter/","headline":"Front Matter","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":"The front matter is where Jekyll starts to get really cool. Any file that contains a YAML front matter block will be processed by Jekyll as a special file. The front matter must be the first thing in the file and must take the form of valid YAML set between triple-dashed lines. Here is a basic example:","mainEntityOfPage":{"@type":"WebPage","@id":"https://jekyllrb.com/docs/frontmatter/"},"@type":"BlogPosting","@context":"https://schema.org"}</script>
32
- <!-- End Jekyll SEO tag -->
33
-
34
- <!--[if lt IE 9]>
35
- <script src="/js/html5shiv.min.js"></script>
36
- <script src="/js/respond.min.js"></script>
37
- <![endif]-->
38
- </head>
39
-
40
-
41
- <body class="wrap">
42
- <header>
43
- <div class="flexbox">
44
- <div class="center-on-mobiles">
45
- <h1>
46
- <a href="/" class="logo">
47
- <span class="sr-only">Jekyll</span>
48
- <img src="/img/logo-2x.png" width="140" height="65" alt="Jekyll Logo">
49
- </a>
50
- </h1>
51
- </div>
52
- <nav class="main-nav hide-on-mobiles">
53
- <ul>
54
- <li class="">
55
- <a href="/">Home</a>
56
- </li>
57
- <li class="current">
58
- <a href="/docs/home/">Docs</a>
59
- </li>
60
- <li class="">
61
- <a href="/news/">News</a>
62
- </li>
63
- <li class="">
64
- <a href="/help/">Help</a>
65
- </li>
66
- </ul>
67
-
68
- </nav>
69
- <div class="search hide-on-mobiles">
70
- <input type="text" id="docsearch-input" placeholder="Search the docs…">
71
-
72
- </div>
73
- <div class="meta hide-on-mobiles">
74
- <ul>
75
- <li>
76
- <a href="https://github.com/jekyll/jekyll/releases/tag/v3.9.0">v3.9.0</a>
77
- </li>
78
- <li>
79
- <a href="https://github.com/jekyll/jekyll">GitHub</a>
80
- </li>
81
- </ul>
82
- </div>
83
- </div>
84
- <nav class="mobile-nav show-on-mobiles">
85
- <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
- <li>
99
- <a href="https://github.com/jekyll/jekyll">GitHub</a>
100
- </li>
101
- </ul>
102
-
103
- </nav>
104
- </header>
105
-
106
-
107
- <section class="docs">
108
- <div class="grid">
109
-
110
- <div class="docs-nav-mobile unit whole show-on-mobiles">
111
- <select onchange="if (this.value) window.location.href=this.value">
112
- <option value="">Navigate the docs…</option>
113
-
114
- <optgroup label="Getting Started">
115
-
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">
148
-
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
- </optgroup>
191
-
192
- <optgroup label="Customization">
193
-
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
- </optgroup>
224
-
225
- <optgroup label="Deployment">
226
-
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
- </optgroup>
241
-
242
- <optgroup label="Miscellaneous">
243
-
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
- </optgroup>
266
-
267
- <optgroup label="Meta">
268
-
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
- </optgroup>
287
-
288
- </select>
289
- </div>
290
-
291
-
292
- <div class="unit four-fifths">
293
- <article>
294
- <div class="improve right hide-on-mobiles">
295
- <a href="https://github.com/jekyll/jekyll/edit/master/docs/_docs/frontmatter.md"><i class="fa fa-pencil"></i> &nbsp;Improve this page</a>
296
- </div>
297
- <h1>Front Matter</h1>
298
- <p>The front matter is where Jekyll starts to get really cool. Any file that
299
- contains a <a href="http://yaml.org/">YAML</a> front matter block will be processed by
300
- Jekyll as a special file. The front matter must be the first thing in the file
301
- and must take the form of valid YAML set between triple-dashed lines. Here is a
302
- basic example:</p>
303
-
304
- <div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nn">---</span>
305
- <span class="na">layout</span><span class="pi">:</span> <span class="s">post</span>
306
- <span class="na">title</span><span class="pi">:</span> <span class="s">Blogging Like a Hacker</span>
307
- <span class="nn">---</span>
308
- </code></pre></div></div>
309
-
310
- <p>Between these triple-dashed lines, you can set predefined variables (see below
311
- for a reference) or even create custom ones of your own. These variables will
312
- then be available to you to access using Liquid tags both further down in the
313
- file and also in any layouts or includes that the page or post in question
314
- relies on.</p>
315
-
316
- <div class="note warning">
317
- <h5>UTF-8 Character Encoding Warning</h5>
318
- <p>
319
- If you use UTF-8 encoding, make sure that no <code>BOM</code> header
320
- characters exist in your files or very, very bad things will happen to
321
- Jekyll. This is especially relevant if you’re running
322
- <a href="../windows/">Jekyll on Windows</a>.
323
- </p>
324
- </div>
325
-
326
- <div class="note">
327
- <h5>ProTip™: Front Matter Variables Are Optional</h5>
328
- <p>
329
- If you want to use <a href="../variables/">Liquid tags and variables</a>
330
- but don’t need anything in your front matter, just leave it empty! The set
331
- of triple-dashed lines with nothing in between will still get Jekyll to
332
- process your file. (This is useful for things like CSS and RSS feeds!)
333
- </p>
334
- </div>
335
-
336
- <h2 id="predefined-global-variables">Predefined Global Variables</h2>
337
-
338
- <p>There are a number of predefined global variables that you can set in the
339
- front matter of a page or post.</p>
340
-
341
- <div class="mobile-side-scroller">
342
- <table>
343
- <thead>
344
- <tr>
345
- <th>Variable</th>
346
- <th>Description</th>
347
- </tr>
348
- </thead>
349
- <tbody>
350
- <tr>
351
- <td>
352
- <p><code>layout</code></p>
353
- </td>
354
- <td>
355
- <p>
356
-
357
- If set, this specifies the layout file to use. Use the layout file
358
- name without the file extension. Layout files must be placed in the
359
- <code>_layouts</code> directory.
360
-
361
- </p>
362
- <ul>
363
- <li>
364
- Using <code>null</code> will produce a file without using a layout
365
- file. However this is overridden if the file is a post/document and has a
366
- layout defined in the <a href="../configuration/#front-matter-defaults">
367
- frontmatter defaults</a>.
368
- </li>
369
- <li>
370
- Starting from version 3.5.0, using <code>none</code> in a post/document will
371
- produce a file without using a layout file regardless of frontmatter defaults.
372
- Using <code>none</code> in a page, however, will cause Jekyll to attempt to
373
- use a layout named "none".
374
- </li>
375
- </ul>
376
- </td>
377
- </tr>
378
- <tr>
379
- <td>
380
- <p><code>permalink</code></p>
381
- </td>
382
- <td>
383
- <p>
384
-
385
- If you need your processed blog post URLs to be something other than
386
- the site-wide style (default <code>/year/month/day/title.html</code>), then you can set
387
- this variable and it will be used as the final URL.
388
-
389
- </p>
390
- </td>
391
- </tr>
392
- <tr>
393
- <td>
394
- <p><code>published</code></p>
395
- </td>
396
- <td>
397
- <p>
398
- Set to false if you don’t want a specific post to show up when the
399
- site is generated.
400
- </p>
401
- </td>
402
- </tr>
403
- </tbody>
404
- </table>
405
- </div>
406
-
407
- <div class="note">
408
- <h5>ProTip™: Render Posts Marked As Unpublished</h5>
409
- <p>
410
- To preview unpublished pages, simply run `jekyll serve` or `jekyll build`
411
- with the `--unpublished` switch. Jekyll also has a handy <a href="../drafts/">drafts</a>
412
- feature tailored specifically for blog posts.
413
- </p>
414
- </div>
415
-
416
- <h2 id="custom-variables">Custom Variables</h2>
417
-
418
- <p>Any variables in the front matter that are not predefined are mixed into the
419
- data that is sent to the Liquid templating engine during the conversion. For
420
- instance, if you set a title, you can use that in your layout to set the page
421
- title:</p>
422
-
423
- <div class="language-liquid highlighter-rouge"><div class="highlight"><pre class="highlight"><code>&lt;!DOCTYPE HTML&gt;
424
- &lt;html&gt;
425
- &lt;head&gt;
426
- &lt;title&gt;<span class="p">{{</span><span class="w"> </span><span class="nv">page</span><span class="p">.</span><span class="nv">title</span><span class="w"> </span><span class="p">}}</span>&lt;/title&gt;
427
- &lt;/head&gt;
428
- &lt;body&gt;
429
-
430
- </code></pre></div></div>
431
-
432
- <h2 id="predefined-variables-for-posts">Predefined Variables for Posts</h2>
433
-
434
- <p>These are available out-of-the-box to be used in the front matter for a post.</p>
435
-
436
- <div class="mobile-side-scroller">
437
- <table>
438
- <thead>
439
- <tr>
440
- <th>Variable</th>
441
- <th>Description</th>
442
- </tr>
443
- </thead>
444
- <tbody>
445
- <tr>
446
- <td>
447
- <p><code>date</code></p>
448
- </td>
449
- <td>
450
- <p>
451
- A date here overrides the date from the name of the post. This can be
452
- used to ensure correct sorting of posts. A date is specified in the
453
- format <code>YYYY-MM-DD HH:MM:SS +/-TTTT</code>; hours, minutes, seconds, and timezone offset
454
- are optional.
455
- </p>
456
- </td>
457
- </tr>
458
- <tr>
459
- <td>
460
- <p><code>category</code></p>
461
- <p><code>categories</code></p>
462
- </td>
463
- <td>
464
- <p>
465
-
466
- Instead of placing posts inside of folders, you can specify one or
467
- more categories that the post belongs to. When the site is generated
468
- the post will act as though it had been set with these categories
469
- normally. Categories (plural key) can be specified as a <a href="https://en.wikipedia.org/wiki/YAML#Basic_components">YAML list</a> or a
470
- space-separated string.
471
-
472
- </p>
473
- </td>
474
- </tr>
475
- <tr>
476
- <td>
477
- <p><code>tags</code></p>
478
- </td>
479
- <td>
480
- <p>
481
-
482
- Similar to categories, one or multiple tags can be added to a post.
483
- Also like categories, tags can be specified as a <a href="https://en.wikipedia.org/wiki/YAML#Basic_components">YAML list</a> or a
484
- space-separated string.
485
-
486
- </p>
487
- </td>
488
- </tr>
489
- </tbody>
490
- </table>
491
- </div>
492
-
493
- <div class="note">
494
- <h5>ProTip™: Don't repeat yourself</h5>
495
- <p>
496
- If you don't want to repeat your frequently used front matter variables
497
- over and over, just define <a href="../configuration/#front-matter-defaults" title="Front Matter defaults">defaults</a>
498
- for them and only override them where necessary (or not at all). This works
499
- both for predefined and custom variables.
500
- </p>
501
- </div>
502
-
503
-
504
-
505
-
506
-
507
-
508
-
509
-
510
-
511
-
512
-
513
-
514
-
515
-
516
-
517
-
518
-
519
-
520
-
521
-
522
-
523
-
524
-
525
-
526
-
527
-
528
-
529
-
530
-
531
-
532
- <div class="section-nav">
533
- <div class="left align-right">
534
-
535
-
536
-
537
- <a href="/docs/configuration/" class="prev">Back</a>
538
-
539
- </div>
540
- <div class="right align-left">
541
-
542
-
543
-
544
- <a href="/docs/posts/" class="next">Next</a>
545
-
546
- </div>
547
- </div>
548
- <div class="clear"></div>
549
-
550
- </article>
551
- </div>
552
-
553
- <div class="unit one-fifth hide-on-mobiles">
554
- <aside>
555
-
556
- <h4>Getting Started</h4>
557
- <ul>
558
-
559
-
560
-
561
- <li class=""><a href="/docs/home/">Welcome</a></li>
562
-
563
-
564
-
565
- <li class=""><a href="/docs/quickstart/">Quick-start guide</a></li>
566
-
567
-
568
-
569
- <li class=""><a href="/docs/installation/">Installation</a></li>
570
-
571
-
572
-
573
- <li class=""><a href="/docs/windows/">Jekyll on Windows</a></li>
574
-
575
-
576
-
577
- <li class=""><a href="/docs/usage/">Basic Usage</a></li>
578
-
579
-
580
-
581
- <li class=""><a href="/docs/structure/">Directory structure</a></li>
582
-
583
-
584
-
585
- <li class=""><a href="/docs/configuration/">Configuration</a></li>
586
-
587
- </ul>
588
-
589
-
590
- <h4>Your Content</h4>
591
- <ul>
592
-
593
-
594
-
595
- <li class="current"><a href="/docs/frontmatter/">Front Matter</a></li>
596
-
597
-
598
-
599
- <li class=""><a href="/docs/posts/">Writing posts</a></li>
600
-
601
-
602
-
603
- <li class=""><a href="/docs/drafts/">Working with drafts</a></li>
604
-
605
-
606
-
607
- <li class=""><a href="/docs/pages/">Creating pages</a></li>
608
-
609
-
610
-
611
- <li class=""><a href="/docs/static-files/">Static Files</a></li>
612
-
613
-
614
-
615
- <li class=""><a href="/docs/variables/">Variables</a></li>
616
-
617
-
618
-
619
- <li class=""><a href="/docs/collections/">Collections</a></li>
620
-
621
-
622
-
623
- <li class=""><a href="/docs/datafiles/">Data Files</a></li>
624
-
625
-
626
-
627
- <li class=""><a href="/docs/assets/">Assets</a></li>
628
-
629
-
630
-
631
- <li class=""><a href="/docs/migrations/">Blog migrations</a></li>
632
-
633
- </ul>
634
-
635
-
636
- <h4>Customization</h4>
637
- <ul>
638
-
639
-
640
-
641
- <li class=""><a href="/docs/templates/">Templates</a></li>
642
-
643
-
644
-
645
- <li class=""><a href="/docs/includes/">Includes</a></li>
646
-
647
-
648
-
649
- <li class=""><a href="/docs/permalinks/">Permalinks</a></li>
650
-
651
-
652
-
653
- <li class=""><a href="/docs/pagination/">Pagination</a></li>
654
-
655
-
656
-
657
- <li class=""><a href="/docs/plugins/">Plugins</a></li>
658
-
659
-
660
-
661
- <li class=""><a href="/docs/themes/">Themes</a></li>
662
-
663
-
664
-
665
- <li class=""><a href="/docs/extras/">Extras</a></li>
666
-
667
- </ul>
668
-
669
-
670
- <h4>Deployment</h4>
671
- <ul>
672
-
673
-
674
-
675
- <li class=""><a href="/docs/github-pages/">GitHub Pages</a></li>
676
-
677
-
678
-
679
- <li class=""><a href="/docs/deployment-methods/">Deployment methods</a></li>
680
-
681
-
682
-
683
- <li class=""><a href="/docs/continuous-integration/">Continuous Integration</a></li>
684
-
685
- </ul>
686
-
687
-
688
- <h4>Miscellaneous</h4>
689
- <ul>
690
-
691
-
692
-
693
- <li class=""><a href="/docs/troubleshooting/">Troubleshooting</a></li>
694
-
695
-
696
-
697
- <li class=""><a href="/docs/sites/">Sites using Jekyll</a></li>
698
-
699
-
700
-
701
- <li class=""><a href="/docs/resources/">Resources</a></li>
702
-
703
-
704
-
705
- <li class=""><a href="/docs/upgrading/0-to-2/">Upgrading from 0.x to 2.x</a></li>
706
-
707
-
708
-
709
- <li class=""><a href="/docs/upgrading/2-to-3/">Upgrading from 2.x to 3.x</a></li>
710
-
711
- </ul>
712
-
713
-
714
- <h4>Meta</h4>
715
- <ul>
716
-
717
-
718
-
719
- <li class=""><a href="/docs/contributing/">Contributing</a></li>
720
-
721
-
722
-
723
- <li class=""><a href="/docs/maintaining/">Maintaining Jekyll</a></li>
724
-
725
-
726
-
727
- <li class=""><a href="/docs/conduct/">Code of Conduct</a></li>
728
-
729
-
730
-
731
- <li class=""><a href="/docs/history/">History</a></li>
732
-
733
- </ul>
734
-
735
-
736
- </aside>
737
- </div>
738
-
739
-
740
- <div class="clear"></div>
741
-
742
- </div>
743
- </section>
744
-
745
-
746
- <footer>
747
- <div class="grid">
748
- <div class="unit one-third center-on-mobiles">
749
- <p>The contents of this website are <br />&copy;&nbsp;2020 under the terms of the <a href="https://github.com/jekyll/jekyll/blob/master/LICENSE">MIT&nbsp;License</a>.</p>
750
- </div>
751
- <div class="unit two-thirds align-right center-on-mobiles">
752
- <p>
753
- Proudly hosted by
754
- <a href="https://github.com">
755
- <img src="/img/footer-logo.png" width="100" height="30" alt="GitHub • Social coding">
756
- </a>
757
- </p>
758
- </div>
759
- </div>
760
- </footer>
761
-
762
- <script>
763
- var anchorForId = function (id) {
764
- var anchor = document.createElement("a");
765
- anchor.className = "header-link";
766
- anchor.href = "#" + id;
767
- anchor.innerHTML = "<span class=\"sr-only\">Permalink</span><i class=\"fa fa-link\"></i>";
768
- anchor.title = "Permalink";
769
- return anchor;
770
- };
771
-
772
- var linkifyAnchors = function (level, containingElement) {
773
- var headers = containingElement.getElementsByTagName("h" + level);
774
- for (var h = 0; h < headers.length; h++) {
775
- var header = headers[h];
776
-
777
- if (typeof header.id !== "undefined" && header.id !== "") {
778
- header.appendChild(anchorForId(header.id));
779
- }
780
- }
781
- };
782
-
783
- document.onreadystatechange = function () {
784
- if (this.readyState === "complete") {
785
- var contentBlock = document.getElementsByClassName("docs")[0] || document.getElementsByClassName("news")[0];
786
- if (!contentBlock) {
787
- return;
788
- }
789
- for (var level = 1; level <= 6; level++) {
790
- linkifyAnchors(level, contentBlock);
791
- }
792
- }
793
- };
794
- </script>
795
-
796
-
797
- <!-- Google Analytics (https://www.google.com/analytics) -->
798
- <script>
799
- !function(j,e,k,y,l,L){j.GoogleAnalyticsObject=y,j[y]||(j[y]=function(){
800
- (j[y].q=j[y].q||[]).push(arguments)}),j[y].l=+new Date,l=e.createElement(k),
801
- L=e.getElementsByTagName(k)[0],l.src='https://www.google-analytics.com/analytics.js',
802
- L.parentNode.insertBefore(l,L)}(window,document,'script','ga');
803
-
804
- ga('create', 'UA-50755011-1', 'jekyllrb.com');
805
- ga('send', 'pageview');
806
-
807
- </script>
808
-
809
-
810
- <script type="text/javascript" src="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.js"></script>
811
- <script type="text/javascript"> docsearch({
812
- apiKey: '50fe39c839958dfad797000f33e2ec17',
813
- indexName: 'jekyllrb',
814
- inputSelector: '#docsearch-input',
815
- enhancedSearchInput: true,
816
- debug: false // Set debug to true if you want to inspect the dropdown
817
- });
818
- </script>
819
-
820
- </body>
3
+ <meta charset="utf-8">
4
+ <title>Redirecting&hellip;</title>
5
+ <link rel="canonical" href="https://jekyllrb.com/docs/front-matter/">
6
+ <script>location="https://jekyllrb.com/docs/front-matter/"</script>
7
+ <meta http-equiv="refresh" content="0; url=https://jekyllrb.com/docs/front-matter/">
8
+ <meta name="robots" content="noindex">
9
+ <h1>Redirecting&hellip;</h1>
10
+ <a href="https://jekyllrb.com/docs/front-matter/">Click here if you are not redirected.</a>
821
11
  </html>