jekyll-docs 3.9.0 → 4.0.0
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 +3 -3
- data/site/404.html +10 -7
- data/site/css/screen.css +3 -1
- data/site/css/screen.css.map +28 -0
- data/site/docs/assets/index.html +412 -453
- data/site/docs/code_of_conduct/index.html +447 -501
- data/site/docs/collections/index.html +487 -674
- data/site/docs/community/bug/index.html +603 -0
- data/site/docs/community/index.html +635 -0
- data/site/docs/conduct/index.html +447 -515
- data/site/docs/configuration/default/index.html +682 -0
- data/site/docs/configuration/environments/index.html +641 -0
- data/site/docs/configuration/front-matter-defaults/index.html +738 -0
- data/site/docs/configuration/incremental-regeneration/index.html +631 -0
- data/site/docs/configuration/index.html +405 -1230
- data/site/docs/configuration/liquid/index.html +616 -0
- data/site/docs/configuration/markdown/index.html +766 -0
- data/site/docs/configuration/options/index.html +1011 -0
- data/site/docs/configuration/webrick/index.html +615 -0
- data/site/docs/continuous-integration/buddyworks/index.html +393 -479
- data/site/docs/continuous-integration/circleci/index.html +465 -481
- data/site/docs/continuous-integration/travis-ci/index.html +450 -507
- data/site/docs/contributing/index.html +425 -514
- data/site/docs/datafiles/index.html +411 -453
- data/site/docs/deployment-methods/index.html +9 -871
- data/site/docs/deployment/automated/index.html +663 -0
- data/site/docs/deployment/index.html +607 -0
- data/site/docs/deployment/manual/index.html +631 -0
- data/site/docs/deployment/third-party/index.html +639 -0
- data/site/docs/drafts/index.html +9 -634
- data/site/docs/extras/index.html +9 -687
- data/site/docs/front-matter/index.html +799 -0
- data/site/docs/frontmatter/index.html +9 -819
- data/site/docs/github-pages/index.html +407 -475
- data/site/docs/history/index.html +1370 -1154
- data/site/docs/home/index.html +9 -627
- data/site/docs/includes/index.html +425 -501
- data/site/docs/index.html +630 -9
- data/site/docs/installation/index.html +403 -540
- data/site/docs/installation/macos/index.html +716 -0
- data/site/docs/installation/other-linux/index.html +613 -0
- data/site/docs/installation/ubuntu/index.html +623 -0
- data/site/docs/installation/windows/index.html +733 -0
- data/site/docs/layouts/index.html +726 -0
- data/site/docs/liquid/filters/index.html +1169 -0
- data/site/docs/liquid/index.html +615 -0
- data/site/docs/liquid/tags/index.html +728 -0
- data/site/docs/maintaining/affinity-team-captain/index.html +395 -479
- data/site/docs/maintaining/avoiding-burnout/index.html +391 -475
- data/site/docs/maintaining/becoming-a-maintainer/index.html +391 -475
- data/site/docs/maintaining/index.html +391 -486
- data/site/docs/maintaining/merging-a-pull-request/index.html +406 -490
- data/site/docs/maintaining/releasing-a-new-version/index.html +409 -485
- data/site/docs/maintaining/reviewing-a-pull-request/index.html +392 -476
- data/site/docs/maintaining/special-labels/index.html +397 -481
- data/site/docs/maintaining/triaging-an-issue/index.html +394 -478
- data/site/docs/markdown-101/index.html +601 -0
- data/site/docs/migrations/index.html +396 -440
- data/site/docs/pages/index.html +408 -482
- data/site/docs/pagination/index.html +450 -509
- data/site/docs/permalinks/index.html +552 -587
- data/site/docs/plugins/commands/index.html +656 -0
- data/site/docs/plugins/converters/index.html +685 -0
- data/site/docs/plugins/filters/index.html +624 -0
- data/site/docs/plugins/generators/index.html +697 -0
- data/site/docs/plugins/hooks/index.html +838 -0
- data/site/docs/plugins/index.html +415 -1565
- data/site/docs/plugins/installation/index.html +681 -0
- data/site/docs/plugins/tags/index.html +699 -0
- data/site/docs/plugins/your-first-plugin/index.html +741 -0
- data/site/docs/posts/index.html +491 -627
- data/site/docs/quickstart/index.html +9 -645
- data/site/docs/resources/index.html +9 -761
- data/site/docs/ruby-101/index.html +640 -0
- data/site/docs/sites/index.html +9 -696
- data/site/docs/static-files/index.html +401 -433
- data/site/docs/step-by-step/01-setup/index.html +771 -0
- data/site/docs/step-by-step/02-liquid/index.html +756 -0
- data/site/docs/step-by-step/03-front-matter/index.html +730 -0
- data/site/docs/step-by-step/04-layouts/index.html +770 -0
- data/site/docs/step-by-step/05-includes/index.html +768 -0
- data/site/docs/step-by-step/06-data-files/index.html +738 -0
- data/site/docs/step-by-step/07-assets/index.html +773 -0
- data/site/docs/step-by-step/08-blogging/index.html +835 -0
- data/site/docs/step-by-step/09-collections/index.html +932 -0
- data/site/docs/step-by-step/10-deployment/index.html +842 -0
- data/site/docs/structure/index.html +411 -430
- data/site/docs/support/index.html +392 -476
- data/site/docs/templates/index.html +9 -1232
- data/site/docs/themes/index.html +487 -521
- data/site/docs/troubleshooting/index.html +443 -520
- data/site/docs/upgrading/0-to-2/index.html +437 -523
- data/site/docs/upgrading/2-to-3/index.html +422 -507
- data/site/docs/upgrading/3-to-4/index.html +765 -0
- data/site/docs/upgrading/index.html +395 -478
- data/site/docs/usage/index.html +409 -506
- data/site/docs/variables/index.html +504 -652
- data/site/docs/windows/index.html +9 -784
- data/site/feed.xml +269 -188
- data/site/feed/release.xml +324 -0
- data/site/fonts/lato-v14-latin-300.woff +0 -0
- data/site/fonts/lato-v14-latin-300.woff2 +0 -0
- data/site/fonts/lato-v14-latin-300italic.woff +0 -0
- data/site/fonts/lato-v14-latin-300italic.woff2 +0 -0
- data/site/fonts/lato-v14-latin-700.woff +0 -0
- data/site/fonts/lato-v14-latin-700.woff2 +0 -0
- data/site/fonts/lato-v14-latin-700italic.woff +0 -0
- data/site/fonts/lato-v14-latin-700italic.woff2 +0 -0
- data/site/fonts/lato-v14-latin-900.woff +0 -0
- data/site/fonts/lato-v14-latin-900.woff2 +0 -0
- data/site/fonts/lato-v14-latin-900italic.woff +0 -0
- data/site/fonts/lato-v14-latin-900italic.woff2 +0 -0
- data/site/fonts/lato-v14-latin-italic.woff +0 -0
- data/site/fonts/lato-v14-latin-italic.woff2 +0 -0
- data/site/fonts/lato-v14-latin-regular.woff +0 -0
- data/site/fonts/lato-v14-latin-regular.woff2 +0 -0
- data/site/help/index.html +9 -247
- data/site/img/forestry-logo.svg +19 -0
- data/site/img/jekyll-og.png +0 -0
- data/site/img/spacer.gif +0 -0
- data/site/index.html +56 -29
- data/site/jekyllconf/index.html +62 -35
- data/site/latest_version.txt +1 -1
- data/site/news/2013/05/05/jekyll-1-0-0-released/index.html +180 -115
- data/site/news/2013/05/08/jekyll-1-0-1-released/index.html +182 -117
- data/site/news/2013/05/12/jekyll-1-0-2-released/index.html +183 -118
- data/site/news/2013/06/07/jekyll-1-0-3-released/index.html +184 -119
- data/site/news/2013/07/14/jekyll-1-1-0-released/index.html +183 -118
- data/site/news/2013/07/24/jekyll-1-1-1-released/index.html +180 -115
- data/site/news/2013/07/25/jekyll-1-0-4-released/index.html +182 -117
- data/site/news/2013/07/25/jekyll-1-1-2-released/index.html +182 -117
- data/site/news/2013/09/06/jekyll-1-2-0-released/index.html +185 -120
- data/site/news/2013/09/14/jekyll-1-2-1-released/index.html +183 -118
- data/site/news/2013/10/28/jekyll-1-3-0-rc1-released/index.html +180 -115
- data/site/news/2013/11/04/jekyll-1-3-0-released/index.html +189 -124
- data/site/news/2013/11/26/jekyll-1-3-1-released/index.html +181 -116
- data/site/news/2013/12/07/jekyll-1-4-0-released/index.html +181 -116
- data/site/news/2013/12/09/jekyll-1-4-1-released/index.html +180 -115
- data/site/news/2013/12/16/jekyll-1-4-2-released/index.html +182 -117
- data/site/news/2014/01/13/jekyll-1-4-3-released/index.html +181 -116
- data/site/news/2014/03/24/jekyll-1-5-0-released/index.html +181 -116
- data/site/news/2014/03/27/jekyll-1-5-1-released/index.html +181 -116
- data/site/news/2014/05/06/jekyll-turns-2-0-0/index.html +184 -119
- data/site/news/2014/05/08/jekyll-2-0-3-released/index.html +180 -115
- data/site/news/2014/06/04/jekyll-stickers-1-dollar-stickermule/index.html +181 -116
- data/site/news/2014/06/28/jekyll-turns-21-i-mean-2-1-0/index.html +185 -120
- data/site/news/2014/07/01/jekyll-2-1-1-released/index.html +182 -117
- data/site/news/2014/07/29/jekyll-2-2-0-released/index.html +181 -116
- data/site/news/2014/08/10/jekyll-2-3-0-released/index.html +189 -124
- data/site/news/2014/09/09/jekyll-2-4-0-released/index.html +187 -122
- data/site/news/2014/11/05/jekylls-midlife-crisis-jekyll-turns-2-5-0/index.html +188 -123
- data/site/news/2014/11/09/jekyll-2-5-1-released/index.html +180 -115
- data/site/news/2014/11/12/jekyll-2-5-2-released/index.html +182 -117
- data/site/news/2014/12/17/alfredxing-welcome-to-jekyll-core/index.html +179 -114
- data/site/news/2014/12/22/jekyll-2-5-3-released/index.html +180 -115
- data/site/news/2015/01/20/jekyll-meet-and-greet/index.html +179 -114
- data/site/news/2015/01/24/jekyll-3-0-0-beta1-released/index.html +180 -115
- data/site/news/2015/02/26/introducing-jekyll-talk/index.html +180 -115
- data/site/news/2015/10/26/jekyll-3-0-released/index.html +185 -120
- data/site/news/2015/11/17/jekyll-3-0-1-released/index.html +184 -119
- data/site/news/2016/01/20/jekyll-3-0-2-released/index.html +182 -117
- data/site/news/2016/01/24/jekyll-3-1-0-released/index.html +186 -121
- data/site/news/2016/01/28/jekyll-3-1-1-released/index.html +183 -118
- data/site/news/2016/02/08/jekyll-3-0-3-released/index.html +181 -116
- data/site/news/2016/02/19/jekyll-3-1-2-released/index.html +182 -117
- data/site/news/2016/03/10/making-it-easier-to-contribute-to-jekyll/index.html +179 -114
- data/site/news/2016/04/19/jekyll-3-0-4-released/index.html +181 -116
- data/site/news/2016/04/19/jekyll-3-1-3-released/index.html +181 -116
- data/site/news/2016/04/26/jekyll-3-0-5-released/index.html +180 -115
- data/site/news/2016/05/18/jekyll-3-1-4-released/index.html +186 -121
- data/site/news/2016/05/18/jekyll-3-1-5-released/index.html +181 -116
- data/site/news/2016/05/19/jekyll-3-1-6-released/index.html +181 -116
- data/site/news/2016/06/03/update-on-jekyll-s-google-summer-of-code-projects/index.html +179 -114
- data/site/news/2016/07/26/jekyll-3-2-0-released/index.html +184 -119
- data/site/news/2016/08/02/jekyll-3-2-1-released/index.html +180 -115
- data/site/news/2016/08/24/jekyll-admin-initial-release/index.html +179 -114
- data/site/news/2016/10/06/jekyll-3-3-is-here/index.html +207 -142
- data/site/news/2016/11/14/jekyll-3-3-1-released/index.html +181 -116
- data/site/news/2017/01/18/jekyll-3-4-0-released/index.html +183 -118
- data/site/news/2017/03/02/jekyll-3-4-1-released/index.html +181 -116
- data/site/news/2017/03/09/jekyll-3-4-2-released/index.html +189 -124
- data/site/news/2017/03/21/jekyll-3-4-3-released/index.html +190 -125
- data/site/news/2017/06/15/jekyll-3-5-0-released/index.html +187 -122
- data/site/news/2017/07/17/jekyll-3-5-1-released/index.html +182 -117
- data/site/news/2017/08/12/jekyll-3-5-2-released/index.html +185 -120
- data/site/news/2017/09/21/jekyll-3-6-0-released/index.html +181 -116
- data/site/news/2017/10/19/diversity-open-source/index.html +181 -116
- data/site/news/2017/10/21/jekyll-3-6-2-released/index.html +183 -118
- data/site/news/2018/01/02/jekyll-3-7-0-released/index.html +184 -119
- data/site/news/2018/01/25/jekyll-3-7-2-released/index.html +189 -124
- data/site/news/2018/02/19/meet-jekyll-s-new-lead-developer/index.html +180 -115
- data/site/news/2018/02/24/jekyll-3-7-3-released/index.html +185 -120
- data/site/news/2018/04/19/development-update/index.html +699 -0
- data/site/news/2018/04/19/jekyll-3-8-0-released/index.html +715 -0
- data/site/news/2018/05/01/jekyll-3-8-1-released/index.html +182 -117
- data/site/news/2018/05/19/jekyll-3-8-2-released/index.html +181 -116
- data/site/news/2018/06/05/jekyll-3-8-3-released/index.html +183 -118
- data/site/news/2018/08/01/jekyll-sponsoring/index.html +748 -0
- data/site/news/2018/09/19/security-fixes-for-3-6-3-7-3-8/index.html +692 -0
- data/site/news/2018/11/04/jekyll-3-8-5-released/index.html +682 -0
- data/site/news/2019/03/18/jekyll-4-0-0-pre-alpha1-released/index.html +710 -0
- data/site/news/2019/07/02/jekyll-3-8-6-released/index.html +180 -115
- data/site/news/2019/07/20/jekyll-4-0-0-pre-beta1-released/index.html +11 -0
- data/site/news/2019/08/04/jekyll-4-0-0-pre-beta1-released/index.html +708 -0
- data/site/news/2019/08/20/jekyll-4-0-0-released/index.html +809 -0
- data/site/news/index.html +976 -326
- data/site/news/releases/index.html +820 -321
- data/site/{philosophy.html → philosophy/index.html} +1 -1
- data/site/redirects.json +1 -1
- data/site/resources/index.html +332 -0
- data/site/showcase/index.html +844 -0
- data/site/sitemap.xml +256 -81
- data/site/team/index.html +63 -77
- data/site/tutorials/cache-api/index.html +418 -0
- data/site/tutorials/convert-site-to-jekyll/index.html +155 -124
- data/site/tutorials/custom-404-page/index.html +76 -43
- data/site/tutorials/home/index.html +64 -37
- data/site/tutorials/navigation/index.html +186 -103
- data/site/tutorials/orderofinterpretation/index.html +80 -53
- data/site/tutorials/using-jekyll-with-bundler/index.html +80 -51
- data/site/tutorials/video-walkthroughs/index.html +62 -35
- metadata +102 -13
- data/site/community/index.html +0 -11
- data/site/docs/continuous-integration/index.html +0 -681
@@ -0,0 +1,768 @@
|
|
1
|
+
<!DOCTYPE HTML>
|
2
|
+
<html lang="en-US">
|
3
|
+
<head>
|
4
|
+
<meta charset="UTF-8">
|
5
|
+
<meta name="viewport" content="width=device-width,initial-scale=1">
|
6
|
+
<meta name="generator" content="Jekyll v4.0.0">
|
7
|
+
<link type="application/atom+xml" rel="alternate" href="https://jekyllrb.com/feed.xml" title="Jekyll • Simple, blog-aware, static sites" />
|
8
|
+
<link type="application/atom+xml" rel="alternate" href="/feed/release.xml" title="Jekyll releases posts" />
|
9
|
+
<link rel="alternate" type="application/atom+xml" title="Recent commits to Jekyll’s master branch" href="https://github.com/jekyll/jekyll/commits/master.atom">
|
10
|
+
<link rel="preload" href="/fonts/lato-v14-latin-300.woff2" as="font" type="font/woff2" crossorigin />
|
11
|
+
<link rel="preload" href="/fonts/lato-v14-latin-700.woff2" as="font" type="font/woff2" crossorigin />
|
12
|
+
<link rel="preload" href="/css/screen.css" as="style">
|
13
|
+
<link rel="stylesheet" href="/css/screen.css">
|
14
|
+
<link rel="icon" type="image/x-icon" href="/favicon.ico">
|
15
|
+
<!-- Begin Jekyll SEO tag v2.6.1 -->
|
16
|
+
<title>Includes | Jekyll • Simple, blog-aware, static sites</title>
|
17
|
+
<meta name="generator" content="Jekyll v4.0.0" />
|
18
|
+
<meta property="og:title" content="Includes" />
|
19
|
+
<meta property="og:locale" content="en_US" />
|
20
|
+
<meta name="description" content="The site is coming together; however, there’s no way to navigate between pages. Let’s fix that." />
|
21
|
+
<meta property="og:description" content="The site is coming together; however, there’s no way to navigate between pages. Let’s fix that." />
|
22
|
+
<link rel="canonical" href="https://jekyllrb.com/docs/step-by-step/05-includes/" />
|
23
|
+
<meta property="og:url" content="https://jekyllrb.com/docs/step-by-step/05-includes/" />
|
24
|
+
<meta property="og:site_name" content="Jekyll • Simple, blog-aware, static sites" />
|
25
|
+
<meta property="og:image" content="https://jekyllrb.com/img/jekyll-og.png" />
|
26
|
+
<meta property="og:type" content="article" />
|
27
|
+
<meta property="article:published_time" content="2019-09-11T07:30:27-07:00" />
|
28
|
+
<meta name="twitter:card" content="summary_large_image" />
|
29
|
+
<meta property="twitter:image" content="https://jekyllrb.com/img/jekyll-og.png" />
|
30
|
+
<meta property="twitter:title" content="Includes" />
|
31
|
+
<meta name="twitter:site" content="@jekyllrb" />
|
32
|
+
<meta name="google-site-verification" content="onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY" />
|
33
|
+
<script type="application/ld+json">
|
34
|
+
{"description":"The site is coming together; however, there’s no way to navigate between pages. Let’s fix that.","@type":"BlogPosting","mainEntityOfPage":{"@type":"WebPage","@id":"https://jekyllrb.com/docs/step-by-step/05-includes/"},"headline":"Includes","dateModified":"2019-09-11T07:30:27-07:00","url":"https://jekyllrb.com/docs/step-by-step/05-includes/","datePublished":"2019-09-11T07:30:27-07:00","image":"https://jekyllrb.com/img/jekyll-og.png","publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://jekyllrb.com/img/logo-2x.png"}},"@context":"https://schema.org"}</script>
|
35
|
+
<!-- End Jekyll SEO tag -->
|
36
|
+
|
37
|
+
<!--[if lt IE 9]>
|
38
|
+
<script src="/js/html5shiv.min.js"></script>
|
39
|
+
<script src="/js/respond.min.js"></script>
|
40
|
+
<![endif]-->
|
41
|
+
</head>
|
42
|
+
|
43
|
+
|
44
|
+
<body class="wrap">
|
45
|
+
<header>
|
46
|
+
<div class="flexbox">
|
47
|
+
<div class="center-on-mobiles">
|
48
|
+
<h1>
|
49
|
+
<a href="/" class="logo">
|
50
|
+
<span class="sr-only">Jekyll</span>
|
51
|
+
<img src="/img/logo-2x.png" width="140" height="65" alt="Jekyll Logo">
|
52
|
+
</a>
|
53
|
+
</h1>
|
54
|
+
</div>
|
55
|
+
<nav class="main-nav hide-on-mobiles">
|
56
|
+
<ul>
|
57
|
+
|
58
|
+
<li>
|
59
|
+
<a href="/">Home</a>
|
60
|
+
</li>
|
61
|
+
|
62
|
+
<li class="current">
|
63
|
+
<a href="/docs/">Docs</a>
|
64
|
+
</li>
|
65
|
+
|
66
|
+
<li>
|
67
|
+
<a href="/resources/">Resources</a>
|
68
|
+
</li>
|
69
|
+
|
70
|
+
<li>
|
71
|
+
<a href="/showcase/">Showcase</a>
|
72
|
+
</li>
|
73
|
+
|
74
|
+
<li>
|
75
|
+
<a href="/news/">News</a>
|
76
|
+
</li>
|
77
|
+
|
78
|
+
</ul>
|
79
|
+
|
80
|
+
</nav>
|
81
|
+
<div class="search hide-on-mobiles">
|
82
|
+
<input type="text" id="docsearch-input" placeholder="Search the docs…">
|
83
|
+
|
84
|
+
</div>
|
85
|
+
<div class="meta hide-on-mobiles">
|
86
|
+
<ul>
|
87
|
+
<li>
|
88
|
+
<a href="https://github.com/jekyll/jekyll/releases/tag/v4.0.0">v4.0.0</a>
|
89
|
+
</li>
|
90
|
+
<li>
|
91
|
+
<a href="https://github.com/jekyll/jekyll">GitHub</a>
|
92
|
+
</li>
|
93
|
+
</ul>
|
94
|
+
</div>
|
95
|
+
</div>
|
96
|
+
<nav class="mobile-nav show-on-mobiles">
|
97
|
+
<ul>
|
98
|
+
|
99
|
+
<li>
|
100
|
+
<a href="/">Home</a>
|
101
|
+
</li>
|
102
|
+
|
103
|
+
<li class="current">
|
104
|
+
<a href="/docs/">Docs</a>
|
105
|
+
</li>
|
106
|
+
|
107
|
+
<li>
|
108
|
+
<a href="/resources/">Resources</a>
|
109
|
+
</li>
|
110
|
+
|
111
|
+
|
112
|
+
<li>
|
113
|
+
<a href="/news/">News</a>
|
114
|
+
</li>
|
115
|
+
|
116
|
+
<li>
|
117
|
+
<a href="https://github.com/jekyll/jekyll">GitHub</a>
|
118
|
+
</li>
|
119
|
+
</ul>
|
120
|
+
|
121
|
+
</nav>
|
122
|
+
</header>
|
123
|
+
|
124
|
+
|
125
|
+
<section class="docs">
|
126
|
+
<div class="grid">
|
127
|
+
|
128
|
+
<div class="docs-nav-mobile unit whole show-on-mobiles">
|
129
|
+
<select onchange="if (this.value) window.location.href=this.value">
|
130
|
+
<option value="">Navigate the docs…</option>
|
131
|
+
|
132
|
+
<optgroup label="Getting Started">
|
133
|
+
|
134
|
+
|
135
|
+
<option value="/docs/">
|
136
|
+
Quickstart
|
137
|
+
</option>
|
138
|
+
|
139
|
+
|
140
|
+
<option value="/docs/ruby-101/">
|
141
|
+
Ruby 101
|
142
|
+
</option>
|
143
|
+
|
144
|
+
|
145
|
+
<option value="/docs/installation/">
|
146
|
+
Installation
|
147
|
+
</option>
|
148
|
+
|
149
|
+
|
150
|
+
<option value="/docs/community/">
|
151
|
+
Community
|
152
|
+
</option>
|
153
|
+
|
154
|
+
|
155
|
+
<option value="/docs/step-by-step/01-setup/">
|
156
|
+
Step by Step Tutorial
|
157
|
+
</option>
|
158
|
+
|
159
|
+
</optgroup>
|
160
|
+
|
161
|
+
<optgroup label="Build">
|
162
|
+
|
163
|
+
|
164
|
+
<option value="/docs/usage/">
|
165
|
+
Command Line Usage
|
166
|
+
</option>
|
167
|
+
|
168
|
+
|
169
|
+
<option value="/docs/configuration/">
|
170
|
+
Configuration
|
171
|
+
</option>
|
172
|
+
|
173
|
+
</optgroup>
|
174
|
+
|
175
|
+
<optgroup label="Content">
|
176
|
+
|
177
|
+
|
178
|
+
<option value="/docs/pages/">
|
179
|
+
Pages
|
180
|
+
</option>
|
181
|
+
|
182
|
+
|
183
|
+
<option value="/docs/posts/">
|
184
|
+
Posts
|
185
|
+
</option>
|
186
|
+
|
187
|
+
|
188
|
+
<option value="/docs/front-matter/">
|
189
|
+
Front Matter
|
190
|
+
</option>
|
191
|
+
|
192
|
+
|
193
|
+
<option value="/docs/collections/">
|
194
|
+
Collections
|
195
|
+
</option>
|
196
|
+
|
197
|
+
|
198
|
+
<option value="/docs/datafiles/">
|
199
|
+
Data Files
|
200
|
+
</option>
|
201
|
+
|
202
|
+
|
203
|
+
<option value="/docs/assets/">
|
204
|
+
Assets
|
205
|
+
</option>
|
206
|
+
|
207
|
+
|
208
|
+
<option value="/docs/static-files/">
|
209
|
+
Static Files
|
210
|
+
</option>
|
211
|
+
|
212
|
+
</optgroup>
|
213
|
+
|
214
|
+
<optgroup label="Site Structure">
|
215
|
+
|
216
|
+
|
217
|
+
<option value="/docs/structure/">
|
218
|
+
Directory Structure
|
219
|
+
</option>
|
220
|
+
|
221
|
+
|
222
|
+
<option value="/docs/liquid/">
|
223
|
+
Liquid
|
224
|
+
</option>
|
225
|
+
|
226
|
+
|
227
|
+
<option value="/docs/variables/">
|
228
|
+
Variables
|
229
|
+
</option>
|
230
|
+
|
231
|
+
|
232
|
+
<option value="/docs/includes/">
|
233
|
+
Includes
|
234
|
+
</option>
|
235
|
+
|
236
|
+
|
237
|
+
<option value="/docs/layouts/">
|
238
|
+
Layouts
|
239
|
+
</option>
|
240
|
+
|
241
|
+
|
242
|
+
<option value="/docs/permalinks/">
|
243
|
+
Permalinks
|
244
|
+
</option>
|
245
|
+
|
246
|
+
|
247
|
+
<option value="/docs/themes/">
|
248
|
+
Themes
|
249
|
+
</option>
|
250
|
+
|
251
|
+
|
252
|
+
<option value="/docs/pagination/">
|
253
|
+
Pagination
|
254
|
+
</option>
|
255
|
+
|
256
|
+
</optgroup>
|
257
|
+
|
258
|
+
<optgroup label="Guides">
|
259
|
+
|
260
|
+
|
261
|
+
<option value="/docs/plugins/">
|
262
|
+
Plugins
|
263
|
+
</option>
|
264
|
+
|
265
|
+
|
266
|
+
<option value="/docs/migrations/">
|
267
|
+
Blog Migrations
|
268
|
+
</option>
|
269
|
+
|
270
|
+
|
271
|
+
<option value="/docs/upgrading/">
|
272
|
+
Upgrading
|
273
|
+
</option>
|
274
|
+
|
275
|
+
|
276
|
+
<option value="/docs/deployment/">
|
277
|
+
Deployment
|
278
|
+
</option>
|
279
|
+
|
280
|
+
</optgroup>
|
281
|
+
|
282
|
+
</select>
|
283
|
+
</div>
|
284
|
+
|
285
|
+
|
286
|
+
<div class="unit four-fifths">
|
287
|
+
<article>
|
288
|
+
<div class="improve right hide-on-mobiles">
|
289
|
+
<a data-proofer-ignore href="https://github.com/jekyll/jekyll/edit/master/docs/_docs/step-by-step/05-includes.md"><i class="fa fa-pencil"></i> Improve this page</a>
|
290
|
+
</div>
|
291
|
+
<h1>Step by Step Tutorial</h1>
|
292
|
+
<h2>5. Includes</h2>
|
293
|
+
<p>The site is coming together; however, there’s no way to navigate between
|
294
|
+
pages. Let’s fix that.</p>
|
295
|
+
|
296
|
+
<p>Navigation should be on every page so adding it to your layout is the correct
|
297
|
+
place to do this. Instead of adding it directly to the layout, let’s use this
|
298
|
+
as an opportunity to learn about includes.</p>
|
299
|
+
|
300
|
+
<h2 id="include-tag">Include tag</h2>
|
301
|
+
|
302
|
+
<p>The <code class="highlighter-rouge">include</code> tag allows you to include content from another file stored
|
303
|
+
in an <code class="highlighter-rouge">_includes</code> folder. Includes are useful for having a single source for
|
304
|
+
source code that repeats around the site or for improving the readability.</p>
|
305
|
+
|
306
|
+
<p>Navigation source code can get complex so sometimes it’s nice to move it into an
|
307
|
+
include.</p>
|
308
|
+
|
309
|
+
<h2 id="include-usage">Include usage</h2>
|
310
|
+
|
311
|
+
<p>Create a file for the navigation at <code class="highlighter-rouge">_includes/navigation.html</code> with the
|
312
|
+
following content:</p>
|
313
|
+
|
314
|
+
<div class="language-liquid highlighter-rouge"><div class="highlight"><pre class="highlight"><code><nav>
|
315
|
+
<a href="/">Home</a>
|
316
|
+
<a href="/about.html">About</a>
|
317
|
+
</nav>
|
318
|
+
</code></pre></div></div>
|
319
|
+
|
320
|
+
<p>Try using the include tag to add the navigation to <code class="highlighter-rouge">_layouts/default.html</code>:</p>
|
321
|
+
|
322
|
+
<div class="language-liquid highlighter-rouge"><div class="highlight"><pre class="highlight"><code><!doctype html>
|
323
|
+
<html>
|
324
|
+
<head>
|
325
|
+
<meta charset="utf-8">
|
326
|
+
<title><span class="p">{{</span><span class="w"> </span><span class="nv">page</span><span class="p">.</span><span class="nv">title</span><span class="w"> </span><span class="p">}}</span></title>
|
327
|
+
</head>
|
328
|
+
<body>
|
329
|
+
<span class="p">{%</span><span class="w"> </span><span class="nt">include</span><span class="w"> </span><span class="na">navigation</span><span class="p">.</span><span class="na">html</span><span class="w"> </span><span class="p">%}</span>
|
330
|
+
<span class="p">{{</span><span class="w"> </span><span class="nv">content</span><span class="w"> </span><span class="p">}}</span>
|
331
|
+
</body>
|
332
|
+
</html>
|
333
|
+
</code></pre></div></div>
|
334
|
+
|
335
|
+
<p>Open <a href="http://localhost:4000" target="_blank" data-proofer-ignore="">http://localhost:4000</a>
|
336
|
+
in your browser and try switching between the pages.</p>
|
337
|
+
|
338
|
+
<h2 id="current-page-highlighting">Current page highlighting</h2>
|
339
|
+
|
340
|
+
<p>Let’s take this a step further and highlight the current page in the navigation.</p>
|
341
|
+
|
342
|
+
<p><code class="highlighter-rouge">_includes/navigation.html</code> needs to know the URL of the page it’s inserted into
|
343
|
+
so it can add styling. Jekyll has useful <a href="/docs/variables/">variables</a> available
|
344
|
+
one of which is <code class="highlighter-rouge">page.url</code>.</p>
|
345
|
+
|
346
|
+
<p>Using <code class="highlighter-rouge">page.url</code> you can check if each link is the current page and color it red
|
347
|
+
if true:</p>
|
348
|
+
|
349
|
+
<div class="language-liquid highlighter-rouge"><div class="highlight"><pre class="highlight"><code><nav>
|
350
|
+
<a href="/" <span class="p">{%</span><span class="w"> </span><span class="kr">if</span><span class="w"> </span><span class="nv">page</span><span class="p">.</span><span class="nv">url</span><span class="w"> </span><span class="o">==</span><span class="w"> </span><span class="s2">"/"</span><span class="w"> </span><span class="p">%}</span>style="color: red;"<span class="p">{%</span><span class="w"> </span><span class="kr">endif</span><span class="w"> </span><span class="p">%}</span>>
|
351
|
+
Home
|
352
|
+
</a>
|
353
|
+
<a href="/about.html" <span class="p">{%</span><span class="w"> </span><span class="kr">if</span><span class="w"> </span><span class="nv">page</span><span class="p">.</span><span class="nv">url</span><span class="w"> </span><span class="o">==</span><span class="w"> </span><span class="s2">"/about.html"</span><span class="w"> </span><span class="p">%}</span>style="color: red;"<span class="p">{%</span><span class="w"> </span><span class="kr">endif</span><span class="w"> </span><span class="p">%}</span>>
|
354
|
+
About
|
355
|
+
</a>
|
356
|
+
</nav>
|
357
|
+
</code></pre></div></div>
|
358
|
+
|
359
|
+
<p>Take a look at <a href="http://localhost:4000" target="_blank" data-proofer-ignore="">http://localhost:4000</a>
|
360
|
+
and see your red link for the current page.</p>
|
361
|
+
|
362
|
+
<p>There’s still a lot of repetition here if you wanted to add a new item to the
|
363
|
+
navigation or change the highlight color. In the next step we’ll address this.</p>
|
364
|
+
|
365
|
+
|
366
|
+
|
367
|
+
|
368
|
+
|
369
|
+
|
370
|
+
|
371
|
+
|
372
|
+
|
373
|
+
|
374
|
+
|
375
|
+
|
376
|
+
|
377
|
+
|
378
|
+
|
379
|
+
|
380
|
+
<div class="section-nav">
|
381
|
+
<div class="left align-right">
|
382
|
+
|
383
|
+
|
384
|
+
<a href="/docs/step-by-step/04-layouts/" class="prev">Back</a>
|
385
|
+
|
386
|
+
</div>
|
387
|
+
<div class="right align-left">
|
388
|
+
|
389
|
+
|
390
|
+
<a href="/docs/step-by-step/06-data-files/" class="next">Next</a>
|
391
|
+
|
392
|
+
</div>
|
393
|
+
</div>
|
394
|
+
<div class="clear"></div>
|
395
|
+
|
396
|
+
|
397
|
+
<ol class="step-nav">
|
398
|
+
|
399
|
+
<li >
|
400
|
+
<a href="/docs/step-by-step/01-setup/">
|
401
|
+
Setup
|
402
|
+
</a>
|
403
|
+
</li>
|
404
|
+
|
405
|
+
<li >
|
406
|
+
<a href="/docs/step-by-step/02-liquid/">
|
407
|
+
Liquid
|
408
|
+
</a>
|
409
|
+
</li>
|
410
|
+
|
411
|
+
<li >
|
412
|
+
<a href="/docs/step-by-step/03-front-matter/">
|
413
|
+
Front Matter
|
414
|
+
</a>
|
415
|
+
</li>
|
416
|
+
|
417
|
+
<li >
|
418
|
+
<a href="/docs/step-by-step/04-layouts/">
|
419
|
+
Layouts
|
420
|
+
</a>
|
421
|
+
</li>
|
422
|
+
|
423
|
+
<li class="current">
|
424
|
+
<a href="/docs/step-by-step/05-includes/">
|
425
|
+
Includes
|
426
|
+
</a>
|
427
|
+
</li>
|
428
|
+
|
429
|
+
<li >
|
430
|
+
<a href="/docs/step-by-step/06-data-files/">
|
431
|
+
Data Files
|
432
|
+
</a>
|
433
|
+
</li>
|
434
|
+
|
435
|
+
<li >
|
436
|
+
<a href="/docs/step-by-step/07-assets/">
|
437
|
+
Assets
|
438
|
+
</a>
|
439
|
+
</li>
|
440
|
+
|
441
|
+
<li >
|
442
|
+
<a href="/docs/step-by-step/08-blogging/">
|
443
|
+
Blogging
|
444
|
+
</a>
|
445
|
+
</li>
|
446
|
+
|
447
|
+
<li >
|
448
|
+
<a href="/docs/step-by-step/09-collections/">
|
449
|
+
Collections
|
450
|
+
</a>
|
451
|
+
</li>
|
452
|
+
|
453
|
+
<li >
|
454
|
+
<a href="/docs/step-by-step/10-deployment/">
|
455
|
+
Deployment
|
456
|
+
</a>
|
457
|
+
</li>
|
458
|
+
|
459
|
+
</ol>
|
460
|
+
|
461
|
+
</article>
|
462
|
+
</div>
|
463
|
+
|
464
|
+
<div class="unit one-fifth hide-on-mobiles">
|
465
|
+
<aside>
|
466
|
+
|
467
|
+
<h4>Getting Started</h4>
|
468
|
+
<ul>
|
469
|
+
|
470
|
+
|
471
|
+
<li>
|
472
|
+
<a href="/docs/">
|
473
|
+
Quickstart
|
474
|
+
</a>
|
475
|
+
</li>
|
476
|
+
|
477
|
+
|
478
|
+
<li>
|
479
|
+
<a href="/docs/ruby-101/">
|
480
|
+
Ruby 101
|
481
|
+
</a>
|
482
|
+
</li>
|
483
|
+
|
484
|
+
|
485
|
+
<li>
|
486
|
+
<a href="/docs/installation/">
|
487
|
+
Installation
|
488
|
+
</a>
|
489
|
+
</li>
|
490
|
+
|
491
|
+
|
492
|
+
<li>
|
493
|
+
<a href="/docs/community/">
|
494
|
+
Community
|
495
|
+
</a>
|
496
|
+
</li>
|
497
|
+
|
498
|
+
|
499
|
+
<li>
|
500
|
+
<a href="/docs/step-by-step/01-setup/">
|
501
|
+
Step by Step Tutorial
|
502
|
+
</a>
|
503
|
+
</li>
|
504
|
+
|
505
|
+
</ul>
|
506
|
+
|
507
|
+
<h4>Build</h4>
|
508
|
+
<ul>
|
509
|
+
|
510
|
+
|
511
|
+
<li>
|
512
|
+
<a href="/docs/usage/">
|
513
|
+
Command Line Usage
|
514
|
+
</a>
|
515
|
+
</li>
|
516
|
+
|
517
|
+
|
518
|
+
<li>
|
519
|
+
<a href="/docs/configuration/">
|
520
|
+
Configuration
|
521
|
+
</a>
|
522
|
+
</li>
|
523
|
+
|
524
|
+
</ul>
|
525
|
+
|
526
|
+
<h4>Content</h4>
|
527
|
+
<ul>
|
528
|
+
|
529
|
+
|
530
|
+
<li>
|
531
|
+
<a href="/docs/pages/">
|
532
|
+
Pages
|
533
|
+
</a>
|
534
|
+
</li>
|
535
|
+
|
536
|
+
|
537
|
+
<li>
|
538
|
+
<a href="/docs/posts/">
|
539
|
+
Posts
|
540
|
+
</a>
|
541
|
+
</li>
|
542
|
+
|
543
|
+
|
544
|
+
<li>
|
545
|
+
<a href="/docs/front-matter/">
|
546
|
+
Front Matter
|
547
|
+
</a>
|
548
|
+
</li>
|
549
|
+
|
550
|
+
|
551
|
+
<li>
|
552
|
+
<a href="/docs/collections/">
|
553
|
+
Collections
|
554
|
+
</a>
|
555
|
+
</li>
|
556
|
+
|
557
|
+
|
558
|
+
<li>
|
559
|
+
<a href="/docs/datafiles/">
|
560
|
+
Data Files
|
561
|
+
</a>
|
562
|
+
</li>
|
563
|
+
|
564
|
+
|
565
|
+
<li>
|
566
|
+
<a href="/docs/assets/">
|
567
|
+
Assets
|
568
|
+
</a>
|
569
|
+
</li>
|
570
|
+
|
571
|
+
|
572
|
+
<li>
|
573
|
+
<a href="/docs/static-files/">
|
574
|
+
Static Files
|
575
|
+
</a>
|
576
|
+
</li>
|
577
|
+
|
578
|
+
</ul>
|
579
|
+
|
580
|
+
<h4>Site Structure</h4>
|
581
|
+
<ul>
|
582
|
+
|
583
|
+
|
584
|
+
<li>
|
585
|
+
<a href="/docs/structure/">
|
586
|
+
Directory Structure
|
587
|
+
</a>
|
588
|
+
</li>
|
589
|
+
|
590
|
+
|
591
|
+
<li>
|
592
|
+
<a href="/docs/liquid/">
|
593
|
+
Liquid
|
594
|
+
</a>
|
595
|
+
</li>
|
596
|
+
|
597
|
+
|
598
|
+
<li>
|
599
|
+
<a href="/docs/variables/">
|
600
|
+
Variables
|
601
|
+
</a>
|
602
|
+
</li>
|
603
|
+
|
604
|
+
|
605
|
+
<li>
|
606
|
+
<a href="/docs/includes/">
|
607
|
+
Includes
|
608
|
+
</a>
|
609
|
+
</li>
|
610
|
+
|
611
|
+
|
612
|
+
<li>
|
613
|
+
<a href="/docs/layouts/">
|
614
|
+
Layouts
|
615
|
+
</a>
|
616
|
+
</li>
|
617
|
+
|
618
|
+
|
619
|
+
<li>
|
620
|
+
<a href="/docs/permalinks/">
|
621
|
+
Permalinks
|
622
|
+
</a>
|
623
|
+
</li>
|
624
|
+
|
625
|
+
|
626
|
+
<li>
|
627
|
+
<a href="/docs/themes/">
|
628
|
+
Themes
|
629
|
+
</a>
|
630
|
+
</li>
|
631
|
+
|
632
|
+
|
633
|
+
<li>
|
634
|
+
<a href="/docs/pagination/">
|
635
|
+
Pagination
|
636
|
+
</a>
|
637
|
+
</li>
|
638
|
+
|
639
|
+
</ul>
|
640
|
+
|
641
|
+
<h4>Guides</h4>
|
642
|
+
<ul>
|
643
|
+
|
644
|
+
|
645
|
+
<li>
|
646
|
+
<a href="/docs/plugins/">
|
647
|
+
Plugins
|
648
|
+
</a>
|
649
|
+
</li>
|
650
|
+
|
651
|
+
|
652
|
+
<li>
|
653
|
+
<a href="/docs/migrations/">
|
654
|
+
Blog Migrations
|
655
|
+
</a>
|
656
|
+
</li>
|
657
|
+
|
658
|
+
|
659
|
+
<li>
|
660
|
+
<a href="/docs/upgrading/">
|
661
|
+
Upgrading
|
662
|
+
</a>
|
663
|
+
</li>
|
664
|
+
|
665
|
+
|
666
|
+
<li>
|
667
|
+
<a href="/docs/deployment/">
|
668
|
+
Deployment
|
669
|
+
</a>
|
670
|
+
</li>
|
671
|
+
|
672
|
+
</ul>
|
673
|
+
|
674
|
+
</aside>
|
675
|
+
</div>
|
676
|
+
|
677
|
+
|
678
|
+
<div class="clear"></div>
|
679
|
+
|
680
|
+
</div>
|
681
|
+
</section>
|
682
|
+
|
683
|
+
|
684
|
+
<footer>
|
685
|
+
<div class="grid">
|
686
|
+
<div class="unit one-third center-on-mobiles">
|
687
|
+
<p>Jekyll is lovingly maintained by the <a href="/team/">core team</a> of volunteers. </p>
|
688
|
+
<p>The contents of this website are <br />© 2019 under the terms of the <a href="https://github.com/jekyll/jekyll/blob/master/LICENSE">MIT License</a>.</p>
|
689
|
+
</div>
|
690
|
+
<div class="unit two-thirds align-right center-on-mobiles">
|
691
|
+
<p>
|
692
|
+
Proudly hosted by
|
693
|
+
<a href="https://github.com">
|
694
|
+
<img src="/img/footer-logo.png" width="100" height="30" alt="GitHub • Social coding">
|
695
|
+
</a>
|
696
|
+
</p>
|
697
|
+
</div>
|
698
|
+
<div class="unit two-thirds align-right center-on-mobiles">
|
699
|
+
<p>
|
700
|
+
Jekyll is funded thanks to its
|
701
|
+
<a href="https://github.com/jekyll/jekyll#sponsors">
|
702
|
+
sponsors!
|
703
|
+
</a>
|
704
|
+
</p>
|
705
|
+
</div>
|
706
|
+
</div>
|
707
|
+
</footer>
|
708
|
+
|
709
|
+
<script>
|
710
|
+
var anchorForId = function (id) {
|
711
|
+
var anchor = document.createElement("a");
|
712
|
+
anchor.className = "header-link";
|
713
|
+
anchor.href = "#" + id;
|
714
|
+
anchor.innerHTML = "<span class=\"sr-only\">Permalink</span><i class=\"fa fa-link\"></i>";
|
715
|
+
anchor.title = "Permalink";
|
716
|
+
return anchor;
|
717
|
+
};
|
718
|
+
|
719
|
+
var linkifyAnchors = function (level, containingElement) {
|
720
|
+
var headers = containingElement.getElementsByTagName("h" + level);
|
721
|
+
for (var h = 0; h < headers.length; h++) {
|
722
|
+
var header = headers[h];
|
723
|
+
|
724
|
+
if (typeof header.id !== "undefined" && header.id !== "") {
|
725
|
+
header.appendChild(anchorForId(header.id));
|
726
|
+
}
|
727
|
+
}
|
728
|
+
};
|
729
|
+
|
730
|
+
document.onreadystatechange = function () {
|
731
|
+
if (this.readyState === "complete") {
|
732
|
+
var contentBlock = document.getElementsByClassName("docs")[0] || document.getElementsByClassName("news")[0];
|
733
|
+
if (!contentBlock) {
|
734
|
+
return;
|
735
|
+
}
|
736
|
+
for (var level = 1; level <= 6; level++) {
|
737
|
+
linkifyAnchors(level, contentBlock);
|
738
|
+
}
|
739
|
+
}
|
740
|
+
};
|
741
|
+
</script>
|
742
|
+
|
743
|
+
|
744
|
+
<!-- Google Analytics (https://www.google.com/analytics) -->
|
745
|
+
<script>
|
746
|
+
!function(j,e,k,y,l,L){j.GoogleAnalyticsObject=y,j[y]||(j[y]=function(){
|
747
|
+
(j[y].q=j[y].q||[]).push(arguments)}),j[y].l=+new Date,l=e.createElement(k),
|
748
|
+
L=e.getElementsByTagName(k)[0],l.src='https://www.google-analytics.com/analytics.js',
|
749
|
+
L.parentNode.insertBefore(l,L)}(window,document,'script','ga');
|
750
|
+
|
751
|
+
ga('create', 'UA-50755011-1', 'jekyllrb.com');
|
752
|
+
ga('send', 'pageview');
|
753
|
+
|
754
|
+
</script>
|
755
|
+
|
756
|
+
|
757
|
+
<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.js"></script>
|
758
|
+
<script type="text/javascript"> docsearch({
|
759
|
+
apiKey: '50fe39c839958dfad797000f33e2ec17',
|
760
|
+
indexName: 'jekyllrb',
|
761
|
+
inputSelector: '#docsearch-input',
|
762
|
+
enhancedSearchInput: true,
|
763
|
+
debug: false // Set debug to true if you want to inspect the dropdown
|
764
|
+
});
|
765
|
+
</script>
|
766
|
+
|
767
|
+
</body>
|
768
|
+
</html>
|