jekyll-docs 3.8.1 → 3.9.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/site/404.html +5 -4
- data/site/community/index.html +1 -1
- data/site/conduct/index.html +1 -1
- data/site/docs/assets/index.html +35 -35
- data/site/docs/code_of_conduct/index.html +8 -7
- data/site/docs/collections/index.html +44 -43
- data/site/docs/conduct/index.html +8 -7
- data/site/docs/configuration/index.html +81 -81
- data/site/docs/continuous-integration/buddyworks/index.html +10 -9
- data/site/docs/continuous-integration/circleci/index.html +13 -12
- data/site/docs/continuous-integration/index.html +8 -7
- data/site/docs/continuous-integration/travis-ci/index.html +32 -31
- data/site/docs/contributing/index.html +47 -47
- data/site/docs/datafiles/index.html +24 -23
- data/site/docs/deployment-methods/index.html +30 -29
- data/site/docs/drafts/index.html +11 -10
- data/site/docs/extras/index.html +9 -8
- data/site/docs/frontmatter/index.html +8 -7
- data/site/docs/github-pages/index.html +32 -32
- data/site/docs/history/index.html +722 -656
- data/site/docs/home/index.html +8 -7
- data/site/docs/includes/index.html +44 -43
- data/site/docs/index.html +1 -1
- data/site/docs/installation/index.html +16 -15
- data/site/docs/maintaining/affinity-team-captain/index.html +24 -24
- data/site/docs/maintaining/avoiding-burnout/index.html +8 -7
- data/site/docs/maintaining/becoming-a-maintainer/index.html +22 -22
- data/site/docs/maintaining/index.html +8 -7
- data/site/docs/maintaining/merging-a-pull-request/index.html +36 -36
- data/site/docs/maintaining/releasing-a-new-version/index.html +32 -32
- data/site/docs/maintaining/reviewing-a-pull-request/index.html +23 -23
- data/site/docs/maintaining/special-labels/index.html +27 -27
- data/site/docs/maintaining/triaging-an-issue/index.html +25 -25
- data/site/docs/migrations/index.html +9 -8
- data/site/docs/pages/index.html +12 -11
- data/site/docs/pagination/index.html +25 -24
- data/site/docs/permalinks/index.html +33 -32
- data/site/docs/plugins/index.html +70 -70
- data/site/docs/posts/index.html +50 -50
- data/site/docs/quickstart/index.html +18 -17
- data/site/docs/resources/index.html +9 -8
- data/site/docs/sites/index.html +8 -7
- data/site/docs/static-files/index.html +14 -13
- data/site/docs/structure/index.html +8 -7
- data/site/docs/support/index.html +9 -8
- data/site/docs/templates/index.html +44 -43
- data/site/docs/themes/index.html +76 -76
- data/site/docs/troubleshooting/index.html +48 -47
- data/site/docs/upgrading/0-to-2/index.html +51 -50
- data/site/docs/upgrading/2-to-3/index.html +35 -34
- data/site/docs/upgrading/index.html +11 -10
- data/site/docs/usage/index.html +15 -14
- data/site/docs/variables/index.html +8 -7
- data/site/docs/windows/index.html +29 -28
- data/site/feed.xml +53 -65
- data/site/github.html +1 -1
- data/site/help/index.html +19 -19
- data/site/index.html +7 -6
- data/site/issues.html +1 -1
- data/site/jekyllconf/index.html +9 -8
- data/site/latest_version.txt +1 -1
- data/site/news/2013/05/05/jekyll-1-0-0-released/index.html +42 -29
- data/site/news/2013/05/08/jekyll-1-0-1-released/index.html +27 -13
- data/site/news/2013/05/12/jekyll-1-0-2-released/index.html +28 -14
- data/site/news/2013/06/07/jekyll-1-0-3-released/index.html +29 -15
- data/site/news/2013/07/14/jekyll-1-1-0-released/index.html +28 -14
- data/site/news/2013/07/24/jekyll-1-1-1-released/index.html +25 -11
- data/site/news/2013/07/25/jekyll-1-0-4-released/index.html +27 -13
- data/site/news/2013/07/25/jekyll-1-1-2-released/index.html +27 -13
- data/site/news/2013/09/06/jekyll-1-2-0-released/index.html +30 -16
- data/site/news/2013/09/14/jekyll-1-2-1-released/index.html +28 -14
- data/site/news/2013/10/28/jekyll-1-3-0-rc1-released/index.html +25 -11
- data/site/news/2013/11/04/jekyll-1-3-0-released/index.html +34 -20
- data/site/news/2013/11/26/jekyll-1-3-1-released/index.html +26 -12
- data/site/news/2013/12/07/jekyll-1-4-0-released/index.html +26 -12
- data/site/news/2013/12/09/jekyll-1-4-1-released/index.html +25 -11
- data/site/news/2013/12/16/jekyll-1-4-2-released/index.html +27 -13
- data/site/news/2014/01/13/jekyll-1-4-3-released/index.html +43 -30
- data/site/news/2014/03/24/jekyll-1-5-0-released/index.html +26 -12
- data/site/news/2014/03/27/jekyll-1-5-1-released/index.html +43 -30
- data/site/news/2014/05/06/jekyll-turns-2-0-0/index.html +46 -33
- data/site/news/2014/05/08/jekyll-2-0-3-released/index.html +25 -11
- data/site/news/2014/06/04/jekyll-stickers-1-dollar-stickermule/index.html +42 -29
- data/site/news/2014/06/28/jekyll-turns-21-i-mean-2-1-0/index.html +30 -16
- data/site/news/2014/07/01/jekyll-2-1-1-released/index.html +27 -13
- data/site/news/2014/07/29/jekyll-2-2-0-released/index.html +26 -12
- 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 +32 -18
- data/site/news/2014/11/05/jekylls-midlife-crisis-jekyll-turns-2-5-0/index.html +48 -35
- data/site/news/2014/11/09/jekyll-2-5-1-released/index.html +25 -11
- data/site/news/2014/11/12/jekyll-2-5-2-released/index.html +27 -13
- data/site/news/2014/12/17/alfredxing-welcome-to-jekyll-core/index.html +42 -29
- data/site/news/2014/12/22/jekyll-2-5-3-released/index.html +25 -11
- data/site/news/2015/01/20/jekyll-meet-and-greet/index.html +42 -29
- data/site/news/2015/01/24/jekyll-3-0-0-beta1-released/index.html +25 -11
- data/site/news/2015/02/26/introducing-jekyll-talk/index.html +42 -29
- data/site/news/2015/10/26/jekyll-3-0-released/index.html +30 -16
- data/site/news/2015/11/17/jekyll-3-0-1-released/index.html +29 -15
- data/site/news/2016/01/20/jekyll-3-0-2-released/index.html +27 -13
- data/site/news/2016/01/24/jekyll-3-1-0-released/index.html +30 -16
- data/site/news/2016/01/28/jekyll-3-1-1-released/index.html +47 -34
- data/site/news/2016/02/08/jekyll-3-0-3-released/index.html +26 -12
- data/site/news/2016/02/19/jekyll-3-1-2-released/index.html +27 -13
- data/site/news/2016/03/10/making-it-easier-to-contribute-to-jekyll/index.html +25 -11
- data/site/news/2016/04/19/jekyll-3-0-4-released/index.html +26 -12
- data/site/news/2016/04/19/jekyll-3-1-3-released/index.html +26 -12
- data/site/news/2016/04/26/jekyll-3-0-5-released/index.html +25 -11
- data/site/news/2016/05/18/jekyll-3-1-4-released/index.html +31 -17
- data/site/news/2016/05/18/jekyll-3-1-5-released/index.html +26 -12
- data/site/news/2016/05/19/jekyll-3-1-6-released/index.html +26 -12
- data/site/news/2016/06/03/update-on-jekyll-s-google-summer-of-code-projects/index.html +42 -29
- data/site/news/2016/07/26/jekyll-3-2-0-released/index.html +29 -15
- data/site/news/2016/08/02/jekyll-3-2-1-released/index.html +43 -30
- data/site/news/2016/08/24/jekyll-admin-initial-release/index.html +42 -29
- data/site/news/2016/10/06/jekyll-3-3-is-here/index.html +51 -37
- data/site/news/2016/11/14/jekyll-3-3-1-released/index.html +26 -12
- data/site/news/2017/01/18/jekyll-3-4-0-released/index.html +27 -13
- data/site/news/2017/03/02/jekyll-3-4-1-released/index.html +43 -30
- data/site/news/2017/03/09/jekyll-3-4-2-released/index.html +47 -34
- data/site/news/2017/03/21/jekyll-3-4-3-released/index.html +52 -39
- data/site/news/2017/06/15/jekyll-3-5-0-released/index.html +51 -38
- data/site/news/2017/07/17/jekyll-3-5-1-released/index.html +27 -13
- data/site/news/2017/08/12/jekyll-3-5-2-released/index.html +30 -16
- data/site/news/2017/09/21/jekyll-3-6-0-released/index.html +26 -12
- data/site/news/2017/10/19/diversity-open-source/index.html +27 -13
- data/site/news/2017/10/21/jekyll-3-6-2-released/index.html +45 -32
- data/site/news/2018/01/02/jekyll-3-7-0-released/index.html +48 -35
- data/site/news/2018/01/25/jekyll-3-7-2-released/index.html +53 -40
- data/site/news/2018/02/19/meet-jekyll-s-new-lead-developer/index.html +42 -29
- data/site/news/2018/02/24/jekyll-3-7-3-released/index.html +50 -37
- data/site/news/2018/05/01/jekyll-3-8-1-released/index.html +47 -34
- data/site/news/2018/05/19/jekyll-3-8-2-released/index.html +620 -0
- data/site/news/2018/06/05/jekyll-3-8-3-released/index.html +615 -0
- data/site/news/2019/07/02/jekyll-3-8-6-released/index.html +623 -0
- data/site/news/index.html +351 -230
- data/site/news/releases/index.html +349 -228
- data/site/philosophy.html +1 -1
- data/site/sitemap.xml +72 -60
- data/site/team/index.html +19 -19
- data/site/tutorials/convert-site-to-jekyll/index.html +97 -96
- data/site/tutorials/custom-404-page/index.html +16 -15
- data/site/tutorials/home/index.html +10 -9
- data/site/tutorials/index.html +1 -1
- data/site/tutorials/navigation/index.html +102 -101
- data/site/tutorials/orderofinterpretation/index.html +32 -31
- data/site/tutorials/using-jekyll-with-bundler/index.html +19 -18
- data/site/tutorials/video-walkthroughs/index.html +8 -7
- metadata +13 -25
|
@@ -3,7 +3,7 @@
|
|
|
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.9.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
9
|
<link rel="preconnect" href="https://fonts.gstatic.com/" crossorigin>
|
|
@@ -11,9 +11,9 @@
|
|
|
11
11
|
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css" />
|
|
12
12
|
<link rel="stylesheet" href="/css/screen.css">
|
|
13
13
|
<link rel="icon" type="image/x-icon" href="/favicon.ico">
|
|
14
|
-
<!-- Begin Jekyll SEO tag v2.
|
|
14
|
+
<!-- Begin Jekyll SEO tag v2.6.1 -->
|
|
15
15
|
<title>Upgrading from 2.x to 3.x | Jekyll • Simple, blog-aware, static sites</title>
|
|
16
|
-
<meta name="generator" content="Jekyll v3.
|
|
16
|
+
<meta name="generator" content="Jekyll v3.9.0" />
|
|
17
17
|
<meta property="og:title" content="Upgrading from 2.x to 3.x" />
|
|
18
18
|
<meta property="og:locale" content="en_US" />
|
|
19
19
|
<meta name="description" content="Upgrading from an older version of Jekyll? A few things have changed in Jekyll 3 that you’ll want to know about." />
|
|
@@ -22,12 +22,13 @@
|
|
|
22
22
|
<meta property="og:url" content="https://jekyllrb.com/docs/upgrading/2-to-3/" />
|
|
23
23
|
<meta property="og:site_name" content="Jekyll • Simple, blog-aware, static sites" />
|
|
24
24
|
<meta property="og:type" content="article" />
|
|
25
|
-
<meta property="article:published_time" content="
|
|
25
|
+
<meta property="article:published_time" content="2020-08-05T11:55:36-07:00" />
|
|
26
26
|
<meta name="twitter:card" content="summary" />
|
|
27
|
+
<meta property="twitter:title" content="Upgrading from 2.x to 3.x" />
|
|
27
28
|
<meta name="twitter:site" content="@jekyllrb" />
|
|
28
29
|
<meta name="google-site-verification" content="onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY" />
|
|
29
30
|
<script type="application/ld+json">
|
|
30
|
-
{"
|
|
31
|
+
{"url":"https://jekyllrb.com/docs/upgrading/2-to-3/","headline":"Upgrading from 2.x to 3.x","dateModified":"2020-08-05T11:55:36-07:00","datePublished":"2020-08-05T11:55:36-07:00","publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://jekyllrb.com/img/logo-2x.png"}},"description":"Upgrading from an older version of Jekyll? A few things have changed in Jekyll 3 that you’ll want to know about.","mainEntityOfPage":{"@type":"WebPage","@id":"https://jekyllrb.com/docs/upgrading/2-to-3/"},"@type":"BlogPosting","@context":"https://schema.org"}</script>
|
|
31
32
|
<!-- End Jekyll SEO tag -->
|
|
32
33
|
|
|
33
34
|
<!--[if lt IE 9]>
|
|
@@ -72,7 +73,7 @@
|
|
|
72
73
|
<div class="meta hide-on-mobiles">
|
|
73
74
|
<ul>
|
|
74
75
|
<li>
|
|
75
|
-
<a href="https://github.com/jekyll/jekyll/releases/tag/v3.
|
|
76
|
+
<a href="https://github.com/jekyll/jekyll/releases/tag/v3.9.0">v3.9.0</a>
|
|
76
77
|
</li>
|
|
77
78
|
<li>
|
|
78
79
|
<a href="https://github.com/jekyll/jekyll">GitHub</a>
|
|
@@ -313,26 +314,26 @@ that you’ll want to know about.</p>
|
|
|
313
314
|
|
|
314
315
|
<h3 id="sitecollections-has-changed">site.collections has changed</h3>
|
|
315
316
|
|
|
316
|
-
<p>In 2.x, your iterations over <code class="highlighter-rouge">site.collections</code> yielded an array with the collection
|
|
317
|
+
<p>In 2.x, your iterations over <code class="language-plaintext highlighter-rouge">site.collections</code> yielded an array with the collection
|
|
317
318
|
label and the collection object as the first and second items, respectively. In 3.x,
|
|
318
319
|
this complication has been removed and iterations now yield simply the collection object.
|
|
319
320
|
A simple conversion must be made in your templates:</p>
|
|
320
321
|
|
|
321
322
|
<ul>
|
|
322
|
-
<li><code class="highlighter-rouge">collection[0]</code> becomes <code class="highlighter-rouge">collection.label</code></li>
|
|
323
|
-
<li><code class="highlighter-rouge">collection[1]</code> becomes <code class="highlighter-rouge">collection</code></li>
|
|
323
|
+
<li><code class="language-plaintext highlighter-rouge">collection[0]</code> becomes <code class="language-plaintext highlighter-rouge">collection.label</code></li>
|
|
324
|
+
<li><code class="language-plaintext highlighter-rouge">collection[1]</code> becomes <code class="language-plaintext highlighter-rouge">collection</code></li>
|
|
324
325
|
</ul>
|
|
325
326
|
|
|
326
|
-
<p>When iterating over <code class="highlighter-rouge">site.collections</code>, ensure the above conversions are made.</p>
|
|
327
|
+
<p>When iterating over <code class="language-plaintext highlighter-rouge">site.collections</code>, ensure the above conversions are made.</p>
|
|
327
328
|
|
|
328
|
-
<p>For <code class="highlighter-rouge">site.collections.myCollection</code> in Jekyll 2, you now do:</p>
|
|
329
|
+
<p>For <code class="language-plaintext highlighter-rouge">site.collections.myCollection</code> in Jekyll 2, you now do:</p>
|
|
329
330
|
|
|
330
331
|
<div class="language-liquid highlighter-rouge"><div class="highlight"><pre class="highlight"><code>
|
|
331
332
|
<span class="p">{%</span><span class="w"> </span><span class="nt">assign</span><span class="w"> </span><span class="nv">myCollection</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nv">site</span><span class="p">.</span><span class="nv">collections</span><span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="nf">where</span><span class="p">:</span><span class="w"> </span><span class="s2">"label"</span><span class="p">,</span><span class="w"> </span><span class="s2">"myCollection"</span><span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="nf">first</span><span class="w"> </span><span class="p">%}</span>
|
|
332
333
|
|
|
333
334
|
</code></pre></div></div>
|
|
334
335
|
|
|
335
|
-
<p>This is a bit cumbersome at first, but is easier than a big <code class="highlighter-rouge">for</code> loop.</p>
|
|
336
|
+
<p>This is a bit cumbersome at first, but is easier than a big <code class="language-plaintext highlighter-rouge">for</code> loop.</p>
|
|
336
337
|
|
|
337
338
|
<h3 id="dropped-dependencies">Dropped dependencies</h3>
|
|
338
339
|
|
|
@@ -341,21 +342,21 @@ A simple conversion must be made in your templates:</p>
|
|
|
341
342
|
<ul>
|
|
342
343
|
<li>jekyll-paginate – Jekyll’s pagination solution from days past</li>
|
|
343
344
|
<li>jekyll-coffeescript – processing of CoffeeScript</li>
|
|
344
|
-
<li>jekyll-gist – the <code class="highlighter-rouge">gist</code> Liquid tag</li>
|
|
345
|
+
<li>jekyll-gist – the <code class="language-plaintext highlighter-rouge">gist</code> Liquid tag</li>
|
|
345
346
|
<li>pygments.rb – the Pygments highlighter</li>
|
|
346
347
|
<li>redcarpet – the Markdown processor</li>
|
|
347
348
|
<li>toml – an alternative to YAML for configuration files</li>
|
|
348
|
-
<li>classifier-reborn – for <code class="highlighter-rouge">site.related_posts</code></li>
|
|
349
|
+
<li>classifier-reborn – for <code class="language-plaintext highlighter-rouge">site.related_posts</code></li>
|
|
349
350
|
</ul>
|
|
350
351
|
|
|
351
352
|
<h3 id="future-posts">Future posts</h3>
|
|
352
353
|
|
|
353
|
-
<p>A seeming feature regression in 2.x, the <code class="highlighter-rouge">--future</code> flag was automatically <em>enabled</em>.
|
|
354
|
+
<p>A seeming feature regression in 2.x, the <code class="language-plaintext highlighter-rouge">--future</code> flag was automatically <em>enabled</em>.
|
|
354
355
|
The future flag allows post authors to give the post a date in the future and to have
|
|
355
356
|
it excluded from the build until the system time is equal or after the post time.
|
|
356
|
-
In Jekyll 3, this has been corrected. <strong>Now, <code class="highlighter-rouge">--future</code> is disabled by default.</strong>
|
|
357
|
-
This means you will need to include <code class="highlighter-rouge">--future</code> if you want your future-dated posts to
|
|
358
|
-
generate when running <code class="highlighter-rouge">jekyll build</code> or <code class="highlighter-rouge">jekyll serve</code>.</p>
|
|
357
|
+
In Jekyll 3, this has been corrected. <strong>Now, <code class="language-plaintext highlighter-rouge">--future</code> is disabled by default.</strong>
|
|
358
|
+
This means you will need to include <code class="language-plaintext highlighter-rouge">--future</code> if you want your future-dated posts to
|
|
359
|
+
generate when running <code class="language-plaintext highlighter-rouge">jekyll build</code> or <code class="language-plaintext highlighter-rouge">jekyll serve</code>.</p>
|
|
359
360
|
|
|
360
361
|
<div class="note info">
|
|
361
362
|
<h5>Future Posts on GitHub Pages</h5>
|
|
@@ -367,21 +368,21 @@ generate when running <code class="highlighter-rouge">jekyll build</code> or <co
|
|
|
367
368
|
|
|
368
369
|
<h3 id="layout-metadata">Layout metadata</h3>
|
|
369
370
|
|
|
370
|
-
<p>Introducing: <code class="highlighter-rouge">layout</code>. In Jekyll 2 and below, any metadata in the layout was merged onto
|
|
371
|
-
the <code class="highlighter-rouge">page</code> variable in Liquid. This caused a lot of confusion in the way the data was
|
|
372
|
-
merged and some unexpected behaviour. In Jekyll 3, all layout data is accessible via <code class="highlighter-rouge">layout</code>
|
|
373
|
-
in Liquid. For example, if your layout has <code class="highlighter-rouge">class: my-layout</code> in its YAML front matter,
|
|
374
|
-
then the layout can access that via <code class="highlighter-rouge">{{ layout.class }}</code>.</p>
|
|
371
|
+
<p>Introducing: <code class="language-plaintext highlighter-rouge">layout</code>. In Jekyll 2 and below, any metadata in the layout was merged onto
|
|
372
|
+
the <code class="language-plaintext highlighter-rouge">page</code> variable in Liquid. This caused a lot of confusion in the way the data was
|
|
373
|
+
merged and some unexpected behaviour. In Jekyll 3, all layout data is accessible via <code class="language-plaintext highlighter-rouge">layout</code>
|
|
374
|
+
in Liquid. For example, if your layout has <code class="language-plaintext highlighter-rouge">class: my-layout</code> in its YAML front matter,
|
|
375
|
+
then the layout can access that via <code class="language-plaintext highlighter-rouge">{{ layout.class }}</code>.</p>
|
|
375
376
|
|
|
376
377
|
<h3 id="syntax-highlighter-changed">Syntax highlighter changed</h3>
|
|
377
378
|
|
|
378
379
|
<p>For the first time, the default syntax highlighter has changed for the
|
|
379
|
-
<code class="highlighter-rouge">highlight</code> tag and for backtick code blocks. Instead of <a href="https://github.com/tmm1/pygments.rb">Pygments.rb</a>,
|
|
380
|
-
it’s now <a href="http://rouge.jneen.net/">Rouge</a>. If you were using the <code class="highlighter-rouge">highlight</code> tag with certain
|
|
381
|
-
options, such as <code class="highlighter-rouge">hl_lines</code>, they may not be available when using Rouge. To
|
|
382
|
-
go back to using Pygments, set <code class="highlighter-rouge">highlighter: pygments</code> in your
|
|
383
|
-
<code class="highlighter-rouge">_config.yml</code> file and run <code class="highlighter-rouge">gem install pygments.rb</code> or add
|
|
384
|
-
<code class="highlighter-rouge">gem 'pygments.rb'</code> to your project’s <code class="highlighter-rouge">Gemfile</code>.</p>
|
|
380
|
+
<code class="language-plaintext highlighter-rouge">highlight</code> tag and for backtick code blocks. Instead of <a href="https://github.com/tmm1/pygments.rb">Pygments.rb</a>,
|
|
381
|
+
it’s now <a href="http://rouge.jneen.net/">Rouge</a>. If you were using the <code class="language-plaintext highlighter-rouge">highlight</code> tag with certain
|
|
382
|
+
options, such as <code class="language-plaintext highlighter-rouge">hl_lines</code>, they may not be available when using Rouge. To
|
|
383
|
+
go back to using Pygments, set <code class="language-plaintext highlighter-rouge">highlighter: pygments</code> in your
|
|
384
|
+
<code class="language-plaintext highlighter-rouge">_config.yml</code> file and run <code class="language-plaintext highlighter-rouge">gem install pygments.rb</code> or add
|
|
385
|
+
<code class="language-plaintext highlighter-rouge">gem 'pygments.rb'</code> to your project’s <code class="language-plaintext highlighter-rouge">Gemfile</code>.</p>
|
|
385
386
|
|
|
386
387
|
<h3 id="relative-permalink-support-removed">Relative Permalink support removed</h3>
|
|
387
388
|
|
|
@@ -394,18 +395,18 @@ source directory, not the parent directory. Check
|
|
|
394
395
|
https://jekyllrb.com/docs/upgrading/ for more info.
|
|
395
396
|
</code></pre></div></div>
|
|
396
397
|
|
|
397
|
-
<p>This can be fixed by removing the following line from your <code class="highlighter-rouge">_config.yml</code> file:</p>
|
|
398
|
+
<p>This can be fixed by removing the following line from your <code class="language-plaintext highlighter-rouge">_config.yml</code> file:</p>
|
|
398
399
|
|
|
399
400
|
<div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">relative_permalinks</span><span class="pi">:</span> <span class="no">true</span>
|
|
400
401
|
</code></pre></div></div>
|
|
401
402
|
|
|
402
403
|
<h3 id="permalinks-no-longer-automatically-add-a-trailing-slash">Permalinks no longer automatically add a trailing slash</h3>
|
|
403
404
|
|
|
404
|
-
<p>In Jekyll 2, any URL constructed from the <code class="highlighter-rouge">permalink:</code> field had a trailing slash (<code class="highlighter-rouge">/</code>) added to it automatically. Jekyll 3 no longer adds a trailing slash automatically to <code class="highlighter-rouge">permalink:</code> URLs. This can potentially result in old links to pages returning a 404 error. For example, suppose a page previously contained the YAML <code class="highlighter-rouge">permalink: /:year-:month-:day-:title</code> that resulted in the URL <code class="highlighter-rouge">example.com/2016-02-01-test/</code> (notice the trailing slash), Jekyll internally generates a folder named <code class="highlighter-rouge">2016-02-01-test</code>. In Jekyll 3, the same <code class="highlighter-rouge">permalink:</code> generate the file <code class="highlighter-rouge">2016-02-01-test.html</code> and the URL for the same page will be <code class="highlighter-rouge">example.com/2016-02-01-test</code>, and consequently any links to the old URL will result in a 404 error. In order to maintain the same URLs and avoid this problem, a trailing slash should be added to the <code class="highlighter-rouge">permalink:</code> field, for example <code class="highlighter-rouge">permalink: /:year-:month-:day-:title/</code>.</p>
|
|
405
|
+
<p>In Jekyll 2, any URL constructed from the <code class="language-plaintext highlighter-rouge">permalink:</code> field had a trailing slash (<code class="language-plaintext highlighter-rouge">/</code>) added to it automatically. Jekyll 3 no longer adds a trailing slash automatically to <code class="language-plaintext highlighter-rouge">permalink:</code> URLs. This can potentially result in old links to pages returning a 404 error. For example, suppose a page previously contained the YAML <code class="language-plaintext highlighter-rouge">permalink: /:year-:month-:day-:title</code> that resulted in the URL <code class="language-plaintext highlighter-rouge">example.com/2016-02-01-test/</code> (notice the trailing slash), Jekyll internally generates a folder named <code class="language-plaintext highlighter-rouge">2016-02-01-test</code>. In Jekyll 3, the same <code class="language-plaintext highlighter-rouge">permalink:</code> generate the file <code class="language-plaintext highlighter-rouge">2016-02-01-test.html</code> and the URL for the same page will be <code class="language-plaintext highlighter-rouge">example.com/2016-02-01-test</code>, and consequently any links to the old URL will result in a 404 error. In order to maintain the same URLs and avoid this problem, a trailing slash should be added to the <code class="language-plaintext highlighter-rouge">permalink:</code> field, for example <code class="language-plaintext highlighter-rouge">permalink: /:year-:month-:day-:title/</code>.</p>
|
|
405
406
|
|
|
406
407
|
<h3 id="all-my-posts-are-gone-whered-they-go">All my posts are gone! Where’d they go!</h3>
|
|
407
408
|
|
|
408
|
-
<p>Try adding <code class="highlighter-rouge">future: true</code> to your <code class="highlighter-rouge">_config.yml</code> file. Are they showing up now? If they are, then you were ensnared by an issue with the way Ruby parses times. Each of your posts is being read in a different timezone than you might expect and, when compared to the computer’s current time, is “in the future.” The fix for this is to add <a href="https://en.wikipedia.org/wiki/List_of_UTC_time_offsets">a timezone offset</a> to each post (and make sure you remove <code class="highlighter-rouge">future: true</code> from your <code class="highlighter-rouge">_config.yml</code> file). If you’re writing from California, for example, you would change this:</p>
|
|
409
|
+
<p>Try adding <code class="language-plaintext highlighter-rouge">future: true</code> to your <code class="language-plaintext highlighter-rouge">_config.yml</code> file. Are they showing up now? If they are, then you were ensnared by an issue with the way Ruby parses times. Each of your posts is being read in a different timezone than you might expect and, when compared to the computer’s current time, is “in the future.” The fix for this is to add <a href="https://en.wikipedia.org/wiki/List_of_UTC_time_offsets">a timezone offset</a> to each post (and make sure you remove <code class="language-plaintext highlighter-rouge">future: true</code> from your <code class="language-plaintext highlighter-rouge">_config.yml</code> file). If you’re writing from California, for example, you would change this:</p>
|
|
409
410
|
|
|
410
411
|
<div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nn">---</span>
|
|
411
412
|
<span class="na">date</span><span class="pi">:</span> <span class="s">2016-02-06 19:32:10</span>
|
|
@@ -421,7 +422,7 @@ https://jekyllrb.com/docs/upgrading/ for more info.
|
|
|
421
422
|
|
|
422
423
|
<h3 id="my-categories-have-stopped-working">My categories have stopped working!</h3>
|
|
423
424
|
|
|
424
|
-
<p>If you organized your categories as <code class="highlighter-rouge">/_posts/code/2008-12-24-closures.md</code>, you will need to restructure your directories to put the categories <em>above</em> the <code class="highlighter-rouge">_posts</code> directories, as follows: <code class="highlighter-rouge">/code/_posts/2008-12-24-closures.md</code>.</p>
|
|
425
|
+
<p>If you organized your categories as <code class="language-plaintext highlighter-rouge">/_posts/code/2008-12-24-closures.md</code>, you will need to restructure your directories to put the categories <em>above</em> the <code class="language-plaintext highlighter-rouge">_posts</code> directories, as follows: <code class="language-plaintext highlighter-rouge">/code/_posts/2008-12-24-closures.md</code>.</p>
|
|
425
426
|
|
|
426
427
|
<p><em>Did we miss something? Please click “Improve this page” above and add a section. Thanks!</em></p>
|
|
427
428
|
|
|
@@ -743,7 +744,7 @@ https://jekyllrb.com/docs/upgrading/ for more info.
|
|
|
743
744
|
<footer>
|
|
744
745
|
<div class="grid">
|
|
745
746
|
<div class="unit one-third center-on-mobiles">
|
|
746
|
-
<p>The contents of this website are <br />©
|
|
747
|
+
<p>The contents of this website are <br />© 2020 under the terms of the <a href="https://github.com/jekyll/jekyll/blob/master/LICENSE">MIT License</a>.</p>
|
|
747
748
|
</div>
|
|
748
749
|
<div class="unit two-thirds align-right center-on-mobiles">
|
|
749
750
|
<p>
|
|
@@ -3,7 +3,7 @@
|
|
|
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.9.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
9
|
<link rel="preconnect" href="https://fonts.gstatic.com/" crossorigin>
|
|
@@ -11,9 +11,9 @@
|
|
|
11
11
|
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css" />
|
|
12
12
|
<link rel="stylesheet" href="/css/screen.css">
|
|
13
13
|
<link rel="icon" type="image/x-icon" href="/favicon.ico">
|
|
14
|
-
<!-- Begin Jekyll SEO tag v2.
|
|
14
|
+
<!-- Begin Jekyll SEO tag v2.6.1 -->
|
|
15
15
|
<title>Upgrading | Jekyll • Simple, blog-aware, static sites</title>
|
|
16
|
-
<meta name="generator" content="Jekyll v3.
|
|
16
|
+
<meta name="generator" content="Jekyll v3.9.0" />
|
|
17
17
|
<meta property="og:title" content="Upgrading" />
|
|
18
18
|
<meta property="og:locale" content="en_US" />
|
|
19
19
|
<meta name="description" content="Upgrading from an older version of Jekyll? Upgrading to a new major version of Jekyll (e.g. from v2.x to v3.x) may cause some headaches. Take the following guides to aid your upgrade:" />
|
|
@@ -22,12 +22,13 @@
|
|
|
22
22
|
<meta property="og:url" content="https://jekyllrb.com/docs/upgrading/" />
|
|
23
23
|
<meta property="og:site_name" content="Jekyll • Simple, blog-aware, static sites" />
|
|
24
24
|
<meta property="og:type" content="article" />
|
|
25
|
-
<meta property="article:published_time" content="
|
|
25
|
+
<meta property="article:published_time" content="2020-08-05T11:55:36-07:00" />
|
|
26
26
|
<meta name="twitter:card" content="summary" />
|
|
27
|
+
<meta property="twitter:title" content="Upgrading" />
|
|
27
28
|
<meta name="twitter:site" content="@jekyllrb" />
|
|
28
29
|
<meta name="google-site-verification" content="onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY" />
|
|
29
30
|
<script type="application/ld+json">
|
|
30
|
-
{"description":"Upgrading from an older version of Jekyll? Upgrading to a new major version of Jekyll (e.g. from v2.x to v3.x) may cause some headaches. Take the following guides to aid your upgrade:","
|
|
31
|
+
{"url":"https://jekyllrb.com/docs/upgrading/","headline":"Upgrading","dateModified":"2020-08-05T11:55:36-07:00","datePublished":"2020-08-05T11:55:36-07:00","publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://jekyllrb.com/img/logo-2x.png"}},"description":"Upgrading from an older version of Jekyll? Upgrading to a new major version of Jekyll (e.g. from v2.x to v3.x) may cause some headaches. Take the following guides to aid your upgrade:","mainEntityOfPage":{"@type":"WebPage","@id":"https://jekyllrb.com/docs/upgrading/"},"@type":"BlogPosting","@context":"https://schema.org"}</script>
|
|
31
32
|
<!-- End Jekyll SEO tag -->
|
|
32
33
|
|
|
33
34
|
<!--[if lt IE 9]>
|
|
@@ -72,7 +73,7 @@
|
|
|
72
73
|
<div class="meta hide-on-mobiles">
|
|
73
74
|
<ul>
|
|
74
75
|
<li>
|
|
75
|
-
<a href="https://github.com/jekyll/jekyll/releases/tag/v3.
|
|
76
|
+
<a href="https://github.com/jekyll/jekyll/releases/tag/v3.9.0">v3.9.0</a>
|
|
76
77
|
</li>
|
|
77
78
|
<li>
|
|
78
79
|
<a href="https://github.com/jekyll/jekyll">GitHub</a>
|
|
@@ -312,12 +313,12 @@ guides to aid your upgrade:</p>
|
|
|
312
313
|
</p>
|
|
313
314
|
</div>
|
|
314
315
|
|
|
315
|
-
<p>If you followed our setup recommendations and installed <a href="http://bundler.io/">Bundler</a>, run <code class="highlighter-rouge">bundle update jekyll</code> or simply <code class="highlighter-rouge">bundle update</code> and all your gems will
|
|
316
|
+
<p>If you followed our setup recommendations and installed <a href="http://bundler.io/">Bundler</a>, run <code class="language-plaintext highlighter-rouge">bundle update jekyll</code> or simply <code class="language-plaintext highlighter-rouge">bundle update</code> and all your gems will
|
|
316
317
|
update to the latest versions.</p>
|
|
317
318
|
|
|
318
|
-
<p>If you don’t have Bundler installed, run <code class="highlighter-rouge">gem update jekyll</code>.</p>
|
|
319
|
+
<p>If you don’t have Bundler installed, run <code class="language-plaintext highlighter-rouge">gem update jekyll</code>.</p>
|
|
319
320
|
|
|
320
|
-
<p>The procedure is similar <a href="https://help.github.com/articles/setting-up-your-github-pages-site-locally-with-jekyll/#keeping-your-site-up-to-date-with-the-github-pages-gem">if you use the <code class="highlighter-rouge">github-pages</code>
|
|
321
|
+
<p>The procedure is similar <a href="https://help.github.com/articles/setting-up-your-github-pages-site-locally-with-jekyll/#keeping-your-site-up-to-date-with-the-github-pages-gem">if you use the <code class="language-plaintext highlighter-rouge">github-pages</code>
|
|
321
322
|
gem</a>.</p>
|
|
322
323
|
|
|
323
324
|
|
|
@@ -633,7 +634,7 @@ gem</a>.</p>
|
|
|
633
634
|
<footer>
|
|
634
635
|
<div class="grid">
|
|
635
636
|
<div class="unit one-third center-on-mobiles">
|
|
636
|
-
<p>The contents of this website are <br />©
|
|
637
|
+
<p>The contents of this website are <br />© 2020 under the terms of the <a href="https://github.com/jekyll/jekyll/blob/master/LICENSE">MIT License</a>.</p>
|
|
637
638
|
</div>
|
|
638
639
|
<div class="unit two-thirds align-right center-on-mobiles">
|
|
639
640
|
<p>
|
data/site/docs/usage/index.html
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
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.9.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
9
|
<link rel="preconnect" href="https://fonts.gstatic.com/" crossorigin>
|
|
@@ -11,9 +11,9 @@
|
|
|
11
11
|
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css" />
|
|
12
12
|
<link rel="stylesheet" href="/css/screen.css">
|
|
13
13
|
<link rel="icon" type="image/x-icon" href="/favicon.ico">
|
|
14
|
-
<!-- Begin Jekyll SEO tag v2.
|
|
14
|
+
<!-- Begin Jekyll SEO tag v2.6.1 -->
|
|
15
15
|
<title>Basic Usage | Jekyll • Simple, blog-aware, static sites</title>
|
|
16
|
-
<meta name="generator" content="Jekyll v3.
|
|
16
|
+
<meta name="generator" content="Jekyll v3.9.0" />
|
|
17
17
|
<meta property="og:title" content="Basic Usage" />
|
|
18
18
|
<meta property="og:locale" content="en_US" />
|
|
19
19
|
<meta name="description" content="The Jekyll gem makes a jekyll executable available to you in your Terminal window. You can use this command in a number of ways:" />
|
|
@@ -22,12 +22,13 @@
|
|
|
22
22
|
<meta property="og:url" content="https://jekyllrb.com/docs/usage/" />
|
|
23
23
|
<meta property="og:site_name" content="Jekyll • Simple, blog-aware, static sites" />
|
|
24
24
|
<meta property="og:type" content="article" />
|
|
25
|
-
<meta property="article:published_time" content="
|
|
25
|
+
<meta property="article:published_time" content="2020-08-05T11:55:36-07:00" />
|
|
26
26
|
<meta name="twitter:card" content="summary" />
|
|
27
|
+
<meta property="twitter:title" content="Basic Usage" />
|
|
27
28
|
<meta name="twitter:site" content="@jekyllrb" />
|
|
28
29
|
<meta name="google-site-verification" content="onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY" />
|
|
29
30
|
<script type="application/ld+json">
|
|
30
|
-
{"
|
|
31
|
+
{"url":"https://jekyllrb.com/docs/usage/","headline":"Basic Usage","dateModified":"2020-08-05T11:55:36-07:00","datePublished":"2020-08-05T11:55:36-07:00","publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://jekyllrb.com/img/logo-2x.png"}},"description":"The Jekyll gem makes a jekyll executable available to you in your Terminal window. You can use this command in a number of ways:","mainEntityOfPage":{"@type":"WebPage","@id":"https://jekyllrb.com/docs/usage/"},"@type":"BlogPosting","@context":"https://schema.org"}</script>
|
|
31
32
|
<!-- End Jekyll SEO tag -->
|
|
32
33
|
|
|
33
34
|
<!--[if lt IE 9]>
|
|
@@ -72,7 +73,7 @@
|
|
|
72
73
|
<div class="meta hide-on-mobiles">
|
|
73
74
|
<ul>
|
|
74
75
|
<li>
|
|
75
|
-
<a href="https://github.com/jekyll/jekyll/releases/tag/v3.
|
|
76
|
+
<a href="https://github.com/jekyll/jekyll/releases/tag/v3.9.0">v3.9.0</a>
|
|
76
77
|
</li>
|
|
77
78
|
<li>
|
|
78
79
|
<a href="https://github.com/jekyll/jekyll">GitHub</a>
|
|
@@ -294,7 +295,7 @@
|
|
|
294
295
|
<a href="https://github.com/jekyll/jekyll/edit/master/docs/_docs/usage.md"><i class="fa fa-pencil"></i> Improve this page</a>
|
|
295
296
|
</div>
|
|
296
297
|
<h1>Basic Usage</h1>
|
|
297
|
-
<p>The Jekyll gem makes a <code class="highlighter-rouge">jekyll</code> executable available to you in your Terminal
|
|
298
|
+
<p>The Jekyll gem makes a <code class="language-plaintext highlighter-rouge">jekyll</code> executable available to you in your Terminal
|
|
298
299
|
window. You can use this command in a number of ways:</p>
|
|
299
300
|
|
|
300
301
|
<div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code>jekyll build
|
|
@@ -313,13 +314,13 @@ jekyll build <span class="nt">--watch</span>
|
|
|
313
314
|
|
|
314
315
|
<h2 id="override-default-development-settings">Override default development settings</h2>
|
|
315
316
|
|
|
316
|
-
<p>Default URL is set to <code class="highlighter-rouge">http://localhost:4000</code> in development environment. <span class="version-badge" title="This feature is available starting version 3.3.0">3.3.0</span></p>
|
|
317
|
+
<p>Default URL is set to <code class="language-plaintext highlighter-rouge">http://localhost:4000</code> in development environment. <span class="version-badge" title="This feature is available starting version 3.3.0">3.3.0</span></p>
|
|
317
318
|
|
|
318
319
|
<p>If you want to build for your production environment:</p>
|
|
319
320
|
|
|
320
321
|
<ul>
|
|
321
|
-
<li>Set your production URL in <code class="highlighter-rouge">_config.yml</code> e.g. <code class="highlighter-rouge">url: https://example.com</code>.</li>
|
|
322
|
-
<li>Run <code class="highlighter-rouge">JEKYLL_ENV=production bundle exec jekyll build</code>.</li>
|
|
322
|
+
<li>Set your production URL in <code class="language-plaintext highlighter-rouge">_config.yml</code> e.g. <code class="language-plaintext highlighter-rouge">url: https://example.com</code>.</li>
|
|
323
|
+
<li>Run <code class="language-plaintext highlighter-rouge">JEKYLL_ENV=production bundle exec jekyll build</code>.</li>
|
|
323
324
|
</ul>
|
|
324
325
|
|
|
325
326
|
<div class="note info">
|
|
@@ -374,10 +375,10 @@ jekyll serve <span class="nt">--detach</span>
|
|
|
374
375
|
|
|
375
376
|
<p>These are just a few of the available <a href="../configuration/">configuration options</a>.
|
|
376
377
|
Many configuration options can either be specified as flags on the command line,
|
|
377
|
-
or alternatively (and more commonly) they can be specified in a <code class="highlighter-rouge">_config.yml</code>
|
|
378
|
+
or alternatively (and more commonly) they can be specified in a <code class="language-plaintext highlighter-rouge">_config.yml</code>
|
|
378
379
|
file at the root of the source directory. Jekyll will automatically use the
|
|
379
380
|
options from this file when run. For example, if you place the following lines
|
|
380
|
-
in your <code class="highlighter-rouge">_config.yml</code> file:</p>
|
|
381
|
+
in your <code class="language-plaintext highlighter-rouge">_config.yml</code> file:</p>
|
|
381
382
|
|
|
382
383
|
<div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">source</span><span class="pi">:</span> <span class="s">_source</span>
|
|
383
384
|
<span class="na">destination</span><span class="pi">:</span> <span class="s">_deploy</span>
|
|
@@ -400,7 +401,7 @@ jekyll build <span class="nt">--source</span> _source <span class="nt">--destina
|
|
|
400
401
|
</div>
|
|
401
402
|
|
|
402
403
|
<p>If you’re interested in browsing these docs on-the-go, install the
|
|
403
|
-
<code class="highlighter-rouge">jekyll-docs</code> gem and run <code class="highlighter-rouge">jekyll docs</code> in your terminal.</p>
|
|
404
|
+
<code class="language-plaintext highlighter-rouge">jekyll-docs</code> gem and run <code class="language-plaintext highlighter-rouge">jekyll docs</code> in your terminal.</p>
|
|
404
405
|
|
|
405
406
|
|
|
406
407
|
|
|
@@ -639,7 +640,7 @@ jekyll build <span class="nt">--source</span> _source <span class="nt">--destina
|
|
|
639
640
|
<footer>
|
|
640
641
|
<div class="grid">
|
|
641
642
|
<div class="unit one-third center-on-mobiles">
|
|
642
|
-
<p>The contents of this website are <br />©
|
|
643
|
+
<p>The contents of this website are <br />© 2020 under the terms of the <a href="https://github.com/jekyll/jekyll/blob/master/LICENSE">MIT License</a>.</p>
|
|
643
644
|
</div>
|
|
644
645
|
<div class="unit two-thirds align-right center-on-mobiles">
|
|
645
646
|
<p>
|
|
@@ -3,7 +3,7 @@
|
|
|
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.9.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
9
|
<link rel="preconnect" href="https://fonts.gstatic.com/" crossorigin>
|
|
@@ -11,9 +11,9 @@
|
|
|
11
11
|
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css" />
|
|
12
12
|
<link rel="stylesheet" href="/css/screen.css">
|
|
13
13
|
<link rel="icon" type="image/x-icon" href="/favicon.ico">
|
|
14
|
-
<!-- Begin Jekyll SEO tag v2.
|
|
14
|
+
<!-- Begin Jekyll SEO tag v2.6.1 -->
|
|
15
15
|
<title>Variables | Jekyll • Simple, blog-aware, static sites</title>
|
|
16
|
-
<meta name="generator" content="Jekyll v3.
|
|
16
|
+
<meta name="generator" content="Jekyll v3.9.0" />
|
|
17
17
|
<meta property="og:title" content="Variables" />
|
|
18
18
|
<meta property="og:locale" content="en_US" />
|
|
19
19
|
<meta name="description" content="Jekyll traverses your site looking for files to process. Any files with YAML front matter are subject to processing. For each of these files, Jekyll makes a variety of data available via the Liquid templating system. The following is a reference of the available data." />
|
|
@@ -22,12 +22,13 @@
|
|
|
22
22
|
<meta property="og:url" content="https://jekyllrb.com/docs/variables/" />
|
|
23
23
|
<meta property="og:site_name" content="Jekyll • Simple, blog-aware, static sites" />
|
|
24
24
|
<meta property="og:type" content="article" />
|
|
25
|
-
<meta property="article:published_time" content="
|
|
25
|
+
<meta property="article:published_time" content="2020-08-05T11:55:36-07:00" />
|
|
26
26
|
<meta name="twitter:card" content="summary" />
|
|
27
|
+
<meta property="twitter:title" content="Variables" />
|
|
27
28
|
<meta name="twitter:site" content="@jekyllrb" />
|
|
28
29
|
<meta name="google-site-verification" content="onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY" />
|
|
29
30
|
<script type="application/ld+json">
|
|
30
|
-
{"description":"Jekyll traverses your site looking for files to process. Any files with YAML front matter are subject to processing. For each of these files, Jekyll makes a variety of data available via the Liquid templating system. The following is a reference of the available data.","
|
|
31
|
+
{"url":"https://jekyllrb.com/docs/variables/","headline":"Variables","dateModified":"2020-08-05T11:55:36-07:00","datePublished":"2020-08-05T11:55:36-07:00","publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://jekyllrb.com/img/logo-2x.png"}},"description":"Jekyll traverses your site looking for files to process. Any files with YAML front matter are subject to processing. For each of these files, Jekyll makes a variety of data available via the Liquid templating system. The following is a reference of the available data.","mainEntityOfPage":{"@type":"WebPage","@id":"https://jekyllrb.com/docs/variables/"},"@type":"BlogPosting","@context":"https://schema.org"}</script>
|
|
31
32
|
<!-- End Jekyll SEO tag -->
|
|
32
33
|
|
|
33
34
|
<!--[if lt IE 9]>
|
|
@@ -72,7 +73,7 @@
|
|
|
72
73
|
<div class="meta hide-on-mobiles">
|
|
73
74
|
<ul>
|
|
74
75
|
<li>
|
|
75
|
-
<a href="https://github.com/jekyll/jekyll/releases/tag/v3.
|
|
76
|
+
<a href="https://github.com/jekyll/jekyll/releases/tag/v3.9.0">v3.9.0</a>
|
|
76
77
|
</li>
|
|
77
78
|
<li>
|
|
78
79
|
<a href="https://github.com/jekyll/jekyll">GitHub</a>
|
|
@@ -972,7 +973,7 @@ following is a reference of the available data.</p>
|
|
|
972
973
|
<footer>
|
|
973
974
|
<div class="grid">
|
|
974
975
|
<div class="unit one-third center-on-mobiles">
|
|
975
|
-
<p>The contents of this website are <br />©
|
|
976
|
+
<p>The contents of this website are <br />© 2020 under the terms of the <a href="https://github.com/jekyll/jekyll/blob/master/LICENSE">MIT License</a>.</p>
|
|
976
977
|
</div>
|
|
977
978
|
<div class="unit two-thirds align-right center-on-mobiles">
|
|
978
979
|
<p>
|
|
@@ -3,7 +3,7 @@
|
|
|
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.9.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
9
|
<link rel="preconnect" href="https://fonts.gstatic.com/" crossorigin>
|
|
@@ -11,9 +11,9 @@
|
|
|
11
11
|
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css" />
|
|
12
12
|
<link rel="stylesheet" href="/css/screen.css">
|
|
13
13
|
<link rel="icon" type="image/x-icon" href="/favicon.ico">
|
|
14
|
-
<!-- Begin Jekyll SEO tag v2.
|
|
14
|
+
<!-- Begin Jekyll SEO tag v2.6.1 -->
|
|
15
15
|
<title>Jekyll on Windows | Jekyll • Simple, blog-aware, static sites</title>
|
|
16
|
-
<meta name="generator" content="Jekyll v3.
|
|
16
|
+
<meta name="generator" content="Jekyll v3.9.0" />
|
|
17
17
|
<meta property="og:title" content="Jekyll on Windows" />
|
|
18
18
|
<meta property="og:locale" content="en_US" />
|
|
19
19
|
<meta name="description" content="While Windows is not an officially-supported platform, it can be used to run Jekyll with the proper tweaks. This page aims to collect some of the general knowledge and lessons that have been unearthed by Windows users." />
|
|
@@ -22,12 +22,13 @@
|
|
|
22
22
|
<meta property="og:url" content="https://jekyllrb.com/docs/windows/" />
|
|
23
23
|
<meta property="og:site_name" content="Jekyll • Simple, blog-aware, static sites" />
|
|
24
24
|
<meta property="og:type" content="article" />
|
|
25
|
-
<meta property="article:published_time" content="
|
|
25
|
+
<meta property="article:published_time" content="2020-08-05T11:55:36-07:00" />
|
|
26
26
|
<meta name="twitter:card" content="summary" />
|
|
27
|
+
<meta property="twitter:title" content="Jekyll on Windows" />
|
|
27
28
|
<meta name="twitter:site" content="@jekyllrb" />
|
|
28
29
|
<meta name="google-site-verification" content="onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY" />
|
|
29
30
|
<script type="application/ld+json">
|
|
30
|
-
{"description":"While Windows is not an officially-supported platform, it can be used to run Jekyll with the proper tweaks. This page aims to collect some of the general knowledge and lessons that have been unearthed by Windows users.","
|
|
31
|
+
{"url":"https://jekyllrb.com/docs/windows/","headline":"Jekyll on Windows","dateModified":"2020-08-05T11:55:36-07:00","datePublished":"2020-08-05T11:55:36-07:00","publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://jekyllrb.com/img/logo-2x.png"}},"description":"While Windows is not an officially-supported platform, it can be used to run Jekyll with the proper tweaks. This page aims to collect some of the general knowledge and lessons that have been unearthed by Windows users.","mainEntityOfPage":{"@type":"WebPage","@id":"https://jekyllrb.com/docs/windows/"},"@type":"BlogPosting","@context":"https://schema.org"}</script>
|
|
31
32
|
<!-- End Jekyll SEO tag -->
|
|
32
33
|
|
|
33
34
|
<!--[if lt IE 9]>
|
|
@@ -72,7 +73,7 @@
|
|
|
72
73
|
<div class="meta hide-on-mobiles">
|
|
73
74
|
<ul>
|
|
74
75
|
<li>
|
|
75
|
-
<a href="https://github.com/jekyll/jekyll/releases/tag/v3.
|
|
76
|
+
<a href="https://github.com/jekyll/jekyll/releases/tag/v3.9.0">v3.9.0</a>
|
|
76
77
|
</li>
|
|
77
78
|
<li>
|
|
78
79
|
<a href="https://github.com/jekyll/jekyll">GitHub</a>
|
|
@@ -336,12 +337,12 @@
|
|
|
336
337
|
|
|
337
338
|
<p><strong>And that’s it!</strong></p>
|
|
338
339
|
|
|
339
|
-
<p>To start a new project named <code class="highlighter-rouge">my_blog</code>, just run:</p>
|
|
340
|
+
<p>To start a new project named <code class="language-plaintext highlighter-rouge">my_blog</code>, just run:</p>
|
|
340
341
|
|
|
341
342
|
<div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code>jekyll new my_blog
|
|
342
343
|
</code></pre></div></div>
|
|
343
344
|
|
|
344
|
-
<p>You can make sure time management is working properly by inspecting your <code class="highlighter-rouge">_posts</code> folder. You should see a markdown file with the current date in the filename.</p>
|
|
345
|
+
<p>You can make sure time management is working properly by inspecting your <code class="language-plaintext highlighter-rouge">_posts</code> folder. You should see a markdown file with the current date in the filename.</p>
|
|
345
346
|
|
|
346
347
|
<div class="note info">
|
|
347
348
|
<h5>Non-superuser account issues</h5>
|
|
@@ -356,8 +357,8 @@
|
|
|
356
357
|
|
|
357
358
|
<ol>
|
|
358
359
|
<li>Download and Install a package manager version from <a href="https://rubyinstaller.org/downloads/">RubyInstaller Downloads</a>.</li>
|
|
359
|
-
<li>Install Jekyll and Bundler via a command prompt window: <code class="highlighter-rouge">gem install jekyll bundler</code></li>
|
|
360
|
-
<li>Check if Jekyll installed properly: <code class="highlighter-rouge">jekyll -v</code></li>
|
|
360
|
+
<li>Install Jekyll and Bundler via a command prompt window: <code class="language-plaintext highlighter-rouge">gem install jekyll bundler</code></li>
|
|
361
|
+
<li>Check if Jekyll installed properly: <code class="language-plaintext highlighter-rouge">jekyll -v</code></li>
|
|
361
362
|
</ol>
|
|
362
363
|
|
|
363
364
|
<h3 id="installation-via-chocolatey">Installation via Chocolatey</h3>
|
|
@@ -366,11 +367,11 @@
|
|
|
366
367
|
|
|
367
368
|
<ol>
|
|
368
369
|
<li>Install a package manager for Windows called <a href="https://chocolatey.org/install" title="Package manager for Windows">Chocolatey</a></li>
|
|
369
|
-
<li>Install Ruby via Chocolatey: <code class="highlighter-rouge">choco install ruby -y</code></li>
|
|
370
|
-
<li>Reopen a command prompt and install Jekyll: <code class="highlighter-rouge">gem install jekyll</code></li>
|
|
370
|
+
<li>Install Ruby via Chocolatey: <code class="language-plaintext highlighter-rouge">choco install ruby -y</code></li>
|
|
371
|
+
<li>Reopen a command prompt and install Jekyll: <code class="language-plaintext highlighter-rouge">gem install jekyll</code></li>
|
|
371
372
|
</ol>
|
|
372
373
|
|
|
373
|
-
<p>Updates in the infrastructure of Ruby may cause SSL errors when attempting to use <code class="highlighter-rouge">gem install</code> with versions of the RubyGems package older than 2.6. (The RubyGems package installed via the Chocolatey tool is version 2.3) If you have installed an older version, you can update the RubyGems package using the directions <a href="http://guides.rubygems.org/ssl-certificate-update/#installing-using-update-packages">here</a>.</p>
|
|
374
|
+
<p>Updates in the infrastructure of Ruby may cause SSL errors when attempting to use <code class="language-plaintext highlighter-rouge">gem install</code> with versions of the RubyGems package older than 2.6. (The RubyGems package installed via the Chocolatey tool is version 2.3) If you have installed an older version, you can update the RubyGems package using the directions <a href="http://guides.rubygems.org/ssl-certificate-update/#installing-using-update-packages">here</a>.</p>
|
|
374
375
|
|
|
375
376
|
<h3 id="installing-github-pages-via-chocolatey">Installing <em>github-pages</em> via Chocolatey</h3>
|
|
376
377
|
|
|
@@ -381,8 +382,8 @@
|
|
|
381
382
|
<p>Open a command prompt and execute the following commands:</p>
|
|
382
383
|
|
|
383
384
|
<ul>
|
|
384
|
-
<li><code class="highlighter-rouge">choco install ruby -version 2.2.4</code></li>
|
|
385
|
-
<li><code class="highlighter-rouge">choco install ruby2.devkit</code> - <em>needed for compilation of json gem</em></li>
|
|
385
|
+
<li><code class="language-plaintext highlighter-rouge">choco install ruby -version 2.2.4</code></li>
|
|
386
|
+
<li><code class="language-plaintext highlighter-rouge">choco install ruby2.devkit</code> - <em>needed for compilation of json gem</em></li>
|
|
386
387
|
</ul>
|
|
387
388
|
|
|
388
389
|
<h4 id="configure-ruby-development-kit">Configure Ruby development kit</h4>
|
|
@@ -390,10 +391,10 @@
|
|
|
390
391
|
<p>The development kit did not set the environment path for Ruby so we need to do it.</p>
|
|
391
392
|
|
|
392
393
|
<ul>
|
|
393
|
-
<li>Open command prompt in <code class="highlighter-rouge">C:\tools\DevKit2</code></li>
|
|
394
|
-
<li>Execute <code class="highlighter-rouge">ruby dk.rb init</code> to create a file called <code class="highlighter-rouge">config.yml</code></li>
|
|
395
|
-
<li>Edit the <code class="highlighter-rouge">config.yml</code> file and include the path to Ruby <code class="highlighter-rouge">- C:/tools/ruby22</code></li>
|
|
396
|
-
<li>Execute the following command to set the path: <code class="highlighter-rouge">ruby dk.rb install</code></li>
|
|
394
|
+
<li>Open command prompt in <code class="language-plaintext highlighter-rouge">C:\tools\DevKit2</code></li>
|
|
395
|
+
<li>Execute <code class="language-plaintext highlighter-rouge">ruby dk.rb init</code> to create a file called <code class="language-plaintext highlighter-rouge">config.yml</code></li>
|
|
396
|
+
<li>Edit the <code class="language-plaintext highlighter-rouge">config.yml</code> file and include the path to Ruby <code class="language-plaintext highlighter-rouge">- C:/tools/ruby22</code></li>
|
|
397
|
+
<li>Execute the following command to set the path: <code class="language-plaintext highlighter-rouge">ruby dk.rb install</code></li>
|
|
397
398
|
</ul>
|
|
398
399
|
|
|
399
400
|
<h4 id="nokogiri-gem-installation">Nokogiri gem installation</h4>
|
|
@@ -420,8 +421,8 @@ gem install nokogiri --^
|
|
|
420
421
|
<h4 id="install-github-pages">Install github-pages</h4>
|
|
421
422
|
|
|
422
423
|
<ul>
|
|
423
|
-
<li>Open command prompt and install <a href="http://bundler.io/" title="Ruby Dependencie Manager">Bundler</a>: <code class="highlighter-rouge">gem install bundler</code></li>
|
|
424
|
-
<li>Create a file called <code class="highlighter-rouge">Gemfile</code> without any extension in your root directory of your blog</li>
|
|
424
|
+
<li>Open command prompt and install <a href="http://bundler.io/" title="Ruby Dependencie Manager">Bundler</a>: <code class="language-plaintext highlighter-rouge">gem install bundler</code></li>
|
|
425
|
+
<li>Create a file called <code class="language-plaintext highlighter-rouge">Gemfile</code> without any extension in your root directory of your blog</li>
|
|
425
426
|
<li>Copy & paste the two lines into the file:</li>
|
|
426
427
|
</ul>
|
|
427
428
|
|
|
@@ -431,11 +432,11 @@ gem install nokogiri --^
|
|
|
431
432
|
|
|
432
433
|
<ul>
|
|
433
434
|
<li><strong>Note:</strong> We use an unsecure connection because SSL throws exceptions in the version of Ruby</li>
|
|
434
|
-
<li>Open a command prompt, target your local blog repository root, and install github-pages: <code class="highlighter-rouge">bundle install</code></li>
|
|
435
|
+
<li>Open a command prompt, target your local blog repository root, and install github-pages: <code class="language-plaintext highlighter-rouge">bundle install</code></li>
|
|
435
436
|
</ul>
|
|
436
437
|
|
|
437
|
-
<p>After this process you should have github-pages installed on your system and you can host your blog again with <code class="highlighter-rouge">jekyll s</code>.
|
|
438
|
-
There will be a warning on startup that you should include <code class="highlighter-rouge">gem 'wdm', '>= 0.1.0' if Gem.win_platform?</code> to your <code class="highlighter-rouge">Gemfile</code> but I could not get <code class="highlighter-rouge">jekyll s</code> working if I include that line so for the moment I ignore that warning.</p>
|
|
438
|
+
<p>After this process you should have github-pages installed on your system and you can host your blog again with <code class="language-plaintext highlighter-rouge">jekyll s</code>.
|
|
439
|
+
There will be a warning on startup that you should include <code class="language-plaintext highlighter-rouge">gem 'wdm', '>= 0.1.0' if Gem.win_platform?</code> to your <code class="language-plaintext highlighter-rouge">Gemfile</code> but I could not get <code class="language-plaintext highlighter-rouge">jekyll s</code> working if I include that line so for the moment I ignore that warning.</p>
|
|
439
440
|
|
|
440
441
|
<p>In the future the installation process of the github-pages should be as simple as the setup of the blog. But as long as the new version of the Nokogiri (<a href="https://github.com/sparklemotion/nokogiri/releases" title="Nokogiri Releases">v1.6.8</a>) is not stable and referenced, it is work to get it up and running on Windows.</p>
|
|
441
442
|
|
|
@@ -445,7 +446,7 @@ There will be a warning on startup that you should include <code class="highligh
|
|
|
445
446
|
|
|
446
447
|
<h2 id="encoding">Encoding</h2>
|
|
447
448
|
|
|
448
|
-
<p>If you use UTF-8 encoding, make sure that no <code class="highlighter-rouge">BOM</code> header characters exist in your files or very, very bad things will happen to
|
|
449
|
+
<p>If you use UTF-8 encoding, make sure that no <code class="language-plaintext highlighter-rouge">BOM</code> header characters exist in your files or very, very bad things will happen to
|
|
449
450
|
Jekyll. This is especially relevant when you’re running Jekyll on Windows.</p>
|
|
450
451
|
|
|
451
452
|
<p>Additionally, you might need to change the code page of the console window to UTF-8 in case you get a “Liquid Exception: Incompatible character encoding” error during the site generation process. It can be done with the following command:</p>
|
|
@@ -455,7 +456,7 @@ Jekyll. This is especially relevant when you’re running Jekyll on Windows.</p>
|
|
|
455
456
|
|
|
456
457
|
<h2 id="time-zone-management">Time-Zone Management</h2>
|
|
457
458
|
|
|
458
|
-
<p>Since Windows doesn’t have a native source of zoneinfo data, the Ruby Interpreter would not understand IANA Timezones and hence using them had the <code class="highlighter-rouge">TZ</code> environment variable default to UTC/GMT 00:00.
|
|
459
|
+
<p>Since Windows doesn’t have a native source of zoneinfo data, the Ruby Interpreter would not understand IANA Timezones and hence using them had the <code class="language-plaintext highlighter-rouge">TZ</code> environment variable default to UTC/GMT 00:00.
|
|
459
460
|
Though Windows users could alternatively define their blog’s timezone by setting the key to use POSIX format of defining timezones, it wasn’t as user-friendly when it came to having the clock altered to changing DST-rules.</p>
|
|
460
461
|
|
|
461
462
|
<p>Jekyll now uses a rubygem to internally configure Timezone based on established <a href="https://en.wikipedia.org/wiki/List_of_tz_database_time_zones">IANA Timezone Database</a>.
|
|
@@ -467,7 +468,7 @@ While ‘new’ blogs created with Jekyll v3.4 and greater, will have the follow
|
|
|
467
468
|
|
|
468
469
|
<h2 id="auto-regeneration">Auto Regeneration</h2>
|
|
469
470
|
|
|
470
|
-
<p>Jekyll uses the <code class="highlighter-rouge">listen</code> gem to watch for changes when the <code class="highlighter-rouge">--watch</code> switch is specified during a build or serve. While <code class="highlighter-rouge">listen</code> has built-in support for UNIX systems, it may require an extra gem for compatibility with Windows.</p>
|
|
471
|
+
<p>Jekyll uses the <code class="language-plaintext highlighter-rouge">listen</code> gem to watch for changes when the <code class="language-plaintext highlighter-rouge">--watch</code> switch is specified during a build or serve. While <code class="language-plaintext highlighter-rouge">listen</code> has built-in support for UNIX systems, it may require an extra gem for compatibility with Windows.</p>
|
|
471
472
|
|
|
472
473
|
<p>Add the following to the Gemfile for your site if you have issues with auto-regeneration on Windows alone:</p>
|
|
473
474
|
|
|
@@ -710,7 +711,7 @@ While ‘new’ blogs created with Jekyll v3.4 and greater, will have the follow
|
|
|
710
711
|
<footer>
|
|
711
712
|
<div class="grid">
|
|
712
713
|
<div class="unit one-third center-on-mobiles">
|
|
713
|
-
<p>The contents of this website are <br />©
|
|
714
|
+
<p>The contents of this website are <br />© 2020 under the terms of the <a href="https://github.com/jekyll/jekyll/blob/master/LICENSE">MIT License</a>.</p>
|
|
714
715
|
</div>
|
|
715
716
|
<div class="unit two-thirds align-right center-on-mobiles">
|
|
716
717
|
<p>
|