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>CircleCI | 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="CircleCI" />
|
|
18
18
|
<meta property="og:locale" content="en_US" />
|
|
19
19
|
<meta name="description" content="Building, testing, and deploying your Jekyll-generated website can quickly be done with CircleCI, a continuous integration & delivery tool. CircleCI supports GitHub and Bitbucket, and you can get started for free using an open-source or private repository." />
|
|
@@ -22,12 +22,13 @@
|
|
|
22
22
|
<meta property="og:url" content="https://jekyllrb.com/docs/continuous-integration/circleci/" />
|
|
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="CircleCI" />
|
|
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":"Building, testing, and deploying your Jekyll-generated website can quickly be done with CircleCI, a continuous integration & delivery tool. CircleCI supports GitHub and Bitbucket, and you can get started for free using an open-source or private repository.","@type":"
|
|
31
|
+
{"url":"https://jekyllrb.com/docs/continuous-integration/circleci/","headline":"CircleCI","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":"Building, testing, and deploying your Jekyll-generated website can quickly be done with CircleCI, a continuous integration & delivery tool. CircleCI supports GitHub and Bitbucket, and you can get started for free using an open-source or private repository.","mainEntityOfPage":{"@type":"WebPage","@id":"https://jekyllrb.com/docs/continuous-integration/circleci/"},"@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>
|
|
@@ -309,7 +310,7 @@
|
|
|
309
310
|
|
|
310
311
|
<h2 id="2-dependencies">2. Dependencies</h2>
|
|
311
312
|
|
|
312
|
-
<p>The easiest way to manage dependencies for a Jekyll project (with or without CircleCI) is via a <a href="http://bundler.io/gemfile.html">Gemfile</a>. You’d want to have Jekyll, any Jekyll plugins, <a href="#html-proofer">HTML Proofer</a>, and any other gems that you are using in the <code class="highlighter-rouge">Gemfile</code>. Don’t forget to version <code class="highlighter-rouge">Gemfile.lock</code> as well. Here’s an example <code class="highlighter-rouge">Gemfile</code>:</p>
|
|
313
|
+
<p>The easiest way to manage dependencies for a Jekyll project (with or without CircleCI) is via a <a href="http://bundler.io/gemfile.html">Gemfile</a>. You’d want to have Jekyll, any Jekyll plugins, <a href="#html-proofer">HTML Proofer</a>, and any other gems that you are using in the <code class="language-plaintext highlighter-rouge">Gemfile</code>. Don’t forget to version <code class="language-plaintext highlighter-rouge">Gemfile.lock</code> as well. Here’s an example <code class="language-plaintext highlighter-rouge">Gemfile</code>:</p>
|
|
313
314
|
|
|
314
315
|
<div class="language-ruby highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="n">source</span> <span class="s1">'https://rubygems.org'</span>
|
|
315
316
|
|
|
@@ -319,11 +320,11 @@
|
|
|
319
320
|
<span class="n">gem</span> <span class="s1">'html-proofer'</span>
|
|
320
321
|
</code></pre></div></div>
|
|
321
322
|
|
|
322
|
-
<p>CircleCI detects when <code class="highlighter-rouge">Gemfile</code> is present is will automatically run <code class="highlighter-rouge">bundle install</code> for you in the <code class="highlighter-rouge">dependencies</code> phase.</p>
|
|
323
|
+
<p>CircleCI detects when <code class="language-plaintext highlighter-rouge">Gemfile</code> is present is will automatically run <code class="language-plaintext highlighter-rouge">bundle install</code> for you in the <code class="language-plaintext highlighter-rouge">dependencies</code> phase.</p>
|
|
323
324
|
|
|
324
325
|
<h2 id="3-testing">3. Testing</h2>
|
|
325
326
|
|
|
326
|
-
<p>The most basic test that can be run is simply seeing if <code class="highlighter-rouge">jekyll build</code> actually works. This is a blocker, a dependency if you will, for other tests you might run on the generate site. So we’ll run Jekyll, via Bundler, in the <code class="highlighter-rouge">dependencies</code> phase.</p>
|
|
327
|
+
<p>The most basic test that can be run is simply seeing if <code class="language-plaintext highlighter-rouge">jekyll build</code> actually works. This is a blocker, a dependency if you will, for other tests you might run on the generate site. So we’ll run Jekyll, via Bundler, in the <code class="language-plaintext highlighter-rouge">dependencies</code> phase.</p>
|
|
327
328
|
|
|
328
329
|
<div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">dependencies</span><span class="pi">:</span>
|
|
329
330
|
<span class="na">post</span><span class="pi">:</span>
|
|
@@ -332,7 +333,7 @@
|
|
|
332
333
|
|
|
333
334
|
<h3 id="html-proofer">HTML Proofer</h3>
|
|
334
335
|
|
|
335
|
-
<p>With your site built, it’s useful to run tests to check for valid HTML, broken links, etc. There’s a few tools out there but <a href="https://github.com/gjtorikian/html-proofer">HTML Proofer</a> is popular amongst Jekyll users. We’ll run it in the <code class="highlighter-rouge">test</code> phase with a few preferred flags. Check out the <code class="highlighter-rouge">html-proofer</code> <a href="https://github.com/gjtorikian/html-proofer/blob/master/README.md#configuration">README</a> for all available flags, or run <code class="highlighter-rouge">htmlproofer --help</code> locally.</p>
|
|
336
|
+
<p>With your site built, it’s useful to run tests to check for valid HTML, broken links, etc. There’s a few tools out there but <a href="https://github.com/gjtorikian/html-proofer">HTML Proofer</a> is popular amongst Jekyll users. We’ll run it in the <code class="language-plaintext highlighter-rouge">test</code> phase with a few preferred flags. Check out the <code class="language-plaintext highlighter-rouge">html-proofer</code> <a href="https://github.com/gjtorikian/html-proofer/blob/master/README.md#configuration">README</a> for all available flags, or run <code class="language-plaintext highlighter-rouge">htmlproofer --help</code> locally.</p>
|
|
336
337
|
|
|
337
338
|
<div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">test</span><span class="pi">:</span>
|
|
338
339
|
<span class="na">post</span><span class="pi">:</span>
|
|
@@ -341,7 +342,7 @@
|
|
|
341
342
|
|
|
342
343
|
<h2 id="complete-example-circleyml-file">Complete Example circle.yml File</h2>
|
|
343
344
|
|
|
344
|
-
<p>When you put it all together, here’s an example of what that <code class="highlighter-rouge">circle.yml</code> file could look like:</p>
|
|
345
|
+
<p>When you put it all together, here’s an example of what that <code class="language-plaintext highlighter-rouge">circle.yml</code> file could look like:</p>
|
|
345
346
|
|
|
346
347
|
<div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">machine</span><span class="pi">:</span>
|
|
347
348
|
<span class="na">environment</span><span class="pi">:</span>
|
|
@@ -680,7 +681,7 @@
|
|
|
680
681
|
<footer>
|
|
681
682
|
<div class="grid">
|
|
682
683
|
<div class="unit one-third center-on-mobiles">
|
|
683
|
-
<p>The contents of this website are <br />©
|
|
684
|
+
<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>
|
|
684
685
|
</div>
|
|
685
686
|
<div class="unit two-thirds align-right center-on-mobiles">
|
|
686
687
|
<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>Continuous Integration | 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="Continuous Integration" />
|
|
18
18
|
<meta property="og:locale" content="en_US" />
|
|
19
19
|
<meta name="description" content="Continuous Integration (CI) enables you to publish your Jekyll generated website with confidence by automating the quality assurance and deployment processes. You can quickly get started using CI with one of the providers below:" />
|
|
@@ -22,12 +22,13 @@
|
|
|
22
22
|
<meta property="og:url" content="https://jekyllrb.com/docs/continuous-integration/" />
|
|
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="Continuous Integration" />
|
|
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/continuous-integration/","headline":"Continuous Integration","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":"Continuous Integration (CI) enables you to publish your Jekyll generated website with confidence by automating the quality assurance and deployment processes. You can quickly get started using CI with one of the providers below:","mainEntityOfPage":{"@type":"WebPage","@id":"https://jekyllrb.com/docs/continuous-integration/"},"@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>
|
|
@@ -605,7 +606,7 @@
|
|
|
605
606
|
<footer>
|
|
606
607
|
<div class="grid">
|
|
607
608
|
<div class="unit one-third center-on-mobiles">
|
|
608
|
-
<p>The contents of this website are <br />©
|
|
609
|
+
<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>
|
|
609
610
|
</div>
|
|
610
611
|
<div class="unit two-thirds align-right center-on-mobiles">
|
|
611
612
|
<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>Travis CI | 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="Travis CI" />
|
|
18
18
|
<meta property="og:locale" content="en_US" />
|
|
19
19
|
<meta name="description" content="You can easily test your website build against one or more versions of Ruby. The following guide will show you how to set up a free build environment on Travis, with GitHub integration for pull requests." />
|
|
@@ -22,12 +22,13 @@
|
|
|
22
22
|
<meta property="og:url" content="https://jekyllrb.com/docs/continuous-integration/travis-ci/" />
|
|
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="Travis CI" />
|
|
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":"You can easily test your website build against one or more versions of Ruby. The following guide will show you how to set up a free build environment on Travis, with GitHub integration for pull requests.","@type":"
|
|
31
|
+
{"url":"https://jekyllrb.com/docs/continuous-integration/travis-ci/","headline":"Travis CI","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":"You can easily test your website build against one or more versions of Ruby. The following guide will show you how to set up a free build environment on Travis, with GitHub integration for pull requests.","mainEntityOfPage":{"@type":"WebPage","@id":"https://jekyllrb.com/docs/continuous-integration/travis-ci/"},"@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,21 +308,21 @@ The following guide will show you how to set up a free build environment on
|
|
|
307
308
|
<li>Find the repository for which you’re interested in enabling builds.</li>
|
|
308
309
|
<li>Flick the repository switch on so that it turns blue.</li>
|
|
309
310
|
<li>Optionally configure the build by clicking on the gear icon. Further
|
|
310
|
-
configuration happens via your <code class="highlighter-rouge">.travis.yml</code> file. More details below.</li>
|
|
311
|
+
configuration happens via your <code class="language-plaintext highlighter-rouge">.travis.yml</code> file. More details below.</li>
|
|
311
312
|
</ol>
|
|
312
313
|
|
|
313
314
|
<h2 id="2-the-test-script">2. The Test Script</h2>
|
|
314
315
|
|
|
315
|
-
<p>The simplest test script simply runs <code class="highlighter-rouge">jekyll build</code> and ensures that Jekyll
|
|
316
|
+
<p>The simplest test script simply runs <code class="language-plaintext highlighter-rouge">jekyll build</code> and ensures that Jekyll
|
|
316
317
|
doesn’t fail to build the site. It doesn’t check the resulting site, but it
|
|
317
318
|
does ensure things are built properly.</p>
|
|
318
319
|
|
|
319
320
|
<p>When testing Jekyll output, there is no better tool than <a href="https://github.com/gjtorikian/html-proofer">html-proofer</a>.
|
|
320
321
|
This tool checks your resulting site to ensure all links and images exist.
|
|
321
|
-
Utilize it either with the convenient <code class="highlighter-rouge">htmlproofer</code> command-line executable,
|
|
322
|
+
Utilize it either with the convenient <code class="language-plaintext highlighter-rouge">htmlproofer</code> command-line executable,
|
|
322
323
|
or write a Ruby script which utilizes the gem.</p>
|
|
323
324
|
|
|
324
|
-
<p>Save the commands you want to run and succeed in a file: <code class="highlighter-rouge">./script/cibuild</code></p>
|
|
325
|
+
<p>Save the commands you want to run and succeed in a file: <code class="language-plaintext highlighter-rouge">./script/cibuild</code></p>
|
|
325
326
|
|
|
326
327
|
<h3 id="the-html-proofer-executable">The HTML Proofer Executable</h3>
|
|
327
328
|
|
|
@@ -333,8 +334,8 @@ bundle <span class="nb">exec </span>htmlproofer ./_site
|
|
|
333
334
|
</code></pre></div></div>
|
|
334
335
|
|
|
335
336
|
<p>Some options can be specified via command-line switches. Check out the
|
|
336
|
-
<code class="highlighter-rouge">html-proofer</code> README for more information about these switches, or run
|
|
337
|
-
<code class="highlighter-rouge">htmlproofer --help</code> locally.</p>
|
|
337
|
+
<code class="language-plaintext highlighter-rouge">html-proofer</code> README for more information about these switches, or run
|
|
338
|
+
<code class="language-plaintext highlighter-rouge">htmlproofer --help</code> locally.</p>
|
|
338
339
|
|
|
339
340
|
<p>For example to avoid testing external sites, use this command:</p>
|
|
340
341
|
|
|
@@ -343,7 +344,7 @@ bundle <span class="nb">exec </span>htmlproofer ./_site
|
|
|
343
344
|
|
|
344
345
|
<h3 id="the-html-proofer-library">The HTML Proofer Library</h3>
|
|
345
346
|
|
|
346
|
-
<p>You can also invoke <code class="highlighter-rouge">html-proofer</code> in Ruby scripts (e.g. in a Rakefile):</p>
|
|
347
|
+
<p>You can also invoke <code class="language-plaintext highlighter-rouge">html-proofer</code> in Ruby scripts (e.g. in a Rakefile):</p>
|
|
347
348
|
|
|
348
349
|
<div class="language-ruby highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="c1">#!/usr/bin/env ruby</span>
|
|
349
350
|
|
|
@@ -351,15 +352,15 @@ bundle <span class="nb">exec </span>htmlproofer ./_site
|
|
|
351
352
|
<span class="no">HTMLProofer</span><span class="p">.</span><span class="nf">check_directory</span><span class="p">(</span><span class="s2">"./_site"</span><span class="p">).</span><span class="nf">run</span>
|
|
352
353
|
</code></pre></div></div>
|
|
353
354
|
|
|
354
|
-
<p>Options are given as a second argument to <code class="highlighter-rouge">.new</code>, and are encoded in a
|
|
355
|
+
<p>Options are given as a second argument to <code class="language-plaintext highlighter-rouge">.new</code>, and are encoded in a
|
|
355
356
|
symbol-keyed Ruby Hash. For more information about the configuration options,
|
|
356
|
-
check out <code class="highlighter-rouge">html-proofer</code>’s README file.</p>
|
|
357
|
+
check out <code class="language-plaintext highlighter-rouge">html-proofer</code>’s README file.</p>
|
|
357
358
|
|
|
358
359
|
<h2 id="3-configuring-your-travis-builds">3. Configuring Your Travis Builds</h2>
|
|
359
360
|
|
|
360
361
|
<p>This file is used to configure your Travis builds. Because Jekyll is built
|
|
361
362
|
with Ruby and requires RubyGems to install, we use the Ruby language build
|
|
362
|
-
environment. Below is a sample <code class="highlighter-rouge">.travis.yml</code> file, followed by
|
|
363
|
+
environment. Below is a sample <code class="language-plaintext highlighter-rouge">.travis.yml</code> file, followed by
|
|
363
364
|
an explanation of each line.</p>
|
|
364
365
|
|
|
365
366
|
<p><strong>Note:</strong> You will need a Gemfile as well, <a href="https://docs.travis-ci.com/user/languages/ruby/#Dependency-Management">Travis will automatically install</a> the dependencies based on the referenced gems:</p>
|
|
@@ -370,7 +371,7 @@ an explanation of each line.</p>
|
|
|
370
371
|
<span class="n">gem</span> <span class="s2">"html-proofer"</span>
|
|
371
372
|
</code></pre></div></div>
|
|
372
373
|
|
|
373
|
-
<p>Your <code class="highlighter-rouge">.travis.yml</code> file should look like this:</p>
|
|
374
|
+
<p>Your <code class="language-plaintext highlighter-rouge">.travis.yml</code> file should look like this:</p>
|
|
374
375
|
|
|
375
376
|
<div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">language</span><span class="pi">:</span> <span class="s">ruby</span>
|
|
376
377
|
<span class="na">rvm</span><span class="pi">:</span>
|
|
@@ -425,8 +426,8 @@ irrelevant.</p>
|
|
|
425
426
|
</code></pre></div></div>
|
|
426
427
|
|
|
427
428
|
<p>Travis allows you to run any arbitrary shell script to test your site. One
|
|
428
|
-
convention is to put all scripts for your project in the <code class="highlighter-rouge">script</code>
|
|
429
|
-
directory, and to call your test script <code class="highlighter-rouge">cibuild</code>. This line is completely
|
|
429
|
+
convention is to put all scripts for your project in the <code class="language-plaintext highlighter-rouge">script</code>
|
|
430
|
+
directory, and to call your test script <code class="language-plaintext highlighter-rouge">cibuild</code>. This line is completely
|
|
430
431
|
customizable. If your script won’t change much, you can write your test
|
|
431
432
|
incantation here directly:</p>
|
|
432
433
|
|
|
@@ -434,7 +435,7 @@ incantation here directly:</p>
|
|
|
434
435
|
<span class="na">script</span><span class="pi">:</span> <span class="s">jekyll build && htmlproofer ./_site</span>
|
|
435
436
|
</code></pre></div></div>
|
|
436
437
|
|
|
437
|
-
<p>The <code class="highlighter-rouge">script</code> directive can be absolutely any valid shell command.</p>
|
|
438
|
+
<p>The <code class="language-plaintext highlighter-rouge">script</code> directive can be absolutely any valid shell command.</p>
|
|
438
439
|
|
|
439
440
|
<div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="c1"># branch whitelist, only for GitHub Pages</span>
|
|
440
441
|
<span class="na">branches</span><span class="pi">:</span>
|
|
@@ -446,13 +447,13 @@ incantation here directly:</p>
|
|
|
446
447
|
<p>You want to ensure the Travis builds for your site are being run only on
|
|
447
448
|
the branch or branches which contain your site. One means of ensuring this
|
|
448
449
|
isolation is including a branch whitelist in your Travis configuration
|
|
449
|
-
file. By specifying the <code class="highlighter-rouge">gh-pages</code> branch, you will ensure the associated
|
|
450
|
+
file. By specifying the <code class="language-plaintext highlighter-rouge">gh-pages</code> branch, you will ensure the associated
|
|
450
451
|
test script (discussed above) is only executed on site branches. If you use
|
|
451
452
|
a pull request flow for proposing changes, you may wish to enforce a
|
|
452
453
|
convention for your builds such that all branches containing edits are
|
|
453
|
-
prefixed, exemplified above with the <code class="highlighter-rouge">/pages-(.*)/</code> regular expression.</p>
|
|
454
|
+
prefixed, exemplified above with the <code class="language-plaintext highlighter-rouge">/pages-(.*)/</code> regular expression.</p>
|
|
454
455
|
|
|
455
|
-
<p>The <code class="highlighter-rouge">branches</code> directive is completely optional. Travis will build from every
|
|
456
|
+
<p>The <code class="language-plaintext highlighter-rouge">branches</code> directive is completely optional. Travis will build from every
|
|
456
457
|
push to any branch of your repo if leave it out.</p>
|
|
457
458
|
|
|
458
459
|
<div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">env</span><span class="pi">:</span>
|
|
@@ -460,11 +461,11 @@ push to any branch of your repo if leave it out.</p>
|
|
|
460
461
|
<span class="pi">-</span> <span class="s">NOKOGIRI_USE_SYSTEM_LIBRARIES=true</span> <span class="c1"># speeds up installation of html-proofer</span>
|
|
461
462
|
</code></pre></div></div>
|
|
462
463
|
|
|
463
|
-
<p>Using <code class="highlighter-rouge">html-proofer</code>? You’ll want this environment variable. Nokogiri, used
|
|
464
|
+
<p>Using <code class="language-plaintext highlighter-rouge">html-proofer</code>? You’ll want this environment variable. Nokogiri, used
|
|
464
465
|
to parse HTML files in your compiled site, comes bundled with libraries
|
|
465
466
|
which it must compile each time it is installed. Luckily, you can
|
|
466
467
|
dramatically decrease the install time of Nokogiri by setting the
|
|
467
|
-
environment variable <code class="highlighter-rouge">NOKOGIRI_USE_SYSTEM_LIBRARIES</code> to <code class="highlighter-rouge">true</code>.</p>
|
|
468
|
+
environment variable <code class="language-plaintext highlighter-rouge">NOKOGIRI_USE_SYSTEM_LIBRARIES</code> to <code class="language-plaintext highlighter-rouge">true</code>.</p>
|
|
468
469
|
|
|
469
470
|
<div class="note warning">
|
|
470
471
|
<h5>Be sure to exclude <code>vendor</code> from your
|
|
@@ -476,11 +477,11 @@ environment variable <code class="highlighter-rouge">NOKOGIRI_USE_SYSTEM_LIBRARI
|
|
|
476
477
|
<div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">exclude</span><span class="pi">:</span> <span class="pi">[</span><span class="nv">vendor</span><span class="pi">]</span>
|
|
477
478
|
</code></pre></div></div>
|
|
478
479
|
|
|
479
|
-
<p>By default you should supply the <code class="highlighter-rouge">sudo: false</code> command to Travis. This command
|
|
480
|
+
<p>By default you should supply the <code class="language-plaintext highlighter-rouge">sudo: false</code> command to Travis. This command
|
|
480
481
|
explicitly tells Travis to run your build on Travis’s <a href="https://docs.travis-ci.com/user/workers/container-based-infrastructure/#Routing-your-build-to-container-based-infrastructure">container-based
|
|
481
482
|
infrastructure</a>. Running on the container-based infrastructure can often times
|
|
482
483
|
speed up your build. If you have any trouble with your build, or if your build
|
|
483
|
-
does need <code class="highlighter-rouge">sudo</code> access, modify the line to <code class="highlighter-rouge">sudo: required</code>.</p>
|
|
484
|
+
does need <code class="language-plaintext highlighter-rouge">sudo</code> access, modify the line to <code class="language-plaintext highlighter-rouge">sudo: required</code>.</p>
|
|
484
485
|
|
|
485
486
|
<div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">sudo</span><span class="pi">:</span> <span class="no">false</span>
|
|
486
487
|
</code></pre></div></div>
|
|
@@ -491,9 +492,9 @@ does need <code class="highlighter-rouge">sudo</code> access, modify the line to
|
|
|
491
492
|
your Gemfile. Run bundle install elsewhere and add the updated Gemfile.lock
|
|
492
493
|
to version control.”</em></p>
|
|
493
494
|
|
|
494
|
-
<p><strong>Workaround:</strong> Either run <code class="highlighter-rouge">bundle install</code> locally and commit your changes to
|
|
495
|
-
<code class="highlighter-rouge">Gemfile.lock</code>, or remove the <code class="highlighter-rouge">Gemfile.lock</code> file from your repository and add
|
|
496
|
-
an entry in the <code class="highlighter-rouge">.gitignore</code> file to avoid it from being checked in again.</p>
|
|
495
|
+
<p><strong>Workaround:</strong> Either run <code class="language-plaintext highlighter-rouge">bundle install</code> locally and commit your changes to
|
|
496
|
+
<code class="language-plaintext highlighter-rouge">Gemfile.lock</code>, or remove the <code class="language-plaintext highlighter-rouge">Gemfile.lock</code> file from your repository and add
|
|
497
|
+
an entry in the <code class="language-plaintext highlighter-rouge">.gitignore</code> file to avoid it from being checked in again.</p>
|
|
497
498
|
|
|
498
499
|
<h3 id="questions">Questions?</h3>
|
|
499
500
|
|
|
@@ -814,7 +815,7 @@ fix or <a href="https://jekyllrb.com/help/">ask for help</a> if you run into tro
|
|
|
814
815
|
<footer>
|
|
815
816
|
<div class="grid">
|
|
816
817
|
<div class="unit one-third center-on-mobiles">
|
|
817
|
-
<p>The contents of this website are <br />©
|
|
818
|
+
<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>
|
|
818
819
|
</div>
|
|
819
820
|
<div class="unit two-thirds align-right center-on-mobiles">
|
|
820
821
|
<p>
|
|
@@ -1,34 +1,34 @@
|
|
|
1
1
|
<!DOCTYPE HTML>
|
|
2
2
|
<html lang="en-US">
|
|
3
3
|
<head>
|
|
4
|
-
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
5
4
|
<meta charset="UTF-8">
|
|
6
5
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
|
7
|
-
<meta name="generator" content="Jekyll v3.
|
|
8
|
-
<link type="application/atom+xml" rel="alternate" href="https://jekyllrb.com/feed.xml" title="Jekyll • Simple, blog-aware, static sites"
|
|
6
|
+
<meta name="generator" content="Jekyll v3.9.0">
|
|
7
|
+
<link type="application/atom+xml" rel="alternate" href="https://jekyllrb.com/feed.xml" title="Jekyll • Simple, blog-aware, static sites" />
|
|
9
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">
|
|
10
9
|
<link rel="preconnect" href="https://fonts.gstatic.com/" crossorigin>
|
|
11
10
|
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Lato:300,300italic,400,400italic,700,700italic,900">
|
|
12
|
-
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css"
|
|
11
|
+
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css" />
|
|
13
12
|
<link rel="stylesheet" href="/css/screen.css">
|
|
14
13
|
<link rel="icon" type="image/x-icon" href="/favicon.ico">
|
|
15
|
-
<!-- Begin Jekyll SEO tag v2.
|
|
14
|
+
<!-- Begin Jekyll SEO tag v2.6.1 -->
|
|
16
15
|
<title>Contributing | Jekyll • Simple, blog-aware, static sites</title>
|
|
17
|
-
<meta name="generator" content="Jekyll v3.
|
|
18
|
-
<meta property="og:title" content="Contributing"
|
|
19
|
-
<meta property="og:locale" content="en_US"
|
|
20
|
-
<meta name="description" content="Hi there! Interested in contributing to Jekyll? We’d love your help. Jekyll is an open source project, built one contribution at a time by users like you."
|
|
21
|
-
<meta property="og:description" content="Hi there! Interested in contributing to Jekyll? We’d love your help. Jekyll is an open source project, built one contribution at a time by users like you."
|
|
22
|
-
<link rel="canonical" href="https://jekyllrb.com/docs/contributing/"
|
|
23
|
-
<meta property="og:url" content="https://jekyllrb.com/docs/contributing/"
|
|
24
|
-
<meta property="og:site_name" content="Jekyll • Simple, blog-aware, static sites"
|
|
25
|
-
<meta property="og:type" content="article"
|
|
26
|
-
<meta property="article:published_time" content="
|
|
27
|
-
<meta name="twitter:card" content="summary"
|
|
28
|
-
<meta
|
|
29
|
-
<meta name="
|
|
16
|
+
<meta name="generator" content="Jekyll v3.9.0" />
|
|
17
|
+
<meta property="og:title" content="Contributing" />
|
|
18
|
+
<meta property="og:locale" content="en_US" />
|
|
19
|
+
<meta name="description" content="Hi there! Interested in contributing to Jekyll? We’d love your help. Jekyll is an open source project, built one contribution at a time by users like you." />
|
|
20
|
+
<meta property="og:description" content="Hi there! Interested in contributing to Jekyll? We’d love your help. Jekyll is an open source project, built one contribution at a time by users like you." />
|
|
21
|
+
<link rel="canonical" href="https://jekyllrb.com/docs/contributing/" />
|
|
22
|
+
<meta property="og:url" content="https://jekyllrb.com/docs/contributing/" />
|
|
23
|
+
<meta property="og:site_name" content="Jekyll • Simple, blog-aware, static sites" />
|
|
24
|
+
<meta property="og:type" content="article" />
|
|
25
|
+
<meta property="article:published_time" content="2020-08-05T11:55:36-07:00" />
|
|
26
|
+
<meta name="twitter:card" content="summary" />
|
|
27
|
+
<meta property="twitter:title" content="Contributing" />
|
|
28
|
+
<meta name="twitter:site" content="@jekyllrb" />
|
|
29
|
+
<meta name="google-site-verification" content="onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY" />
|
|
30
30
|
<script type="application/ld+json">
|
|
31
|
-
{"
|
|
31
|
+
{"url":"https://jekyllrb.com/docs/contributing/","headline":"Contributing","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":"Hi there! Interested in contributing to Jekyll? We’d love your help. Jekyll is an open source project, built one contribution at a time by users like you.","mainEntityOfPage":{"@type":"WebPage","@id":"https://jekyllrb.com/docs/contributing/"},"@type":"BlogPosting","@context":"https://schema.org"}</script>
|
|
32
32
|
<!-- End Jekyll SEO tag -->
|
|
33
33
|
|
|
34
34
|
<!--[if lt IE 9]>
|
|
@@ -73,7 +73,7 @@
|
|
|
73
73
|
<div class="meta hide-on-mobiles">
|
|
74
74
|
<ul>
|
|
75
75
|
<li>
|
|
76
|
-
<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>
|
|
77
77
|
</li>
|
|
78
78
|
<li>
|
|
79
79
|
<a href="https://github.com/jekyll/jekyll">GitHub</a>
|
|
@@ -311,7 +311,7 @@
|
|
|
311
311
|
<li>Comment on some of the project’s <a href="https://github.com/jekyll/jekyll/issues">open issues</a>. Have you experienced the same problem? Know a work around? Do you have a suggestion for how the feature could be better?</li>
|
|
312
312
|
<li>Read through <a href="https://jekyllrb.com/docs/home/">the documentation</a>, and click the “improve this page” button, any time you see something confusing, or have a suggestion for something that could be improved.</li>
|
|
313
313
|
<li>Browse through <a href="https://talk.jekyllrb.com/">the Jekyll discussion forum</a>, and lend a hand answering questions. There’s a good chance you’ve already experienced what another user is experiencing.</li>
|
|
314
|
-
<li>Find <a href="https://github.com/jekyll/jekyll/issues">an open issue</a> (especially <a href="https://github.com/jekyll/jekyll/issues?q=is%3Aopen+is%3Aissue+label%3Ahelp-wanted">those labeled <code class="highlighter-rouge">help-wanted</code></a>), and submit a proposed fix. If it’s your first pull request, we promise we won’t bite, and are glad to answer any questions.</li>
|
|
314
|
+
<li>Find <a href="https://github.com/jekyll/jekyll/issues">an open issue</a> (especially <a href="https://github.com/jekyll/jekyll/issues?q=is%3Aopen+is%3Aissue+label%3Ahelp-wanted">those labeled <code class="language-plaintext highlighter-rouge">help-wanted</code></a>), and submit a proposed fix. If it’s your first pull request, we promise we won’t bite, and are glad to answer any questions.</li>
|
|
315
315
|
<li>Help evaluate <a href="https://github.com/jekyll/jekyll/pulls">open pull requests</a>, by testing the changes locally and reviewing what’s proposed.</li>
|
|
316
316
|
</ul>
|
|
317
317
|
|
|
@@ -339,7 +339,7 @@
|
|
|
339
339
|
<p>Many small changes can be made entirely through the github.com web interface.</p>
|
|
340
340
|
|
|
341
341
|
<ol>
|
|
342
|
-
<li>Navigate to the file within <a href="https://github.com/jekyll/jekyll"><code class="highlighter-rouge">jekyll/jekyll</code></a> that you’d like to edit.</li>
|
|
342
|
+
<li>Navigate to the file within <a href="https://github.com/jekyll/jekyll"><code class="language-plaintext highlighter-rouge">jekyll/jekyll</code></a> that you’d like to edit.</li>
|
|
343
343
|
<li>Click the pencil icon in the top right corner to edit the file</li>
|
|
344
344
|
<li>Make your proposed changes</li>
|
|
345
345
|
<li>Click “Propose file change”</li>
|
|
@@ -353,13 +353,13 @@
|
|
|
353
353
|
<h3 id="submitting-a-pull-request-via-git-command-line">Submitting a pull request via Git command line</h3>
|
|
354
354
|
|
|
355
355
|
<ol>
|
|
356
|
-
<li>Fork the project by clicking “Fork” in the top right corner of <a href="https://github.com/jekyll/jekyll"><code class="highlighter-rouge">jekyll/jekyll</code></a>.</li>
|
|
357
|
-
<li>Clone the repository locally <code class="highlighter-rouge">git clone https://github.com/<you-username>/jekyll</code>.</li>
|
|
358
|
-
<li>Create a new, descriptively named branch to contain your change ( <code class="highlighter-rouge">git checkout -b my-awesome-feature</code> ).</li>
|
|
356
|
+
<li>Fork the project by clicking “Fork” in the top right corner of <a href="https://github.com/jekyll/jekyll"><code class="language-plaintext highlighter-rouge">jekyll/jekyll</code></a>.</li>
|
|
357
|
+
<li>Clone the repository locally <code class="language-plaintext highlighter-rouge">git clone https://github.com/<you-username>/jekyll</code>.</li>
|
|
358
|
+
<li>Create a new, descriptively named branch to contain your change ( <code class="language-plaintext highlighter-rouge">git checkout -b my-awesome-feature</code> ).</li>
|
|
359
359
|
<li>Hack away, add tests. Not necessarily in that order.</li>
|
|
360
|
-
<li>Make sure everything still passes by running <code class="highlighter-rouge">script/cibuild</code> (see <a href="#running-tests-locally">the tests section</a> below)</li>
|
|
361
|
-
<li>Push the branch up ( <code class="highlighter-rouge">git push origin my-awesome-feature</code> ).</li>
|
|
362
|
-
<li>Create a pull request by visiting <code class="highlighter-rouge">https://github.com/<your-username>/jekyll</code> and following the instructions at the top of the screen.</li>
|
|
360
|
+
<li>Make sure everything still passes by running <code class="language-plaintext highlighter-rouge">script/cibuild</code> (see <a href="#running-tests-locally">the tests section</a> below)</li>
|
|
361
|
+
<li>Push the branch up ( <code class="language-plaintext highlighter-rouge">git push origin my-awesome-feature</code> ).</li>
|
|
362
|
+
<li>Create a pull request by visiting <code class="language-plaintext highlighter-rouge">https://github.com/<your-username>/jekyll</code> and following the instructions at the top of the screen.</li>
|
|
363
363
|
</ol>
|
|
364
364
|
|
|
365
365
|
<h2 id="proposing-updates-to-the-documentation">Proposing updates to the documentation</h2>
|
|
@@ -370,7 +370,7 @@
|
|
|
370
370
|
|
|
371
371
|
<p>You can find the documentation for jekyllrb.com in the <a href="https://github.com/jekyll/jekyll/tree/master/docs">docs</a> directory. See the section above, <a href="#submitting-a-pull-request">submitting a pull request</a> for information on how to propose a change.</p>
|
|
372
372
|
|
|
373
|
-
<p>One gotcha, all pull requests should be directed at the <code class="highlighter-rouge">master</code> branch (the default branch).</p>
|
|
373
|
+
<p>One gotcha, all pull requests should be directed at the <code class="language-plaintext highlighter-rouge">master</code> branch (the default branch).</p>
|
|
374
374
|
|
|
375
375
|
<h3 id="updating-fontawesome-iconset-for-jekyllrbcom">Updating FontAwesome iconset for jekyllrb.com</h3>
|
|
376
376
|
|
|
@@ -380,19 +380,19 @@
|
|
|
380
380
|
|
|
381
381
|
<ol>
|
|
382
382
|
<li>Go to <a href="https://icomoon.io/app/">https://icomoon.io/app/</a>.</li>
|
|
383
|
-
<li>Click <code class="highlighter-rouge">Import Icons</code> on the top-horizontal-bar and upload the existing <code class="highlighter-rouge"><jekyll>/docs/icomoon-selection.json</code>.</li>
|
|
384
|
-
<li>Click <code class="highlighter-rouge">Add Icons from Library..</code> further down on the page, and add ‘Font Awesome’.</li>
|
|
383
|
+
<li>Click <code class="language-plaintext highlighter-rouge">Import Icons</code> on the top-horizontal-bar and upload the existing <code class="language-plaintext highlighter-rouge"><jekyll>/docs/icomoon-selection.json</code>.</li>
|
|
384
|
+
<li>Click <code class="language-plaintext highlighter-rouge">Add Icons from Library..</code> further down on the page, and add ‘Font Awesome’.</li>
|
|
385
385
|
<li>Select the required icon(s) from the Library (make sure its the ‘FontAwesome’ library instead of ‘IcoMoon-Free’ library).</li>
|
|
386
|
-
<li>Click <code class="highlighter-rouge">Generate Font</code> on the bottom-horizontal-bar.</li>
|
|
387
|
-
<li>Inspect the included icons and proceed by clicking <code class="highlighter-rouge">Download</code>.</li>
|
|
386
|
+
<li>Click <code class="language-plaintext highlighter-rouge">Generate Font</code> on the bottom-horizontal-bar.</li>
|
|
387
|
+
<li>Inspect the included icons and proceed by clicking <code class="language-plaintext highlighter-rouge">Download</code>.</li>
|
|
388
388
|
<li>Extract the font files and adapt the CSS to the paths we use in Jekyll:
|
|
389
389
|
<ul>
|
|
390
|
-
<li>Copy the entire <code class="highlighter-rouge">fonts</code> directory over and overwrite existing ones at <code class="highlighter-rouge"><jekyll>/docs/</code>.</li>
|
|
391
|
-
<li>Copy the contents of <code class="highlighter-rouge">selection.json</code> and overwrite existing content inside <code class="highlighter-rouge"><jekyll>/docs/icomoon-selection.json</code>.</li>
|
|
392
|
-
<li>Copy the entire <code class="highlighter-rouge">@font-face {}</code> declaration and only the <strong>new-icon(s)’ css declarations</strong> further below, to update the
|
|
393
|
-
<code class="highlighter-rouge"><jekyll>/docs/_sass/_font-awesome.scss</code> sass partial.</li>
|
|
394
|
-
<li>Fix paths in the <code class="highlighter-rouge">@font-face {}</code> declaration by adding <code class="highlighter-rouge">../</code> before <code class="highlighter-rouge">fonts/FontAwesome.*</code> like so:
|
|
395
|
-
<code class="highlighter-rouge">('../fonts/Fontawesome.woff?9h6hxj')</code>.</li>
|
|
390
|
+
<li>Copy the entire <code class="language-plaintext highlighter-rouge">fonts</code> directory over and overwrite existing ones at <code class="language-plaintext highlighter-rouge"><jekyll>/docs/</code>.</li>
|
|
391
|
+
<li>Copy the contents of <code class="language-plaintext highlighter-rouge">selection.json</code> and overwrite existing content inside <code class="language-plaintext highlighter-rouge"><jekyll>/docs/icomoon-selection.json</code>.</li>
|
|
392
|
+
<li>Copy the entire <code class="language-plaintext highlighter-rouge">@font-face {}</code> declaration and only the <strong>new-icon(s)’ css declarations</strong> further below, to update the
|
|
393
|
+
<code class="language-plaintext highlighter-rouge"><jekyll>/docs/_sass/_font-awesome.scss</code> sass partial.</li>
|
|
394
|
+
<li>Fix paths in the <code class="language-plaintext highlighter-rouge">@font-face {}</code> declaration by adding <code class="language-plaintext highlighter-rouge">../</code> before <code class="language-plaintext highlighter-rouge">fonts/FontAwesome.*</code> like so:
|
|
395
|
+
<code class="language-plaintext highlighter-rouge">('../fonts/Fontawesome.woff?9h6hxj')</code>.</li>
|
|
396
396
|
</ul>
|
|
397
397
|
</li>
|
|
398
398
|
</ol>
|
|
@@ -411,13 +411,13 @@
|
|
|
411
411
|
|
|
412
412
|
<h4 id="documentation">Documentation</h4>
|
|
413
413
|
|
|
414
|
-
<p>If your contribution changes any Jekyll behavior, make sure to update the documentation. Documentation lives in the <code class="highlighter-rouge">docs/_docs</code> folder (spoiler alert: it’s a Jekyll site!). If the docs are missing information, please feel free to add it in. Great docs make a great project. Include changes to the documentation within your pull request, and once merged, <code class="highlighter-rouge">jekyllrb.com</code> will be updated.</p>
|
|
414
|
+
<p>If your contribution changes any Jekyll behavior, make sure to update the documentation. Documentation lives in the <code class="language-plaintext highlighter-rouge">docs/_docs</code> folder (spoiler alert: it’s a Jekyll site!). If the docs are missing information, please feel free to add it in. Great docs make a great project. Include changes to the documentation within your pull request, and once merged, <code class="language-plaintext highlighter-rouge">jekyllrb.com</code> will be updated.</p>
|
|
415
415
|
|
|
416
416
|
<h4 id="tests">Tests</h4>
|
|
417
417
|
|
|
418
418
|
<ul>
|
|
419
419
|
<li>
|
|
420
|
-
<p>If you’re creating a small fix or patch to an existing feature, a simple test is more than enough. You can usually copy/paste from an existing example in the <code class="highlighter-rouge">tests</code> folder, but if you need you can find out about our tests suites <a href="https://github.com/thoughtbot/shoulda/tree/master">Shoulda</a> and <a href="https://github.com/rspec/rspec-mocks">RSpec-Mocks</a>.</p>
|
|
420
|
+
<p>If you’re creating a small fix or patch to an existing feature, a simple test is more than enough. You can usually copy/paste from an existing example in the <code class="language-plaintext highlighter-rouge">tests</code> folder, but if you need you can find out about our tests suites <a href="https://github.com/thoughtbot/shoulda/tree/master">Shoulda</a> and <a href="https://github.com/rspec/rspec-mocks">RSpec-Mocks</a>.</p>
|
|
421
421
|
</li>
|
|
422
422
|
<li>
|
|
423
423
|
<p>If it’s a brand new feature, create a new <a href="https://github.com/cucumber/cucumber/">Cucumber</a> feature, reusing existing steps where appropriate.</p>
|
|
@@ -428,13 +428,13 @@
|
|
|
428
428
|
|
|
429
429
|
<ul>
|
|
430
430
|
<li>
|
|
431
|
-
<p>Jekyll uses the <a href="https://github.com/bbatsov/rubocop">Rubocop</a> static analyzer to ensure that contributions follow the <a href="https://github.com/styleguide/ruby">GitHub Ruby Styleguide</a>. Please check your code using <code class="highlighter-rouge">script/fmt</code> and resolve any errors before pushing your branch.</p>
|
|
431
|
+
<p>Jekyll uses the <a href="https://github.com/bbatsov/rubocop">Rubocop</a> static analyzer to ensure that contributions follow the <a href="https://github.com/styleguide/ruby">GitHub Ruby Styleguide</a>. Please check your code using <code class="language-plaintext highlighter-rouge">script/fmt</code> and resolve any errors before pushing your branch.</p>
|
|
432
432
|
</li>
|
|
433
433
|
<li>
|
|
434
434
|
<p>Don’t bump the Gem version in your pull request (if you don’t know what that means, you probably didn’t).</p>
|
|
435
435
|
</li>
|
|
436
436
|
<li>
|
|
437
|
-
<p>You can use the command <code class="highlighter-rouge">script/console</code> to start a REPL to explore the result of
|
|
437
|
+
<p>You can use the command <code class="language-plaintext highlighter-rouge">script/console</code> to start a REPL to explore the result of
|
|
438
438
|
Jekyll’s methods. It also provides you with helpful methods to quickly create a
|
|
439
439
|
site or configuration. <a href="https://github.com/jekyll/jekyll/blob/master/script/console">Feel free to check it out!</a></p>
|
|
440
440
|
</li>
|
|
@@ -454,17 +454,17 @@ site or configuration. <a href="https://github.com/jekyll/jekyll/blob/master/scr
|
|
|
454
454
|
<div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code>script/cibuild
|
|
455
455
|
</code></pre></div></div>
|
|
456
456
|
|
|
457
|
-
<p>If you are only updating a file in <code class="highlighter-rouge">test/</code>, you can use the command:</p>
|
|
457
|
+
<p>If you are only updating a file in <code class="language-plaintext highlighter-rouge">test/</code>, you can use the command:</p>
|
|
458
458
|
|
|
459
459
|
<div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code>script/test <span class="nb">test</span>/blah_test.rb
|
|
460
460
|
</code></pre></div></div>
|
|
461
461
|
|
|
462
|
-
<p>If you are only updating a <code class="highlighter-rouge">.feature</code> file, you can use the command:</p>
|
|
462
|
+
<p>If you are only updating a <code class="language-plaintext highlighter-rouge">.feature</code> file, you can use the command:</p>
|
|
463
463
|
|
|
464
464
|
<div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code>script/cucumber features/blah.feature
|
|
465
465
|
</code></pre></div></div>
|
|
466
466
|
|
|
467
|
-
<p>Both <code class="highlighter-rouge">script/test</code> and <code class="highlighter-rouge">script/cucumber</code> can be run without arguments to
|
|
467
|
+
<p>Both <code class="language-plaintext highlighter-rouge">script/test</code> and <code class="language-plaintext highlighter-rouge">script/cucumber</code> can be run without arguments to
|
|
468
468
|
run its entire respective suite.</p>
|
|
469
469
|
|
|
470
470
|
<h2 id="a-thank-you">A thank you</h2>
|
|
@@ -792,7 +792,7 @@ run its entire respective suite.</p>
|
|
|
792
792
|
<footer>
|
|
793
793
|
<div class="grid">
|
|
794
794
|
<div class="unit one-third center-on-mobiles">
|
|
795
|
-
<p>The contents of this website are <br>©
|
|
795
|
+
<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>
|
|
796
796
|
</div>
|
|
797
797
|
<div class="unit two-thirds align-right center-on-mobiles">
|
|
798
798
|
<p>
|