jekyll-docs 3.8.5 → 3.9.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/site/404.html +5 -4
- data/site/docs/assets/index.html +22 -21
- 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 +68 -67
- 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 +34 -33
- 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 +19 -18
- data/site/docs/history/index.html +674 -645
- data/site/docs/home/index.html +8 -7
- data/site/docs/includes/index.html +44 -43
- data/site/docs/installation/index.html +16 -15
- data/site/docs/maintaining/affinity-team-captain/index.html +11 -10
- data/site/docs/maintaining/avoiding-burnout/index.html +8 -7
- data/site/docs/maintaining/becoming-a-maintainer/index.html +9 -8
- data/site/docs/maintaining/index.html +8 -7
- data/site/docs/maintaining/merging-a-pull-request/index.html +23 -22
- data/site/docs/maintaining/releasing-a-new-version/index.html +19 -18
- data/site/docs/maintaining/reviewing-a-pull-request/index.html +10 -9
- data/site/docs/maintaining/special-labels/index.html +14 -13
- data/site/docs/maintaining/triaging-an-issue/index.html +12 -11
- 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 +57 -56
- data/site/docs/posts/index.html +37 -36
- 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 +63 -62
- 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 +45 -41
- data/site/help/index.html +7 -6
- data/site/index.html +7 -6
- 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 +16 -10
- data/site/news/2013/05/08/jekyll-1-0-1-released/index.html +18 -12
- data/site/news/2013/05/12/jekyll-1-0-2-released/index.html +19 -13
- data/site/news/2013/06/07/jekyll-1-0-3-released/index.html +20 -14
- data/site/news/2013/07/14/jekyll-1-1-0-released/index.html +19 -13
- data/site/news/2013/07/24/jekyll-1-1-1-released/index.html +16 -10
- data/site/news/2013/07/25/jekyll-1-0-4-released/index.html +18 -12
- data/site/news/2013/07/25/jekyll-1-1-2-released/index.html +18 -12
- data/site/news/2013/09/06/jekyll-1-2-0-released/index.html +21 -15
- data/site/news/2013/09/14/jekyll-1-2-1-released/index.html +19 -13
- data/site/news/2013/10/28/jekyll-1-3-0-rc1-released/index.html +16 -10
- data/site/news/2013/11/04/jekyll-1-3-0-released/index.html +25 -19
- data/site/news/2013/11/26/jekyll-1-3-1-released/index.html +17 -11
- data/site/news/2013/12/07/jekyll-1-4-0-released/index.html +17 -11
- data/site/news/2013/12/09/jekyll-1-4-1-released/index.html +16 -10
- data/site/news/2013/12/16/jekyll-1-4-2-released/index.html +18 -12
- data/site/news/2014/01/13/jekyll-1-4-3-released/index.html +17 -11
- data/site/news/2014/03/24/jekyll-1-5-0-released/index.html +17 -11
- data/site/news/2014/03/27/jekyll-1-5-1-released/index.html +17 -11
- data/site/news/2014/05/06/jekyll-turns-2-0-0/index.html +20 -14
- data/site/news/2014/05/08/jekyll-2-0-3-released/index.html +16 -10
- data/site/news/2014/06/04/jekyll-stickers-1-dollar-stickermule/index.html +16 -10
- data/site/news/2014/06/28/jekyll-turns-21-i-mean-2-1-0/index.html +21 -15
- data/site/news/2014/07/01/jekyll-2-1-1-released/index.html +18 -12
- data/site/news/2014/07/29/jekyll-2-2-0-released/index.html +17 -11
- data/site/news/2014/08/10/jekyll-2-3-0-released/index.html +24 -18
- data/site/news/2014/09/09/jekyll-2-4-0-released/index.html +23 -17
- data/site/news/2014/11/05/jekylls-midlife-crisis-jekyll-turns-2-5-0/index.html +22 -16
- data/site/news/2014/11/09/jekyll-2-5-1-released/index.html +16 -10
- data/site/news/2014/11/12/jekyll-2-5-2-released/index.html +18 -12
- data/site/news/2014/12/17/alfredxing-welcome-to-jekyll-core/index.html +16 -10
- data/site/news/2014/12/22/jekyll-2-5-3-released/index.html +16 -10
- data/site/news/2015/01/20/jekyll-meet-and-greet/index.html +16 -10
- data/site/news/2015/01/24/jekyll-3-0-0-beta1-released/index.html +16 -10
- data/site/news/2015/02/26/introducing-jekyll-talk/index.html +16 -10
- data/site/news/2015/10/26/jekyll-3-0-released/index.html +21 -15
- data/site/news/2015/11/17/jekyll-3-0-1-released/index.html +20 -14
- data/site/news/2016/01/20/jekyll-3-0-2-released/index.html +18 -12
- data/site/news/2016/01/24/jekyll-3-1-0-released/index.html +21 -15
- data/site/news/2016/01/28/jekyll-3-1-1-released/index.html +21 -15
- data/site/news/2016/02/08/jekyll-3-0-3-released/index.html +17 -11
- data/site/news/2016/02/19/jekyll-3-1-2-released/index.html +18 -12
- data/site/news/2016/03/10/making-it-easier-to-contribute-to-jekyll/index.html +16 -10
- data/site/news/2016/04/19/jekyll-3-0-4-released/index.html +17 -11
- data/site/news/2016/04/19/jekyll-3-1-3-released/index.html +17 -11
- data/site/news/2016/04/26/jekyll-3-0-5-released/index.html +16 -10
- data/site/news/2016/05/18/jekyll-3-1-4-released/index.html +22 -16
- data/site/news/2016/05/18/jekyll-3-1-5-released/index.html +17 -11
- data/site/news/2016/05/19/jekyll-3-1-6-released/index.html +17 -11
- data/site/news/2016/06/03/update-on-jekyll-s-google-summer-of-code-projects/index.html +16 -10
- data/site/news/2016/07/26/jekyll-3-2-0-released/index.html +20 -14
- data/site/news/2016/08/02/jekyll-3-2-1-released/index.html +17 -11
- data/site/news/2016/08/24/jekyll-admin-initial-release/index.html +16 -10
- data/site/news/2016/10/06/jekyll-3-3-is-here/index.html +42 -36
- data/site/news/2016/11/14/jekyll-3-3-1-released/index.html +17 -11
- data/site/news/2017/01/18/jekyll-3-4-0-released/index.html +18 -12
- data/site/news/2017/03/02/jekyll-3-4-1-released/index.html +17 -11
- data/site/news/2017/03/09/jekyll-3-4-2-released/index.html +21 -15
- data/site/news/2017/03/21/jekyll-3-4-3-released/index.html +26 -20
- data/site/news/2017/06/15/jekyll-3-5-0-released/index.html +25 -19
- data/site/news/2017/07/17/jekyll-3-5-1-released/index.html +18 -12
- data/site/news/2017/08/12/jekyll-3-5-2-released/index.html +21 -15
- data/site/news/2017/09/21/jekyll-3-6-0-released/index.html +17 -11
- data/site/news/2017/10/19/diversity-open-source/index.html +18 -12
- data/site/news/2017/10/21/jekyll-3-6-2-released/index.html +18 -12
- data/site/news/2018/01/02/jekyll-3-7-0-released/index.html +21 -15
- data/site/news/2018/01/25/jekyll-3-7-2-released/index.html +26 -20
- data/site/news/2018/02/19/meet-jekyll-s-new-lead-developer/index.html +16 -10
- data/site/news/2018/02/24/jekyll-3-7-3-released/index.html +22 -16
- data/site/news/2018/05/01/jekyll-3-8-1-released/index.html +19 -13
- data/site/news/2018/05/19/jekyll-3-8-2-released/index.html +17 -11
- data/site/news/2018/06/05/jekyll-3-8-3-released/index.html +19 -13
- data/site/news/2019/07/02/jekyll-3-8-6-released/index.html +623 -0
- data/site/news/index.html +263 -218
- data/site/news/releases/index.html +261 -216
- data/site/philosophy.html +1 -1
- data/site/sitemap.xml +61 -57
- data/site/team/index.html +7 -6
- 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/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 +10 -24
|
@@ -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>Code of Conduct | 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="Code of Conduct" />
|
|
18
18
|
<meta property="og:locale" content="en_US" />
|
|
19
19
|
<meta name="description" content="As contributors and maintainers of this project, and in the interest of fostering an open and welcoming community, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities." />
|
|
@@ -22,12 +22,13 @@
|
|
|
22
22
|
<meta property="og:url" content="https://jekyllrb.com/docs/conduct/" />
|
|
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="Code of Conduct" />
|
|
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
|
-
{"headline":"Code of Conduct","dateModified":"
|
|
31
|
+
{"url":"https://jekyllrb.com/docs/conduct/","headline":"Code of Conduct","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":"As contributors and maintainers of this project, and in the interest of fostering an open and welcoming community, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.","mainEntityOfPage":{"@type":"WebPage","@id":"https://jekyllrb.com/docs/conduct/"},"@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>
|
|
@@ -668,7 +669,7 @@ version 1.3.0, available at
|
|
|
668
669
|
<footer>
|
|
669
670
|
<div class="grid">
|
|
670
671
|
<div class="unit one-third center-on-mobiles">
|
|
671
|
-
<p>The contents of this website are <br />©
|
|
672
|
+
<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>
|
|
672
673
|
</div>
|
|
673
674
|
<div class="unit two-thirds align-right center-on-mobiles">
|
|
674
675
|
<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>Configuration | 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="Configuration" />
|
|
18
18
|
<meta property="og:locale" content="en_US" />
|
|
19
19
|
<meta name="description" content="Jekyll allows you to concoct your sites in any way you can dream up, and it’s thanks to the powerful and flexible configuration options that this is possible. These options can either be specified in a _config.yml file placed in your site’s root directory, or can be specified as flags for the jekyll executable in the terminal." />
|
|
@@ -22,12 +22,13 @@
|
|
|
22
22
|
<meta property="og:url" content="https://jekyllrb.com/docs/configuration/" />
|
|
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="Configuration" />
|
|
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
|
-
{"headline":"Configuration","dateModified":"
|
|
31
|
+
{"url":"https://jekyllrb.com/docs/configuration/","headline":"Configuration","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 allows you to concoct your sites in any way you can dream up, and it’s thanks to the powerful and flexible configuration options that this is possible. These options can either be specified in a _config.yml file placed in your site’s root directory, or can be specified as flags for the jekyll executable in the terminal.","mainEntityOfPage":{"@type":"WebPage","@id":"https://jekyllrb.com/docs/configuration/"},"@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>
|
|
@@ -296,8 +297,8 @@
|
|
|
296
297
|
<h1>Configuration</h1>
|
|
297
298
|
<p>Jekyll allows you to concoct your sites in any way you can dream up, and it’s
|
|
298
299
|
thanks to the powerful and flexible configuration options that this is possible.
|
|
299
|
-
These options can either be specified in a <code class="highlighter-rouge">_config.yml</code> file placed in your
|
|
300
|
-
site’s root directory, or can be specified as flags for the <code class="highlighter-rouge">jekyll</code> executable
|
|
300
|
+
These options can either be specified in a <code class="language-plaintext highlighter-rouge">_config.yml</code> file placed in your
|
|
301
|
+
site’s root directory, or can be specified as flags for the <code class="language-plaintext highlighter-rouge">jekyll</code> executable
|
|
301
302
|
in the terminal.</p>
|
|
302
303
|
|
|
303
304
|
<h2 id="configuration-settings">Configuration Settings</h2>
|
|
@@ -614,8 +615,8 @@ in the terminal.</p>
|
|
|
614
615
|
|
|
615
616
|
<h3 id="serve-command-options">Serve Command Options</h3>
|
|
616
617
|
|
|
617
|
-
<p>In addition to the options below, the <code class="highlighter-rouge">serve</code> sub-command can accept any of the options
|
|
618
|
-
for the <code class="highlighter-rouge">build</code> sub-command, which are then applied to the site build which occurs right
|
|
618
|
+
<p>In addition to the options below, the <code class="language-plaintext highlighter-rouge">serve</code> sub-command can accept any of the options
|
|
619
|
+
for the <code class="language-plaintext highlighter-rouge">build</code> sub-command, which are then applied to the site build which occurs right
|
|
619
620
|
before your site is served.</p>
|
|
620
621
|
|
|
621
622
|
<div class="mobile-side-scroller">
|
|
@@ -710,7 +711,7 @@ before your site is served.</p>
|
|
|
710
711
|
|
|
711
712
|
<h2 id="custom-webrick-headers">Custom WEBrick Headers</h2>
|
|
712
713
|
|
|
713
|
-
<p>You can provide custom headers for your site by adding them to <code class="highlighter-rouge">_config.yml</code></p>
|
|
714
|
+
<p>You can provide custom headers for your site by adding them to <code class="language-plaintext highlighter-rouge">_config.yml</code></p>
|
|
714
715
|
|
|
715
716
|
<div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="c1"># File: _config.yml</span>
|
|
716
717
|
<span class="na">webrick</span><span class="pi">:</span>
|
|
@@ -721,7 +722,7 @@ before your site is served.</p>
|
|
|
721
722
|
|
|
722
723
|
<h3 id="defaults">Defaults</h3>
|
|
723
724
|
|
|
724
|
-
<p>We provide by default <code class="highlighter-rouge">Content-Type</code> and <code class="highlighter-rouge">Cache-Control</code> response headers: one
|
|
725
|
+
<p>We provide by default <code class="language-plaintext highlighter-rouge">Content-Type</code> and <code class="language-plaintext highlighter-rouge">Cache-Control</code> response headers: one
|
|
725
726
|
dynamic in order to specify the nature of the data being served, the other
|
|
726
727
|
static in order to disable caching so that you don’t have to fight with Chrome’s
|
|
727
728
|
aggressive caching when you are in development mode.</p>
|
|
@@ -734,21 +735,21 @@ aggressive caching when you are in development mode.</p>
|
|
|
734
735
|
|
|
735
736
|
<div class="language-liquid highlighter-rouge"><div class="highlight"><pre class="highlight"><code>
|
|
736
737
|
<span class="p">{%</span><span class="w"> </span><span class="kr">if</span><span class="w"> </span><span class="nv">jekyll</span><span class="p">.</span><span class="nv">environment</span><span class="w"> </span><span class="o">==</span><span class="w"> </span><span class="s2">"production"</span><span class="w"> </span><span class="p">%}</span>
|
|
737
|
-
<span class="p">{%</span><span class="w"> </span><span class="nt">include</span><span class="w"> </span
|
|
738
|
+
<span class="p">{%</span><span class="w"> </span><span class="nt">include</span><span class="w"> </span>disqus.html<span class="w"> </span><span class="p">%}</span>
|
|
738
739
|
<span class="p">{%</span><span class="w"> </span><span class="kr">endif</span><span class="w"> </span><span class="p">%}</span>
|
|
739
740
|
|
|
740
741
|
</code></pre></div></div>
|
|
741
742
|
|
|
742
|
-
<p>When you build your Jekyll site, the content inside the <code class="highlighter-rouge">if</code> statement won’t be run unless you also specify a <code class="highlighter-rouge">production</code> environment in the build command, like this:</p>
|
|
743
|
+
<p>When you build your Jekyll site, the content inside the <code class="language-plaintext highlighter-rouge">if</code> statement won’t be run unless you also specify a <code class="language-plaintext highlighter-rouge">production</code> environment in the build command, like this:</p>
|
|
743
744
|
|
|
744
745
|
<div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">JEKYLL_ENV</span><span class="o">=</span>production jekyll build
|
|
745
746
|
</code></pre></div></div>
|
|
746
747
|
|
|
747
748
|
<p>Specifying an environment value allows you to make certain content available only within specific environments.</p>
|
|
748
749
|
|
|
749
|
-
<p>The default value for <code class="highlighter-rouge">JEKYLL_ENV</code> is <code class="highlighter-rouge">development</code>. Therefore if you omit <code class="highlighter-rouge">JEKYLL_ENV</code> from the build arguments, the default value will be <code class="highlighter-rouge">JEKYLL_ENV=development</code>. Any content inside <code class="highlighter-rouge">{% if jekyll.environment == "development" %}</code> tags will automatically appear in the build.</p>
|
|
750
|
+
<p>The default value for <code class="language-plaintext highlighter-rouge">JEKYLL_ENV</code> is <code class="language-plaintext highlighter-rouge">development</code>. Therefore if you omit <code class="language-plaintext highlighter-rouge">JEKYLL_ENV</code> from the build arguments, the default value will be <code class="language-plaintext highlighter-rouge">JEKYLL_ENV=development</code>. Any content inside <code class="language-plaintext highlighter-rouge">{% if jekyll.environment == "development" %}</code> tags will automatically appear in the build.</p>
|
|
750
751
|
|
|
751
|
-
<p>Your environment values can be anything you want (not just <code class="highlighter-rouge">development</code> or <code class="highlighter-rouge">production</code>). Some elements you might want to hide in development environments include Disqus comment forms or Google Analytics. Conversely, you might want to expose an “Edit me in GitHub” button in a development environment but not include it in production environments.</p>
|
|
752
|
+
<p>Your environment values can be anything you want (not just <code class="language-plaintext highlighter-rouge">development</code> or <code class="language-plaintext highlighter-rouge">production</code>). Some elements you might want to hide in development environments include Disqus comment forms or Google Analytics. Conversely, you might want to expose an “Edit me in GitHub” button in a development environment but not include it in production environments.</p>
|
|
752
753
|
|
|
753
754
|
<p>By specifying the option in the build command, you avoid having to change values in your configuration files when moving from one environment to another.</p>
|
|
754
755
|
|
|
@@ -758,11 +759,11 @@ aggressive caching when you are in development mode.</p>
|
|
|
758
759
|
|
|
759
760
|
<p>Often times, you will find that you are repeating a lot of configuration options. Setting the same layout in each file, adding the same category - or categories - to a post, etc. You can even add custom variables like author names, which might be the same for the majority of posts on your blog.</p>
|
|
760
761
|
|
|
761
|
-
<p>Instead of repeating this configuration each time you create a new post or page, Jekyll provides a way to set these defaults in the site configuration. To do this, you can specify site-wide defaults using the <code class="highlighter-rouge">defaults</code> key in the <code class="highlighter-rouge">_config.yml</code> file in your project’s root directory.</p>
|
|
762
|
+
<p>Instead of repeating this configuration each time you create a new post or page, Jekyll provides a way to set these defaults in the site configuration. To do this, you can specify site-wide defaults using the <code class="language-plaintext highlighter-rouge">defaults</code> key in the <code class="language-plaintext highlighter-rouge">_config.yml</code> file in your project’s root directory.</p>
|
|
762
763
|
|
|
763
|
-
<p>The <code class="highlighter-rouge">defaults</code> key holds an array of scope/values pairs that define what defaults should be set for a particular file path, and optionally, a file type in that path.</p>
|
|
764
|
+
<p>The <code class="language-plaintext highlighter-rouge">defaults</code> key holds an array of scope/values pairs that define what defaults should be set for a particular file path, and optionally, a file type in that path.</p>
|
|
764
765
|
|
|
765
|
-
<p>Let’s say that you want to add a default layout to all pages and posts in your site. You would add this to your <code class="highlighter-rouge">_config.yml</code> file:</p>
|
|
766
|
+
<p>Let’s say that you want to add a default layout to all pages and posts in your site. You would add this to your <code class="language-plaintext highlighter-rouge">_config.yml</code> file:</p>
|
|
766
767
|
|
|
767
768
|
<div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">defaults</span><span class="pi">:</span>
|
|
768
769
|
<span class="pi">-</span>
|
|
@@ -784,7 +785,7 @@ aggressive caching when you are in development mode.</p>
|
|
|
784
785
|
</p>
|
|
785
786
|
</div>
|
|
786
787
|
|
|
787
|
-
<p>Here, we are scoping the <code class="highlighter-rouge">values</code> to any file that exists in the path <code class="highlighter-rouge">scope</code>. Since the path is set as an empty string, it will apply to <strong>all files</strong> in your project. You probably don’t want to set a layout on every file in your project - like css files, for example - so you can also specify a <code class="highlighter-rouge">type</code> value under the <code class="highlighter-rouge">scope</code> key.</p>
|
|
788
|
+
<p>Here, we are scoping the <code class="language-plaintext highlighter-rouge">values</code> to any file that exists in the path <code class="language-plaintext highlighter-rouge">scope</code>. Since the path is set as an empty string, it will apply to <strong>all files</strong> in your project. You probably don’t want to set a layout on every file in your project - like css files, for example - so you can also specify a <code class="language-plaintext highlighter-rouge">type</code> value under the <code class="language-plaintext highlighter-rouge">scope</code> key.</p>
|
|
788
789
|
|
|
789
790
|
<div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">defaults</span><span class="pi">:</span>
|
|
790
791
|
<span class="pi">-</span>
|
|
@@ -795,10 +796,10 @@ aggressive caching when you are in development mode.</p>
|
|
|
795
796
|
<span class="na">layout</span><span class="pi">:</span> <span class="s2">"</span><span class="s">default"</span>
|
|
796
797
|
</code></pre></div></div>
|
|
797
798
|
|
|
798
|
-
<p>Now, this will only set the layout for files where the type is <code class="highlighter-rouge">posts</code>.
|
|
799
|
-
The different types that are available to you are <code class="highlighter-rouge">pages</code>, <code class="highlighter-rouge">posts</code>, <code class="highlighter-rouge">drafts</code> or any collection in your site. While <code class="highlighter-rouge">type</code> is optional, you must specify a value for <code class="highlighter-rouge">path</code> when creating a <code class="highlighter-rouge">scope/values</code> pair.</p>
|
|
799
|
+
<p>Now, this will only set the layout for files where the type is <code class="language-plaintext highlighter-rouge">posts</code>.
|
|
800
|
+
The different types that are available to you are <code class="language-plaintext highlighter-rouge">pages</code>, <code class="language-plaintext highlighter-rouge">posts</code>, <code class="language-plaintext highlighter-rouge">drafts</code> or any collection in your site. While <code class="language-plaintext highlighter-rouge">type</code> is optional, you must specify a value for <code class="language-plaintext highlighter-rouge">path</code> when creating a <code class="language-plaintext highlighter-rouge">scope/values</code> pair.</p>
|
|
800
801
|
|
|
801
|
-
<p>As mentioned earlier, you can set multiple scope/values pairs for <code class="highlighter-rouge">defaults</code>.</p>
|
|
802
|
+
<p>As mentioned earlier, you can set multiple scope/values pairs for <code class="language-plaintext highlighter-rouge">defaults</code>.</p>
|
|
802
803
|
|
|
803
804
|
<div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">defaults</span><span class="pi">:</span>
|
|
804
805
|
<span class="pi">-</span>
|
|
@@ -816,7 +817,7 @@ The different types that are available to you are <code class="highlighter-rouge
|
|
|
816
817
|
<span class="na">author</span><span class="pi">:</span> <span class="s2">"</span><span class="s">Mr.</span><span class="nv"> </span><span class="s">Hyde"</span>
|
|
817
818
|
</code></pre></div></div>
|
|
818
819
|
|
|
819
|
-
<p>With these defaults, all pages would use the <code class="highlighter-rouge">my-site</code> layout. Any html files that exist in the <code class="highlighter-rouge">projects/</code> folder will use the <code class="highlighter-rouge">project</code> layout, if it exists. Those files will also have the <code class="highlighter-rouge">page.author</code> <a href="../variables/">liquid variable</a> set to <code class="highlighter-rouge">Mr. Hyde</code>.</p>
|
|
820
|
+
<p>With these defaults, all pages would use the <code class="language-plaintext highlighter-rouge">my-site</code> layout. Any html files that exist in the <code class="language-plaintext highlighter-rouge">projects/</code> folder will use the <code class="language-plaintext highlighter-rouge">project</code> layout, if it exists. Those files will also have the <code class="language-plaintext highlighter-rouge">page.author</code> <a href="../variables/">liquid variable</a> set to <code class="language-plaintext highlighter-rouge">Mr. Hyde</code>.</p>
|
|
820
821
|
|
|
821
822
|
<div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">collections</span><span class="pi">:</span>
|
|
822
823
|
<span class="na">my_collection</span><span class="pi">:</span>
|
|
@@ -831,12 +832,12 @@ The different types that are available to you are <code class="highlighter-rouge
|
|
|
831
832
|
<span class="na">layout</span><span class="pi">:</span> <span class="s2">"</span><span class="s">default"</span>
|
|
832
833
|
</code></pre></div></div>
|
|
833
834
|
|
|
834
|
-
<p>In this example, the <code class="highlighter-rouge">layout</code> is set to <code class="highlighter-rouge">default</code> inside the
|
|
835
|
-
<a href="../collections/">collection</a> with the name <code class="highlighter-rouge">my_collection</code>.</p>
|
|
835
|
+
<p>In this example, the <code class="language-plaintext highlighter-rouge">layout</code> is set to <code class="language-plaintext highlighter-rouge">default</code> inside the
|
|
836
|
+
<a href="../collections/">collection</a> with the name <code class="language-plaintext highlighter-rouge">my_collection</code>.</p>
|
|
836
837
|
|
|
837
838
|
<h3 id="glob-patterns-in-front-matter-defaults">Glob patterns in Front Matter defaults</h3>
|
|
838
839
|
|
|
839
|
-
<p>It is also possible to use glob patterns (currently limited to patterns that contain <code class="highlighter-rouge">*</code>) when matching defaults. For example, it is possible to set specific layout for each <code class="highlighter-rouge">special-page.html</code> in any subfolder of <code class="highlighter-rouge">section</code> folder.<span class="version-badge" title="This feature is available starting version 3.7.0">3.7.0</span></p>
|
|
840
|
+
<p>It is also possible to use glob patterns (currently limited to patterns that contain <code class="language-plaintext highlighter-rouge">*</code>) when matching defaults. For example, it is possible to set specific layout for each <code class="language-plaintext highlighter-rouge">special-page.html</code> in any subfolder of <code class="language-plaintext highlighter-rouge">section</code> folder.<span class="version-badge" title="This feature is available starting version 3.7.0">3.7.0</span></p>
|
|
840
841
|
<div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">collections</span><span class="pi">:</span>
|
|
841
842
|
<span class="na">my_collection</span><span class="pi">:</span>
|
|
842
843
|
<span class="na">output</span><span class="pi">:</span> <span class="no">true</span>
|
|
@@ -861,11 +862,11 @@ The different types that are available to you are <code class="highlighter-rouge
|
|
|
861
862
|
|
|
862
863
|
<h3 id="precedence">Precedence</h3>
|
|
863
864
|
|
|
864
|
-
<p>Jekyll will apply all of the configuration settings you specify in the <code class="highlighter-rouge">defaults</code> section of your <code class="highlighter-rouge">_config.yml</code> file. However, you can choose to override settings from other scope/values pair by specifying a more specific path for the scope.</p>
|
|
865
|
+
<p>Jekyll will apply all of the configuration settings you specify in the <code class="language-plaintext highlighter-rouge">defaults</code> section of your <code class="language-plaintext highlighter-rouge">_config.yml</code> file. However, you can choose to override settings from other scope/values pair by specifying a more specific path for the scope.</p>
|
|
865
866
|
|
|
866
|
-
<p>You can see that in the second to last example above. First, we set the default page layout to <code class="highlighter-rouge">my-site</code>. Then, using a more specific path, we set the default layout for pages in the <code class="highlighter-rouge">projects/</code> path to <code class="highlighter-rouge">project</code>. This can be done with any value that you would set in the page or post front matter.</p>
|
|
867
|
+
<p>You can see that in the second to last example above. First, we set the default page layout to <code class="language-plaintext highlighter-rouge">my-site</code>. Then, using a more specific path, we set the default layout for pages in the <code class="language-plaintext highlighter-rouge">projects/</code> path to <code class="language-plaintext highlighter-rouge">project</code>. This can be done with any value that you would set in the page or post front matter.</p>
|
|
867
868
|
|
|
868
|
-
<p>Finally, if you set defaults in the site configuration by adding a <code class="highlighter-rouge">defaults</code> section to your <code class="highlighter-rouge">_config.yml</code> file, you can override those settings in a post or page file. All you need to do is specify the settings in the post or page front matter. For example:</p>
|
|
869
|
+
<p>Finally, if you set defaults in the site configuration by adding a <code class="language-plaintext highlighter-rouge">defaults</code> section to your <code class="language-plaintext highlighter-rouge">_config.yml</code> file, you can override those settings in a post or page file. All you need to do is specify the settings in the post or page front matter. For example:</p>
|
|
869
870
|
|
|
870
871
|
<div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="c1"># In _config.yml</span>
|
|
871
872
|
<span class="nn">...</span>
|
|
@@ -889,8 +890,8 @@ The different types that are available to you are <code class="highlighter-rouge
|
|
|
889
890
|
<span class="s">The post text goes here...</span>
|
|
890
891
|
</code></pre></div></div>
|
|
891
892
|
|
|
892
|
-
<p>The <code class="highlighter-rouge">projects/foo_project.md</code> would have the <code class="highlighter-rouge">layout</code> set to <code class="highlighter-rouge">foobar</code> instead
|
|
893
|
-
of <code class="highlighter-rouge">project</code> and the <code class="highlighter-rouge">author</code> set to <code class="highlighter-rouge">John Smith</code> instead of <code class="highlighter-rouge">Mr. Hyde</code> when
|
|
893
|
+
<p>The <code class="language-plaintext highlighter-rouge">projects/foo_project.md</code> would have the <code class="language-plaintext highlighter-rouge">layout</code> set to <code class="language-plaintext highlighter-rouge">foobar</code> instead
|
|
894
|
+
of <code class="language-plaintext highlighter-rouge">project</code> and the <code class="language-plaintext highlighter-rouge">author</code> set to <code class="language-plaintext highlighter-rouge">John Smith</code> instead of <code class="language-plaintext highlighter-rouge">Mr. Hyde</code> when
|
|
894
895
|
the site is built.</p>
|
|
895
896
|
|
|
896
897
|
<h2 id="default-configuration">Default Configuration</h2>
|
|
@@ -931,7 +932,7 @@ file or on the command-line.</p>
|
|
|
931
932
|
|
|
932
933
|
<span class="c1"># Filtering Content</span>
|
|
933
934
|
<span class="na">show_drafts</span><span class="pi">:</span> <span class="no">null</span>
|
|
934
|
-
<span class="na">limit_posts</span><span class="pi">:</span> <span class="
|
|
935
|
+
<span class="na">limit_posts</span><span class="pi">:</span> <span class="m">0</span>
|
|
935
936
|
<span class="na">future</span><span class="pi">:</span> <span class="no">false</span>
|
|
936
937
|
<span class="na">unpublished</span><span class="pi">:</span> <span class="no">false</span>
|
|
937
938
|
|
|
@@ -948,7 +949,7 @@ file or on the command-line.</p>
|
|
|
948
949
|
|
|
949
950
|
<span class="c1"># Serving</span>
|
|
950
951
|
<span class="na">detach</span><span class="pi">:</span> <span class="no">false</span>
|
|
951
|
-
<span class="na">port</span><span class="pi">:</span> <span class="
|
|
952
|
+
<span class="na">port</span><span class="pi">:</span> <span class="m">4000</span>
|
|
952
953
|
<span class="na">host</span><span class="pi">:</span> <span class="s">127.0.0.1</span>
|
|
953
954
|
<span class="na">baseurl</span><span class="pi">:</span> <span class="s2">"</span><span class="s">"</span> <span class="c1"># does not include hostname</span>
|
|
954
955
|
<span class="na">show_dir_listing</span><span class="pi">:</span> <span class="no">false</span>
|
|
@@ -981,30 +982,30 @@ file or on the command-line.</p>
|
|
|
981
982
|
<span class="na">smart_quotes</span><span class="pi">:</span> <span class="s">lsquo,rsquo,ldquo,rdquo</span>
|
|
982
983
|
<span class="na">input</span><span class="pi">:</span> <span class="s">GFM</span>
|
|
983
984
|
<span class="na">hard_wrap</span><span class="pi">:</span> <span class="no">false</span>
|
|
984
|
-
<span class="na">footnote_nr</span><span class="pi">:</span> <span class="
|
|
985
|
+
<span class="na">footnote_nr</span><span class="pi">:</span> <span class="m">1</span>
|
|
985
986
|
<span class="na">show_warnings</span><span class="pi">:</span> <span class="no">false</span>
|
|
986
987
|
</code></pre></div></div>
|
|
987
988
|
|
|
988
989
|
<h2 id="liquid-options">Liquid Options</h2>
|
|
989
990
|
|
|
990
|
-
<p>Liquid’s response to errors can be configured by setting <code class="highlighter-rouge">error_mode</code>. The
|
|
991
|
+
<p>Liquid’s response to errors can be configured by setting <code class="language-plaintext highlighter-rouge">error_mode</code>. The
|
|
991
992
|
options are</p>
|
|
992
993
|
|
|
993
994
|
<ul>
|
|
994
995
|
<li>
|
|
995
|
-
<code class="highlighter-rouge">lax</code> — Ignore all errors.</li>
|
|
996
|
+
<code class="language-plaintext highlighter-rouge">lax</code> — Ignore all errors.</li>
|
|
996
997
|
<li>
|
|
997
|
-
<code class="highlighter-rouge">warn</code> — Output a warning on the console for each error.</li>
|
|
998
|
+
<code class="language-plaintext highlighter-rouge">warn</code> — Output a warning on the console for each error.</li>
|
|
998
999
|
<li>
|
|
999
|
-
<code class="highlighter-rouge">strict</code> — Output an error message and stop the build.</li>
|
|
1000
|
+
<code class="language-plaintext highlighter-rouge">strict</code> — Output an error message and stop the build.</li>
|
|
1000
1001
|
</ul>
|
|
1001
1002
|
|
|
1002
1003
|
<p>You can also configure Liquid’s renderer to catch non-assigned variables and
|
|
1003
|
-
non-existing filters by setting <code class="highlighter-rouge">strict_variables</code> and / or <code class="highlighter-rouge">strict_filters</code>
|
|
1004
|
-
to <code class="highlighter-rouge">true</code> respectively. <span class="version-badge" title="This feature is available starting version 3.8.0">3.8.0</span></p>
|
|
1004
|
+
non-existing filters by setting <code class="language-plaintext highlighter-rouge">strict_variables</code> and / or <code class="language-plaintext highlighter-rouge">strict_filters</code>
|
|
1005
|
+
to <code class="language-plaintext highlighter-rouge">true</code> respectively. <span class="version-badge" title="This feature is available starting version 3.8.0">3.8.0</span></p>
|
|
1005
1006
|
|
|
1006
|
-
<p>Do note that while <code class="highlighter-rouge">error_mode</code> configures Liquid’s parser, the <code class="highlighter-rouge">strict_variables</code>
|
|
1007
|
-
and <code class="highlighter-rouge">strict_filters</code> options configure Liquid’s renderer and are consequently,
|
|
1007
|
+
<p>Do note that while <code class="language-plaintext highlighter-rouge">error_mode</code> configures Liquid’s parser, the <code class="language-plaintext highlighter-rouge">strict_variables</code>
|
|
1008
|
+
and <code class="language-plaintext highlighter-rouge">strict_filters</code> options configure Liquid’s renderer and are consequently,
|
|
1008
1009
|
mutually exclusive.</p>
|
|
1009
1010
|
|
|
1010
1011
|
<h2 id="markdown-options">Markdown Options</h2>
|
|
@@ -1014,19 +1015,19 @@ available.</p>
|
|
|
1014
1015
|
|
|
1015
1016
|
<h3 id="redcarpet">Redcarpet</h3>
|
|
1016
1017
|
|
|
1017
|
-
<p>Redcarpet can be configured by providing an <code class="highlighter-rouge">extensions</code> sub-setting, whose
|
|
1018
|
+
<p>Redcarpet can be configured by providing an <code class="language-plaintext highlighter-rouge">extensions</code> sub-setting, whose
|
|
1018
1019
|
value should be an array of strings. Each string should be the name of one of
|
|
1019
|
-
the <code class="highlighter-rouge">Redcarpet::Markdown</code> class’s extensions; if present in the array, it will
|
|
1020
|
-
set the corresponding extension to <code class="highlighter-rouge">true</code>.</p>
|
|
1020
|
+
the <code class="language-plaintext highlighter-rouge">Redcarpet::Markdown</code> class’s extensions; if present in the array, it will
|
|
1021
|
+
set the corresponding extension to <code class="language-plaintext highlighter-rouge">true</code>.</p>
|
|
1021
1022
|
|
|
1022
1023
|
<p>Jekyll handles two special Redcarpet extensions:</p>
|
|
1023
1024
|
|
|
1024
1025
|
<ul>
|
|
1025
1026
|
<li>
|
|
1026
|
-
<code class="highlighter-rouge">no_fenced_code_blocks</code> — By default, Jekyll sets the <code class="highlighter-rouge">fenced_code_blocks</code>
|
|
1027
|
+
<code class="language-plaintext highlighter-rouge">no_fenced_code_blocks</code> — By default, Jekyll sets the <code class="language-plaintext highlighter-rouge">fenced_code_blocks</code>
|
|
1027
1028
|
extension (for delimiting code blocks with triple tildes or triple backticks)
|
|
1028
|
-
to <code class="highlighter-rouge">true</code>, probably because GitHub’s eager adoption of them is starting to make
|
|
1029
|
-
them inescapable. Redcarpet’s normal <code class="highlighter-rouge">fenced_code_blocks</code> extension is inert
|
|
1029
|
+
to <code class="language-plaintext highlighter-rouge">true</code>, probably because GitHub’s eager adoption of them is starting to make
|
|
1030
|
+
them inescapable. Redcarpet’s normal <code class="language-plaintext highlighter-rouge">fenced_code_blocks</code> extension is inert
|
|
1030
1031
|
when used with Jekyll; instead, you can use this inverted version of the
|
|
1031
1032
|
extension for disabling fenced code.</li>
|
|
1032
1033
|
</ul>
|
|
@@ -1034,40 +1035,40 @@ extension for disabling fenced code.</li>
|
|
|
1034
1035
|
<p>Note that you can also specify a language for highlighting after the first
|
|
1035
1036
|
delimiter:</p>
|
|
1036
1037
|
|
|
1037
|
-
<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code> ```ruby
|
|
1038
|
+
<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code> ```ruby
|
|
1038
1039
|
# ...ruby code
|
|
1039
1040
|
```
|
|
1040
1041
|
</code></pre></div></div>
|
|
1041
1042
|
|
|
1042
1043
|
<p>With both fenced code blocks and highlighter enabled, this will statically
|
|
1043
1044
|
highlight the code; without any syntax highlighter, it will add a
|
|
1044
|
-
<code class="highlighter-rouge">class="LANGUAGE"</code> attribute to the <code class="highlighter-rouge"><code></code> element, which can be used as a
|
|
1045
|
+
<code class="language-plaintext highlighter-rouge">class="LANGUAGE"</code> attribute to the <code class="language-plaintext highlighter-rouge"><code></code> element, which can be used as a
|
|
1045
1046
|
hint by various JavaScript code highlighting libraries.</p>
|
|
1046
1047
|
|
|
1047
1048
|
<ul>
|
|
1048
1049
|
<li>
|
|
1049
|
-
<code class="highlighter-rouge">smart</code> — This pseudo-extension turns on SmartyPants, which converts
|
|
1050
|
-
straight quotes to curly quotes and runs of hyphens to em (<code class="highlighter-rouge">---</code>) and en (<code class="highlighter-rouge">--</code>) dashes.</li>
|
|
1050
|
+
<code class="language-plaintext highlighter-rouge">smart</code> — This pseudo-extension turns on SmartyPants, which converts
|
|
1051
|
+
straight quotes to curly quotes and runs of hyphens to em (<code class="language-plaintext highlighter-rouge">---</code>) and en (<code class="language-plaintext highlighter-rouge">--</code>) dashes.</li>
|
|
1051
1052
|
</ul>
|
|
1052
1053
|
|
|
1053
1054
|
<p>All other extensions retain their usual names from Redcarpet, and no renderer
|
|
1054
|
-
options aside from <code class="highlighter-rouge">smart</code> can be specified in Jekyll. <a href="https://github.com/vmg/redcarpet/blob/v3.2.2/README.markdown#and-its-like-really-simple-to-use">A list of available
|
|
1055
|
+
options aside from <code class="language-plaintext highlighter-rouge">smart</code> can be specified in Jekyll. <a href="https://github.com/vmg/redcarpet/blob/v3.2.2/README.markdown#and-its-like-really-simple-to-use">A list of available
|
|
1055
1056
|
extensions can be found in the Redcarpet README file.</a>
|
|
1056
1057
|
Make sure you’re looking at the README for the right version of
|
|
1057
1058
|
Redcarpet: Jekyll currently uses v3.2.x. The most commonly used
|
|
1058
1059
|
extensions are:</p>
|
|
1059
1060
|
|
|
1060
1061
|
<ul>
|
|
1061
|
-
<li><code class="highlighter-rouge">tables</code></li>
|
|
1062
|
-
<li><code class="highlighter-rouge">no_intra_emphasis</code></li>
|
|
1063
|
-
<li><code class="highlighter-rouge">autolink</code></li>
|
|
1062
|
+
<li><code class="language-plaintext highlighter-rouge">tables</code></li>
|
|
1063
|
+
<li><code class="language-plaintext highlighter-rouge">no_intra_emphasis</code></li>
|
|
1064
|
+
<li><code class="language-plaintext highlighter-rouge">autolink</code></li>
|
|
1064
1065
|
</ul>
|
|
1065
1066
|
|
|
1066
1067
|
<h3 id="custom-markdown-processors">Custom Markdown Processors</h3>
|
|
1067
1068
|
|
|
1068
|
-
<p>If you’re interested in creating a custom markdown processor, you’re in luck! Create a new class in the <code class="highlighter-rouge">Jekyll::Converters::Markdown</code> namespace:</p>
|
|
1069
|
+
<p>If you’re interested in creating a custom markdown processor, you’re in luck! Create a new class in the <code class="language-plaintext highlighter-rouge">Jekyll::Converters::Markdown</code> namespace:</p>
|
|
1069
1070
|
|
|
1070
|
-
<div class="language-ruby highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="k">class</span> <span class="nc">Jekyll
|
|
1071
|
+
<div class="language-ruby highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="k">class</span> <span class="nc">Jekyll::Converters::Markdown::MyCustomProcessor</span>
|
|
1071
1072
|
<span class="k">def</span> <span class="nf">initialize</span><span class="p">(</span><span class="n">config</span><span class="p">)</span>
|
|
1072
1073
|
<span class="nb">require</span> <span class="s1">'funky_markdown'</span>
|
|
1073
1074
|
<span class="vi">@config</span> <span class="o">=</span> <span class="n">config</span>
|
|
@@ -1084,7 +1085,7 @@ extensions are:</p>
|
|
|
1084
1085
|
</code></pre></div></div>
|
|
1085
1086
|
|
|
1086
1087
|
<p>Once you’ve created your class and have it properly set up either as a plugin
|
|
1087
|
-
in the <code class="highlighter-rouge">_plugins</code> folder or as a gem, specify it in your <code class="highlighter-rouge">_config.yml</code>:</p>
|
|
1088
|
+
in the <code class="language-plaintext highlighter-rouge">_plugins</code> folder or as a gem, specify it in your <code class="language-plaintext highlighter-rouge">_config.yml</code>:</p>
|
|
1088
1089
|
|
|
1089
1090
|
<div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">markdown</span><span class="pi">:</span> <span class="s">MyCustomProcessor</span>
|
|
1090
1091
|
</code></pre></div></div>
|
|
@@ -1103,22 +1104,22 @@ in the <code class="highlighter-rouge">_plugins</code> folder or as a gem, speci
|
|
|
1103
1104
|
<p>Incremental regeneration helps shorten build times by only generating documents
|
|
1104
1105
|
and pages that were updated since the previous build. It does this by keeping
|
|
1105
1106
|
track of both file modification times and inter-document dependencies in the
|
|
1106
|
-
<code class="highlighter-rouge">.jekyll-metadata</code> file.</p>
|
|
1107
|
+
<code class="language-plaintext highlighter-rouge">.jekyll-metadata</code> file.</p>
|
|
1107
1108
|
|
|
1108
1109
|
<p>Under the current implementation, incremental regeneration will only generate a
|
|
1109
1110
|
document or page if either it, or one of its dependencies, is modified. Currently,
|
|
1110
1111
|
the only types of dependencies tracked are includes (using the
|
|
1111
|
-
<code class="highlighter-rouge">{% include %}</code> tag) and layouts. This means that plain
|
|
1112
|
+
<code class="language-plaintext highlighter-rouge">{% include %}</code> tag) and layouts. This means that plain
|
|
1112
1113
|
references to other documents (for example, the common case of iterating over
|
|
1113
|
-
<code class="highlighter-rouge">site.posts</code> in a post listings page) will not be detected as a dependency.</p>
|
|
1114
|
+
<code class="language-plaintext highlighter-rouge">site.posts</code> in a post listings page) will not be detected as a dependency.</p>
|
|
1114
1115
|
|
|
1115
|
-
<p>To remedy some of these shortfalls, putting <code class="highlighter-rouge">regenerate: true</code> in the front-matter
|
|
1116
|
+
<p>To remedy some of these shortfalls, putting <code class="language-plaintext highlighter-rouge">regenerate: true</code> in the front-matter
|
|
1116
1117
|
of a document will force Jekyll to regenerate it regardless of whether it has been
|
|
1117
1118
|
modified. Note that this will generate the specified document only; references
|
|
1118
1119
|
to other documents’ contents will not work since they won’t be re-rendered.</p>
|
|
1119
1120
|
|
|
1120
|
-
<p>Incremental regeneration can be enabled via the <code class="highlighter-rouge">--incremental</code> flag (<code class="highlighter-rouge">-I</code> for
|
|
1121
|
-
short) from the command-line or by setting <code class="highlighter-rouge">incremental: true</code> in your
|
|
1121
|
+
<p>Incremental regeneration can be enabled via the <code class="language-plaintext highlighter-rouge">--incremental</code> flag (<code class="language-plaintext highlighter-rouge">-I</code> for
|
|
1122
|
+
short) from the command-line or by setting <code class="language-plaintext highlighter-rouge">incremental: true</code> in your
|
|
1122
1123
|
configuration file.</p>
|
|
1123
1124
|
|
|
1124
1125
|
|
|
@@ -1364,7 +1365,7 @@ configuration file.</p>
|
|
|
1364
1365
|
<footer>
|
|
1365
1366
|
<div class="grid">
|
|
1366
1367
|
<div class="unit one-third center-on-mobiles">
|
|
1367
|
-
<p>The contents of this website are <br>©
|
|
1368
|
+
<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>
|
|
1368
1369
|
</div>
|
|
1369
1370
|
<div class="unit two-thirds align-right center-on-mobiles">
|
|
1370
1371
|
<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>Buddy | 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="Buddy" />
|
|
18
18
|
<meta property="og:locale" content="en_US" />
|
|
19
19
|
<meta name="description" content="Buddy is a Docker-based CI server that you can set up in 15-20 minutes to build, test, and deploy your Jekyll websites. It supports GitHub, Bitbucket, and GitLab repositories, and can be installed on-premises or used in cloud. The following guide will show you how to set up a free environment to build and test your Jekyll project." />
|
|
@@ -22,12 +22,13 @@
|
|
|
22
22
|
<meta property="og:url" content="https://jekyllrb.com/docs/continuous-integration/buddyworks/" />
|
|
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="Buddy" />
|
|
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
|
-
{"headline":"Buddy","dateModified":"
|
|
31
|
+
{"url":"https://jekyllrb.com/docs/continuous-integration/buddyworks/","headline":"Buddy","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":"Buddy is a Docker-based CI server that you can set up in 15-20 minutes to build, test, and deploy your Jekyll websites. It supports GitHub, Bitbucket, and GitLab repositories, and can be installed on-premises or used in cloud. The following guide will show you how to set up a free environment to build and test your Jekyll project.","mainEntityOfPage":{"@type":"WebPage","@id":"https://jekyllrb.com/docs/continuous-integration/buddyworks/"},"@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>
|
|
@@ -307,13 +308,13 @@
|
|
|
307
308
|
|
|
308
309
|
<h2 id="2-how-it-works">2. How it works</h2>
|
|
309
310
|
|
|
310
|
-
<p>Whenever you make a push to the selected branch, the Jekyll action runs <code class="highlighter-rouge">jekyll build</code> in an isolated <a href="https://hub.docker.com/r/jekyll/jekyll/">Jekyll Docker image</a>. The output is generated to the <code class="highlighter-rouge">/filesystem</code> directory, and can be further deployed to FTP/SFTP and IaaS services. You can add your own commands, install additional packages, attach services, and run Selenium tests, as well as add other actions down the pipeline, eg. a Slack notification or an SSH script that will restart your server.</p>
|
|
311
|
+
<p>Whenever you make a push to the selected branch, the Jekyll action runs <code class="language-plaintext highlighter-rouge">jekyll build</code> in an isolated <a href="https://hub.docker.com/r/jekyll/jekyll/">Jekyll Docker image</a>. The output is generated to the <code class="language-plaintext highlighter-rouge">/filesystem</code> directory, and can be further deployed to FTP/SFTP and IaaS services. You can add your own commands, install additional packages, attach services, and run Selenium tests, as well as add other actions down the pipeline, eg. a Slack notification or an SSH script that will restart your server.</p>
|
|
311
312
|
|
|
312
313
|
<p><img src="https://buddy.works/data/blog/_images/buddyworks-jekyll-small.png" alt="Jekyll Build" /></p>
|
|
313
314
|
|
|
314
315
|
<h2 id="3-using-yaml-for-configuration">3. Using YAML for configuration</h2>
|
|
315
316
|
|
|
316
|
-
<p>If you prefer configuration as code over GUI, you can generate a <code class="highlighter-rouge">buddy.yml</code> that will create a pipeline with the Jekyll action once you push it to the target branch:</p>
|
|
317
|
+
<p>If you prefer configuration as code over GUI, you can generate a <code class="language-plaintext highlighter-rouge">buddy.yml</code> that will create a pipeline with the Jekyll action once you push it to the target branch:</p>
|
|
317
318
|
|
|
318
319
|
<div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="pi">-</span> <span class="na">pipeline</span><span class="pi">:</span> <span class="s2">"</span><span class="s">Build</span><span class="nv"> </span><span class="s">and</span><span class="nv"> </span><span class="s">Deploy</span><span class="nv"> </span><span class="s">Jekyll</span><span class="nv"> </span><span class="s">site"</span>
|
|
319
320
|
<span class="na">trigger_mode</span><span class="pi">:</span> <span class="s2">"</span><span class="s">ON_EVERY_PUSH"</span>
|
|
@@ -650,7 +651,7 @@
|
|
|
650
651
|
<footer>
|
|
651
652
|
<div class="grid">
|
|
652
653
|
<div class="unit one-third center-on-mobiles">
|
|
653
|
-
<p>The contents of this website are <br />©
|
|
654
|
+
<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>
|
|
654
655
|
</div>
|
|
655
656
|
<div class="unit two-thirds align-right center-on-mobiles">
|
|
656
657
|
<p>
|