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>Troubleshooting | 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="Troubleshooting" />
|
|
18
18
|
<meta property="og:locale" content="en_US" />
|
|
19
19
|
<meta name="description" content="If you ever run into problems installing or using Jekyll, here are a few tips that might be of help. If the problem you’re experiencing isn’t covered below, please check out our other help resources as well." />
|
|
@@ -22,12 +22,13 @@
|
|
|
22
22
|
<meta property="og:url" content="https://jekyllrb.com/docs/troubleshooting/" />
|
|
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="Troubleshooting" />
|
|
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":"If you ever run into problems installing or using Jekyll, here are a few tips that might be of help. If the problem you’re experiencing isn’t covered below, please check out our other help resources as well.","
|
|
31
|
+
{"url":"https://jekyllrb.com/docs/troubleshooting/","headline":"Troubleshooting","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":"If you ever run into problems installing or using Jekyll, here are a few tips that might be of help. If the problem you’re experiencing isn’t covered below, please check out our other help resources as well.","mainEntityOfPage":{"@type":"WebPage","@id":"https://jekyllrb.com/docs/troubleshooting/"},"@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>
|
|
@@ -321,7 +322,7 @@ can be done on Ubuntu or Debian by running:</p>
|
|
|
321
322
|
<div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nb">sudo </span>yum <span class="nb">install </span>ruby-devel
|
|
322
323
|
</code></pre></div></div>
|
|
323
324
|
|
|
324
|
-
<p>If you installed the above - specifically on Fedora 23 - but the extensions would still not compile, you are probably running a Fedora image that misses the <code class="highlighter-rouge">redhat-rpm-config</code> package. To solve this, simply run:</p>
|
|
325
|
+
<p>If you installed the above - specifically on Fedora 23 - but the extensions would still not compile, you are probably running a Fedora image that misses the <code class="language-plaintext highlighter-rouge">redhat-rpm-config</code> package. To solve this, simply run:</p>
|
|
325
326
|
|
|
326
327
|
<div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nb">sudo </span>dnf <span class="nb">install </span>redhat-rpm-config
|
|
327
328
|
</code></pre></div></div>
|
|
@@ -331,10 +332,10 @@ can be done on Ubuntu or Debian by running:</p>
|
|
|
331
332
|
<div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nb">sudo </span>pacman <span class="nt">-S</span> ruby-ffi
|
|
332
333
|
</code></pre></div></div>
|
|
333
334
|
|
|
334
|
-
<p>On Ubuntu if you get stuck after <code class="highlighter-rouge">bundle exec jekyll serve</code> and see error
|
|
335
|
-
messages like <code class="highlighter-rouge">Could not locate Gemfile</code> or <code class="highlighter-rouge">.bundle/ directory</code>, it’s likely
|
|
335
|
+
<p>On Ubuntu if you get stuck after <code class="language-plaintext highlighter-rouge">bundle exec jekyll serve</code> and see error
|
|
336
|
+
messages like <code class="language-plaintext highlighter-rouge">Could not locate Gemfile</code> or <code class="language-plaintext highlighter-rouge">.bundle/ directory</code>, it’s likely
|
|
336
337
|
because all requirements have not been fully met. Recent stock Ubuntu
|
|
337
|
-
distributions require the installation of both the <code class="highlighter-rouge">ruby</code> and <code class="highlighter-rouge">ruby-all-dev</code>
|
|
338
|
+
distributions require the installation of both the <code class="language-plaintext highlighter-rouge">ruby</code> and <code class="language-plaintext highlighter-rouge">ruby-all-dev</code>
|
|
338
339
|
packages:</p>
|
|
339
340
|
|
|
340
341
|
<div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nb">sudo </span>apt-get <span class="nb">install </span>ruby ruby-all-dev
|
|
@@ -362,19 +363,19 @@ DevKit</a>.</p>
|
|
|
362
363
|
<div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code>apt update <span class="o">&&</span> apt <span class="nb">install </span>libffi-dev clang ruby-dev make
|
|
363
364
|
</code></pre></div></div>
|
|
364
365
|
|
|
365
|
-
<p>On macOS, you may need to update RubyGems (using <code class="highlighter-rouge">sudo</code> only if necessary):</p>
|
|
366
|
+
<p>On macOS, you may need to update RubyGems (using <code class="language-plaintext highlighter-rouge">sudo</code> only if necessary):</p>
|
|
366
367
|
|
|
367
368
|
<div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code>gem update <span class="nt">--system</span>
|
|
368
369
|
</code></pre></div></div>
|
|
369
370
|
|
|
370
371
|
<p>If you still have issues, you can download and install new Command Line
|
|
371
|
-
Tools (such as <code class="highlighter-rouge">gcc</code>) using the following command:</p>
|
|
372
|
+
Tools (such as <code class="language-plaintext highlighter-rouge">gcc</code>) using the following command:</p>
|
|
372
373
|
|
|
373
374
|
<div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code>xcode-select <span class="nt">--install</span>
|
|
374
375
|
</code></pre></div></div>
|
|
375
376
|
|
|
376
377
|
<p>which may allow you to install native gems using this command (again, using
|
|
377
|
-
<code class="highlighter-rouge">sudo</code> only if necessary):</p>
|
|
378
|
+
<code class="language-plaintext highlighter-rouge">sudo</code> only if necessary):</p>
|
|
378
379
|
|
|
379
380
|
<div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code>gem <span class="nb">install </span>jekyll
|
|
380
381
|
</code></pre></div></div>
|
|
@@ -390,27 +391,27 @@ Line Tools.</p>
|
|
|
390
391
|
<p>On most flavors of Linux, macOS, and Bash on Ubuntu on Windows, it is
|
|
391
392
|
possible to run Jekyll as a non-superuser and without having to install
|
|
392
393
|
gems to system-wide locations by adding the following lines to the end
|
|
393
|
-
of your <code class="highlighter-rouge">.bashrc</code> file:</p>
|
|
394
|
+
of your <code class="language-plaintext highlighter-rouge">.bashrc</code> file:</p>
|
|
394
395
|
|
|
395
|
-
<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code># Ruby exports
|
|
396
|
+
<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code># Ruby exports
|
|
396
397
|
|
|
397
398
|
export GEM_HOME=$HOME/gems
|
|
398
399
|
export PATH=$HOME/gems/bin:$PATH
|
|
399
400
|
</code></pre></div></div>
|
|
400
401
|
|
|
401
|
-
<p>This tells <code class="highlighter-rouge">gem</code> to place its gems within the user’s home folder,
|
|
402
|
-
not in a system-wide location, and adds the local <code class="highlighter-rouge">jekyll</code> command to the
|
|
403
|
-
user’s <code class="highlighter-rouge">PATH</code> ahead of any system-wide paths.</p>
|
|
402
|
+
<p>This tells <code class="language-plaintext highlighter-rouge">gem</code> to place its gems within the user’s home folder,
|
|
403
|
+
not in a system-wide location, and adds the local <code class="language-plaintext highlighter-rouge">jekyll</code> command to the
|
|
404
|
+
user’s <code class="language-plaintext highlighter-rouge">PATH</code> ahead of any system-wide paths.</p>
|
|
404
405
|
|
|
405
406
|
<p>This is also useful for many shared webhosting services, where user accounts
|
|
406
|
-
have only limited privileges. Adding these exports to <code class="highlighter-rouge">.bashrc</code> before running
|
|
407
|
-
<code class="highlighter-rouge">gem install jekyll bundler</code> allows a complete non-<code class="highlighter-rouge">sudo</code> install of Jekyll.</p>
|
|
407
|
+
have only limited privileges. Adding these exports to <code class="language-plaintext highlighter-rouge">.bashrc</code> before running
|
|
408
|
+
<code class="language-plaintext highlighter-rouge">gem install jekyll bundler</code> allows a complete non-<code class="language-plaintext highlighter-rouge">sudo</code> install of Jekyll.</p>
|
|
408
409
|
|
|
409
410
|
<p>To activate the new exports, either close and restart Bash, logout and
|
|
410
|
-
log back into your shell account, or run <code class="highlighter-rouge">. .bashrc</code> in the
|
|
411
|
+
log back into your shell account, or run <code class="language-plaintext highlighter-rouge">. .bashrc</code> in the
|
|
411
412
|
currently-running shell.</p>
|
|
412
413
|
|
|
413
|
-
<p>If you see the following error when running the <code class="highlighter-rouge">jekyll new</code> command,
|
|
414
|
+
<p>If you see the following error when running the <code class="language-plaintext highlighter-rouge">jekyll new</code> command,
|
|
414
415
|
you can solve it by using the above-described procedure:</p>
|
|
415
416
|
|
|
416
417
|
<div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code>jekyll new <span class="nb">test
|
|
@@ -428,7 +429,7 @@ and install the bundled gems to RubyGems using sudo.
|
|
|
428
429
|
Password:
|
|
429
430
|
</span></code></pre></div></div>
|
|
430
431
|
|
|
431
|
-
<p>Once this is done, the <code class="highlighter-rouge">jekyll new</code> command should work properly for
|
|
432
|
+
<p>Once this is done, the <code class="language-plaintext highlighter-rouge">jekyll new</code> command should work properly for
|
|
432
433
|
your user account.</p>
|
|
433
434
|
|
|
434
435
|
<h3 id="jekyll--mac-os-x-1011">Jekyll & Mac OS X 10.11</h3>
|
|
@@ -437,7 +438,7 @@ your user account.</p>
|
|
|
437
438
|
that were previously writable are now considered system locations and are no
|
|
438
439
|
longer available. Given these changes, there are a couple of simple ways to get
|
|
439
440
|
up and running. One option is to change the location where the gem will be
|
|
440
|
-
installed (again, using <code class="highlighter-rouge">sudo</code> only if necessary):</p>
|
|
441
|
+
installed (again, using <code class="language-plaintext highlighter-rouge">sudo</code> only if necessary):</p>
|
|
441
442
|
|
|
442
443
|
<div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code>gem <span class="nb">install</span> <span class="nt">-n</span> /usr/local/bin jekyll
|
|
443
444
|
</code></pre></div></div>
|
|
@@ -445,7 +446,7 @@ installed (again, using <code class="highlighter-rouge">sudo</code> only if nece
|
|
|
445
446
|
<p>Alternatively, Homebrew can be installed and used to set up Ruby. This can be
|
|
446
447
|
done as follows:</p>
|
|
447
448
|
|
|
448
|
-
<div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code>ruby <span class="nt">-e</span> <span class="s2">"</span><span class="
|
|
449
|
+
<div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code>ruby <span class="nt">-e</span> <span class="s2">"</span><span class="si">$(</span>curl <span class="nt">-fsSL</span> https://raw.githubusercontent.com/Homebrew/install/master/install<span class="si">)</span><span class="s2">"</span>
|
|
449
450
|
</code></pre></div></div>
|
|
450
451
|
|
|
451
452
|
<p>Once Homebrew is installed, the second step is easy:</p>
|
|
@@ -458,33 +459,33 @@ number of Ruby version managers (<a href="https://rvm.io">RVM</a>, <a href="http
|
|
|
458
459
|
which to install Jekyll.</p>
|
|
459
460
|
|
|
460
461
|
<p>If you elect to use one of the above methods to install Ruby, it might be
|
|
461
|
-
necessary to modify your <code class="highlighter-rouge">$PATH</code> variable using the following command:</p>
|
|
462
|
+
necessary to modify your <code class="language-plaintext highlighter-rouge">$PATH</code> variable using the following command:</p>
|
|
462
463
|
|
|
463
464
|
<div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nb">export </span><span class="nv">PATH</span><span class="o">=</span>/usr/local/bin:<span class="nv">$PATH</span>
|
|
464
465
|
</code></pre></div></div>
|
|
465
466
|
|
|
466
|
-
<p>GUI apps can modify the <code class="highlighter-rouge">$PATH</code> as follows:</p>
|
|
467
|
+
<p>GUI apps can modify the <code class="language-plaintext highlighter-rouge">$PATH</code> as follows:</p>
|
|
467
468
|
|
|
468
469
|
<div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code>launchctl setenv PATH <span class="s2">"/usr/local/bin:</span><span class="nv">$PATH</span><span class="s2">"</span>
|
|
469
470
|
</code></pre></div></div>
|
|
470
471
|
|
|
471
|
-
<p>Either of these approaches are useful because <code class="highlighter-rouge">/usr/local</code> is considered a
|
|
472
|
+
<p>Either of these approaches are useful because <code class="language-plaintext highlighter-rouge">/usr/local</code> is considered a
|
|
472
473
|
“safe” location on systems which have SIP enabled, they avoid potential
|
|
473
474
|
conflicts with the version of Ruby included by Apple, and it keeps Jekyll and
|
|
474
475
|
its dependencies in a sandboxed environment. This also has the added
|
|
475
|
-
benefit of not requiring <code class="highlighter-rouge">sudo</code> when you want to add or remove a gem.</p>
|
|
476
|
+
benefit of not requiring <code class="language-plaintext highlighter-rouge">sudo</code> when you want to add or remove a gem.</p>
|
|
476
477
|
|
|
477
478
|
<h3 id="could-not-find-a-javascript-runtime-execjsruntimeunavailable">Could not find a JavaScript runtime. (ExecJS::RuntimeUnavailable)</h3>
|
|
478
479
|
|
|
479
|
-
<p>This error can occur during the installation of <code class="highlighter-rouge">jekyll-coffeescript</code> when
|
|
480
|
+
<p>This error can occur during the installation of <code class="language-plaintext highlighter-rouge">jekyll-coffeescript</code> when
|
|
480
481
|
you don’t have a proper JavaScript runtime. To solve this, either install
|
|
481
|
-
<code class="highlighter-rouge">execjs</code> and <code class="highlighter-rouge">therubyracer</code> gems, or install <code class="highlighter-rouge">nodejs</code>. Check out
|
|
482
|
+
<code class="language-plaintext highlighter-rouge">execjs</code> and <code class="language-plaintext highlighter-rouge">therubyracer</code> gems, or install <code class="language-plaintext highlighter-rouge">nodejs</code>. Check out
|
|
482
483
|
<a href="https://github.com/jekyll/jekyll/issues/2327">issue #2327</a> for more info.</p>
|
|
483
484
|
|
|
484
485
|
<h2 id="problems-running-jekyll">Problems running Jekyll</h2>
|
|
485
486
|
|
|
486
|
-
<p>On Debian or Ubuntu, you may need to add <code class="highlighter-rouge">/var/lib/gems/1.8/bin/</code> to your path
|
|
487
|
-
in order to have the <code class="highlighter-rouge">jekyll</code> executable be available in your Terminal.</p>
|
|
487
|
+
<p>On Debian or Ubuntu, you may need to add <code class="language-plaintext highlighter-rouge">/var/lib/gems/1.8/bin/</code> to your path
|
|
488
|
+
in order to have the <code class="language-plaintext highlighter-rouge">jekyll</code> executable be available in your Terminal.</p>
|
|
488
489
|
|
|
489
490
|
<h2 id="base-url-problems">Base-URL Problems</h2>
|
|
490
491
|
|
|
@@ -495,12 +496,12 @@ in order to have the <code class="highlighter-rouge">jekyll</code> executable be
|
|
|
495
496
|
|
|
496
497
|
<p>… then make sure that you access the site at:</p>
|
|
497
498
|
|
|
498
|
-
<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>http://localhost:4000/blog/index.html
|
|
499
|
+
<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>http://localhost:4000/blog/index.html
|
|
499
500
|
</code></pre></div></div>
|
|
500
501
|
|
|
501
502
|
<p>It won’t work to just access:</p>
|
|
502
503
|
|
|
503
|
-
<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>http://localhost:4000/blog
|
|
504
|
+
<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>http://localhost:4000/blog
|
|
504
505
|
</code></pre></div></div>
|
|
505
506
|
|
|
506
507
|
<h2 id="configuration-problems">Configuration problems</h2>
|
|
@@ -514,11 +515,11 @@ is as follows:</p>
|
|
|
514
515
|
<li>Defaults</li>
|
|
515
516
|
</ol>
|
|
516
517
|
|
|
517
|
-
<p>That is: defaults are overridden by options specified in <code class="highlighter-rouge">_config.yml</code>,
|
|
518
|
+
<p>That is: defaults are overridden by options specified in <code class="language-plaintext highlighter-rouge">_config.yml</code>,
|
|
518
519
|
and flags specified at the command-line will override all other settings
|
|
519
520
|
specified elsewhere.</p>
|
|
520
521
|
|
|
521
|
-
<p><strong>Note: From v3.3.0 onward, Jekyll does not process <code class="highlighter-rouge">node_modules</code> and certain subdirectories within <code class="highlighter-rouge">vendor</code>, by default. But, by having an <code class="highlighter-rouge">exclude:</code> array defined explicitly in the config file overrides this default setting, which results in some users to encounter an error in building the site, with the following error message:</strong></p>
|
|
522
|
+
<p><strong>Note: From v3.3.0 onward, Jekyll does not process <code class="language-plaintext highlighter-rouge">node_modules</code> and certain subdirectories within <code class="language-plaintext highlighter-rouge">vendor</code>, by default. But, by having an <code class="language-plaintext highlighter-rouge">exclude:</code> array defined explicitly in the config file overrides this default setting, which results in some users to encounter an error in building the site, with the following error message:</strong></p>
|
|
522
523
|
|
|
523
524
|
<div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code> ERROR: YOUR SITE COULD NOT BE BUILT:
|
|
524
525
|
<span class="nt">------------------------------------</span>
|
|
@@ -527,11 +528,11 @@ specified elsewhere.</p>
|
|
|
527
528
|
does not have a valid <span class="nb">date </span><span class="k">in </span>the YAML front matter.
|
|
528
529
|
</code></pre></div></div>
|
|
529
530
|
|
|
530
|
-
<p>Simply adding <code class="highlighter-rouge">vendor/bundle</code> to the <code class="highlighter-rouge">exclude:</code> list will solve this problem but will lead to having other sub-directories under <code class="highlighter-rouge">/vendor/</code> (and also <code class="highlighter-rouge">/node_modules/</code>, if present) be processed to the destination folder <code class="highlighter-rouge">_site</code>.</p>
|
|
531
|
+
<p>Simply adding <code class="language-plaintext highlighter-rouge">vendor/bundle</code> to the <code class="language-plaintext highlighter-rouge">exclude:</code> list will solve this problem but will lead to having other sub-directories under <code class="language-plaintext highlighter-rouge">/vendor/</code> (and also <code class="language-plaintext highlighter-rouge">/node_modules/</code>, if present) be processed to the destination folder <code class="language-plaintext highlighter-rouge">_site</code>.</p>
|
|
531
532
|
|
|
532
|
-
<p>The proper solution is to incorporate the default setting for <code class="highlighter-rouge">exclude:</code> rather than override it completely:</p>
|
|
533
|
+
<p>The proper solution is to incorporate the default setting for <code class="language-plaintext highlighter-rouge">exclude:</code> rather than override it completely:</p>
|
|
533
534
|
|
|
534
|
-
<p>For versions upto <code class="highlighter-rouge">v3.4.3</code>, the <code class="highlighter-rouge">exclude:</code> setting must look like following:</p>
|
|
535
|
+
<p>For versions upto <code class="language-plaintext highlighter-rouge">v3.4.3</code>, the <code class="language-plaintext highlighter-rouge">exclude:</code> setting must look like following:</p>
|
|
535
536
|
|
|
536
537
|
<div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">exclude</span><span class="pi">:</span>
|
|
537
538
|
<span class="pi">-</span> <span class="s">Gemfile</span>
|
|
@@ -544,7 +545,7 @@ specified elsewhere.</p>
|
|
|
544
545
|
<span class="pi">-</span> <span class="s">any_additional_item</span> <span class="c1"># any user-specific listing goes at the end</span>
|
|
545
546
|
</code></pre></div></div>
|
|
546
547
|
|
|
547
|
-
<p>From <code class="highlighter-rouge">v3.5</code> onward, <code class="highlighter-rouge">Gemfile</code> and <code class="highlighter-rouge">Gemfile.lock</code> are also excluded by default. So, in most cases there is no need to define another <code class="highlighter-rouge">exclude:</code> array in the config file. So an existing definition can either be modified as above, or removed completely, or simply commented out to enable easy edits in future.</p>
|
|
548
|
+
<p>From <code class="language-plaintext highlighter-rouge">v3.5</code> onward, <code class="language-plaintext highlighter-rouge">Gemfile</code> and <code class="language-plaintext highlighter-rouge">Gemfile.lock</code> are also excluded by default. So, in most cases there is no need to define another <code class="language-plaintext highlighter-rouge">exclude:</code> array in the config file. So an existing definition can either be modified as above, or removed completely, or simply commented out to enable easy edits in future.</p>
|
|
548
549
|
|
|
549
550
|
<h2 id="markup-problems">Markup Problems</h2>
|
|
550
551
|
|
|
@@ -554,8 +555,8 @@ problems.</p>
|
|
|
554
555
|
|
|
555
556
|
<h3 id="liquid">Liquid</h3>
|
|
556
557
|
|
|
557
|
-
<p>Liquid version 2.0 seems to break the use of <code class="highlighter-rouge">{{</code> in templates.
|
|
558
|
-
Unlike previous versions, using <code class="highlighter-rouge">{{</code> in 2.0 triggers the following error:</p>
|
|
558
|
+
<p>Liquid version 2.0 seems to break the use of <code class="language-plaintext highlighter-rouge">{{</code> in templates.
|
|
559
|
+
Unlike previous versions, using <code class="language-plaintext highlighter-rouge">{{</code> in 2.0 triggers the following error:</p>
|
|
559
560
|
|
|
560
561
|
<div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="s1">'{{'</span> was not properly terminated with regexp: /<span class="se">\}\}</span>/ <span class="o">(</span>Liquid::SyntaxError<span class="o">)</span>
|
|
561
562
|
</code></pre></div></div>
|
|
@@ -565,14 +566,14 @@ Unlike previous versions, using <code class="highlighter-rouge">{{</code> in 2.0
|
|
|
565
566
|
<p>Since v1.0.0, Jekyll has had automatically-generated post excerpts. Since
|
|
566
567
|
v1.1.0, Jekyll also passes these excerpts through Liquid, which can cause
|
|
567
568
|
strange errors where references don’t exist or a tag hasn’t been closed. If you
|
|
568
|
-
run into these errors, try setting <code class="highlighter-rouge">excerpt_separator: ""</code> in your
|
|
569
|
-
<code class="highlighter-rouge">_config.yml</code>, or set it to some nonsense string.</p>
|
|
569
|
+
run into these errors, try setting <code class="language-plaintext highlighter-rouge">excerpt_separator: ""</code> in your
|
|
570
|
+
<code class="language-plaintext highlighter-rouge">_config.yml</code>, or set it to some nonsense string.</p>
|
|
570
571
|
|
|
571
572
|
<h2 id="production-problems">Production Problems</h2>
|
|
572
573
|
|
|
573
574
|
<p>If you run into an issue that a static file can’t be found in your
|
|
574
575
|
production environment during build since v3.2.0 you should set your
|
|
575
|
-
<a href="../configuration/#specifying-a-jekyll-environment-at-build-time">environment to <code class="highlighter-rouge">production</code></a>.
|
|
576
|
+
<a href="../configuration/#specifying-a-jekyll-environment-at-build-time">environment to <code class="language-plaintext highlighter-rouge">production</code></a>.
|
|
576
577
|
The issue is caused by trying to copy a non-existing symlink.</p>
|
|
577
578
|
|
|
578
579
|
<div class="note">
|
|
@@ -890,7 +891,7 @@ The issue is caused by trying to copy a non-existing symlink.</p>
|
|
|
890
891
|
<footer>
|
|
891
892
|
<div class="grid">
|
|
892
893
|
<div class="unit one-third center-on-mobiles">
|
|
893
|
-
<p>The contents of this website are <br />©
|
|
894
|
+
<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>
|
|
894
895
|
</div>
|
|
895
896
|
<div class="unit two-thirds align-right center-on-mobiles">
|
|
896
897
|
<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 from 0.x to 2.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 0.x to 2.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 1.0 and 2.0 that you’ll want to know about." />
|
|
@@ -22,12 +22,13 @@
|
|
|
22
22
|
<meta property="og:url" content="https://jekyllrb.com/docs/upgrading/0-to-2/" />
|
|
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 0.x to 2.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/0-to-2/","headline":"Upgrading from 0.x to 2.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 1.0 and 2.0 that you’ll want to know about.","mainEntityOfPage":{"@type":"WebPage","@id":"https://jekyllrb.com/docs/upgrading/0-to-2/"},"@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>
|
|
@@ -311,19 +312,19 @@ and 2.0 that you’ll want to know about.</p>
|
|
|
311
312
|
|
|
312
313
|
<h3 id="the-jekyll-command">The Jekyll Command</h3>
|
|
313
314
|
|
|
314
|
-
<p>For better clarity, Jekyll now accepts the commands <code class="highlighter-rouge">build</code> and <code class="highlighter-rouge">serve</code>.
|
|
315
|
-
Whereas before you might simply run the command <code class="highlighter-rouge">jekyll</code> to generate a site
|
|
316
|
-
and <code class="highlighter-rouge">jekyll --server</code> to view it locally, in v2.0 (and later) you should
|
|
317
|
-
use the subcommands <code class="highlighter-rouge">jekyll build</code> and <code class="highlighter-rouge">jekyll serve</code> to build and preview
|
|
315
|
+
<p>For better clarity, Jekyll now accepts the commands <code class="language-plaintext highlighter-rouge">build</code> and <code class="language-plaintext highlighter-rouge">serve</code>.
|
|
316
|
+
Whereas before you might simply run the command <code class="language-plaintext highlighter-rouge">jekyll</code> to generate a site
|
|
317
|
+
and <code class="language-plaintext highlighter-rouge">jekyll --server</code> to view it locally, in v2.0 (and later) you should
|
|
318
|
+
use the subcommands <code class="language-plaintext highlighter-rouge">jekyll build</code> and <code class="language-plaintext highlighter-rouge">jekyll serve</code> to build and preview
|
|
318
319
|
your site.</p>
|
|
319
320
|
|
|
320
321
|
<div class="note info">
|
|
321
322
|
<h5>Watching and Serving</h5>
|
|
322
323
|
<p>With the new subcommands, the way sites are previewed locally
|
|
323
|
-
changed a bit. Instead of specifying <code class="highlighter-rouge">server: true</code> in the site’s
|
|
324
|
-
configuration file, use <code class="highlighter-rouge">jekyll serve</code>. The same holds true for
|
|
325
|
-
<code class="highlighter-rouge">watch: true</code>. Instead, use the <code class="highlighter-rouge">--watch</code> flag with either <code class="highlighter-rouge">jekyll serve</code>
|
|
326
|
-
or <code class="highlighter-rouge">jekyll build</code>.</p>
|
|
324
|
+
changed a bit. Instead of specifying <code class="language-plaintext highlighter-rouge">server: true</code> in the site’s
|
|
325
|
+
configuration file, use <code class="language-plaintext highlighter-rouge">jekyll serve</code>. The same holds true for
|
|
326
|
+
<code class="language-plaintext highlighter-rouge">watch: true</code>. Instead, use the <code class="language-plaintext highlighter-rouge">--watch</code> flag with either <code class="language-plaintext highlighter-rouge">jekyll serve</code>
|
|
327
|
+
or <code class="language-plaintext highlighter-rouge">jekyll build</code>.</p>
|
|
327
328
|
</div>
|
|
328
329
|
|
|
329
330
|
<h3 id="absolute-permalinks">Absolute Permalinks</h3>
|
|
@@ -344,17 +345,17 @@ relative permalinks. Relative permalink backwards-compatibility was removed in v
|
|
|
344
345
|
|
|
345
346
|
<p>Jekyll now lets you write draft posts, and allows you to easily preview how
|
|
346
347
|
they will look prior to publishing. To start a draft, simply create a folder
|
|
347
|
-
called <code class="highlighter-rouge">_drafts</code> in your site’s source directory (e.g., alongside <code class="highlighter-rouge">_posts</code>),
|
|
348
|
+
called <code class="language-plaintext highlighter-rouge">_drafts</code> in your site’s source directory (e.g., alongside <code class="language-plaintext highlighter-rouge">_posts</code>),
|
|
348
349
|
and add a new markdown file to it. To preview your new post, simply run the
|
|
349
|
-
<code class="highlighter-rouge">jekyll serve</code> command with the <code class="highlighter-rouge">--drafts</code> flag.</p>
|
|
350
|
+
<code class="language-plaintext highlighter-rouge">jekyll serve</code> command with the <code class="language-plaintext highlighter-rouge">--drafts</code> flag.</p>
|
|
350
351
|
|
|
351
352
|
<div class="note info">
|
|
352
353
|
<h5>Drafts don’t have dates</h5>
|
|
353
354
|
<p>
|
|
354
355
|
Unlike posts, drafts don’t have a date, since they haven’t
|
|
355
356
|
been published yet. Rather than naming your draft something like
|
|
356
|
-
<code class="highlighter-rouge">2013-07-01-my-draft-post.md</code>, simply name the file what you’d like your
|
|
357
|
-
post to eventually be titled, here <code class="highlighter-rouge">my-draft-post.md</code>.</p>
|
|
357
|
+
<code class="language-plaintext highlighter-rouge">2013-07-01-my-draft-post.md</code>, simply name the file what you’d like your
|
|
358
|
+
post to eventually be titled, here <code class="language-plaintext highlighter-rouge">my-draft-post.md</code>.</p>
|
|
358
359
|
</div>
|
|
359
360
|
|
|
360
361
|
<h3 id="custom-config-file">Custom Config File</h3>
|
|
@@ -362,32 +363,32 @@ and add a new markdown file to it. To preview your new post, simply run the
|
|
|
362
363
|
<p>Rather than passing individual flags via the command line, you can now pass
|
|
363
364
|
an entire custom Jekyll config file. This helps to distinguish between
|
|
364
365
|
environments, or lets you programmatically override user-specified
|
|
365
|
-
defaults. Simply add the <code class="highlighter-rouge">--config</code> flag to the <code class="highlighter-rouge">jekyll</code> command, followed
|
|
366
|
+
defaults. Simply add the <code class="language-plaintext highlighter-rouge">--config</code> flag to the <code class="language-plaintext highlighter-rouge">jekyll</code> command, followed
|
|
366
367
|
by the path to one or more config files (comma-delimited, no spaces).</p>
|
|
367
368
|
|
|
368
369
|
<h4 id="as-a-result-the-following-command-line-flags-are-now-deprecated">As a result, the following command line flags are now deprecated:</h4>
|
|
369
370
|
|
|
370
371
|
<ul>
|
|
371
|
-
<li><code class="highlighter-rouge">--no-server</code></li>
|
|
372
|
-
<li><code class="highlighter-rouge">--no-auto</code> (now <code class="highlighter-rouge">--no-watch</code>)</li>
|
|
373
|
-
<li><code class="highlighter-rouge">--auto</code> (now <code class="highlighter-rouge">--watch</code>)</li>
|
|
374
|
-
<li><code class="highlighter-rouge">--server</code></li>
|
|
375
|
-
<li><code class="highlighter-rouge">--url=</code></li>
|
|
376
|
-
<li><code class="highlighter-rouge">--maruku</code>, <code class="highlighter-rouge">--rdiscount</code>, and <code class="highlighter-rouge">--redcarpet</code></li>
|
|
377
|
-
<li><code class="highlighter-rouge">--pygments</code></li>
|
|
378
|
-
<li><code class="highlighter-rouge">--permalink=</code></li>
|
|
379
|
-
<li><code class="highlighter-rouge">--paginate</code></li>
|
|
372
|
+
<li><code class="language-plaintext highlighter-rouge">--no-server</code></li>
|
|
373
|
+
<li><code class="language-plaintext highlighter-rouge">--no-auto</code> (now <code class="language-plaintext highlighter-rouge">--no-watch</code>)</li>
|
|
374
|
+
<li><code class="language-plaintext highlighter-rouge">--auto</code> (now <code class="language-plaintext highlighter-rouge">--watch</code>)</li>
|
|
375
|
+
<li><code class="language-plaintext highlighter-rouge">--server</code></li>
|
|
376
|
+
<li><code class="language-plaintext highlighter-rouge">--url=</code></li>
|
|
377
|
+
<li><code class="language-plaintext highlighter-rouge">--maruku</code>, <code class="language-plaintext highlighter-rouge">--rdiscount</code>, and <code class="language-plaintext highlighter-rouge">--redcarpet</code></li>
|
|
378
|
+
<li><code class="language-plaintext highlighter-rouge">--pygments</code></li>
|
|
379
|
+
<li><code class="language-plaintext highlighter-rouge">--permalink=</code></li>
|
|
380
|
+
<li><code class="language-plaintext highlighter-rouge">--paginate</code></li>
|
|
380
381
|
</ul>
|
|
381
382
|
|
|
382
383
|
<div class="note info">
|
|
383
384
|
<h5>The config flag explicitly specifies your configuration file(s)</h5>
|
|
384
|
-
<p>If you use the <code class="highlighter-rouge">--config</code> flag, Jekyll will ignore your
|
|
385
|
-
<code class="highlighter-rouge">_config.yml</code> file. Want to merge a custom configuration with the normal
|
|
385
|
+
<p>If you use the <code class="language-plaintext highlighter-rouge">--config</code> flag, Jekyll will ignore your
|
|
386
|
+
<code class="language-plaintext highlighter-rouge">_config.yml</code> file. Want to merge a custom configuration with the normal
|
|
386
387
|
configuration? No problem. Jekyll will accept more than one custom config
|
|
387
388
|
file via the command line. Config files cascade from right to left, such
|
|
388
|
-
that if I run <code class="highlighter-rouge">jekyll serve --config _config.yml,_config-dev.yml</code>,
|
|
389
|
-
the values in the config files on the right (<code class="highlighter-rouge">_config-dev.yml</code>) overwrite
|
|
390
|
-
those on the left (<code class="highlighter-rouge">_config.yml</code>) when both contain the same key.</p>
|
|
389
|
+
that if I run <code class="language-plaintext highlighter-rouge">jekyll serve --config _config.yml,_config-dev.yml</code>,
|
|
390
|
+
the values in the config files on the right (<code class="language-plaintext highlighter-rouge">_config-dev.yml</code>) overwrite
|
|
391
|
+
those on the left (<code class="language-plaintext highlighter-rouge">_config.yml</code>) when both contain the same key.</p>
|
|
391
392
|
</div>
|
|
392
393
|
|
|
393
394
|
<h3 id="new-config-file-options">New Config File Options</h3>
|
|
@@ -397,26 +398,26 @@ you should check to see if any of these are present in your pre-1.0 config
|
|
|
397
398
|
file, and if so, make sure that you’re using them properly:</p>
|
|
398
399
|
|
|
399
400
|
<ul>
|
|
400
|
-
<li><code class="highlighter-rouge">excerpt_separator</code></li>
|
|
401
|
-
<li><code class="highlighter-rouge">host</code></li>
|
|
402
|
-
<li><code class="highlighter-rouge">include</code></li>
|
|
403
|
-
<li><code class="highlighter-rouge">keep_files</code></li>
|
|
404
|
-
<li><code class="highlighter-rouge">layouts</code></li>
|
|
405
|
-
<li><code class="highlighter-rouge">show_drafts</code></li>
|
|
406
|
-
<li><code class="highlighter-rouge">timezone</code></li>
|
|
407
|
-
<li><code class="highlighter-rouge">url</code></li>
|
|
401
|
+
<li><code class="language-plaintext highlighter-rouge">excerpt_separator</code></li>
|
|
402
|
+
<li><code class="language-plaintext highlighter-rouge">host</code></li>
|
|
403
|
+
<li><code class="language-plaintext highlighter-rouge">include</code></li>
|
|
404
|
+
<li><code class="language-plaintext highlighter-rouge">keep_files</code></li>
|
|
405
|
+
<li><code class="language-plaintext highlighter-rouge">layouts</code></li>
|
|
406
|
+
<li><code class="language-plaintext highlighter-rouge">show_drafts</code></li>
|
|
407
|
+
<li><code class="language-plaintext highlighter-rouge">timezone</code></li>
|
|
408
|
+
<li><code class="language-plaintext highlighter-rouge">url</code></li>
|
|
408
409
|
</ul>
|
|
409
410
|
|
|
410
411
|
<h3 id="baseurl">Baseurl</h3>
|
|
411
412
|
|
|
412
413
|
<p>Often, you’ll want the ability to run a Jekyll site in multiple places,
|
|
413
414
|
such as previewing locally before pushing to GitHub Pages. Jekyll 1.0 makes
|
|
414
|
-
that easier with the new <code class="highlighter-rouge">--baseurl</code> flag. To take advantage of this
|
|
415
|
-
feature, first add the production <code class="highlighter-rouge">baseurl</code> to your site’s <code class="highlighter-rouge">_config.yml</code>
|
|
415
|
+
that easier with the new <code class="language-plaintext highlighter-rouge">--baseurl</code> flag. To take advantage of this
|
|
416
|
+
feature, first add the production <code class="language-plaintext highlighter-rouge">baseurl</code> to your site’s <code class="language-plaintext highlighter-rouge">_config.yml</code>
|
|
416
417
|
file. Then, throughout the site, simply prefix relative URLs
|
|
417
|
-
with <code class="highlighter-rouge">{{ site.baseurl }}</code>.
|
|
418
|
-
When you’re ready to preview your site locally, pass along the <code class="highlighter-rouge">--baseurl</code>
|
|
419
|
-
flag with your local baseurl (most likely <code class="highlighter-rouge">/</code>) to <code class="highlighter-rouge">jekyll serve</code> and Jekyll
|
|
418
|
+
with <code class="language-plaintext highlighter-rouge">{{ site.baseurl }}</code>.
|
|
419
|
+
When you’re ready to preview your site locally, pass along the <code class="language-plaintext highlighter-rouge">--baseurl</code>
|
|
420
|
+
flag with your local baseurl (most likely <code class="language-plaintext highlighter-rouge">/</code>) to <code class="language-plaintext highlighter-rouge">jekyll serve</code> and Jekyll
|
|
420
421
|
will swap in whatever you’ve passed along, ensuring all your links work as
|
|
421
422
|
you’d expect in both environments.</p>
|
|
422
423
|
|
|
@@ -425,10 +426,10 @@ you’d expect in both environments.</p>
|
|
|
425
426
|
<p>If you use the method described above, please remember
|
|
426
427
|
that the URLs for all posts and pages contain a leading slash. Therefore,
|
|
427
428
|
concatenating the site baseurl and the post/page url where
|
|
428
|
-
<code class="highlighter-rouge">site.baseurl = /</code> and <code class="highlighter-rouge">post.url = /2013/06/05/my-fun-post/</code> will
|
|
429
|
+
<code class="language-plaintext highlighter-rouge">site.baseurl = /</code> and <code class="language-plaintext highlighter-rouge">post.url = /2013/06/05/my-fun-post/</code> will
|
|
429
430
|
result in two leading slashes, which will break links. It is thus
|
|
430
|
-
suggested that prefixing with <code class="highlighter-rouge">site.baseurl</code> only be used when the
|
|
431
|
-
<code class="highlighter-rouge">baseurl</code> is something other than the default of <code class="highlighter-rouge">/</code>.</p>
|
|
431
|
+
suggested that prefixing with <code class="language-plaintext highlighter-rouge">site.baseurl</code> only be used when the
|
|
432
|
+
<code class="language-plaintext highlighter-rouge">baseurl</code> is something other than the default of <code class="language-plaintext highlighter-rouge">/</code>.</p>
|
|
432
433
|
</div>
|
|
433
434
|
|
|
434
435
|
|
|
@@ -746,7 +747,7 @@ you’d expect in both environments.</p>
|
|
|
746
747
|
<footer>
|
|
747
748
|
<div class="grid">
|
|
748
749
|
<div class="unit one-third center-on-mobiles">
|
|
749
|
-
<p>The contents of this website are <br />©
|
|
750
|
+
<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>
|
|
750
751
|
</div>
|
|
751
752
|
<div class="unit two-thirds align-right center-on-mobiles">
|
|
752
753
|
<p>
|