jekyll-docs 3.5.2 → 3.6.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/docs/assets/index.html +14 -22
- data/site/docs/code_of_conduct/index.html +730 -0
- data/site/docs/collections/index.html +65 -80
- data/site/docs/conduct/index.html +4 -4
- data/site/docs/configuration/index.html +130 -156
- data/site/docs/continuous-integration/buddyworks/index.html +14 -16
- data/site/docs/continuous-integration/circleci/index.html +13 -21
- data/site/docs/continuous-integration/index.html +5 -5
- data/site/docs/continuous-integration/travis-ci/index.html +45 -73
- data/site/docs/contributing/index.html +10 -10
- data/site/docs/datafiles/index.html +37 -53
- data/site/docs/deployment-methods/index.html +54 -64
- data/site/docs/drafts/index.html +6 -8
- data/site/docs/extras/index.html +8 -12
- data/site/docs/frontmatter/index.html +10 -14
- data/site/docs/github-pages/index.html +10 -14
- data/site/docs/history/index.html +539 -440
- data/site/docs/home/index.html +4 -4
- data/site/docs/includes/index.html +42 -70
- data/site/docs/installation/index.html +23 -37
- data/site/docs/maintaining/affinity-team-captain/index.html +4 -4
- data/site/docs/maintaining/avoiding-burnout/index.html +4 -4
- data/site/docs/maintaining/becoming-a-maintainer/index.html +4 -4
- data/site/docs/maintaining/index.html +4 -4
- data/site/docs/maintaining/merging-a-pull-request/index.html +6 -8
- data/site/docs/maintaining/reviewing-a-pull-request/index.html +4 -4
- data/site/docs/maintaining/special-labels/index.html +4 -4
- data/site/docs/maintaining/triaging-an-issue/index.html +4 -4
- data/site/docs/migrations/index.html +4 -4
- data/site/docs/pages/index.html +8 -12
- data/site/docs/pagination/index.html +13 -21
- data/site/docs/permalinks/index.html +43 -34
- data/site/docs/plugins/index.html +51 -79
- data/site/docs/posts/index.html +26 -48
- data/site/docs/quickstart/index.html +6 -8
- data/site/docs/resources/index.html +45 -21
- data/site/docs/sites/index.html +4 -4
- data/site/docs/static-files/index.html +12 -16
- data/site/docs/structure/index.html +6 -8
- data/site/docs/templates/index.html +36 -68
- data/site/docs/themes/index.html +32 -49
- data/site/docs/troubleshooting/index.html +44 -82
- data/site/docs/upgrading/0-to-2/index.html +7 -9
- data/site/docs/upgrading/2-to-3/index.html +19 -31
- data/site/docs/upgrading/index.html +4 -4
- data/site/docs/usage/index.html +20 -30
- data/site/docs/variables/index.html +26 -10
- data/site/docs/windows/index.html +36 -58
- data/site/feed.xml +47 -53
- data/site/help/index.html +3 -3
- 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 +16 -8
- data/site/news/2013/05/08/jekyll-1-0-1-released/index.html +16 -8
- data/site/news/2013/05/12/jekyll-1-0-2-released/index.html +16 -8
- data/site/news/2013/06/07/jekyll-1-0-3-released/index.html +16 -8
- data/site/news/2013/07/14/jekyll-1-1-0-released/index.html +16 -8
- data/site/news/2013/07/24/jekyll-1-1-1-released/index.html +16 -8
- data/site/news/2013/07/25/jekyll-1-0-4-released/index.html +16 -8
- data/site/news/2013/07/25/jekyll-1-1-2-released/index.html +16 -8
- data/site/news/2013/09/06/jekyll-1-2-0-released/index.html +16 -8
- data/site/news/2013/09/14/jekyll-1-2-1-released/index.html +16 -8
- data/site/news/2013/10/28/jekyll-1-3-0-rc1-released/index.html +16 -8
- data/site/news/2013/11/04/jekyll-1-3-0-released/index.html +16 -8
- data/site/news/2013/11/26/jekyll-1-3-1-released/index.html +16 -8
- data/site/news/2013/12/07/jekyll-1-4-0-released/index.html +16 -8
- data/site/news/2013/12/09/jekyll-1-4-1-released/index.html +16 -8
- data/site/news/2013/12/16/jekyll-1-4-2-released/index.html +16 -8
- data/site/news/2014/01/13/jekyll-1-4-3-released/index.html +16 -8
- data/site/news/2014/03/24/jekyll-1-5-0-released/index.html +16 -8
- data/site/news/2014/03/27/jekyll-1-5-1-released/index.html +16 -8
- data/site/news/2014/05/06/jekyll-turns-2-0-0/index.html +16 -8
- data/site/news/2014/05/08/jekyll-2-0-3-released/index.html +16 -8
- data/site/news/2014/06/04/jekyll-stickers-1-dollar-stickermule/index.html +16 -8
- data/site/news/2014/06/28/jekyll-turns-21-i-mean-2-1-0/index.html +16 -8
- data/site/news/2014/07/01/jekyll-2-1-1-released/index.html +16 -8
- data/site/news/2014/07/29/jekyll-2-2-0-released/index.html +16 -8
- data/site/news/2014/08/10/jekyll-2-3-0-released/index.html +16 -8
- data/site/news/2014/09/09/jekyll-2-4-0-released/index.html +16 -8
- data/site/news/2014/11/05/jekylls-midlife-crisis-jekyll-turns-2-5-0/index.html +16 -8
- data/site/news/2014/11/09/jekyll-2-5-1-released/index.html +16 -8
- data/site/news/2014/11/12/jekyll-2-5-2-released/index.html +16 -8
- data/site/news/2014/12/17/alfredxing-welcome-to-jekyll-core/index.html +16 -8
- data/site/news/2014/12/22/jekyll-2-5-3-released/index.html +16 -8
- data/site/news/2015/01/20/jekyll-meet-and-greet/index.html +16 -8
- data/site/news/2015/01/24/jekyll-3-0-0-beta1-released/index.html +17 -9
- data/site/news/2015/02/26/introducing-jekyll-talk/index.html +16 -8
- data/site/news/2015/10/26/jekyll-3-0-released/index.html +16 -8
- data/site/news/2015/11/17/jekyll-3-0-1-released/index.html +16 -8
- data/site/news/2016/01/20/jekyll-3-0-2-released/index.html +16 -8
- data/site/news/2016/01/24/jekyll-3-1-0-released/index.html +16 -8
- data/site/news/2016/01/28/jekyll-3-1-1-released/index.html +16 -8
- data/site/news/2016/02/08/jekyll-3-0-3-released/index.html +16 -8
- data/site/news/2016/02/19/jekyll-3-1-2-released/index.html +16 -8
- data/site/news/2016/03/10/making-it-easier-to-contribute-to-jekyll/index.html +16 -8
- data/site/news/2016/04/19/jekyll-3-0-4-released/index.html +20 -12
- data/site/news/2016/04/19/jekyll-3-1-3-released/index.html +16 -8
- data/site/news/2016/04/26/jekyll-3-0-5-released/index.html +16 -8
- data/site/news/2016/05/18/jekyll-3-1-4-released/index.html +16 -8
- data/site/news/2016/05/18/jekyll-3-1-5-released/index.html +16 -8
- data/site/news/2016/05/19/jekyll-3-1-6-released/index.html +16 -8
- data/site/news/2016/06/03/update-on-jekyll-s-google-summer-of-code-projects/index.html +16 -8
- data/site/news/2016/07/26/jekyll-3-2-0-released/index.html +16 -8
- data/site/news/2016/08/02/jekyll-3-2-1-released/index.html +16 -8
- data/site/news/2016/08/24/jekyll-admin-initial-release/index.html +16 -8
- data/site/news/2016/10/06/jekyll-3-3-is-here/index.html +16 -8
- data/site/news/2016/11/14/jekyll-3-3-1-released/index.html +16 -8
- data/site/news/2017/01/18/jekyll-3-4-0-released/index.html +16 -8
- data/site/news/2017/03/02/jekyll-3-4-1-released/index.html +27 -29
- data/site/news/2017/03/09/jekyll-3-4-2-released/index.html +23 -17
- data/site/news/2017/03/21/jekyll-3-4-3-released/index.html +20 -14
- data/site/news/2017/06/15/jekyll-3-5-0-released/index.html +21 -13
- data/site/news/2017/07/17/jekyll-3-5-1-released/index.html +18 -10
- data/site/news/2017/08/12/jekyll-3-5-2-released/index.html +573 -0
- data/site/news/2017/09/21/jekyll-3-6-0-released/index.html +565 -0
- data/site/news/index.html +122 -48
- data/site/news/releases/index.html +122 -48
- data/site/sitemap.xml +64 -52
- data/site/tutorials/convert-site-to-jekyll/index.html +80 -138
- data/site/tutorials/custom-404-page/index.html +13 -21
- data/site/tutorials/home/index.html +4 -4
- data/site/tutorials/navigation/index.html +144 -180
- data/site/tutorials/orderofinterpretation/index.html +27 -45
- metadata +8 -5
@@ -4,13 +4,13 @@
|
|
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.6.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">
|
11
11
|
<link rel="stylesheet" href="/css/screen.css">
|
12
12
|
<link rel="icon" type="image/x-icon" href="/favicon.ico">
|
13
|
-
<!-- Begin Jekyll SEO tag v2.
|
13
|
+
<!-- Begin Jekyll SEO tag v2.3.0 -->
|
14
14
|
<title>Contributing | Jekyll • Simple, blog-aware, static sites</title>
|
15
15
|
<meta property="og:title" content="Contributing">
|
16
16
|
<meta property="og:locale" content="en_US">
|
@@ -20,12 +20,12 @@
|
|
20
20
|
<meta property="og:url" content="https://jekyllrb.com/docs/contributing/">
|
21
21
|
<meta property="og:site_name" content="Jekyll • Simple, blog-aware, static sites">
|
22
22
|
<meta property="og:type" content="article">
|
23
|
-
<meta property="article:published_time" content="2017-
|
23
|
+
<meta property="article:published_time" content="2017-10-24T08:07:43-07:00">
|
24
24
|
<meta name="twitter:card" content="summary">
|
25
25
|
<meta name="twitter:site" content="@jekyllrb">
|
26
26
|
<meta name="google-site-verification" content="onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY">
|
27
27
|
<script type="application/ld+json">
|
28
|
-
{"
|
28
|
+
{"name":null,"description":"Hi there! Interested in contributing to Jekyll? We’d love your help. Jekyll is an open source project, built one contribution at a time by users like you.","url":"https://jekyllrb.com/docs/contributing/","headline":"Contributing","dateModified":"2017-10-24T08:07:43-07:00","datePublished":"2017-10-24T08:07:43-07:00","sameAs":null,"@type":"BlogPosting","author":null,"image":null,"publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://jekyllrb.com/img/logo-2x.png"}},"mainEntityOfPage":{"@type":"WebPage","@id":"https://jekyllrb.com/docs/contributing/"},"@context":"http://schema.org"}</script>
|
29
29
|
<!-- End Jekyll SEO tag -->
|
30
30
|
|
31
31
|
<!--[if lt IE 9]>
|
@@ -291,12 +291,7 @@
|
|
291
291
|
|
292
292
|
<h2 id="where-to-get-help-or-report-a-problem">Where to get help or report a problem</h2>
|
293
293
|
|
294
|
-
<
|
295
|
-
<li>If you have a question about using Jekyll, start a discussion on <a href="https://talk.jekyllrb.com">Jekyll Talk</a>.</li>
|
296
|
-
<li>If you think you’ve found a bug within a Jekyll plugin, open an issue in that plugin’s repository.</li>
|
297
|
-
<li>If you think you’ve found a bug within Jekyll itself, <a href="https://github.com/jekyll/jekyll/issues/new">open an issue</a>.</li>
|
298
|
-
<li>More resources are listed on our <a href="https://jekyllrb.com/help/">Help page</a>.</li>
|
299
|
-
</ul>
|
294
|
+
<p>See <a href="SUPPORT.md">the support guidelines</a></p>
|
300
295
|
|
301
296
|
<h2 id="ways-to-contribute">Ways to contribute</h2>
|
302
297
|
|
@@ -430,6 +425,11 @@
|
|
430
425
|
<li>
|
431
426
|
<p>Don’t bump the Gem version in your pull request (if you don’t know what that means, you probably didn’t).</p>
|
432
427
|
</li>
|
428
|
+
<li>
|
429
|
+
<p>You can use the command <code class="highlighter-rouge">script/console</code> to start a REPL to explore the result of
|
430
|
+
Jekyll’s methods. It also provides you with helpful methods to quickly create a
|
431
|
+
site or configuration. <a href="https://github.com/jekyll/jekyll/blob/master/script/console">Feel free to check it out!</a></p>
|
432
|
+
</li>
|
433
433
|
</ul>
|
434
434
|
|
435
435
|
<h2 id="running-tests-locally">Running tests locally</h2>
|
@@ -4,13 +4,13 @@
|
|
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.6.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">
|
11
11
|
<link rel="stylesheet" href="/css/screen.css">
|
12
12
|
<link rel="icon" type="image/x-icon" href="/favicon.ico">
|
13
|
-
<!-- Begin Jekyll SEO tag v2.
|
13
|
+
<!-- Begin Jekyll SEO tag v2.3.0 -->
|
14
14
|
<title>Data Files | Jekyll • Simple, blog-aware, static sites</title>
|
15
15
|
<meta property="og:title" content="Data Files">
|
16
16
|
<meta property="og:locale" content="en_US">
|
@@ -20,12 +20,12 @@
|
|
20
20
|
<meta property="og:url" content="https://jekyllrb.com/docs/datafiles/">
|
21
21
|
<meta property="og:site_name" content="Jekyll • Simple, blog-aware, static sites">
|
22
22
|
<meta property="og:type" content="article">
|
23
|
-
<meta property="article:published_time" content="2017-
|
23
|
+
<meta property="article:published_time" content="2017-10-24T08:07:43-07:00">
|
24
24
|
<meta name="twitter:card" content="summary">
|
25
25
|
<meta name="twitter:site" content="@jekyllrb">
|
26
26
|
<meta name="google-site-verification" content="onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY">
|
27
27
|
<script type="application/ld+json">
|
28
|
-
{"
|
28
|
+
{"name":null,"description":"In addition to the built-in variables available from Jekyll, you can specify your own custom data that can be accessed via the Liquid templating system.","url":"https://jekyllrb.com/docs/datafiles/","headline":"Data Files","dateModified":"2017-10-24T08:07:43-07:00","datePublished":"2017-10-24T08:07:43-07:00","sameAs":null,"@type":"BlogPosting","author":null,"image":null,"publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://jekyllrb.com/img/logo-2x.png"}},"mainEntityOfPage":{"@type":"WebPage","@id":"https://jekyllrb.com/docs/datafiles/"},"@context":"http://schema.org"}</script>
|
29
29
|
<!-- End Jekyll SEO tag -->
|
30
30
|
|
31
31
|
<!--[if lt IE 9]>
|
@@ -315,35 +315,30 @@ of code in your Jekyll templates:</p>
|
|
315
315
|
|
316
316
|
<p>In <code class="highlighter-rouge">_data/members.yml</code>:</p>
|
317
317
|
|
318
|
-
<div class="language-yaml highlighter-rouge">
|
319
|
-
<
|
320
|
-
<span class="s">github</span><span class="pi">:</span> <span class="s">konklone</span>
|
318
|
+
<div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="pi">-</span> <span class="na">name</span><span class="pi">:</span> <span class="s">Eric Mill</span>
|
319
|
+
<span class="na">github</span><span class="pi">:</span> <span class="s">konklone</span>
|
321
320
|
|
322
|
-
<span class="pi">-</span> <span class="
|
323
|
-
<span class="
|
321
|
+
<span class="pi">-</span> <span class="na">name</span><span class="pi">:</span> <span class="s">Parker Moore</span>
|
322
|
+
<span class="na">github</span><span class="pi">:</span> <span class="s">parkr</span>
|
324
323
|
|
325
|
-
<span class="pi">-</span> <span class="
|
326
|
-
<span class="
|
327
|
-
</code></pre>
|
328
|
-
</div>
|
324
|
+
<span class="pi">-</span> <span class="na">name</span><span class="pi">:</span> <span class="s">Liu Fengyun</span>
|
325
|
+
<span class="na">github</span><span class="pi">:</span> <span class="s">liufengyun</span>
|
326
|
+
</code></pre></div></div>
|
329
327
|
|
330
328
|
<p>Or <code class="highlighter-rouge">_data/members.csv</code>:</p>
|
331
329
|
|
332
|
-
<div class="language-text highlighter-rouge">
|
333
|
-
<pre class="highlight"><code>name,github
|
330
|
+
<div class="language-text highlighter-rouge"><div class="highlight"><pre class="highlight"><code>name,github
|
334
331
|
Eric Mill,konklone
|
335
332
|
Parker Moore,parkr
|
336
333
|
Liu Fengyun,liufengyun
|
337
|
-
</code></pre>
|
338
|
-
</div>
|
334
|
+
</code></pre></div></div>
|
339
335
|
|
340
336
|
<p>This data can be accessed via <code class="highlighter-rouge">site.data.members</code> (notice that the filename
|
341
337
|
determines the variable name).</p>
|
342
338
|
|
343
339
|
<p>You can now render the list of members in a template:</p>
|
344
340
|
|
345
|
-
<div class="language-html highlighter-rouge">
|
346
|
-
<pre class="highlight"><code>
|
341
|
+
<div class="language-html highlighter-rouge"><div class="highlight"><pre class="highlight"><code>
|
347
342
|
<span class="nt"><ul></span>
|
348
343
|
{% for member in site.data.members %}
|
349
344
|
<span class="nt"><li></span>
|
@@ -354,8 +349,7 @@ determines the variable name).</p>
|
|
354
349
|
{% endfor %}
|
355
350
|
<span class="nt"></ul></span>
|
356
351
|
|
357
|
-
</code></pre>
|
358
|
-
</div>
|
352
|
+
</code></pre></div></div>
|
359
353
|
|
360
354
|
<p class="note info">If your Jekyll site has a lot of pages, such as with documentation websites, see the detailed examples in <a href="/tutorials/navigation/">how to build robust navigation for your site</a>.</p>
|
361
355
|
|
@@ -368,34 +362,29 @@ folder:</p>
|
|
368
362
|
|
369
363
|
<p>In <code class="highlighter-rouge">_data/orgs/jekyll.yml</code>:</p>
|
370
364
|
|
371
|
-
<div class="language-yaml highlighter-rouge">
|
372
|
-
<
|
373
|
-
<span class="
|
374
|
-
<span class="
|
375
|
-
|
376
|
-
<span class="s">github</span><span class="pi">:</span> <span class="s">mojombo</span>
|
365
|
+
<div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">username</span><span class="pi">:</span> <span class="s">jekyll</span>
|
366
|
+
<span class="na">name</span><span class="pi">:</span> <span class="s">Jekyll</span>
|
367
|
+
<span class="na">members</span><span class="pi">:</span>
|
368
|
+
<span class="pi">-</span> <span class="na">name</span><span class="pi">:</span> <span class="s">Tom Preston-Werner</span>
|
369
|
+
<span class="na">github</span><span class="pi">:</span> <span class="s">mojombo</span>
|
377
370
|
|
378
|
-
<span class="pi">-</span> <span class="
|
379
|
-
<span class="
|
380
|
-
</code></pre>
|
381
|
-
</div>
|
371
|
+
<span class="pi">-</span> <span class="na">name</span><span class="pi">:</span> <span class="s">Parker Moore</span>
|
372
|
+
<span class="na">github</span><span class="pi">:</span> <span class="s">parkr</span>
|
373
|
+
</code></pre></div></div>
|
382
374
|
|
383
375
|
<p>In <code class="highlighter-rouge">_data/orgs/doeorg.yml</code>:</p>
|
384
376
|
|
385
|
-
<div class="language-yaml highlighter-rouge">
|
386
|
-
<
|
387
|
-
<span class="
|
388
|
-
<span class="
|
389
|
-
|
390
|
-
|
391
|
-
</code></pre>
|
392
|
-
</div>
|
377
|
+
<div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">username</span><span class="pi">:</span> <span class="s">doeorg</span>
|
378
|
+
<span class="na">name</span><span class="pi">:</span> <span class="s">Doe Org</span>
|
379
|
+
<span class="na">members</span><span class="pi">:</span>
|
380
|
+
<span class="pi">-</span> <span class="na">name</span><span class="pi">:</span> <span class="s">John Doe</span>
|
381
|
+
<span class="na">github</span><span class="pi">:</span> <span class="s">jdoe</span>
|
382
|
+
</code></pre></div></div>
|
393
383
|
|
394
384
|
<p>The organizations can then be accessed via <code class="highlighter-rouge">site.data.orgs</code>, followed by the
|
395
385
|
file name:</p>
|
396
386
|
|
397
|
-
<div class="language-html highlighter-rouge">
|
398
|
-
<pre class="highlight"><code>
|
387
|
+
<div class="language-html highlighter-rouge"><div class="highlight"><pre class="highlight"><code>
|
399
388
|
<span class="nt"><ul></span>
|
400
389
|
{% for org_hash in site.data.orgs %}
|
401
390
|
{% assign org = org_hash[1] %}
|
@@ -408,8 +397,7 @@ file name:</p>
|
|
408
397
|
{% endfor %}
|
409
398
|
<span class="nt"></ul></span>
|
410
399
|
|
411
|
-
</code></pre>
|
412
|
-
</div>
|
400
|
+
</code></pre></div></div>
|
413
401
|
|
414
402
|
<h2 id="example-accessing-a-specific-author">Example: Accessing a specific author</h2>
|
415
403
|
|
@@ -417,17 +405,14 @@ file name:</p>
|
|
417
405
|
|
418
406
|
<p><code class="highlighter-rouge">_data/people.yml</code>:</p>
|
419
407
|
|
420
|
-
<div class="language-yaml highlighter-rouge">
|
421
|
-
<
|
422
|
-
<span class="
|
423
|
-
|
424
|
-
</code></pre>
|
425
|
-
</div>
|
408
|
+
<div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">dave</span><span class="pi">:</span>
|
409
|
+
<span class="na">name</span><span class="pi">:</span> <span class="s">David Smith</span>
|
410
|
+
<span class="na">twitter</span><span class="pi">:</span> <span class="s">DavidSilvaSmith</span>
|
411
|
+
</code></pre></div></div>
|
426
412
|
|
427
413
|
<p>The author can then be specified as a page variable in a post’s frontmatter:</p>
|
428
414
|
|
429
|
-
<div class="language-html highlighter-rouge">
|
430
|
-
<pre class="highlight"><code>
|
415
|
+
<div class="language-html highlighter-rouge"><div class="highlight"><pre class="highlight"><code>
|
431
416
|
---
|
432
417
|
title: sample post
|
433
418
|
author: dave
|
@@ -441,8 +426,7 @@ author: dave
|
|
441
426
|
<span class="nt"></a></span>
|
442
427
|
|
443
428
|
|
444
|
-
</code></pre>
|
445
|
-
</div>
|
429
|
+
</code></pre></div></div>
|
446
430
|
|
447
431
|
<p>For information on how to build robust navigation for your site (especially if you have a documentation website or another type of Jekyll site with a lot of pages to organize), see <a href="/tutorials/navigation">Navigation</a>.</p>
|
448
432
|
|
@@ -4,13 +4,13 @@
|
|
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.6.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">
|
11
11
|
<link rel="stylesheet" href="/css/screen.css">
|
12
12
|
<link rel="icon" type="image/x-icon" href="/favicon.ico">
|
13
|
-
<!-- Begin Jekyll SEO tag v2.
|
13
|
+
<!-- Begin Jekyll SEO tag v2.3.0 -->
|
14
14
|
<title>Deployment methods | Jekyll • Simple, blog-aware, static sites</title>
|
15
15
|
<meta property="og:title" content="Deployment methods">
|
16
16
|
<meta property="og:locale" content="en_US">
|
@@ -20,12 +20,12 @@
|
|
20
20
|
<meta property="og:url" content="https://jekyllrb.com/docs/deployment-methods/">
|
21
21
|
<meta property="og:site_name" content="Jekyll • Simple, blog-aware, static sites">
|
22
22
|
<meta property="og:type" content="article">
|
23
|
-
<meta property="article:published_time" content="2017-
|
23
|
+
<meta property="article:published_time" content="2017-10-24T08:07:43-07:00">
|
24
24
|
<meta name="twitter:card" content="summary">
|
25
25
|
<meta name="twitter:site" content="@jekyllrb">
|
26
26
|
<meta name="google-site-verification" content="onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY">
|
27
27
|
<script type="application/ld+json">
|
28
|
-
{"
|
28
|
+
{"name":null,"description":"Sites built using Jekyll can be deployed in a large number of ways due to the static nature of the generated output. A few of the most common deployment techniques are described below.","url":"https://jekyllrb.com/docs/deployment-methods/","headline":"Deployment methods","dateModified":"2017-10-24T08:07:43-07:00","datePublished":"2017-10-24T08:07:43-07:00","sameAs":null,"@type":"BlogPosting","author":null,"image":null,"publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://jekyllrb.com/img/logo-2x.png"}},"mainEntityOfPage":{"@type":"WebPage","@id":"https://jekyllrb.com/docs/deployment-methods/"},"@context":"http://schema.org"}</script>
|
29
29
|
<!-- End Jekyll SEO tag -->
|
30
30
|
|
31
31
|
<!--[if lt IE 9]>
|
@@ -289,6 +289,31 @@
|
|
289
289
|
<h1>Deployment methods</h1>
|
290
290
|
<p>Sites built using Jekyll can be deployed in a large number of ways due to the static nature of the generated output. A few of the most common deployment techniques are described below.</p>
|
291
291
|
|
292
|
+
<div class="note">
|
293
|
+
<h5>ProTip™: Use GitHub Pages for zero-hassle Jekyll hosting</h5>
|
294
|
+
<p>GitHub Pages are powered by Jekyll behind the scenes, so if you’re looking for a zero-hassle, zero-cost solution, GitHub Pages are a great way to <a href="../github-pages/">host your Jekyll-powered website for free</a>.</p>
|
295
|
+
</div>
|
296
|
+
|
297
|
+
<h2 id="netlify">Netlify</h2>
|
298
|
+
|
299
|
+
<p>Netlify provides Global CDN, Continuous Deployment, one click HTTPS and <a href="https://www.netlify.com/features/">much more</a>, providing developers the most robust toolset available for modern web projects, without added complexity. Netlify supports custom plugins for Jekyll and has a free plan for open source projects.</p>
|
300
|
+
|
301
|
+
<p>Read this <a href="https://www.netlify.com/blog/2015/10/28/a-step-by-step-guide-jekyll-3.0-on-netlify/">Jekyll step-by-step guide</a> to setup your Jekyll site on Netlify.</p>
|
302
|
+
|
303
|
+
<h2 id="aerobatic">Aerobatic</h2>
|
304
|
+
|
305
|
+
<p><a href="https://www.aerobatic.com">Aerobatic</a> has custom domains, global CDN distribution, basic auth, CORS proxying, and a growing list of plugins all included.</p>
|
306
|
+
|
307
|
+
<p>Automating the deployment of a Jekyll site is simple. See our <a href="https://www.aerobatic.com/docs/static-site-generators/#jekyll">Jekyll docs</a> for more details. Your built <code class="highlighter-rouge">_site</code> folder is deployed to our highly-available, globally distributed hosting service.</p>
|
308
|
+
|
309
|
+
<h2 id="kickster">Kickster</h2>
|
310
|
+
|
311
|
+
<p>Use <a href="http://kickster.nielsenramon.com/">Kickster</a> for easy (automated) deploys to GitHub Pages when using unsupported plugins on GitHub Pages.</p>
|
312
|
+
|
313
|
+
<p>Kickster provides a basic Jekyll project setup packed with web best practises and useful optimization tools increasing your overall project quality. Kickster ships with automated and worry-free deployment scripts for GitHub Pages.</p>
|
314
|
+
|
315
|
+
<p>Setting up Kickster is very easy, just install the gem and you are good to go. More documentation can here found <a href="https://github.com/nielsenramon/kickster#kickster">here</a>. If you do not want to use the gem or start a new project you can just copy paste the deployment scripts for <a href="https://github.com/nielsenramon/kickster/tree/master/snippets/travis">Travis CI</a> or <a href="https://github.com/nielsenramon/kickster#automated-deployment-with-circle-ci">Circle CI</a>.</p>
|
316
|
+
|
292
317
|
<h2 id="web-hosting-providers-ftp">Web hosting providers (FTP)</h2>
|
293
318
|
|
294
319
|
<p>Just about any traditional web hosting provider will let you upload files to their servers over FTP. To upload a Jekyll site to a web host using FTP, simply run the <code class="highlighter-rouge">jekyll build</code> command and copy the contents of the generated <code class="highlighter-rouge">_site</code> folder to the root folder of your hosting account. This is most likely to be the <code class="highlighter-rouge">httpdocs</code> or <code class="highlighter-rouge">public_html</code> folder on most hosting providers.</p>
|
@@ -313,46 +338,38 @@ this</a>.</p>
|
|
313
338
|
|
314
339
|
<p>To have a remote server handle the deploy for you every time you push changes using Git, you can create a user account which has all the public keys that are authorized to deploy in its <code class="highlighter-rouge">authorized_keys</code> file. With that in place, setting up the post-receive hook is done as follows:</p>
|
315
340
|
|
316
|
-
<div class="language-sh highlighter-rouge">
|
317
|
-
<
|
318
|
-
<span class="
|
319
|
-
<span class="
|
320
|
-
<span class="
|
321
|
-
<span class="
|
322
|
-
|
323
|
-
</code></pre>
|
324
|
-
</div>
|
341
|
+
<div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code>laptop<span class="nv">$ </span>ssh deployer@example.com
|
342
|
+
server<span class="nv">$ </span>mkdir myrepo.git
|
343
|
+
server<span class="nv">$ </span><span class="nb">cd </span>myrepo.git
|
344
|
+
server<span class="nv">$ </span>git <span class="nt">--bare</span> init
|
345
|
+
server<span class="nv">$ </span>cp hooks/post-receive.sample hooks/post-receive
|
346
|
+
server<span class="nv">$ </span>mkdir /var/www/myrepo
|
347
|
+
</code></pre></div></div>
|
325
348
|
|
326
349
|
<p>Next, add the following lines to hooks/post-receive and be sure Jekyll is
|
327
350
|
installed on the server:</p>
|
328
351
|
|
329
|
-
<div class="language-sh highlighter-rouge">
|
330
|
-
<pre class="highlight"><code><span class="nv">GIT_REPO</span><span class="o">=</span><span class="nv">$HOME</span>/myrepo.git
|
352
|
+
<div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">GIT_REPO</span><span class="o">=</span><span class="nv">$HOME</span>/myrepo.git
|
331
353
|
<span class="nv">TMP_GIT_CLONE</span><span class="o">=</span><span class="nv">$HOME</span>/tmp/myrepo
|
332
354
|
<span class="nv">PUBLIC_WWW</span><span class="o">=</span>/var/www/myrepo
|
333
355
|
|
334
356
|
git clone <span class="nv">$GIT_REPO</span> <span class="nv">$TMP_GIT_CLONE</span>
|
335
|
-
jekyll build
|
336
|
-
rm
|
357
|
+
bundle <span class="nb">exec </span>jekyll build <span class="nt">-s</span> <span class="nv">$TMP_GIT_CLONE</span> <span class="nt">-d</span> <span class="nv">$PUBLIC_WWW</span>
|
358
|
+
rm <span class="nt">-Rf</span> <span class="nv">$TMP_GIT_CLONE</span>
|
337
359
|
<span class="nb">exit</span>
|
338
|
-
</code></pre>
|
339
|
-
</div>
|
360
|
+
</code></pre></div></div>
|
340
361
|
|
341
362
|
<p>Finally, run the following command on any users laptop that needs to be able to
|
342
363
|
deploy using this hook:</p>
|
343
364
|
|
344
|
-
<div class="language-sh highlighter-rouge">
|
345
|
-
|
346
|
-
</code></pre>
|
347
|
-
</div>
|
365
|
+
<div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code>laptops<span class="nv">$ </span>git remote add deploy deployer@example.com:~/myrepo.git
|
366
|
+
</code></pre></div></div>
|
348
367
|
|
349
368
|
<p>Deploying is now as easy as telling nginx or Apache to look at
|
350
369
|
<code class="highlighter-rouge">/var/www/myrepo</code> and running the following:</p>
|
351
370
|
|
352
|
-
<div class="language-sh highlighter-rouge">
|
353
|
-
|
354
|
-
</code></pre>
|
355
|
-
</div>
|
371
|
+
<div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code>laptops<span class="nv">$ </span>git push deploy master
|
372
|
+
</code></pre></div></div>
|
356
373
|
|
357
374
|
<h3 id="static-publisher">Static Publisher</h3>
|
358
375
|
|
@@ -395,10 +412,8 @@ is to put the restriction to certificate-based authorization in
|
|
395
412
|
<code class="highlighter-rouge">~/.ssh/authorized_keys</code>. Then, launch <code class="highlighter-rouge">rrsync</code> and supply
|
396
413
|
it with the folder it shall have read-write access to:</p>
|
397
414
|
|
398
|
-
<div class="language-sh highlighter-rouge">
|
399
|
-
|
400
|
-
</code></pre>
|
401
|
-
</div>
|
415
|
+
<div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nb">command</span><span class="o">=</span><span class="s2">"</span><span class="nv">$HOME</span><span class="s2">/bin/rrsync <folder>"</span>,no-agent-forwarding,no-port-forwarding,no-pty,no-user-rc,no-X11-forwarding ssh-rsa <cert>
|
416
|
+
</code></pre></div></div>
|
402
417
|
|
403
418
|
<p><code class="highlighter-rouge"><folder></code> is the path to your site. E.g., <code class="highlighter-rouge">~/public_html/you.org/blog-html/</code>.</p>
|
404
419
|
|
@@ -406,12 +421,10 @@ it with the folder it shall have read-write access to:</p>
|
|
406
421
|
|
407
422
|
<p>Add the <code class="highlighter-rouge">deploy</code> script to the site source folder:</p>
|
408
423
|
|
409
|
-
<div class="language-sh highlighter-rouge">
|
410
|
-
<pre class="highlight"><code><span class="c">#!/bin/sh</span>
|
424
|
+
<div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="c">#!/bin/sh</span>
|
411
425
|
|
412
|
-
rsync
|
413
|
-
</code></pre>
|
414
|
-
</div>
|
426
|
+
rsync <span class="nt">-crvz</span> <span class="nt">--rsh</span><span class="o">=</span><span class="s1">'ssh -p2222'</span> <span class="nt">--delete-after</span> <span class="nt">--delete-excluded</span> <folder> <user>@<site>:
|
427
|
+
</code></pre></div></div>
|
415
428
|
|
416
429
|
<p>Command line parameters are:</p>
|
417
430
|
|
@@ -429,10 +442,8 @@ your host uses a different port than the default (e.g, HostGator)</li>
|
|
429
442
|
|
430
443
|
<p>Using this setup, you might run the following command:</p>
|
431
444
|
|
432
|
-
<div class="language-sh highlighter-rouge">
|
433
|
-
|
434
|
-
</code></pre>
|
435
|
-
</div>
|
445
|
+
<div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code>rsync <span class="nt">-crvz</span> <span class="nt">--rsh</span><span class="o">=</span><span class="s1">'ssh -p2222'</span> <span class="nt">--delete-after</span> <span class="nt">--delete-excluded</span> _site/ hostuser@example.org:
|
446
|
+
</code></pre></div></div>
|
436
447
|
|
437
448
|
<p>Don’t forget the column <code class="highlighter-rouge">:</code> after server name!</p>
|
438
449
|
|
@@ -444,11 +455,9 @@ copy it to the output folder. This behavior can be changed in <code class="highl
|
|
444
455
|
|
445
456
|
<p>Just add the following line:</p>
|
446
457
|
|
447
|
-
<div class="language-yaml highlighter-rouge">
|
448
|
-
<
|
449
|
-
|
450
|
-
</code></pre>
|
451
|
-
</div>
|
458
|
+
<div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="c1"># Do not copy these files to the output directory</span>
|
459
|
+
<span class="na">exclude</span><span class="pi">:</span> <span class="pi">[</span><span class="s2">"</span><span class="s">deploy"</span><span class="pi">]</span>
|
460
|
+
</code></pre></div></div>
|
452
461
|
|
453
462
|
<p>Alternatively, you can use an <code class="highlighter-rouge">rsync-exclude.txt</code> file to control which files will be transferred to your server.</p>
|
454
463
|
|
@@ -483,25 +492,6 @@ low-volume blogs as you only pay for what you use.</p>
|
|
483
492
|
<p>If you’d like to deploy your site to an OpenShift gear, there’s <a href="https://github.com/openshift-quickstart/jekyll-openshift">a cartridge
|
484
493
|
for that</a>.</p>
|
485
494
|
|
486
|
-
<div class="note">
|
487
|
-
<h5>ProTip™: Use GitHub Pages for zero-hassle Jekyll hosting</h5>
|
488
|
-
<p>GitHub Pages are powered by Jekyll behind the scenes, so if you’re looking for a zero-hassle, zero-cost solution, GitHub Pages are a great way to <a href="../github-pages/">host your Jekyll-powered website for free</a>.</p>
|
489
|
-
</div>
|
490
|
-
|
491
|
-
<h2 id="kickster">Kickster</h2>
|
492
|
-
|
493
|
-
<p>Use <a href="http://kickster.nielsenramon.com/">Kickster</a> for easy (automated) deploys to GitHub Pages when using unsupported plugins on GitHub Pages.</p>
|
494
|
-
|
495
|
-
<p>Kickster provides a basic Jekyll project setup packed with web best practises and useful optimization tools increasing your overall project quality. Kickster ships with automated and worry-free deployment scripts for GitHub Pages.</p>
|
496
|
-
|
497
|
-
<p>Setting up Kickster is very easy, just install the gem and you are good to go. More documentation can here found <a href="https://github.com/nielsenramon/kickster#kickster">here</a>. If you do not want to use the gem or start a new project you can just copy paste the deployment scripts for <a href="https://github.com/nielsenramon/kickster/tree/master/snippets/travis">Travis CI</a> or <a href="https://github.com/nielsenramon/kickster#automated-deployment-with-circle-ci">Circle CI</a>.</p>
|
498
|
-
|
499
|
-
<h2 id="aerobatic">Aerobatic</h2>
|
500
|
-
|
501
|
-
<p><a href="https://www.aerobatic.com">Aerobatic</a> has custom domains, global CDN distribution, basic auth, CORS proxying, and a growing list of plugins all included.</p>
|
502
|
-
|
503
|
-
<p>Automating the deployment of a Jekyll site is simple. See our <a href="https://www.aerobatic.com/docs/static-site-generators/#jekyll">Jekyll docs</a> for more details. Your built <code class="highlighter-rouge">_site</code> folder is deployed to our highly-available, globally distributed hosting service.</p>
|
504
|
-
|
505
495
|
|
506
496
|
|
507
497
|
|
data/site/docs/drafts/index.html
CHANGED
@@ -4,13 +4,13 @@
|
|
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.6.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">
|
11
11
|
<link rel="stylesheet" href="/css/screen.css">
|
12
12
|
<link rel="icon" type="image/x-icon" href="/favicon.ico">
|
13
|
-
<!-- Begin Jekyll SEO tag v2.
|
13
|
+
<!-- Begin Jekyll SEO tag v2.3.0 -->
|
14
14
|
<title>Working with drafts | Jekyll • Simple, blog-aware, static sites</title>
|
15
15
|
<meta property="og:title" content="Working with drafts">
|
16
16
|
<meta property="og:locale" content="en_US">
|
@@ -20,12 +20,12 @@
|
|
20
20
|
<meta property="og:url" content="https://jekyllrb.com/docs/drafts/">
|
21
21
|
<meta property="og:site_name" content="Jekyll • Simple, blog-aware, static sites">
|
22
22
|
<meta property="og:type" content="article">
|
23
|
-
<meta property="article:published_time" content="2017-
|
23
|
+
<meta property="article:published_time" content="2017-10-24T08:07:43-07:00">
|
24
24
|
<meta name="twitter:card" content="summary">
|
25
25
|
<meta name="twitter:site" content="@jekyllrb">
|
26
26
|
<meta name="google-site-verification" content="onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY">
|
27
27
|
<script type="application/ld+json">
|
28
|
-
{"
|
28
|
+
{"name":null,"description":"Drafts are posts without a date. They’re posts you’re still working on and don’t want to publish yet. To get up and running with drafts, create a _drafts folder in your site’s root (as described in the site structure section) and create your first draft:","url":"https://jekyllrb.com/docs/drafts/","headline":"Working with drafts","dateModified":"2017-10-24T08:07:43-07:00","datePublished":"2017-10-24T08:07:43-07:00","sameAs":null,"@type":"BlogPosting","author":null,"image":null,"publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://jekyllrb.com/img/logo-2x.png"}},"mainEntityOfPage":{"@type":"WebPage","@id":"https://jekyllrb.com/docs/drafts/"},"@context":"http://schema.org"}</script>
|
29
29
|
<!-- End Jekyll SEO tag -->
|
30
30
|
|
31
31
|
<!--[if lt IE 9]>
|
@@ -292,11 +292,9 @@ don’t want to publish yet. To get up and running with drafts, create a
|
|
292
292
|
<code class="highlighter-rouge">_drafts</code> folder in your site’s root (as described in the <a href="/docs/structure/">site structure</a> section) and create your
|
293
293
|
first draft:</p>
|
294
294
|
|
295
|
-
<div class="language-text highlighter-rouge"
|
296
|
-
<pre class="highlight"><code>|-- _drafts/
|
295
|
+
<div class="language-text highlighter-rouge"><div class="highlight"><pre class="highlight"><code>|-- _drafts/
|
297
296
|
| |-- a-draft-post.md
|
298
|
-
</code></pre>
|
299
|
-
</div>
|
297
|
+
</code></pre></div></div>
|
300
298
|
|
301
299
|
<p>To preview your site with drafts, simply run <code class="highlighter-rouge">jekyll serve</code> or <code class="highlighter-rouge">jekyll build</code>
|
302
300
|
with the <code class="highlighter-rouge">--drafts</code> switch. Each will be assigned the value modification time
|