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.
- checksums.yaml +4 -4
- data/lib/jekyll-docs.rb +3 -3
- data/site/404.html +10 -7
- data/site/css/screen.css +3 -1
- data/site/css/screen.css.map +28 -0
- data/site/docs/assets/index.html +412 -453
- data/site/docs/code_of_conduct/index.html +447 -501
- data/site/docs/collections/index.html +487 -674
- data/site/docs/community/bug/index.html +603 -0
- data/site/docs/community/index.html +635 -0
- data/site/docs/conduct/index.html +447 -515
- data/site/docs/configuration/default/index.html +682 -0
- data/site/docs/configuration/environments/index.html +641 -0
- data/site/docs/configuration/front-matter-defaults/index.html +738 -0
- data/site/docs/configuration/incremental-regeneration/index.html +631 -0
- data/site/docs/configuration/index.html +405 -1230
- data/site/docs/configuration/liquid/index.html +616 -0
- data/site/docs/configuration/markdown/index.html +766 -0
- data/site/docs/configuration/options/index.html +1011 -0
- data/site/docs/configuration/webrick/index.html +615 -0
- data/site/docs/continuous-integration/buddyworks/index.html +393 -479
- data/site/docs/continuous-integration/circleci/index.html +465 -481
- data/site/docs/continuous-integration/travis-ci/index.html +450 -507
- data/site/docs/contributing/index.html +425 -514
- data/site/docs/datafiles/index.html +411 -453
- data/site/docs/deployment-methods/index.html +9 -871
- data/site/docs/deployment/automated/index.html +663 -0
- data/site/docs/deployment/index.html +607 -0
- data/site/docs/deployment/manual/index.html +631 -0
- data/site/docs/deployment/third-party/index.html +639 -0
- data/site/docs/drafts/index.html +9 -634
- data/site/docs/extras/index.html +9 -687
- data/site/docs/front-matter/index.html +799 -0
- data/site/docs/frontmatter/index.html +9 -819
- data/site/docs/github-pages/index.html +407 -475
- data/site/docs/history/index.html +1370 -1154
- data/site/docs/home/index.html +9 -627
- data/site/docs/includes/index.html +425 -501
- data/site/docs/index.html +630 -9
- data/site/docs/installation/index.html +403 -540
- data/site/docs/installation/macos/index.html +716 -0
- data/site/docs/installation/other-linux/index.html +613 -0
- data/site/docs/installation/ubuntu/index.html +623 -0
- data/site/docs/installation/windows/index.html +733 -0
- data/site/docs/layouts/index.html +726 -0
- data/site/docs/liquid/filters/index.html +1169 -0
- data/site/docs/liquid/index.html +615 -0
- data/site/docs/liquid/tags/index.html +728 -0
- data/site/docs/maintaining/affinity-team-captain/index.html +395 -479
- data/site/docs/maintaining/avoiding-burnout/index.html +391 -475
- data/site/docs/maintaining/becoming-a-maintainer/index.html +391 -475
- data/site/docs/maintaining/index.html +391 -486
- data/site/docs/maintaining/merging-a-pull-request/index.html +406 -490
- data/site/docs/maintaining/releasing-a-new-version/index.html +409 -485
- data/site/docs/maintaining/reviewing-a-pull-request/index.html +392 -476
- data/site/docs/maintaining/special-labels/index.html +397 -481
- data/site/docs/maintaining/triaging-an-issue/index.html +394 -478
- data/site/docs/markdown-101/index.html +601 -0
- data/site/docs/migrations/index.html +396 -440
- data/site/docs/pages/index.html +408 -482
- data/site/docs/pagination/index.html +450 -509
- data/site/docs/permalinks/index.html +552 -587
- data/site/docs/plugins/commands/index.html +656 -0
- data/site/docs/plugins/converters/index.html +685 -0
- data/site/docs/plugins/filters/index.html +624 -0
- data/site/docs/plugins/generators/index.html +697 -0
- data/site/docs/plugins/hooks/index.html +838 -0
- data/site/docs/plugins/index.html +415 -1565
- data/site/docs/plugins/installation/index.html +681 -0
- data/site/docs/plugins/tags/index.html +699 -0
- data/site/docs/plugins/your-first-plugin/index.html +741 -0
- data/site/docs/posts/index.html +491 -627
- data/site/docs/quickstart/index.html +9 -645
- data/site/docs/resources/index.html +9 -761
- data/site/docs/ruby-101/index.html +640 -0
- data/site/docs/sites/index.html +9 -696
- data/site/docs/static-files/index.html +401 -433
- data/site/docs/step-by-step/01-setup/index.html +771 -0
- data/site/docs/step-by-step/02-liquid/index.html +756 -0
- data/site/docs/step-by-step/03-front-matter/index.html +730 -0
- data/site/docs/step-by-step/04-layouts/index.html +770 -0
- data/site/docs/step-by-step/05-includes/index.html +768 -0
- data/site/docs/step-by-step/06-data-files/index.html +738 -0
- data/site/docs/step-by-step/07-assets/index.html +773 -0
- data/site/docs/step-by-step/08-blogging/index.html +835 -0
- data/site/docs/step-by-step/09-collections/index.html +932 -0
- data/site/docs/step-by-step/10-deployment/index.html +842 -0
- data/site/docs/structure/index.html +411 -430
- data/site/docs/support/index.html +392 -476
- data/site/docs/templates/index.html +9 -1232
- data/site/docs/themes/index.html +487 -521
- data/site/docs/troubleshooting/index.html +443 -520
- data/site/docs/upgrading/0-to-2/index.html +437 -523
- data/site/docs/upgrading/2-to-3/index.html +422 -507
- data/site/docs/upgrading/3-to-4/index.html +765 -0
- data/site/docs/upgrading/index.html +395 -478
- data/site/docs/usage/index.html +409 -506
- data/site/docs/variables/index.html +504 -652
- data/site/docs/windows/index.html +9 -784
- data/site/feed.xml +269 -188
- data/site/feed/release.xml +324 -0
- data/site/fonts/lato-v14-latin-300.woff +0 -0
- data/site/fonts/lato-v14-latin-300.woff2 +0 -0
- data/site/fonts/lato-v14-latin-300italic.woff +0 -0
- data/site/fonts/lato-v14-latin-300italic.woff2 +0 -0
- data/site/fonts/lato-v14-latin-700.woff +0 -0
- data/site/fonts/lato-v14-latin-700.woff2 +0 -0
- data/site/fonts/lato-v14-latin-700italic.woff +0 -0
- data/site/fonts/lato-v14-latin-700italic.woff2 +0 -0
- data/site/fonts/lato-v14-latin-900.woff +0 -0
- data/site/fonts/lato-v14-latin-900.woff2 +0 -0
- data/site/fonts/lato-v14-latin-900italic.woff +0 -0
- data/site/fonts/lato-v14-latin-900italic.woff2 +0 -0
- data/site/fonts/lato-v14-latin-italic.woff +0 -0
- data/site/fonts/lato-v14-latin-italic.woff2 +0 -0
- data/site/fonts/lato-v14-latin-regular.woff +0 -0
- data/site/fonts/lato-v14-latin-regular.woff2 +0 -0
- data/site/help/index.html +9 -247
- data/site/img/forestry-logo.svg +19 -0
- data/site/img/jekyll-og.png +0 -0
- data/site/img/spacer.gif +0 -0
- data/site/index.html +56 -29
- data/site/jekyllconf/index.html +62 -35
- data/site/latest_version.txt +1 -1
- data/site/news/2013/05/05/jekyll-1-0-0-released/index.html +180 -115
- data/site/news/2013/05/08/jekyll-1-0-1-released/index.html +182 -117
- data/site/news/2013/05/12/jekyll-1-0-2-released/index.html +183 -118
- data/site/news/2013/06/07/jekyll-1-0-3-released/index.html +184 -119
- data/site/news/2013/07/14/jekyll-1-1-0-released/index.html +183 -118
- data/site/news/2013/07/24/jekyll-1-1-1-released/index.html +180 -115
- data/site/news/2013/07/25/jekyll-1-0-4-released/index.html +182 -117
- data/site/news/2013/07/25/jekyll-1-1-2-released/index.html +182 -117
- data/site/news/2013/09/06/jekyll-1-2-0-released/index.html +185 -120
- data/site/news/2013/09/14/jekyll-1-2-1-released/index.html +183 -118
- data/site/news/2013/10/28/jekyll-1-3-0-rc1-released/index.html +180 -115
- data/site/news/2013/11/04/jekyll-1-3-0-released/index.html +189 -124
- data/site/news/2013/11/26/jekyll-1-3-1-released/index.html +181 -116
- data/site/news/2013/12/07/jekyll-1-4-0-released/index.html +181 -116
- data/site/news/2013/12/09/jekyll-1-4-1-released/index.html +180 -115
- data/site/news/2013/12/16/jekyll-1-4-2-released/index.html +182 -117
- data/site/news/2014/01/13/jekyll-1-4-3-released/index.html +181 -116
- data/site/news/2014/03/24/jekyll-1-5-0-released/index.html +181 -116
- data/site/news/2014/03/27/jekyll-1-5-1-released/index.html +181 -116
- data/site/news/2014/05/06/jekyll-turns-2-0-0/index.html +184 -119
- data/site/news/2014/05/08/jekyll-2-0-3-released/index.html +180 -115
- data/site/news/2014/06/04/jekyll-stickers-1-dollar-stickermule/index.html +181 -116
- data/site/news/2014/06/28/jekyll-turns-21-i-mean-2-1-0/index.html +185 -120
- data/site/news/2014/07/01/jekyll-2-1-1-released/index.html +182 -117
- data/site/news/2014/07/29/jekyll-2-2-0-released/index.html +181 -116
- data/site/news/2014/08/10/jekyll-2-3-0-released/index.html +189 -124
- data/site/news/2014/09/09/jekyll-2-4-0-released/index.html +187 -122
- data/site/news/2014/11/05/jekylls-midlife-crisis-jekyll-turns-2-5-0/index.html +188 -123
- data/site/news/2014/11/09/jekyll-2-5-1-released/index.html +180 -115
- data/site/news/2014/11/12/jekyll-2-5-2-released/index.html +182 -117
- data/site/news/2014/12/17/alfredxing-welcome-to-jekyll-core/index.html +179 -114
- data/site/news/2014/12/22/jekyll-2-5-3-released/index.html +180 -115
- data/site/news/2015/01/20/jekyll-meet-and-greet/index.html +179 -114
- data/site/news/2015/01/24/jekyll-3-0-0-beta1-released/index.html +180 -115
- data/site/news/2015/02/26/introducing-jekyll-talk/index.html +180 -115
- data/site/news/2015/10/26/jekyll-3-0-released/index.html +185 -120
- data/site/news/2015/11/17/jekyll-3-0-1-released/index.html +184 -119
- data/site/news/2016/01/20/jekyll-3-0-2-released/index.html +182 -117
- data/site/news/2016/01/24/jekyll-3-1-0-released/index.html +186 -121
- data/site/news/2016/01/28/jekyll-3-1-1-released/index.html +183 -118
- data/site/news/2016/02/08/jekyll-3-0-3-released/index.html +181 -116
- data/site/news/2016/02/19/jekyll-3-1-2-released/index.html +182 -117
- data/site/news/2016/03/10/making-it-easier-to-contribute-to-jekyll/index.html +179 -114
- data/site/news/2016/04/19/jekyll-3-0-4-released/index.html +181 -116
- data/site/news/2016/04/19/jekyll-3-1-3-released/index.html +181 -116
- data/site/news/2016/04/26/jekyll-3-0-5-released/index.html +180 -115
- data/site/news/2016/05/18/jekyll-3-1-4-released/index.html +186 -121
- data/site/news/2016/05/18/jekyll-3-1-5-released/index.html +181 -116
- data/site/news/2016/05/19/jekyll-3-1-6-released/index.html +181 -116
- data/site/news/2016/06/03/update-on-jekyll-s-google-summer-of-code-projects/index.html +179 -114
- data/site/news/2016/07/26/jekyll-3-2-0-released/index.html +184 -119
- data/site/news/2016/08/02/jekyll-3-2-1-released/index.html +180 -115
- data/site/news/2016/08/24/jekyll-admin-initial-release/index.html +179 -114
- data/site/news/2016/10/06/jekyll-3-3-is-here/index.html +207 -142
- data/site/news/2016/11/14/jekyll-3-3-1-released/index.html +181 -116
- data/site/news/2017/01/18/jekyll-3-4-0-released/index.html +183 -118
- data/site/news/2017/03/02/jekyll-3-4-1-released/index.html +181 -116
- data/site/news/2017/03/09/jekyll-3-4-2-released/index.html +189 -124
- data/site/news/2017/03/21/jekyll-3-4-3-released/index.html +190 -125
- data/site/news/2017/06/15/jekyll-3-5-0-released/index.html +187 -122
- data/site/news/2017/07/17/jekyll-3-5-1-released/index.html +182 -117
- data/site/news/2017/08/12/jekyll-3-5-2-released/index.html +185 -120
- data/site/news/2017/09/21/jekyll-3-6-0-released/index.html +181 -116
- data/site/news/2017/10/19/diversity-open-source/index.html +181 -116
- data/site/news/2017/10/21/jekyll-3-6-2-released/index.html +183 -118
- data/site/news/2018/01/02/jekyll-3-7-0-released/index.html +184 -119
- data/site/news/2018/01/25/jekyll-3-7-2-released/index.html +189 -124
- data/site/news/2018/02/19/meet-jekyll-s-new-lead-developer/index.html +180 -115
- data/site/news/2018/02/24/jekyll-3-7-3-released/index.html +185 -120
- data/site/news/2018/04/19/development-update/index.html +699 -0
- data/site/news/2018/04/19/jekyll-3-8-0-released/index.html +715 -0
- data/site/news/2018/05/01/jekyll-3-8-1-released/index.html +182 -117
- data/site/news/2018/05/19/jekyll-3-8-2-released/index.html +181 -116
- data/site/news/2018/06/05/jekyll-3-8-3-released/index.html +183 -118
- data/site/news/2018/08/01/jekyll-sponsoring/index.html +748 -0
- data/site/news/2018/09/19/security-fixes-for-3-6-3-7-3-8/index.html +692 -0
- data/site/news/2018/11/04/jekyll-3-8-5-released/index.html +682 -0
- data/site/news/2019/03/18/jekyll-4-0-0-pre-alpha1-released/index.html +710 -0
- data/site/news/2019/07/02/jekyll-3-8-6-released/index.html +180 -115
- data/site/news/2019/07/20/jekyll-4-0-0-pre-beta1-released/index.html +11 -0
- data/site/news/2019/08/04/jekyll-4-0-0-pre-beta1-released/index.html +708 -0
- data/site/news/2019/08/20/jekyll-4-0-0-released/index.html +809 -0
- data/site/news/index.html +976 -326
- data/site/news/releases/index.html +820 -321
- data/site/{philosophy.html → philosophy/index.html} +1 -1
- data/site/redirects.json +1 -1
- data/site/resources/index.html +332 -0
- data/site/showcase/index.html +844 -0
- data/site/sitemap.xml +256 -81
- data/site/team/index.html +63 -77
- data/site/tutorials/cache-api/index.html +418 -0
- data/site/tutorials/convert-site-to-jekyll/index.html +155 -124
- data/site/tutorials/custom-404-page/index.html +76 -43
- data/site/tutorials/home/index.html +64 -37
- data/site/tutorials/navigation/index.html +186 -103
- data/site/tutorials/orderofinterpretation/index.html +80 -53
- data/site/tutorials/using-jekyll-with-bundler/index.html +80 -51
- data/site/tutorials/video-walkthroughs/index.html +62 -35
- metadata +102 -13
- data/site/community/index.html +0 -11
- data/site/docs/continuous-integration/index.html +0 -681
@@ -0,0 +1,799 @@
|
|
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 | Jekyll • Simple, blog-aware, static sites</title>
|
17
|
+
<meta name="generator" content="Jekyll v4.0.0" />
|
18
|
+
<meta property="og:title" content="Front Matter" />
|
19
|
+
<meta property="og:locale" content="en_US" />
|
20
|
+
<meta name="description" content="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
|
+
<meta property="og:description" content="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:" />
|
22
|
+
<link rel="canonical" href="https://jekyllrb.com/docs/front-matter/" />
|
23
|
+
<meta property="og:url" content="https://jekyllrb.com/docs/front-matter/" />
|
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" />
|
31
|
+
<meta name="twitter:site" content="@jekyllrb" />
|
32
|
+
<meta name="google-site-verification" content="onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY" />
|
33
|
+
<script type="application/ld+json">
|
34
|
+
{"description":"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:","@type":"BlogPosting","mainEntityOfPage":{"@type":"WebPage","@id":"https://jekyllrb.com/docs/front-matter/"},"headline":"Front Matter","dateModified":"2019-09-11T07:30:27-07:00","url":"https://jekyllrb.com/docs/front-matter/","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/front-matter.md"><i class="fa fa-pencil"></i> Improve this page</a>
|
290
|
+
</div>
|
291
|
+
<h1>Front Matter</h1>
|
292
|
+
<p>Any file that contains a <a href="https://yaml.org/">YAML</a> front matter block will be
|
293
|
+
processed by Jekyll as a special file. The front matter must be the first thing
|
294
|
+
in the file and must take the form of valid YAML set between triple-dashed
|
295
|
+
lines. Here is a basic example:</p>
|
296
|
+
|
297
|
+
<div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nn">---</span>
|
298
|
+
<span class="na">layout</span><span class="pi">:</span> <span class="s">post</span>
|
299
|
+
<span class="na">title</span><span class="pi">:</span> <span class="s">Blogging Like a Hacker</span>
|
300
|
+
<span class="nn">---</span>
|
301
|
+
</code></pre></div></div>
|
302
|
+
|
303
|
+
<p>Between these triple-dashed lines, you can set predefined variables (see below
|
304
|
+
for a reference) or even create custom ones of your own. These variables will
|
305
|
+
then be available to you to access using Liquid tags both further down in the
|
306
|
+
file and also in any layouts or includes that the page or post in question
|
307
|
+
relies on.</p>
|
308
|
+
|
309
|
+
<div class="note warning">
|
310
|
+
<h5>UTF-8 Character Encoding Warning</h5>
|
311
|
+
<p>
|
312
|
+
If you use UTF-8 encoding, make sure that no <code>BOM</code> header
|
313
|
+
characters exist in your files or very, very bad things will happen to
|
314
|
+
Jekyll. This is especially relevant if you’re running
|
315
|
+
<a href="/docs/installation/windows/">Jekyll on Windows</a>.
|
316
|
+
</p>
|
317
|
+
</div>
|
318
|
+
|
319
|
+
<div class="note">
|
320
|
+
<h5>Front Matter Variables Are Optional</h5>
|
321
|
+
<p>
|
322
|
+
If you want to use <a href="/docs/variables/">Liquid tags and variables</a>
|
323
|
+
but don’t need anything in your front matter, just leave it empty! The set
|
324
|
+
of triple-dashed lines with nothing in between will still get Jekyll to
|
325
|
+
process your file. (This is useful for things like CSS and RSS feeds!)
|
326
|
+
</p>
|
327
|
+
</div>
|
328
|
+
|
329
|
+
<h2 id="predefined-global-variables">Predefined Global Variables</h2>
|
330
|
+
|
331
|
+
<p>There are a number of predefined global variables that you can set in the
|
332
|
+
front matter of a page or post.</p>
|
333
|
+
|
334
|
+
<div class="mobile-side-scroller">
|
335
|
+
<table>
|
336
|
+
<thead>
|
337
|
+
<tr>
|
338
|
+
<th>Variable</th>
|
339
|
+
<th>Description</th>
|
340
|
+
</tr>
|
341
|
+
</thead>
|
342
|
+
<tbody>
|
343
|
+
<tr>
|
344
|
+
<td>
|
345
|
+
<p><code>layout</code></p>
|
346
|
+
</td>
|
347
|
+
<td>
|
348
|
+
<p>
|
349
|
+
|
350
|
+
If set, this specifies the layout file to use. Use the layout file
|
351
|
+
name without the file extension. Layout files must be placed in the
|
352
|
+
<code>_layouts</code> directory.
|
353
|
+
|
354
|
+
</p>
|
355
|
+
<ul>
|
356
|
+
<li>
|
357
|
+
Using <code>null</code> will produce a file without using a layout
|
358
|
+
file. This is overridden if the file is a post/document and has a
|
359
|
+
layout defined in the <a href="/docs/configuration/front-matter-defaults/">
|
360
|
+
front matter defaults</a>.
|
361
|
+
</li>
|
362
|
+
<li>
|
363
|
+
Starting from version 3.5.0, using <code>none</code> in a post/document will
|
364
|
+
produce a file without using a layout file regardless of front matter defaults.
|
365
|
+
Using <code>none</code> in a page will cause Jekyll to attempt to
|
366
|
+
use a layout named "none".
|
367
|
+
</li>
|
368
|
+
</ul>
|
369
|
+
</td>
|
370
|
+
</tr>
|
371
|
+
<tr>
|
372
|
+
<td>
|
373
|
+
<p><code>permalink</code></p>
|
374
|
+
</td>
|
375
|
+
<td>
|
376
|
+
<p>
|
377
|
+
|
378
|
+
If you need your processed blog post URLs to be something other than
|
379
|
+
the site-wide style (default <code>/year/month/day/title.html</code>), then you can set
|
380
|
+
this variable and it will be used as the final URL.
|
381
|
+
|
382
|
+
</p>
|
383
|
+
</td>
|
384
|
+
</tr>
|
385
|
+
<tr>
|
386
|
+
<td>
|
387
|
+
<p><code>published</code></p>
|
388
|
+
</td>
|
389
|
+
<td>
|
390
|
+
<p>
|
391
|
+
Set to false if you don’t want a specific post to show up when the
|
392
|
+
site is generated.
|
393
|
+
</p>
|
394
|
+
</td>
|
395
|
+
</tr>
|
396
|
+
</tbody>
|
397
|
+
</table>
|
398
|
+
</div>
|
399
|
+
|
400
|
+
<div class="note">
|
401
|
+
<h5>Render Posts Marked As Unpublished</h5>
|
402
|
+
<p>
|
403
|
+
To preview unpublished pages, run `jekyll serve` or `jekyll build`
|
404
|
+
with the `--unpublished` switch. Jekyll also has a handy <a href="/docs/posts/#drafts">drafts</a>
|
405
|
+
feature tailored specifically for blog posts.
|
406
|
+
</p>
|
407
|
+
</div>
|
408
|
+
|
409
|
+
<h2 id="custom-variables">Custom Variables</h2>
|
410
|
+
|
411
|
+
<p>You can also set your own front matter variables you can access in Liquid. For
|
412
|
+
instance, if you set a variable called <code class="highlighter-rouge">food</code>, you can use that in your page:</p>
|
413
|
+
|
414
|
+
<div class="language-liquid highlighter-rouge"><div class="highlight"><pre class="highlight"><code>---
|
415
|
+
food: Pizza
|
416
|
+
---
|
417
|
+
|
418
|
+
<h1><span class="p">{{</span><span class="w"> </span><span class="nv">page</span><span class="p">.</span><span class="nv">food</span><span class="w"> </span><span class="p">}}</span></h1>
|
419
|
+
</code></pre></div></div>
|
420
|
+
|
421
|
+
<h2 id="predefined-variables-for-posts">Predefined Variables for Posts</h2>
|
422
|
+
|
423
|
+
<p>These are available out-of-the-box to be used in the front matter for a post.</p>
|
424
|
+
|
425
|
+
<div class="mobile-side-scroller">
|
426
|
+
<table>
|
427
|
+
<thead>
|
428
|
+
<tr>
|
429
|
+
<th>Variable</th>
|
430
|
+
<th>Description</th>
|
431
|
+
</tr>
|
432
|
+
</thead>
|
433
|
+
<tbody>
|
434
|
+
<tr>
|
435
|
+
<td>
|
436
|
+
<p><code>date</code></p>
|
437
|
+
</td>
|
438
|
+
<td>
|
439
|
+
<p>
|
440
|
+
A date here overrides the date from the name of the post. This can be
|
441
|
+
used to ensure correct sorting of posts. A date is specified in the
|
442
|
+
format <code>YYYY-MM-DD HH:MM:SS +/-TTTT</code>; hours, minutes, seconds, and timezone offset
|
443
|
+
are optional.
|
444
|
+
</p>
|
445
|
+
</td>
|
446
|
+
</tr>
|
447
|
+
<tr>
|
448
|
+
<td>
|
449
|
+
<p><code>category</code></p>
|
450
|
+
<p><code>categories</code></p>
|
451
|
+
</td>
|
452
|
+
<td>
|
453
|
+
<p>
|
454
|
+
|
455
|
+
Instead of placing posts inside of folders, you can specify one or
|
456
|
+
more categories that the post belongs to. When the site is generated
|
457
|
+
the post will act as though it had been set with these categories
|
458
|
+
normally. Categories (plural key) can be specified as a <a href="https://en.wikipedia.org/wiki/YAML#Basic_components">YAML list</a> or a
|
459
|
+
space-separated string.
|
460
|
+
|
461
|
+
</p>
|
462
|
+
</td>
|
463
|
+
</tr>
|
464
|
+
<tr>
|
465
|
+
<td>
|
466
|
+
<p><code>tags</code></p>
|
467
|
+
</td>
|
468
|
+
<td>
|
469
|
+
<p>
|
470
|
+
|
471
|
+
Similar to categories, one or multiple tags can be added to a post.
|
472
|
+
Also like categories, tags can be specified as a <a href="https://en.wikipedia.org/wiki/YAML#Basic_components">YAML list</a> or a
|
473
|
+
space-separated string.
|
474
|
+
|
475
|
+
</p>
|
476
|
+
</td>
|
477
|
+
</tr>
|
478
|
+
</tbody>
|
479
|
+
</table>
|
480
|
+
</div>
|
481
|
+
|
482
|
+
<div class="note">
|
483
|
+
<h5>Don't repeat yourself</h5>
|
484
|
+
<p>
|
485
|
+
If you don't want to repeat your frequently used front matter variables
|
486
|
+
over and over, define <a href="/docs/configuration/front-matter-defaults/" title="Front Matter defaults">defaults</a>
|
487
|
+
for them and only override them where necessary (or not at all). This works
|
488
|
+
both for predefined and custom variables.
|
489
|
+
</p>
|
490
|
+
</div>
|
491
|
+
|
492
|
+
</article>
|
493
|
+
</div>
|
494
|
+
|
495
|
+
<div class="unit one-fifth hide-on-mobiles">
|
496
|
+
<aside>
|
497
|
+
|
498
|
+
<h4>Getting Started</h4>
|
499
|
+
<ul>
|
500
|
+
|
501
|
+
|
502
|
+
<li>
|
503
|
+
<a href="/docs/">
|
504
|
+
Quickstart
|
505
|
+
</a>
|
506
|
+
</li>
|
507
|
+
|
508
|
+
|
509
|
+
<li>
|
510
|
+
<a href="/docs/ruby-101/">
|
511
|
+
Ruby 101
|
512
|
+
</a>
|
513
|
+
</li>
|
514
|
+
|
515
|
+
|
516
|
+
<li>
|
517
|
+
<a href="/docs/installation/">
|
518
|
+
Installation
|
519
|
+
</a>
|
520
|
+
</li>
|
521
|
+
|
522
|
+
|
523
|
+
<li>
|
524
|
+
<a href="/docs/community/">
|
525
|
+
Community
|
526
|
+
</a>
|
527
|
+
</li>
|
528
|
+
|
529
|
+
|
530
|
+
<li>
|
531
|
+
<a href="/docs/step-by-step/01-setup/">
|
532
|
+
Step by Step Tutorial
|
533
|
+
</a>
|
534
|
+
</li>
|
535
|
+
|
536
|
+
</ul>
|
537
|
+
|
538
|
+
<h4>Build</h4>
|
539
|
+
<ul>
|
540
|
+
|
541
|
+
|
542
|
+
<li>
|
543
|
+
<a href="/docs/usage/">
|
544
|
+
Command Line Usage
|
545
|
+
</a>
|
546
|
+
</li>
|
547
|
+
|
548
|
+
|
549
|
+
<li>
|
550
|
+
<a href="/docs/configuration/">
|
551
|
+
Configuration
|
552
|
+
</a>
|
553
|
+
</li>
|
554
|
+
|
555
|
+
</ul>
|
556
|
+
|
557
|
+
<h4>Content</h4>
|
558
|
+
<ul>
|
559
|
+
|
560
|
+
|
561
|
+
<li>
|
562
|
+
<a href="/docs/pages/">
|
563
|
+
Pages
|
564
|
+
</a>
|
565
|
+
</li>
|
566
|
+
|
567
|
+
|
568
|
+
<li>
|
569
|
+
<a href="/docs/posts/">
|
570
|
+
Posts
|
571
|
+
</a>
|
572
|
+
</li>
|
573
|
+
|
574
|
+
|
575
|
+
<li class="current">
|
576
|
+
<a href="/docs/front-matter/">
|
577
|
+
Front Matter
|
578
|
+
</a>
|
579
|
+
</li>
|
580
|
+
|
581
|
+
|
582
|
+
<li>
|
583
|
+
<a href="/docs/collections/">
|
584
|
+
Collections
|
585
|
+
</a>
|
586
|
+
</li>
|
587
|
+
|
588
|
+
|
589
|
+
<li>
|
590
|
+
<a href="/docs/datafiles/">
|
591
|
+
Data Files
|
592
|
+
</a>
|
593
|
+
</li>
|
594
|
+
|
595
|
+
|
596
|
+
<li>
|
597
|
+
<a href="/docs/assets/">
|
598
|
+
Assets
|
599
|
+
</a>
|
600
|
+
</li>
|
601
|
+
|
602
|
+
|
603
|
+
<li>
|
604
|
+
<a href="/docs/static-files/">
|
605
|
+
Static Files
|
606
|
+
</a>
|
607
|
+
</li>
|
608
|
+
|
609
|
+
</ul>
|
610
|
+
|
611
|
+
<h4>Site Structure</h4>
|
612
|
+
<ul>
|
613
|
+
|
614
|
+
|
615
|
+
<li>
|
616
|
+
<a href="/docs/structure/">
|
617
|
+
Directory Structure
|
618
|
+
</a>
|
619
|
+
</li>
|
620
|
+
|
621
|
+
|
622
|
+
<li>
|
623
|
+
<a href="/docs/liquid/">
|
624
|
+
Liquid
|
625
|
+
</a>
|
626
|
+
</li>
|
627
|
+
|
628
|
+
|
629
|
+
<li>
|
630
|
+
<a href="/docs/variables/">
|
631
|
+
Variables
|
632
|
+
</a>
|
633
|
+
</li>
|
634
|
+
|
635
|
+
|
636
|
+
<li>
|
637
|
+
<a href="/docs/includes/">
|
638
|
+
Includes
|
639
|
+
</a>
|
640
|
+
</li>
|
641
|
+
|
642
|
+
|
643
|
+
<li>
|
644
|
+
<a href="/docs/layouts/">
|
645
|
+
Layouts
|
646
|
+
</a>
|
647
|
+
</li>
|
648
|
+
|
649
|
+
|
650
|
+
<li>
|
651
|
+
<a href="/docs/permalinks/">
|
652
|
+
Permalinks
|
653
|
+
</a>
|
654
|
+
</li>
|
655
|
+
|
656
|
+
|
657
|
+
<li>
|
658
|
+
<a href="/docs/themes/">
|
659
|
+
Themes
|
660
|
+
</a>
|
661
|
+
</li>
|
662
|
+
|
663
|
+
|
664
|
+
<li>
|
665
|
+
<a href="/docs/pagination/">
|
666
|
+
Pagination
|
667
|
+
</a>
|
668
|
+
</li>
|
669
|
+
|
670
|
+
</ul>
|
671
|
+
|
672
|
+
<h4>Guides</h4>
|
673
|
+
<ul>
|
674
|
+
|
675
|
+
|
676
|
+
<li>
|
677
|
+
<a href="/docs/plugins/">
|
678
|
+
Plugins
|
679
|
+
</a>
|
680
|
+
</li>
|
681
|
+
|
682
|
+
|
683
|
+
<li>
|
684
|
+
<a href="/docs/migrations/">
|
685
|
+
Blog Migrations
|
686
|
+
</a>
|
687
|
+
</li>
|
688
|
+
|
689
|
+
|
690
|
+
<li>
|
691
|
+
<a href="/docs/upgrading/">
|
692
|
+
Upgrading
|
693
|
+
</a>
|
694
|
+
</li>
|
695
|
+
|
696
|
+
|
697
|
+
<li>
|
698
|
+
<a href="/docs/deployment/">
|
699
|
+
Deployment
|
700
|
+
</a>
|
701
|
+
</li>
|
702
|
+
|
703
|
+
</ul>
|
704
|
+
|
705
|
+
</aside>
|
706
|
+
</div>
|
707
|
+
|
708
|
+
|
709
|
+
<div class="clear"></div>
|
710
|
+
|
711
|
+
</div>
|
712
|
+
</section>
|
713
|
+
|
714
|
+
|
715
|
+
<footer>
|
716
|
+
<div class="grid">
|
717
|
+
<div class="unit one-third center-on-mobiles">
|
718
|
+
<p>Jekyll is lovingly maintained by the <a href="/team/">core team</a> of volunteers. </p>
|
719
|
+
<p>The contents of this website are <br />© 2019 under the terms of the <a href="https://github.com/jekyll/jekyll/blob/master/LICENSE">MIT License</a>.</p>
|
720
|
+
</div>
|
721
|
+
<div class="unit two-thirds align-right center-on-mobiles">
|
722
|
+
<p>
|
723
|
+
Proudly hosted by
|
724
|
+
<a href="https://github.com">
|
725
|
+
<img src="/img/footer-logo.png" width="100" height="30" alt="GitHub • Social coding">
|
726
|
+
</a>
|
727
|
+
</p>
|
728
|
+
</div>
|
729
|
+
<div class="unit two-thirds align-right center-on-mobiles">
|
730
|
+
<p>
|
731
|
+
Jekyll is funded thanks to its
|
732
|
+
<a href="https://github.com/jekyll/jekyll#sponsors">
|
733
|
+
sponsors!
|
734
|
+
</a>
|
735
|
+
</p>
|
736
|
+
</div>
|
737
|
+
</div>
|
738
|
+
</footer>
|
739
|
+
|
740
|
+
<script>
|
741
|
+
var anchorForId = function (id) {
|
742
|
+
var anchor = document.createElement("a");
|
743
|
+
anchor.className = "header-link";
|
744
|
+
anchor.href = "#" + id;
|
745
|
+
anchor.innerHTML = "<span class=\"sr-only\">Permalink</span><i class=\"fa fa-link\"></i>";
|
746
|
+
anchor.title = "Permalink";
|
747
|
+
return anchor;
|
748
|
+
};
|
749
|
+
|
750
|
+
var linkifyAnchors = function (level, containingElement) {
|
751
|
+
var headers = containingElement.getElementsByTagName("h" + level);
|
752
|
+
for (var h = 0; h < headers.length; h++) {
|
753
|
+
var header = headers[h];
|
754
|
+
|
755
|
+
if (typeof header.id !== "undefined" && header.id !== "") {
|
756
|
+
header.appendChild(anchorForId(header.id));
|
757
|
+
}
|
758
|
+
}
|
759
|
+
};
|
760
|
+
|
761
|
+
document.onreadystatechange = function () {
|
762
|
+
if (this.readyState === "complete") {
|
763
|
+
var contentBlock = document.getElementsByClassName("docs")[0] || document.getElementsByClassName("news")[0];
|
764
|
+
if (!contentBlock) {
|
765
|
+
return;
|
766
|
+
}
|
767
|
+
for (var level = 1; level <= 6; level++) {
|
768
|
+
linkifyAnchors(level, contentBlock);
|
769
|
+
}
|
770
|
+
}
|
771
|
+
};
|
772
|
+
</script>
|
773
|
+
|
774
|
+
|
775
|
+
<!-- Google Analytics (https://www.google.com/analytics) -->
|
776
|
+
<script>
|
777
|
+
!function(j,e,k,y,l,L){j.GoogleAnalyticsObject=y,j[y]||(j[y]=function(){
|
778
|
+
(j[y].q=j[y].q||[]).push(arguments)}),j[y].l=+new Date,l=e.createElement(k),
|
779
|
+
L=e.getElementsByTagName(k)[0],l.src='https://www.google-analytics.com/analytics.js',
|
780
|
+
L.parentNode.insertBefore(l,L)}(window,document,'script','ga');
|
781
|
+
|
782
|
+
ga('create', 'UA-50755011-1', 'jekyllrb.com');
|
783
|
+
ga('send', 'pageview');
|
784
|
+
|
785
|
+
</script>
|
786
|
+
|
787
|
+
|
788
|
+
<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.js"></script>
|
789
|
+
<script type="text/javascript"> docsearch({
|
790
|
+
apiKey: '50fe39c839958dfad797000f33e2ec17',
|
791
|
+
indexName: 'jekyllrb',
|
792
|
+
inputSelector: '#docsearch-input',
|
793
|
+
enhancedSearchInput: true,
|
794
|
+
debug: false // Set debug to true if you want to inspect the dropdown
|
795
|
+
});
|
796
|
+
</script>
|
797
|
+
|
798
|
+
</body>
|
799
|
+
</html>
|