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,681 @@
|
|
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>Plugins | Jekyll • Simple, blog-aware, static sites</title>
|
17
|
+
<meta name="generator" content="Jekyll v4.0.0" />
|
18
|
+
<meta property="og:title" content="Plugins" />
|
19
|
+
<meta property="og:locale" content="en_US" />
|
20
|
+
<meta name="description" content="You have 3 options for installing plugins:" />
|
21
|
+
<meta property="og:description" content="You have 3 options for installing plugins:" />
|
22
|
+
<link rel="canonical" href="https://jekyllrb.com/docs/plugins/installation/" />
|
23
|
+
<meta property="og:url" content="https://jekyllrb.com/docs/plugins/installation/" />
|
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="Plugins" />
|
31
|
+
<meta name="twitter:site" content="@jekyllrb" />
|
32
|
+
<meta name="google-site-verification" content="onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY" />
|
33
|
+
<script type="application/ld+json">
|
34
|
+
{"description":"You have 3 options for installing plugins:","@type":"BlogPosting","mainEntityOfPage":{"@type":"WebPage","@id":"https://jekyllrb.com/docs/plugins/installation/"},"headline":"Plugins","dateModified":"2019-09-11T07:30:27-07:00","url":"https://jekyllrb.com/docs/plugins/installation/","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/installation.md"><i class="fa fa-pencil"></i> Improve this page</a>
|
290
|
+
</div>
|
291
|
+
<h1>Plugins</h1>
|
292
|
+
<p>You have 3 options for installing plugins:</p>
|
293
|
+
|
294
|
+
<ol>
|
295
|
+
<li>
|
296
|
+
<p>In your site source root, make a <code class="highlighter-rouge">_plugins</code> directory. Place your plugins
|
297
|
+
here. Any file ending in <code class="highlighter-rouge">*.rb</code> inside this directory will be loaded before
|
298
|
+
Jekyll generates your site.</p>
|
299
|
+
</li>
|
300
|
+
<li>
|
301
|
+
<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
|
302
|
+
values of the gem names of the plugins you’d like to use. An example:</p>
|
303
|
+
|
304
|
+
<div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="c1"># This will require each of these plugins automatically.</span>
|
305
|
+
<span class="na">plugins</span><span class="pi">:</span>
|
306
|
+
<span class="pi">-</span> <span class="s">jekyll-gist</span>
|
307
|
+
<span class="pi">-</span> <span class="s">jekyll-coffeescript</span>
|
308
|
+
<span class="pi">-</span> <span class="s">jekyll-assets</span>
|
309
|
+
<span class="pi">-</span> <span class="s">another-jekyll-plugin</span>
|
310
|
+
</code></pre></div> </div>
|
311
|
+
|
312
|
+
<p>Then install your plugins using <code class="highlighter-rouge">gem install jekyll-gist jekyll-coffeescript jekyll-assets another-jekyll-plugin</code></p>
|
313
|
+
</li>
|
314
|
+
<li>
|
315
|
+
<p>Add the relevant plugins to a Bundler group in your <code class="highlighter-rouge">Gemfile</code>. An
|
316
|
+
example:</p>
|
317
|
+
|
318
|
+
<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>
|
319
|
+
<span class="n">gem</span> <span class="s2">"jekyll-gist"</span>
|
320
|
+
<span class="n">gem</span> <span class="s2">"jekyll-coffeescript"</span>
|
321
|
+
<span class="n">gem</span> <span class="s2">"jekyll-assets"</span>
|
322
|
+
<span class="n">gem</span> <span class="s2">"another-jekyll-plugin"</span>
|
323
|
+
<span class="k">end</span>
|
324
|
+
</code></pre></div> </div>
|
325
|
+
|
326
|
+
<p>Now you need to install all plugins from your Bundler group by running single command <code class="highlighter-rouge">bundle install</code>.</p>
|
327
|
+
</li>
|
328
|
+
</ol>
|
329
|
+
|
330
|
+
<div class="note info">
|
331
|
+
<h5>Plugins on GitHub Pages</h5>
|
332
|
+
<p>
|
333
|
+
<a href="https://pages.github.com/">GitHub Pages</a> is powered by Jekyll.
|
334
|
+
All Pages sites are generated using the <code>--safe</code> option
|
335
|
+
to disable plugins (with the exception of some
|
336
|
+
<a href="https://pages.github.com/versions">whitelisted plugins</a>) for
|
337
|
+
security reasons. Unfortunately, this means
|
338
|
+
your plugins won’t work if you’re deploying to GitHub Pages.<br /><br />
|
339
|
+
You can still use GitHub Pages to publish your site, but you’ll need to
|
340
|
+
convert the site locally and push the generated static files to your GitHub
|
341
|
+
repository instead of the Jekyll source files.
|
342
|
+
</p>
|
343
|
+
</div>
|
344
|
+
|
345
|
+
<div class="note info">
|
346
|
+
<h5>
|
347
|
+
<code>_plugins</code>, <code>_config.yml</code> and <code>Gemfile</code>
|
348
|
+
can be used simultaneously
|
349
|
+
</h5>
|
350
|
+
<p>
|
351
|
+
You may use any of the aforementioned plugin options simultaneously in the
|
352
|
+
same site if you so choose. Use of one does not restrict the use of the
|
353
|
+
others.
|
354
|
+
</p>
|
355
|
+
</div>
|
356
|
+
|
357
|
+
<h3 id="the-jekyll_plugins-group">The jekyll_plugins group</h3>
|
358
|
+
|
359
|
+
<p>Jekyll gives this particular group of gems in your <code class="highlighter-rouge">Gemfile</code> a different
|
360
|
+
treatment. Any gem included in this group is loaded before Jekyll starts
|
361
|
+
processing the rest of your source directory.</p>
|
362
|
+
|
363
|
+
<p>A gem included here will be activated even if its not explicitly listed under
|
364
|
+
the <code class="highlighter-rouge">plugins:</code> key in your site’s config file.</p>
|
365
|
+
|
366
|
+
<div class="note warning">
|
367
|
+
<p>
|
368
|
+
Gems included in the <code>:jekyll-plugins</code> group are activated
|
369
|
+
regardless of the <code>--safe</code> mode setting. Be aware of what
|
370
|
+
gems are included under this group!
|
371
|
+
</p>
|
372
|
+
</div>
|
373
|
+
|
374
|
+
</article>
|
375
|
+
</div>
|
376
|
+
|
377
|
+
<div class="unit one-fifth hide-on-mobiles">
|
378
|
+
<aside>
|
379
|
+
|
380
|
+
<h4>Getting Started</h4>
|
381
|
+
<ul>
|
382
|
+
|
383
|
+
|
384
|
+
<li>
|
385
|
+
<a href="/docs/">
|
386
|
+
Quickstart
|
387
|
+
</a>
|
388
|
+
</li>
|
389
|
+
|
390
|
+
|
391
|
+
<li>
|
392
|
+
<a href="/docs/ruby-101/">
|
393
|
+
Ruby 101
|
394
|
+
</a>
|
395
|
+
</li>
|
396
|
+
|
397
|
+
|
398
|
+
<li>
|
399
|
+
<a href="/docs/installation/">
|
400
|
+
Installation
|
401
|
+
</a>
|
402
|
+
</li>
|
403
|
+
|
404
|
+
|
405
|
+
<li>
|
406
|
+
<a href="/docs/community/">
|
407
|
+
Community
|
408
|
+
</a>
|
409
|
+
</li>
|
410
|
+
|
411
|
+
|
412
|
+
<li>
|
413
|
+
<a href="/docs/step-by-step/01-setup/">
|
414
|
+
Step by Step Tutorial
|
415
|
+
</a>
|
416
|
+
</li>
|
417
|
+
|
418
|
+
</ul>
|
419
|
+
|
420
|
+
<h4>Build</h4>
|
421
|
+
<ul>
|
422
|
+
|
423
|
+
|
424
|
+
<li>
|
425
|
+
<a href="/docs/usage/">
|
426
|
+
Command Line Usage
|
427
|
+
</a>
|
428
|
+
</li>
|
429
|
+
|
430
|
+
|
431
|
+
<li>
|
432
|
+
<a href="/docs/configuration/">
|
433
|
+
Configuration
|
434
|
+
</a>
|
435
|
+
</li>
|
436
|
+
|
437
|
+
</ul>
|
438
|
+
|
439
|
+
<h4>Content</h4>
|
440
|
+
<ul>
|
441
|
+
|
442
|
+
|
443
|
+
<li>
|
444
|
+
<a href="/docs/pages/">
|
445
|
+
Pages
|
446
|
+
</a>
|
447
|
+
</li>
|
448
|
+
|
449
|
+
|
450
|
+
<li>
|
451
|
+
<a href="/docs/posts/">
|
452
|
+
Posts
|
453
|
+
</a>
|
454
|
+
</li>
|
455
|
+
|
456
|
+
|
457
|
+
<li>
|
458
|
+
<a href="/docs/front-matter/">
|
459
|
+
Front Matter
|
460
|
+
</a>
|
461
|
+
</li>
|
462
|
+
|
463
|
+
|
464
|
+
<li>
|
465
|
+
<a href="/docs/collections/">
|
466
|
+
Collections
|
467
|
+
</a>
|
468
|
+
</li>
|
469
|
+
|
470
|
+
|
471
|
+
<li>
|
472
|
+
<a href="/docs/datafiles/">
|
473
|
+
Data Files
|
474
|
+
</a>
|
475
|
+
</li>
|
476
|
+
|
477
|
+
|
478
|
+
<li>
|
479
|
+
<a href="/docs/assets/">
|
480
|
+
Assets
|
481
|
+
</a>
|
482
|
+
</li>
|
483
|
+
|
484
|
+
|
485
|
+
<li>
|
486
|
+
<a href="/docs/static-files/">
|
487
|
+
Static Files
|
488
|
+
</a>
|
489
|
+
</li>
|
490
|
+
|
491
|
+
</ul>
|
492
|
+
|
493
|
+
<h4>Site Structure</h4>
|
494
|
+
<ul>
|
495
|
+
|
496
|
+
|
497
|
+
<li>
|
498
|
+
<a href="/docs/structure/">
|
499
|
+
Directory Structure
|
500
|
+
</a>
|
501
|
+
</li>
|
502
|
+
|
503
|
+
|
504
|
+
<li>
|
505
|
+
<a href="/docs/liquid/">
|
506
|
+
Liquid
|
507
|
+
</a>
|
508
|
+
</li>
|
509
|
+
|
510
|
+
|
511
|
+
<li>
|
512
|
+
<a href="/docs/variables/">
|
513
|
+
Variables
|
514
|
+
</a>
|
515
|
+
</li>
|
516
|
+
|
517
|
+
|
518
|
+
<li>
|
519
|
+
<a href="/docs/includes/">
|
520
|
+
Includes
|
521
|
+
</a>
|
522
|
+
</li>
|
523
|
+
|
524
|
+
|
525
|
+
<li>
|
526
|
+
<a href="/docs/layouts/">
|
527
|
+
Layouts
|
528
|
+
</a>
|
529
|
+
</li>
|
530
|
+
|
531
|
+
|
532
|
+
<li>
|
533
|
+
<a href="/docs/permalinks/">
|
534
|
+
Permalinks
|
535
|
+
</a>
|
536
|
+
</li>
|
537
|
+
|
538
|
+
|
539
|
+
<li>
|
540
|
+
<a href="/docs/themes/">
|
541
|
+
Themes
|
542
|
+
</a>
|
543
|
+
</li>
|
544
|
+
|
545
|
+
|
546
|
+
<li>
|
547
|
+
<a href="/docs/pagination/">
|
548
|
+
Pagination
|
549
|
+
</a>
|
550
|
+
</li>
|
551
|
+
|
552
|
+
</ul>
|
553
|
+
|
554
|
+
<h4>Guides</h4>
|
555
|
+
<ul>
|
556
|
+
|
557
|
+
|
558
|
+
<li>
|
559
|
+
<a href="/docs/plugins/">
|
560
|
+
Plugins
|
561
|
+
</a>
|
562
|
+
</li>
|
563
|
+
|
564
|
+
|
565
|
+
<li>
|
566
|
+
<a href="/docs/migrations/">
|
567
|
+
Blog Migrations
|
568
|
+
</a>
|
569
|
+
</li>
|
570
|
+
|
571
|
+
|
572
|
+
<li>
|
573
|
+
<a href="/docs/upgrading/">
|
574
|
+
Upgrading
|
575
|
+
</a>
|
576
|
+
</li>
|
577
|
+
|
578
|
+
|
579
|
+
<li>
|
580
|
+
<a href="/docs/deployment/">
|
581
|
+
Deployment
|
582
|
+
</a>
|
583
|
+
</li>
|
584
|
+
|
585
|
+
</ul>
|
586
|
+
|
587
|
+
</aside>
|
588
|
+
</div>
|
589
|
+
|
590
|
+
|
591
|
+
<div class="clear"></div>
|
592
|
+
|
593
|
+
</div>
|
594
|
+
</section>
|
595
|
+
|
596
|
+
|
597
|
+
<footer>
|
598
|
+
<div class="grid">
|
599
|
+
<div class="unit one-third center-on-mobiles">
|
600
|
+
<p>Jekyll is lovingly maintained by the <a href="/team/">core team</a> of volunteers. </p>
|
601
|
+
<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>
|
602
|
+
</div>
|
603
|
+
<div class="unit two-thirds align-right center-on-mobiles">
|
604
|
+
<p>
|
605
|
+
Proudly hosted by
|
606
|
+
<a href="https://github.com">
|
607
|
+
<img src="/img/footer-logo.png" width="100" height="30" alt="GitHub • Social coding">
|
608
|
+
</a>
|
609
|
+
</p>
|
610
|
+
</div>
|
611
|
+
<div class="unit two-thirds align-right center-on-mobiles">
|
612
|
+
<p>
|
613
|
+
Jekyll is funded thanks to its
|
614
|
+
<a href="https://github.com/jekyll/jekyll#sponsors">
|
615
|
+
sponsors!
|
616
|
+
</a>
|
617
|
+
</p>
|
618
|
+
</div>
|
619
|
+
</div>
|
620
|
+
</footer>
|
621
|
+
|
622
|
+
<script>
|
623
|
+
var anchorForId = function (id) {
|
624
|
+
var anchor = document.createElement("a");
|
625
|
+
anchor.className = "header-link";
|
626
|
+
anchor.href = "#" + id;
|
627
|
+
anchor.innerHTML = "<span class=\"sr-only\">Permalink</span><i class=\"fa fa-link\"></i>";
|
628
|
+
anchor.title = "Permalink";
|
629
|
+
return anchor;
|
630
|
+
};
|
631
|
+
|
632
|
+
var linkifyAnchors = function (level, containingElement) {
|
633
|
+
var headers = containingElement.getElementsByTagName("h" + level);
|
634
|
+
for (var h = 0; h < headers.length; h++) {
|
635
|
+
var header = headers[h];
|
636
|
+
|
637
|
+
if (typeof header.id !== "undefined" && header.id !== "") {
|
638
|
+
header.appendChild(anchorForId(header.id));
|
639
|
+
}
|
640
|
+
}
|
641
|
+
};
|
642
|
+
|
643
|
+
document.onreadystatechange = function () {
|
644
|
+
if (this.readyState === "complete") {
|
645
|
+
var contentBlock = document.getElementsByClassName("docs")[0] || document.getElementsByClassName("news")[0];
|
646
|
+
if (!contentBlock) {
|
647
|
+
return;
|
648
|
+
}
|
649
|
+
for (var level = 1; level <= 6; level++) {
|
650
|
+
linkifyAnchors(level, contentBlock);
|
651
|
+
}
|
652
|
+
}
|
653
|
+
};
|
654
|
+
</script>
|
655
|
+
|
656
|
+
|
657
|
+
<!-- Google Analytics (https://www.google.com/analytics) -->
|
658
|
+
<script>
|
659
|
+
!function(j,e,k,y,l,L){j.GoogleAnalyticsObject=y,j[y]||(j[y]=function(){
|
660
|
+
(j[y].q=j[y].q||[]).push(arguments)}),j[y].l=+new Date,l=e.createElement(k),
|
661
|
+
L=e.getElementsByTagName(k)[0],l.src='https://www.google-analytics.com/analytics.js',
|
662
|
+
L.parentNode.insertBefore(l,L)}(window,document,'script','ga');
|
663
|
+
|
664
|
+
ga('create', 'UA-50755011-1', 'jekyllrb.com');
|
665
|
+
ga('send', 'pageview');
|
666
|
+
|
667
|
+
</script>
|
668
|
+
|
669
|
+
|
670
|
+
<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.js"></script>
|
671
|
+
<script type="text/javascript"> docsearch({
|
672
|
+
apiKey: '50fe39c839958dfad797000f33e2ec17',
|
673
|
+
indexName: 'jekyllrb',
|
674
|
+
inputSelector: '#docsearch-input',
|
675
|
+
enhancedSearchInput: true,
|
676
|
+
debug: false // Set debug to true if you want to inspect the dropdown
|
677
|
+
});
|
678
|
+
</script>
|
679
|
+
|
680
|
+
</body>
|
681
|
+
</html>
|