jekyll-docs 3.7.3 → 3.8.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/lib/jekyll-docs.rb +1 -1
- data/site/404.html +6 -22
- data/site/docs/assets/index.html +9 -25
- data/site/docs/code_of_conduct/index.html +8 -24
- data/site/docs/collections/index.html +22 -24
- data/site/docs/conduct/index.html +8 -24
- data/site/docs/configuration/index.html +33 -39
- data/site/docs/continuous-integration/buddyworks/index.html +8 -24
- data/site/docs/continuous-integration/circleci/index.html +8 -24
- data/site/docs/continuous-integration/index.html +8 -24
- data/site/docs/continuous-integration/travis-ci/index.html +8 -24
- data/site/docs/contributing/index.html +8 -24
- data/site/docs/datafiles/index.html +8 -24
- data/site/docs/deployment-methods/index.html +8 -24
- data/site/docs/drafts/index.html +8 -24
- data/site/docs/extras/index.html +8 -24
- data/site/docs/frontmatter/index.html +8 -24
- data/site/docs/github-pages/index.html +8 -24
- data/site/docs/history/index.html +137 -40
- data/site/docs/home/index.html +32 -63
- data/site/docs/includes/index.html +8 -24
- data/site/docs/installation/index.html +120 -109
- data/site/docs/maintaining/affinity-team-captain/index.html +8 -24
- data/site/docs/maintaining/avoiding-burnout/index.html +10 -26
- data/site/docs/maintaining/becoming-a-maintainer/index.html +8 -24
- data/site/docs/maintaining/index.html +14 -29
- data/site/docs/maintaining/merging-a-pull-request/index.html +12 -28
- data/site/docs/maintaining/releasing-a-new-version/index.html +761 -0
- data/site/docs/maintaining/reviewing-a-pull-request/index.html +8 -24
- data/site/docs/maintaining/special-labels/index.html +8 -24
- data/site/docs/maintaining/triaging-an-issue/index.html +8 -24
- data/site/docs/migrations/index.html +8 -24
- data/site/docs/pages/index.html +8 -24
- data/site/docs/pagination/index.html +8 -24
- data/site/docs/permalinks/index.html +16 -32
- data/site/docs/plugins/index.html +27 -104
- data/site/docs/posts/index.html +34 -27
- data/site/docs/quickstart/index.html +8 -24
- data/site/docs/resources/index.html +14 -26
- data/site/docs/sites/index.html +8 -24
- data/site/docs/static-files/index.html +8 -24
- data/site/docs/structure/index.html +8 -24
- data/site/docs/support/index.html +8 -24
- data/site/docs/templates/index.html +36 -24
- data/site/docs/themes/index.html +50 -29
- data/site/docs/troubleshooting/index.html +68 -34
- data/site/docs/upgrading/0-to-2/index.html +8 -24
- data/site/docs/upgrading/2-to-3/index.html +8 -24
- data/site/docs/upgrading/index.html +8 -24
- data/site/docs/usage/index.html +8 -24
- data/site/docs/variables/index.html +9 -25
- data/site/docs/windows/index.html +14 -25
- data/site/feed.xml +49 -82
- data/site/help/index.html +7 -23
- data/site/index.html +7 -23
- data/site/jekyllconf/index.html +7 -23
- data/site/latest_version.txt +1 -1
- data/site/news/2013/05/05/jekyll-1-0-0-released/index.html +27 -30
- data/site/news/2013/05/08/jekyll-1-0-1-released/index.html +27 -30
- data/site/news/2013/05/12/jekyll-1-0-2-released/index.html +27 -30
- data/site/news/2013/06/07/jekyll-1-0-3-released/index.html +27 -30
- data/site/news/2013/07/14/jekyll-1-1-0-released/index.html +27 -30
- data/site/news/2013/07/24/jekyll-1-1-1-released/index.html +27 -30
- data/site/news/2013/07/25/jekyll-1-0-4-released/index.html +27 -30
- data/site/news/2013/07/25/jekyll-1-1-2-released/index.html +27 -30
- data/site/news/2013/09/06/jekyll-1-2-0-released/index.html +27 -30
- data/site/news/2013/09/14/jekyll-1-2-1-released/index.html +27 -30
- data/site/news/2013/10/28/jekyll-1-3-0-rc1-released/index.html +27 -30
- data/site/news/2013/11/04/jekyll-1-3-0-released/index.html +27 -30
- data/site/news/2013/11/26/jekyll-1-3-1-released/index.html +27 -30
- data/site/news/2013/12/07/jekyll-1-4-0-released/index.html +27 -30
- data/site/news/2013/12/09/jekyll-1-4-1-released/index.html +27 -30
- data/site/news/2013/12/16/jekyll-1-4-2-released/index.html +27 -30
- data/site/news/2014/01/13/jekyll-1-4-3-released/index.html +27 -30
- data/site/news/2014/03/24/jekyll-1-5-0-released/index.html +27 -30
- data/site/news/2014/03/27/jekyll-1-5-1-released/index.html +27 -30
- data/site/news/2014/05/06/jekyll-turns-2-0-0/index.html +27 -30
- data/site/news/2014/05/08/jekyll-2-0-3-released/index.html +27 -30
- data/site/news/2014/06/04/jekyll-stickers-1-dollar-stickermule/index.html +27 -30
- data/site/news/2014/06/28/jekyll-turns-21-i-mean-2-1-0/index.html +27 -30
- data/site/news/2014/07/01/jekyll-2-1-1-released/index.html +27 -30
- data/site/news/2014/07/29/jekyll-2-2-0-released/index.html +27 -30
- data/site/news/2014/08/10/jekyll-2-3-0-released/index.html +27 -30
- data/site/news/2014/09/09/jekyll-2-4-0-released/index.html +27 -30
- data/site/news/2014/11/05/jekylls-midlife-crisis-jekyll-turns-2-5-0/index.html +27 -30
- data/site/news/2014/11/09/jekyll-2-5-1-released/index.html +27 -30
- data/site/news/2014/11/12/jekyll-2-5-2-released/index.html +27 -30
- data/site/news/2014/12/17/alfredxing-welcome-to-jekyll-core/index.html +27 -30
- data/site/news/2014/12/22/jekyll-2-5-3-released/index.html +27 -30
- data/site/news/2015/01/20/jekyll-meet-and-greet/index.html +27 -30
- data/site/news/2015/01/24/jekyll-3-0-0-beta1-released/index.html +27 -30
- data/site/news/2015/02/26/introducing-jekyll-talk/index.html +27 -30
- data/site/news/2015/10/26/jekyll-3-0-released/index.html +27 -30
- data/site/news/2015/11/17/jekyll-3-0-1-released/index.html +27 -30
- data/site/news/2016/01/20/jekyll-3-0-2-released/index.html +27 -30
- data/site/news/2016/01/24/jekyll-3-1-0-released/index.html +27 -30
- data/site/news/2016/01/28/jekyll-3-1-1-released/index.html +27 -30
- data/site/news/2016/02/08/jekyll-3-0-3-released/index.html +27 -30
- data/site/news/2016/02/19/jekyll-3-1-2-released/index.html +27 -30
- data/site/news/2016/03/10/making-it-easier-to-contribute-to-jekyll/index.html +27 -30
- data/site/news/2016/04/19/jekyll-3-0-4-released/index.html +27 -30
- data/site/news/2016/04/19/jekyll-3-1-3-released/index.html +27 -30
- data/site/news/2016/04/26/jekyll-3-0-5-released/index.html +27 -30
- data/site/news/2016/05/18/jekyll-3-1-4-released/index.html +27 -30
- data/site/news/2016/05/18/jekyll-3-1-5-released/index.html +27 -30
- data/site/news/2016/05/19/jekyll-3-1-6-released/index.html +27 -30
- data/site/news/2016/06/03/update-on-jekyll-s-google-summer-of-code-projects/index.html +27 -30
- data/site/news/2016/07/26/jekyll-3-2-0-released/index.html +27 -30
- data/site/news/2016/08/02/jekyll-3-2-1-released/index.html +27 -30
- data/site/news/2016/08/24/jekyll-admin-initial-release/index.html +27 -30
- data/site/news/2016/10/06/jekyll-3-3-is-here/index.html +27 -30
- data/site/news/2016/11/14/jekyll-3-3-1-released/index.html +27 -30
- data/site/news/2017/01/18/jekyll-3-4-0-released/index.html +27 -30
- data/site/news/2017/03/02/jekyll-3-4-1-released/index.html +27 -30
- data/site/news/2017/03/09/jekyll-3-4-2-released/index.html +27 -30
- data/site/news/2017/03/21/jekyll-3-4-3-released/index.html +27 -30
- data/site/news/2017/06/15/jekyll-3-5-0-released/index.html +27 -30
- data/site/news/2017/07/17/jekyll-3-5-1-released/index.html +27 -30
- data/site/news/2017/08/12/jekyll-3-5-2-released/index.html +27 -30
- data/site/news/2017/09/21/jekyll-3-6-0-released/index.html +27 -30
- data/site/news/2017/10/19/diversity-open-source/index.html +31 -34
- data/site/news/2017/10/21/jekyll-3-6-2-released/index.html +27 -30
- data/site/news/2018/01/02/jekyll-3-7-0-released/index.html +27 -30
- data/site/news/2018/01/25/{jekyll-3-7-1-released → jekyll-3-7-2-released}/index.html +35 -37
- data/site/news/2018/02/19/meet-jekyll-s-new-lead-developer/index.html +628 -0
- data/site/news/2018/02/24/jekyll-3-7-3-released/index.html +604 -0
- data/site/news/index.html +265 -168
- data/site/news/releases/index.html +185 -150
- data/site/sitemap.xml +78 -59
- data/site/team/index.html +258 -0
- data/site/tutorials/convert-site-to-jekyll/index.html +19 -25
- data/site/tutorials/custom-404-page/index.html +16 -24
- data/site/tutorials/home/index.html +16 -24
- data/site/tutorials/navigation/index.html +23 -28
- data/site/tutorials/orderofinterpretation/index.html +16 -24
- data/site/tutorials/using-jekyll-with-bundler/index.html +424 -0
- data/site/tutorials/video-walkthroughs/index.html +16 -24
- metadata +11 -6
data/site/docs/home/index.html
CHANGED
@@ -3,30 +3,31 @@
|
|
3
3
|
<head>
|
4
4
|
<meta charset="UTF-8">
|
5
5
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
6
|
-
<meta name="generator" content="Jekyll v3.
|
6
|
+
<meta name="generator" content="Jekyll v3.8.0">
|
7
7
|
<link type="application/atom+xml" rel="alternate" href="https://jekyllrb.com/feed.xml" title="Jekyll • Simple, blog-aware, static sites" />
|
8
8
|
<link rel="alternate" type="application/atom+xml" title="Recent commits to Jekyll’s master branch" href="https://github.com/jekyll/jekyll/commits/master.atom">
|
9
|
-
<link rel="
|
9
|
+
<link rel="preconnect" href="https://fonts.gstatic.com/" crossorigin>
|
10
|
+
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Lato:300,300italic,400,400italic,700,700italic,900">
|
10
11
|
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css" />
|
11
12
|
<link rel="stylesheet" href="/css/screen.css">
|
12
13
|
<link rel="icon" type="image/x-icon" href="/favicon.ico">
|
13
14
|
<!-- Begin Jekyll SEO tag v2.4.0 -->
|
14
15
|
<title>Welcome | Jekyll • Simple, blog-aware, static sites</title>
|
15
|
-
<meta name="generator" content="Jekyll v3.
|
16
|
+
<meta name="generator" content="Jekyll v3.8.0" />
|
16
17
|
<meta property="og:title" content="Welcome" />
|
17
18
|
<meta property="og:locale" content="en_US" />
|
18
|
-
<meta name="description" content="This site aims to be a comprehensive guide to Jekyll. We’ll cover topics such as getting your site up and running, creating and managing
|
19
|
-
<meta property="og:description" content="This site aims to be a comprehensive guide to Jekyll. We’ll cover topics such as getting your site up and running, creating and managing
|
19
|
+
<meta name="description" content="This site aims to be a comprehensive guide to Jekyll. We’ll cover topics such as getting your site up and running, creating and managing content, customizing your build, and deploying." />
|
20
|
+
<meta property="og:description" content="This site aims to be a comprehensive guide to Jekyll. We’ll cover topics such as getting your site up and running, creating and managing content, customizing your build, and deploying." />
|
20
21
|
<link rel="canonical" href="https://jekyllrb.com/docs/home/" />
|
21
22
|
<meta property="og:url" content="https://jekyllrb.com/docs/home/" />
|
22
23
|
<meta property="og:site_name" content="Jekyll • Simple, blog-aware, static sites" />
|
23
24
|
<meta property="og:type" content="article" />
|
24
|
-
<meta property="article:published_time" content="2018-
|
25
|
+
<meta property="article:published_time" content="2018-05-01T13:26:35-07:00" />
|
25
26
|
<meta name="twitter:card" content="summary" />
|
26
27
|
<meta name="twitter:site" content="@jekyllrb" />
|
27
28
|
<meta name="google-site-verification" content="onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY" />
|
28
29
|
<script type="application/ld+json">
|
29
|
-
{"publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://jekyllrb.com/img/logo-2x.png"}},"headline":"Welcome","dateModified":"2018-
|
30
|
+
{"description":"This site aims to be a comprehensive guide to Jekyll. We’ll cover topics such as getting your site up and running, creating and managing content, customizing your build, and deploying.","@type":"BlogPosting","url":"https://jekyllrb.com/docs/home/","publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://jekyllrb.com/img/logo-2x.png"}},"headline":"Welcome","dateModified":"2018-05-01T13:26:35-07:00","datePublished":"2018-05-01T13:26:35-07:00","mainEntityOfPage":{"@type":"WebPage","@id":"https://jekyllrb.com/docs/home/"},"@context":"http://schema.org"}</script>
|
30
31
|
<!-- End Jekyll SEO tag -->
|
31
32
|
|
32
33
|
<!--[if lt IE 9]>
|
@@ -71,7 +72,7 @@
|
|
71
72
|
<div class="meta hide-on-mobiles">
|
72
73
|
<ul>
|
73
74
|
<li>
|
74
|
-
<a href="https://github.com/jekyll/jekyll/releases/tag/v3.
|
75
|
+
<a href="https://github.com/jekyll/jekyll/releases/tag/v3.8.0">v3.8.0</a>
|
75
76
|
</li>
|
76
77
|
<li>
|
77
78
|
<a href="https://github.com/jekyll/jekyll">GitHub</a>
|
@@ -293,56 +294,41 @@
|
|
293
294
|
<a href="https://github.com/jekyll/jekyll/edit/master/docs/_docs/index.md"><i class="fa fa-pencil"></i> Improve this page</a>
|
294
295
|
</div>
|
295
296
|
<h1>Welcome</h1>
|
296
|
-
<p>This site aims to be a comprehensive guide to Jekyll. We’ll cover topics such
|
297
|
-
|
298
|
-
|
299
|
-
|
300
|
-
|
301
|
-
|
302
|
-
<
|
303
|
-
|
304
|
-
<p>Jekyll
|
305
|
-
|
306
|
-
|
307
|
-
|
308
|
-
|
309
|
-
for serving with your favorite web server. Jekyll also happens to be the engine
|
310
|
-
behind <a href="https://pages.github.com">GitHub Pages</a>, which means you can use Jekyll
|
311
|
-
to host your project’s page, blog, or website from GitHub’s servers <strong>for
|
312
|
-
free</strong>.</p>
|
313
|
-
|
314
|
-
<h2 id="helpful-hints">Helpful Hints</h2>
|
315
|
-
|
316
|
-
<p>Throughout this guide there are a number of small-but-handy pieces of
|
317
|
-
information that can make using Jekyll easier, more interesting, and less
|
318
|
-
hazardous. Here’s what to look out for.</p>
|
297
|
+
<p>This site aims to be a comprehensive guide to Jekyll. We’ll cover topics such as getting your site up and running, creating and managing content, customizing your build, and deploying.</p>
|
298
|
+
|
299
|
+
<h2 id="what-is-jekyll-exactly">What is Jekyll, exactly?</h2>
|
300
|
+
|
301
|
+
<p>Jekyll is a simple, blog-aware, static site generator.</p>
|
302
|
+
|
303
|
+
<p>You create your content as text files (<a href="https://daringfireball.net/projects/markdown/">Markdown</a>), and organize them into folders. Then, you build the shell of your site using <a href="https://shopify.github.io/liquid/">Liquid</a>-enhanced HTML templates. Jekyll automatically stitches the content and templates together, generating a website made entirely of static assets, suitable for uploading to any server.</p>
|
304
|
+
|
305
|
+
<p>Jekyll happens to be the engine behind <a href="https://pages.github.com">GitHub Pages</a>, so you can host your project’s Jekyll page/blog/website on GitHub’s servers <strong>for free</strong>.</p>
|
306
|
+
|
307
|
+
<h2 id="navigating-the-guide">Navigating the Guide</h2>
|
308
|
+
|
309
|
+
<p>Throughout this guide, you’ll see these special sections that help you get the most out of Jekyll:</p>
|
319
310
|
|
320
311
|
<div class="note">
|
321
|
-
<h5>ProTips
|
322
|
-
<p>
|
312
|
+
<h5>ProTips™</h5>
|
313
|
+
<p>Tips and tricks that'll make you a Jekyll wizard!</p>
|
323
314
|
</div>
|
324
315
|
|
325
316
|
<div class="note info">
|
326
|
-
<h5>Notes
|
327
|
-
<p>
|
328
|
-
Jekyll.</p>
|
317
|
+
<h5>Notes</h5>
|
318
|
+
<p>Extra tidbits that are sometimes necessary to understand Jekyll.</p>
|
329
319
|
</div>
|
330
320
|
|
331
321
|
<div class="note warning">
|
332
|
-
<h5>Warnings
|
333
|
-
<p>
|
322
|
+
<h5>Warnings</h5>
|
323
|
+
<p>Common pitfalls to avoid.</p>
|
334
324
|
</div>
|
335
325
|
|
336
326
|
<div class="note unreleased">
|
337
|
-
<h5>
|
338
|
-
<p>
|
339
|
-
are not yet released.</p>
|
327
|
+
<h5>Unreleased</h5>
|
328
|
+
<p>Features planned for future versions of Jekyll, but not available yet.</p>
|
340
329
|
</div>
|
341
330
|
|
342
|
-
<p>If you
|
343
|
-
know of a tip you think others would find handy, please <a href="https://github.com/jekyll/jekyll/issues/new">file an
|
344
|
-
issue</a> and we’ll see about
|
345
|
-
including it in this guide.</p>
|
331
|
+
<p>If you find anything we haven’t covered, or would like to share a tip that others might find handy, please <a href="https://github.com/jekyll/jekyll/issues/new">file an issue</a> and we’ll see about adding it to the guide.</p>
|
346
332
|
|
347
333
|
|
348
334
|
|
@@ -615,28 +601,11 @@ including it in this guide.</p>
|
|
615
601
|
</script>
|
616
602
|
|
617
603
|
|
618
|
-
<!-- Gauges (http://get.gaug.es/) -->
|
619
|
-
<script>
|
620
|
-
var _gauges = _gauges || [];
|
621
|
-
(function() {
|
622
|
-
var t = document.createElement('script');
|
623
|
-
t.type = 'text/javascript';
|
624
|
-
t.async = true;
|
625
|
-
t.id = 'gauges-tracker';
|
626
|
-
t.setAttribute('data-site-id', '503c5af6613f5d0f19000027');
|
627
|
-
t.src = '//secure.gaug.es/track.js';
|
628
|
-
var s = document.getElementsByTagName('script')[0];
|
629
|
-
s.parentNode.insertBefore(t, s);
|
630
|
-
})();
|
631
|
-
</script>
|
632
|
-
|
633
|
-
|
634
|
-
|
635
604
|
<!-- Google Analytics (https://www.google.com/analytics) -->
|
636
605
|
<script>
|
637
606
|
!function(j,e,k,y,l,L){j.GoogleAnalyticsObject=y,j[y]||(j[y]=function(){
|
638
607
|
(j[y].q=j[y].q||[]).push(arguments)}),j[y].l=+new Date,l=e.createElement(k),
|
639
|
-
L=e.getElementsByTagName(k)[0],l.src='
|
608
|
+
L=e.getElementsByTagName(k)[0],l.src='https://www.google-analytics.com/analytics.js',
|
640
609
|
L.parentNode.insertBefore(l,L)}(window,document,'script','ga');
|
641
610
|
|
642
611
|
ga('create', 'UA-50755011-1', 'jekyllrb.com');
|
@@ -3,16 +3,17 @@
|
|
3
3
|
<head>
|
4
4
|
<meta charset="UTF-8">
|
5
5
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
6
|
-
<meta name="generator" content="Jekyll v3.
|
6
|
+
<meta name="generator" content="Jekyll v3.8.0">
|
7
7
|
<link type="application/atom+xml" rel="alternate" href="https://jekyllrb.com/feed.xml" title="Jekyll • Simple, blog-aware, static sites" />
|
8
8
|
<link rel="alternate" type="application/atom+xml" title="Recent commits to Jekyll’s master branch" href="https://github.com/jekyll/jekyll/commits/master.atom">
|
9
|
-
<link rel="
|
9
|
+
<link rel="preconnect" href="https://fonts.gstatic.com/" crossorigin>
|
10
|
+
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Lato:300,300italic,400,400italic,700,700italic,900">
|
10
11
|
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css" />
|
11
12
|
<link rel="stylesheet" href="/css/screen.css">
|
12
13
|
<link rel="icon" type="image/x-icon" href="/favicon.ico">
|
13
14
|
<!-- Begin Jekyll SEO tag v2.4.0 -->
|
14
15
|
<title>Includes | Jekyll • Simple, blog-aware, static sites</title>
|
15
|
-
<meta name="generator" content="Jekyll v3.
|
16
|
+
<meta name="generator" content="Jekyll v3.8.0" />
|
16
17
|
<meta property="og:title" content="Includes" />
|
17
18
|
<meta property="og:locale" content="en_US" />
|
18
19
|
<meta name="description" content="The include tag allows you to include the content from another file stored in the _includes folder:" />
|
@@ -21,12 +22,12 @@
|
|
21
22
|
<meta property="og:url" content="https://jekyllrb.com/docs/includes/" />
|
22
23
|
<meta property="og:site_name" content="Jekyll • Simple, blog-aware, static sites" />
|
23
24
|
<meta property="og:type" content="article" />
|
24
|
-
<meta property="article:published_time" content="2018-
|
25
|
+
<meta property="article:published_time" content="2018-05-01T13:26:35-07:00" />
|
25
26
|
<meta name="twitter:card" content="summary" />
|
26
27
|
<meta name="twitter:site" content="@jekyllrb" />
|
27
28
|
<meta name="google-site-verification" content="onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY" />
|
28
29
|
<script type="application/ld+json">
|
29
|
-
{"publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://jekyllrb.com/img/logo-2x.png"}},"headline":"Includes","dateModified":"2018-
|
30
|
+
{"description":"The include tag allows you to include the content from another file stored in the _includes folder:","@type":"BlogPosting","url":"https://jekyllrb.com/docs/includes/","publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://jekyllrb.com/img/logo-2x.png"}},"headline":"Includes","dateModified":"2018-05-01T13:26:35-07:00","datePublished":"2018-05-01T13:26:35-07:00","mainEntityOfPage":{"@type":"WebPage","@id":"https://jekyllrb.com/docs/includes/"},"@context":"http://schema.org"}</script>
|
30
31
|
<!-- End Jekyll SEO tag -->
|
31
32
|
|
32
33
|
<!--[if lt IE 9]>
|
@@ -71,7 +72,7 @@
|
|
71
72
|
<div class="meta hide-on-mobiles">
|
72
73
|
<ul>
|
73
74
|
<li>
|
74
|
-
<a href="https://github.com/jekyll/jekyll/releases/tag/v3.
|
75
|
+
<a href="https://github.com/jekyll/jekyll/releases/tag/v3.8.0">v3.8.0</a>
|
75
76
|
</li>
|
76
77
|
<li>
|
77
78
|
<a href="https://github.com/jekyll/jekyll">GitHub</a>
|
@@ -772,28 +773,11 @@ The latest version of <span class="p">{{</span><span class="w"> </span><span cla
|
|
772
773
|
</script>
|
773
774
|
|
774
775
|
|
775
|
-
<!-- Gauges (http://get.gaug.es/) -->
|
776
|
-
<script>
|
777
|
-
var _gauges = _gauges || [];
|
778
|
-
(function() {
|
779
|
-
var t = document.createElement('script');
|
780
|
-
t.type = 'text/javascript';
|
781
|
-
t.async = true;
|
782
|
-
t.id = 'gauges-tracker';
|
783
|
-
t.setAttribute('data-site-id', '503c5af6613f5d0f19000027');
|
784
|
-
t.src = '//secure.gaug.es/track.js';
|
785
|
-
var s = document.getElementsByTagName('script')[0];
|
786
|
-
s.parentNode.insertBefore(t, s);
|
787
|
-
})();
|
788
|
-
</script>
|
789
|
-
|
790
|
-
|
791
|
-
|
792
776
|
<!-- Google Analytics (https://www.google.com/analytics) -->
|
793
777
|
<script>
|
794
778
|
!function(j,e,k,y,l,L){j.GoogleAnalyticsObject=y,j[y]||(j[y]=function(){
|
795
779
|
(j[y].q=j[y].q||[]).push(arguments)}),j[y].l=+new Date,l=e.createElement(k),
|
796
|
-
L=e.getElementsByTagName(k)[0],l.src='
|
780
|
+
L=e.getElementsByTagName(k)[0],l.src='https://www.google-analytics.com/analytics.js',
|
797
781
|
L.parentNode.insertBefore(l,L)}(window,document,'script','ga');
|
798
782
|
|
799
783
|
ga('create', 'UA-50755011-1', 'jekyllrb.com');
|
@@ -3,30 +3,31 @@
|
|
3
3
|
<head>
|
4
4
|
<meta charset="UTF-8">
|
5
5
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
6
|
-
<meta name="generator" content="Jekyll v3.
|
6
|
+
<meta name="generator" content="Jekyll v3.8.0">
|
7
7
|
<link type="application/atom+xml" rel="alternate" href="https://jekyllrb.com/feed.xml" title="Jekyll • Simple, blog-aware, static sites" />
|
8
8
|
<link rel="alternate" type="application/atom+xml" title="Recent commits to Jekyll’s master branch" href="https://github.com/jekyll/jekyll/commits/master.atom">
|
9
|
-
<link rel="
|
9
|
+
<link rel="preconnect" href="https://fonts.gstatic.com/" crossorigin>
|
10
|
+
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Lato:300,300italic,400,400italic,700,700italic,900">
|
10
11
|
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css" />
|
11
12
|
<link rel="stylesheet" href="/css/screen.css">
|
12
13
|
<link rel="icon" type="image/x-icon" href="/favicon.ico">
|
13
14
|
<!-- Begin Jekyll SEO tag v2.4.0 -->
|
14
15
|
<title>Installation | Jekyll • Simple, blog-aware, static sites</title>
|
15
|
-
<meta name="generator" content="Jekyll v3.
|
16
|
+
<meta name="generator" content="Jekyll v3.8.0" />
|
16
17
|
<meta property="og:title" content="Installation" />
|
17
18
|
<meta property="og:locale" content="en_US" />
|
18
|
-
<meta name="description" content="
|
19
|
-
<meta property="og:description" content="
|
19
|
+
<meta name="description" content="Official guide to install Jekyll on macOS, GNU/Linux or Windows." />
|
20
|
+
<meta property="og:description" content="Official guide to install Jekyll on macOS, GNU/Linux or Windows." />
|
20
21
|
<link rel="canonical" href="https://jekyllrb.com/docs/installation/" />
|
21
22
|
<meta property="og:url" content="https://jekyllrb.com/docs/installation/" />
|
22
23
|
<meta property="og:site_name" content="Jekyll • Simple, blog-aware, static sites" />
|
23
24
|
<meta property="og:type" content="article" />
|
24
|
-
<meta property="article:published_time" content="2018-
|
25
|
+
<meta property="article:published_time" content="2018-05-01T13:26:35-07:00" />
|
25
26
|
<meta name="twitter:card" content="summary" />
|
26
27
|
<meta name="twitter:site" content="@jekyllrb" />
|
27
28
|
<meta name="google-site-verification" content="onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY" />
|
28
29
|
<script type="application/ld+json">
|
29
|
-
{"publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://jekyllrb.com/img/logo-2x.png"}},"headline":"Installation","dateModified":"2018-
|
30
|
+
{"description":"Official guide to install Jekyll on macOS, GNU/Linux or Windows.","@type":"BlogPosting","url":"https://jekyllrb.com/docs/installation/","publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://jekyllrb.com/img/logo-2x.png"}},"headline":"Installation","dateModified":"2018-05-01T13:26:35-07:00","datePublished":"2018-05-01T13:26:35-07:00","mainEntityOfPage":{"@type":"WebPage","@id":"https://jekyllrb.com/docs/installation/"},"@context":"http://schema.org"}</script>
|
30
31
|
<!-- End Jekyll SEO tag -->
|
31
32
|
|
32
33
|
<!--[if lt IE 9]>
|
@@ -71,7 +72,7 @@
|
|
71
72
|
<div class="meta hide-on-mobiles">
|
72
73
|
<ul>
|
73
74
|
<li>
|
74
|
-
<a href="https://github.com/jekyll/jekyll/releases/tag/v3.
|
75
|
+
<a href="https://github.com/jekyll/jekyll/releases/tag/v3.8.0">v3.8.0</a>
|
75
76
|
</li>
|
76
77
|
<li>
|
77
78
|
<a href="https://github.com/jekyll/jekyll">GitHub</a>
|
@@ -293,121 +294,119 @@
|
|
293
294
|
<a href="https://github.com/jekyll/jekyll/edit/master/docs/_docs/installation.md"><i class="fa fa-pencil"></i> Improve this page</a>
|
294
295
|
</div>
|
295
296
|
<h1>Installation</h1>
|
296
|
-
<
|
297
|
-
|
298
|
-
|
299
|
-
|
297
|
+
<ul>
|
298
|
+
<li><a href="#requirements">Requirements</a></li>
|
299
|
+
<li><a href="#macOS">Install on macOS</a></li>
|
300
|
+
<li><a href="../windows/">Install on Windows</a></li>
|
301
|
+
<li><a href="#upgrade-jekyll">Upgrade Jekyll</a></li>
|
302
|
+
</ul>
|
303
|
+
|
304
|
+
<p>Installing Jekyll should be straight-forward if your system meets the requirements.</p>
|
300
305
|
|
301
|
-
<
|
306
|
+
<h2 id="requirements">Requirements</h2>
|
302
307
|
|
303
|
-
<p>
|
304
|
-
Before you start, make sure your system has the following:</p>
|
308
|
+
<p>Before you start, make sure your system has the following:</p>
|
305
309
|
|
306
310
|
<ul>
|
307
|
-
<li>
|
308
|
-
<li><a href="https://www.ruby-lang.org/en/downloads/">Ruby</a> version 2.2.5 or above, including all development
|
309
|
-
headers (ruby installation can be checked by running <code class="highlighter-rouge">ruby -v</code>, development headers can be checked on Ubuntu by running <code class="highlighter-rouge">apt list --installed ruby-dev</code>)</li>
|
311
|
+
<li><a href="https://www.ruby-lang.org/en/downloads/">Ruby</a> version 2.2.5 or above, including all development headers (ruby installation can be checked by running <code class="highlighter-rouge">ruby -v</code>)</li>
|
310
312
|
<li><a href="https://rubygems.org/pages/download">RubyGems</a> (which you can check by running <code class="highlighter-rouge">gem -v</code>)</li>
|
311
313
|
<li><a href="https://gcc.gnu.org/install/">GCC</a> and <a href="https://www.gnu.org/software/make/">Make</a> (in case your system doesn’t have them installed, which you can check by running <code class="highlighter-rouge">gcc -v</code>,<code class="highlighter-rouge">g++ -v</code> and <code class="highlighter-rouge">make -v</code> in your system’s command line interface)</li>
|
312
314
|
</ul>
|
313
315
|
|
314
|
-
<
|
315
|
-
<h5>Problems installing Jekyll?</h5>
|
316
|
-
<p>
|
317
|
-
Check out the <a href="../troubleshooting/">troubleshooting</a> page or
|
318
|
-
<a href="https://github.com/jekyll/jekyll/issues/new">report an issue</a> so the
|
319
|
-
Jekyll community can improve the experience for everyone.
|
320
|
-
</p>
|
321
|
-
</div>
|
316
|
+
<h2 id="macOS">Install on macOS</h2>
|
322
317
|
|
323
|
-
<
|
324
|
-
|
325
|
-
|
326
|
-
While Windows is not officially supported, it is possible to get Jekyll running
|
327
|
-
on Windows. Special instructions can be found on our
|
328
|
-
<a href="../windows/#installation">Windows-specific docs page</a>.
|
329
|
-
</p>
|
330
|
-
</div>
|
318
|
+
<p>We only cover macOS High Sierra 10.13 here, which comes with Ruby 2.3.3, older systems will need to <a href="#homebrew">install a more recent Ruby version via Homebrew</a>.</p>
|
319
|
+
|
320
|
+
<p>First, you need to install the command-line tools to be able to compile native extensions, open a terminal and run:</p>
|
331
321
|
|
332
|
-
<
|
322
|
+
<div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code>xcode-select <span class="nt">--install</span>
|
323
|
+
</code></pre></div></div>
|
333
324
|
|
334
|
-
<
|
335
|
-
<a href="https://rubygems.org/pages/download">RubyGems</a>. At the terminal prompt,
|
336
|
-
simply run the following command to install Jekyll:</p>
|
325
|
+
<h3 id="set-up-ruby-included-with-the-os">Set up Ruby included with the OS</h3>
|
337
326
|
|
338
|
-
<
|
327
|
+
<p>Check your Ruby version meet our requirements:</p>
|
328
|
+
|
329
|
+
<div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code>ruby <span class="nt">-v</span>
|
330
|
+
2.3.3
|
339
331
|
</code></pre></div></div>
|
340
332
|
|
341
|
-
<p>
|
342
|
-
command, so you won’t have to worry about them at all.</p>
|
333
|
+
<p>Great, let’s install Jekyll. We also need <a href="https://bundler.io/">Bundler</a> to help us handle <a href="../plugins">plugins</a> and <a href="../themes">themes</a>:</p>
|
343
334
|
|
344
|
-
<div class="
|
345
|
-
|
346
|
-
<p>
|
347
|
-
If you run into issues installing Jekyll's dependencies which make use of
|
348
|
-
native extensions and are using macOS, you will need to install Xcode
|
349
|
-
and the Command-Line Tools it ships with. Download them in
|
350
|
-
<code>Preferences → Downloads → Components</code>.
|
351
|
-
</p>
|
352
|
-
</div>
|
335
|
+
<div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code>gem <span class="nb">install </span>bundler jekyll
|
336
|
+
</code></pre></div></div>
|
353
337
|
|
354
|
-
<
|
338
|
+
<p>That’s it, you’re ready to go, either by installing our <a href="https://github.com/jekyll/minima">default minimal blog theme</a> with <code class="highlighter-rouge">jekyll new jekyll-website</code> or by starting from scratch:</p>
|
355
339
|
|
356
|
-
<
|
357
|
-
|
340
|
+
<div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nb">mkdir </span>jekyll-website
|
341
|
+
<span class="nb">cd </span>jekyll-website
|
358
342
|
|
359
|
-
<
|
343
|
+
<span class="c"># Create a Gemfile</span>
|
344
|
+
bundle init
|
345
|
+
|
346
|
+
<span class="c"># Add Jekyll</span>
|
347
|
+
bundle add jekyll
|
348
|
+
|
349
|
+
<span class="c"># Install gems</span>
|
350
|
+
bundle <span class="nb">install</span>
|
360
351
|
</code></pre></div></div>
|
361
352
|
|
362
|
-
<p>
|
363
|
-
use the <code class="highlighter-rouge">-v</code> switch to indicate the version you’d like to install:</p>
|
353
|
+
<p>Great, from there you can now either use a <a href="../themes/">theme</a> or <a href="../templates/">create your own layouts</a>.</p>
|
364
354
|
|
365
|
-
<
|
355
|
+
<h3 id="homebrew">Install a newer Ruby version via Homebrew</h3>
|
356
|
+
|
357
|
+
<p>If you wish to install the latest version of Ruby and get faster builds, we recommend to do it via <a href="https://brew.sh">Homebrew</a> a handy package manager for macOS.</p>
|
358
|
+
|
359
|
+
<div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code>/usr/bin/ruby <span class="nt">-e</span> <span class="s2">"</span><span class="k">$(</span>curl <span class="nt">-fsSL</span> https://raw.githubusercontent.com/Homebrew/install/master/install<span class="k">)</span><span class="s2">"</span>
|
360
|
+
brew <span class="nb">install </span>ruby
|
361
|
+
ruby <span class="nt">-v</span>
|
362
|
+
ruby 2.5.1p57 <span class="o">(</span>2018-03-29 revision 63029<span class="o">)</span> <span class="o">[</span>x86_64-darwin17]
|
366
363
|
</code></pre></div></div>
|
367
364
|
|
368
|
-
<p>
|
369
|
-
more involved. This gives you the advantage of having the latest and greatest,
|
370
|
-
but may be unstable.</p>
|
365
|
+
<p>Yay! Now you have a shiny Ruby on your system!</p>
|
371
366
|
|
372
|
-
<
|
373
|
-
|
374
|
-
|
375
|
-
|
376
|
-
<
|
367
|
+
<h3 id="rbenv">Install multiple Ruby versions with rbenv</h3>
|
368
|
+
|
369
|
+
<p>Developers often use <a href="https://github.com/rbenv/rbenv">rbenv</a> to manage multiple Ruby versions. This can be useful if you want to run the same Ruby version used by <a href="https://pages.github.com/versions/">GitHub Pages</a> or <a href="https://www.netlify.com/docs/#ruby">Netlify</a> for instance.</p>
|
370
|
+
|
371
|
+
<div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="c"># Install rbenv and ruby-build</span>
|
372
|
+
brew <span class="nb">install </span>rbenv
|
373
|
+
|
374
|
+
<span class="c"># Setup rbenv integration to your shell</span>
|
375
|
+
rbenv init
|
376
|
+
|
377
|
+
<span class="c"># Check your install</span>
|
378
|
+
curl <span class="nt">-fsSL</span> https://github.com/rbenv/rbenv-installer/raw/master/bin/rbenv-doctor | bash
|
377
379
|
</code></pre></div></div>
|
378
380
|
|
379
|
-
<
|
380
|
-
|
381
|
-
|
382
|
-
|
383
|
-
|
384
|
-
|
385
|
-
|
386
|
-
|
387
|
-
|
388
|
-
|
389
|
-
|
390
|
-
|
391
|
-
|
392
|
-
|
393
|
-
|
394
|
-
|
381
|
+
<p>Restart your terminal for changes to take effect.
|
382
|
+
Now we can install the Ruby version of our choice, let’s go with Ruby 2.5.1 here:</p>
|
383
|
+
|
384
|
+
<div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code>rbenv <span class="nb">install </span>2.5.1
|
385
|
+
rbenv global 2.5.1
|
386
|
+
ruby <span class="nt">-v</span>
|
387
|
+
ruby 2.5.1p57 <span class="o">(</span>2018-03-29 revision 63029<span class="o">)</span> <span class="o">[</span>x86_64-darwin17]
|
388
|
+
</code></pre></div></div>
|
389
|
+
|
390
|
+
<p>That’s it! Head over <a href="https://github.com/rbenv/rbenv#command-reference">rbenv command references</a> to learn how to use different versions of Ruby in your projects.</p>
|
391
|
+
|
392
|
+
<div class="note info">
|
393
|
+
|
394
|
+
<h5 id="problems-installing-jekyll">Problems installing Jekyll?</h5>
|
395
|
+
|
396
|
+
<p>Check out the <a href="../troubleshooting/">troubleshooting</a> page or
|
397
|
+
<a href="https://talk.jekyllrb.com">ask for help on our forum</a>.</p>
|
398
|
+
|
395
399
|
</div>
|
396
400
|
|
397
|
-
<h2 id="
|
401
|
+
<h2 id="upgrade-jekyll">Upgrade Jekyll</h2>
|
398
402
|
|
399
|
-
<p>Before you start developing with Jekyll, you may want to check that you’re up to date with the latest version. To find
|
403
|
+
<p>Before you start developing with Jekyll, you may want to check that you’re up to date with the latest version. To find the currently installed version of Jekyll, run one of these commands:</p>
|
400
404
|
|
401
405
|
<div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code>jekyll <span class="nt">--version</span>
|
402
406
|
gem list jekyll
|
403
407
|
</code></pre></div></div>
|
404
408
|
|
405
|
-
<p>You can
|
406
|
-
|
407
|
-
<div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code>gem search jekyll <span class="nt">--remote</span>
|
408
|
-
</code></pre></div></div>
|
409
|
-
|
410
|
-
<p>and you’ll search for just the name <code class="highlighter-rouge">jekyll</code>, and in brackets will be latest version. Another way to check if you have the latest version is to run the command <code class="highlighter-rouge">gem outdated</code>. This will provide a list of all the gems on your system that need to be updated. If you aren’t running the latest version, run this command:</p>
|
409
|
+
<p>You can use RubyGems to find <a href="https://rubygems.org/gems/jekyll">the current version of Jekyll</a>. Another way to check if you have the latest version is to run the command <code class="highlighter-rouge">gem outdated</code>. This will provide a list of all the gems on your system that need to be updated. If you aren’t running the latest version, run this command:</p>
|
411
410
|
|
412
411
|
<div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code>bundle update jekyll
|
413
412
|
</code></pre></div></div>
|
@@ -417,8 +416,37 @@ gem list jekyll
|
|
417
416
|
<div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code>gem update jekyll
|
418
417
|
</code></pre></div></div>
|
419
418
|
|
420
|
-
<p>
|
421
|
-
|
419
|
+
<p>To upgrade to latest Rubygems, run:</p>
|
420
|
+
|
421
|
+
<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>gem update --system
|
422
|
+
</code></pre></div></div>
|
423
|
+
|
424
|
+
<p>Refer to our <a href="../upgrading/">upgrading section</a> to upgrade from Jekyll 2.x or 1.x.</p>
|
425
|
+
|
426
|
+
<h2 id="pre-releases">Pre-releases</h2>
|
427
|
+
|
428
|
+
<p>In order to install a pre-release, make sure you have all the requirements
|
429
|
+
installed properly and run:</p>
|
430
|
+
|
431
|
+
<div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code>gem <span class="nb">install </span>jekyll <span class="nt">--pre</span>
|
432
|
+
</code></pre></div></div>
|
433
|
+
|
434
|
+
<p>This will install the latest pre-release. If you want a particular pre-release,
|
435
|
+
use the <code class="highlighter-rouge">-v</code> switch to indicate the version you’d like to install:</p>
|
436
|
+
|
437
|
+
<div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code>gem <span class="nb">install </span>jekyll <span class="nt">-v</span> <span class="s1">'2.0.0.alpha.1'</span>
|
438
|
+
</code></pre></div></div>
|
439
|
+
|
440
|
+
<p>If you’d like to install a development version of Jekyll, the process is a bit
|
441
|
+
more involved. This gives you the advantage of having the latest and greatest,
|
442
|
+
but may be unstable.</p>
|
443
|
+
|
444
|
+
<div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code>git clone git://github.com/jekyll/jekyll.git
|
445
|
+
<span class="nb">cd </span>jekyll
|
446
|
+
script/bootstrap
|
447
|
+
bundle <span class="nb">exec </span>rake build
|
448
|
+
<span class="nb">ls </span>pkg/<span class="k">*</span>.gem | <span class="nb">head</span> <span class="nt">-n</span> 1 | xargs gem <span class="nb">install</span> <span class="nt">-l</span>
|
449
|
+
</code></pre></div></div>
|
422
450
|
|
423
451
|
<p>Now that you’ve got everything up-to-date and installed, let’s get to work!</p>
|
424
452
|
|
@@ -701,28 +729,11 @@ detailed instructions.</p>
|
|
701
729
|
</script>
|
702
730
|
|
703
731
|
|
704
|
-
<!-- Gauges (http://get.gaug.es/) -->
|
705
|
-
<script>
|
706
|
-
var _gauges = _gauges || [];
|
707
|
-
(function() {
|
708
|
-
var t = document.createElement('script');
|
709
|
-
t.type = 'text/javascript';
|
710
|
-
t.async = true;
|
711
|
-
t.id = 'gauges-tracker';
|
712
|
-
t.setAttribute('data-site-id', '503c5af6613f5d0f19000027');
|
713
|
-
t.src = '//secure.gaug.es/track.js';
|
714
|
-
var s = document.getElementsByTagName('script')[0];
|
715
|
-
s.parentNode.insertBefore(t, s);
|
716
|
-
})();
|
717
|
-
</script>
|
718
|
-
|
719
|
-
|
720
|
-
|
721
732
|
<!-- Google Analytics (https://www.google.com/analytics) -->
|
722
733
|
<script>
|
723
734
|
!function(j,e,k,y,l,L){j.GoogleAnalyticsObject=y,j[y]||(j[y]=function(){
|
724
735
|
(j[y].q=j[y].q||[]).push(arguments)}),j[y].l=+new Date,l=e.createElement(k),
|
725
|
-
L=e.getElementsByTagName(k)[0],l.src='
|
736
|
+
L=e.getElementsByTagName(k)[0],l.src='https://www.google-analytics.com/analytics.js',
|
726
737
|
L.parentNode.insertBefore(l,L)}(window,document,'script','ga');
|
727
738
|
|
728
739
|
ga('create', 'UA-50755011-1', 'jekyllrb.com');
|