jekyll-docs 3.8.5 → 3.9.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/site/404.html +5 -4
- data/site/docs/assets/index.html +22 -21
- data/site/docs/code_of_conduct/index.html +8 -7
- data/site/docs/collections/index.html +44 -43
- data/site/docs/conduct/index.html +8 -7
- data/site/docs/configuration/index.html +68 -67
- data/site/docs/continuous-integration/buddyworks/index.html +10 -9
- data/site/docs/continuous-integration/circleci/index.html +13 -12
- data/site/docs/continuous-integration/index.html +8 -7
- data/site/docs/continuous-integration/travis-ci/index.html +32 -31
- data/site/docs/contributing/index.html +34 -33
- data/site/docs/datafiles/index.html +24 -23
- data/site/docs/deployment-methods/index.html +30 -29
- data/site/docs/drafts/index.html +11 -10
- data/site/docs/extras/index.html +9 -8
- data/site/docs/frontmatter/index.html +8 -7
- data/site/docs/github-pages/index.html +19 -18
- data/site/docs/history/index.html +674 -645
- data/site/docs/home/index.html +8 -7
- data/site/docs/includes/index.html +44 -43
- data/site/docs/installation/index.html +16 -15
- data/site/docs/maintaining/affinity-team-captain/index.html +11 -10
- data/site/docs/maintaining/avoiding-burnout/index.html +8 -7
- data/site/docs/maintaining/becoming-a-maintainer/index.html +9 -8
- data/site/docs/maintaining/index.html +8 -7
- data/site/docs/maintaining/merging-a-pull-request/index.html +23 -22
- data/site/docs/maintaining/releasing-a-new-version/index.html +19 -18
- data/site/docs/maintaining/reviewing-a-pull-request/index.html +10 -9
- data/site/docs/maintaining/special-labels/index.html +14 -13
- data/site/docs/maintaining/triaging-an-issue/index.html +12 -11
- data/site/docs/migrations/index.html +9 -8
- data/site/docs/pages/index.html +12 -11
- data/site/docs/pagination/index.html +25 -24
- data/site/docs/permalinks/index.html +33 -32
- data/site/docs/plugins/index.html +57 -56
- data/site/docs/posts/index.html +37 -36
- data/site/docs/quickstart/index.html +18 -17
- data/site/docs/resources/index.html +9 -8
- data/site/docs/sites/index.html +8 -7
- data/site/docs/static-files/index.html +14 -13
- data/site/docs/structure/index.html +8 -7
- data/site/docs/support/index.html +9 -8
- data/site/docs/templates/index.html +44 -43
- data/site/docs/themes/index.html +63 -62
- data/site/docs/troubleshooting/index.html +48 -47
- data/site/docs/upgrading/0-to-2/index.html +51 -50
- data/site/docs/upgrading/2-to-3/index.html +35 -34
- data/site/docs/upgrading/index.html +11 -10
- data/site/docs/usage/index.html +15 -14
- data/site/docs/variables/index.html +8 -7
- data/site/docs/windows/index.html +29 -28
- data/site/feed.xml +45 -41
- data/site/help/index.html +7 -6
- data/site/index.html +7 -6
- data/site/jekyllconf/index.html +9 -8
- data/site/latest_version.txt +1 -1
- data/site/news/2013/05/05/jekyll-1-0-0-released/index.html +16 -10
- data/site/news/2013/05/08/jekyll-1-0-1-released/index.html +18 -12
- data/site/news/2013/05/12/jekyll-1-0-2-released/index.html +19 -13
- data/site/news/2013/06/07/jekyll-1-0-3-released/index.html +20 -14
- data/site/news/2013/07/14/jekyll-1-1-0-released/index.html +19 -13
- data/site/news/2013/07/24/jekyll-1-1-1-released/index.html +16 -10
- data/site/news/2013/07/25/jekyll-1-0-4-released/index.html +18 -12
- data/site/news/2013/07/25/jekyll-1-1-2-released/index.html +18 -12
- data/site/news/2013/09/06/jekyll-1-2-0-released/index.html +21 -15
- data/site/news/2013/09/14/jekyll-1-2-1-released/index.html +19 -13
- data/site/news/2013/10/28/jekyll-1-3-0-rc1-released/index.html +16 -10
- data/site/news/2013/11/04/jekyll-1-3-0-released/index.html +25 -19
- data/site/news/2013/11/26/jekyll-1-3-1-released/index.html +17 -11
- data/site/news/2013/12/07/jekyll-1-4-0-released/index.html +17 -11
- data/site/news/2013/12/09/jekyll-1-4-1-released/index.html +16 -10
- data/site/news/2013/12/16/jekyll-1-4-2-released/index.html +18 -12
- data/site/news/2014/01/13/jekyll-1-4-3-released/index.html +17 -11
- data/site/news/2014/03/24/jekyll-1-5-0-released/index.html +17 -11
- data/site/news/2014/03/27/jekyll-1-5-1-released/index.html +17 -11
- data/site/news/2014/05/06/jekyll-turns-2-0-0/index.html +20 -14
- data/site/news/2014/05/08/jekyll-2-0-3-released/index.html +16 -10
- data/site/news/2014/06/04/jekyll-stickers-1-dollar-stickermule/index.html +16 -10
- data/site/news/2014/06/28/jekyll-turns-21-i-mean-2-1-0/index.html +21 -15
- data/site/news/2014/07/01/jekyll-2-1-1-released/index.html +18 -12
- data/site/news/2014/07/29/jekyll-2-2-0-released/index.html +17 -11
- data/site/news/2014/08/10/jekyll-2-3-0-released/index.html +24 -18
- data/site/news/2014/09/09/jekyll-2-4-0-released/index.html +23 -17
- data/site/news/2014/11/05/jekylls-midlife-crisis-jekyll-turns-2-5-0/index.html +22 -16
- data/site/news/2014/11/09/jekyll-2-5-1-released/index.html +16 -10
- data/site/news/2014/11/12/jekyll-2-5-2-released/index.html +18 -12
- data/site/news/2014/12/17/alfredxing-welcome-to-jekyll-core/index.html +16 -10
- data/site/news/2014/12/22/jekyll-2-5-3-released/index.html +16 -10
- data/site/news/2015/01/20/jekyll-meet-and-greet/index.html +16 -10
- data/site/news/2015/01/24/jekyll-3-0-0-beta1-released/index.html +16 -10
- data/site/news/2015/02/26/introducing-jekyll-talk/index.html +16 -10
- data/site/news/2015/10/26/jekyll-3-0-released/index.html +21 -15
- data/site/news/2015/11/17/jekyll-3-0-1-released/index.html +20 -14
- data/site/news/2016/01/20/jekyll-3-0-2-released/index.html +18 -12
- data/site/news/2016/01/24/jekyll-3-1-0-released/index.html +21 -15
- data/site/news/2016/01/28/jekyll-3-1-1-released/index.html +21 -15
- data/site/news/2016/02/08/jekyll-3-0-3-released/index.html +17 -11
- data/site/news/2016/02/19/jekyll-3-1-2-released/index.html +18 -12
- data/site/news/2016/03/10/making-it-easier-to-contribute-to-jekyll/index.html +16 -10
- data/site/news/2016/04/19/jekyll-3-0-4-released/index.html +17 -11
- data/site/news/2016/04/19/jekyll-3-1-3-released/index.html +17 -11
- data/site/news/2016/04/26/jekyll-3-0-5-released/index.html +16 -10
- data/site/news/2016/05/18/jekyll-3-1-4-released/index.html +22 -16
- data/site/news/2016/05/18/jekyll-3-1-5-released/index.html +17 -11
- data/site/news/2016/05/19/jekyll-3-1-6-released/index.html +17 -11
- data/site/news/2016/06/03/update-on-jekyll-s-google-summer-of-code-projects/index.html +16 -10
- data/site/news/2016/07/26/jekyll-3-2-0-released/index.html +20 -14
- data/site/news/2016/08/02/jekyll-3-2-1-released/index.html +17 -11
- data/site/news/2016/08/24/jekyll-admin-initial-release/index.html +16 -10
- data/site/news/2016/10/06/jekyll-3-3-is-here/index.html +42 -36
- data/site/news/2016/11/14/jekyll-3-3-1-released/index.html +17 -11
- data/site/news/2017/01/18/jekyll-3-4-0-released/index.html +18 -12
- data/site/news/2017/03/02/jekyll-3-4-1-released/index.html +17 -11
- data/site/news/2017/03/09/jekyll-3-4-2-released/index.html +21 -15
- data/site/news/2017/03/21/jekyll-3-4-3-released/index.html +26 -20
- data/site/news/2017/06/15/jekyll-3-5-0-released/index.html +25 -19
- data/site/news/2017/07/17/jekyll-3-5-1-released/index.html +18 -12
- data/site/news/2017/08/12/jekyll-3-5-2-released/index.html +21 -15
- data/site/news/2017/09/21/jekyll-3-6-0-released/index.html +17 -11
- data/site/news/2017/10/19/diversity-open-source/index.html +18 -12
- data/site/news/2017/10/21/jekyll-3-6-2-released/index.html +18 -12
- data/site/news/2018/01/02/jekyll-3-7-0-released/index.html +21 -15
- data/site/news/2018/01/25/jekyll-3-7-2-released/index.html +26 -20
- data/site/news/2018/02/19/meet-jekyll-s-new-lead-developer/index.html +16 -10
- data/site/news/2018/02/24/jekyll-3-7-3-released/index.html +22 -16
- data/site/news/2018/05/01/jekyll-3-8-1-released/index.html +19 -13
- data/site/news/2018/05/19/jekyll-3-8-2-released/index.html +17 -11
- data/site/news/2018/06/05/jekyll-3-8-3-released/index.html +19 -13
- data/site/news/2019/07/02/jekyll-3-8-6-released/index.html +623 -0
- data/site/news/index.html +263 -218
- data/site/news/releases/index.html +261 -216
- data/site/philosophy.html +1 -1
- data/site/sitemap.xml +61 -57
- data/site/team/index.html +7 -6
- data/site/tutorials/convert-site-to-jekyll/index.html +97 -96
- data/site/tutorials/custom-404-page/index.html +16 -15
- data/site/tutorials/home/index.html +10 -9
- data/site/tutorials/navigation/index.html +102 -101
- data/site/tutorials/orderofinterpretation/index.html +32 -31
- data/site/tutorials/using-jekyll-with-bundler/index.html +19 -18
- data/site/tutorials/video-walkthroughs/index.html +8 -7
- metadata +10 -24
@@ -3,7 +3,7 @@
|
|
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 v3.
|
6
|
+
<meta name="generator" content="Jekyll v3.9.0">
|
7
7
|
<link type="application/atom+xml" rel="alternate" href="https://jekyllrb.com/feed.xml" title="Jekyll • Simple, blog-aware, static sites" />
|
8
8
|
<link rel="alternate" type="application/atom+xml" title="Recent commits to Jekyll’s master branch" href="https://github.com/jekyll/jekyll/commits/master.atom">
|
9
9
|
<link rel="preconnect" href="https://fonts.gstatic.com/" crossorigin>
|
@@ -11,9 +11,9 @@
|
|
11
11
|
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css" />
|
12
12
|
<link rel="stylesheet" href="/css/screen.css">
|
13
13
|
<link rel="icon" type="image/x-icon" href="/favicon.ico">
|
14
|
-
<!-- Begin Jekyll SEO tag v2.
|
14
|
+
<!-- Begin Jekyll SEO tag v2.6.1 -->
|
15
15
|
<title>Permalinks | Jekyll • Simple, blog-aware, static sites</title>
|
16
|
-
<meta name="generator" content="Jekyll v3.
|
16
|
+
<meta name="generator" content="Jekyll v3.9.0" />
|
17
17
|
<meta property="og:title" content="Permalinks" />
|
18
18
|
<meta property="og:locale" content="en_US" />
|
19
19
|
<meta name="description" content="Permalinks refer to the URLs (excluding the domain name or directory folder) for your pages, posts, or collections. Jekyll supports a flexible way to build permalinks, allowing you to leverage various template variables or choose built-in permalink styles (such as date) that automatically use a template-variable pattern." />
|
@@ -22,12 +22,13 @@
|
|
22
22
|
<meta property="og:url" content="https://jekyllrb.com/docs/permalinks/" />
|
23
23
|
<meta property="og:site_name" content="Jekyll • Simple, blog-aware, static sites" />
|
24
24
|
<meta property="og:type" content="article" />
|
25
|
-
<meta property="article:published_time" content="
|
25
|
+
<meta property="article:published_time" content="2020-08-05T11:55:36-07:00" />
|
26
26
|
<meta name="twitter:card" content="summary" />
|
27
|
+
<meta property="twitter:title" content="Permalinks" />
|
27
28
|
<meta name="twitter:site" content="@jekyllrb" />
|
28
29
|
<meta name="google-site-verification" content="onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY" />
|
29
30
|
<script type="application/ld+json">
|
30
|
-
{"headline":"Permalinks","dateModified":"
|
31
|
+
{"url":"https://jekyllrb.com/docs/permalinks/","headline":"Permalinks","dateModified":"2020-08-05T11:55:36-07:00","datePublished":"2020-08-05T11:55:36-07:00","publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://jekyllrb.com/img/logo-2x.png"}},"description":"Permalinks refer to the URLs (excluding the domain name or directory folder) for your pages, posts, or collections. Jekyll supports a flexible way to build permalinks, allowing you to leverage various template variables or choose built-in permalink styles (such as date) that automatically use a template-variable pattern.","mainEntityOfPage":{"@type":"WebPage","@id":"https://jekyllrb.com/docs/permalinks/"},"@type":"BlogPosting","@context":"https://schema.org"}</script>
|
31
32
|
<!-- End Jekyll SEO tag -->
|
32
33
|
|
33
34
|
<!--[if lt IE 9]>
|
@@ -72,7 +73,7 @@
|
|
72
73
|
<div class="meta hide-on-mobiles">
|
73
74
|
<ul>
|
74
75
|
<li>
|
75
|
-
<a href="https://github.com/jekyll/jekyll/releases/tag/v3.
|
76
|
+
<a href="https://github.com/jekyll/jekyll/releases/tag/v3.9.0">v3.9.0</a>
|
76
77
|
</li>
|
77
78
|
<li>
|
78
79
|
<a href="https://github.com/jekyll/jekyll">GitHub</a>
|
@@ -295,15 +296,15 @@
|
|
295
296
|
</div>
|
296
297
|
<h1>Permalinks</h1>
|
297
298
|
<p>Permalinks refer to the URLs (excluding the domain name or directory folder) for your pages, posts, or collections.
|
298
|
-
Jekyll supports a flexible way to build permalinks, allowing you to leverage various template variables or choose built-in permalink styles (such as <code class="highlighter-rouge">date</code>) that automatically use a template-variable pattern.</p>
|
299
|
+
Jekyll supports a flexible way to build permalinks, allowing you to leverage various template variables or choose built-in permalink styles (such as <code class="language-plaintext highlighter-rouge">date</code>) that automatically use a template-variable pattern.</p>
|
299
300
|
|
300
|
-
<p>You construct permalinks by creating a template URL where dynamic elements are represented by colon-prefixed keywords. The default template permalink is <code class="highlighter-rouge">/:categories/:year/:month/:day/:title:output_ext</code>. Each of the colon-prefixed keywords is a template variable.</p>
|
301
|
+
<p>You construct permalinks by creating a template URL where dynamic elements are represented by colon-prefixed keywords. The default template permalink is <code class="language-plaintext highlighter-rouge">/:categories/:year/:month/:day/:title:output_ext</code>. Each of the colon-prefixed keywords is a template variable.</p>
|
301
302
|
|
302
303
|
<h2 id="where-to-configure-permalinks">Where to configure permalinks</h2>
|
303
304
|
|
304
305
|
<p>You can configure your site’s permalinks through the <a href="/docs/configuration/">Configuration</a> file or in the <a href="/docs/frontmatter/">Front Matter</a> for each post, page, or collection.</p>
|
305
306
|
|
306
|
-
<p>Setting permalink styles in your configuration file applies the setting globally in your project. You configure permalinks in your <code class="highlighter-rouge">_config.yml</code> file like this:</p>
|
307
|
+
<p>Setting permalink styles in your configuration file applies the setting globally in your project. You configure permalinks in your <code class="language-plaintext highlighter-rouge">_config.yml</code> file like this:</p>
|
307
308
|
|
308
309
|
<div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">permalink</span><span class="pi">:</span> <span class="s">/:categories/:year/:month/:day/:title:output_ext</span>
|
309
310
|
</code></pre></div></div>
|
@@ -315,7 +316,7 @@ Jekyll supports a flexible way to build permalinks, allowing you to leverage var
|
|
315
316
|
<div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">permalink</span><span class="pi">:</span> <span class="s">date</span>
|
316
317
|
</code></pre></div></div>
|
317
318
|
|
318
|
-
<p><code class="highlighter-rouge">date</code> is the same as <code class="highlighter-rouge">:categories/:year/:month/:day/:title:output_ext</code>, the default. See <a href="#builtinpermalinkstyles">Built-in Permalink Styles</a> below for more options.</p>
|
319
|
+
<p><code class="language-plaintext highlighter-rouge">date</code> is the same as <code class="language-plaintext highlighter-rouge">:categories/:year/:month/:day/:title:output_ext</code>, the default. See <a href="#builtinpermalinkstyles">Built-in Permalink Styles</a> below for more options.</p>
|
319
320
|
|
320
321
|
<p>Setting the permalink in your post, page, or collection’s front matter overrides any global settings. Here’s an example:</p>
|
321
322
|
|
@@ -325,19 +326,19 @@ Jekyll supports a flexible way to build permalinks, allowing you to leverage var
|
|
325
326
|
<span class="nn">---</span>
|
326
327
|
</code></pre></div></div>
|
327
328
|
|
328
|
-
<p>Even if your configuration file specifies the <code class="highlighter-rouge">date</code> style, the URL for this page would be <code class="highlighter-rouge">http://somedomain.com/mypageurl/</code>.</p>
|
329
|
+
<p>Even if your configuration file specifies the <code class="language-plaintext highlighter-rouge">date</code> style, the URL for this page would be <code class="language-plaintext highlighter-rouge">http://somedomain.com/mypageurl/</code>.</p>
|
329
330
|
|
330
|
-
<p>When you use permalinks that omit the <code class="highlighter-rouge">.html</code> file extension (called “pretty URLs”) Jekyll builds the file as index.html placed inside a folder with the page’s name. For example:</p>
|
331
|
+
<p>When you use permalinks that omit the <code class="language-plaintext highlighter-rouge">.html</code> file extension (called “pretty URLs”) Jekyll builds the file as index.html placed inside a folder with the page’s name. For example:</p>
|
331
332
|
|
332
|
-
<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>├── mypageurl
|
333
|
+
<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>├── mypageurl
|
333
334
|
│ └── index.html
|
334
335
|
</code></pre></div></div>
|
335
336
|
|
336
|
-
<p>With a URL such as <code class="highlighter-rouge">/mypageurl/</code>, servers automatically load the index.html file inside the folder, so users can simply navigate to <code class="highlighter-rouge">http://somedomain.com/mypageurl/</code> to get to <code class="highlighter-rouge">mypageurl/index.html</code>.</p>
|
337
|
+
<p>With a URL such as <code class="language-plaintext highlighter-rouge">/mypageurl/</code>, servers automatically load the index.html file inside the folder, so users can simply navigate to <code class="language-plaintext highlighter-rouge">http://somedomain.com/mypageurl/</code> to get to <code class="language-plaintext highlighter-rouge">mypageurl/index.html</code>.</p>
|
337
338
|
|
338
339
|
<h2 id="template-variables">Template variables for permalinks</h2>
|
339
340
|
|
340
|
-
<p>The following table lists the template variables available for permalinks. You can use these variables in the <code class="highlighter-rouge">permalink</code> property in your config file.</p>
|
341
|
+
<p>The following table lists the template variables available for permalinks. You can use these variables in the <code class="language-plaintext highlighter-rouge">permalink</code> property in your config file.</p>
|
341
342
|
|
342
343
|
<div class="mobile-side-scroller">
|
343
344
|
<table>
|
@@ -544,7 +545,7 @@ Jekyll supports a flexible way to build permalinks, allowing you to leverage var
|
|
544
545
|
</table>
|
545
546
|
</div>
|
546
547
|
|
547
|
-
<p>Rather than typing <code class="highlighter-rouge">permalink: /:categories/:year/:month/:day/:title/</code>, you can just type <code class="highlighter-rouge">permalink: pretty</code>.</p>
|
548
|
+
<p>Rather than typing <code class="language-plaintext highlighter-rouge">permalink: /:categories/:year/:month/:day/:title/</code>, you can just type <code class="language-plaintext highlighter-rouge">permalink: pretty</code>.</p>
|
548
549
|
|
549
550
|
<div class="note info">
|
550
551
|
<h5>Specifying permalinks through the YAML Front Matter</h5>
|
@@ -555,7 +556,7 @@ Jekyll supports a flexible way to build permalinks, allowing you to leverage var
|
|
555
556
|
|
556
557
|
<p>Here are a few examples to clarify how permalink styles get applied with posts.</p>
|
557
558
|
|
558
|
-
<p>Given a post named: <code class="highlighter-rouge">/2009-04-29-slap-chop.md</code></p>
|
559
|
+
<p>Given a post named: <code class="language-plaintext highlighter-rouge">/2009-04-29-slap-chop.md</code></p>
|
559
560
|
|
560
561
|
<div class="mobile-side-scroller">
|
561
562
|
<table>
|
@@ -618,9 +619,9 @@ Jekyll supports a flexible way to build permalinks, allowing you to leverage var
|
|
618
619
|
<p>For example:</p>
|
619
620
|
|
620
621
|
<ul>
|
621
|
-
<li>A permalink style of <code class="highlighter-rouge">/:categories/:year/:month/:day/:title:output_ext</code> for posts becomes <code class="highlighter-rouge">/:title.html</code> for pages and collections.</li>
|
622
|
-
<li>A permalink style of <code class="highlighter-rouge">pretty</code> (or <code class="highlighter-rouge">/:categories/:year/:month/:day/:title/</code>), which omits the file extension and contains a trailing slash, will update page and collection permalinks to also omit the file extension and contain a trailing slash: <code class="highlighter-rouge">/:title/</code>.</li>
|
623
|
-
<li>A permalink style of <code class="highlighter-rouge">date</code>, which contains a trailing file extension, will update page permalinks to also contain a trailing file extension: <code class="highlighter-rouge">/:title.html</code>. But no time or category information will be included.</li>
|
622
|
+
<li>A permalink style of <code class="language-plaintext highlighter-rouge">/:categories/:year/:month/:day/:title:output_ext</code> for posts becomes <code class="language-plaintext highlighter-rouge">/:title.html</code> for pages and collections.</li>
|
623
|
+
<li>A permalink style of <code class="language-plaintext highlighter-rouge">pretty</code> (or <code class="language-plaintext highlighter-rouge">/:categories/:year/:month/:day/:title/</code>), which omits the file extension and contains a trailing slash, will update page and collection permalinks to also omit the file extension and contain a trailing slash: <code class="language-plaintext highlighter-rouge">/:title/</code>.</li>
|
624
|
+
<li>A permalink style of <code class="language-plaintext highlighter-rouge">date</code>, which contains a trailing file extension, will update page permalinks to also contain a trailing file extension: <code class="language-plaintext highlighter-rouge">/:title.html</code>. But no time or category information will be included.</li>
|
624
625
|
</ul>
|
625
626
|
|
626
627
|
<h2 id="permalinks-and-default-paths">Permalinks and default paths</h2>
|
@@ -629,25 +630,25 @@ Jekyll supports a flexible way to build permalinks, allowing you to leverage var
|
|
629
630
|
|
630
631
|
<h3 id="posts">Posts</h3>
|
631
632
|
|
632
|
-
<p>The subfolders into which you may have organized your posts inside the <code class="highlighter-rouge">_posts</code> directory will not be part of the permalink.</p>
|
633
|
+
<p>The subfolders into which you may have organized your posts inside the <code class="language-plaintext highlighter-rouge">_posts</code> directory will not be part of the permalink.</p>
|
633
634
|
|
634
|
-
<p>If you use a permalink style that omits the <code class="highlighter-rouge">.html</code> file extension, each post is rendered as an <code class="highlighter-rouge">index.html</code> file inside a folder with the post’s name (for example, <code class="highlighter-rouge">categoryname/2016/12/01/mypostname/index.html</code>).</p>
|
635
|
+
<p>If you use a permalink style that omits the <code class="language-plaintext highlighter-rouge">.html</code> file extension, each post is rendered as an <code class="language-plaintext highlighter-rouge">index.html</code> file inside a folder with the post’s name (for example, <code class="language-plaintext highlighter-rouge">categoryname/2016/12/01/mypostname/index.html</code>).</p>
|
635
636
|
|
636
637
|
<h3 id="pages">Pages</h3>
|
637
638
|
|
638
|
-
<p>Unlike posts, pages by default mimic the source directory structure exactly. (The only exception is if your page has a <code class="highlighter-rouge">permalink</code> declared its front matter — in that case, the structure honors the permalink setting instead of the source folder structure.)</p>
|
639
|
+
<p>Unlike posts, pages by default mimic the source directory structure exactly. (The only exception is if your page has a <code class="language-plaintext highlighter-rouge">permalink</code> declared its front matter — in that case, the structure honors the permalink setting instead of the source folder structure.)</p>
|
639
640
|
|
640
|
-
<p>As with posts, if you use a permalink style that omits the <code class="highlighter-rouge">.html</code> file extension, each page is rendered as an <code class="highlighter-rouge">index.html</code> file inserted inside a folder with the page’s name (for example, <code class="highlighter-rouge">mypage/index.html</code>).</p>
|
641
|
+
<p>As with posts, if you use a permalink style that omits the <code class="language-plaintext highlighter-rouge">.html</code> file extension, each page is rendered as an <code class="language-plaintext highlighter-rouge">index.html</code> file inserted inside a folder with the page’s name (for example, <code class="language-plaintext highlighter-rouge">mypage/index.html</code>).</p>
|
641
642
|
|
642
643
|
<h3 id="collections">Collections</h3>
|
643
644
|
|
644
|
-
<p>By default, collections follow a similar structure in the <code class="highlighter-rouge">_site</code> folder as pages, except that the path is prefaced by the collection name. For example: <code class="highlighter-rouge">collectionname/mypage.html</code>. For permalink settings that omit the file extension, the path would be <code class="highlighter-rouge">collection_name/mypage/index.html</code>.</p>
|
645
|
+
<p>By default, collections follow a similar structure in the <code class="language-plaintext highlighter-rouge">_site</code> folder as pages, except that the path is prefaced by the collection name. For example: <code class="language-plaintext highlighter-rouge">collectionname/mypage.html</code>. For permalink settings that omit the file extension, the path would be <code class="language-plaintext highlighter-rouge">collection_name/mypage/index.html</code>.</p>
|
645
646
|
|
646
|
-
<p>Collections have their own way of setting permalinks. Additionally, collections have unique template variables available (such as <code class="highlighter-rouge">path</code> and <code class="highlighter-rouge">output_ext</code>). See the <a href="../collections/#permalinks">Configuring permalinks for collections</a> in Collections for more information.</p>
|
647
|
+
<p>Collections have their own way of setting permalinks. Additionally, collections have unique template variables available (such as <code class="language-plaintext highlighter-rouge">path</code> and <code class="language-plaintext highlighter-rouge">output_ext</code>). See the <a href="../collections/#permalinks">Configuring permalinks for collections</a> in Collections for more information.</p>
|
647
648
|
|
648
649
|
<h2 id="flattening-pages-in-_site-on-build">Flattening pages in _site on build</h2>
|
649
650
|
|
650
|
-
<p>If you want to flatten your pages (pull them out of subfolders) in the <code class="highlighter-rouge">_site</code> directory when your site builds (similar to posts), add the <code class="highlighter-rouge">permalink</code> property to the front matter of each page, with no path specified:</p>
|
651
|
+
<p>If you want to flatten your pages (pull them out of subfolders) in the <code class="language-plaintext highlighter-rouge">_site</code> directory when your site builds (similar to posts), add the <code class="language-plaintext highlighter-rouge">permalink</code> property to the front matter of each page, with no path specified:</p>
|
651
652
|
|
652
653
|
<div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nn">---</span>
|
653
654
|
<span class="na">title</span><span class="pi">:</span> <span class="s">My page</span>
|
@@ -657,25 +658,25 @@ Jekyll supports a flexible way to build permalinks, allowing you to leverage var
|
|
657
658
|
|
658
659
|
<h2 id="extensionless-permalinks">Extensionless permalinks with no trailing slashes</h2>
|
659
660
|
|
660
|
-
<p>Jekyll supports permalinks that contain neither a trailing slash nor a file extension, but this requires additional support from the web server to properly serve. When using these types of permalinks, output files written to disk will still have the proper file extension (typically <code class="highlighter-rouge">.html</code>), so the web server must be able to map requests without file extensions to these files.</p>
|
661
|
+
<p>Jekyll supports permalinks that contain neither a trailing slash nor a file extension, but this requires additional support from the web server to properly serve. When using these types of permalinks, output files written to disk will still have the proper file extension (typically <code class="language-plaintext highlighter-rouge">.html</code>), so the web server must be able to map requests without file extensions to these files.</p>
|
661
662
|
|
662
663
|
<p>Both <a href="../github-pages/">GitHub Pages</a> and the Jekyll’s built-in WEBrick server handle these requests properly without any additional work.</p>
|
663
664
|
|
664
665
|
<h3 id="apache">Apache</h3>
|
665
666
|
|
666
|
-
<p>The Apache web server has extensive support for content negotiation and can handle extensionless URLs by setting the <a href="https://httpd.apache.org/docs/current/content-negotiation.html#multiviews">multiviews</a> option in your <code class="highlighter-rouge">httpd.conf</code> or <code class="highlighter-rouge">.htaccess</code> file:</p>
|
667
|
+
<p>The Apache web server has extensive support for content negotiation and can handle extensionless URLs by setting the <a href="https://httpd.apache.org/docs/current/content-negotiation.html#multiviews">multiviews</a> option in your <code class="language-plaintext highlighter-rouge">httpd.conf</code> or <code class="language-plaintext highlighter-rouge">.htaccess</code> file:</p>
|
667
668
|
|
668
669
|
<figure class="highlight"><pre><code class="language-apache" data-lang="apache"><span class="nc">Options</span> +MultiViews</code></pre></figure>
|
669
670
|
|
670
671
|
<h3 id="nginx">Nginx</h3>
|
671
672
|
|
672
|
-
<p>The <a href="http://nginx.org/en/docs/http/ngx_http_core_module.html#try_files">try_files</a> directive allows you to specify a list of files to search for to process a request. The following configuration will instruct nginx to search for a file with an <code class="highlighter-rouge">.html</code> extension if an exact match for the requested URI is not found.</p>
|
673
|
+
<p>The <a href="http://nginx.org/en/docs/http/ngx_http_core_module.html#try_files">try_files</a> directive allows you to specify a list of files to search for to process a request. The following configuration will instruct nginx to search for a file with an <code class="language-plaintext highlighter-rouge">.html</code> extension if an exact match for the requested URI is not found.</p>
|
673
674
|
|
674
675
|
<figure class="highlight"><pre><code class="language-nginx" data-lang="nginx"><span class="k">try_files</span> <span class="nv">$uri</span> <span class="nv">$uri</span><span class="s">.html</span> <span class="nv">$uri</span><span class="n">/</span> <span class="p">=</span><span class="mi">404</span><span class="p">;</span></code></pre></figure>
|
675
676
|
|
676
677
|
<h2 id="linking-without-regard-to-permalink-styles">Linking without regard to permalink styles</h2>
|
677
678
|
|
678
|
-
<p>You can create links in your topics to other posts, pages, or collection items in a way that is valid no matter what permalink configuration you choose. By using the <code class="highlighter-rouge">link</code> tag, if you change your permalinks, your links won’t break. See <a href="../templates#link">Linking to pages</a> in Templates for more details.</p>
|
679
|
+
<p>You can create links in your topics to other posts, pages, or collection items in a way that is valid no matter what permalink configuration you choose. By using the <code class="language-plaintext highlighter-rouge">link</code> tag, if you change your permalinks, your links won’t break. See <a href="../templates#link">Linking to pages</a> in Templates for more details.</p>
|
679
680
|
|
680
681
|
|
681
682
|
|
@@ -959,7 +960,7 @@ Jekyll supports a flexible way to build permalinks, allowing you to leverage var
|
|
959
960
|
<footer>
|
960
961
|
<div class="grid">
|
961
962
|
<div class="unit one-third center-on-mobiles">
|
962
|
-
<p>The contents of this website are <br />©
|
963
|
+
<p>The contents of this website are <br />© 2020 under the terms of the <a href="https://github.com/jekyll/jekyll/blob/master/LICENSE">MIT License</a>.</p>
|
963
964
|
</div>
|
964
965
|
<div class="unit two-thirds align-right center-on-mobiles">
|
965
966
|
<p>
|
@@ -3,7 +3,7 @@
|
|
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 v3.
|
6
|
+
<meta name="generator" content="Jekyll v3.9.0">
|
7
7
|
<link type="application/atom+xml" rel="alternate" href="https://jekyllrb.com/feed.xml" title="Jekyll • Simple, blog-aware, static sites" />
|
8
8
|
<link rel="alternate" type="application/atom+xml" title="Recent commits to Jekyll’s master branch" href="https://github.com/jekyll/jekyll/commits/master.atom">
|
9
9
|
<link rel="preconnect" href="https://fonts.gstatic.com/" crossorigin>
|
@@ -11,9 +11,9 @@
|
|
11
11
|
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css" />
|
12
12
|
<link rel="stylesheet" href="/css/screen.css">
|
13
13
|
<link rel="icon" type="image/x-icon" href="/favicon.ico">
|
14
|
-
<!-- Begin Jekyll SEO tag v2.
|
14
|
+
<!-- Begin Jekyll SEO tag v2.6.1 -->
|
15
15
|
<title>Plugins | Jekyll • Simple, blog-aware, static sites</title>
|
16
|
-
<meta name="generator" content="Jekyll v3.
|
16
|
+
<meta name="generator" content="Jekyll v3.9.0" />
|
17
17
|
<meta property="og:title" content="Plugins" />
|
18
18
|
<meta property="og:locale" content="en_US" />
|
19
19
|
<meta name="description" content="Jekyll has a plugin system with hooks that allow you to create custom generated content specific to your site. You can run custom code for your site without having to modify the Jekyll source itself." />
|
@@ -22,12 +22,13 @@
|
|
22
22
|
<meta property="og:url" content="https://jekyllrb.com/docs/plugins/" />
|
23
23
|
<meta property="og:site_name" content="Jekyll • Simple, blog-aware, static sites" />
|
24
24
|
<meta property="og:type" content="article" />
|
25
|
-
<meta property="article:published_time" content="
|
25
|
+
<meta property="article:published_time" content="2020-08-05T11:55:36-07:00" />
|
26
26
|
<meta name="twitter:card" content="summary" />
|
27
|
+
<meta property="twitter:title" content="Plugins" />
|
27
28
|
<meta name="twitter:site" content="@jekyllrb" />
|
28
29
|
<meta name="google-site-verification" content="onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY" />
|
29
30
|
<script type="application/ld+json">
|
30
|
-
{"headline":"Plugins","dateModified":"
|
31
|
+
{"url":"https://jekyllrb.com/docs/plugins/","headline":"Plugins","dateModified":"2020-08-05T11:55:36-07:00","datePublished":"2020-08-05T11:55:36-07:00","publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://jekyllrb.com/img/logo-2x.png"}},"description":"Jekyll has a plugin system with hooks that allow you to create custom generated content specific to your site. You can run custom code for your site without having to modify the Jekyll source itself.","mainEntityOfPage":{"@type":"WebPage","@id":"https://jekyllrb.com/docs/plugins/"},"@type":"BlogPosting","@context":"https://schema.org"}</script>
|
31
32
|
<!-- End Jekyll SEO tag -->
|
32
33
|
|
33
34
|
<!--[if lt IE 9]>
|
@@ -72,7 +73,7 @@
|
|
72
73
|
<div class="meta hide-on-mobiles">
|
73
74
|
<ul>
|
74
75
|
<li>
|
75
|
-
<a href="https://github.com/jekyll/jekyll/releases/tag/v3.
|
76
|
+
<a href="https://github.com/jekyll/jekyll/releases/tag/v3.9.0">v3.9.0</a>
|
76
77
|
</li>
|
77
78
|
<li>
|
78
79
|
<a href="https://github.com/jekyll/jekyll">GitHub</a>
|
@@ -317,12 +318,12 @@ having to modify the Jekyll source itself.</p>
|
|
317
318
|
|
318
319
|
<ol>
|
319
320
|
<li>
|
320
|
-
<p>In your site source root, make a <code class="highlighter-rouge">_plugins</code> directory. Place your plugins
|
321
|
-
here. Any file ending in <code class="highlighter-rouge">*.rb</code> inside this directory will be loaded before
|
321
|
+
<p>In your site source root, make a <code class="language-plaintext highlighter-rouge">_plugins</code> directory. Place your plugins
|
322
|
+
here. Any file ending in <code class="language-plaintext highlighter-rouge">*.rb</code> inside this directory will be loaded before
|
322
323
|
Jekyll generates your site.</p>
|
323
324
|
</li>
|
324
325
|
<li>
|
325
|
-
<p>In your <code class="highlighter-rouge">_config.yml</code> file, add a new array with the key <code class="highlighter-rouge">plugins</code> (or <code class="highlighter-rouge">gems</code> for Jekyll < <code class="highlighter-rouge">3.5.0</code>) and the
|
326
|
+
<p>In your <code class="language-plaintext highlighter-rouge">_config.yml</code> file, add a new array with the key <code class="language-plaintext highlighter-rouge">plugins</code> (or <code class="language-plaintext highlighter-rouge">gems</code> for Jekyll < <code class="language-plaintext highlighter-rouge">3.5.0</code>) and the
|
326
327
|
values of the gem names of the plugins you’d like to use. An example:</p>
|
327
328
|
|
328
329
|
<div class="language-yaml highlighter-rouge">
|
@@ -334,10 +335,10 @@ values of the gem names of the plugins you’d like to use. An example:</p>
|
|
334
335
|
<span class="pi">-</span> <span class="s">another-jekyll-plugin</span>
|
335
336
|
</code></pre></div> </div>
|
336
337
|
|
337
|
-
<p>Then install your plugins using <code class="highlighter-rouge">gem install jekyll-gist jekyll-coffeescript jekyll-assets another-jekyll-plugin</code></p>
|
338
|
+
<p>Then install your plugins using <code class="language-plaintext highlighter-rouge">gem install jekyll-gist jekyll-coffeescript jekyll-assets another-jekyll-plugin</code></p>
|
338
339
|
</li>
|
339
340
|
<li>
|
340
|
-
<p>Add the relevant plugins to a Bundler group in your <code class="highlighter-rouge">Gemfile</code>. An
|
341
|
+
<p>Add the relevant plugins to a Bundler group in your <code class="language-plaintext highlighter-rouge">Gemfile</code>. An
|
341
342
|
example:</p>
|
342
343
|
|
343
344
|
<div class="language-ruby highlighter-rouge">
|
@@ -349,7 +350,7 @@ example:</p>
|
|
349
350
|
<span class="k">end</span>
|
350
351
|
</code></pre></div> </div>
|
351
352
|
|
352
|
-
<p>Now you need to install all plugins from your Bundler group by running single command <code class="highlighter-rouge">bundle install</code>.</p>
|
353
|
+
<p>Now you need to install all plugins from your Bundler group by running single command <code class="language-plaintext highlighter-rouge">bundle install</code>.</p>
|
353
354
|
</li>
|
354
355
|
</ol>
|
355
356
|
|
@@ -367,12 +368,12 @@ example:</p>
|
|
367
368
|
|
368
369
|
<h3 id="the-jekyll_plugins-group">The jekyll_plugins group</h3>
|
369
370
|
|
370
|
-
<p>Jekyll gives this particular group of gems in your <code class="highlighter-rouge">Gemfile</code> a different
|
371
|
+
<p>Jekyll gives this particular group of gems in your <code class="language-plaintext highlighter-rouge">Gemfile</code> a different
|
371
372
|
treatment. Any gem included in this group is loaded before Jekyll starts
|
372
373
|
processing the rest of your source directory.</p>
|
373
374
|
|
374
375
|
<p>A gem included here will be activated even if its not explicitly listed under
|
375
|
-
the <code class="highlighter-rouge">plugins:</code> key in your site’s config file.</p>
|
376
|
+
the <code class="language-plaintext highlighter-rouge">plugins:</code> key in your site’s config file.</p>
|
376
377
|
|
377
378
|
<div class="note warning">
|
378
379
|
<p>
|
@@ -403,25 +404,25 @@ the <code class="highlighter-rouge">plugins:</code> key in your site’s config
|
|
403
404
|
<p>You can create a generator when you need Jekyll to create additional content
|
404
405
|
based on your own rules.</p>
|
405
406
|
|
406
|
-
<p>A generator is a subclass of <code class="highlighter-rouge">Jekyll::Generator</code> that defines a <code class="highlighter-rouge">generate</code>
|
407
|
+
<p>A generator is a subclass of <code class="language-plaintext highlighter-rouge">Jekyll::Generator</code> that defines a <code class="language-plaintext highlighter-rouge">generate</code>
|
407
408
|
method, which receives an instance of
|
408
|
-
<a href="https://github.com/jekyll/jekyll/blob/master/lib/jekyll/site.rb"><code class="highlighter-rouge">Jekyll::Site</code></a>. The
|
409
|
-
return value of <code class="highlighter-rouge">generate</code> is ignored.</p>
|
409
|
+
<a href="https://github.com/jekyll/jekyll/blob/master/lib/jekyll/site.rb"><code class="language-plaintext highlighter-rouge">Jekyll::Site</code></a>. The
|
410
|
+
return value of <code class="language-plaintext highlighter-rouge">generate</code> is ignored.</p>
|
410
411
|
|
411
412
|
<p>Generators run after Jekyll has made an inventory of the existing content, and
|
412
413
|
before the site is generated. Pages with YAML Front Matters are stored as
|
413
414
|
instances of
|
414
|
-
<a href="https://github.com/jekyll/jekyll/blob/master/lib/jekyll/page.rb"><code class="highlighter-rouge">Jekyll::Page</code></a>
|
415
|
-
and are available via <code class="highlighter-rouge">site.pages</code>. Static files become instances of
|
416
|
-
<a href="https://github.com/jekyll/jekyll/blob/master/lib/jekyll/static_file.rb"><code class="highlighter-rouge">Jekyll::StaticFile</code></a>
|
417
|
-
and are available via <code class="highlighter-rouge">site.static_files</code>. See
|
415
|
+
<a href="https://github.com/jekyll/jekyll/blob/master/lib/jekyll/page.rb"><code class="language-plaintext highlighter-rouge">Jekyll::Page</code></a>
|
416
|
+
and are available via <code class="language-plaintext highlighter-rouge">site.pages</code>. Static files become instances of
|
417
|
+
<a href="https://github.com/jekyll/jekyll/blob/master/lib/jekyll/static_file.rb"><code class="language-plaintext highlighter-rouge">Jekyll::StaticFile</code></a>
|
418
|
+
and are available via <code class="language-plaintext highlighter-rouge">site.static_files</code>. See
|
418
419
|
<a href="/docs/variables/">the Variables documentation page</a> and
|
419
|
-
<a href="https://github.com/jekyll/jekyll/blob/master/lib/jekyll/site.rb"><code class="highlighter-rouge">Jekyll::Site</code></a>
|
420
|
+
<a href="https://github.com/jekyll/jekyll/blob/master/lib/jekyll/site.rb"><code class="language-plaintext highlighter-rouge">Jekyll::Site</code></a>
|
420
421
|
for more details.</p>
|
421
422
|
|
422
423
|
<p>For instance, a generator can inject values computed at build time for template
|
423
|
-
variables. In the following example the template <code class="highlighter-rouge">reading.html</code> has two
|
424
|
-
variables <code class="highlighter-rouge">ongoing</code> and <code class="highlighter-rouge">done</code> that we fill in the generator:</p>
|
424
|
+
variables. In the following example the template <code class="language-plaintext highlighter-rouge">reading.html</code> has two
|
425
|
+
variables <code class="language-plaintext highlighter-rouge">ongoing</code> and <code class="language-plaintext highlighter-rouge">done</code> that we fill in the generator:</p>
|
425
426
|
|
426
427
|
<div class="language-ruby highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="k">module</span> <span class="nn">Reading</span>
|
427
428
|
<span class="k">class</span> <span class="nc">Generator</span> <span class="o"><</span> <span class="no">Jekyll</span><span class="o">::</span><span class="no">Generator</span>
|
@@ -471,8 +472,8 @@ variables <code class="highlighter-rouge">ongoing</code> and <code class="highli
|
|
471
472
|
</code></pre></div></div>
|
472
473
|
|
473
474
|
<p>In this example, our generator will create a series of files under the
|
474
|
-
<code class="highlighter-rouge">categories</code> directory for each category, listing the posts in each category
|
475
|
-
using the <code class="highlighter-rouge">category_index.html</code> layout.</p>
|
475
|
+
<code class="language-plaintext highlighter-rouge">categories</code> directory for each category, listing the posts in each category
|
476
|
+
using the <code class="language-plaintext highlighter-rouge">category_index.html</code> layout.</p>
|
476
477
|
|
477
478
|
<p>Generators are only required to implement one method:</p>
|
478
479
|
|
@@ -512,8 +513,8 @@ languages are implemented using this method.</p>
|
|
512
513
|
</p>
|
513
514
|
</div>
|
514
515
|
|
515
|
-
<p>Below is a converter that will take all posts ending in <code class="highlighter-rouge">.upcase</code> and process
|
516
|
-
them using the <code class="highlighter-rouge">UpcaseConverter</code>:</p>
|
516
|
+
<p>Below is a converter that will take all posts ending in <code class="language-plaintext highlighter-rouge">.upcase</code> and process
|
517
|
+
them using the <code class="language-plaintext highlighter-rouge">UpcaseConverter</code>:</p>
|
517
518
|
|
518
519
|
<div class="language-ruby highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="k">module</span> <span class="nn">Jekyll</span>
|
519
520
|
<span class="k">class</span> <span class="nc">UpcaseConverter</span> <span class="o"><</span> <span class="no">Converter</span>
|
@@ -579,25 +580,25 @@ them using the <code class="highlighter-rouge">UpcaseConverter</code>:</p>
|
|
579
580
|
</table>
|
580
581
|
</div>
|
581
582
|
|
582
|
-
<p>In our example, <code class="highlighter-rouge">UpcaseConverter#matches</code> checks if our filename extension is
|
583
|
-
<code class="highlighter-rouge">.upcase</code>, and will render using the converter if it is. It will call
|
584
|
-
<code class="highlighter-rouge">UpcaseConverter#convert</code> to process the content. In our simple converter we’re
|
583
|
+
<p>In our example, <code class="language-plaintext highlighter-rouge">UpcaseConverter#matches</code> checks if our filename extension is
|
584
|
+
<code class="language-plaintext highlighter-rouge">.upcase</code>, and will render using the converter if it is. It will call
|
585
|
+
<code class="language-plaintext highlighter-rouge">UpcaseConverter#convert</code> to process the content. In our simple converter we’re
|
585
586
|
simply uppercasing the entire content string. Finally, when it saves the page,
|
586
|
-
it will do so with a <code class="highlighter-rouge">.html</code> extension.</p>
|
587
|
+
it will do so with a <code class="language-plaintext highlighter-rouge">.html</code> extension.</p>
|
587
588
|
|
588
589
|
<h2 id="commands">Commands</h2>
|
589
590
|
|
590
591
|
<p>As of version 2.5.0, Jekyll can be extended with plugins which provide
|
591
|
-
subcommands for the <code class="highlighter-rouge">jekyll</code> executable. This is possible by including the
|
592
|
-
relevant plugins in a <code class="highlighter-rouge">Gemfile</code> group called <code class="highlighter-rouge">:jekyll_plugins</code>:</p>
|
592
|
+
subcommands for the <code class="language-plaintext highlighter-rouge">jekyll</code> executable. This is possible by including the
|
593
|
+
relevant plugins in a <code class="language-plaintext highlighter-rouge">Gemfile</code> group called <code class="language-plaintext highlighter-rouge">:jekyll_plugins</code>:</p>
|
593
594
|
|
594
595
|
<div class="language-ruby highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="n">group</span> <span class="ss">:jekyll_plugins</span> <span class="k">do</span>
|
595
596
|
<span class="n">gem</span> <span class="s2">"my_fancy_jekyll_plugin"</span>
|
596
597
|
<span class="k">end</span>
|
597
598
|
</code></pre></div></div>
|
598
599
|
|
599
|
-
<p>Each <code class="highlighter-rouge">Command</code> must be a subclass of the <code class="highlighter-rouge">Jekyll::Command</code> class and must
|
600
|
-
contain one class method: <code class="highlighter-rouge">init_with_program</code>. An example:</p>
|
600
|
+
<p>Each <code class="language-plaintext highlighter-rouge">Command</code> must be a subclass of the <code class="language-plaintext highlighter-rouge">Jekyll::Command</code> class and must
|
601
|
+
contain one class method: <code class="language-plaintext highlighter-rouge">init_with_program</code>. An example:</p>
|
601
602
|
|
602
603
|
<div class="language-ruby highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="k">class</span> <span class="nc">MyNewCommand</span> <span class="o"><</span> <span class="no">Jekyll</span><span class="o">::</span><span class="no">Command</span>
|
603
604
|
<span class="k">class</span> <span class="o"><<</span> <span class="nb">self</span>
|
@@ -648,7 +649,7 @@ contain one class method: <code class="highlighter-rouge">init_with_program</cod
|
|
648
649
|
|
649
650
|
<p>If you’d like to include custom liquid tags in your site, you can do so by
|
650
651
|
hooking into the tagging system. Built-in examples added by Jekyll include the
|
651
|
-
<code class="highlighter-rouge">highlight</code> and <code class="highlighter-rouge">include</code> tags. Below is an example of a custom liquid tag that
|
652
|
+
<code class="language-plaintext highlighter-rouge">highlight</code> and <code class="language-plaintext highlighter-rouge">include</code> tags. Below is an example of a custom liquid tag that
|
652
653
|
will output the time the page was rendered:</p>
|
653
654
|
|
654
655
|
<div class="language-ruby highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="k">module</span> <span class="nn">Jekyll</span>
|
@@ -814,10 +815,10 @@ hook like this:</p>
|
|
814
815
|
<p>Jekyll provides hooks for <code>:site</code>, <code>:pages</code>,
|
815
816
|
<code>:posts</code>, and <code>:documents</code>. In all cases, Jekyll calls
|
816
817
|
your hooks with the container object as the first callback parameter. However,
|
817
|
-
all <code class="highlighter-rouge">:pre_render</code> hooks and the<code class="highlighter-rouge">:site, :post_render</code> hook will also provide a
|
818
|
-
payload hash as a second parameter. In the case of <code class="highlighter-rouge">:pre_render</code>, the payload
|
818
|
+
all <code class="language-plaintext highlighter-rouge">:pre_render</code> hooks and the<code class="language-plaintext highlighter-rouge">:site, :post_render</code> hook will also provide a
|
819
|
+
payload hash as a second parameter. In the case of <code class="language-plaintext highlighter-rouge">:pre_render</code>, the payload
|
819
820
|
gives you full control over the variables that are available while rendering.
|
820
|
-
In the case of <code class="highlighter-rouge">:site, :post_render</code>, the payload contains final values after
|
821
|
+
In the case of <code class="language-plaintext highlighter-rouge">:site, :post_render</code>, the payload contains final values after
|
821
822
|
rendering all the site (useful for sitemaps, feeds, etc).</p>
|
822
823
|
|
823
824
|
<p>The complete list of available hooks is below:</p>
|
@@ -1061,7 +1062,7 @@ rendering all the site (useful for sitemaps, feeds, etc).</p>
|
|
1061
1062
|
<li>
|
1062
1063
|
<a href="https://github.com/mscharley/jekyll-compass">Compass integration for Jekyll</a>: Easily integrate Compass and Sass with your Jekyll website.</li>
|
1063
1064
|
<li>
|
1064
|
-
<a href="https://github.com/bbakersmith/jekyll-pages-directory">Pages Directory by Ben Baker-Smith</a>: Defines a <code class="highlighter-rouge">_pages</code> directory for page files which routes its output relative to the project root.</li>
|
1065
|
+
<a href="https://github.com/bbakersmith/jekyll-pages-directory">Pages Directory by Ben Baker-Smith</a>: Defines a <code class="language-plaintext highlighter-rouge">_pages</code> directory for page files which routes its output relative to the project root.</li>
|
1065
1066
|
<li>
|
1066
1067
|
<a href="https://github.com/jeffkole/jekyll-page-collections">Page Collections by Jeff Kolesky</a>: Generates collections of pages with functionality that resembles posts.</li>
|
1067
1068
|
<li>
|
@@ -1095,7 +1096,7 @@ rendering all the site (useful for sitemaps, feeds, etc).</p>
|
|
1095
1096
|
<li>
|
1096
1097
|
<a href="https://github.com/ibrado/jekyll-tweetsert">Tweetsert</a>: Imports tweets (Twitter statuses) as new posts. Features multiple timeline support, hashtag import, filtering, automatic category and/or tags, optional retweets and replies.</li>
|
1097
1098
|
<li>
|
1098
|
-
<a href="https://github.com/ibrado/jekyll-stickyposts">Stickyposts</a>: Moves or copies (pins) posts marked <code class="highlighter-rouge">sticky: true</code> to the top of the list. Perfect for keeping important announcements on the home page, or giving collections a descriptive entry. Paginator friendly.</li>
|
1099
|
+
<a href="https://github.com/ibrado/jekyll-stickyposts">Stickyposts</a>: Moves or copies (pins) posts marked <code class="language-plaintext highlighter-rouge">sticky: true</code> to the top of the list. Perfect for keeping important announcements on the home page, or giving collections a descriptive entry. Paginator friendly.</li>
|
1099
1100
|
<li>
|
1100
1101
|
<a href="https://github.com/ibrado/jekyll-paginate-content">Jekyll::Paginate::Content</a>: Content paginator in the style of jekyll-paginator-v2 that splits pages, posts, and collection entries into several pages. Specify a separator or use HTML <h1> etc. headers. Automatic splitting, single-page view, pager/trail, self-adjusting links, multipage TOC, SEO support.</li>
|
1101
1102
|
<li>
|
@@ -1110,7 +1111,7 @@ rendering all the site (useful for sitemaps, feeds, etc).</p>
|
|
1110
1111
|
<li>
|
1111
1112
|
<a href="http://jekyll-pug.dougie.io">Pug plugin by Doug Beney</a>: Use the popular Pug (previously Jade) templating language in Jekyll. Complete with caching, includes support, and much more.</li>
|
1112
1113
|
<li>
|
1113
|
-
<a href="https://github.com/jekyll/jekyll-textile-converter">Textile converter</a>: Convert <code class="highlighter-rouge">.textile</code> files into HTML. Also includes the <code class="highlighter-rouge">textilize</code> Liquid filter.</li>
|
1114
|
+
<a href="https://github.com/jekyll/jekyll-textile-converter">Textile converter</a>: Convert <code class="language-plaintext highlighter-rouge">.textile</code> files into HTML. Also includes the <code class="language-plaintext highlighter-rouge">textilize</code> Liquid filter.</li>
|
1114
1115
|
<li>
|
1115
1116
|
<a href="https://github.com/slim-template/jekyll-slim">Slim plugin</a>: Slim converter and includes for Jekyll with support for Liquid tags.</li>
|
1116
1117
|
<li>
|
@@ -1186,7 +1187,7 @@ rendering all the site (useful for sitemaps, feeds, etc).</p>
|
|
1186
1187
|
|
1187
1188
|
<ul>
|
1188
1189
|
<li>
|
1189
|
-
<a href="https://github.com/jekyll/jekyll-gist">Jekyll-gist</a>: Use the <code class="highlighter-rouge">gist</code> tag to easily embed a GitHub Gist onto your site. This works with public or secret gists.</li>
|
1190
|
+
<a href="https://github.com/jekyll/jekyll-gist">Jekyll-gist</a>: Use the <code class="language-plaintext highlighter-rouge">gist</code> tag to easily embed a GitHub Gist onto your site. This works with public or secret gists.</li>
|
1190
1191
|
<li>
|
1191
1192
|
<a href="https://github.com/samrayner/jekyll-asset-path-plugin">Asset Path Tag</a> by <a href="http://www.samrayner.com/">Sam Rayner</a>: Allows organisation of assets into subdirectories by outputting a path for a given file relative to the current post or page.</li>
|
1192
1193
|
<li>
|
@@ -1214,11 +1215,11 @@ rendering all the site (useful for sitemaps, feeds, etc).</p>
|
|
1214
1215
|
<li>
|
1215
1216
|
<a href="https://github.com/sectore/jekyll-swfobject">Jekyll-swfobject</a>: Liquid plugin for embedding Adobe Flash files (.swf) using <a href="https://github.com/swfobject/swfobject">SWFObject</a>.</li>
|
1216
1217
|
<li>
|
1217
|
-
<a href="https://github.com/robwierzbowski/jekyll-picture-tag">Jekyll Picture Tag</a>: Easy responsive images for Jekyll. Based on the proposed <a href="https://html.spec.whatwg.org/multipage/embedded-content.html#the-picture-element"><code class="highlighter-rouge"><picture></code></a> element, polyfilled with Scott Jehl’s <a href="https://github.com/scottjehl/picturefill">Picturefill</a>.</li>
|
1218
|
+
<a href="https://github.com/robwierzbowski/jekyll-picture-tag">Jekyll Picture Tag</a>: Easy responsive images for Jekyll. Based on the proposed <a href="https://html.spec.whatwg.org/multipage/embedded-content.html#the-picture-element"><code class="language-plaintext highlighter-rouge"><picture></code></a> element, polyfilled with Scott Jehl’s <a href="https://github.com/scottjehl/picturefill">Picturefill</a>.</li>
|
1218
1219
|
<li>
|
1219
1220
|
<a href="https://github.com/robwierzbowski/jekyll-image-tag">Jekyll Image Tag</a>: Better images for Jekyll. Save image presets, generate resized images, and add classes, alt text, and other attributes.</li>
|
1220
1221
|
<li>
|
1221
|
-
<a href="https://github.com/wildlyinaccurate/jekyll-responsive-image">Jekyll Responsive Image</a>: Responsive images for Jekyll. Automatically resizes images, supports all responsive methods (<code class="highlighter-rouge"><picture></code>, <code class="highlighter-rouge">srcset</code>, Imager.js, etc), super-flexible configuration.</li>
|
1222
|
+
<a href="https://github.com/wildlyinaccurate/jekyll-responsive-image">Jekyll Responsive Image</a>: Responsive images for Jekyll. Automatically resizes images, supports all responsive methods (<code class="language-plaintext highlighter-rouge"><picture></code>, <code class="language-plaintext highlighter-rouge">srcset</code>, Imager.js, etc), super-flexible configuration.</li>
|
1222
1223
|
<li>
|
1223
1224
|
<a href="https://github.com/matze/jekyll-ditaa">Ditaa Tag</a> by <a href="https://github.com/matze">matze</a>: Renders ASCII diagram art into PNG images and inserts a figure tag.</li>
|
1224
1225
|
<li>
|
@@ -1252,7 +1253,7 @@ rendering all the site (useful for sitemaps, feeds, etc).</p>
|
|
1252
1253
|
<li>
|
1253
1254
|
<a href="https://github.com/Ezmyrelda/twa">twa</a>: Twemoji Awesome plugin for Jekyll. Liquid tag allowing you to use twitter emoji in your jekyll pages.</li>
|
1254
1255
|
<li>
|
1255
|
-
<a href="https://github.com/dimitri-koenig/jekyll-plugins">Fetch remote file content</a> by <a href="https://www.dimitrikoenig.net/">Dimitri König</a>: Using <code class="highlighter-rouge">remote_file_content</code> tag you can fetch the content of a remote file and include it as if you would put the content right into your markdown file yourself. Very useful for including code from github repo’s to always have a current repo version.</li>
|
1256
|
+
<a href="https://github.com/dimitri-koenig/jekyll-plugins">Fetch remote file content</a> by <a href="https://www.dimitrikoenig.net/">Dimitri König</a>: Using <code class="language-plaintext highlighter-rouge">remote_file_content</code> tag you can fetch the content of a remote file and include it as if you would put the content right into your markdown file yourself. Very useful for including code from github repo’s to always have a current repo version.</li>
|
1256
1257
|
<li>
|
1257
1258
|
<a href="https://github.com/mnuessler/jekyll-asciinema">jekyll-asciinema</a>: A tag for embedding asciicasts recorded with <a href="https://asciinema.org">asciinema</a> in your Jekyll pages.</li>
|
1258
1259
|
<li>
|
@@ -1260,7 +1261,7 @@ rendering all the site (useful for sitemaps, feeds, etc).</p>
|
|
1260
1261
|
<li>
|
1261
1262
|
<a href="https://github.com/lawmurray/indii-jekyll-flickr">Jekyll Flickr Plugin</a> by <a href="http://www.indii.org">Lawrence Murray</a>: Embeds Flickr photosets (albums) as a gallery of thumbnails, with lightbox links to larger images.</li>
|
1262
1263
|
<li>
|
1263
|
-
<a href="https://github.com/paulrobertlloyd/jekyll-figure">jekyll-figure</a>: A liquid tag for Jekyll that generates <code class="highlighter-rouge"><figure></code> elements.</li>
|
1264
|
+
<a href="https://github.com/paulrobertlloyd/jekyll-figure">jekyll-figure</a>: A liquid tag for Jekyll that generates <code class="language-plaintext highlighter-rouge"><figure></code> elements.</li>
|
1264
1265
|
<li>
|
1265
1266
|
<a href="https://github.com/eug/jekyll-video-embed">Jekyll Video Embed</a>: It provides several tags to easily embed videos (e.g. Youtube, Vimeo, UStream and Ted Talks)</li>
|
1266
1267
|
<li>
|
@@ -1276,7 +1277,7 @@ rendering all the site (useful for sitemaps, feeds, etc).</p>
|
|
1276
1277
|
<li>
|
1277
1278
|
<a href="https://github.com/tnhu/jekyll-include-absolute-plugin">jekyll-include-absolute-plugin</a> by <a href="https://github.com/tnhu">Tan Nhu</a>: A Jekyll plugin to include a file from its path relative to Jekyll’s source folder.</li>
|
1278
1279
|
<li>
|
1279
|
-
<a href="https://github.com/mattg/jekyll-download-tag">Jekyll Download Tag</a>: A Liquid tag that acts like <code class="highlighter-rouge">include</code>, but for external resources.</li>
|
1280
|
+
<a href="https://github.com/mattg/jekyll-download-tag">Jekyll Download Tag</a>: A Liquid tag that acts like <code class="language-plaintext highlighter-rouge">include</code>, but for external resources.</li>
|
1280
1281
|
<li>
|
1281
1282
|
<a href="https://github.com/MediaComem/jekyll-brand-social-wall">Jekyll Brand Social Wall</a>: A jekyll plugin to generate a social wall with your favorite social networks</li>
|
1282
1283
|
<li>
|
@@ -1317,7 +1318,7 @@ plugin to generate publication lists from <a href="https://www.bibsonomy.org/">B
|
|
1317
1318
|
<li>
|
1318
1319
|
<a href="https://github.com/rsim/blog.rayapps.com/blob/master/_plugins/pygments_cache_patch.rb">Pygments Cache Path by Raimonds Simanovskis</a>: Plugin to cache syntax-highlighted code from Pygments.</li>
|
1319
1320
|
<li>
|
1320
|
-
<a href="https://github.com/LawrenceWoodman/related_posts-jekyll_plugin">Related Posts by Lawrence Woodman</a>: Overrides <code class="highlighter-rouge">site.related_posts</code> to use categories to assess relationship.</li>
|
1321
|
+
<a href="https://github.com/LawrenceWoodman/related_posts-jekyll_plugin">Related Posts by Lawrence Woodman</a>: Overrides <code class="language-plaintext highlighter-rouge">site.related_posts</code> to use categories to assess relationship.</li>
|
1321
1322
|
<li>
|
1322
1323
|
<a href="https://github.com/toshimaru/jekyll-tagging-related_posts">jekyll-tagging-related_posts</a>: Jekyll related_posts function based on tags (works on Jekyll3).</li>
|
1323
1324
|
<li>
|
@@ -1343,7 +1344,7 @@ plugin to generate publication lists from <a href="https://www.bibsonomy.org/">B
|
|
1343
1344
|
<li>
|
1344
1345
|
<a href="https://github.com/dannygarcia/grunt-jekyll">grunt-jekyll</a>: A straightforward <a href="http://gruntjs.com/">Grunt</a> plugin for Jekyll.</li>
|
1345
1346
|
<li>
|
1346
|
-
<a href="https://github.com/indirect/jekyll-postfiles">jekyll-postfiles</a>: Add <code class="highlighter-rouge">_postfiles</code> directory and <code class="highlighter-rouge">{{ postfile }}</code> tag so the files a post refers to will always be right there inside your repo.</li>
|
1347
|
+
<a href="https://github.com/indirect/jekyll-postfiles">jekyll-postfiles</a>: Add <code class="language-plaintext highlighter-rouge">_postfiles</code> directory and <code class="language-plaintext highlighter-rouge">{{ postfile }}</code> tag so the files a post refers to will always be right there inside your repo.</li>
|
1347
1348
|
<li>
|
1348
1349
|
<a href="http://jch.penibelst.de/">A layout that compresses HTML</a>: GitHub Pages compatible, configurable way to compress HTML files on site build.</li>
|
1349
1350
|
<li>
|
@@ -1357,13 +1358,13 @@ plugin to generate publication lists from <a href="https://www.bibsonomy.org/">B
|
|
1357
1358
|
<li>
|
1358
1359
|
<a href="https://github.com/vwochnik/jekyll-language-plugin">Jekyll Language Plugin</a>: Jekyll 3.0-compatible multi-language plugin for posts, pages and includes.</li>
|
1359
1360
|
<li>
|
1360
|
-
<a href="https://github.com/vwochnik/jekyll-deploy">Jekyll Deploy</a>: Adds a <code class="highlighter-rouge">deploy</code> sub-command to Jekyll.</li>
|
1361
|
+
<a href="https://github.com/vwochnik/jekyll-deploy">Jekyll Deploy</a>: Adds a <code class="language-plaintext highlighter-rouge">deploy</code> sub-command to Jekyll.</li>
|
1361
1362
|
<li>
|
1362
|
-
<a href="https://github.com/contentful/jekyll-contentful-data-import">Official Contentful Jekyll Plugin</a>: Adds a <code class="highlighter-rouge">contentful</code> sub-command to Jekyll to import data from Contentful.</li>
|
1363
|
+
<a href="https://github.com/contentful/jekyll-contentful-data-import">Official Contentful Jekyll Plugin</a>: Adds a <code class="language-plaintext highlighter-rouge">contentful</code> sub-command to Jekyll to import data from Contentful.</li>
|
1363
1364
|
<li>
|
1364
1365
|
<a href="https://github.com/KrzysiekJ/jekyll-paspagon">jekyll-paspagon</a>: Sell your posts in various formats for cryptocurrencies.</li>
|
1365
1366
|
<li>
|
1366
|
-
<a href="https://github.com/awood/hawkins">Hawkins</a>: Adds a <code class="highlighter-rouge">liveserve</code> sub-command to Jekyll that incorporates <a href="http://livereload.com/">LiveReload</a> into your pages while you preview them. No more hitting the refresh button in your browser!</li>
|
1367
|
+
<a href="https://github.com/awood/hawkins">Hawkins</a>: Adds a <code class="language-plaintext highlighter-rouge">liveserve</code> sub-command to Jekyll that incorporates <a href="http://livereload.com/">LiveReload</a> into your pages while you preview them. No more hitting the refresh button in your browser!</li>
|
1367
1368
|
<li>
|
1368
1369
|
<a href="https://github.com/vwochnik/jekyll-autoprefixer">Jekyll Autoprefixer</a>: Autoprefixer integration for Jekyll</li>
|
1369
1370
|
<li>
|
@@ -1379,7 +1380,7 @@ plugin to generate publication lists from <a href="https://www.bibsonomy.org/">B
|
|
1379
1380
|
<li>
|
1380
1381
|
<a href="https://github.com/snaptortoise/jekyll-pinboard-plugin">jekyll-pinboard</a>: Access your Pinboard bookmarks within your Jekyll theme.</li>
|
1381
1382
|
<li>
|
1382
|
-
<a href="https://github.com/mpchadwick/jekyll-migrate-permalink">jekyll-migrate-permalink</a>: Adds a <code class="highlighter-rouge">migrate-permalink</code> sub-command to help deal with side effects of changing your permalink.</li>
|
1383
|
+
<a href="https://github.com/mpchadwick/jekyll-migrate-permalink">jekyll-migrate-permalink</a>: Adds a <code class="language-plaintext highlighter-rouge">migrate-permalink</code> sub-command to help deal with side effects of changing your permalink.</li>
|
1383
1384
|
<li>
|
1384
1385
|
<a href="https://github.com/robcrocombe/jekyll-post">Jekyll-Post</a>: A CLI tool to easily draft, edit, and publish Jekyll posts.</li>
|
1385
1386
|
<li>
|
@@ -1688,7 +1689,7 @@ plugin to generate publication lists from <a href="https://www.bibsonomy.org/">B
|
|
1688
1689
|
<footer>
|
1689
1690
|
<div class="grid">
|
1690
1691
|
<div class="unit one-third center-on-mobiles">
|
1691
|
-
<p>The contents of this website are <br>©
|
1692
|
+
<p>The contents of this website are <br>© 2020 under the terms of the <a href="https://github.com/jekyll/jekyll/blob/master/LICENSE">MIT License</a>.</p>
|
1692
1693
|
</div>
|
1693
1694
|
<div class="unit two-thirds align-right center-on-mobiles">
|
1694
1695
|
<p>
|