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
@@ -3,32 +3,35 @@
|
|
3
3
|
<head>
|
4
4
|
<meta charset="UTF-8">
|
5
5
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
6
|
-
<meta name="generator" content="Jekyll
|
6
|
+
<meta name="generator" content="Jekyll v4.0.0">
|
7
7
|
<link type="application/atom+xml" rel="alternate" href="https://jekyllrb.com/feed.xml" title="Jekyll • Simple, blog-aware, static sites" />
|
8
|
+
<link type="application/atom+xml" rel="alternate" href="/feed/release.xml" title="Jekyll releases posts" />
|
8
9
|
<link rel="alternate" type="application/atom+xml" title="Recent commits to Jekyll’s master branch" href="https://github.com/jekyll/jekyll/commits/master.atom">
|
9
|
-
<link rel="
|
10
|
-
<link rel="
|
11
|
-
<link rel="
|
10
|
+
<link rel="preload" href="/fonts/lato-v14-latin-300.woff2" as="font" type="font/woff2" crossorigin />
|
11
|
+
<link rel="preload" href="/fonts/lato-v14-latin-700.woff2" as="font" type="font/woff2" crossorigin />
|
12
|
+
<link rel="preload" href="/css/screen.css" as="style">
|
12
13
|
<link rel="stylesheet" href="/css/screen.css">
|
13
14
|
<link rel="icon" type="image/x-icon" href="/favicon.ico">
|
14
15
|
<!-- Begin Jekyll SEO tag v2.6.1 -->
|
15
16
|
<title>Variables | Jekyll • Simple, blog-aware, static sites</title>
|
16
|
-
<meta name="generator" content="Jekyll
|
17
|
+
<meta name="generator" content="Jekyll v4.0.0" />
|
17
18
|
<meta property="og:title" content="Variables" />
|
18
19
|
<meta property="og:locale" content="en_US" />
|
19
|
-
<meta name="description" content="Jekyll traverses your site looking for files to process. Any files with
|
20
|
-
<meta property="og:description" content="Jekyll traverses your site looking for files to process. Any files with
|
20
|
+
<meta name="description" content="Jekyll traverses your site looking for files to process. Any files with front matter are subject to processing. For each of these files, Jekyll makes a variety of data available via the Liquid. The following is a reference of the available data." />
|
21
|
+
<meta property="og:description" content="Jekyll traverses your site looking for files to process. Any files with front matter are subject to processing. For each of these files, Jekyll makes a variety of data available via the Liquid. The following is a reference of the available data." />
|
21
22
|
<link rel="canonical" href="https://jekyllrb.com/docs/variables/" />
|
22
23
|
<meta property="og:url" content="https://jekyllrb.com/docs/variables/" />
|
23
24
|
<meta property="og:site_name" content="Jekyll • Simple, blog-aware, static sites" />
|
25
|
+
<meta property="og:image" content="https://jekyllrb.com/img/jekyll-og.png" />
|
24
26
|
<meta property="og:type" content="article" />
|
25
|
-
<meta property="article:published_time" content="
|
26
|
-
<meta name="twitter:card" content="
|
27
|
+
<meta property="article:published_time" content="2019-09-11T07:30:27-07:00" />
|
28
|
+
<meta name="twitter:card" content="summary_large_image" />
|
29
|
+
<meta property="twitter:image" content="https://jekyllrb.com/img/jekyll-og.png" />
|
27
30
|
<meta property="twitter:title" content="Variables" />
|
28
31
|
<meta name="twitter:site" content="@jekyllrb" />
|
29
32
|
<meta name="google-site-verification" content="onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY" />
|
30
33
|
<script type="application/ld+json">
|
31
|
-
{"
|
34
|
+
{"description":"Jekyll traverses your site looking for files to process. Any files with front matter are subject to processing. For each of these files, Jekyll makes a variety of data available via the Liquid. The following is a reference of the available data.","@type":"BlogPosting","mainEntityOfPage":{"@type":"WebPage","@id":"https://jekyllrb.com/docs/variables/"},"headline":"Variables","dateModified":"2019-09-11T07:30:27-07:00","url":"https://jekyllrb.com/docs/variables/","datePublished":"2019-09-11T07:30:27-07:00","image":"https://jekyllrb.com/img/jekyll-og.png","publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://jekyllrb.com/img/logo-2x.png"}},"@context":"https://schema.org"}</script>
|
32
35
|
<!-- End Jekyll SEO tag -->
|
33
36
|
|
34
37
|
<!--[if lt IE 9]>
|
@@ -51,18 +54,27 @@
|
|
51
54
|
</div>
|
52
55
|
<nav class="main-nav hide-on-mobiles">
|
53
56
|
<ul>
|
54
|
-
|
57
|
+
|
58
|
+
<li>
|
55
59
|
<a href="/">Home</a>
|
56
60
|
</li>
|
61
|
+
|
57
62
|
<li class="current">
|
58
|
-
<a href="/docs/
|
63
|
+
<a href="/docs/">Docs</a>
|
59
64
|
</li>
|
60
|
-
|
61
|
-
|
65
|
+
|
66
|
+
<li>
|
67
|
+
<a href="/resources/">Resources</a>
|
68
|
+
</li>
|
69
|
+
|
70
|
+
<li>
|
71
|
+
<a href="/showcase/">Showcase</a>
|
62
72
|
</li>
|
63
|
-
|
64
|
-
|
73
|
+
|
74
|
+
<li>
|
75
|
+
<a href="/news/">News</a>
|
65
76
|
</li>
|
77
|
+
|
66
78
|
</ul>
|
67
79
|
|
68
80
|
</nav>
|
@@ -73,7 +85,7 @@
|
|
73
85
|
<div class="meta hide-on-mobiles">
|
74
86
|
<ul>
|
75
87
|
<li>
|
76
|
-
<a href="https://github.com/jekyll/jekyll/releases/tag/
|
88
|
+
<a href="https://github.com/jekyll/jekyll/releases/tag/v4.0.0">v4.0.0</a>
|
77
89
|
</li>
|
78
90
|
<li>
|
79
91
|
<a href="https://github.com/jekyll/jekyll">GitHub</a>
|
@@ -83,18 +95,24 @@
|
|
83
95
|
</div>
|
84
96
|
<nav class="mobile-nav show-on-mobiles">
|
85
97
|
<ul>
|
86
|
-
|
87
|
-
<
|
88
|
-
|
89
|
-
|
90
|
-
|
91
|
-
|
92
|
-
|
93
|
-
|
94
|
-
|
95
|
-
|
96
|
-
|
97
|
-
|
98
|
+
|
99
|
+
<li>
|
100
|
+
<a href="/">Home</a>
|
101
|
+
</li>
|
102
|
+
|
103
|
+
<li class="current">
|
104
|
+
<a href="/docs/">Docs</a>
|
105
|
+
</li>
|
106
|
+
|
107
|
+
<li>
|
108
|
+
<a href="/resources/">Resources</a>
|
109
|
+
</li>
|
110
|
+
|
111
|
+
|
112
|
+
<li>
|
113
|
+
<a href="/news/">News</a>
|
114
|
+
</li>
|
115
|
+
|
98
116
|
<li>
|
99
117
|
<a href="https://github.com/jekyll/jekyll">GitHub</a>
|
100
118
|
</li>
|
@@ -113,176 +131,152 @@
|
|
113
131
|
|
114
132
|
<optgroup label="Getting Started">
|
115
133
|
|
116
|
-
|
117
|
-
|
118
|
-
|
119
|
-
|
120
|
-
|
121
|
-
|
122
|
-
|
123
|
-
|
124
|
-
|
125
|
-
|
126
|
-
|
127
|
-
|
128
|
-
|
129
|
-
|
130
|
-
|
131
|
-
|
132
|
-
|
133
|
-
|
134
|
-
|
135
|
-
|
136
|
-
|
137
|
-
|
138
|
-
|
139
|
-
|
140
|
-
|
141
|
-
|
142
|
-
<option value="/docs/configuration/">Configuration</option>
|
143
|
-
|
144
|
-
|
145
|
-
</optgroup>
|
146
|
-
|
147
|
-
<optgroup label="Your Content">
|
134
|
+
|
135
|
+
<option value="/docs/">
|
136
|
+
Quickstart
|
137
|
+
</option>
|
138
|
+
|
139
|
+
|
140
|
+
<option value="/docs/ruby-101/">
|
141
|
+
Ruby 101
|
142
|
+
</option>
|
143
|
+
|
144
|
+
|
145
|
+
<option value="/docs/installation/">
|
146
|
+
Installation
|
147
|
+
</option>
|
148
|
+
|
149
|
+
|
150
|
+
<option value="/docs/community/">
|
151
|
+
Community
|
152
|
+
</option>
|
153
|
+
|
154
|
+
|
155
|
+
<option value="/docs/step-by-step/01-setup/">
|
156
|
+
Step by Step Tutorial
|
157
|
+
</option>
|
148
158
|
|
149
|
-
|
150
|
-
|
151
|
-
<option value="/docs/frontmatter/">Front Matter</option>
|
152
|
-
|
153
|
-
|
154
|
-
|
155
|
-
<option value="/docs/posts/">Writing posts</option>
|
156
|
-
|
157
|
-
|
158
|
-
|
159
|
-
<option value="/docs/drafts/">Working with drafts</option>
|
160
|
-
|
161
|
-
|
162
|
-
|
163
|
-
<option value="/docs/pages/">Creating pages</option>
|
164
|
-
|
165
|
-
|
166
|
-
|
167
|
-
<option value="/docs/static-files/">Static Files</option>
|
168
|
-
|
169
|
-
|
170
|
-
|
171
|
-
<option value="/docs/variables/">Variables</option>
|
172
|
-
|
173
|
-
|
174
|
-
|
175
|
-
<option value="/docs/collections/">Collections</option>
|
176
|
-
|
177
|
-
|
178
|
-
|
179
|
-
<option value="/docs/datafiles/">Data Files</option>
|
180
|
-
|
181
|
-
|
182
|
-
|
183
|
-
<option value="/docs/assets/">Assets</option>
|
184
|
-
|
185
|
-
|
186
|
-
|
187
|
-
<option value="/docs/migrations/">Blog migrations</option>
|
188
|
-
|
189
|
-
|
190
159
|
</optgroup>
|
191
160
|
|
192
|
-
<optgroup label="
|
161
|
+
<optgroup label="Build">
|
162
|
+
|
163
|
+
|
164
|
+
<option value="/docs/usage/">
|
165
|
+
Command Line Usage
|
166
|
+
</option>
|
167
|
+
|
168
|
+
|
169
|
+
<option value="/docs/configuration/">
|
170
|
+
Configuration
|
171
|
+
</option>
|
193
172
|
|
194
|
-
|
195
|
-
|
196
|
-
<option value="/docs/templates/">Templates</option>
|
197
|
-
|
198
|
-
|
199
|
-
|
200
|
-
<option value="/docs/includes/">Includes</option>
|
201
|
-
|
202
|
-
|
203
|
-
|
204
|
-
<option value="/docs/permalinks/">Permalinks</option>
|
205
|
-
|
206
|
-
|
207
|
-
|
208
|
-
<option value="/docs/pagination/">Pagination</option>
|
209
|
-
|
210
|
-
|
211
|
-
|
212
|
-
<option value="/docs/plugins/">Plugins</option>
|
213
|
-
|
214
|
-
|
215
|
-
|
216
|
-
<option value="/docs/themes/">Themes</option>
|
217
|
-
|
218
|
-
|
219
|
-
|
220
|
-
<option value="/docs/extras/">Extras</option>
|
221
|
-
|
222
|
-
|
223
173
|
</optgroup>
|
224
174
|
|
225
|
-
<optgroup label="
|
175
|
+
<optgroup label="Content">
|
176
|
+
|
177
|
+
|
178
|
+
<option value="/docs/pages/">
|
179
|
+
Pages
|
180
|
+
</option>
|
181
|
+
|
182
|
+
|
183
|
+
<option value="/docs/posts/">
|
184
|
+
Posts
|
185
|
+
</option>
|
186
|
+
|
187
|
+
|
188
|
+
<option value="/docs/front-matter/">
|
189
|
+
Front Matter
|
190
|
+
</option>
|
191
|
+
|
192
|
+
|
193
|
+
<option value="/docs/collections/">
|
194
|
+
Collections
|
195
|
+
</option>
|
196
|
+
|
197
|
+
|
198
|
+
<option value="/docs/datafiles/">
|
199
|
+
Data Files
|
200
|
+
</option>
|
201
|
+
|
202
|
+
|
203
|
+
<option value="/docs/assets/">
|
204
|
+
Assets
|
205
|
+
</option>
|
206
|
+
|
207
|
+
|
208
|
+
<option value="/docs/static-files/">
|
209
|
+
Static Files
|
210
|
+
</option>
|
226
211
|
|
227
|
-
|
228
|
-
|
229
|
-
<option value="/docs/github-pages/">GitHub Pages</option>
|
230
|
-
|
231
|
-
|
232
|
-
|
233
|
-
<option value="/docs/deployment-methods/">Deployment methods</option>
|
234
|
-
|
235
|
-
|
236
|
-
|
237
|
-
<option value="/docs/continuous-integration/">Continuous Integration</option>
|
238
|
-
|
239
|
-
|
240
212
|
</optgroup>
|
241
213
|
|
242
|
-
<optgroup label="
|
214
|
+
<optgroup label="Site Structure">
|
215
|
+
|
216
|
+
|
217
|
+
<option value="/docs/structure/">
|
218
|
+
Directory Structure
|
219
|
+
</option>
|
220
|
+
|
221
|
+
|
222
|
+
<option value="/docs/liquid/">
|
223
|
+
Liquid
|
224
|
+
</option>
|
225
|
+
|
226
|
+
|
227
|
+
<option value="/docs/variables/">
|
228
|
+
Variables
|
229
|
+
</option>
|
230
|
+
|
231
|
+
|
232
|
+
<option value="/docs/includes/">
|
233
|
+
Includes
|
234
|
+
</option>
|
235
|
+
|
236
|
+
|
237
|
+
<option value="/docs/layouts/">
|
238
|
+
Layouts
|
239
|
+
</option>
|
240
|
+
|
241
|
+
|
242
|
+
<option value="/docs/permalinks/">
|
243
|
+
Permalinks
|
244
|
+
</option>
|
245
|
+
|
246
|
+
|
247
|
+
<option value="/docs/themes/">
|
248
|
+
Themes
|
249
|
+
</option>
|
250
|
+
|
251
|
+
|
252
|
+
<option value="/docs/pagination/">
|
253
|
+
Pagination
|
254
|
+
</option>
|
243
255
|
|
244
|
-
|
245
|
-
|
246
|
-
<option value="/docs/troubleshooting/">Troubleshooting</option>
|
247
|
-
|
248
|
-
|
249
|
-
|
250
|
-
<option value="/docs/sites/">Sites using Jekyll</option>
|
251
|
-
|
252
|
-
|
253
|
-
|
254
|
-
<option value="/docs/resources/">Resources</option>
|
255
|
-
|
256
|
-
|
257
|
-
|
258
|
-
<option value="/docs/upgrading/0-to-2/">Upgrading from 0.x to 2.x</option>
|
259
|
-
|
260
|
-
|
261
|
-
|
262
|
-
<option value="/docs/upgrading/2-to-3/">Upgrading from 2.x to 3.x</option>
|
263
|
-
|
264
|
-
|
265
256
|
</optgroup>
|
266
257
|
|
267
|
-
<optgroup label="
|
258
|
+
<optgroup label="Guides">
|
259
|
+
|
260
|
+
|
261
|
+
<option value="/docs/plugins/">
|
262
|
+
Plugins
|
263
|
+
</option>
|
264
|
+
|
265
|
+
|
266
|
+
<option value="/docs/migrations/">
|
267
|
+
Blog Migrations
|
268
|
+
</option>
|
269
|
+
|
270
|
+
|
271
|
+
<option value="/docs/upgrading/">
|
272
|
+
Upgrading
|
273
|
+
</option>
|
274
|
+
|
275
|
+
|
276
|
+
<option value="/docs/deployment/">
|
277
|
+
Deployment
|
278
|
+
</option>
|
268
279
|
|
269
|
-
|
270
|
-
|
271
|
-
<option value="/docs/contributing/">Contributing</option>
|
272
|
-
|
273
|
-
|
274
|
-
|
275
|
-
<option value="/docs/maintaining/">Maintaining Jekyll</option>
|
276
|
-
|
277
|
-
|
278
|
-
|
279
|
-
<option value="/docs/conduct/">Code of Conduct</option>
|
280
|
-
|
281
|
-
|
282
|
-
|
283
|
-
<option value="/docs/history/">History</option>
|
284
|
-
|
285
|
-
|
286
280
|
</optgroup>
|
287
281
|
|
288
282
|
</select>
|
@@ -292,14 +286,13 @@
|
|
292
286
|
<div class="unit four-fifths">
|
293
287
|
<article>
|
294
288
|
<div class="improve right hide-on-mobiles">
|
295
|
-
<a href="https://github.com/jekyll/jekyll/edit/master/docs/_docs/variables.md"><i class="fa fa-pencil"></i> Improve this page</a>
|
289
|
+
<a data-proofer-ignore href="https://github.com/jekyll/jekyll/edit/master/docs/_docs/variables.md"><i class="fa fa-pencil"></i> Improve this page</a>
|
296
290
|
</div>
|
297
291
|
<h1>Variables</h1>
|
298
|
-
<p>Jekyll traverses your site looking for files to process. Any files with
|
299
|
-
front matter</a> are subject to processing. For each of these
|
300
|
-
files, Jekyll makes a variety of data available via the <a href="
|
301
|
-
|
302
|
-
following is a reference of the available data.</p>
|
292
|
+
<p>Jekyll traverses your site looking for files to process. Any files with
|
293
|
+
<a href="/docs/front-matter/">front matter</a> are subject to processing. For each of these
|
294
|
+
files, Jekyll makes a variety of data available via the <a href="/docs/liquid/">Liquid</a>.
|
295
|
+
The following is a reference of the available data.</p>
|
303
296
|
|
304
297
|
<h2 id="global-variables">Global Variables</h2>
|
305
298
|
|
@@ -312,53 +305,32 @@ following is a reference of the available data.</p>
|
|
312
305
|
</tr>
|
313
306
|
</thead>
|
314
307
|
<tbody>
|
308
|
+
|
315
309
|
<tr>
|
316
310
|
<td><p><code>site</code></p></td>
|
317
|
-
<td><p>
|
318
|
-
|
319
|
-
Sitewide information + configuration settings from
|
320
|
-
<code>_config.yml</code>. See below for details.
|
321
|
-
|
322
|
-
</p></td>
|
311
|
+
<td><p>Site wide information + configuration settings from <code>_config.yml</code>. See below for details.</p></td>
|
323
312
|
</tr>
|
313
|
+
|
324
314
|
<tr>
|
325
315
|
<td><p><code>page</code></p></td>
|
326
|
-
<td><p>
|
327
|
-
|
328
|
-
Page specific information + the <a href="../frontmatter/">YAML front
|
329
|
-
matter</a>. Custom variables set via the YAML Front Matter will be
|
330
|
-
available here. See below for details.
|
331
|
-
|
332
|
-
</p></td>
|
316
|
+
<td><p>Page specific information + the <a href="/docs/front-matter/">front matter</a>. Custom variables set via the front matter will be available here. See below for details.</p></td>
|
333
317
|
</tr>
|
318
|
+
|
334
319
|
<tr>
|
335
320
|
<td><p><code>layout</code></p></td>
|
336
|
-
<td><p>
|
337
|
-
|
338
|
-
Layout specific information + the <a href="../frontmatter/">YAML front
|
339
|
-
matter</a>. Custom variables set via the YAML Front Matter in
|
340
|
-
layouts will be available here.
|
341
|
-
|
342
|
-
</p></td>
|
321
|
+
<td><p>Layout specific information + the <a href="/docs/front-matter/">front matter</a>. Custom variables set via front matter in layouts will be available here.</p></td>
|
343
322
|
</tr>
|
323
|
+
|
344
324
|
<tr>
|
345
325
|
<td><p><code>content</code></p></td>
|
346
|
-
<td><p>
|
347
|
-
|
348
|
-
In layout files, the rendered content of the Post or Page being wrapped.
|
349
|
-
Not defined in Post or Page files.
|
350
|
-
|
351
|
-
</p></td>
|
326
|
+
<td><p>In layout files, the rendered content of the Post or Page being wrapped. Not defined in Post or Page files.</p></td>
|
352
327
|
</tr>
|
328
|
+
|
353
329
|
<tr>
|
354
330
|
<td><p><code>paginator</code></p></td>
|
355
|
-
<td><p>
|
356
|
-
|
357
|
-
When the <code>paginate</code> configuration option is set, this
|
358
|
-
variable becomes available for use. See <a href="../pagination/">Pagination</a> for details.
|
359
|
-
|
360
|
-
</p></td>
|
331
|
+
<td><p>When the <code>paginate</code> configuration option is set, this variable becomes available for use. See <a href="../pagination/">Pagination</a> for details.</p></td>
|
361
332
|
</tr>
|
333
|
+
|
362
334
|
</tbody>
|
363
335
|
</table>
|
364
336
|
</div>
|
@@ -374,137 +346,77 @@ following is a reference of the available data.</p>
|
|
374
346
|
</tr>
|
375
347
|
</thead>
|
376
348
|
<tbody>
|
349
|
+
|
377
350
|
<tr>
|
378
351
|
<td><p><code>site.time</code></p></td>
|
379
|
-
<td><p>
|
380
|
-
|
381
|
-
The current time (when you run the <code>jekyll</code> command).
|
382
|
-
|
383
|
-
</p></td>
|
352
|
+
<td><p>The current time (when you run the <code>jekyll</code> command).</p></td>
|
384
353
|
</tr>
|
354
|
+
|
385
355
|
<tr>
|
386
356
|
<td><p><code>site.pages</code></p></td>
|
387
|
-
<td><p>
|
388
|
-
|
389
|
-
A list of all Pages.
|
390
|
-
|
391
|
-
</p></td>
|
357
|
+
<td><p>A list of all Pages.</p></td>
|
392
358
|
</tr>
|
359
|
+
|
393
360
|
<tr>
|
394
361
|
<td><p><code>site.posts</code></p></td>
|
395
|
-
<td><p>
|
396
|
-
|
397
|
-
A reverse chronological list of all Posts.
|
398
|
-
|
399
|
-
</p></td>
|
362
|
+
<td><p>A reverse chronological list of all Posts.</p></td>
|
400
363
|
</tr>
|
364
|
+
|
401
365
|
<tr>
|
402
366
|
<td><p><code>site.related_posts</code></p></td>
|
403
|
-
<td><p>
|
404
|
-
|
405
|
-
If the page being processed is a Post, this contains a list of up to ten
|
406
|
-
related Posts. By default, these are the ten most recent posts.
|
407
|
-
For high quality but slow to compute results, run the
|
408
|
-
<code>jekyll</code> command with the <code>--lsi</code> (<a href="https://en.wikipedia.org/wiki/Latent_semantic_analysis#Latent_semantic_indexing">latent semantic indexing</a>) option. Also note GitHub Pages does not support the <code>lsi</code> option when generating sites.
|
409
|
-
|
410
|
-
</p></td>
|
367
|
+
<td><p>If the page being processed is a Post, this contains a list of up to ten related Posts. By default, these are the ten most recent posts. For high quality but slow to compute results, run the <code>jekyll</code> command with the <code>--lsi</code> (<a href="https://en.wikipedia.org/wiki/Latent_semantic_analysis#Latent_semantic_indexing">latent semantic indexing</a>) option. Also note GitHub Pages does not support the <code>lsi</code> option when generating sites.</p></td>
|
411
368
|
</tr>
|
369
|
+
|
412
370
|
<tr>
|
413
371
|
<td><p><code>site.static_files</code></p></td>
|
414
|
-
<td><p>
|
415
|
-
|
416
|
-
A list of all <a href="/docs/static-files/">static files</a> (i.e.
|
417
|
-
files not processed by Jekyll's converters or the Liquid renderer).
|
418
|
-
Each file has three properties: <code>path</code>,
|
419
|
-
<code>modified_time</code> and <code>extname</code>.
|
420
|
-
|
421
|
-
</p></td>
|
372
|
+
<td><p>A list of all <a href="/docs/static-files/">static files</a> (i.e. files not processed by Jekyll's converters or the Liquid renderer). Each file has five properties: <code>path</code>, <code>modified_time</code>, <code>name</code>, <code>basename</code> and <code>extname</code>.</p></td>
|
422
373
|
</tr>
|
374
|
+
|
423
375
|
<tr>
|
424
376
|
<td><p><code>site.html_pages</code></p></td>
|
425
|
-
<td><p>
|
426
|
-
|
427
|
-
A subset of `site.pages` listing those which end in `.html`.
|
428
|
-
|
429
|
-
</p></td>
|
377
|
+
<td><p>A subset of `site.pages` listing those which end in `.html`.</p></td>
|
430
378
|
</tr>
|
379
|
+
|
431
380
|
<tr>
|
432
381
|
<td><p><code>site.html_files</code></p></td>
|
433
|
-
<td><p>
|
434
|
-
|
435
|
-
A subset of `site.static_files` listing those which end in `.html`.
|
436
|
-
|
437
|
-
</p></td>
|
382
|
+
<td><p>A subset of `site.static_files` listing those which end in `.html`.</p></td>
|
438
383
|
</tr>
|
384
|
+
|
439
385
|
<tr>
|
440
386
|
<td><p><code>site.collections</code></p></td>
|
441
|
-
<td><p>
|
442
|
-
|
443
|
-
A list of all the collections.
|
444
|
-
|
445
|
-
</p></td>
|
387
|
+
<td><p>A list of all the collections (including posts).</p></td>
|
446
388
|
</tr>
|
389
|
+
|
447
390
|
<tr>
|
448
391
|
<td><p><code>site.data</code></p></td>
|
449
|
-
<td><p>
|
450
|
-
|
451
|
-
A list containing the data loaded from the YAML files located in the <code>_data</code> directory.
|
452
|
-
|
453
|
-
</p></td>
|
392
|
+
<td><p>A list containing the data loaded from the YAML files located in the <code>_data</code> directory.</p></td>
|
454
393
|
</tr>
|
394
|
+
|
455
395
|
<tr>
|
456
396
|
<td><p><code>site.documents</code></p></td>
|
457
|
-
<td><p>
|
458
|
-
|
459
|
-
A list of all the documents in every collection.
|
460
|
-
|
461
|
-
</p></td>
|
397
|
+
<td><p>A list of all the documents in every collection.</p></td>
|
462
398
|
</tr>
|
399
|
+
|
463
400
|
<tr>
|
464
401
|
<td><p><code>site.categories.CATEGORY</code></p></td>
|
465
|
-
<td><p>
|
466
|
-
|
467
|
-
The list of all Posts in category <code>CATEGORY</code>.
|
468
|
-
|
469
|
-
</p></td>
|
402
|
+
<td><p>The list of all Posts in category <code>CATEGORY</code>.</p></td>
|
470
403
|
</tr>
|
404
|
+
|
471
405
|
<tr>
|
472
406
|
<td><p><code>site.tags.TAG</code></p></td>
|
473
|
-
<td><p>
|
474
|
-
|
475
|
-
The list of all Posts with tag <code>TAG</code>.
|
476
|
-
|
477
|
-
</p></td>
|
407
|
+
<td><p>The list of all Posts with tag <code>TAG</code>.</p></td>
|
478
408
|
</tr>
|
409
|
+
|
479
410
|
<tr>
|
480
411
|
<td><p><code>site.url</code></p></td>
|
481
|
-
<td><p>
|
482
|
-
|
483
|
-
Contains the url of your site as it is configured in the <code>_config.yml</code>.
|
484
|
-
For example, if you have <code>url: http://mysite.com</code>
|
485
|
-
in your configuration file, then it will be accessible in Liquid as
|
486
|
-
<code>site.url</code>. For the development environment there is
|
487
|
-
<a href="/news/#3-siteurl-is-set-by-the-development-server">an exception</a>,
|
488
|
-
if you are running <code>jekyll serve</code> in a development environment
|
489
|
-
<code>site.url</code> will be set to the value of <code>host</code>,
|
490
|
-
<code>port</code>, and SSL-related options. This defaults to
|
491
|
-
<code>url: http://localhost:4000</code>.
|
492
|
-
|
493
|
-
</p></td>
|
412
|
+
<td><p>Contains the url of your site as it is configured in the <code>_config.yml</code>. For example, if you have <code>url: http://mysite.com</code> in your configuration file, then it will be accessible in Liquid as <code>site.url</code>. For the development environment there is <a href="/news/#3-siteurl-is-set-by-the-development-server">an exception</a>, if you are running <code>jekyll serve</code> in a development environment <code>site.url</code> will be set to the value of <code>host</code>, <code>port</code>, and SSL-related options. This defaults to <code>url: http://localhost:4000</code>.</p></td>
|
494
413
|
</tr>
|
414
|
+
|
495
415
|
<tr>
|
496
416
|
<td><p><code>site.[CONFIGURATION_DATA]</code></p></td>
|
497
|
-
<td><p>
|
498
|
-
|
499
|
-
All the variables set via the command line and your
|
500
|
-
<code>_config.yml</code> are available through the <code>site</code>
|
501
|
-
variable. For example, if you have <code>foo: bar</code>
|
502
|
-
in your configuration file, then it will be accessible in Liquid as <code>site.foo</code>.
|
503
|
-
Jekyll does not parse changes to <code>_config.yml</code> in
|
504
|
-
<code>watch</code> mode, you must restart Jekyll to see changes to variables.
|
505
|
-
|
506
|
-
</p></td>
|
417
|
+
<td><p>All the variables set via the command line and your <code>_config.yml</code> are available through the <code>site</code> variable. For example, if you have <code>foo: bar</code> in your configuration file, then it will be accessible in Liquid as <code>site.foo</code>. Jekyll does not parse changes to <code>_config.yml</code> in <code>watch</code> mode, you must restart Jekyll to see changes to variables.</p></td>
|
507
418
|
</tr>
|
419
|
+
|
508
420
|
</tbody>
|
509
421
|
</table>
|
510
422
|
</div>
|
@@ -520,113 +432,77 @@ following is a reference of the available data.</p>
|
|
520
432
|
</tr>
|
521
433
|
</thead>
|
522
434
|
<tbody>
|
435
|
+
|
523
436
|
<tr>
|
524
437
|
<td><p><code>page.content</code></p></td>
|
525
|
-
<td><p>
|
526
|
-
|
527
|
-
The content of the Page, rendered or un-rendered depending upon
|
528
|
-
what Liquid is being processed and what <code>page</code> is.
|
529
|
-
|
530
|
-
</p></td>
|
438
|
+
<td><p>The content of the Page, rendered or un-rendered depending upon what Liquid is being processed and what <code>page</code> is.</p></td>
|
531
439
|
</tr>
|
440
|
+
|
532
441
|
<tr>
|
533
442
|
<td><p><code>page.title</code></p></td>
|
534
|
-
<td><p>
|
535
|
-
|
536
|
-
The title of the Page.
|
537
|
-
|
538
|
-
</p></td>
|
443
|
+
<td><p>The title of the Page.</p></td>
|
539
444
|
</tr>
|
445
|
+
|
540
446
|
<tr>
|
541
447
|
<td><p><code>page.excerpt</code></p></td>
|
542
|
-
<td><p>
|
543
|
-
|
544
|
-
The un-rendered excerpt of a document.
|
545
|
-
|
546
|
-
</p></td>
|
448
|
+
<td><p>The un-rendered excerpt of a document.</p></td>
|
547
449
|
</tr>
|
450
|
+
|
548
451
|
<tr>
|
549
452
|
<td><p><code>page.url</code></p></td>
|
550
|
-
<td><p>
|
551
|
-
|
552
|
-
The URL of the Post without the domain, but
|
553
|
-
with a leading slash, e.g.
|
554
|
-
<code>/2008/12/14/my-post.html</code>
|
555
|
-
|
556
|
-
</p></td>
|
453
|
+
<td><p>The URL of the Post without the domain, but with a leading slash, e.g. <code>/2008/12/14/my-post.html</code></p></td>
|
557
454
|
</tr>
|
455
|
+
|
558
456
|
<tr>
|
559
457
|
<td><p><code>page.date</code></p></td>
|
560
|
-
<td><p>
|
561
|
-
|
562
|
-
The Date assigned to the Post. This can be overridden in a Post’s front
|
563
|
-
matter by specifying a new date/time in the format
|
564
|
-
<code>YYYY-MM-DD HH:MM:SS</code> (assuming UTC), or
|
565
|
-
<code>YYYY-MM-DD HH:MM:SS +/-TTTT</code> (to specify a time zone using
|
566
|
-
an offset from UTC. e.g. <code>2008-12-14 10:30:00 +0900</code>).
|
567
|
-
|
568
|
-
</p></td>
|
458
|
+
<td><p>The Date assigned to the Post. This can be overridden in a Post’s front matter by specifying a new date/time in the format <code>YYYY-MM-DD HH:MM:SS</code> (assuming UTC), or <code>YYYY-MM-DD HH:MM:SS +/-TTTT</code> (to specify a time zone using an offset from UTC. e.g. <code>2008-12-14 10:30:00 +0900</code>).</p></td>
|
569
459
|
</tr>
|
460
|
+
|
570
461
|
<tr>
|
571
462
|
<td><p><code>page.id</code></p></td>
|
572
|
-
<td><p>
|
573
|
-
|
574
|
-
An identifier unique to a document in a Collection or a Post (useful in RSS feeds). e.g.
|
575
|
-
<code>/2008/12/14/my-post</code>
|
576
|
-
<code>/my-collection/my-document</code>
|
577
|
-
|
578
|
-
</p></td>
|
463
|
+
<td><p>An identifier unique to a document in a Collection or a Post (useful in RSS feeds). e.g. <code>/2008/12/14/my-post</code><code>/my-collection/my-document</code></p></td>
|
579
464
|
</tr>
|
465
|
+
|
580
466
|
<tr>
|
581
467
|
<td><p><code>page.categories</code></p></td>
|
582
|
-
<td><p>
|
583
|
-
|
584
|
-
The list of categories to which this post belongs. Categories are
|
585
|
-
derived from the directory structure above the <code>_posts</code>
|
586
|
-
directory. For example, a post at
|
587
|
-
<code>/work/code/_posts/2008-12-24-closures.md</code> would have this
|
588
|
-
field set to <code>['work', 'code']</code>. These can also be specified
|
589
|
-
in the <a href="../frontmatter/">YAML Front Matter</a>.
|
590
|
-
|
591
|
-
</p></td>
|
468
|
+
<td><p>The list of categories to which this post belongs. Categories are derived from the directory structure above the <code>_posts</code> directory. For example, a post at <code>/work/code/_posts/2008-12-24-closures.md</code> would have this field set to <code>['work', 'code']</code>. These can also be specified in the <a href="/docs/front-matter/">front matter</a>.</p></td>
|
592
469
|
</tr>
|
470
|
+
|
593
471
|
<tr>
|
594
|
-
<td><p><code>page.
|
595
|
-
<td><p>
|
596
|
-
|
597
|
-
The list of tags to which this post belongs. These can be specified in
|
598
|
-
the <a href="../frontmatter/">YAML Front Matter</a>.
|
599
|
-
|
600
|
-
</p></td>
|
472
|
+
<td><p><code>page.collection</code></p></td>
|
473
|
+
<td><p>The label of the collection to which this document belongs. e.g. <code>posts</code> for a post, or <code>puppies</code> for a document at path <code>_puppies/rover.md</code>. If not part of a collection, an empty string is returned.</p></td>
|
601
474
|
</tr>
|
475
|
+
|
602
476
|
<tr>
|
603
|
-
<td><p><code>page.
|
604
|
-
<td><p>
|
605
|
-
|
606
|
-
The path to the raw post or page. Example usage: Linking back to the
|
607
|
-
page or post’s source on GitHub. This can be overridden in the
|
608
|
-
<a href="../frontmatter/">YAML Front Matter</a>.
|
609
|
-
|
610
|
-
</p></td>
|
477
|
+
<td><p><code>page.tags</code></p></td>
|
478
|
+
<td><p>The list of tags to which this post belongs. These can be specified in the <a href="/docs/front-matter/">front matter</a>.</p></td>
|
611
479
|
</tr>
|
480
|
+
|
481
|
+
<tr>
|
482
|
+
<td><p><code>page.dir</code></p></td>
|
483
|
+
<td><p>The path between the source directory and the file of the post or page, e.g. <code>/pages/</code>. This can be overridden by <code>permalink</code> in the <a href="/docs/front-matter/">front matter</a>.</p></td>
|
484
|
+
</tr>
|
485
|
+
|
486
|
+
<tr>
|
487
|
+
<td><p><code>page.name</code></p></td>
|
488
|
+
<td><p>The filename of the post or page, e.g. <code>about.md</code></p></td>
|
489
|
+
</tr>
|
490
|
+
|
491
|
+
<tr>
|
492
|
+
<td><p><code>page.path</code></p></td>
|
493
|
+
<td><p>The path to the raw post or page. Example usage: Linking back to the page or post’s source on GitHub. This can be overridden in the <a href="/docs/front-matter/">front matter</a>.</p></td>
|
494
|
+
</tr>
|
495
|
+
|
612
496
|
<tr>
|
613
497
|
<td><p><code>page.next</code></p></td>
|
614
|
-
<td><p>
|
615
|
-
|
616
|
-
The next post relative to the position of the current post in
|
617
|
-
<code>site.posts</code>. Returns <code>nil</code> for the last entry.
|
618
|
-
|
619
|
-
</p></td>
|
498
|
+
<td><p>The next post relative to the position of the current post in <code>site.posts</code>. Returns <code>nil</code> for the last entry.</p></td>
|
620
499
|
</tr>
|
500
|
+
|
621
501
|
<tr>
|
622
502
|
<td><p><code>page.previous</code></p></td>
|
623
|
-
<td><p>
|
624
|
-
|
625
|
-
The previous post relative to the position of the current post in
|
626
|
-
<code>site.posts</code>. Returns <code>nil</code> for the first entry.
|
627
|
-
|
628
|
-
</p></td>
|
503
|
+
<td><p>The previous post relative to the position of the current post in <code>site.posts</code>. Returns <code>nil</code> for the first entry.</p></td>
|
629
504
|
</tr>
|
505
|
+
|
630
506
|
</tbody>
|
631
507
|
</table>
|
632
508
|
</div>
|
@@ -634,20 +510,14 @@ following is a reference of the available data.</p>
|
|
634
510
|
<div class="note">
|
635
511
|
<h5>ProTip™: Use Custom Front Matter</h5>
|
636
512
|
<p>
|
637
|
-
|
638
513
|
Any custom front matter that you specify will be available under
|
639
514
|
<code>page</code>. For example, if you specify <code>custom_css: true</code>
|
640
|
-
in a page’s front matter, that value will be available as
|
641
|
-
<code>page.custom_css</code>.
|
642
|
-
|
515
|
+
in a page’s front matter, that value will be available as <code>page.custom_css</code>.
|
643
516
|
</p>
|
644
517
|
<p>
|
645
|
-
|
646
518
|
If you specify front matter in a layout, access that via <code>layout</code>.
|
647
|
-
For example, if you specify <code>class: full_page</code>
|
648
|
-
|
649
|
-
<code>layout.class</code> in the layout and its parents.
|
650
|
-
|
519
|
+
For example, if you specify <code>class: full_page</code> in a layout’s front matter,
|
520
|
+
that value will be available as <code>layout.class</code> in the layout and its parents.
|
651
521
|
</p>
|
652
522
|
</div>
|
653
523
|
|
@@ -662,42 +532,52 @@ following is a reference of the available data.</p>
|
|
662
532
|
</tr>
|
663
533
|
</thead>
|
664
534
|
<tbody>
|
535
|
+
|
536
|
+
<tr>
|
537
|
+
<td><p><code>paginator.page</code></p></td>
|
538
|
+
<td><p>The number of the current page</p></td>
|
539
|
+
</tr>
|
540
|
+
|
665
541
|
<tr>
|
666
542
|
<td><p><code>paginator.per_page</code></p></td>
|
667
|
-
<td><p>Number of
|
543
|
+
<td><p>Number of posts per page</p></td>
|
668
544
|
</tr>
|
545
|
+
|
669
546
|
<tr>
|
670
547
|
<td><p><code>paginator.posts</code></p></td>
|
671
|
-
<td><p>Posts available for
|
548
|
+
<td><p>Posts available for the current page</p></td>
|
672
549
|
</tr>
|
550
|
+
|
673
551
|
<tr>
|
674
552
|
<td><p><code>paginator.total_posts</code></p></td>
|
675
|
-
<td><p>Total number of
|
553
|
+
<td><p>Total number of posts</p></td>
|
676
554
|
</tr>
|
555
|
+
|
677
556
|
<tr>
|
678
557
|
<td><p><code>paginator.total_pages</code></p></td>
|
679
|
-
<td><p>Total number of pages
|
680
|
-
</tr>
|
681
|
-
<tr>
|
682
|
-
<td><p><code>paginator.page</code></p></td>
|
683
|
-
<td><p>The number of the current page.</p></td>
|
558
|
+
<td><p>Total number of pages</p></td>
|
684
559
|
</tr>
|
560
|
+
|
685
561
|
<tr>
|
686
562
|
<td><p><code>paginator.previous_page</code></p></td>
|
687
|
-
<td><p>The number of the previous page
|
563
|
+
<td><p>The number of the previous page, or <code>nil</code> if no previous page exists</p></td>
|
688
564
|
</tr>
|
565
|
+
|
689
566
|
<tr>
|
690
567
|
<td><p><code>paginator.previous_page_path</code></p></td>
|
691
|
-
<td><p>The path to the previous page
|
568
|
+
<td><p>The path to the previous page, or <code>nil</code> if no previous page exists</p></td>
|
692
569
|
</tr>
|
570
|
+
|
693
571
|
<tr>
|
694
572
|
<td><p><code>paginator.next_page</code></p></td>
|
695
|
-
<td><p>The number of the next page
|
573
|
+
<td><p>The number of the next page, or <code>nil</code> if no subsequent page exists</p></td>
|
696
574
|
</tr>
|
575
|
+
|
697
576
|
<tr>
|
698
577
|
<td><p><code>paginator.next_page_path</code></p></td>
|
699
|
-
<td><p>The path to the next page
|
578
|
+
<td><p>The path to the next page, or <code>nil</code> if no subsequent page exists</p></td>
|
700
579
|
</tr>
|
580
|
+
|
701
581
|
</tbody>
|
702
582
|
</table>
|
703
583
|
</div>
|
@@ -705,260 +585,223 @@ following is a reference of the available data.</p>
|
|
705
585
|
<div class="note info">
|
706
586
|
<h5>Paginator variable availability</h5>
|
707
587
|
<p>
|
708
|
-
|
709
|
-
|
710
|
-
subdirectory, such as <code>/blog/index.html</code>.
|
711
|
-
|
588
|
+
These are only available in index files, however they can be located in a subdirectory,
|
589
|
+
such as <code>/blog/index.html</code>.
|
712
590
|
</p>
|
713
591
|
</div>
|
714
592
|
|
715
|
-
|
716
|
-
|
717
|
-
|
718
|
-
|
719
|
-
|
720
|
-
|
721
|
-
|
722
|
-
|
723
|
-
|
724
|
-
|
725
|
-
|
726
|
-
|
727
|
-
|
728
|
-
|
729
|
-
|
730
|
-
|
731
|
-
|
732
|
-
|
733
|
-
|
734
|
-
|
735
|
-
|
736
|
-
|
737
|
-
|
738
|
-
|
739
|
-
|
740
|
-
|
741
|
-
|
742
|
-
|
743
|
-
|
744
|
-
|
745
|
-
|
746
|
-
|
747
|
-
|
748
|
-
|
749
|
-
|
750
|
-
|
751
|
-
|
752
|
-
|
753
|
-
|
754
|
-
|
755
|
-
|
756
|
-
|
757
|
-
|
758
|
-
|
759
|
-
<div class="section-nav">
|
760
|
-
<div class="left align-right">
|
761
|
-
|
762
|
-
|
763
|
-
|
764
|
-
<a href="/docs/static-files/" class="prev">Back</a>
|
765
|
-
|
766
|
-
</div>
|
767
|
-
<div class="right align-left">
|
768
|
-
|
769
|
-
|
770
|
-
|
771
|
-
<a href="/docs/collections/" class="next">Next</a>
|
772
|
-
|
773
|
-
</div>
|
774
|
-
</div>
|
775
|
-
<div class="clear"></div>
|
776
|
-
|
777
593
|
</article>
|
778
594
|
</div>
|
779
595
|
|
780
596
|
<div class="unit one-fifth hide-on-mobiles">
|
781
597
|
<aside>
|
782
598
|
|
783
|
-
|
784
|
-
|
785
|
-
|
786
|
-
|
787
|
-
|
788
|
-
|
789
|
-
|
790
|
-
|
791
|
-
|
792
|
-
|
793
|
-
|
794
|
-
|
795
|
-
|
796
|
-
|
797
|
-
|
798
|
-
|
799
|
-
|
800
|
-
|
801
|
-
|
802
|
-
|
803
|
-
|
804
|
-
|
805
|
-
|
806
|
-
|
807
|
-
|
808
|
-
|
809
|
-
|
810
|
-
|
811
|
-
|
812
|
-
|
813
|
-
|
814
|
-
|
815
|
-
|
816
|
-
|
817
|
-
|
818
|
-
|
819
|
-
|
820
|
-
|
821
|
-
|
822
|
-
<li class=""><a href="/docs/frontmatter/">Front Matter</a></li>
|
823
|
-
|
824
|
-
|
825
|
-
|
826
|
-
<li class=""><a href="/docs/posts/">Writing posts</a></li>
|
827
|
-
|
828
|
-
|
829
|
-
|
830
|
-
<li class=""><a href="/docs/drafts/">Working with drafts</a></li>
|
831
|
-
|
832
|
-
|
833
|
-
|
834
|
-
<li class=""><a href="/docs/pages/">Creating pages</a></li>
|
835
|
-
|
836
|
-
|
837
|
-
|
838
|
-
<li class=""><a href="/docs/static-files/">Static Files</a></li>
|
839
|
-
|
840
|
-
|
841
|
-
|
842
|
-
<li class="current"><a href="/docs/variables/">Variables</a></li>
|
843
|
-
|
844
|
-
|
845
|
-
|
846
|
-
<li class=""><a href="/docs/collections/">Collections</a></li>
|
847
|
-
|
848
|
-
|
849
|
-
|
850
|
-
<li class=""><a href="/docs/datafiles/">Data Files</a></li>
|
851
|
-
|
852
|
-
|
853
|
-
|
854
|
-
<li class=""><a href="/docs/assets/">Assets</a></li>
|
855
|
-
|
856
|
-
|
857
|
-
|
858
|
-
<li class=""><a href="/docs/migrations/">Blog migrations</a></li>
|
859
|
-
|
860
|
-
</ul>
|
861
|
-
|
599
|
+
<h4>Getting Started</h4>
|
600
|
+
<ul>
|
601
|
+
|
602
|
+
|
603
|
+
<li>
|
604
|
+
<a href="/docs/">
|
605
|
+
Quickstart
|
606
|
+
</a>
|
607
|
+
</li>
|
608
|
+
|
609
|
+
|
610
|
+
<li>
|
611
|
+
<a href="/docs/ruby-101/">
|
612
|
+
Ruby 101
|
613
|
+
</a>
|
614
|
+
</li>
|
615
|
+
|
616
|
+
|
617
|
+
<li>
|
618
|
+
<a href="/docs/installation/">
|
619
|
+
Installation
|
620
|
+
</a>
|
621
|
+
</li>
|
622
|
+
|
623
|
+
|
624
|
+
<li>
|
625
|
+
<a href="/docs/community/">
|
626
|
+
Community
|
627
|
+
</a>
|
628
|
+
</li>
|
629
|
+
|
630
|
+
|
631
|
+
<li>
|
632
|
+
<a href="/docs/step-by-step/01-setup/">
|
633
|
+
Step by Step Tutorial
|
634
|
+
</a>
|
635
|
+
</li>
|
636
|
+
|
637
|
+
</ul>
|
862
638
|
|
863
|
-
|
864
|
-
|
865
|
-
|
866
|
-
|
867
|
-
|
868
|
-
|
869
|
-
|
870
|
-
|
871
|
-
|
872
|
-
|
873
|
-
|
874
|
-
|
875
|
-
|
876
|
-
|
877
|
-
|
878
|
-
|
879
|
-
|
880
|
-
|
881
|
-
|
882
|
-
|
883
|
-
|
884
|
-
<li class=""><a href="/docs/plugins/">Plugins</a></li>
|
885
|
-
|
886
|
-
|
887
|
-
|
888
|
-
<li class=""><a href="/docs/themes/">Themes</a></li>
|
889
|
-
|
890
|
-
|
891
|
-
|
892
|
-
<li class=""><a href="/docs/extras/">Extras</a></li>
|
893
|
-
|
894
|
-
</ul>
|
895
|
-
|
639
|
+
<h4>Build</h4>
|
640
|
+
<ul>
|
641
|
+
|
642
|
+
|
643
|
+
<li>
|
644
|
+
<a href="/docs/usage/">
|
645
|
+
Command Line Usage
|
646
|
+
</a>
|
647
|
+
</li>
|
648
|
+
|
649
|
+
|
650
|
+
<li>
|
651
|
+
<a href="/docs/configuration/">
|
652
|
+
Configuration
|
653
|
+
</a>
|
654
|
+
</li>
|
655
|
+
|
656
|
+
</ul>
|
896
657
|
|
897
|
-
|
898
|
-
|
899
|
-
|
900
|
-
|
901
|
-
|
902
|
-
|
903
|
-
|
904
|
-
|
905
|
-
|
906
|
-
|
907
|
-
|
908
|
-
|
909
|
-
|
910
|
-
|
911
|
-
|
912
|
-
</
|
913
|
-
|
658
|
+
<h4>Content</h4>
|
659
|
+
<ul>
|
660
|
+
|
661
|
+
|
662
|
+
<li>
|
663
|
+
<a href="/docs/pages/">
|
664
|
+
Pages
|
665
|
+
</a>
|
666
|
+
</li>
|
667
|
+
|
668
|
+
|
669
|
+
<li>
|
670
|
+
<a href="/docs/posts/">
|
671
|
+
Posts
|
672
|
+
</a>
|
673
|
+
</li>
|
674
|
+
|
675
|
+
|
676
|
+
<li>
|
677
|
+
<a href="/docs/front-matter/">
|
678
|
+
Front Matter
|
679
|
+
</a>
|
680
|
+
</li>
|
681
|
+
|
682
|
+
|
683
|
+
<li>
|
684
|
+
<a href="/docs/collections/">
|
685
|
+
Collections
|
686
|
+
</a>
|
687
|
+
</li>
|
688
|
+
|
689
|
+
|
690
|
+
<li>
|
691
|
+
<a href="/docs/datafiles/">
|
692
|
+
Data Files
|
693
|
+
</a>
|
694
|
+
</li>
|
695
|
+
|
696
|
+
|
697
|
+
<li>
|
698
|
+
<a href="/docs/assets/">
|
699
|
+
Assets
|
700
|
+
</a>
|
701
|
+
</li>
|
702
|
+
|
703
|
+
|
704
|
+
<li>
|
705
|
+
<a href="/docs/static-files/">
|
706
|
+
Static Files
|
707
|
+
</a>
|
708
|
+
</li>
|
709
|
+
|
710
|
+
</ul>
|
914
711
|
|
915
|
-
|
916
|
-
|
917
|
-
|
918
|
-
|
919
|
-
|
920
|
-
|
921
|
-
|
922
|
-
|
923
|
-
|
924
|
-
|
925
|
-
|
926
|
-
|
927
|
-
|
928
|
-
|
929
|
-
|
930
|
-
|
931
|
-
|
932
|
-
|
933
|
-
|
934
|
-
|
935
|
-
|
936
|
-
|
937
|
-
|
938
|
-
|
939
|
-
|
712
|
+
<h4>Site Structure</h4>
|
713
|
+
<ul>
|
714
|
+
|
715
|
+
|
716
|
+
<li>
|
717
|
+
<a href="/docs/structure/">
|
718
|
+
Directory Structure
|
719
|
+
</a>
|
720
|
+
</li>
|
721
|
+
|
722
|
+
|
723
|
+
<li>
|
724
|
+
<a href="/docs/liquid/">
|
725
|
+
Liquid
|
726
|
+
</a>
|
727
|
+
</li>
|
728
|
+
|
729
|
+
|
730
|
+
<li class="current">
|
731
|
+
<a href="/docs/variables/">
|
732
|
+
Variables
|
733
|
+
</a>
|
734
|
+
</li>
|
735
|
+
|
736
|
+
|
737
|
+
<li>
|
738
|
+
<a href="/docs/includes/">
|
739
|
+
Includes
|
740
|
+
</a>
|
741
|
+
</li>
|
742
|
+
|
743
|
+
|
744
|
+
<li>
|
745
|
+
<a href="/docs/layouts/">
|
746
|
+
Layouts
|
747
|
+
</a>
|
748
|
+
</li>
|
749
|
+
|
750
|
+
|
751
|
+
<li>
|
752
|
+
<a href="/docs/permalinks/">
|
753
|
+
Permalinks
|
754
|
+
</a>
|
755
|
+
</li>
|
756
|
+
|
757
|
+
|
758
|
+
<li>
|
759
|
+
<a href="/docs/themes/">
|
760
|
+
Themes
|
761
|
+
</a>
|
762
|
+
</li>
|
763
|
+
|
764
|
+
|
765
|
+
<li>
|
766
|
+
<a href="/docs/pagination/">
|
767
|
+
Pagination
|
768
|
+
</a>
|
769
|
+
</li>
|
770
|
+
|
771
|
+
</ul>
|
940
772
|
|
941
|
-
|
942
|
-
|
943
|
-
|
944
|
-
|
945
|
-
|
946
|
-
|
947
|
-
|
948
|
-
|
949
|
-
|
950
|
-
|
951
|
-
|
952
|
-
|
953
|
-
|
954
|
-
|
955
|
-
|
956
|
-
|
957
|
-
|
958
|
-
|
959
|
-
|
960
|
-
|
961
|
-
|
773
|
+
<h4>Guides</h4>
|
774
|
+
<ul>
|
775
|
+
|
776
|
+
|
777
|
+
<li>
|
778
|
+
<a href="/docs/plugins/">
|
779
|
+
Plugins
|
780
|
+
</a>
|
781
|
+
</li>
|
782
|
+
|
783
|
+
|
784
|
+
<li>
|
785
|
+
<a href="/docs/migrations/">
|
786
|
+
Blog Migrations
|
787
|
+
</a>
|
788
|
+
</li>
|
789
|
+
|
790
|
+
|
791
|
+
<li>
|
792
|
+
<a href="/docs/upgrading/">
|
793
|
+
Upgrading
|
794
|
+
</a>
|
795
|
+
</li>
|
796
|
+
|
797
|
+
|
798
|
+
<li>
|
799
|
+
<a href="/docs/deployment/">
|
800
|
+
Deployment
|
801
|
+
</a>
|
802
|
+
</li>
|
803
|
+
|
804
|
+
</ul>
|
962
805
|
|
963
806
|
</aside>
|
964
807
|
</div>
|
@@ -973,7 +816,8 @@ following is a reference of the available data.</p>
|
|
973
816
|
<footer>
|
974
817
|
<div class="grid">
|
975
818
|
<div class="unit one-third center-on-mobiles">
|
976
|
-
<p>
|
819
|
+
<p>Jekyll is lovingly maintained by the <a href="/team/">core team</a> of volunteers. </p>
|
820
|
+
<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>
|
977
821
|
</div>
|
978
822
|
<div class="unit two-thirds align-right center-on-mobiles">
|
979
823
|
<p>
|
@@ -983,6 +827,14 @@ following is a reference of the available data.</p>
|
|
983
827
|
</a>
|
984
828
|
</p>
|
985
829
|
</div>
|
830
|
+
<div class="unit two-thirds align-right center-on-mobiles">
|
831
|
+
<p>
|
832
|
+
Jekyll is funded thanks to its
|
833
|
+
<a href="https://github.com/jekyll/jekyll#sponsors">
|
834
|
+
sponsors!
|
835
|
+
</a>
|
836
|
+
</p>
|
837
|
+
</div>
|
986
838
|
</div>
|
987
839
|
</footer>
|
988
840
|
|