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
data/site/docs/sites/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/sites/">
|
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": "Sites using Jekyll",
|
30
|
-
"datePublished": "2017-
|
30
|
+
"datePublished": "2017-03-22T08:06:48-07:00",
|
31
31
|
"description": "It’s interesting to see what designs and features others have come up with. Below are some Jekyll-powered blogs which were hand-picked for learning purposes.",
|
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
|
|
@@ -295,10 +299,10 @@ learning purposes.</p>
|
|
295
299
|
<a href="http://tom.preston-werner.com/">Tom Preston-Werner</a>
|
296
300
|
(<a href="https://github.com/mojombo/mojombo.github.io">source</a>)</li>
|
297
301
|
<li>
|
298
|
-
<a href="
|
302
|
+
<a href="https://services.github.com/training/">GitHub Official Teaching Materials</a>
|
299
303
|
(<a href="https://github.com/github/training-kit">source</a>)</li>
|
300
304
|
<li>
|
301
|
-
<a href="
|
305
|
+
<a href="https://rsms.me/">Rasmus Andersson</a>
|
302
306
|
(<a href="https://github.com/rsms/rsms.github.com">source</a>)</li>
|
303
307
|
</ul>
|
304
308
|
|
@@ -388,6 +392,9 @@ and their sources on the <a href="https://github.com/jekyll/jekyll/wiki/Sites">
|
|
388
392
|
|
389
393
|
|
390
394
|
|
395
|
+
|
396
|
+
|
397
|
+
|
391
398
|
|
392
399
|
|
393
400
|
|
@@ -501,6 +508,10 @@ and their sources on the <a href="https://github.com/jekyll/jekyll/wiki/Sites">
|
|
501
508
|
|
502
509
|
|
503
510
|
|
511
|
+
<li class=""><a href="/docs/includes/">Includes</a></li>
|
512
|
+
|
513
|
+
|
514
|
+
|
504
515
|
<li class=""><a href="/docs/permalinks/">Permalinks</a></li>
|
505
516
|
|
506
517
|
|
@@ -649,7 +660,7 @@ and their sources on the <a href="https://github.com/jekyll/jekyll/wiki/Sites">
|
|
649
660
|
</script>
|
650
661
|
|
651
662
|
|
652
|
-
<!-- Gauges (http://gaug.es/) -->
|
663
|
+
<!-- Gauges (http://get.gaug.es/) -->
|
653
664
|
<script>
|
654
665
|
var _gauges = _gauges || [];
|
655
666
|
(function() {
|
@@ -666,7 +677,7 @@ and their sources on the <a href="https://github.com/jekyll/jekyll/wiki/Sites">
|
|
666
677
|
|
667
678
|
|
668
679
|
|
669
|
-
<!-- Google Analytics (
|
680
|
+
<!-- Google Analytics (https://www.google.com/analytics) -->
|
670
681
|
<script>
|
671
682
|
!function(j,e,k,y,l,L){j.GoogleAnalyticsObject=y,j[y]||(j[y]=function(){
|
672
683
|
(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/static-files/">
|
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": "Static Files",
|
30
|
-
"datePublished": "2017-
|
30
|
+
"datePublished": "2017-03-22T08:06:48-07:00",
|
31
31
|
"description": "In addition to renderable and convertible content, we also have static files.",
|
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
|
|
@@ -308,7 +312,7 @@ following metadata:</p>
|
|
308
312
|
<td><p><code>file.path</code></p></td>
|
309
313
|
<td><p>
|
310
314
|
|
311
|
-
The relative path to the file, e.g <code>/assets/img/image.jpg</code>
|
315
|
+
The relative path to the file, e.g. <code>/assets/img/image.jpg</code>
|
312
316
|
|
313
317
|
</p></td>
|
314
318
|
</tr>
|
@@ -316,7 +320,7 @@ following metadata:</p>
|
|
316
320
|
<td><p><code>file.modified_time</code></p></td>
|
317
321
|
<td><p>
|
318
322
|
|
319
|
-
The `Time` the file was last modified, e.g <code>2016-04-01 16:35:26 +0200</code>
|
323
|
+
The `Time` the file was last modified, e.g. <code>2016-04-01 16:35:26 +0200</code>
|
320
324
|
|
321
325
|
</p></td>
|
322
326
|
</tr>
|
@@ -496,6 +500,10 @@ following metadata:</p>
|
|
496
500
|
|
497
501
|
|
498
502
|
|
503
|
+
<li class=""><a href="/docs/includes/">Includes</a></li>
|
504
|
+
|
505
|
+
|
506
|
+
|
499
507
|
<li class=""><a href="/docs/permalinks/">Permalinks</a></li>
|
500
508
|
|
501
509
|
|
@@ -644,7 +652,7 @@ following metadata:</p>
|
|
644
652
|
</script>
|
645
653
|
|
646
654
|
|
647
|
-
<!-- Gauges (http://gaug.es/) -->
|
655
|
+
<!-- Gauges (http://get.gaug.es/) -->
|
648
656
|
<script>
|
649
657
|
var _gauges = _gauges || [];
|
650
658
|
(function() {
|
@@ -661,7 +669,7 @@ following metadata:</p>
|
|
661
669
|
|
662
670
|
|
663
671
|
|
664
|
-
<!-- Google Analytics (
|
672
|
+
<!-- Google Analytics (https://www.google.com/analytics) -->
|
665
673
|
<script>
|
666
674
|
!function(j,e,k,y,l,L){j.GoogleAnalyticsObject=y,j[y]||(j[y]=function(){
|
667
675
|
(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/structure/">
|
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": "Directory structure",
|
30
|
-
"datePublished": "2017-
|
30
|
+
"datePublished": "2017-03-22T08:06:48-07:00",
|
31
31
|
"description": "Jekyll is, at its core, a text transformation engine. The concept behind the system is this: you give it text written in your favorite markup language, be that Markdown, Textile, or just plain HTML, and it churns that through a layout or a series of layout files. Throughout that process you can tweak how you want the site URLs to look, what data gets displayed in the layout, and more. This is all done through editing text files; the static web site is the final product.",
|
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
|
|
@@ -299,6 +303,8 @@ product.</p>
|
|
299
303
|
<div class="language-sh highlighter-rouge">
|
300
304
|
<pre class="highlight"><code>.
|
301
305
|
├── _config.yml
|
306
|
+
├── _data
|
307
|
+
| └── members.yml
|
302
308
|
├── _drafts
|
303
309
|
| ├── begin-with-the-crazy-ideas.md
|
304
310
|
| └── on-simplicity-in-technology.md
|
@@ -311,14 +317,26 @@ product.</p>
|
|
311
317
|
├── _posts
|
312
318
|
| ├── 2007-10-29-why-every-programmer-should-play-nethack.md
|
313
319
|
| └── 2009-04-26-barcamp-boston-4-roundup.md
|
314
|
-
├──
|
315
|
-
|
|
320
|
+
├── _sass
|
321
|
+
| ├── _base.scss
|
322
|
+
| └── _layout.scss
|
316
323
|
├── _site
|
317
324
|
├── .jekyll-metadata
|
318
|
-
└── index.html
|
325
|
+
└── index.html <span class="c"># can also be an 'index.md' with valid YAML Frontmatter</span>
|
319
326
|
</code></pre>
|
320
327
|
</div>
|
321
328
|
|
329
|
+
<div class="note info">
|
330
|
+
<h5>Directory structure of Jekyll sites using gem-based themes</h5>
|
331
|
+
<p>
|
332
|
+
Starting <strong>Jekyll 3.2</strong>, a new Jekyll project bootstrapped with <code>jekyll new</code> uses <a href="../themes/">gem-based themes</a> to define the look of the site. This results in a lighter default directory structure : <code>_layouts</code>, <code>_includes</code> and <code>_sass</code> are stored in the theme-gem, by default.
|
333
|
+
</p>
|
334
|
+
<br>
|
335
|
+
<p>
|
336
|
+
<a href="https://github.com/jekyll/minima">minima</a> is the current default theme, and <code>bundle show minima</code> will show you where minima theme's files are stored on your computer.
|
337
|
+
</p>
|
338
|
+
</div>
|
339
|
+
|
322
340
|
<p>An overview of what each of these does:</p>
|
323
341
|
|
324
342
|
<div class="mobile-side-scroller">
|
@@ -336,11 +354,9 @@ product.</p>
|
|
336
354
|
</td>
|
337
355
|
<td>
|
338
356
|
<p>
|
339
|
-
|
340
357
|
Stores <a href="../configuration/">configuration</a> data. Many of
|
341
358
|
these options can be specified from the command line executable but
|
342
359
|
it’s easier to specify them here so you don’t have to remember them.
|
343
|
-
|
344
360
|
</p>
|
345
361
|
</td>
|
346
362
|
</tr>
|
@@ -350,11 +366,9 @@ product.</p>
|
|
350
366
|
</td>
|
351
367
|
<td>
|
352
368
|
<p>
|
353
|
-
|
354
369
|
Drafts are unpublished posts. The format of these files is without a
|
355
370
|
date: <code>title.MARKUP</code>. Learn how to <a href="../drafts/">
|
356
371
|
work with drafts</a>.
|
357
|
-
|
358
372
|
</p>
|
359
373
|
</td>
|
360
374
|
</tr>
|
@@ -364,13 +378,11 @@ product.</p>
|
|
364
378
|
</td>
|
365
379
|
<td>
|
366
380
|
<p>
|
367
|
-
|
368
381
|
These are the partials that can be mixed and matched by your layouts
|
369
382
|
and posts to facilitate reuse. The liquid tag
|
370
383
|
<code>{% include file.ext %}</code>
|
371
384
|
can be used to include the partial in
|
372
385
|
<code>_includes/file.ext</code>.
|
373
|
-
|
374
386
|
</p>
|
375
387
|
</td>
|
376
388
|
</tr>
|
@@ -380,14 +392,12 @@ product.</p>
|
|
380
392
|
</td>
|
381
393
|
<td>
|
382
394
|
<p>
|
383
|
-
|
384
395
|
These are the templates that wrap posts. Layouts are chosen on a
|
385
396
|
post-by-post basis in the
|
386
397
|
<a href="../frontmatter/">YAML Front Matter</a>,
|
387
398
|
which is described in the next section. The liquid tag
|
388
399
|
<code>{{ content }}</code>
|
389
400
|
is used to inject content into the web page.
|
390
|
-
|
391
401
|
</p>
|
392
402
|
</td>
|
393
403
|
</tr>
|
@@ -397,14 +407,12 @@ product.</p>
|
|
397
407
|
</td>
|
398
408
|
<td>
|
399
409
|
<p>
|
400
|
-
|
401
410
|
Your dynamic content, so to speak. The naming convention of these
|
402
411
|
files is important, and must follow the format:
|
403
412
|
<code>YEAR-MONTH-DAY-title.MARKUP</code>.
|
404
413
|
The <a href="../permalinks/">permalinks</a> can be customized for
|
405
414
|
each post, but the date and markup language are determined solely by
|
406
415
|
the file name.
|
407
|
-
|
408
416
|
</p>
|
409
417
|
</td>
|
410
418
|
</tr>
|
@@ -414,15 +422,25 @@ product.</p>
|
|
414
422
|
</td>
|
415
423
|
<td>
|
416
424
|
<p>
|
417
|
-
|
418
425
|
Well-formatted site data should be placed here. The Jekyll engine
|
419
|
-
will autoload all
|
420
|
-
<code>.
|
421
|
-
|
426
|
+
will autoload all data files (using either the <code>.yml</code>,
|
427
|
+
<code>.yaml</code>, <code>.json</code> or <code>.csv</code>
|
428
|
+
formats and extensions) in this directory, and they will be
|
422
429
|
accessible via `site.data`. If there's a file
|
423
430
|
<code>members.yml</code> under the directory, then you can access
|
424
431
|
contents of the file through <code>site.data.members</code>.
|
425
|
-
|
432
|
+
</p>
|
433
|
+
</td>
|
434
|
+
</tr>
|
435
|
+
<tr>
|
436
|
+
<td>
|
437
|
+
<p><code>_sass</code></p>
|
438
|
+
</td>
|
439
|
+
<td>
|
440
|
+
<p>
|
441
|
+
These are sass partials that can be imported into your <code>main.scss</code>
|
442
|
+
which will then be processed into a single stylesheet
|
443
|
+
<code>main.css</code> that defines the styles to be used by your site.
|
426
444
|
</p>
|
427
445
|
</td>
|
428
446
|
</tr>
|
@@ -432,11 +450,9 @@ product.</p>
|
|
432
450
|
</td>
|
433
451
|
<td>
|
434
452
|
<p>
|
435
|
-
|
436
453
|
This is where the generated site will be placed (by default) once
|
437
454
|
Jekyll is done transforming it. It’s probably a good idea to add this
|
438
455
|
to your <code>.gitignore</code> file.
|
439
|
-
|
440
456
|
</p>
|
441
457
|
</td>
|
442
458
|
</tr>
|
@@ -446,29 +462,26 @@ product.</p>
|
|
446
462
|
</td>
|
447
463
|
<td>
|
448
464
|
<p>
|
449
|
-
|
450
465
|
This helps Jekyll keep track of which files have not been modified
|
451
466
|
since the site was last built, and which files will need to be
|
452
467
|
regenerated on the next build. This file will not be included in the
|
453
468
|
generated site. It’s probably a good idea to add this to your
|
454
469
|
<code>.gitignore</code> file.
|
455
|
-
|
456
470
|
</p>
|
457
471
|
</td>
|
458
472
|
</tr>
|
459
473
|
<tr>
|
460
474
|
<td>
|
461
|
-
<p><code>index.html</code> and other HTML,
|
475
|
+
<p><code>index.html</code> or <code>index.md</code> and other HTML,
|
476
|
+
Markdown, Textile files</p>
|
462
477
|
</td>
|
463
478
|
<td>
|
464
479
|
<p>
|
465
|
-
|
466
480
|
Provided that the file has a <a href="../frontmatter/">YAML Front
|
467
481
|
Matter</a> section, it will be transformed by Jekyll. The same will
|
468
482
|
happen for any <code>.html</code>, <code>.markdown</code>,
|
469
483
|
<code>.md</code>, or <code>.textile</code> file in your site’s root
|
470
484
|
directory or directories not listed above.
|
471
|
-
|
472
485
|
</p>
|
473
486
|
</td>
|
474
487
|
</tr>
|
@@ -478,14 +491,12 @@ product.</p>
|
|
478
491
|
</td>
|
479
492
|
<td>
|
480
493
|
<p>
|
481
|
-
|
482
494
|
Every other directory and file except for those listed above—such as
|
483
495
|
<code>css</code> and <code>images</code> folders,
|
484
496
|
<code>favicon.ico</code> files, and so forth—will be copied verbatim
|
485
497
|
to the generated site. There are plenty of <a href="../sites/">sites
|
486
498
|
already using Jekyll</a> if you’re curious to see how they’re laid
|
487
499
|
out.
|
488
|
-
|
489
500
|
</p>
|
490
501
|
</td>
|
491
502
|
</tr>
|
@@ -622,6 +633,10 @@ product.</p>
|
|
622
633
|
|
623
634
|
|
624
635
|
|
636
|
+
<li class=""><a href="/docs/includes/">Includes</a></li>
|
637
|
+
|
638
|
+
|
639
|
+
|
625
640
|
<li class=""><a href="/docs/permalinks/">Permalinks</a></li>
|
626
641
|
|
627
642
|
|
@@ -770,7 +785,7 @@ product.</p>
|
|
770
785
|
</script>
|
771
786
|
|
772
787
|
|
773
|
-
<!-- Gauges (http://gaug.es/) -->
|
788
|
+
<!-- Gauges (http://get.gaug.es/) -->
|
774
789
|
<script>
|
775
790
|
var _gauges = _gauges || [];
|
776
791
|
(function() {
|
@@ -787,7 +802,7 @@ product.</p>
|
|
787
802
|
|
788
803
|
|
789
804
|
|
790
|
-
<!-- Google Analytics (
|
805
|
+
<!-- Google Analytics (https://www.google.com/analytics) -->
|
791
806
|
<script>
|
792
807
|
!function(j,e,k,y,l,L){j.GoogleAnalyticsObject=y,j[y]||(j[y]=function(){
|
793
808
|
(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/templates/">
|
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": "Templates",
|
30
|
-
"datePublished": "2017-
|
30
|
+
"datePublished": "2017-03-22T08:06:48-07:00",
|
31
31
|
"description": "Jekyll uses the Liquid templating language to process templates. All of the standard Liquid tags and filters are supported. Jekyll even adds a few handy filters and tags of its own to make common tasks easier.",
|
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
|
|
@@ -431,6 +435,22 @@ common tasks easier.</p>
|
|
431
435
|
</p>
|
432
436
|
</td>
|
433
437
|
</tr>
|
438
|
+
<tr>
|
439
|
+
<td>
|
440
|
+
<p class="name"><strong>Group By Expression</strong></p>
|
441
|
+
<p>Group an array's items using a Liquid expression.</p>
|
442
|
+
</td>
|
443
|
+
<td class="align-center">
|
444
|
+
<p>
|
445
|
+
<code class="filter">{{ site.members | group_by_exp:"item",
|
446
|
+
"item.graduation_year | truncate: 3, \"\"" }}</code>
|
447
|
+
</p>
|
448
|
+
<p>
|
449
|
+
<code class="output">[{"name"=>"201...", "items"=>[...]},
|
450
|
+
{"name"=>"200...", "items"=>[...]}]</code>
|
451
|
+
</p>
|
452
|
+
</td>
|
453
|
+
</tr>
|
434
454
|
<tr>
|
435
455
|
<td>
|
436
456
|
<p class="name"><strong>XML Escape</strong></p>
|
@@ -492,7 +512,7 @@ common tasks easier.</p>
|
|
492
512
|
<tr>
|
493
513
|
<td>
|
494
514
|
<p class="name"><strong>Array to Sentence</strong></p>
|
495
|
-
<p>Convert an array into a sentence. Useful for listing tags.</p>
|
515
|
+
<p>Convert an array into a sentence. Useful for listing tags. Optional argument for connector.</p>
|
496
516
|
</td>
|
497
517
|
<td class="align-center">
|
498
518
|
<p>
|
@@ -501,6 +521,12 @@ common tasks easier.</p>
|
|
501
521
|
<p>
|
502
522
|
<code class="output">foo, bar, and baz</code>
|
503
523
|
</p>
|
524
|
+
<p>
|
525
|
+
<code class="filter">{{ page.tags | array_to_sentence_string: 'or' }}</code>
|
526
|
+
</p>
|
527
|
+
<p>
|
528
|
+
<code class="output">foo, bar, or baz</code>
|
529
|
+
</p>
|
504
530
|
</td>
|
505
531
|
</tr>
|
506
532
|
<tr>
|
@@ -690,60 +716,16 @@ The default is <code class="highlighter-rouge">default</code>. They are as follo
|
|
690
716
|
|
691
717
|
<h3 id="includes">Includes</h3>
|
692
718
|
|
693
|
-
<p>If you have small page
|
694
|
-
your site, you can use the <code class="highlighter-rouge">include</code> tag.</p>
|
719
|
+
<p>If you have small page snippets that you want to include in multiple places on your site, save the snippets as <em>include files</em> and insert them where required, by using the <code class="highlighter-rouge">include</code> tag:</p>
|
695
720
|
|
696
721
|
<div class="language-liquid highlighter-rouge">
|
697
722
|
<pre class="highlight"><code><span class="p">{%</span><span class="w"> </span><span class="nt">include</span><span class="w"> </span><span class="na">footer</span><span class="p">.</span><span class="na">html</span><span class="w"> </span><span class="p">%}</span>
|
698
723
|
</code></pre>
|
699
724
|
</div>
|
700
725
|
|
701
|
-
<p>Jekyll expects all include files to be placed in an <code class="highlighter-rouge">_includes</code> directory at the
|
702
|
-
root of your source directory. This will embed the contents of
|
703
|
-
<code class="highlighter-rouge"><source>/_includes/footer.html</code> into the calling file.</p>
|
704
|
-
|
705
|
-
<div class="note">
|
706
|
-
<h5>ProTip™: Use variables as file name</h5>
|
707
|
-
<p>
|
708
|
-
|
709
|
-
The name of the file you wish to embed can be literal (as in the example above),
|
710
|
-
or you can use a variable, using liquid-like variable syntax as in
|
711
|
-
<code>{% include {{my_variable}} %}</code>.
|
712
|
-
|
713
|
-
</p>
|
714
|
-
</div>
|
715
|
-
|
716
|
-
<p>You can also pass parameters to an include. Omit the quotation marks to send a variable’s value. Liquid curly brackets should not be used here:</p>
|
717
|
-
|
718
|
-
<div class="language-liquid highlighter-rouge">
|
719
|
-
<pre class="highlight"><code><span class="p">{%</span><span class="w"> </span><span class="nt">include</span><span class="w"> </span><span class="na">footer</span><span class="p">.</span><span class="na">html</span><span class="w"> </span><span class="na">param</span><span class="o">=</span><span class="s2">"value"</span><span class="w"> </span><span class="na">variable-param</span><span class="o">=</span><span class="nv">page</span><span class="p">.</span><span class="nv">variable</span><span class="w"> </span><span class="p">%}</span>
|
720
|
-
</code></pre>
|
721
|
-
</div>
|
722
|
-
|
723
|
-
<p>These parameters are available via Liquid in the include:</p>
|
724
|
-
|
725
|
-
<div class="language-liquid highlighter-rouge">
|
726
|
-
<pre class="highlight"><code><span class="p">{{</span><span class="w"> </span><span class="nv">include</span><span class="p">.</span><span class="nv">param</span><span class="w"> </span><span class="p">}}</span>
|
727
|
-
</code></pre>
|
728
|
-
</div>
|
729
|
-
|
730
|
-
<h4 id="including-files-relative-to-another-file">Including files relative to another file</h4>
|
731
|
-
|
732
|
-
<p>You can also choose to include file fragments relative to the current file:</p>
|
733
|
-
|
734
|
-
<div class="language-liquid highlighter-rouge">
|
735
|
-
<pre class="highlight"><code><span class="p">{%</span><span class="w"> </span><span class="nt">include</span><span class="na">_relative somedir/footer</span><span class="p">.</span><span class="na">html</span><span class="w"> </span><span class="p">%}</span>
|
736
|
-
</code></pre>
|
737
|
-
</div>
|
738
|
-
|
739
|
-
<p>You won’t need to place your included content within the <code class="highlighter-rouge">_includes</code> directory. Instead,
|
740
|
-
the inclusion is specifically relative to the file where the tag is being used. For example,
|
741
|
-
if <code class="highlighter-rouge">_posts/2014-09-03-my-file.markdown</code> uses the <code class="highlighter-rouge">include_relative</code> tag, the included file
|
742
|
-
must be within the <code class="highlighter-rouge">_posts</code> directory, or one of its subdirectories. You cannot include
|
743
|
-
files in other locations.</p>
|
726
|
+
<p>Jekyll expects all <em>include files</em> to be placed in an <code class="highlighter-rouge">_includes</code> directory at the root of your source directory. In the above example, this will embed the contents of <code class="highlighter-rouge">_includes/footer.html</code> into the calling file.</p>
|
744
727
|
|
745
|
-
<p>
|
746
|
-
such as using variables.</p>
|
728
|
+
<p>For more advanced information on using includes, see <a href="../includes">Includes</a>.</p>
|
747
729
|
|
748
730
|
<h3 id="code-snippet-highlighting">Code snippet highlighting</h3>
|
749
731
|
|
@@ -805,93 +787,103 @@ site. If you use <code class="highlighter-rouge">linenos</code>, you might want
|
|
805
787
|
definition for the <code class="highlighter-rouge">.lineno</code> class in <code class="highlighter-rouge">syntax.css</code> to distinguish the line
|
806
788
|
numbers from the highlighted code.</p>
|
807
789
|
|
808
|
-
<h3 id="
|
809
|
-
|
810
|
-
<p>If you want to include a link to a collection’s document, a post, a page
|
811
|
-
or a file the <code class="highlighter-rouge">link</code> tag will generate the correct permalink URL for the path
|
812
|
-
you specify.</p>
|
790
|
+
<h3 id="gist">Gist</h3>
|
813
791
|
|
814
|
-
<p>
|
792
|
+
<p>Use the <code class="highlighter-rouge">gist</code> tag to easily embed a GitHub Gist onto your site. This works
|
793
|
+
with public or secret gists:</p>
|
815
794
|
|
816
795
|
<div class="language-liquid highlighter-rouge">
|
817
796
|
<pre class="highlight"><code>
|
818
|
-
<span class="p">{
|
819
|
-
<span class="p">{{</span><span class="w"> </span><span class="nv">site</span><span class="p">.</span><span class="nv">baseurl</span><span class="w"> </span><span class="p">}}{%</span><span class="w"> </span><span class="nt">link</span><span class="w"> </span>_posts/<span class="mi">2016</span>-<span class="mi">07</span>-<span class="mi">26</span>-name-of-post.md<span class="w"> </span><span class="p">%}</span>
|
820
|
-
<span class="p">{{</span><span class="w"> </span><span class="nv">site</span><span class="p">.</span><span class="nv">baseurl</span><span class="w"> </span><span class="p">}}{%</span><span class="w"> </span><span class="nt">link</span><span class="w"> </span>news/index.html<span class="w"> </span><span class="p">%}</span>
|
821
|
-
<span class="p">{{</span><span class="w"> </span><span class="nv">site</span><span class="p">.</span><span class="nv">baseurl</span><span class="w"> </span><span class="p">}}{%</span><span class="w"> </span><span class="nt">link</span><span class="w"> </span>/assets/files/doc.pdf<span class="w"> </span><span class="p">%}</span>
|
797
|
+
<span class="p">{%</span><span class="w"> </span><span class="nt">gist</span><span class="w"> </span>parkr/<span class="mi">931</span>c<span class="mi">1</span>c<span class="mi">8</span>d<span class="mi">465</span>a<span class="mi">04042403</span><span class="w"> </span><span class="p">%}</span>
|
822
798
|
|
823
799
|
</code></pre>
|
824
800
|
</div>
|
825
801
|
|
826
|
-
<p>You
|
802
|
+
<p>You may also optionally specify the filename in the gist to display:</p>
|
827
803
|
|
828
804
|
<div class="language-liquid highlighter-rouge">
|
829
805
|
<pre class="highlight"><code>
|
830
|
-
|
831
|
-
[Link to a post](<span class="p">{{</span><span class="w"> </span><span class="nv">site</span><span class="p">.</span><span class="nv">baseurl</span><span class="w"> </span><span class="p">}}{%</span><span class="w"> </span><span class="nt">link</span><span class="w"> </span>_posts/<span class="mi">2016</span>-<span class="mi">07</span>-<span class="mi">26</span>-name-of-post.md<span class="w"> </span><span class="p">%}</span>)
|
832
|
-
[Link to a page](<span class="p">{{</span><span class="w"> </span><span class="nv">site</span><span class="p">.</span><span class="nv">baseurl</span><span class="w"> </span><span class="p">}}{%</span><span class="w"> </span><span class="nt">link</span><span class="w"> </span>news/index.html<span class="w"> </span><span class="p">%}</span>)
|
833
|
-
[Link to a file](<span class="p">{{</span><span class="w"> </span><span class="nv">site</span><span class="p">.</span><span class="nv">baseurl</span><span class="w"> </span><span class="p">}}{%</span><span class="w"> </span><span class="nt">link</span><span class="w"> </span>/assets/files/doc.pdf<span class="w"> </span><span class="p">%}</span>)
|
806
|
+
<span class="p">{%</span><span class="w"> </span><span class="nt">gist</span><span class="w"> </span>parkr/<span class="mi">931</span>c<span class="mi">1</span>c<span class="mi">8</span>d<span class="mi">465</span>a<span class="mi">04042403</span><span class="w"> </span>jekyll-private-gist.markdown<span class="w"> </span><span class="p">%}</span>
|
834
807
|
|
835
808
|
</code></pre>
|
836
809
|
</div>
|
837
810
|
|
838
|
-
<
|
811
|
+
<p>To use the <code class="highlighter-rouge">gist</code> tag, you’ll need to add the
|
812
|
+
<a href="https://github.com/jekyll/jekyll-gist">jekyll-gist</a> gem to your project.</p>
|
813
|
+
|
814
|
+
<h2 id="links">Links</h2>
|
815
|
+
|
816
|
+
<h3 id="link">Linking to pages</h3>
|
839
817
|
|
840
|
-
<p>
|
841
|
-
|
818
|
+
<p>To link to a post, a page, collection item, or file, the <code class="highlighter-rouge">link</code> tag will generate the correct permalink URL for the path you specify. For example, if you use the <code class="highlighter-rouge">link</code> tag to link to <code class="highlighter-rouge">mypage.html</code>, even if you change your permalink style to include the file extension or omit it, the URL formed by the <code class="highlighter-rouge">link</code> tag will always be valid.</p>
|
819
|
+
|
820
|
+
<p>You must include the file’s original extension when using the <code class="highlighter-rouge">link</code> tag. Here are some examples:</p>
|
842
821
|
|
843
822
|
<div class="language-liquid highlighter-rouge">
|
844
823
|
<pre class="highlight"><code>
|
845
|
-
<span class="p">{{</span><span class="w"> </span><span class="nv">site</span><span class="p">.</span><span class="nv">baseurl</span><span class="w"> </span><span class="p">}}{%</span><span class="w"> </span><span class="nt">
|
824
|
+
<span class="p">{{</span><span class="w"> </span><span class="nv">site</span><span class="p">.</span><span class="nv">baseurl</span><span class="w"> </span><span class="p">}}{%</span><span class="w"> </span><span class="nt">link</span><span class="w"> </span>_collection/name-of-document.md<span class="w"> </span><span class="p">%}</span>
|
825
|
+
<span class="p">{{</span><span class="w"> </span><span class="nv">site</span><span class="p">.</span><span class="nv">baseurl</span><span class="w"> </span><span class="p">}}{%</span><span class="w"> </span><span class="nt">link</span><span class="w"> </span>_posts/<span class="mi">2016</span>-<span class="mi">07</span>-<span class="mi">26</span>-name-of-post.md<span class="w"> </span><span class="p">%}</span>
|
826
|
+
<span class="p">{{</span><span class="w"> </span><span class="nv">site</span><span class="p">.</span><span class="nv">baseurl</span><span class="w"> </span><span class="p">}}{%</span><span class="w"> </span><span class="nt">link</span><span class="w"> </span>news/index.html<span class="w"> </span><span class="p">%}</span>
|
827
|
+
<span class="p">{{</span><span class="w"> </span><span class="nv">site</span><span class="p">.</span><span class="nv">baseurl</span><span class="w"> </span><span class="p">}}{%</span><span class="w"> </span><span class="nt">link</span><span class="w"> </span>/assets/files/doc.pdf<span class="w"> </span><span class="p">%}</span>
|
846
828
|
|
847
829
|
</code></pre>
|
848
830
|
</div>
|
849
831
|
|
850
|
-
<p>
|
851
|
-
path to the post:</p>
|
832
|
+
<p>You can also use the <code class="highlighter-rouge">link</code> tag to create a link in Markdown as follows:</p>
|
852
833
|
|
853
834
|
<div class="language-liquid highlighter-rouge">
|
854
835
|
<pre class="highlight"><code>
|
855
|
-
<span class="p">{{</span><span class="w"> </span><span class="nv">site</span><span class="p">.</span><span class="nv">baseurl</span><span class="w"> </span><span class="p">}}{%</span><span class="w"> </span><span class="nt">
|
836
|
+
[Link to a document](<span class="p">{{</span><span class="w"> </span><span class="nv">site</span><span class="p">.</span><span class="nv">baseurl</span><span class="w"> </span><span class="p">}}{%</span><span class="w"> </span><span class="nt">link</span><span class="w"> </span>_collection/name-of-document.md<span class="w"> </span><span class="p">%}</span>)
|
837
|
+
[Link to a post](<span class="p">{{</span><span class="w"> </span><span class="nv">site</span><span class="p">.</span><span class="nv">baseurl</span><span class="w"> </span><span class="p">}}{%</span><span class="w"> </span><span class="nt">link</span><span class="w"> </span>_posts/<span class="mi">2016</span>-<span class="mi">07</span>-<span class="mi">26</span>-name-of-post.md<span class="w"> </span><span class="p">%}</span>)
|
838
|
+
[Link to a page](<span class="p">{{</span><span class="w"> </span><span class="nv">site</span><span class="p">.</span><span class="nv">baseurl</span><span class="w"> </span><span class="p">}}{%</span><span class="w"> </span><span class="nt">link</span><span class="w"> </span>news/index.html<span class="w"> </span><span class="p">%}</span>)
|
839
|
+
[Link to a file](<span class="p">{{</span><span class="w"> </span><span class="nv">site</span><span class="p">.</span><span class="nv">baseurl</span><span class="w"> </span><span class="p">}}{%</span><span class="w"> </span><span class="nt">link</span><span class="w"> </span>/assets/files/doc.pdf<span class="w"> </span><span class="p">%}</span>)
|
856
840
|
|
857
841
|
</code></pre>
|
858
842
|
</div>
|
859
843
|
|
860
|
-
<p>
|
844
|
+
<p>(Including <code class="highlighter-rouge"><span class="p">{</span><span class="err">{</span><span class="w"> </span><span class="err">site.baseurl</span><span class="w"> </span><span class="p">}</span><span class="err">}</span></code> is optional — it depends on whether you want to preface the page URL with the <code class="highlighter-rouge">baseurl</code> value.)</p>
|
861
845
|
|
862
|
-
<p>
|
846
|
+
<p>The path to the post, page, or collection is defined as the path relative to the root directory (where your config file is) to the file, not the path from your existing page to the other page.</p>
|
847
|
+
|
848
|
+
<p>For example, suppose you’re creating a link <code class="highlighter-rouge">page_a.md</code> (stored in <code class="highlighter-rouge">pages/folder1/folder2</code>) to <code class="highlighter-rouge">page_b.md</code> (stored in <code class="highlighter-rouge">pages/folder1</code>). Your path in the link would not be <code class="highlighter-rouge">../page_b.html</code>. Instead, it would be <code class="highlighter-rouge">/pages/folder1/page_b.md</code>.</p>
|
849
|
+
|
850
|
+
<p>If you’re unsure of the path, add <code class="highlighter-rouge"><span class="p">{</span><span class="err">{</span><span class="w"> </span><span class="err">page.path</span><span class="w"> </span><span class="p">}</span><span class="err">}</span></code> to the page and it will display the path.</p>
|
851
|
+
|
852
|
+
<p>One major benefit of using the <code class="highlighter-rouge">link</code> tag is link validation. If the link doesn’t exist, Jekyll won’t build your site. This is a good thing, as it will alert you to a broken link so you can fix it (rather than allowing you to build and deploy a site with broken links).</p>
|
853
|
+
|
854
|
+
<p>Note you cannot add filters to <code class="highlighter-rouge">link</code> tags. For example, you cannot append a string using Liquid filters, such as <code class="highlighter-rouge"><span class="p">{</span><span class="err">%</span><span class="w"> </span><span class="err">link</span><span class="w"> </span><span class="err">mypage.html</span><span class="w"> </span><span class="err">|</span><span class="w"> </span><span class="err">append:</span><span class="w"> </span><span class="nt">"#section1"</span><span class="w"> </span><span class="err">%}</span><span class="w"> </span></code>. To link to sections on a page, you will need to use regular HTML or Markdown linking techniques.</p>
|
855
|
+
|
856
|
+
<h3 id="linking-to-posts">Linking to posts</h3>
|
857
|
+
|
858
|
+
<p>If you want like to include a link to a post on your site, the <code class="highlighter-rouge">post_url</code> tag will generate the correct permalink URL for the post you specify.</p>
|
863
859
|
|
864
860
|
<div class="language-liquid highlighter-rouge">
|
865
861
|
<pre class="highlight"><code>
|
866
|
-
|
862
|
+
<span class="p">{{</span><span class="w"> </span><span class="nv">site</span><span class="p">.</span><span class="nv">baseurl</span><span class="w"> </span><span class="p">}}{%</span><span class="w"> </span><span class="nt">post_url</span><span class="w"> </span><span class="mi">2010</span>-<span class="mi">07</span>-<span class="mi">21</span>-name-of-post<span class="w"> </span><span class="p">%}</span>
|
867
863
|
|
868
864
|
</code></pre>
|
869
865
|
</div>
|
870
866
|
|
871
|
-
<
|
872
|
-
|
873
|
-
<p>Use the <code class="highlighter-rouge">gist</code> tag to easily embed a GitHub Gist onto your site. This works
|
874
|
-
with public or secret gists:</p>
|
867
|
+
<p>If you organize your posts in subdirectories, you need to include subdirectory path to the post:</p>
|
875
868
|
|
876
869
|
<div class="language-liquid highlighter-rouge">
|
877
870
|
<pre class="highlight"><code>
|
878
|
-
<span class="p">{
|
871
|
+
<span class="p">{{</span><span class="w"> </span><span class="nv">site</span><span class="p">.</span><span class="nv">baseurl</span><span class="w"> </span><span class="p">}}{%</span><span class="w"> </span><span class="nt">post_url</span><span class="w"> </span>/subdir/<span class="mi">2010</span>-<span class="mi">07</span>-<span class="mi">21</span>-name-of-post<span class="w"> </span><span class="p">%}</span>
|
879
872
|
|
880
873
|
</code></pre>
|
881
874
|
</div>
|
882
875
|
|
883
|
-
<p>
|
876
|
+
<p>There is no need to include the file extension when using the <code class="highlighter-rouge">post_url</code> tag.</p>
|
877
|
+
|
878
|
+
<p>You can also use this tag to create a link to a post in Markdown as follows:</p>
|
884
879
|
|
885
880
|
<div class="language-liquid highlighter-rouge">
|
886
881
|
<pre class="highlight"><code>
|
887
|
-
<span class="p">{
|
882
|
+
[Name of Link](<span class="p">{{</span><span class="w"> </span><span class="nv">site</span><span class="p">.</span><span class="nv">baseurl</span><span class="w"> </span><span class="p">}}{%</span><span class="w"> </span><span class="nt">post_url</span><span class="w"> </span><span class="mi">2010</span>-<span class="mi">07</span>-<span class="mi">21</span>-name-of-post<span class="w"> </span><span class="p">%}</span>)
|
888
883
|
|
889
884
|
</code></pre>
|
890
885
|
</div>
|
891
886
|
|
892
|
-
<p>To use the <code class="highlighter-rouge">gist</code> tag, you’ll need to add the
|
893
|
-
<a href="https://github.com/jekyll/jekyll-gist">jekyll-gist</a> gem to your project.</p>
|
894
|
-
|
895
887
|
|
896
888
|
|
897
889
|
|
@@ -960,7 +952,7 @@ with public or secret gists:</p>
|
|
960
952
|
|
961
953
|
|
962
954
|
|
963
|
-
<a href="/docs/
|
955
|
+
<a href="/docs/includes/" class="next">Next</a>
|
964
956
|
|
965
957
|
</div>
|
966
958
|
</div>
|
@@ -1057,6 +1049,10 @@ with public or secret gists:</p>
|
|
1057
1049
|
|
1058
1050
|
|
1059
1051
|
|
1052
|
+
<li class=""><a href="/docs/includes/">Includes</a></li>
|
1053
|
+
|
1054
|
+
|
1055
|
+
|
1060
1056
|
<li class=""><a href="/docs/permalinks/">Permalinks</a></li>
|
1061
1057
|
|
1062
1058
|
|
@@ -1205,7 +1201,7 @@ with public or secret gists:</p>
|
|
1205
1201
|
</script>
|
1206
1202
|
|
1207
1203
|
|
1208
|
-
<!-- Gauges (http://gaug.es/) -->
|
1204
|
+
<!-- Gauges (http://get.gaug.es/) -->
|
1209
1205
|
<script>
|
1210
1206
|
var _gauges = _gauges || [];
|
1211
1207
|
(function() {
|
@@ -1222,7 +1218,7 @@ with public or secret gists:</p>
|
|
1222
1218
|
|
1223
1219
|
|
1224
1220
|
|
1225
|
-
<!-- Google Analytics (
|
1221
|
+
<!-- Google Analytics (https://www.google.com/analytics) -->
|
1226
1222
|
<script>
|
1227
1223
|
!function(j,e,k,y,l,L){j.GoogleAnalyticsObject=y,j[y]||(j[y]=function(){
|
1228
1224
|
(j[y].q=j[y].q||[]).push(arguments)}),j[y].l=+new Date,l=e.createElement(k),
|