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,699 @@
|
|
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>Tags | Jekyll • Simple, blog-aware, static sites</title>
|
17
|
+
<meta name="generator" content="Jekyll v4.0.0" />
|
18
|
+
<meta property="og:title" content="Tags" />
|
19
|
+
<meta property="og:locale" content="en_US" />
|
20
|
+
<meta name="description" content="If you’d like to include custom liquid tags in your site, you can do so by hooking into the tagging system. Built-in examples added by Jekyll include the highlight and include tags. Below is an example of a custom liquid tag that will output the time the page was rendered:" />
|
21
|
+
<meta property="og:description" content="If you’d like to include custom liquid tags in your site, you can do so by hooking into the tagging system. Built-in examples added by Jekyll include the highlight and include tags. Below is an example of a custom liquid tag that will output the time the page was rendered:" />
|
22
|
+
<link rel="canonical" href="https://jekyllrb.com/docs/plugins/tags/" />
|
23
|
+
<meta property="og:url" content="https://jekyllrb.com/docs/plugins/tags/" />
|
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="Tags" />
|
31
|
+
<meta name="twitter:site" content="@jekyllrb" />
|
32
|
+
<meta name="google-site-verification" content="onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY" />
|
33
|
+
<script type="application/ld+json">
|
34
|
+
{"description":"If you’d like to include custom liquid tags in your site, you can do so by hooking into the tagging system. Built-in examples added by Jekyll include the highlight and include tags. Below is an example of a custom liquid tag that will output the time the page was rendered:","@type":"BlogPosting","mainEntityOfPage":{"@type":"WebPage","@id":"https://jekyllrb.com/docs/plugins/tags/"},"headline":"Tags","dateModified":"2019-09-11T07:30:27-07:00","url":"https://jekyllrb.com/docs/plugins/tags/","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/plugins/tags.md"><i class="fa fa-pencil"></i> Improve this page</a>
|
290
|
+
</div>
|
291
|
+
<h1>Tags</h1>
|
292
|
+
<p>If you’d like to include custom liquid tags in your site, you can do so by
|
293
|
+
hooking into the tagging system. Built-in examples added by Jekyll include the
|
294
|
+
<code class="highlighter-rouge">highlight</code> and <code class="highlighter-rouge">include</code> tags. Below is an example of a custom liquid tag that
|
295
|
+
will output the time the page was rendered:</p>
|
296
|
+
|
297
|
+
<div class="language-ruby highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="k">module</span> <span class="nn">Jekyll</span>
|
298
|
+
<span class="k">class</span> <span class="nc">RenderTimeTag</span> <span class="o"><</span> <span class="no">Liquid</span><span class="o">::</span><span class="no">Tag</span>
|
299
|
+
|
300
|
+
<span class="k">def</span> <span class="nf">initialize</span><span class="p">(</span><span class="n">tag_name</span><span class="p">,</span> <span class="n">text</span><span class="p">,</span> <span class="n">tokens</span><span class="p">)</span>
|
301
|
+
<span class="k">super</span>
|
302
|
+
<span class="vi">@text</span> <span class="o">=</span> <span class="n">text</span>
|
303
|
+
<span class="k">end</span>
|
304
|
+
|
305
|
+
<span class="k">def</span> <span class="nf">render</span><span class="p">(</span><span class="n">context</span><span class="p">)</span>
|
306
|
+
<span class="s2">"</span><span class="si">#{</span><span class="vi">@text</span><span class="si">}</span><span class="s2"> </span><span class="si">#{</span><span class="no">Time</span><span class="p">.</span><span class="nf">now</span><span class="si">}</span><span class="s2">"</span>
|
307
|
+
<span class="k">end</span>
|
308
|
+
<span class="k">end</span>
|
309
|
+
<span class="k">end</span>
|
310
|
+
|
311
|
+
<span class="no">Liquid</span><span class="o">::</span><span class="no">Template</span><span class="p">.</span><span class="nf">register_tag</span><span class="p">(</span><span class="s1">'render_time'</span><span class="p">,</span> <span class="no">Jekyll</span><span class="o">::</span><span class="no">RenderTimeTag</span><span class="p">)</span>
|
312
|
+
</code></pre></div></div>
|
313
|
+
|
314
|
+
<p>At a minimum, liquid tags must implement:</p>
|
315
|
+
|
316
|
+
<div class="mobile-side-scroller">
|
317
|
+
<table>
|
318
|
+
<thead>
|
319
|
+
<tr>
|
320
|
+
<th>Method</th>
|
321
|
+
<th>Description</th>
|
322
|
+
</tr>
|
323
|
+
</thead>
|
324
|
+
<tbody>
|
325
|
+
<tr>
|
326
|
+
<td>
|
327
|
+
<p><code>render</code></p>
|
328
|
+
</td>
|
329
|
+
<td>
|
330
|
+
<p>Outputs the content of the tag.</p>
|
331
|
+
</td>
|
332
|
+
</tr>
|
333
|
+
</tbody>
|
334
|
+
</table>
|
335
|
+
</div>
|
336
|
+
|
337
|
+
<p>You must also register the custom tag with the Liquid template engine as
|
338
|
+
follows:</p>
|
339
|
+
|
340
|
+
<div class="language-ruby highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="no">Liquid</span><span class="o">::</span><span class="no">Template</span><span class="p">.</span><span class="nf">register_tag</span><span class="p">(</span><span class="s1">'render_time'</span><span class="p">,</span> <span class="no">Jekyll</span><span class="o">::</span><span class="no">RenderTimeTag</span><span class="p">)</span>
|
341
|
+
</code></pre></div></div>
|
342
|
+
|
343
|
+
<p>In the example above, we can place the following tag anywhere in one of our
|
344
|
+
pages:</p>
|
345
|
+
|
346
|
+
<div class="language-ruby highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="o"><</span><span class="nb">p</span><span class="o">></span><span class="p">{</span><span class="sx">% render_time </span><span class="n">page</span> <span class="n">rendered</span> <span class="ss">at: </span><span class="sx">%}</p>
|
347
|
+
</span></code></pre></div></div>
|
348
|
+
|
349
|
+
<p>And we would get something like this on the page:</p>
|
350
|
+
|
351
|
+
<div class="language-html highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nt"><p></span>page rendered at: Tue June 22 23:38:47 –0500 2010<span class="nt"></p></span>
|
352
|
+
</code></pre></div></div>
|
353
|
+
|
354
|
+
<h2 id="tag-blocks">Tag Blocks</h2>
|
355
|
+
|
356
|
+
<p>The <code class="highlighter-rouge">render_time</code> tag seen above can also be rewritten as a tag block by
|
357
|
+
inheriting the <code class="highlighter-rouge">Liquid::Block</code> class. Look at the example below:</p>
|
358
|
+
|
359
|
+
<div class="language-ruby highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="k">module</span> <span class="nn">Jekyll</span>
|
360
|
+
<span class="k">class</span> <span class="nc">RenderTimeTagBlock</span> <span class="o"><</span> <span class="no">Liquid</span><span class="o">::</span><span class="no">Block</span>
|
361
|
+
|
362
|
+
<span class="k">def</span> <span class="nf">render</span><span class="p">(</span><span class="n">context</span><span class="p">)</span>
|
363
|
+
<span class="n">text</span> <span class="o">=</span> <span class="k">super</span>
|
364
|
+
<span class="s2">"<p></span><span class="si">#{</span><span class="n">text</span><span class="si">}</span><span class="s2"> </span><span class="si">#{</span><span class="no">Time</span><span class="p">.</span><span class="nf">now</span><span class="si">}</span><span class="s2"></p>"</span>
|
365
|
+
<span class="k">end</span>
|
366
|
+
|
367
|
+
<span class="k">end</span>
|
368
|
+
<span class="k">end</span>
|
369
|
+
|
370
|
+
<span class="no">Liquid</span><span class="o">::</span><span class="no">Template</span><span class="p">.</span><span class="nf">register_tag</span><span class="p">(</span><span class="s1">'render_time'</span><span class="p">,</span> <span class="no">Jekyll</span><span class="o">::</span><span class="no">RenderTimeTagBlock</span><span class="p">)</span>
|
371
|
+
</code></pre></div></div>
|
372
|
+
|
373
|
+
<p>We can now use the tag block anywhere:</p>
|
374
|
+
|
375
|
+
<div class="language-liquid highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="p">{%</span><span class="w"> </span><span class="nt">render_time</span><span class="w"> </span><span class="p">%}</span>
|
376
|
+
page rendered at:
|
377
|
+
<span class="p">{%</span><span class="w"> </span><span class="nt">endrender_time</span><span class="w"> </span><span class="p">%}</span>
|
378
|
+
</code></pre></div></div>
|
379
|
+
|
380
|
+
<p>And we would still get the same output as above on the page:</p>
|
381
|
+
|
382
|
+
<div class="language-html highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nt"><p></span>page rendered at: Tue June 22 23:38:47 –0500 2010<span class="nt"></p></span>
|
383
|
+
</code></pre></div></div>
|
384
|
+
|
385
|
+
<div class="note info">
|
386
|
+
<p>In the above example, the tag block and the tag are both registered with
|
387
|
+
the name <code>render_time</code> but to register a tag and a tag block using
|
388
|
+
the same name in the same project is not recommended as this may lead to
|
389
|
+
conflicts.</p>
|
390
|
+
</div>
|
391
|
+
|
392
|
+
</article>
|
393
|
+
</div>
|
394
|
+
|
395
|
+
<div class="unit one-fifth hide-on-mobiles">
|
396
|
+
<aside>
|
397
|
+
|
398
|
+
<h4>Getting Started</h4>
|
399
|
+
<ul>
|
400
|
+
|
401
|
+
|
402
|
+
<li>
|
403
|
+
<a href="/docs/">
|
404
|
+
Quickstart
|
405
|
+
</a>
|
406
|
+
</li>
|
407
|
+
|
408
|
+
|
409
|
+
<li>
|
410
|
+
<a href="/docs/ruby-101/">
|
411
|
+
Ruby 101
|
412
|
+
</a>
|
413
|
+
</li>
|
414
|
+
|
415
|
+
|
416
|
+
<li>
|
417
|
+
<a href="/docs/installation/">
|
418
|
+
Installation
|
419
|
+
</a>
|
420
|
+
</li>
|
421
|
+
|
422
|
+
|
423
|
+
<li>
|
424
|
+
<a href="/docs/community/">
|
425
|
+
Community
|
426
|
+
</a>
|
427
|
+
</li>
|
428
|
+
|
429
|
+
|
430
|
+
<li>
|
431
|
+
<a href="/docs/step-by-step/01-setup/">
|
432
|
+
Step by Step Tutorial
|
433
|
+
</a>
|
434
|
+
</li>
|
435
|
+
|
436
|
+
</ul>
|
437
|
+
|
438
|
+
<h4>Build</h4>
|
439
|
+
<ul>
|
440
|
+
|
441
|
+
|
442
|
+
<li>
|
443
|
+
<a href="/docs/usage/">
|
444
|
+
Command Line Usage
|
445
|
+
</a>
|
446
|
+
</li>
|
447
|
+
|
448
|
+
|
449
|
+
<li>
|
450
|
+
<a href="/docs/configuration/">
|
451
|
+
Configuration
|
452
|
+
</a>
|
453
|
+
</li>
|
454
|
+
|
455
|
+
</ul>
|
456
|
+
|
457
|
+
<h4>Content</h4>
|
458
|
+
<ul>
|
459
|
+
|
460
|
+
|
461
|
+
<li>
|
462
|
+
<a href="/docs/pages/">
|
463
|
+
Pages
|
464
|
+
</a>
|
465
|
+
</li>
|
466
|
+
|
467
|
+
|
468
|
+
<li>
|
469
|
+
<a href="/docs/posts/">
|
470
|
+
Posts
|
471
|
+
</a>
|
472
|
+
</li>
|
473
|
+
|
474
|
+
|
475
|
+
<li>
|
476
|
+
<a href="/docs/front-matter/">
|
477
|
+
Front Matter
|
478
|
+
</a>
|
479
|
+
</li>
|
480
|
+
|
481
|
+
|
482
|
+
<li>
|
483
|
+
<a href="/docs/collections/">
|
484
|
+
Collections
|
485
|
+
</a>
|
486
|
+
</li>
|
487
|
+
|
488
|
+
|
489
|
+
<li>
|
490
|
+
<a href="/docs/datafiles/">
|
491
|
+
Data Files
|
492
|
+
</a>
|
493
|
+
</li>
|
494
|
+
|
495
|
+
|
496
|
+
<li>
|
497
|
+
<a href="/docs/assets/">
|
498
|
+
Assets
|
499
|
+
</a>
|
500
|
+
</li>
|
501
|
+
|
502
|
+
|
503
|
+
<li>
|
504
|
+
<a href="/docs/static-files/">
|
505
|
+
Static Files
|
506
|
+
</a>
|
507
|
+
</li>
|
508
|
+
|
509
|
+
</ul>
|
510
|
+
|
511
|
+
<h4>Site Structure</h4>
|
512
|
+
<ul>
|
513
|
+
|
514
|
+
|
515
|
+
<li>
|
516
|
+
<a href="/docs/structure/">
|
517
|
+
Directory Structure
|
518
|
+
</a>
|
519
|
+
</li>
|
520
|
+
|
521
|
+
|
522
|
+
<li>
|
523
|
+
<a href="/docs/liquid/">
|
524
|
+
Liquid
|
525
|
+
</a>
|
526
|
+
</li>
|
527
|
+
|
528
|
+
|
529
|
+
<li>
|
530
|
+
<a href="/docs/variables/">
|
531
|
+
Variables
|
532
|
+
</a>
|
533
|
+
</li>
|
534
|
+
|
535
|
+
|
536
|
+
<li>
|
537
|
+
<a href="/docs/includes/">
|
538
|
+
Includes
|
539
|
+
</a>
|
540
|
+
</li>
|
541
|
+
|
542
|
+
|
543
|
+
<li>
|
544
|
+
<a href="/docs/layouts/">
|
545
|
+
Layouts
|
546
|
+
</a>
|
547
|
+
</li>
|
548
|
+
|
549
|
+
|
550
|
+
<li>
|
551
|
+
<a href="/docs/permalinks/">
|
552
|
+
Permalinks
|
553
|
+
</a>
|
554
|
+
</li>
|
555
|
+
|
556
|
+
|
557
|
+
<li>
|
558
|
+
<a href="/docs/themes/">
|
559
|
+
Themes
|
560
|
+
</a>
|
561
|
+
</li>
|
562
|
+
|
563
|
+
|
564
|
+
<li>
|
565
|
+
<a href="/docs/pagination/">
|
566
|
+
Pagination
|
567
|
+
</a>
|
568
|
+
</li>
|
569
|
+
|
570
|
+
</ul>
|
571
|
+
|
572
|
+
<h4>Guides</h4>
|
573
|
+
<ul>
|
574
|
+
|
575
|
+
|
576
|
+
<li>
|
577
|
+
<a href="/docs/plugins/">
|
578
|
+
Plugins
|
579
|
+
</a>
|
580
|
+
</li>
|
581
|
+
|
582
|
+
|
583
|
+
<li>
|
584
|
+
<a href="/docs/migrations/">
|
585
|
+
Blog Migrations
|
586
|
+
</a>
|
587
|
+
</li>
|
588
|
+
|
589
|
+
|
590
|
+
<li>
|
591
|
+
<a href="/docs/upgrading/">
|
592
|
+
Upgrading
|
593
|
+
</a>
|
594
|
+
</li>
|
595
|
+
|
596
|
+
|
597
|
+
<li>
|
598
|
+
<a href="/docs/deployment/">
|
599
|
+
Deployment
|
600
|
+
</a>
|
601
|
+
</li>
|
602
|
+
|
603
|
+
</ul>
|
604
|
+
|
605
|
+
</aside>
|
606
|
+
</div>
|
607
|
+
|
608
|
+
|
609
|
+
<div class="clear"></div>
|
610
|
+
|
611
|
+
</div>
|
612
|
+
</section>
|
613
|
+
|
614
|
+
|
615
|
+
<footer>
|
616
|
+
<div class="grid">
|
617
|
+
<div class="unit one-third center-on-mobiles">
|
618
|
+
<p>Jekyll is lovingly maintained by the <a href="/team/">core team</a> of volunteers. </p>
|
619
|
+
<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>
|
620
|
+
</div>
|
621
|
+
<div class="unit two-thirds align-right center-on-mobiles">
|
622
|
+
<p>
|
623
|
+
Proudly hosted by
|
624
|
+
<a href="https://github.com">
|
625
|
+
<img src="/img/footer-logo.png" width="100" height="30" alt="GitHub • Social coding">
|
626
|
+
</a>
|
627
|
+
</p>
|
628
|
+
</div>
|
629
|
+
<div class="unit two-thirds align-right center-on-mobiles">
|
630
|
+
<p>
|
631
|
+
Jekyll is funded thanks to its
|
632
|
+
<a href="https://github.com/jekyll/jekyll#sponsors">
|
633
|
+
sponsors!
|
634
|
+
</a>
|
635
|
+
</p>
|
636
|
+
</div>
|
637
|
+
</div>
|
638
|
+
</footer>
|
639
|
+
|
640
|
+
<script>
|
641
|
+
var anchorForId = function (id) {
|
642
|
+
var anchor = document.createElement("a");
|
643
|
+
anchor.className = "header-link";
|
644
|
+
anchor.href = "#" + id;
|
645
|
+
anchor.innerHTML = "<span class=\"sr-only\">Permalink</span><i class=\"fa fa-link\"></i>";
|
646
|
+
anchor.title = "Permalink";
|
647
|
+
return anchor;
|
648
|
+
};
|
649
|
+
|
650
|
+
var linkifyAnchors = function (level, containingElement) {
|
651
|
+
var headers = containingElement.getElementsByTagName("h" + level);
|
652
|
+
for (var h = 0; h < headers.length; h++) {
|
653
|
+
var header = headers[h];
|
654
|
+
|
655
|
+
if (typeof header.id !== "undefined" && header.id !== "") {
|
656
|
+
header.appendChild(anchorForId(header.id));
|
657
|
+
}
|
658
|
+
}
|
659
|
+
};
|
660
|
+
|
661
|
+
document.onreadystatechange = function () {
|
662
|
+
if (this.readyState === "complete") {
|
663
|
+
var contentBlock = document.getElementsByClassName("docs")[0] || document.getElementsByClassName("news")[0];
|
664
|
+
if (!contentBlock) {
|
665
|
+
return;
|
666
|
+
}
|
667
|
+
for (var level = 1; level <= 6; level++) {
|
668
|
+
linkifyAnchors(level, contentBlock);
|
669
|
+
}
|
670
|
+
}
|
671
|
+
};
|
672
|
+
</script>
|
673
|
+
|
674
|
+
|
675
|
+
<!-- Google Analytics (https://www.google.com/analytics) -->
|
676
|
+
<script>
|
677
|
+
!function(j,e,k,y,l,L){j.GoogleAnalyticsObject=y,j[y]||(j[y]=function(){
|
678
|
+
(j[y].q=j[y].q||[]).push(arguments)}),j[y].l=+new Date,l=e.createElement(k),
|
679
|
+
L=e.getElementsByTagName(k)[0],l.src='https://www.google-analytics.com/analytics.js',
|
680
|
+
L.parentNode.insertBefore(l,L)}(window,document,'script','ga');
|
681
|
+
|
682
|
+
ga('create', 'UA-50755011-1', 'jekyllrb.com');
|
683
|
+
ga('send', 'pageview');
|
684
|
+
|
685
|
+
</script>
|
686
|
+
|
687
|
+
|
688
|
+
<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.js"></script>
|
689
|
+
<script type="text/javascript"> docsearch({
|
690
|
+
apiKey: '50fe39c839958dfad797000f33e2ec17',
|
691
|
+
indexName: 'jekyllrb',
|
692
|
+
inputSelector: '#docsearch-input',
|
693
|
+
enhancedSearchInput: true,
|
694
|
+
debug: false // Set debug to true if you want to inspect the dropdown
|
695
|
+
});
|
696
|
+
</script>
|
697
|
+
|
698
|
+
</body>
|
699
|
+
</html>
|