jekyll-docs 3.3.1 → 3.4.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 +3 -3
- data/site/community/index.html +5 -5
- data/site/css/screen.css +7 -6
- data/site/docs/assets/index.html +13 -5
- data/site/docs/collections/index.html +132 -29
- data/site/docs/conduct/index.html +16 -5
- data/site/docs/configuration/index.html +26 -8
- data/site/docs/continuous-integration/circleci/index.html +761 -0
- data/site/docs/continuous-integration/index.html +25 -245
- data/site/docs/continuous-integration/travis-ci/index.html +916 -0
- data/site/docs/contributing/index.html +41 -5
- data/site/docs/datafiles/index.html +14 -6
- data/site/docs/deployment-methods/index.html +17 -7
- data/site/docs/drafts/index.html +13 -5
- data/site/docs/extras/index.html +17 -6
- data/site/docs/frontmatter/index.html +13 -5
- data/site/docs/github-pages/index.html +68 -47
- data/site/docs/history/index.html +132 -9
- data/site/docs/home/index.html +13 -5
- data/site/docs/includes/index.html +824 -0
- data/site/docs/installation/index.html +16 -6
- data/site/docs/maintaining/affinity-team-captain/index.html +16 -5
- data/site/docs/maintaining/avoiding-burnout/index.html +16 -5
- data/site/docs/maintaining/becoming-a-maintainer/index.html +17 -6
- data/site/docs/maintaining/index.html +16 -5
- data/site/docs/maintaining/merging-a-pull-request/index.html +21 -6
- data/site/docs/maintaining/reviewing-a-pull-request/index.html +16 -5
- data/site/docs/maintaining/special-labels/index.html +16 -5
- data/site/docs/maintaining/triaging-an-issue/index.html +16 -5
- data/site/docs/migrations/index.html +13 -5
- data/site/docs/pages/index.html +33 -50
- data/site/docs/pagination/index.html +16 -5
- data/site/docs/permalinks/index.html +148 -66
- data/site/docs/plugins/index.html +39 -14
- data/site/docs/posts/index.html +32 -5
- data/site/docs/quickstart/index.html +57 -18
- data/site/docs/resources/index.html +21 -10
- data/site/docs/sites/index.html +18 -7
- data/site/docs/static-files/index.html +15 -7
- data/site/docs/structure/index.html +47 -32
- data/site/docs/templates/index.html +85 -89
- data/site/docs/themes/index.html +214 -63
- data/site/docs/troubleshooting/index.html +16 -5
- data/site/docs/upgrading/0-to-2/index.html +16 -5
- data/site/docs/upgrading/2-to-3/index.html +17 -6
- data/site/docs/upgrading/index.html +16 -5
- data/site/docs/usage/index.html +21 -6
- data/site/docs/variables/index.html +14 -6
- data/site/docs/windows/index.html +35 -10
- data/site/feed.xml +41 -22
- data/site/fonts/FontAwesome.eot +0 -0
- data/site/fonts/FontAwesome.svg +12 -0
- data/site/fonts/FontAwesome.ttf +0 -0
- data/site/fonts/FontAwesome.woff +0 -0
- data/site/help/index.html +3 -3
- data/site/icomoon-selection.json +96 -0
- data/site/index.html +3 -3
- data/site/latest_version.txt +1 -1
- data/site/news/2013/05/05/jekyll-1-0-0-released/index.html +12 -8
- data/site/news/2013/05/08/jekyll-1-0-1-released/index.html +11 -7
- data/site/news/2013/05/12/jekyll-1-0-2-released/index.html +11 -7
- data/site/news/2013/06/07/jekyll-1-0-3-released/index.html +11 -7
- data/site/news/2013/07/14/jekyll-1-1-0-released/index.html +11 -7
- data/site/news/2013/07/24/jekyll-1-1-1-released/index.html +12 -8
- data/site/news/2013/07/25/jekyll-1-0-4-released/index.html +11 -7
- data/site/news/2013/07/25/jekyll-1-1-2-released/index.html +11 -7
- data/site/news/2013/09/06/jekyll-1-2-0-released/index.html +11 -7
- data/site/news/2013/09/14/jekyll-1-2-1-released/index.html +11 -7
- data/site/news/2013/10/28/jekyll-1-3-0-rc1-released/index.html +11 -7
- data/site/news/2013/11/04/jekyll-1-3-0-released/index.html +11 -7
- data/site/news/2013/11/26/jekyll-1-3-1-released/index.html +11 -7
- data/site/news/2013/12/07/jekyll-1-4-0-released/index.html +11 -7
- data/site/news/2013/12/09/jekyll-1-4-1-released/index.html +11 -7
- data/site/news/2013/12/16/jekyll-1-4-2-released/index.html +11 -7
- data/site/news/2014/01/13/jekyll-1-4-3-released/index.html +11 -7
- data/site/news/2014/03/24/jekyll-1-5-0-released/index.html +11 -7
- data/site/news/2014/03/27/jekyll-1-5-1-released/index.html +11 -7
- data/site/news/2014/05/06/jekyll-turns-2-0-0/index.html +11 -7
- data/site/news/2014/05/08/jekyll-2-0-3-released/index.html +11 -7
- data/site/news/2014/06/04/jekyll-stickers-1-dollar-stickermule/index.html +12 -8
- data/site/news/2014/06/28/jekyll-turns-21-i-mean-2-1-0/index.html +12 -8
- data/site/news/2014/07/01/jekyll-2-1-1-released/index.html +11 -7
- data/site/news/2014/07/29/jekyll-2-2-0-released/index.html +11 -7
- data/site/news/2014/08/10/jekyll-2-3-0-released/index.html +11 -7
- data/site/news/2014/09/09/jekyll-2-4-0-released/index.html +11 -7
- data/site/news/2014/11/05/jekylls-midlife-crisis-jekyll-turns-2-5-0/index.html +11 -7
- data/site/news/2014/11/09/jekyll-2-5-1-released/index.html +11 -7
- data/site/news/2014/11/12/jekyll-2-5-2-released/index.html +11 -7
- data/site/news/2014/12/17/alfredxing-welcome-to-jekyll-core/index.html +12 -8
- data/site/news/2014/12/22/jekyll-2-5-3-released/index.html +11 -7
- data/site/news/2015/01/20/jekyll-meet-and-greet/index.html +11 -7
- data/site/news/2015/01/24/jekyll-3-0-0-beta1-released/index.html +11 -7
- data/site/news/2015/02/26/introducing-jekyll-talk/index.html +11 -7
- data/site/news/2015/10/26/jekyll-3-0-released/index.html +11 -7
- data/site/news/2015/11/17/jekyll-3-0-1-released/index.html +11 -7
- data/site/news/2016/01/20/jekyll-3-0-2-released/index.html +11 -7
- data/site/news/2016/01/24/jekyll-3-1-0-released/index.html +11 -7
- data/site/news/2016/01/28/jekyll-3-1-1-released/index.html +11 -7
- data/site/news/2016/02/08/jekyll-3-0-3-released/index.html +11 -7
- data/site/news/2016/02/19/jekyll-3-1-2-released/index.html +11 -7
- data/site/news/2016/03/10/making-it-easier-to-contribute-to-jekyll/index.html +11 -7
- data/site/news/2016/04/19/jekyll-3-0-4-released/index.html +11 -7
- data/site/news/2016/04/19/jekyll-3-1-3-released/index.html +11 -8
- data/site/news/2016/04/26/jekyll-3-0-5-released/index.html +11 -7
- data/site/news/2016/05/18/jekyll-3-1-4-released/index.html +11 -7
- data/site/news/2016/05/18/jekyll-3-1-5-released/index.html +11 -7
- data/site/news/2016/05/19/jekyll-3-1-6-released/index.html +11 -7
- data/site/news/2016/06/03/update-on-jekyll-s-google-summer-of-code-projects/index.html +11 -7
- data/site/news/2016/07/26/jekyll-3-2-0-released/index.html +11 -7
- data/site/news/2016/08/02/jekyll-3-2-1-released/index.html +11 -7
- data/site/news/2016/08/24/jekyll-admin-initial-release/index.html +12 -8
- data/site/news/2016/10/06/jekyll-3-3-is-here/index.html +12 -8
- data/site/news/2016/11/14/jekyll-3-3-1-released/index.html +11 -7
- data/site/news/2017/01/18/jekyll-3-4-0-released/index.html +570 -0
- data/site/news/index.html +81 -15
- data/site/news/releases/index.html +78 -12
- data/site/readme.md +9 -2
- data/site/sitemap.xml +59 -43
- metadata +14 -10
- data/site/fonts/fontawesome-webfont.eot +0 -0
- data/site/fonts/fontawesome-webfont.svg +0 -640
- data/site/fonts/fontawesome-webfont.ttf +0 -0
- data/site/fonts/fontawesome-webfont.woff +0 -0
- data/site/fonts/fontawesome-webfont.woff2 +0 -0
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: b32e5c07682490e0954fd209343813b960129bf7
|
4
|
+
data.tar.gz: 0ede939df788cdd4b0c67ba1ee13da45c4deec32
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 6dd4eb54ca781ee906e2dec604a4bc8507369fc3a06e7f26f7259074816bebc8962fc682f1b1c0cbc03420680badc96ffce2e8a48cc82f862a802ce80bc37f99
|
7
|
+
data.tar.gz: 72ef57b0d54db64f6074598ef2f61583ce5d1f462f3a29f8225e0477432d8552eacc34bf9c1996cee140af3cc74186e3275c7e9be01a283e9a403bf2dcf8f507
|
data/site/404.html
CHANGED
@@ -4,7 +4,7 @@
|
|
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.4.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">
|
@@ -124,7 +124,7 @@
|
|
124
124
|
</script>
|
125
125
|
|
126
126
|
|
127
|
-
<!-- Gauges (http://gaug.es/) -->
|
127
|
+
<!-- Gauges (http://get.gaug.es/) -->
|
128
128
|
<script>
|
129
129
|
var _gauges = _gauges || [];
|
130
130
|
(function() {
|
@@ -141,7 +141,7 @@
|
|
141
141
|
|
142
142
|
|
143
143
|
|
144
|
-
<!-- Google Analytics (
|
144
|
+
<!-- Google Analytics (https://www.google.com/analytics) -->
|
145
145
|
<script>
|
146
146
|
!function(j,e,k,y,l,L){j.GoogleAnalyticsObject=y,j[y]||(j[y]=function(){
|
147
147
|
(j[y].q=j[y].q||[]).push(arguments)}),j[y].l=+new Date,l=e.createElement(k),
|
data/site/community/index.html
CHANGED
@@ -4,7 +4,7 @@
|
|
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.4.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">
|
@@ -110,9 +110,9 @@
|
|
110
110
|
|
111
111
|
<h2 id="featured">Featured</h2>
|
112
112
|
|
113
|
-
<p>
|
113
|
+
<p>Responsive srcset images with imgix - <a href="https://twitter.com/olivermakes">Oliver Pattison</a></p>
|
114
114
|
<div class="videoWrapper">
|
115
|
-
<iframe width="420" height="315" src="https://www.youtube.com/embed/
|
115
|
+
<iframe width="420" height="315" src="https://www.youtube.com/embed/BIf6oNpGl74" frameborder="0" allowfullscreen=""></iframe>
|
116
116
|
</div>
|
117
117
|
|
118
118
|
<h2 id="2016">2016</h2>
|
@@ -270,7 +270,7 @@
|
|
270
270
|
</script>
|
271
271
|
|
272
272
|
|
273
|
-
<!-- Gauges (http://gaug.es/) -->
|
273
|
+
<!-- Gauges (http://get.gaug.es/) -->
|
274
274
|
<script>
|
275
275
|
var _gauges = _gauges || [];
|
276
276
|
(function() {
|
@@ -287,7 +287,7 @@
|
|
287
287
|
|
288
288
|
|
289
289
|
|
290
|
-
<!-- Google Analytics (
|
290
|
+
<!-- Google Analytics (https://www.google.com/analytics) -->
|
291
291
|
<script>
|
292
292
|
!function(j,e,k,y,l,L){j.GoogleAnalyticsObject=y,j[y]||(j[y]=function(){
|
293
293
|
(j[y].q=j[y].q||[]).push(arguments)}),j[y].l=+new Date,l=e.createElement(k),
|
data/site/css/screen.css
CHANGED
@@ -542,14 +542,10 @@ template {
|
|
542
542
|
-o-user-select: none;
|
543
543
|
user-select: none; }
|
544
544
|
|
545
|
-
/*!
|
546
|
-
* Font Awesome 4.4.0 by @davegandy - http://fontawesome.io - @fontawesome
|
547
|
-
* License - http://fontawesome.io/license (Font: SIL OFL 1.1, CSS: MIT License)
|
548
|
-
*/
|
549
545
|
@font-face {
|
550
546
|
font-family: 'FontAwesome';
|
551
|
-
src: url("../fonts/
|
552
|
-
src: url("../fonts/
|
547
|
+
src: url("../fonts/FontAwesome.eot?9h6hxj");
|
548
|
+
src: url("../fonts/FontAwesome.eot?9h6hxj#iefix") format("embedded-opentype"), url("../fonts/FontAwesome.woff?9h6hxj") format("woff"), url("../fonts/FontAwesome.ttf?9h6hxj") format("truetype"), url("../fonts/FontAwesome.svg?9h6hxj#FontAwesome") format("svg");
|
553
549
|
font-weight: normal;
|
554
550
|
font-style: normal; }
|
555
551
|
.fa {
|
@@ -1136,6 +1132,11 @@ h5 > code,
|
|
1136
1132
|
margin-right: 2.5px;
|
1137
1133
|
font-size: 0.8em; }
|
1138
1134
|
|
1135
|
+
.code-block {
|
1136
|
+
margin: 10px 0; }
|
1137
|
+
.code-block code {
|
1138
|
+
background: none; }
|
1139
|
+
|
1139
1140
|
.highlight, .highlighter-rouge .highlight {
|
1140
1141
|
margin: 1em 0;
|
1141
1142
|
padding: 10px 0;
|
data/site/docs/assets/index.html
CHANGED
@@ -4,7 +4,7 @@
|
|
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.4.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">
|
@@ -19,7 +19,7 @@
|
|
19
19
|
<meta property="og:url" content="https://jekyllrb.com/docs/assets/">
|
20
20
|
<meta property="og:site_name" content="Jekyll • Simple, blog-aware, static sites">
|
21
21
|
<meta property="og:type" content="article">
|
22
|
-
<meta property="article:published_time" content="2017-
|
22
|
+
<meta property="article:published_time" content="2017-03-22T08:06:48-07:00">
|
23
23
|
<meta name="twitter:card" content="summary">
|
24
24
|
<meta name="twitter:site" content="@jekyllrb">
|
25
25
|
<meta name="google-site-verification" content="onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY">
|
@@ -27,7 +27,7 @@
|
|
27
27
|
{"@context": "http://schema.org",
|
28
28
|
"@type": "BlogPosting",
|
29
29
|
"headline": "Assets",
|
30
|
-
"datePublished": "2017-
|
30
|
+
"datePublished": "2017-03-22T08:06:48-07:00",
|
31
31
|
"description": "Jekyll provides built-in support for Sass and can work with CoffeeScript via a Ruby gem. In order to use them, you must first create a file with the proper extension name (one of .sass, .scss, or .coffee) and start the file with two lines of triple dashes, like this:",
|
32
32
|
"publisher": {"@type": "Organization",
|
33
33
|
"logo": {"@type": "ImageObject",
|
@@ -192,6 +192,10 @@
|
|
192
192
|
|
193
193
|
|
194
194
|
|
195
|
+
<option value="/docs/includes/">Includes</option>
|
196
|
+
|
197
|
+
|
198
|
+
|
195
199
|
<option value="/docs/permalinks/">Permalinks</option>
|
196
200
|
|
197
201
|
|
@@ -537,6 +541,10 @@ here, too.</p>
|
|
537
541
|
|
538
542
|
|
539
543
|
|
544
|
+
<li class=""><a href="/docs/includes/">Includes</a></li>
|
545
|
+
|
546
|
+
|
547
|
+
|
540
548
|
<li class=""><a href="/docs/permalinks/">Permalinks</a></li>
|
541
549
|
|
542
550
|
|
@@ -685,7 +693,7 @@ here, too.</p>
|
|
685
693
|
</script>
|
686
694
|
|
687
695
|
|
688
|
-
<!-- Gauges (http://gaug.es/) -->
|
696
|
+
<!-- Gauges (http://get.gaug.es/) -->
|
689
697
|
<script>
|
690
698
|
var _gauges = _gauges || [];
|
691
699
|
(function() {
|
@@ -702,7 +710,7 @@ here, too.</p>
|
|
702
710
|
|
703
711
|
|
704
712
|
|
705
|
-
<!-- Google Analytics (
|
713
|
+
<!-- Google Analytics (https://www.google.com/analytics) -->
|
706
714
|
<script>
|
707
715
|
!function(j,e,k,y,l,L){j.GoogleAnalyticsObject=y,j[y]||(j[y]=function(){
|
708
716
|
(j[y].q=j[y].q||[]).push(arguments)}),j[y].l=+new Date,l=e.createElement(k),
|
@@ -4,7 +4,7 @@
|
|
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.4.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">
|
@@ -19,7 +19,7 @@
|
|
19
19
|
<meta property="og:url" content="https://jekyllrb.com/docs/collections/">
|
20
20
|
<meta property="og:site_name" content="Jekyll • Simple, blog-aware, static sites">
|
21
21
|
<meta property="og:type" content="article">
|
22
|
-
<meta property="article:published_time" content="2017-
|
22
|
+
<meta property="article:published_time" content="2017-03-22T08:06:48-07:00">
|
23
23
|
<meta name="twitter:card" content="summary">
|
24
24
|
<meta name="twitter:site" content="@jekyllrb">
|
25
25
|
<meta name="google-site-verification" content="onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY">
|
@@ -27,7 +27,7 @@
|
|
27
27
|
{"@context": "http://schema.org",
|
28
28
|
"@type": "BlogPosting",
|
29
29
|
"headline": "Collections",
|
30
|
-
"datePublished": "2017-
|
30
|
+
"datePublished": "2017-03-22T08:06:48-07:00",
|
31
31
|
"description": "Not everything is a post or a page. Maybe you want to document the various methods in your open source project, members of a team, or talks at a conference. Collections allow you to define a new type of document that behave like Pages or Posts do normally, but also have their own unique properties and namespace.",
|
32
32
|
"publisher": {"@type": "Organization",
|
33
33
|
"logo": {"@type": "ImageObject",
|
@@ -192,6 +192,10 @@
|
|
192
192
|
|
193
193
|
|
194
194
|
|
195
|
+
<option value="/docs/includes/">Includes</option>
|
196
|
+
|
197
|
+
|
198
|
+
|
195
199
|
<option value="/docs/permalinks/">Permalinks</option>
|
196
200
|
|
197
201
|
|
@@ -294,7 +298,15 @@ namespace.</p>
|
|
294
298
|
|
295
299
|
<h2 id="using-collections">Using Collections</h2>
|
296
300
|
|
297
|
-
<
|
301
|
+
<p>To start using collections, follow these 3 steps:</p>
|
302
|
+
|
303
|
+
<ul>
|
304
|
+
<li><a href="#step1">Step 1: Tell Jekyll to read in your collection</a></li>
|
305
|
+
<li><a href="#step2">Step 2: Add your content</a></li>
|
306
|
+
<li><a href="#step3">Step 3: Optionally render your collection’s documents into independent files</a></li>
|
307
|
+
</ul>
|
308
|
+
|
309
|
+
<h3 id="step1">Step 1: Tell Jekyll to read in your collection</h3>
|
298
310
|
|
299
311
|
<p>Add the following to your site’s <code class="highlighter-rouge">_config.yml</code> file, replacing <code class="highlighter-rouge">my_collection</code>
|
300
312
|
with the name of your collection:</p>
|
@@ -326,12 +338,12 @@ with the name of your collection:</p>
|
|
326
338
|
</code></pre>
|
327
339
|
</div>
|
328
340
|
|
329
|
-
<h3 id="
|
341
|
+
<h3 id="step2">Step 2: Add your content</h3>
|
330
342
|
|
331
343
|
<p>Create a corresponding folder (e.g. <code class="highlighter-rouge"><source>/_my_collection</code>) and add
|
332
|
-
documents. YAML
|
333
|
-
after
|
334
|
-
|
344
|
+
documents. YAML front matter is processed if the front matter exists, and everything
|
345
|
+
after the front matter is pushed into the document’s <code class="highlighter-rouge">content</code> attribute. If no YAML front
|
346
|
+
matter is provided, Jekyll will not generate the file in your collection.</p>
|
335
347
|
|
336
348
|
<div class="note info">
|
337
349
|
<h5>Be sure to name your directories correctly</h5>
|
@@ -341,7 +353,7 @@ your <code>_config.yml</code> file, with the addition of the preceding <code>_</
|
|
341
353
|
</p>
|
342
354
|
</div>
|
343
355
|
|
344
|
-
<h3 id="
|
356
|
+
<h3 id="step3">Step 3: Optionally render your collection’s documents into independent files</h3>
|
345
357
|
|
346
358
|
<p>If you’d like Jekyll to create a public-facing, rendered version of each
|
347
359
|
document in your collection, set the <code class="highlighter-rouge">output</code> key to <code class="highlighter-rouge">true</code> in your collection
|
@@ -359,28 +371,30 @@ For example, if you have <code class="highlighter-rouge">_my_collection/some_sub
|
|
359
371
|
it will be rendered using Liquid and the Markdown converter of your
|
360
372
|
choice and written out to <code class="highlighter-rouge"><dest>/my_collection/some_subdir/some_doc.html</code>.</p>
|
361
373
|
|
362
|
-
<
|
363
|
-
|
374
|
+
<div class="note info">
|
375
|
+
<h5>Don't forget to add YAML for processing</h5>
|
376
|
+
<p>
|
377
|
+
Files in collections that do not have front matter are treated as
|
378
|
+
<a href="/docs/static-files">static files</a> and simply copied to their
|
379
|
+
output location without processing.
|
380
|
+
</p>
|
381
|
+
</div>
|
382
|
+
|
383
|
+
<h2 id="permalinks">Configuring permalinks for collections</h2>
|
384
|
+
|
385
|
+
<p>You can customize the <a href="../permalinks/">Permalinks</a> for your collection’s documents by setting <code class="highlighter-rouge">permalink</code> property in the collection’s configuration as follows:</p>
|
364
386
|
|
365
387
|
<div class="language-yaml highlighter-rouge">
|
366
388
|
<pre class="highlight"><code><span class="s">collections</span><span class="pi">:</span>
|
367
389
|
<span class="s">my_collection</span><span class="pi">:</span>
|
368
390
|
<span class="s">output</span><span class="pi">:</span> <span class="s">true</span>
|
369
|
-
<span class="s">permalink</span><span class="pi">:</span> <span class="s">/awesome/:path
|
391
|
+
<span class="s">permalink</span><span class="pi">:</span> <span class="s">/awesome/:path/:title.:output_ext</span>
|
370
392
|
</code></pre>
|
371
393
|
</div>
|
372
394
|
|
373
|
-
<p>
|
374
|
-
written out to <code class="highlighter-rouge"><dest>/awesome/some_subdir/some_doc/index.html</code>.</p>
|
395
|
+
<p>In this example, the collection documents will the have the URL of <code class="highlighter-rouge">awesome</code> followed by the path to the document and its file extension.</p>
|
375
396
|
|
376
|
-
<
|
377
|
-
<h5>Don't forget to add YAML for processing</h5>
|
378
|
-
<p>
|
379
|
-
Files in collections that do not have front matter are treated as
|
380
|
-
<a href="/docs/static-files">static files</a> and simply copied to their
|
381
|
-
output location without processing.
|
382
|
-
</p>
|
383
|
-
</div>
|
397
|
+
<p>Collections have the following template variables available for permalinks:</p>
|
384
398
|
|
385
399
|
<div class="mobile-side-scroller">
|
386
400
|
<table>
|
@@ -436,15 +450,100 @@ written out to <code class="highlighter-rouge"><dest>/awesome/some_subdir/
|
|
436
450
|
</table>
|
437
451
|
</div>
|
438
452
|
|
453
|
+
<h2 id="permalink-examples-for-collections">Permalink examples for collections</h2>
|
454
|
+
|
455
|
+
<p>Depending on how you declare the permalinks in your configuration file, the permalinks and paths get written differently in the <code class="highlighter-rouge">_site</code> folder. A few examples will help clarify the options.</p>
|
456
|
+
|
457
|
+
<p>Let’s say your collection is called <code class="highlighter-rouge">apidocs</code> with <code class="highlighter-rouge">doc1.md</code> in your collection. <code class="highlighter-rouge">doc1.md</code> is grouped inside a folder called <code class="highlighter-rouge">mydocs</code>. Your project’s source directory for the collection looks this:</p>
|
458
|
+
|
459
|
+
<div class="highlighter-rouge">
|
460
|
+
<pre class="highlight"><code>├── \_apidocs
|
461
|
+
│ └── mydocs
|
462
|
+
│ └── doc1.md
|
463
|
+
</code></pre>
|
464
|
+
</div>
|
465
|
+
|
466
|
+
<p>Based on this scenario, here are a few permalink options.</p>
|
467
|
+
|
468
|
+
<p><strong>Permalink configuration 1</strong>: [Nothing configured] <br>
|
469
|
+
<strong>Output</strong>:</p>
|
470
|
+
|
471
|
+
<div class="highlighter-rouge">
|
472
|
+
<pre class="highlight"><code>├── apidocs
|
473
|
+
│ └── mydocs
|
474
|
+
│ └── doc1.html
|
475
|
+
</code></pre>
|
476
|
+
</div>
|
477
|
+
|
478
|
+
<p><strong>Permalink configuration 2</strong>: <code class="highlighter-rouge">/:collection/:path/:title:output_ext</code> <br>
|
479
|
+
<strong>Output</strong>:</p>
|
480
|
+
|
481
|
+
<div class="highlighter-rouge">
|
482
|
+
<pre class="highlight"><code>├── apidocs
|
483
|
+
│ └── mydocs
|
484
|
+
│ └── doc1.html
|
485
|
+
</code></pre>
|
486
|
+
</div>
|
487
|
+
|
488
|
+
<p><strong>Permalink configuration 3</strong>: No collection permalinks configured, but <code class="highlighter-rouge">pretty</code> configured for pages/posts. <br>
|
489
|
+
<strong>Output</strong>:</p>
|
490
|
+
|
491
|
+
<div class="highlighter-rouge">
|
492
|
+
<pre class="highlight"><code>├── apidocs
|
493
|
+
│ └── mydocs
|
494
|
+
│ └── doc1
|
495
|
+
│ └── index.html
|
496
|
+
</code></pre>
|
497
|
+
</div>
|
498
|
+
|
499
|
+
<p><strong>Permalink configuration 4</strong>: <code class="highlighter-rouge">/awesome/:path/:title.html</code> <br>
|
500
|
+
<strong>Output</strong>:</p>
|
501
|
+
|
502
|
+
<div class="highlighter-rouge">
|
503
|
+
<pre class="highlight"><code>├── awesome
|
504
|
+
│ └── mydocs
|
505
|
+
│ └── doc1.html
|
506
|
+
</code></pre>
|
507
|
+
</div>
|
508
|
+
|
509
|
+
<p><strong>Permalink configuration 5</strong>: <code class="highlighter-rouge">/awesome/:path/:title/</code> <br>
|
510
|
+
<strong>Output</strong>:</p>
|
511
|
+
|
512
|
+
<div class="highlighter-rouge">
|
513
|
+
<pre class="highlight"><code>├── awesome
|
514
|
+
│ └── mydocs
|
515
|
+
│ └── doc1
|
516
|
+
│ └── index.html
|
517
|
+
</code></pre>
|
518
|
+
</div>
|
519
|
+
|
520
|
+
<p><strong>Permalink configuration 6</strong>: <code class="highlighter-rouge">/awesome/:title.html</code> <br>
|
521
|
+
<strong>Output</strong>:</p>
|
522
|
+
|
523
|
+
<div class="highlighter-rouge">
|
524
|
+
<pre class="highlight"><code>├── awesome
|
525
|
+
│ └── doc1.html
|
526
|
+
</code></pre>
|
527
|
+
</div>
|
528
|
+
|
529
|
+
<p><strong>Permalink configuration 7</strong>: <code class="highlighter-rouge">:title.html</code>
|
530
|
+
<strong>Output</strong>:</p>
|
531
|
+
|
532
|
+
<div class="highlighter-rouge">
|
533
|
+
<pre class="highlight"><code>├── doc1.html
|
534
|
+
</code></pre>
|
535
|
+
</div>
|
536
|
+
|
439
537
|
<h2 id="liquid-attributes">Liquid Attributes</h2>
|
440
538
|
|
441
539
|
<h3 id="collections">Collections</h3>
|
442
540
|
|
443
|
-
<p>Each collection is accessible
|
541
|
+
<p>Each collection is accessible as a field on the <code class="highlighter-rouge">site</code> variable. For example, if
|
444
542
|
you want to access the <code class="highlighter-rouge">albums</code> collection found in <code class="highlighter-rouge">_albums</code>, you’d use
|
445
|
-
<code class="highlighter-rouge">site.albums</code
|
446
|
-
|
447
|
-
<code class="highlighter-rouge">site.
|
543
|
+
<code class="highlighter-rouge">site.albums</code>.</p>
|
544
|
+
|
545
|
+
<p>Each collection is itself an array of documents (e.g., <code class="highlighter-rouge">site.albums</code> is an array of documents, much like <code class="highlighter-rouge">site.pages</code> and
|
546
|
+
<code class="highlighter-rouge">site.posts</code>). See the table below for how to access attributes of those documents.</p>
|
448
547
|
|
449
548
|
<p>The collections are also available under <code class="highlighter-rouge">site.collections</code>, with the metadata
|
450
549
|
you specified in your <code class="highlighter-rouge">_config.yml</code> (if present) and the following information:</p>
|
@@ -621,7 +720,7 @@ file, each document has the following attributes:</p>
|
|
621
720
|
|
622
721
|
<p>Attributes from the YAML front matter can be accessed as data anywhere in the
|
623
722
|
site. Using the above example for configuring a collection as <code class="highlighter-rouge">site.albums</code>,
|
624
|
-
|
723
|
+
you might have front matter in an individual file structured as follows (which
|
625
724
|
must use a supported markup format, and cannot be saved with a <code class="highlighter-rouge">.yaml</code>
|
626
725
|
extension):</p>
|
627
726
|
|
@@ -820,6 +919,10 @@ extension):</p>
|
|
820
919
|
|
821
920
|
|
822
921
|
|
922
|
+
<li class=""><a href="/docs/includes/">Includes</a></li>
|
923
|
+
|
924
|
+
|
925
|
+
|
823
926
|
<li class=""><a href="/docs/permalinks/">Permalinks</a></li>
|
824
927
|
|
825
928
|
|
@@ -968,7 +1071,7 @@ extension):</p>
|
|
968
1071
|
</script>
|
969
1072
|
|
970
1073
|
|
971
|
-
<!-- Gauges (http://gaug.es/) -->
|
1074
|
+
<!-- Gauges (http://get.gaug.es/) -->
|
972
1075
|
<script>
|
973
1076
|
var _gauges = _gauges || [];
|
974
1077
|
(function() {
|
@@ -985,7 +1088,7 @@ extension):</p>
|
|
985
1088
|
|
986
1089
|
|
987
1090
|
|
988
|
-
<!-- Google Analytics (
|
1091
|
+
<!-- Google Analytics (https://www.google.com/analytics) -->
|
989
1092
|
<script>
|
990
1093
|
!function(j,e,k,y,l,L){j.GoogleAnalyticsObject=y,j[y]||(j[y]=function(){
|
991
1094
|
(j[y].q=j[y].q||[]).push(arguments)}),j[y].l=+new Date,l=e.createElement(k),
|
@@ -4,7 +4,7 @@
|
|
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.4.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">
|
@@ -19,7 +19,7 @@
|
|
19
19
|
<meta property="og:url" content="https://jekyllrb.com/docs/conduct/">
|
20
20
|
<meta property="og:site_name" content="Jekyll • Simple, blog-aware, static sites">
|
21
21
|
<meta property="og:type" content="article">
|
22
|
-
<meta property="article:published_time" content="2017-
|
22
|
+
<meta property="article:published_time" content="2017-03-22T08:06:48-07:00">
|
23
23
|
<meta name="twitter:card" content="summary">
|
24
24
|
<meta name="twitter:site" content="@jekyllrb">
|
25
25
|
<meta name="google-site-verification" content="onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY">
|
@@ -27,7 +27,7 @@
|
|
27
27
|
{"@context": "http://schema.org",
|
28
28
|
"@type": "BlogPosting",
|
29
29
|
"headline": "Code of Conduct",
|
30
|
-
"datePublished": "2017-
|
30
|
+
"datePublished": "2017-03-22T08:06:48-07:00",
|
31
31
|
"description": "As contributors and maintainers of this project, and in the interest of fostering an open and welcoming community, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.",
|
32
32
|
"publisher": {"@type": "Organization",
|
33
33
|
"logo": {"@type": "ImageObject",
|
@@ -192,6 +192,10 @@
|
|
192
192
|
|
193
193
|
|
194
194
|
|
195
|
+
<option value="/docs/includes/">Includes</option>
|
196
|
+
|
197
|
+
|
198
|
+
|
195
199
|
<option value="/docs/permalinks/">Permalinks</option>
|
196
200
|
|
197
201
|
|
@@ -433,6 +437,9 @@ version 1.3.0, available at
|
|
433
437
|
|
434
438
|
|
435
439
|
|
440
|
+
|
441
|
+
|
442
|
+
|
436
443
|
|
437
444
|
|
438
445
|
|
@@ -546,6 +553,10 @@ version 1.3.0, available at
|
|
546
553
|
|
547
554
|
|
548
555
|
|
556
|
+
<li class=""><a href="/docs/includes/">Includes</a></li>
|
557
|
+
|
558
|
+
|
559
|
+
|
549
560
|
<li class=""><a href="/docs/permalinks/">Permalinks</a></li>
|
550
561
|
|
551
562
|
|
@@ -694,7 +705,7 @@ version 1.3.0, available at
|
|
694
705
|
</script>
|
695
706
|
|
696
707
|
|
697
|
-
<!-- Gauges (http://gaug.es/) -->
|
708
|
+
<!-- Gauges (http://get.gaug.es/) -->
|
698
709
|
<script>
|
699
710
|
var _gauges = _gauges || [];
|
700
711
|
(function() {
|
@@ -711,7 +722,7 @@ version 1.3.0, available at
|
|
711
722
|
|
712
723
|
|
713
724
|
|
714
|
-
<!-- Google Analytics (
|
725
|
+
<!-- Google Analytics (https://www.google.com/analytics) -->
|
715
726
|
<script>
|
716
727
|
!function(j,e,k,y,l,L){j.GoogleAnalyticsObject=y,j[y]||(j[y]=function(){
|
717
728
|
(j[y].q=j[y].q||[]).push(arguments)}),j[y].l=+new Date,l=e.createElement(k),
|