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
|
@@ -0,0 +1,366 @@
|
|
|
1
|
+
<!DOCTYPE HTML>
|
|
2
|
+
<html lang="en-US">
|
|
3
|
+
<head>
|
|
4
|
+
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
5
|
+
<meta charset="UTF-8">
|
|
6
|
+
<meta name="viewport" content="width=device-width,initial-scale=1">
|
|
7
|
+
<meta name="generator" content="Jekyll v3.5.1">
|
|
8
|
+
<link type="application/atom+xml" rel="alternate" href="https://jekyllrb.com/feed.xml" title="Jekyll • Simple, blog-aware, static sites">
|
|
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="stylesheet" href="//fonts.googleapis.com/css?family=Lato:300,300italic,400,400italic,700,700italic,900">
|
|
11
|
+
<link rel="stylesheet" href="/css/screen.css">
|
|
12
|
+
<link rel="icon" type="image/x-icon" href="/favicon.ico">
|
|
13
|
+
<!-- Begin Jekyll SEO tag v2.2.3 -->
|
|
14
|
+
<title>Custom 404 Page | Jekyll • Simple, blog-aware, static sites</title>
|
|
15
|
+
<meta property="og:title" content="Custom 404 Page">
|
|
16
|
+
<meta property="og:locale" content="en_US">
|
|
17
|
+
<meta name="description" content="You can easily serve custom 404 error pages with Jekyll to replace the default Error 404 – File Not Found page displayed when one tries to access a broken link on your site.">
|
|
18
|
+
<meta property="og:description" content="You can easily serve custom 404 error pages with Jekyll to replace the default Error 404 – File Not Found page displayed when one tries to access a broken link on your site.">
|
|
19
|
+
<link rel="canonical" href="https://jekyllrb.com/tutorials/custom-404-page/">
|
|
20
|
+
<meta property="og:url" content="https://jekyllrb.com/tutorials/custom-404-page/">
|
|
21
|
+
<meta property="og:site_name" content="Jekyll • Simple, blog-aware, static sites">
|
|
22
|
+
<meta property="og:type" content="article">
|
|
23
|
+
<meta property="article:published_time" content="2017-07-17T13:16:40-07:00">
|
|
24
|
+
<meta name="twitter:card" content="summary">
|
|
25
|
+
<meta name="twitter:site" content="@jekyllrb">
|
|
26
|
+
<meta name="google-site-verification" content="onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY">
|
|
27
|
+
<script type="application/ld+json">
|
|
28
|
+
{"@context":"http://schema.org","@type":"BlogPosting","headline":"Custom 404 Page","datePublished":"2017-07-17T13:16:40-07:00","dateModified":"2017-07-17T13:16:40-07:00","description":"You can easily serve custom 404 error pages with Jekyll to replace the default Error 404 – File Not Found page displayed when one tries to access a broken link on your site.","publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://jekyllrb.com/img/logo-2x.png"}},"mainEntityOfPage":{"@type":"WebPage","@id":"https://jekyllrb.com/tutorials/custom-404-page/"},"url":"https://jekyllrb.com/tutorials/custom-404-page/"}</script>
|
|
29
|
+
<!-- End Jekyll SEO tag -->
|
|
30
|
+
|
|
31
|
+
<!--[if lt IE 9]>
|
|
32
|
+
<script src="/js/html5shiv.min.js"></script>
|
|
33
|
+
<script src="/js/respond.min.js"></script>
|
|
34
|
+
<![endif]-->
|
|
35
|
+
</head>
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
<body class="wrap">
|
|
39
|
+
<header>
|
|
40
|
+
<nav class="mobile-nav show-on-mobiles">
|
|
41
|
+
<ul>
|
|
42
|
+
<li class="">
|
|
43
|
+
<a href="/">Home</a>
|
|
44
|
+
</li>
|
|
45
|
+
<li class="">
|
|
46
|
+
<a href="/docs/home/">Docs</a>
|
|
47
|
+
</li>
|
|
48
|
+
<li class="">
|
|
49
|
+
<a href="/news/">News</a>
|
|
50
|
+
</li>
|
|
51
|
+
<li class="">
|
|
52
|
+
<a href="/community/">Community</a>
|
|
53
|
+
</li>
|
|
54
|
+
<li class="">
|
|
55
|
+
<a href="/help/">Help</a>
|
|
56
|
+
</li>
|
|
57
|
+
<li>
|
|
58
|
+
<a href="https://github.com/jekyll/jekyll">GitHub</a>
|
|
59
|
+
</li>
|
|
60
|
+
</ul>
|
|
61
|
+
|
|
62
|
+
</nav>
|
|
63
|
+
<div class="grid">
|
|
64
|
+
<div class="unit one-third center-on-mobiles">
|
|
65
|
+
<h1>
|
|
66
|
+
<a href="/">
|
|
67
|
+
<span class="sr-only">Jekyll</span>
|
|
68
|
+
<img src="/img/logo-2x.png" width="249" height="115" alt="Jekyll Logo">
|
|
69
|
+
</a>
|
|
70
|
+
</h1>
|
|
71
|
+
</div>
|
|
72
|
+
<nav class="main-nav unit two-thirds hide-on-mobiles">
|
|
73
|
+
<ul>
|
|
74
|
+
<li class="">
|
|
75
|
+
<a href="/">Home</a>
|
|
76
|
+
</li>
|
|
77
|
+
<li class="">
|
|
78
|
+
<a href="/docs/home/">Docs</a>
|
|
79
|
+
</li>
|
|
80
|
+
<li class="">
|
|
81
|
+
<a href="/news/">News</a>
|
|
82
|
+
</li>
|
|
83
|
+
<li class="">
|
|
84
|
+
<a href="/community/">Community</a>
|
|
85
|
+
</li>
|
|
86
|
+
<li class="">
|
|
87
|
+
<a href="/help/">Help</a>
|
|
88
|
+
</li>
|
|
89
|
+
<li>
|
|
90
|
+
<a href="https://github.com/jekyll/jekyll">GitHub</a>
|
|
91
|
+
</li>
|
|
92
|
+
</ul>
|
|
93
|
+
|
|
94
|
+
</nav>
|
|
95
|
+
</div>
|
|
96
|
+
</header>
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
<section class="docs">
|
|
100
|
+
<div class="grid">
|
|
101
|
+
|
|
102
|
+
<div class="docs-nav-mobile unit whole show-on-mobiles">
|
|
103
|
+
<select onchange="if (this.value) window.location.href=this.value">
|
|
104
|
+
<option value="">Navigate the tutorials…</option>
|
|
105
|
+
|
|
106
|
+
<optgroup label="Tutorials">
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
|
|
110
|
+
<option value="/tutorials/home/">Tutorials</option>
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
|
|
114
|
+
<option value="/tutorials/navigation/">Navigation</option>
|
|
115
|
+
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
<option value="/tutorials/orderofinterpretation/">Order of interpretation</option>
|
|
119
|
+
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
<option value="/tutorials/custom-404-page/">Custom 404 Page</option>
|
|
123
|
+
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
<option value="/tutorials/convert-site-to-jekyll/">Convert an HTML site to Jekyll</option>
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
</optgroup>
|
|
130
|
+
|
|
131
|
+
</select>
|
|
132
|
+
</div>
|
|
133
|
+
|
|
134
|
+
|
|
135
|
+
<div class="unit four-fifths">
|
|
136
|
+
<article>
|
|
137
|
+
<div class="improve right hide-on-mobiles">
|
|
138
|
+
<a href="https://github.com/jekyll/jekyll/edit/master/docs/_tutorials/custom-404-page.md"><i class="fa fa-pencil"></i> Improve this page</a>
|
|
139
|
+
</div>
|
|
140
|
+
<h1>Custom 404 Page</h1>
|
|
141
|
+
<p>You can easily serve custom 404 error pages with Jekyll to replace the default <strong>Error 404 – File Not Found</strong> page displayed when one tries to access a broken link on your site.</p>
|
|
142
|
+
|
|
143
|
+
<h2 id="on-github-pages">On GitHub Pages</h2>
|
|
144
|
+
|
|
145
|
+
<p>Any <code class="highlighter-rouge">404.html</code> at the <strong>root of your <code class="highlighter-rouge">_site</code> directory</strong> will be served automatically by GitHub Pages and the local WEBrick development server.</p>
|
|
146
|
+
|
|
147
|
+
<p>Simply add a <code class="highlighter-rouge">404.md</code> or <code class="highlighter-rouge">404.html</code> at the root of your site’s source directory and include the YAML Front Matter data to use the theme’s base layout.</p>
|
|
148
|
+
|
|
149
|
+
<p>If you plan to organize your files under subdirectories, the error page should have the following Front Matter Data, set: <code class="highlighter-rouge">permalink: /404.html</code>. This is to ensure that the compiled <code class="highlighter-rouge">404.html</code> resides at the root of your processed site, where it’ll be picked by the server.</p>
|
|
150
|
+
|
|
151
|
+
<div class="highlighter-rouge">
|
|
152
|
+
<pre class="highlight"><code>---
|
|
153
|
+
# example 404.md
|
|
154
|
+
|
|
155
|
+
layout: default
|
|
156
|
+
permalink: /404.html
|
|
157
|
+
---
|
|
158
|
+
|
|
159
|
+
# 404
|
|
160
|
+
|
|
161
|
+
Page not found! :(
|
|
162
|
+
</code></pre>
|
|
163
|
+
</div>
|
|
164
|
+
|
|
165
|
+
<h2 id="hosting-on-apache-web-servers">Hosting on Apache Web Servers</h2>
|
|
166
|
+
|
|
167
|
+
<p>Apache Web Servers load a configuration file named <a href="http://www.htaccess-guide.com/"><code class="highlighter-rouge">.htaccess</code></a> that modifies the functionality of these servers.</p>
|
|
168
|
+
|
|
169
|
+
<p>Simply add the following to your <code class="highlighter-rouge">.htaccess</code> file.</p>
|
|
170
|
+
|
|
171
|
+
<div class="highlighter-rouge">
|
|
172
|
+
<pre class="highlight"><code>ErrorDocument 404 /404.html
|
|
173
|
+
</code></pre>
|
|
174
|
+
</div>
|
|
175
|
+
|
|
176
|
+
<p>With an <code class="highlighter-rouge">.htaccess</code> file, you have the freedom to place your error page within a subdirectory.</p>
|
|
177
|
+
|
|
178
|
+
<div class="highlighter-rouge">
|
|
179
|
+
<pre class="highlight"><code>ErrorDocument 404 /error_pages/404.html
|
|
180
|
+
</code></pre>
|
|
181
|
+
</div>
|
|
182
|
+
|
|
183
|
+
<p>Where the path is relative to your site’s domain.</p>
|
|
184
|
+
|
|
185
|
+
<p>More info on configuring Apache Error Pages can found in <a href="https://httpd.apache.org/docs/current/mod/core.html#errordocument">official documentation</a>.</p>
|
|
186
|
+
|
|
187
|
+
<h2 id="hosting-on-nginx-server">Hosting on Nginx server</h2>
|
|
188
|
+
|
|
189
|
+
<p>The procedure is just as simple as configuring Apache servers, but slightly different.</p>
|
|
190
|
+
|
|
191
|
+
<p>Add the following to the ngnix configuration file, <code class="highlighter-rouge">nginx.conf</code>, which is usually located inside <code class="highlighter-rouge">/etc/nginx/</code> or <code class="highlighter-rouge">/etc/nginx/conf/</code>:</p>
|
|
192
|
+
|
|
193
|
+
<div class="highlighter-rouge">
|
|
194
|
+
<pre class="highlight"><code>server {
|
|
195
|
+
error_page 404 /404.html;
|
|
196
|
+
location /404.html {
|
|
197
|
+
internal;
|
|
198
|
+
}
|
|
199
|
+
}
|
|
200
|
+
</code></pre>
|
|
201
|
+
</div>
|
|
202
|
+
<p>The <code class="highlighter-rouge">location</code> directive prevents users from directly browsing the 404.html page.</p>
|
|
203
|
+
|
|
204
|
+
|
|
205
|
+
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
|
|
210
|
+
|
|
211
|
+
|
|
212
|
+
|
|
213
|
+
|
|
214
|
+
|
|
215
|
+
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
<div class="section-nav">
|
|
222
|
+
<div class="left align-right">
|
|
223
|
+
|
|
224
|
+
|
|
225
|
+
|
|
226
|
+
<a href="/tutorials/orderofinterpretation/" class="prev">Back</a>
|
|
227
|
+
|
|
228
|
+
</div>
|
|
229
|
+
<div class="right align-left">
|
|
230
|
+
|
|
231
|
+
|
|
232
|
+
|
|
233
|
+
<a href="/tutorials/convert-site-to-jekyll/" class="next">Next</a>
|
|
234
|
+
|
|
235
|
+
</div>
|
|
236
|
+
</div>
|
|
237
|
+
<div class="clear"></div>
|
|
238
|
+
|
|
239
|
+
</article>
|
|
240
|
+
</div>
|
|
241
|
+
|
|
242
|
+
<div class="unit one-fifth hide-on-mobiles">
|
|
243
|
+
<aside>
|
|
244
|
+
|
|
245
|
+
<h4>Tutorials</h4>
|
|
246
|
+
|
|
247
|
+
<ul>
|
|
248
|
+
|
|
249
|
+
|
|
250
|
+
|
|
251
|
+
<li class=""><a href="/tutorials/home/">Tutorials</a></li>
|
|
252
|
+
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
<li class=""><a href="/tutorials/navigation/">Navigation</a></li>
|
|
256
|
+
|
|
257
|
+
|
|
258
|
+
|
|
259
|
+
<li class=""><a href="/tutorials/orderofinterpretation/">Order of interpretation</a></li>
|
|
260
|
+
|
|
261
|
+
|
|
262
|
+
|
|
263
|
+
<li class="current"><a href="/tutorials/custom-404-page/">Custom 404 Page</a></li>
|
|
264
|
+
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
<li class=""><a href="/tutorials/convert-site-to-jekyll/">Convert an HTML site to Jekyll</a></li>
|
|
268
|
+
|
|
269
|
+
</ul>
|
|
270
|
+
|
|
271
|
+
|
|
272
|
+
|
|
273
|
+
</aside>
|
|
274
|
+
</div>
|
|
275
|
+
|
|
276
|
+
|
|
277
|
+
<div class="clear"></div>
|
|
278
|
+
|
|
279
|
+
</div>
|
|
280
|
+
</section>
|
|
281
|
+
|
|
282
|
+
|
|
283
|
+
<footer>
|
|
284
|
+
<div class="grid">
|
|
285
|
+
<div class="unit one-third center-on-mobiles">
|
|
286
|
+
<p>The contents of this website are <br>© 2017 under the terms of the <a href="https://github.com/jekyll/jekyll/blob/master/LICENSE">MIT License</a>.</p>
|
|
287
|
+
</div>
|
|
288
|
+
<div class="unit two-thirds align-right center-on-mobiles">
|
|
289
|
+
<p>
|
|
290
|
+
Proudly hosted by
|
|
291
|
+
<a href="https://github.com">
|
|
292
|
+
<img src="/img/footer-logo.png" width="100" height="30" alt="GitHub • Social coding">
|
|
293
|
+
</a>
|
|
294
|
+
</p>
|
|
295
|
+
</div>
|
|
296
|
+
</div>
|
|
297
|
+
</footer>
|
|
298
|
+
|
|
299
|
+
<script>
|
|
300
|
+
var anchorForId = function (id) {
|
|
301
|
+
var anchor = document.createElement("a");
|
|
302
|
+
anchor.className = "header-link";
|
|
303
|
+
anchor.href = "#" + id;
|
|
304
|
+
anchor.innerHTML = "<span class=\"sr-only\">Permalink</span><i class=\"fa fa-link\"></i>";
|
|
305
|
+
anchor.title = "Permalink";
|
|
306
|
+
return anchor;
|
|
307
|
+
};
|
|
308
|
+
|
|
309
|
+
var linkifyAnchors = function (level, containingElement) {
|
|
310
|
+
var headers = containingElement.getElementsByTagName("h" + level);
|
|
311
|
+
for (var h = 0; h < headers.length; h++) {
|
|
312
|
+
var header = headers[h];
|
|
313
|
+
|
|
314
|
+
if (typeof header.id !== "undefined" && header.id !== "") {
|
|
315
|
+
header.appendChild(anchorForId(header.id));
|
|
316
|
+
}
|
|
317
|
+
}
|
|
318
|
+
};
|
|
319
|
+
|
|
320
|
+
document.onreadystatechange = function () {
|
|
321
|
+
if (this.readyState === "complete") {
|
|
322
|
+
var contentBlock = document.getElementsByClassName("docs")[0] || document.getElementsByClassName("news")[0];
|
|
323
|
+
if (!contentBlock) {
|
|
324
|
+
return;
|
|
325
|
+
}
|
|
326
|
+
for (var level = 1; level <= 6; level++) {
|
|
327
|
+
linkifyAnchors(level, contentBlock);
|
|
328
|
+
}
|
|
329
|
+
}
|
|
330
|
+
};
|
|
331
|
+
</script>
|
|
332
|
+
|
|
333
|
+
|
|
334
|
+
<!-- Gauges (http://get.gaug.es/) -->
|
|
335
|
+
<script>
|
|
336
|
+
var _gauges = _gauges || [];
|
|
337
|
+
(function() {
|
|
338
|
+
var t = document.createElement('script');
|
|
339
|
+
t.type = 'text/javascript';
|
|
340
|
+
t.async = true;
|
|
341
|
+
t.id = 'gauges-tracker';
|
|
342
|
+
t.setAttribute('data-site-id', '503c5af6613f5d0f19000027');
|
|
343
|
+
t.src = '//secure.gaug.es/track.js';
|
|
344
|
+
var s = document.getElementsByTagName('script')[0];
|
|
345
|
+
s.parentNode.insertBefore(t, s);
|
|
346
|
+
})();
|
|
347
|
+
</script>
|
|
348
|
+
|
|
349
|
+
|
|
350
|
+
|
|
351
|
+
<!-- Google Analytics (https://www.google.com/analytics) -->
|
|
352
|
+
<script>
|
|
353
|
+
!function(j,e,k,y,l,L){j.GoogleAnalyticsObject=y,j[y]||(j[y]=function(){
|
|
354
|
+
(j[y].q=j[y].q||[]).push(arguments)}),j[y].l=+new Date,l=e.createElement(k),
|
|
355
|
+
L=e.getElementsByTagName(k)[0],l.src='//www.google-analytics.com/analytics.js',
|
|
356
|
+
L.parentNode.insertBefore(l,L)}(window,document,'script','ga');
|
|
357
|
+
|
|
358
|
+
ga('create', 'UA-50755011-1', 'jekyllrb.com');
|
|
359
|
+
ga('send', 'pageview');
|
|
360
|
+
|
|
361
|
+
</script>
|
|
362
|
+
|
|
363
|
+
|
|
364
|
+
|
|
365
|
+
</body>
|
|
366
|
+
</html>
|
|
@@ -0,0 +1,323 @@
|
|
|
1
|
+
<!DOCTYPE HTML>
|
|
2
|
+
<html lang="en-US">
|
|
3
|
+
<head>
|
|
4
|
+
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
5
|
+
<meta charset="UTF-8">
|
|
6
|
+
<meta name="viewport" content="width=device-width,initial-scale=1">
|
|
7
|
+
<meta name="generator" content="Jekyll v3.5.1">
|
|
8
|
+
<link type="application/atom+xml" rel="alternate" href="https://jekyllrb.com/feed.xml" title="Jekyll • Simple, blog-aware, static sites">
|
|
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="stylesheet" href="//fonts.googleapis.com/css?family=Lato:300,300italic,400,400italic,700,700italic,900">
|
|
11
|
+
<link rel="stylesheet" href="/css/screen.css">
|
|
12
|
+
<link rel="icon" type="image/x-icon" href="/favicon.ico">
|
|
13
|
+
<!-- Begin Jekyll SEO tag v2.2.3 -->
|
|
14
|
+
<title>Tutorials | Jekyll • Simple, blog-aware, static sites</title>
|
|
15
|
+
<meta property="og:title" content="Tutorials">
|
|
16
|
+
<meta property="og:locale" content="en_US">
|
|
17
|
+
<meta name="description" content="In contrast to Docs, Tutorials provide more detailed, narrative instruction that cover a variety of Jekyll topics and scenarios. Tutorials might contain the following:">
|
|
18
|
+
<meta property="og:description" content="In contrast to Docs, Tutorials provide more detailed, narrative instruction that cover a variety of Jekyll topics and scenarios. Tutorials might contain the following:">
|
|
19
|
+
<link rel="canonical" href="https://jekyllrb.com/tutorials/home/">
|
|
20
|
+
<meta property="og:url" content="https://jekyllrb.com/tutorials/home/">
|
|
21
|
+
<meta property="og:site_name" content="Jekyll • Simple, blog-aware, static sites">
|
|
22
|
+
<meta property="og:type" content="article">
|
|
23
|
+
<meta property="article:published_time" content="2017-07-17T13:16:40-07:00">
|
|
24
|
+
<meta name="twitter:card" content="summary">
|
|
25
|
+
<meta name="twitter:site" content="@jekyllrb">
|
|
26
|
+
<meta name="google-site-verification" content="onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY">
|
|
27
|
+
<script type="application/ld+json">
|
|
28
|
+
{"@context":"http://schema.org","@type":"BlogPosting","headline":"Tutorials","datePublished":"2017-07-17T13:16:40-07:00","dateModified":"2017-07-17T13:16:40-07:00","description":"In contrast to Docs, Tutorials provide more detailed, narrative instruction that cover a variety of Jekyll topics and scenarios. Tutorials might contain the following:","publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://jekyllrb.com/img/logo-2x.png"}},"mainEntityOfPage":{"@type":"WebPage","@id":"https://jekyllrb.com/tutorials/home/"},"url":"https://jekyllrb.com/tutorials/home/"}</script>
|
|
29
|
+
<!-- End Jekyll SEO tag -->
|
|
30
|
+
|
|
31
|
+
<!--[if lt IE 9]>
|
|
32
|
+
<script src="/js/html5shiv.min.js"></script>
|
|
33
|
+
<script src="/js/respond.min.js"></script>
|
|
34
|
+
<![endif]-->
|
|
35
|
+
</head>
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
<body class="wrap">
|
|
39
|
+
<header>
|
|
40
|
+
<nav class="mobile-nav show-on-mobiles">
|
|
41
|
+
<ul>
|
|
42
|
+
<li class="">
|
|
43
|
+
<a href="/">Home</a>
|
|
44
|
+
</li>
|
|
45
|
+
<li class="">
|
|
46
|
+
<a href="/docs/home/">Docs</a>
|
|
47
|
+
</li>
|
|
48
|
+
<li class="">
|
|
49
|
+
<a href="/news/">News</a>
|
|
50
|
+
</li>
|
|
51
|
+
<li class="">
|
|
52
|
+
<a href="/community/">Community</a>
|
|
53
|
+
</li>
|
|
54
|
+
<li class="">
|
|
55
|
+
<a href="/help/">Help</a>
|
|
56
|
+
</li>
|
|
57
|
+
<li>
|
|
58
|
+
<a href="https://github.com/jekyll/jekyll">GitHub</a>
|
|
59
|
+
</li>
|
|
60
|
+
</ul>
|
|
61
|
+
|
|
62
|
+
</nav>
|
|
63
|
+
<div class="grid">
|
|
64
|
+
<div class="unit one-third center-on-mobiles">
|
|
65
|
+
<h1>
|
|
66
|
+
<a href="/">
|
|
67
|
+
<span class="sr-only">Jekyll</span>
|
|
68
|
+
<img src="/img/logo-2x.png" width="249" height="115" alt="Jekyll Logo">
|
|
69
|
+
</a>
|
|
70
|
+
</h1>
|
|
71
|
+
</div>
|
|
72
|
+
<nav class="main-nav unit two-thirds hide-on-mobiles">
|
|
73
|
+
<ul>
|
|
74
|
+
<li class="">
|
|
75
|
+
<a href="/">Home</a>
|
|
76
|
+
</li>
|
|
77
|
+
<li class="">
|
|
78
|
+
<a href="/docs/home/">Docs</a>
|
|
79
|
+
</li>
|
|
80
|
+
<li class="">
|
|
81
|
+
<a href="/news/">News</a>
|
|
82
|
+
</li>
|
|
83
|
+
<li class="">
|
|
84
|
+
<a href="/community/">Community</a>
|
|
85
|
+
</li>
|
|
86
|
+
<li class="">
|
|
87
|
+
<a href="/help/">Help</a>
|
|
88
|
+
</li>
|
|
89
|
+
<li>
|
|
90
|
+
<a href="https://github.com/jekyll/jekyll">GitHub</a>
|
|
91
|
+
</li>
|
|
92
|
+
</ul>
|
|
93
|
+
|
|
94
|
+
</nav>
|
|
95
|
+
</div>
|
|
96
|
+
</header>
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
<section class="docs">
|
|
100
|
+
<div class="grid">
|
|
101
|
+
|
|
102
|
+
<div class="docs-nav-mobile unit whole show-on-mobiles">
|
|
103
|
+
<select onchange="if (this.value) window.location.href=this.value">
|
|
104
|
+
<option value="">Navigate the tutorials…</option>
|
|
105
|
+
|
|
106
|
+
<optgroup label="Tutorials">
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
|
|
110
|
+
<option value="/tutorials/home/">Tutorials</option>
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
|
|
114
|
+
<option value="/tutorials/navigation/">Navigation</option>
|
|
115
|
+
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
<option value="/tutorials/orderofinterpretation/">Order of interpretation</option>
|
|
119
|
+
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
<option value="/tutorials/custom-404-page/">Custom 404 Page</option>
|
|
123
|
+
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
<option value="/tutorials/convert-site-to-jekyll/">Convert an HTML site to Jekyll</option>
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
</optgroup>
|
|
130
|
+
|
|
131
|
+
</select>
|
|
132
|
+
</div>
|
|
133
|
+
|
|
134
|
+
|
|
135
|
+
<div class="unit four-fifths">
|
|
136
|
+
<article>
|
|
137
|
+
<div class="improve right hide-on-mobiles">
|
|
138
|
+
<a href="https://github.com/jekyll/jekyll/edit/master/docs/_tutorials/index.md"><i class="fa fa-pencil"></i> Improve this page</a>
|
|
139
|
+
</div>
|
|
140
|
+
<h1>Tutorials</h1>
|
|
141
|
+
<p>In contrast to <a href="/docs/home/">Docs</a>, Tutorials provide more detailed, narrative instruction that cover a variety of Jekyll topics and scenarios. Tutorials might contain the following:</p>
|
|
142
|
+
|
|
143
|
+
<ul>
|
|
144
|
+
<li>Step-by-step processes through particular scenarios or challenges</li>
|
|
145
|
+
<li>Full walk-throughs using sample data, showing inputs and results from the sample data</li>
|
|
146
|
+
<li>Detailed explanation about the pros and cons for different Jekyll strategies</li>
|
|
147
|
+
<li>End-to-end instruction in developing a complete feature on a Jekyll site</li>
|
|
148
|
+
<li>Instruction that combines various techniques from across the docs</li>
|
|
149
|
+
</ul>
|
|
150
|
+
|
|
151
|
+
<p>In short, tutorials aren’t the core reference information in docs. They walk users through processes from beginning to end.</p>
|
|
152
|
+
|
|
153
|
+
<p class="info note"><strong>Note:</strong> The Tutorials section is new, so there aren’t many tutorials yet. You can add a tutorial here to help populate this section.</p>
|
|
154
|
+
|
|
155
|
+
<p>Some of these techniques might even guide you through a supporting tool, script, service, or other hack used with your Jekyll site. Feel free to include tutorials involving external services with Jekyll as well. However, note that Jekyll in no way endorses any third-party tools mentioned in tutorials.</p>
|
|
156
|
+
|
|
157
|
+
<h2 id="how-to-contribute-a-tutorial">How to contribute a tutorial</h2>
|
|
158
|
+
|
|
159
|
+
<p>We welcome your tutorial contributions. To add your tutorial:</p>
|
|
160
|
+
|
|
161
|
+
<ol>
|
|
162
|
+
<li>Fork the Jekyll project by clicking the <strong>Fork</strong> button in the upper-right corner of the <a href="https://github.com/jekyll/jekyll/">jekyll/jekyll project Github repo</a>.</li>
|
|
163
|
+
<li>Add your tutorial in the <code class="highlighter-rouge">_tutorials</code> collection.</li>
|
|
164
|
+
<li>Make sure your tutorial has the same front matter items as other tutorial items.</li>
|
|
165
|
+
<li>Add a reference to your tutorial filename in <code class="highlighter-rouge">_data/tutorials.yml</code>. This allows your tutorial to appear in the Tutorials sidebar.</li>
|
|
166
|
+
<li>Follow the regular git workflow to submit the pull request.</li>
|
|
167
|
+
</ol>
|
|
168
|
+
|
|
169
|
+
<p>When you submit your pull request, the Jekyll documentation team will review your contribution and either merge it or suggest edits.</p>
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
<div class="section-nav">
|
|
181
|
+
<div class="left align-right">
|
|
182
|
+
|
|
183
|
+
<span class="prev disabled">Back</span>
|
|
184
|
+
|
|
185
|
+
</div>
|
|
186
|
+
<div class="right align-left">
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
<a href="/tutorials/navigation/" class="next">Next</a>
|
|
191
|
+
|
|
192
|
+
</div>
|
|
193
|
+
</div>
|
|
194
|
+
<div class="clear"></div>
|
|
195
|
+
|
|
196
|
+
</article>
|
|
197
|
+
</div>
|
|
198
|
+
|
|
199
|
+
<div class="unit one-fifth hide-on-mobiles">
|
|
200
|
+
<aside>
|
|
201
|
+
|
|
202
|
+
<h4>Tutorials</h4>
|
|
203
|
+
|
|
204
|
+
<ul>
|
|
205
|
+
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
<li class="current"><a href="/tutorials/home/">Tutorials</a></li>
|
|
209
|
+
|
|
210
|
+
|
|
211
|
+
|
|
212
|
+
<li class=""><a href="/tutorials/navigation/">Navigation</a></li>
|
|
213
|
+
|
|
214
|
+
|
|
215
|
+
|
|
216
|
+
<li class=""><a href="/tutorials/orderofinterpretation/">Order of interpretation</a></li>
|
|
217
|
+
|
|
218
|
+
|
|
219
|
+
|
|
220
|
+
<li class=""><a href="/tutorials/custom-404-page/">Custom 404 Page</a></li>
|
|
221
|
+
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
<li class=""><a href="/tutorials/convert-site-to-jekyll/">Convert an HTML site to Jekyll</a></li>
|
|
225
|
+
|
|
226
|
+
</ul>
|
|
227
|
+
|
|
228
|
+
|
|
229
|
+
|
|
230
|
+
</aside>
|
|
231
|
+
</div>
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
<div class="clear"></div>
|
|
235
|
+
|
|
236
|
+
</div>
|
|
237
|
+
</section>
|
|
238
|
+
|
|
239
|
+
|
|
240
|
+
<footer>
|
|
241
|
+
<div class="grid">
|
|
242
|
+
<div class="unit one-third center-on-mobiles">
|
|
243
|
+
<p>The contents of this website are <br>© 2017 under the terms of the <a href="https://github.com/jekyll/jekyll/blob/master/LICENSE">MIT License</a>.</p>
|
|
244
|
+
</div>
|
|
245
|
+
<div class="unit two-thirds align-right center-on-mobiles">
|
|
246
|
+
<p>
|
|
247
|
+
Proudly hosted by
|
|
248
|
+
<a href="https://github.com">
|
|
249
|
+
<img src="/img/footer-logo.png" width="100" height="30" alt="GitHub • Social coding">
|
|
250
|
+
</a>
|
|
251
|
+
</p>
|
|
252
|
+
</div>
|
|
253
|
+
</div>
|
|
254
|
+
</footer>
|
|
255
|
+
|
|
256
|
+
<script>
|
|
257
|
+
var anchorForId = function (id) {
|
|
258
|
+
var anchor = document.createElement("a");
|
|
259
|
+
anchor.className = "header-link";
|
|
260
|
+
anchor.href = "#" + id;
|
|
261
|
+
anchor.innerHTML = "<span class=\"sr-only\">Permalink</span><i class=\"fa fa-link\"></i>";
|
|
262
|
+
anchor.title = "Permalink";
|
|
263
|
+
return anchor;
|
|
264
|
+
};
|
|
265
|
+
|
|
266
|
+
var linkifyAnchors = function (level, containingElement) {
|
|
267
|
+
var headers = containingElement.getElementsByTagName("h" + level);
|
|
268
|
+
for (var h = 0; h < headers.length; h++) {
|
|
269
|
+
var header = headers[h];
|
|
270
|
+
|
|
271
|
+
if (typeof header.id !== "undefined" && header.id !== "") {
|
|
272
|
+
header.appendChild(anchorForId(header.id));
|
|
273
|
+
}
|
|
274
|
+
}
|
|
275
|
+
};
|
|
276
|
+
|
|
277
|
+
document.onreadystatechange = function () {
|
|
278
|
+
if (this.readyState === "complete") {
|
|
279
|
+
var contentBlock = document.getElementsByClassName("docs")[0] || document.getElementsByClassName("news")[0];
|
|
280
|
+
if (!contentBlock) {
|
|
281
|
+
return;
|
|
282
|
+
}
|
|
283
|
+
for (var level = 1; level <= 6; level++) {
|
|
284
|
+
linkifyAnchors(level, contentBlock);
|
|
285
|
+
}
|
|
286
|
+
}
|
|
287
|
+
};
|
|
288
|
+
</script>
|
|
289
|
+
|
|
290
|
+
|
|
291
|
+
<!-- Gauges (http://get.gaug.es/) -->
|
|
292
|
+
<script>
|
|
293
|
+
var _gauges = _gauges || [];
|
|
294
|
+
(function() {
|
|
295
|
+
var t = document.createElement('script');
|
|
296
|
+
t.type = 'text/javascript';
|
|
297
|
+
t.async = true;
|
|
298
|
+
t.id = 'gauges-tracker';
|
|
299
|
+
t.setAttribute('data-site-id', '503c5af6613f5d0f19000027');
|
|
300
|
+
t.src = '//secure.gaug.es/track.js';
|
|
301
|
+
var s = document.getElementsByTagName('script')[0];
|
|
302
|
+
s.parentNode.insertBefore(t, s);
|
|
303
|
+
})();
|
|
304
|
+
</script>
|
|
305
|
+
|
|
306
|
+
|
|
307
|
+
|
|
308
|
+
<!-- Google Analytics (https://www.google.com/analytics) -->
|
|
309
|
+
<script>
|
|
310
|
+
!function(j,e,k,y,l,L){j.GoogleAnalyticsObject=y,j[y]||(j[y]=function(){
|
|
311
|
+
(j[y].q=j[y].q||[]).push(arguments)}),j[y].l=+new Date,l=e.createElement(k),
|
|
312
|
+
L=e.getElementsByTagName(k)[0],l.src='//www.google-analytics.com/analytics.js',
|
|
313
|
+
L.parentNode.insertBefore(l,L)}(window,document,'script','ga');
|
|
314
|
+
|
|
315
|
+
ga('create', 'UA-50755011-1', 'jekyllrb.com');
|
|
316
|
+
ga('send', 'pageview');
|
|
317
|
+
|
|
318
|
+
</script>
|
|
319
|
+
|
|
320
|
+
|
|
321
|
+
|
|
322
|
+
</body>
|
|
323
|
+
</html>
|