jekyll-docs 3.4.3 → 3.5.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/jekyll-docs.rb +1 -1
- data/site/404.html +5 -11
- data/site/community/index.html +9 -15
- data/site/css/screen.css +1 -1468
- data/site/docs/assets/index.html +20 -16
- data/site/docs/collections/index.html +115 -109
- data/site/docs/conduct/index.html +19 -15
- data/site/docs/configuration/index.html +39 -23
- data/site/docs/continuous-integration/buddyworks/index.html +728 -0
- data/site/docs/continuous-integration/circleci/index.html +19 -15
- data/site/docs/continuous-integration/index.html +20 -15
- data/site/docs/continuous-integration/travis-ci/index.html +21 -18
- data/site/docs/contributing/index.html +20 -16
- data/site/docs/datafiles/index.html +23 -15
- data/site/docs/deployment-methods/index.html +24 -20
- data/site/docs/drafts/index.html +19 -15
- data/site/docs/extras/index.html +31 -16
- data/site/docs/frontmatter/index.html +28 -15
- data/site/docs/github-pages/index.html +21 -17
- data/site/docs/history/index.html +521 -315
- data/site/docs/home/index.html +16 -15
- data/site/docs/includes/index.html +21 -17
- data/site/docs/installation/index.html +41 -31
- data/site/docs/maintaining/affinity-team-captain/index.html +19 -15
- data/site/docs/maintaining/avoiding-burnout/index.html +19 -15
- data/site/docs/maintaining/becoming-a-maintainer/index.html +19 -15
- data/site/docs/maintaining/index.html +19 -15
- data/site/docs/maintaining/merging-a-pull-request/index.html +19 -15
- data/site/docs/maintaining/reviewing-a-pull-request/index.html +19 -15
- data/site/docs/maintaining/special-labels/index.html +23 -15
- data/site/docs/maintaining/triaging-an-issue/index.html +20 -16
- data/site/docs/migrations/index.html +19 -15
- data/site/docs/pages/index.html +19 -15
- data/site/docs/pagination/index.html +19 -15
- data/site/docs/permalinks/index.html +19 -15
- data/site/docs/plugins/index.html +36 -23
- data/site/docs/posts/index.html +23 -19
- data/site/docs/quickstart/index.html +18 -17
- data/site/docs/resources/index.html +19 -15
- data/site/docs/sites/index.html +22 -15
- data/site/docs/static-files/index.html +52 -15
- data/site/docs/structure/index.html +19 -15
- data/site/docs/templates/index.html +29 -25
- data/site/docs/themes/index.html +65 -39
- data/site/docs/troubleshooting/index.html +41 -19
- data/site/docs/upgrading/0-to-2/index.html +19 -15
- data/site/docs/upgrading/2-to-3/index.html +20 -16
- data/site/docs/upgrading/index.html +22 -15
- data/site/docs/usage/index.html +20 -16
- data/site/docs/variables/index.html +19 -15
- data/site/docs/windows/index.html +135 -136
- data/site/feed.xml +228 -180
- data/site/help/index.html +11 -13
- data/site/img/jekylllayoutconcept.png +0 -0
- data/site/index.html +7 -14
- data/site/latest_version.txt +1 -1
- data/site/news/2013/05/05/jekyll-1-0-0-released/index.html +33 -19
- data/site/news/2013/05/08/jekyll-1-0-1-released/index.html +33 -19
- data/site/news/2013/05/12/jekyll-1-0-2-released/index.html +33 -19
- data/site/news/2013/06/07/jekyll-1-0-3-released/index.html +33 -19
- data/site/news/2013/07/14/jekyll-1-1-0-released/index.html +33 -19
- data/site/news/2013/07/24/jekyll-1-1-1-released/index.html +33 -19
- data/site/news/2013/07/25/jekyll-1-0-4-released/index.html +33 -19
- data/site/news/2013/07/25/jekyll-1-1-2-released/index.html +33 -19
- data/site/news/2013/09/06/jekyll-1-2-0-released/index.html +33 -19
- data/site/news/2013/09/14/jekyll-1-2-1-released/index.html +33 -19
- data/site/news/2013/10/28/jekyll-1-3-0-rc1-released/index.html +33 -19
- data/site/news/2013/11/04/jekyll-1-3-0-released/index.html +33 -19
- data/site/news/2013/11/26/jekyll-1-3-1-released/index.html +33 -19
- data/site/news/2013/12/07/jekyll-1-4-0-released/index.html +33 -19
- data/site/news/2013/12/09/jekyll-1-4-1-released/index.html +33 -19
- data/site/news/2013/12/16/jekyll-1-4-2-released/index.html +33 -19
- data/site/news/2014/01/13/jekyll-1-4-3-released/index.html +33 -19
- data/site/news/2014/03/24/jekyll-1-5-0-released/index.html +33 -19
- data/site/news/2014/03/27/jekyll-1-5-1-released/index.html +33 -19
- data/site/news/2014/05/06/jekyll-turns-2-0-0/index.html +33 -19
- data/site/news/2014/05/08/jekyll-2-0-3-released/index.html +33 -19
- data/site/news/2014/06/04/jekyll-stickers-1-dollar-stickermule/index.html +35 -21
- data/site/news/2014/06/28/jekyll-turns-21-i-mean-2-1-0/index.html +33 -19
- data/site/news/2014/07/01/jekyll-2-1-1-released/index.html +33 -19
- data/site/news/2014/07/29/jekyll-2-2-0-released/index.html +33 -19
- data/site/news/2014/08/10/jekyll-2-3-0-released/index.html +33 -19
- data/site/news/2014/09/09/jekyll-2-4-0-released/index.html +33 -19
- data/site/news/2014/11/05/jekylls-midlife-crisis-jekyll-turns-2-5-0/index.html +33 -19
- data/site/news/2014/11/09/jekyll-2-5-1-released/index.html +33 -19
- data/site/news/2014/11/12/jekyll-2-5-2-released/index.html +33 -19
- data/site/news/2014/12/17/alfredxing-welcome-to-jekyll-core/index.html +33 -19
- data/site/news/2014/12/22/jekyll-2-5-3-released/index.html +33 -19
- data/site/news/2015/01/20/jekyll-meet-and-greet/index.html +33 -19
- data/site/news/2015/01/24/jekyll-3-0-0-beta1-released/index.html +33 -19
- data/site/news/2015/02/26/introducing-jekyll-talk/index.html +33 -19
- data/site/news/2015/10/26/jekyll-3-0-released/index.html +33 -19
- data/site/news/2015/11/17/jekyll-3-0-1-released/index.html +33 -19
- data/site/news/2016/01/20/jekyll-3-0-2-released/index.html +33 -19
- data/site/news/2016/01/24/jekyll-3-1-0-released/index.html +33 -19
- data/site/news/2016/01/28/jekyll-3-1-1-released/index.html +33 -19
- data/site/news/2016/02/08/jekyll-3-0-3-released/index.html +33 -19
- data/site/news/2016/02/19/jekyll-3-1-2-released/index.html +33 -19
- data/site/news/2016/03/10/making-it-easier-to-contribute-to-jekyll/index.html +33 -19
- data/site/news/2016/04/19/jekyll-3-0-4-released/index.html +33 -19
- data/site/news/2016/04/19/jekyll-3-1-3-released/index.html +33 -19
- data/site/news/2016/04/26/jekyll-3-0-5-released/index.html +33 -19
- data/site/news/2016/05/18/jekyll-3-1-4-released/index.html +33 -19
- data/site/news/2016/05/18/jekyll-3-1-5-released/index.html +33 -19
- data/site/news/2016/05/19/jekyll-3-1-6-released/index.html +33 -19
- data/site/news/2016/06/03/update-on-jekyll-s-google-summer-of-code-projects/index.html +33 -19
- data/site/news/2016/07/26/jekyll-3-2-0-released/index.html +35 -21
- data/site/news/2016/08/02/jekyll-3-2-1-released/index.html +34 -20
- data/site/news/2016/08/24/jekyll-admin-initial-release/index.html +33 -19
- data/site/news/2016/10/06/jekyll-3-3-is-here/index.html +35 -21
- data/site/news/2016/11/14/jekyll-3-3-1-released/index.html +34 -20
- data/site/news/2017/01/18/jekyll-3-4-0-released/index.html +36 -22
- data/site/news/2017/03/02/jekyll-3-4-1-released/index.html +651 -0
- data/site/news/2017/03/09/jekyll-3-4-2-released/index.html +592 -0
- data/site/news/2017/03/21/jekyll-3-4-3-released/index.html +588 -0
- data/site/news/2017/06/15/jekyll-3-5-0-released/index.html +581 -0
- data/site/news/2017/07/17/jekyll-3-5-1-released/index.html +561 -0
- data/site/news/index.html +405 -22
- data/site/news/releases/index.html +405 -22
- data/site/philosophy.html +46 -0
- data/site/sitemap.xml +95 -48
- data/site/tutorials/convert-site-to-jekyll/index.html +851 -0
- data/site/tutorials/custom-404-page/index.html +366 -0
- data/site/tutorials/home/index.html +323 -0
- data/site/tutorials/index.html +10 -0
- data/site/tutorials/navigation/index.html +908 -0
- data/site/tutorials/orderofinterpretation/index.html +459 -0
- metadata +20 -7
- data/site/feed.xslt.xml +0 -4
data/site/docs/assets/index.html
CHANGED
@@ -4,35 +4,28 @@
|
|
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.5.1">
|
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
11
|
<link rel="stylesheet" href="/css/screen.css">
|
12
12
|
<link rel="icon" type="image/x-icon" href="/favicon.ico">
|
13
|
-
<!-- Begin Jekyll SEO tag v2.
|
14
|
-
<title>Assets
|
13
|
+
<!-- Begin Jekyll SEO tag v2.2.3 -->
|
14
|
+
<title>Assets | Jekyll • Simple, blog-aware, static sites</title>
|
15
15
|
<meta property="og:title" content="Assets">
|
16
|
+
<meta property="og:locale" content="en_US">
|
16
17
|
<meta name="description" content="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:">
|
17
18
|
<meta property="og:description" content="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:">
|
18
19
|
<link rel="canonical" href="https://jekyllrb.com/docs/assets/">
|
19
20
|
<meta property="og:url" content="https://jekyllrb.com/docs/assets/">
|
20
21
|
<meta property="og:site_name" content="Jekyll • Simple, blog-aware, static sites">
|
21
22
|
<meta property="og:type" content="article">
|
22
|
-
<meta property="article:published_time" content="2017-
|
23
|
+
<meta property="article:published_time" content="2017-07-17T13:16:40-07:00">
|
23
24
|
<meta name="twitter:card" content="summary">
|
24
25
|
<meta name="twitter:site" content="@jekyllrb">
|
25
26
|
<meta name="google-site-verification" content="onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY">
|
26
27
|
<script type="application/ld+json">
|
27
|
-
{"@context":
|
28
|
-
"@type": "BlogPosting",
|
29
|
-
"headline": "Assets",
|
30
|
-
"datePublished": "2017-03-22T08:08:47-07:00",
|
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
|
-
"publisher": {"@type": "Organization",
|
33
|
-
"logo": {"@type": "ImageObject",
|
34
|
-
"url": "https://jekyllrb.com/img/logo-2x.png"}},
|
35
|
-
"url": "https://jekyllrb.com/docs/assets/"}</script>
|
28
|
+
{"@context":"http://schema.org","@type":"BlogPosting","headline":"Assets","datePublished":"2017-07-17T13:16:40-07:00","dateModified":"2017-07-17T13:16:40-07:00","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:","publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://jekyllrb.com/img/logo-2x.png"}},"mainEntityOfPage":{"@type":"WebPage","@id":"https://jekyllrb.com/docs/assets/"},"url":"https://jekyllrb.com/docs/assets/"}</script>
|
36
29
|
<!-- End Jekyll SEO tag -->
|
37
30
|
|
38
31
|
<!--[if lt IE 9]>
|
@@ -62,7 +55,7 @@
|
|
62
55
|
<a href="/help/">Help</a>
|
63
56
|
</li>
|
64
57
|
<li>
|
65
|
-
<a href="https://github.com/jekyll/jekyll"
|
58
|
+
<a href="https://github.com/jekyll/jekyll">GitHub</a>
|
66
59
|
</li>
|
67
60
|
</ul>
|
68
61
|
|
@@ -94,7 +87,7 @@
|
|
94
87
|
<a href="/help/">Help</a>
|
95
88
|
</li>
|
96
89
|
<li>
|
97
|
-
<a href="https://github.com/jekyll/jekyll"
|
90
|
+
<a href="https://github.com/jekyll/jekyll">GitHub</a>
|
98
91
|
</li>
|
99
92
|
</ul>
|
100
93
|
|
@@ -126,6 +119,10 @@
|
|
126
119
|
|
127
120
|
|
128
121
|
|
122
|
+
<option value="/docs/windows/">Jekyll on Windows</option>
|
123
|
+
|
124
|
+
|
125
|
+
|
129
126
|
<option value="/docs/usage/">Basic Usage</option>
|
130
127
|
|
131
128
|
|
@@ -377,7 +374,7 @@ here, too.</p>
|
|
377
374
|
</ul>
|
378
375
|
|
379
376
|
<div class="language-yaml highlighter-rouge">
|
380
|
-
<pre class="highlight"><code><span class="s">
|
377
|
+
<pre class="highlight"><code><span class="s">plugins</span><span class="pi">:</span>
|
381
378
|
<span class="pi">-</span> <span class="s">jekyll-coffeescript</span>
|
382
379
|
</code></pre>
|
383
380
|
</div>
|
@@ -428,6 +425,9 @@ here, too.</p>
|
|
428
425
|
|
429
426
|
|
430
427
|
|
428
|
+
|
429
|
+
|
430
|
+
|
431
431
|
|
432
432
|
|
433
433
|
|
@@ -473,6 +473,10 @@ here, too.</p>
|
|
473
473
|
|
474
474
|
|
475
475
|
|
476
|
+
<li class=""><a href="/docs/windows/">Jekyll on Windows</a></li>
|
477
|
+
|
478
|
+
|
479
|
+
|
476
480
|
<li class=""><a href="/docs/usage/">Basic Usage</a></li>
|
477
481
|
|
478
482
|
|
@@ -4,35 +4,28 @@
|
|
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.5.1">
|
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
11
|
<link rel="stylesheet" href="/css/screen.css">
|
12
12
|
<link rel="icon" type="image/x-icon" href="/favicon.ico">
|
13
|
-
<!-- Begin Jekyll SEO tag v2.
|
14
|
-
<title>Collections
|
13
|
+
<!-- Begin Jekyll SEO tag v2.2.3 -->
|
14
|
+
<title>Collections | Jekyll • Simple, blog-aware, static sites</title>
|
15
15
|
<meta property="og:title" content="Collections">
|
16
|
+
<meta property="og:locale" content="en_US">
|
16
17
|
<meta name="description" content="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.">
|
17
18
|
<meta property="og:description" content="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.">
|
18
19
|
<link rel="canonical" href="https://jekyllrb.com/docs/collections/">
|
19
20
|
<meta property="og:url" content="https://jekyllrb.com/docs/collections/">
|
20
21
|
<meta property="og:site_name" content="Jekyll • Simple, blog-aware, static sites">
|
21
22
|
<meta property="og:type" content="article">
|
22
|
-
<meta property="article:published_time" content="2017-
|
23
|
+
<meta property="article:published_time" content="2017-07-17T13:16:40-07:00">
|
23
24
|
<meta name="twitter:card" content="summary">
|
24
25
|
<meta name="twitter:site" content="@jekyllrb">
|
25
26
|
<meta name="google-site-verification" content="onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY">
|
26
27
|
<script type="application/ld+json">
|
27
|
-
{"@context":
|
28
|
-
"@type": "BlogPosting",
|
29
|
-
"headline": "Collections",
|
30
|
-
"datePublished": "2017-03-22T08:08:47-07:00",
|
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
|
-
"publisher": {"@type": "Organization",
|
33
|
-
"logo": {"@type": "ImageObject",
|
34
|
-
"url": "https://jekyllrb.com/img/logo-2x.png"}},
|
35
|
-
"url": "https://jekyllrb.com/docs/collections/"}</script>
|
28
|
+
{"@context":"http://schema.org","@type":"BlogPosting","headline":"Collections","datePublished":"2017-07-17T13:16:40-07:00","dateModified":"2017-07-17T13:16:40-07:00","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.","publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://jekyllrb.com/img/logo-2x.png"}},"mainEntityOfPage":{"@type":"WebPage","@id":"https://jekyllrb.com/docs/collections/"},"url":"https://jekyllrb.com/docs/collections/"}</script>
|
36
29
|
<!-- End Jekyll SEO tag -->
|
37
30
|
|
38
31
|
<!--[if lt IE 9]>
|
@@ -62,7 +55,7 @@
|
|
62
55
|
<a href="/help/">Help</a>
|
63
56
|
</li>
|
64
57
|
<li>
|
65
|
-
<a href="https://github.com/jekyll/jekyll"
|
58
|
+
<a href="https://github.com/jekyll/jekyll">GitHub</a>
|
66
59
|
</li>
|
67
60
|
</ul>
|
68
61
|
|
@@ -94,7 +87,7 @@
|
|
94
87
|
<a href="/help/">Help</a>
|
95
88
|
</li>
|
96
89
|
<li>
|
97
|
-
<a href="https://github.com/jekyll/jekyll"
|
90
|
+
<a href="https://github.com/jekyll/jekyll">GitHub</a>
|
98
91
|
</li>
|
99
92
|
</ul>
|
100
93
|
|
@@ -126,6 +119,10 @@
|
|
126
119
|
|
127
120
|
|
128
121
|
|
122
|
+
<option value="/docs/windows/">Jekyll on Windows</option>
|
123
|
+
|
124
|
+
|
125
|
+
|
129
126
|
<option value="/docs/usage/">Basic Usage</option>
|
130
127
|
|
131
128
|
|
@@ -382,19 +379,94 @@ choice and written out to <code class="highlighter-rouge"><dest>/my_collec
|
|
382
379
|
|
383
380
|
<h2 id="permalinks">Configuring permalinks for collections</h2>
|
384
381
|
|
385
|
-
<p>
|
382
|
+
<p>If you wish to specify a custom pattern for the URLs where your Collection pages
|
383
|
+
will reside, you may do so with the <a href="../permalinks/"><code class="highlighter-rouge">permalink</code> property</a>:</p>
|
386
384
|
|
387
385
|
<div class="language-yaml highlighter-rouge">
|
388
386
|
<pre class="highlight"><code><span class="s">collections</span><span class="pi">:</span>
|
389
387
|
<span class="s">my_collection</span><span class="pi">:</span>
|
390
388
|
<span class="s">output</span><span class="pi">:</span> <span class="s">true</span>
|
391
|
-
<span class="s">permalink</span><span class="pi">:</span> <span class="s"
|
389
|
+
<span class="s">permalink</span><span class="pi">:</span> <span class="s">/:collection/:name</span>
|
390
|
+
</code></pre>
|
391
|
+
</div>
|
392
|
+
|
393
|
+
<h3 id="examples">Examples</h3>
|
394
|
+
|
395
|
+
<p>For a collection with the following source file structure,</p>
|
396
|
+
|
397
|
+
<div class="highlighter-rouge">
|
398
|
+
<pre class="highlight"><code>_my_collection/
|
399
|
+
└── some_subdir
|
400
|
+
└── some_doc.md
|
392
401
|
</code></pre>
|
393
402
|
</div>
|
394
403
|
|
395
|
-
<p>
|
404
|
+
<p>each of the following <code class="highlighter-rouge">permalink</code> configurations will produce the document structure shown below it.</p>
|
405
|
+
|
406
|
+
<ul>
|
407
|
+
<li>
|
408
|
+
<p><strong>Default</strong><br>
|
409
|
+
Same as <code class="highlighter-rouge">permalink: /:collection/:path</code>.</p>
|
410
|
+
|
411
|
+
<div class="highlighter-rouge">
|
412
|
+
<pre class="highlight"><code>_site/
|
413
|
+
├── my_collection
|
414
|
+
│ └── some_subdir
|
415
|
+
│ └── some_doc.html
|
416
|
+
...
|
417
|
+
</code></pre>
|
418
|
+
</div>
|
419
|
+
</li>
|
420
|
+
<li>
|
421
|
+
<p><code class="highlighter-rouge">permalink: pretty</code><br>
|
422
|
+
Same as <code class="highlighter-rouge">permalink: /:collection/:path/</code>.</p>
|
423
|
+
|
424
|
+
<div class="highlighter-rouge">
|
425
|
+
<pre class="highlight"><code>_site/
|
426
|
+
├── my_collection
|
427
|
+
│ └── some_subdir
|
428
|
+
│ └── some_doc
|
429
|
+
│ └── index.html
|
430
|
+
...
|
431
|
+
</code></pre>
|
432
|
+
</div>
|
433
|
+
</li>
|
434
|
+
<li>
|
435
|
+
<p><code class="highlighter-rouge">permalink: /doc/:path</code></p>
|
436
|
+
|
437
|
+
<div class="highlighter-rouge">
|
438
|
+
<pre class="highlight"><code>_site/
|
439
|
+
├── doc
|
440
|
+
│ └── some_subdir
|
441
|
+
│ └── some_doc.html
|
442
|
+
...
|
443
|
+
</code></pre>
|
444
|
+
</div>
|
445
|
+
</li>
|
446
|
+
<li>
|
447
|
+
<p><code class="highlighter-rouge">permalink: /doc/:name</code></p>
|
448
|
+
|
449
|
+
<div class="highlighter-rouge">
|
450
|
+
<pre class="highlight"><code>_site/
|
451
|
+
├── doc
|
452
|
+
│ └── some_doc.html
|
453
|
+
...
|
454
|
+
</code></pre>
|
455
|
+
</div>
|
456
|
+
</li>
|
457
|
+
<li>
|
458
|
+
<p><code class="highlighter-rouge">permalink: /:name</code></p>
|
459
|
+
|
460
|
+
<div class="highlighter-rouge">
|
461
|
+
<pre class="highlight"><code>_site/
|
462
|
+
├── some_doc.html
|
463
|
+
...
|
464
|
+
</code></pre>
|
465
|
+
</div>
|
466
|
+
</li>
|
467
|
+
</ul>
|
396
468
|
|
397
|
-
<
|
469
|
+
<h3 id="template-variables">Template Variables</h3>
|
398
470
|
|
399
471
|
<div class="mobile-side-scroller">
|
400
472
|
<table>
|
@@ -407,7 +479,7 @@ choice and written out to <code class="highlighter-rouge"><dest>/my_collec
|
|
407
479
|
<tbody>
|
408
480
|
<tr>
|
409
481
|
<td>
|
410
|
-
<p><code
|
482
|
+
<p><code>:collection</code></p>
|
411
483
|
</td>
|
412
484
|
<td>
|
413
485
|
<p>Label of the containing collection.</p>
|
@@ -415,7 +487,7 @@ choice and written out to <code class="highlighter-rouge"><dest>/my_collec
|
|
415
487
|
</tr>
|
416
488
|
<tr>
|
417
489
|
<td>
|
418
|
-
<p><code
|
490
|
+
<p><code>:path</code></p>
|
419
491
|
</td>
|
420
492
|
<td>
|
421
493
|
<p>Path to the document relative to the collection's directory.</p>
|
@@ -423,7 +495,7 @@ choice and written out to <code class="highlighter-rouge"><dest>/my_collec
|
|
423
495
|
</tr>
|
424
496
|
<tr>
|
425
497
|
<td>
|
426
|
-
<p><code
|
498
|
+
<p><code>:name</code></p>
|
427
499
|
</td>
|
428
500
|
<td>
|
429
501
|
<p>The document's base filename, with every sequence of spaces
|
@@ -432,7 +504,7 @@ choice and written out to <code class="highlighter-rouge"><dest>/my_collec
|
|
432
504
|
</tr>
|
433
505
|
<tr>
|
434
506
|
<td>
|
435
|
-
<p><code
|
507
|
+
<p><code>:title</code></p>
|
436
508
|
</td>
|
437
509
|
<td>
|
438
510
|
<p>The document's lowercase title (as defined in its <a href="/docs/frontmatter/">front matter</a>), with every sequence of spaces and non-alphanumeric characters replaced by a hyphen. If the document does not define a title in its <a href="/docs/frontmatter/">front matter</a>, this is equivalent to <code>name</code>.</p>
|
@@ -440,100 +512,16 @@ choice and written out to <code class="highlighter-rouge"><dest>/my_collec
|
|
440
512
|
</tr>
|
441
513
|
<tr>
|
442
514
|
<td>
|
443
|
-
<p><code
|
515
|
+
<p><code>:output_ext</code></p>
|
444
516
|
</td>
|
445
517
|
<td>
|
446
|
-
<p>Extension of the output file
|
518
|
+
<p>Extension of the output file. (Included by default and usually unnecessary.)</p>
|
447
519
|
</td>
|
448
520
|
</tr>
|
449
521
|
</tbody>
|
450
522
|
</table>
|
451
523
|
</div>
|
452
524
|
|
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
|
-
|
537
525
|
<h2 id="liquid-attributes">Liquid Attributes</h2>
|
538
526
|
|
539
527
|
<h3 id="collections">Collections</h3>
|
@@ -623,6 +611,17 @@ you specified in your <code class="highlighter-rouge">_config.yml</code> (if pre
|
|
623
611
|
</table>
|
624
612
|
</div>
|
625
613
|
|
614
|
+
<div class="note info">
|
615
|
+
<h5>A Hard-Coded Collection</h5>
|
616
|
+
<p>In addition to any collections you create yourself, the
|
617
|
+
<code>posts</code> collection is hard-coded into Jekyll. It exists whether
|
618
|
+
you have a <code>_posts</code> directory or not. This is something to note
|
619
|
+
when iterating through <code>site.collections</code> as you may need to
|
620
|
+
filter it out.</p>
|
621
|
+
<p>You may wish to use filters to find your collection:
|
622
|
+
<code>{{ site.collections | where: "label", "myCollection" | first }}</code></p>
|
623
|
+
</div>
|
624
|
+
|
626
625
|
<h3 id="documents">Documents</h3>
|
627
626
|
|
628
627
|
<p>In addition to any YAML Front Matter provided in the document’s corresponding
|
@@ -806,6 +805,9 @@ extension):</p>
|
|
806
805
|
|
807
806
|
|
808
807
|
|
808
|
+
|
809
|
+
|
810
|
+
|
809
811
|
|
810
812
|
|
811
813
|
|
@@ -851,6 +853,10 @@ extension):</p>
|
|
851
853
|
|
852
854
|
|
853
855
|
|
856
|
+
<li class=""><a href="/docs/windows/">Jekyll on Windows</a></li>
|
857
|
+
|
858
|
+
|
859
|
+
|
854
860
|
<li class=""><a href="/docs/usage/">Basic Usage</a></li>
|
855
861
|
|
856
862
|
|
@@ -4,35 +4,28 @@
|
|
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.5.1">
|
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
11
|
<link rel="stylesheet" href="/css/screen.css">
|
12
12
|
<link rel="icon" type="image/x-icon" href="/favicon.ico">
|
13
|
-
<!-- Begin Jekyll SEO tag v2.
|
14
|
-
<title>Code of Conduct
|
13
|
+
<!-- Begin Jekyll SEO tag v2.2.3 -->
|
14
|
+
<title>Code of Conduct | Jekyll • Simple, blog-aware, static sites</title>
|
15
15
|
<meta property="og:title" content="Code of Conduct">
|
16
|
+
<meta property="og:locale" content="en_US">
|
16
17
|
<meta name="description" content="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.">
|
17
18
|
<meta property="og:description" content="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.">
|
18
19
|
<link rel="canonical" href="https://jekyllrb.com/docs/conduct/">
|
19
20
|
<meta property="og:url" content="https://jekyllrb.com/docs/conduct/">
|
20
21
|
<meta property="og:site_name" content="Jekyll • Simple, blog-aware, static sites">
|
21
22
|
<meta property="og:type" content="article">
|
22
|
-
<meta property="article:published_time" content="2017-
|
23
|
+
<meta property="article:published_time" content="2017-07-17T13:16:40-07:00">
|
23
24
|
<meta name="twitter:card" content="summary">
|
24
25
|
<meta name="twitter:site" content="@jekyllrb">
|
25
26
|
<meta name="google-site-verification" content="onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY">
|
26
27
|
<script type="application/ld+json">
|
27
|
-
{"@context":
|
28
|
-
"@type": "BlogPosting",
|
29
|
-
"headline": "Code of Conduct",
|
30
|
-
"datePublished": "2017-03-22T08:08:47-07:00",
|
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
|
-
"publisher": {"@type": "Organization",
|
33
|
-
"logo": {"@type": "ImageObject",
|
34
|
-
"url": "https://jekyllrb.com/img/logo-2x.png"}},
|
35
|
-
"url": "https://jekyllrb.com/docs/conduct/"}</script>
|
28
|
+
{"@context":"http://schema.org","@type":"BlogPosting","headline":"Code of Conduct","datePublished":"2017-07-17T13:16:40-07:00","dateModified":"2017-07-17T13:16:40-07:00","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.","publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://jekyllrb.com/img/logo-2x.png"}},"mainEntityOfPage":{"@type":"WebPage","@id":"https://jekyllrb.com/docs/conduct/"},"url":"https://jekyllrb.com/docs/conduct/"}</script>
|
36
29
|
<!-- End Jekyll SEO tag -->
|
37
30
|
|
38
31
|
<!--[if lt IE 9]>
|
@@ -62,7 +55,7 @@
|
|
62
55
|
<a href="/help/">Help</a>
|
63
56
|
</li>
|
64
57
|
<li>
|
65
|
-
<a href="https://github.com/jekyll/jekyll"
|
58
|
+
<a href="https://github.com/jekyll/jekyll">GitHub</a>
|
66
59
|
</li>
|
67
60
|
</ul>
|
68
61
|
|
@@ -94,7 +87,7 @@
|
|
94
87
|
<a href="/help/">Help</a>
|
95
88
|
</li>
|
96
89
|
<li>
|
97
|
-
<a href="https://github.com/jekyll/jekyll"
|
90
|
+
<a href="https://github.com/jekyll/jekyll">GitHub</a>
|
98
91
|
</li>
|
99
92
|
</ul>
|
100
93
|
|
@@ -126,6 +119,10 @@
|
|
126
119
|
|
127
120
|
|
128
121
|
|
122
|
+
<option value="/docs/windows/">Jekyll on Windows</option>
|
123
|
+
|
124
|
+
|
125
|
+
|
129
126
|
<option value="/docs/usage/">Basic Usage</option>
|
130
127
|
|
131
128
|
|
@@ -440,6 +437,9 @@ version 1.3.0, available at
|
|
440
437
|
|
441
438
|
|
442
439
|
|
440
|
+
|
441
|
+
|
442
|
+
|
443
443
|
|
444
444
|
|
445
445
|
|
@@ -485,6 +485,10 @@ version 1.3.0, available at
|
|
485
485
|
|
486
486
|
|
487
487
|
|
488
|
+
<li class=""><a href="/docs/windows/">Jekyll on Windows</a></li>
|
489
|
+
|
490
|
+
|
491
|
+
|
488
492
|
<li class=""><a href="/docs/usage/">Basic Usage</a></li>
|
489
493
|
|
490
494
|
|