jekyll-docs 3.6.2.0 → 3.7.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/lib/jekyll-docs.rb +7 -5
- data/site/404.html +5 -6
- data/site/community/index.html +9 -297
- data/site/conduct/index.html +3 -2
- data/site/css/screen.css +1 -1
- data/site/docs/assets/index.html +46 -30
- data/site/docs/code_of_conduct/index.html +44 -28
- data/site/docs/collections/index.html +85 -48
- data/site/docs/conduct/index.html +44 -28
- data/site/docs/configuration/index.html +66 -35
- data/site/docs/continuous-integration/buddyworks/index.html +55 -39
- data/site/docs/continuous-integration/circleci/index.html +65 -49
- data/site/docs/continuous-integration/index.html +44 -28
- data/site/docs/continuous-integration/travis-ci/index.html +45 -29
- data/site/docs/contributing/index.html +53 -33
- data/site/docs/datafiles/index.html +71 -62
- data/site/docs/deployment-methods/index.html +49 -33
- data/site/docs/drafts/index.html +44 -28
- data/site/docs/extras/index.html +44 -28
- data/site/docs/frontmatter/index.html +55 -39
- data/site/docs/github-pages/index.html +107 -111
- data/site/docs/history/index.html +299 -115
- data/site/docs/home/index.html +45 -29
- data/site/docs/includes/index.html +51 -34
- data/site/docs/index.html +3 -2
- data/site/docs/installation/index.html +65 -49
- data/site/docs/maintaining/affinity-team-captain/index.html +46 -30
- data/site/docs/maintaining/avoiding-burnout/index.html +44 -28
- data/site/docs/maintaining/becoming-a-maintainer/index.html +45 -29
- data/site/docs/maintaining/index.html +44 -28
- data/site/docs/maintaining/merging-a-pull-request/index.html +45 -29
- data/site/docs/maintaining/reviewing-a-pull-request/index.html +45 -29
- data/site/docs/maintaining/special-labels/index.html +44 -28
- data/site/docs/maintaining/triaging-an-issue/index.html +45 -29
- data/site/docs/migrations/index.html +44 -28
- data/site/docs/pages/index.html +48 -32
- data/site/docs/pagination/index.html +105 -84
- data/site/docs/permalinks/index.html +48 -32
- data/site/docs/plugins/index.html +97 -58
- data/site/docs/posts/index.html +126 -71
- data/site/docs/quickstart/index.html +48 -32
- data/site/docs/resources/index.html +46 -29
- data/site/docs/sites/index.html +44 -28
- data/site/docs/static-files/index.html +44 -28
- data/site/docs/structure/index.html +44 -28
- data/site/docs/support/index.html +725 -0
- data/site/docs/templates/index.html +77 -54
- data/site/docs/themes/index.html +63 -37
- data/site/docs/troubleshooting/index.html +56 -40
- data/site/docs/upgrading/0-to-2/index.html +45 -29
- data/site/docs/upgrading/2-to-3/index.html +50 -34
- data/site/docs/upgrading/index.html +63 -31
- data/site/docs/usage/index.html +68 -44
- data/site/docs/variables/index.html +44 -28
- data/site/docs/windows/index.html +66 -54
- data/site/feed.xml +81 -108
- data/site/github.html +3 -2
- data/site/help/index.html +66 -46
- data/site/img/jekyll-sticker.jpg +0 -0
- data/site/img/jekylllayoutconcept.png +0 -0
- data/site/img/twitter-card.png +0 -0
- data/site/index.html +43 -27
- data/site/issues.html +3 -2
- data/site/jekyllconf/index.html +315 -0
- data/site/latest_version.txt +1 -1
- data/site/news/2013/05/05/jekyll-1-0-0-released/index.html +69 -33
- data/site/news/2013/05/08/jekyll-1-0-1-released/index.html +69 -33
- data/site/news/2013/05/12/jekyll-1-0-2-released/index.html +69 -33
- data/site/news/2013/06/07/jekyll-1-0-3-released/index.html +69 -33
- data/site/news/2013/07/14/jekyll-1-1-0-released/index.html +69 -33
- data/site/news/2013/07/24/jekyll-1-1-1-released/index.html +81 -45
- data/site/news/2013/07/25/jekyll-1-0-4-released/index.html +69 -33
- data/site/news/2013/07/25/jekyll-1-1-2-released/index.html +69 -33
- data/site/news/2013/09/06/jekyll-1-2-0-released/index.html +69 -33
- data/site/news/2013/09/14/jekyll-1-2-1-released/index.html +69 -33
- data/site/news/2013/10/28/jekyll-1-3-0-rc1-released/index.html +69 -33
- data/site/news/2013/11/04/jekyll-1-3-0-released/index.html +69 -33
- data/site/news/2013/11/26/jekyll-1-3-1-released/index.html +69 -33
- data/site/news/2013/12/07/jekyll-1-4-0-released/index.html +69 -33
- data/site/news/2013/12/09/jekyll-1-4-1-released/index.html +69 -33
- data/site/news/2013/12/16/jekyll-1-4-2-released/index.html +69 -33
- data/site/news/2014/01/13/jekyll-1-4-3-released/index.html +69 -33
- data/site/news/2014/03/24/jekyll-1-5-0-released/index.html +69 -33
- data/site/news/2014/03/27/jekyll-1-5-1-released/index.html +69 -33
- data/site/news/2014/05/06/jekyll-turns-2-0-0/index.html +69 -33
- data/site/news/2014/05/08/jekyll-2-0-3-released/index.html +69 -33
- data/site/news/2014/06/04/jekyll-stickers-1-dollar-stickermule/index.html +69 -33
- data/site/news/2014/06/28/jekyll-turns-21-i-mean-2-1-0/index.html +69 -33
- data/site/news/2014/07/01/jekyll-2-1-1-released/index.html +69 -33
- data/site/news/2014/07/29/jekyll-2-2-0-released/index.html +69 -33
- data/site/news/2014/08/10/jekyll-2-3-0-released/index.html +69 -33
- data/site/news/2014/09/09/jekyll-2-4-0-released/index.html +69 -33
- data/site/news/2014/11/05/jekylls-midlife-crisis-jekyll-turns-2-5-0/index.html +70 -34
- data/site/news/2014/11/09/jekyll-2-5-1-released/index.html +69 -33
- data/site/news/2014/11/12/jekyll-2-5-2-released/index.html +69 -33
- data/site/news/2014/12/17/alfredxing-welcome-to-jekyll-core/index.html +69 -33
- data/site/news/2014/12/22/jekyll-2-5-3-released/index.html +70 -34
- data/site/news/2015/01/20/jekyll-meet-and-greet/index.html +69 -33
- data/site/news/2015/01/24/jekyll-3-0-0-beta1-released/index.html +70 -34
- data/site/news/2015/02/26/introducing-jekyll-talk/index.html +69 -33
- data/site/news/2015/10/26/jekyll-3-0-released/index.html +69 -33
- data/site/news/2015/11/17/jekyll-3-0-1-released/index.html +69 -33
- data/site/news/2016/01/20/jekyll-3-0-2-released/index.html +69 -33
- data/site/news/2016/01/24/jekyll-3-1-0-released/index.html +69 -33
- data/site/news/2016/01/28/jekyll-3-1-1-released/index.html +71 -35
- data/site/news/2016/02/08/jekyll-3-0-3-released/index.html +69 -33
- data/site/news/2016/02/19/jekyll-3-1-2-released/index.html +69 -33
- data/site/news/2016/03/10/making-it-easier-to-contribute-to-jekyll/index.html +69 -33
- data/site/news/2016/04/19/jekyll-3-0-4-released/index.html +69 -33
- data/site/news/2016/04/19/jekyll-3-1-3-released/index.html +69 -33
- data/site/news/2016/04/26/jekyll-3-0-5-released/index.html +69 -33
- data/site/news/2016/05/18/jekyll-3-1-4-released/index.html +69 -33
- data/site/news/2016/05/18/jekyll-3-1-5-released/index.html +69 -33
- data/site/news/2016/05/19/jekyll-3-1-6-released/index.html +69 -33
- data/site/news/2016/06/03/update-on-jekyll-s-google-summer-of-code-projects/index.html +69 -33
- data/site/news/2016/07/26/jekyll-3-2-0-released/index.html +69 -33
- data/site/news/2016/08/02/jekyll-3-2-1-released/index.html +70 -34
- data/site/news/2016/08/24/jekyll-admin-initial-release/index.html +69 -33
- data/site/news/2016/10/06/jekyll-3-3-is-here/index.html +69 -33
- data/site/news/2016/11/14/jekyll-3-3-1-released/index.html +69 -33
- data/site/news/2017/01/02/jekyll-3-7-0-released/index.html +626 -0
- data/site/news/2017/01/18/jekyll-3-4-0-released/index.html +69 -33
- data/site/news/2017/03/02/jekyll-3-4-1-released/index.html +69 -33
- data/site/news/2017/03/09/jekyll-3-4-2-released/index.html +69 -33
- data/site/news/2017/03/21/jekyll-3-4-3-released/index.html +69 -33
- data/site/news/2017/06/15/jekyll-3-5-0-released/index.html +71 -35
- data/site/news/2017/07/17/jekyll-3-5-1-released/index.html +69 -33
- data/site/news/2017/08/12/jekyll-3-5-2-released/index.html +69 -33
- data/site/news/2017/09/21/jekyll-3-6-0-released/index.html +69 -33
- data/site/news/2017/10/19/diversity-open-source/index.html +631 -0
- data/site/news/2017/10/21/jekyll-3-6-2-released/index.html +627 -0
- data/site/news/index.html +270 -49
- data/site/news/releases/index.html +204 -49
- data/site/redirects.json +1 -0
- data/site/sitemap.xml +77 -57
- data/site/tutorials/convert-site-to-jekyll/index.html +58 -31
- data/site/tutorials/custom-404-page/index.html +70 -42
- data/site/tutorials/home/index.html +53 -29
- data/site/tutorials/index.html +3 -2
- data/site/tutorials/navigation/index.html +70 -38
- data/site/tutorials/orderofinterpretation/index.html +61 -34
- data/site/tutorials/video-walkthroughs/index.html +352 -0
- metadata +17 -12
- data/site/CNAME +0 -1
- data/site/icomoon-selection.json +0 -96
- data/site/readme.md +0 -23
@@ -4,14 +4,16 @@
|
|
4
4
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
5
5
|
<meta charset="UTF-8">
|
6
6
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
7
|
-
<meta name="generator" content="Jekyll v3.
|
7
|
+
<meta name="generator" content="Jekyll v3.7.0">
|
8
8
|
<link type="application/atom+xml" rel="alternate" href="https://jekyllrb.com/feed.xml" title="Jekyll • Simple, blog-aware, static sites">
|
9
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
10
|
<link rel="stylesheet" href="//fonts.googleapis.com/css?family=Lato:300,300italic,400,400italic,700,700italic,900">
|
11
|
+
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css">
|
11
12
|
<link rel="stylesheet" href="/css/screen.css">
|
12
13
|
<link rel="icon" type="image/x-icon" href="/favicon.ico">
|
13
|
-
<!-- Begin Jekyll SEO tag v2.
|
14
|
+
<!-- Begin Jekyll SEO tag v2.4.0 -->
|
14
15
|
<title>Permalinks | Jekyll • Simple, blog-aware, static sites</title>
|
16
|
+
<meta name="generator" content="Jekyll v3.7.0">
|
15
17
|
<meta property="og:title" content="Permalinks">
|
16
18
|
<meta property="og:locale" content="en_US">
|
17
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.">
|
@@ -20,12 +22,12 @@
|
|
20
22
|
<meta property="og:url" content="https://jekyllrb.com/docs/permalinks/">
|
21
23
|
<meta property="og:site_name" content="Jekyll • Simple, blog-aware, static sites">
|
22
24
|
<meta property="og:type" content="article">
|
23
|
-
<meta property="article:published_time" content="
|
25
|
+
<meta property="article:published_time" content="2018-01-03T02:41:17-08:00">
|
24
26
|
<meta name="twitter:card" content="summary">
|
25
27
|
<meta name="twitter:site" content="@jekyllrb">
|
26
28
|
<meta name="google-site-verification" content="onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY">
|
27
29
|
<script type="application/ld+json">
|
28
|
-
{"
|
30
|
+
{"headline":"Permalinks","dateModified":"2018-01-03T02:41:17-08:00","datePublished":"2018-01-03T02:41:17-08:00","mainEntityOfPage":{"@type":"WebPage","@id":"https://jekyllrb.com/docs/permalinks/"},"publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://jekyllrb.com/img/logo-2x.png"}},"url":"https://jekyllrb.com/docs/permalinks/","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.","@type":"BlogPosting","@context":"http://schema.org"}</script>
|
29
31
|
<!-- End Jekyll SEO tag -->
|
30
32
|
|
31
33
|
<!--[if lt IE 9]>
|
@@ -37,8 +39,17 @@
|
|
37
39
|
|
38
40
|
<body class="wrap">
|
39
41
|
<header>
|
40
|
-
<
|
41
|
-
<
|
42
|
+
<div class="flexbox">
|
43
|
+
<div class="center-on-mobiles">
|
44
|
+
<h1>
|
45
|
+
<a href="/" class="logo">
|
46
|
+
<span class="sr-only">Jekyll</span>
|
47
|
+
<img src="/img/logo-2x.png" width="140" height="65" alt="Jekyll Logo">
|
48
|
+
</a>
|
49
|
+
</h1>
|
50
|
+
</div>
|
51
|
+
<nav class="main-nav hide-on-mobiles">
|
52
|
+
<ul>
|
42
53
|
<li class="">
|
43
54
|
<a href="/">Home</a>
|
44
55
|
</li>
|
@@ -48,29 +59,29 @@
|
|
48
59
|
<li class="">
|
49
60
|
<a href="/news/">News</a>
|
50
61
|
</li>
|
51
|
-
<li class="">
|
52
|
-
<a href="/community/">Community</a>
|
53
|
-
</li>
|
54
62
|
<li class="">
|
55
63
|
<a href="/help/">Help</a>
|
56
64
|
</li>
|
57
|
-
<li>
|
58
|
-
<a href="https://github.com/jekyll/jekyll">GitHub</a>
|
59
|
-
</li>
|
60
65
|
</ul>
|
61
66
|
|
62
|
-
|
63
|
-
|
64
|
-
|
65
|
-
|
66
|
-
<a href="/">
|
67
|
-
<span class="sr-only">Jekyll</span>
|
68
|
-
<img src="/img/logo-2x.png" width="249" height="115" alt="Jekyll Logo">
|
69
|
-
</a>
|
70
|
-
</h1>
|
67
|
+
</nav>
|
68
|
+
<div class="search hide-on-mobiles">
|
69
|
+
<input type="text" id="docsearch-input" placeholder="Search the docs…">
|
70
|
+
|
71
71
|
</div>
|
72
|
-
<
|
72
|
+
<div class="meta hide-on-mobiles">
|
73
73
|
<ul>
|
74
|
+
<li>
|
75
|
+
<a href="https://github.com/jekyll/jekyll/releases/tag/v3.7.0">v3.7.0</a>
|
76
|
+
</li>
|
77
|
+
<li>
|
78
|
+
<a href="https://github.com/jekyll/jekyll">GitHub</a>
|
79
|
+
</li>
|
80
|
+
</ul>
|
81
|
+
</div>
|
82
|
+
</div>
|
83
|
+
<nav class="mobile-nav show-on-mobiles">
|
84
|
+
<ul>
|
74
85
|
<li class="">
|
75
86
|
<a href="/">Home</a>
|
76
87
|
</li>
|
@@ -80,9 +91,6 @@
|
|
80
91
|
<li class="">
|
81
92
|
<a href="/news/">News</a>
|
82
93
|
</li>
|
83
|
-
<li class="">
|
84
|
-
<a href="/community/">Community</a>
|
85
|
-
</li>
|
86
94
|
<li class="">
|
87
95
|
<a href="/help/">Help</a>
|
88
96
|
</li>
|
@@ -91,8 +99,7 @@
|
|
91
99
|
</li>
|
92
100
|
</ul>
|
93
101
|
|
94
|
-
|
95
|
-
</div>
|
102
|
+
</nav>
|
96
103
|
</header>
|
97
104
|
|
98
105
|
|
@@ -642,10 +649,10 @@ Jekyll supports a flexible way to build permalinks, allowing you to leverage var
|
|
642
649
|
|
643
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>
|
644
651
|
|
645
|
-
<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code
|
646
|
-
title
|
647
|
-
permalink
|
648
|
-
|
652
|
+
<div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nn">---</span>
|
653
|
+
<span class="na">title</span><span class="pi">:</span> <span class="s">My page</span>
|
654
|
+
<span class="na">permalink</span><span class="pi">:</span> <span class="s">mypageurl.html</span>
|
655
|
+
<span class="nn">---</span>
|
649
656
|
</code></pre></div></div>
|
650
657
|
|
651
658
|
<h2 id="extensionless-permalinks">Extensionless permalinks with no trailing slashes</h2>
|
@@ -952,7 +959,7 @@ permalink: mypageurl.html
|
|
952
959
|
<footer>
|
953
960
|
<div class="grid">
|
954
961
|
<div class="unit one-third center-on-mobiles">
|
955
|
-
<p>The contents of this website are <br>©
|
962
|
+
<p>The contents of this website are <br>© 2018 under the terms of the <a href="https://github.com/jekyll/jekyll/blob/master/LICENSE">MIT License</a>.</p>
|
956
963
|
</div>
|
957
964
|
<div class="unit two-thirds align-right center-on-mobiles">
|
958
965
|
<p>
|
@@ -1030,6 +1037,15 @@ permalink: mypageurl.html
|
|
1030
1037
|
</script>
|
1031
1038
|
|
1032
1039
|
|
1040
|
+
<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.js"></script>
|
1041
|
+
<script type="text/javascript"> docsearch({
|
1042
|
+
apiKey: '50fe39c839958dfad797000f33e2ec17',
|
1043
|
+
indexName: 'jekyllrb',
|
1044
|
+
inputSelector: '#docsearch-input',
|
1045
|
+
enhancedSearchInput: true,
|
1046
|
+
debug: false // Set debug to true if you want to inspect the dropdown
|
1047
|
+
});
|
1048
|
+
</script>
|
1033
1049
|
|
1034
1050
|
</body>
|
1035
1051
|
</html>
|
@@ -4,14 +4,16 @@
|
|
4
4
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
5
5
|
<meta charset="UTF-8">
|
6
6
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
7
|
-
<meta name="generator" content="Jekyll v3.
|
7
|
+
<meta name="generator" content="Jekyll v3.7.0">
|
8
8
|
<link type="application/atom+xml" rel="alternate" href="https://jekyllrb.com/feed.xml" title="Jekyll • Simple, blog-aware, static sites">
|
9
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
10
|
<link rel="stylesheet" href="//fonts.googleapis.com/css?family=Lato:300,300italic,400,400italic,700,700italic,900">
|
11
|
+
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css">
|
11
12
|
<link rel="stylesheet" href="/css/screen.css">
|
12
13
|
<link rel="icon" type="image/x-icon" href="/favicon.ico">
|
13
|
-
<!-- Begin Jekyll SEO tag v2.
|
14
|
+
<!-- Begin Jekyll SEO tag v2.4.0 -->
|
14
15
|
<title>Plugins | Jekyll • Simple, blog-aware, static sites</title>
|
16
|
+
<meta name="generator" content="Jekyll v3.7.0">
|
15
17
|
<meta property="og:title" content="Plugins">
|
16
18
|
<meta property="og:locale" content="en_US">
|
17
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.">
|
@@ -20,12 +22,12 @@
|
|
20
22
|
<meta property="og:url" content="https://jekyllrb.com/docs/plugins/">
|
21
23
|
<meta property="og:site_name" content="Jekyll • Simple, blog-aware, static sites">
|
22
24
|
<meta property="og:type" content="article">
|
23
|
-
<meta property="article:published_time" content="
|
25
|
+
<meta property="article:published_time" content="2018-01-03T02:41:17-08:00">
|
24
26
|
<meta name="twitter:card" content="summary">
|
25
27
|
<meta name="twitter:site" content="@jekyllrb">
|
26
28
|
<meta name="google-site-verification" content="onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY">
|
27
29
|
<script type="application/ld+json">
|
28
|
-
{"
|
30
|
+
{"headline":"Plugins","dateModified":"2018-01-03T02:41:17-08:00","datePublished":"2018-01-03T02:41:17-08:00","mainEntityOfPage":{"@type":"WebPage","@id":"https://jekyllrb.com/docs/plugins/"},"publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://jekyllrb.com/img/logo-2x.png"}},"url":"https://jekyllrb.com/docs/plugins/","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.","@type":"BlogPosting","@context":"http://schema.org"}</script>
|
29
31
|
<!-- End Jekyll SEO tag -->
|
30
32
|
|
31
33
|
<!--[if lt IE 9]>
|
@@ -37,8 +39,17 @@
|
|
37
39
|
|
38
40
|
<body class="wrap">
|
39
41
|
<header>
|
40
|
-
<
|
41
|
-
<
|
42
|
+
<div class="flexbox">
|
43
|
+
<div class="center-on-mobiles">
|
44
|
+
<h1>
|
45
|
+
<a href="/" class="logo">
|
46
|
+
<span class="sr-only">Jekyll</span>
|
47
|
+
<img src="/img/logo-2x.png" width="140" height="65" alt="Jekyll Logo">
|
48
|
+
</a>
|
49
|
+
</h1>
|
50
|
+
</div>
|
51
|
+
<nav class="main-nav hide-on-mobiles">
|
52
|
+
<ul>
|
42
53
|
<li class="">
|
43
54
|
<a href="/">Home</a>
|
44
55
|
</li>
|
@@ -48,29 +59,29 @@
|
|
48
59
|
<li class="">
|
49
60
|
<a href="/news/">News</a>
|
50
61
|
</li>
|
51
|
-
<li class="">
|
52
|
-
<a href="/community/">Community</a>
|
53
|
-
</li>
|
54
62
|
<li class="">
|
55
63
|
<a href="/help/">Help</a>
|
56
64
|
</li>
|
57
|
-
<li>
|
58
|
-
<a href="https://github.com/jekyll/jekyll">GitHub</a>
|
59
|
-
</li>
|
60
65
|
</ul>
|
61
66
|
|
62
|
-
|
63
|
-
|
64
|
-
|
65
|
-
|
66
|
-
<a href="/">
|
67
|
-
<span class="sr-only">Jekyll</span>
|
68
|
-
<img src="/img/logo-2x.png" width="249" height="115" alt="Jekyll Logo">
|
69
|
-
</a>
|
70
|
-
</h1>
|
67
|
+
</nav>
|
68
|
+
<div class="search hide-on-mobiles">
|
69
|
+
<input type="text" id="docsearch-input" placeholder="Search the docs…">
|
70
|
+
|
71
71
|
</div>
|
72
|
-
<
|
72
|
+
<div class="meta hide-on-mobiles">
|
73
73
|
<ul>
|
74
|
+
<li>
|
75
|
+
<a href="https://github.com/jekyll/jekyll/releases/tag/v3.7.0">v3.7.0</a>
|
76
|
+
</li>
|
77
|
+
<li>
|
78
|
+
<a href="https://github.com/jekyll/jekyll">GitHub</a>
|
79
|
+
</li>
|
80
|
+
</ul>
|
81
|
+
</div>
|
82
|
+
</div>
|
83
|
+
<nav class="mobile-nav show-on-mobiles">
|
84
|
+
<ul>
|
74
85
|
<li class="">
|
75
86
|
<a href="/">Home</a>
|
76
87
|
</li>
|
@@ -80,9 +91,6 @@
|
|
80
91
|
<li class="">
|
81
92
|
<a href="/news/">News</a>
|
82
93
|
</li>
|
83
|
-
<li class="">
|
84
|
-
<a href="/community/">Community</a>
|
85
|
-
</li>
|
86
94
|
<li class="">
|
87
95
|
<a href="/help/">Help</a>
|
88
96
|
</li>
|
@@ -91,8 +99,7 @@
|
|
91
99
|
</li>
|
92
100
|
</ul>
|
93
101
|
|
94
|
-
|
95
|
-
</div>
|
102
|
+
</nav>
|
96
103
|
</header>
|
97
104
|
|
98
105
|
|
@@ -309,35 +316,37 @@ having to modify the Jekyll source itself.</p>
|
|
309
316
|
<p>You have 3 options for installing plugins:</p>
|
310
317
|
|
311
318
|
<ol>
|
312
|
-
<li>
|
319
|
+
<li>
|
320
|
+
<p>In your site source root, make a <code class="highlighter-rouge">_plugins</code> directory. Place your plugins
|
313
321
|
here. Any file ending in <code class="highlighter-rouge">*.rb</code> inside this directory will be loaded before
|
314
|
-
Jekyll generates your site.</
|
322
|
+
Jekyll generates your site.</p>
|
323
|
+
</li>
|
315
324
|
<li>
|
316
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> and the
|
317
326
|
values of the gem names of the plugins you’d like to use. An example:</p>
|
318
327
|
|
319
|
-
<div class="highlighter-rouge">
|
320
|
-
<div class="highlight"><pre class="highlight"><code
|
321
|
-
|
322
|
-
|
323
|
-
|
324
|
-
|
325
|
-
|
328
|
+
<div class="language-yaml highlighter-rouge">
|
329
|
+
<div class="highlight"><pre class="highlight"><code><span class="c1"># This will require each of these plugins automatically.</span>
|
330
|
+
<span class="na">plugins</span><span class="pi">:</span>
|
331
|
+
<span class="pi">-</span> <span class="s">jekyll-gist</span>
|
332
|
+
<span class="pi">-</span> <span class="s">jekyll-coffeescript</span>
|
333
|
+
<span class="pi">-</span> <span class="s">jekyll-assets</span>
|
334
|
+
<span class="pi">-</span> <span class="s">another-jekyll-plugin</span>
|
326
335
|
</code></pre></div> </div>
|
327
336
|
|
328
337
|
<p>Then install your plugins using <code class="highlighter-rouge">gem install jekyll-gist jekyll-coffeescript jekyll-assets another-jekyll-plugin</code></p>
|
329
338
|
</li>
|
330
339
|
<li>
|
331
340
|
<p>Add the relevant plugins to a Bundler group in your <code class="highlighter-rouge">Gemfile</code>. An
|
332
|
-
|
333
|
-
|
334
|
-
<div class="highlighter-rouge">
|
335
|
-
<div class="highlight"><pre class="highlight"><code> group
|
336
|
-
gem "jekyll-gist"
|
337
|
-
gem "jekyll-coffeescript"
|
338
|
-
gem "jekyll-assets"
|
339
|
-
gem "another-jekyll-plugin"
|
340
|
-
end
|
341
|
+
example:</p>
|
342
|
+
|
343
|
+
<div class="language-ruby highlighter-rouge">
|
344
|
+
<div class="highlight"><pre class="highlight"><code> <span class="n">group</span> <span class="ss">:jekyll_plugins</span> <span class="k">do</span>
|
345
|
+
<span class="n">gem</span> <span class="s2">"jekyll-gist"</span>
|
346
|
+
<span class="n">gem</span> <span class="s2">"jekyll-coffeescript"</span>
|
347
|
+
<span class="n">gem</span> <span class="s2">"jekyll-assets"</span>
|
348
|
+
<span class="n">gem</span> <span class="s2">"another-jekyll-plugin"</span>
|
349
|
+
<span class="k">end</span>
|
341
350
|
</code></pre></div> </div>
|
342
351
|
|
343
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>
|
@@ -356,6 +365,23 @@ values of the gem names of the plugins you’d like to use. An example:</p>
|
|
356
365
|
</p>
|
357
366
|
</div>
|
358
367
|
|
368
|
+
<h3 id="the-jekyll_plugins-group">The jekyll_plugins group</h3>
|
369
|
+
|
370
|
+
<p>Jekyll gives this particular group of gems in your <code class="highlighter-rouge">Gemfile</code> a different
|
371
|
+
treatment. Any gem included in this group is loaded before Jekyll starts
|
372
|
+
processing the rest of your source directory.</p>
|
373
|
+
|
374
|
+
<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
|
+
|
377
|
+
<div class="note warning">
|
378
|
+
<p>
|
379
|
+
Gems included in the <code>:jekyll-plugins</code> group are activated
|
380
|
+
regardless of the <code>--safe</code> mode setting. Be aware of what
|
381
|
+
gems are included under this group!
|
382
|
+
</p>
|
383
|
+
</div>
|
384
|
+
|
359
385
|
<p>In general, plugins you make will fall broadly into one of five categories:</p>
|
360
386
|
|
361
387
|
<ol>
|
@@ -409,7 +435,6 @@ variables <code class="highlighter-rouge">ongoing</code> and <code class="highli
|
|
409
435
|
<p>This is a more complex generator that generates new pages:</p>
|
410
436
|
|
411
437
|
<div class="language-ruby highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="k">module</span> <span class="nn">Jekyll</span>
|
412
|
-
|
413
438
|
<span class="k">class</span> <span class="nc">CategoryPage</span> <span class="o"><</span> <span class="no">Page</span>
|
414
439
|
<span class="k">def</span> <span class="nf">initialize</span><span class="p">(</span><span class="n">site</span><span class="p">,</span> <span class="n">base</span><span class="p">,</span> <span class="n">dir</span><span class="p">,</span> <span class="n">category</span><span class="p">)</span>
|
415
440
|
<span class="vi">@site</span> <span class="o">=</span> <span class="n">site</span>
|
@@ -438,7 +463,6 @@ variables <code class="highlighter-rouge">ongoing</code> and <code class="highli
|
|
438
463
|
<span class="k">end</span>
|
439
464
|
<span class="k">end</span>
|
440
465
|
<span class="k">end</span>
|
441
|
-
|
442
466
|
<span class="k">end</span>
|
443
467
|
</code></pre></div></div>
|
444
468
|
|
@@ -672,9 +696,7 @@ follows:</p>
|
|
672
696
|
<p>In the example above, we can place the following tag anywhere in one of our
|
673
697
|
pages:</p>
|
674
698
|
|
675
|
-
<div class="language-ruby highlighter-rouge"><div class="highlight"><pre class="highlight"><code>
|
676
|
-
<span class="o"><</span><span class="nb">p</span><span class="o">></span><span class="p">{</span><span class="sx">% render_time </span><span class="n">page</span> <span class="n">rendered</span> <span class="ss">at: </span><span class="sx">%}</p>
|
677
|
-
|
699
|
+
<div class="language-ruby highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="o"><</span><span class="nb">p</span><span class="o">></span><span class="p">{</span><span class="sx">% render_time </span><span class="n">page</span> <span class="n">rendered</span> <span class="ss">at: </span><span class="sx">%}</p>
|
678
700
|
</span></code></pre></div></div>
|
679
701
|
|
680
702
|
<p>And we would get something like this on the page:</p>
|
@@ -1073,13 +1095,21 @@ LESS.js files during generation.</li>
|
|
1073
1095
|
<a href="https://github.com/developmentseed/jekyll-ga">jekyll-ga</a>: A Jekyll plugin that downloads Google Analytics data and adds it to posts. Useful for making a site that lists “most popular” content. <a href="https://developmentseed.org/blog/google-analytics-jekyll-plugin/">Read the introduction</a> post on the developmentSEED blog.</li>
|
1074
1096
|
<li>
|
1075
1097
|
<a href="https://github.com/fadhilnapis/jekyll-multi-paginate">jekyll-multi-paginate</a>: Simple Jekyll paginator for multiple page. Ease you to make pagination on multiple page especially like multiple language.</li>
|
1098
|
+
<li>
|
1099
|
+
<a href="https://github.com/field-theory/jekyll-category-pages">jekyll-category-pages</a>: Easy-to-use category index pages with and without pagination. Supports non-URL-safe category keywords and has extensive documentation and test coverage.</li>
|
1100
|
+
<li>
|
1101
|
+
<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>
|
1102
|
+
<li>
|
1103
|
+
<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>
|
1104
|
+
<li>
|
1105
|
+
<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>
|
1076
1106
|
</ul>
|
1077
1107
|
|
1078
1108
|
<h4 id="converters-1">Converters</h4>
|
1079
1109
|
|
1080
1110
|
<ul>
|
1081
1111
|
<li>
|
1082
|
-
<a href="
|
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>
|
1083
1113
|
<li>
|
1084
1114
|
<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>
|
1085
1115
|
<li>
|
@@ -1132,8 +1162,6 @@ LESS.js files during generation.</li>
|
|
1132
1162
|
<li>
|
1133
1163
|
<a href="https://gist.github.com/731597">Summarize Filter by Mathieu Arnold</a>: Remove markup after a <code class="highlighter-rouge"><div id="extended"></code> tag.</li>
|
1134
1164
|
<li>
|
1135
|
-
<a href="https://github.com/gacha/gacha.id.lv/blob/master/_plugins/i18n_filter.rb">i18n_filter</a>: Liquid filter to use I18n localization.</li>
|
1136
|
-
<li>
|
1137
1165
|
<a href="https://github.com/SaswatPadhi/jekyll_smilify">Smilify</a> by <a href="https://github.com/SaswatPadhi">SaswatPadhi</a>: Convert text emoticons in your content to themeable smiley pics.</li>
|
1138
1166
|
<li>
|
1139
1167
|
<a href="https://gist.github.com/zachleat/5792681">Read in X Minutes</a> by <a href="https://github.com/zachleat">zachleat</a>: Estimates the reading time of a string (for blog post content).</li>
|
@@ -1158,8 +1186,6 @@ LESS.js files during generation.</li>
|
|
1158
1186
|
<li>
|
1159
1187
|
<a href="https://github.com/matallo/jekyll-thumbnail-filter">Jekyll Thumbnail Filter</a>: Related posts thumbnail filter.</li>
|
1160
1188
|
<li>
|
1161
|
-
<a href="https://github.com/pathawks/jekyll-smartify">Jekyll-Smartify</a>: SmartyPants filter. Make "quotes" “curly”</li>
|
1162
|
-
<li>
|
1163
1189
|
<a href="https://github.com/pathawks/liquid-md5">liquid-md5</a>: Returns an MD5 hash. Helpful for generating Gravatars in templates.</li>
|
1164
1190
|
<li>
|
1165
1191
|
<a href="https://github.com/paulrobertlloyd/jekyll-roman">jekyll-roman</a>: A liquid filter for Jekyll that converts numbers into Roman numerals.</li>
|
@@ -1314,6 +1340,10 @@ LESS.js files during generation.</li>
|
|
1314
1340
|
<li>
|
1315
1341
|
<a href="https://github.com/rjoberon/bibsonomy-jekyll">BibSonomy</a>: Jekyll
|
1316
1342
|
plugin to generate publication lists from <a href="https://www.bibsonomy.org/">BibSonomy</a>.</li>
|
1343
|
+
<li>
|
1344
|
+
<a href="https://github.com/edward-shen/github-cards">github-cards</a>: Creates styleable Github cards for your Github projects.</li>
|
1345
|
+
<li>
|
1346
|
+
<a href="https://github.com/kacperduras/disqus-for-jekyll">disqus-for-jekyll</a>: A Jekyll plugin to view the comments powered by Disqus.</li>
|
1317
1347
|
</ul>
|
1318
1348
|
|
1319
1349
|
<h4 id="collections">Collections</h4>
|
@@ -1359,8 +1389,6 @@ plugin to generate publication lists from <a href="https://www.bibsonomy.org/">B
|
|
1359
1389
|
<li>
|
1360
1390
|
<a href="https://github.com/inukshuk/jekyll-scholar">Jekyll-scholar</a>: Jekyll extensions for the blogging scholar.</li>
|
1361
1391
|
<li>
|
1362
|
-
<a href="https://github.com/moshen/jekyll-asset_bundler">Jekyll-asset_bundler</a>: Bundles and minifies JavaScript and CSS.</li>
|
1363
|
-
<li>
|
1364
1392
|
<a href="http://jekyll.github.io/jekyll-assets/">Jekyll-assets</a> by <a href="https://github.com/ixti">ixti</a>: Rails-alike assets pipeline (write assets in CoffeeScript, Sass, LESS etc; specify dependencies for automatic bundling using simple declarative comments in assets; minify and compress; use JST templates; cache bust; and many-many more).</li>
|
1365
1393
|
<li>
|
1366
1394
|
<a href="https://github.com/kitsched/japr">JAPR</a>: Jekyll Asset Pipeline Reborn - Powerful asset pipeline for Jekyll that collects, converts and compresses JavaScript and CSS assets.</li>
|
@@ -1418,6 +1446,8 @@ plugin to generate publication lists from <a href="https://www.bibsonomy.org/">B
|
|
1418
1446
|
<a href="https://github.com/muratayusuke/jekyll-numbered-headings">jekyll-numbered-headings</a>: Adds ordered number to headings.</li>
|
1419
1447
|
<li>
|
1420
1448
|
<a href="https://github.com/mpchadwick/jekyll-pre-commit">jekyll-pre-commit</a>: A framework for running checks against your posts using a git pre-commit hook before you publish them.</li>
|
1449
|
+
<li>
|
1450
|
+
<a href="https://github.com/lavas-project/jekyll-pwa">jekyll-pwa-plugin</a>: A plugin provides PWA support for Jekyll. It generates a service worker in Jekyll build process and makes precache and runtime cache available in the runtime with Google Workbox.</li>
|
1421
1451
|
</ul>
|
1422
1452
|
|
1423
1453
|
<div class="note info">
|
@@ -1717,7 +1747,7 @@ plugin to generate publication lists from <a href="https://www.bibsonomy.org/">B
|
|
1717
1747
|
<footer>
|
1718
1748
|
<div class="grid">
|
1719
1749
|
<div class="unit one-third center-on-mobiles">
|
1720
|
-
<p>The contents of this website are <br>©
|
1750
|
+
<p>The contents of this website are <br>© 2018 under the terms of the <a href="https://github.com/jekyll/jekyll/blob/master/LICENSE">MIT License</a>.</p>
|
1721
1751
|
</div>
|
1722
1752
|
<div class="unit two-thirds align-right center-on-mobiles">
|
1723
1753
|
<p>
|
@@ -1795,6 +1825,15 @@ plugin to generate publication lists from <a href="https://www.bibsonomy.org/">B
|
|
1795
1825
|
</script>
|
1796
1826
|
|
1797
1827
|
|
1828
|
+
<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.js"></script>
|
1829
|
+
<script type="text/javascript"> docsearch({
|
1830
|
+
apiKey: '50fe39c839958dfad797000f33e2ec17',
|
1831
|
+
indexName: 'jekyllrb',
|
1832
|
+
inputSelector: '#docsearch-input',
|
1833
|
+
enhancedSearchInput: true,
|
1834
|
+
debug: false // Set debug to true if you want to inspect the dropdown
|
1835
|
+
});
|
1836
|
+
</script>
|
1798
1837
|
|
1799
1838
|
</body>
|
1800
1839
|
</html>
|