jekyll-docs 3.5.2 → 3.6.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 +3 -3
- data/site/community/index.html +5 -5
- data/site/docs/assets/index.html +14 -22
- data/site/docs/code_of_conduct/index.html +730 -0
- data/site/docs/collections/index.html +65 -80
- data/site/docs/conduct/index.html +4 -4
- data/site/docs/configuration/index.html +130 -156
- data/site/docs/continuous-integration/buddyworks/index.html +14 -16
- data/site/docs/continuous-integration/circleci/index.html +13 -21
- data/site/docs/continuous-integration/index.html +5 -5
- data/site/docs/continuous-integration/travis-ci/index.html +45 -73
- data/site/docs/contributing/index.html +10 -10
- data/site/docs/datafiles/index.html +37 -53
- data/site/docs/deployment-methods/index.html +54 -64
- data/site/docs/drafts/index.html +6 -8
- data/site/docs/extras/index.html +8 -12
- data/site/docs/frontmatter/index.html +10 -14
- data/site/docs/github-pages/index.html +10 -14
- data/site/docs/history/index.html +539 -440
- data/site/docs/home/index.html +4 -4
- data/site/docs/includes/index.html +42 -70
- data/site/docs/installation/index.html +23 -37
- data/site/docs/maintaining/affinity-team-captain/index.html +4 -4
- data/site/docs/maintaining/avoiding-burnout/index.html +4 -4
- data/site/docs/maintaining/becoming-a-maintainer/index.html +4 -4
- data/site/docs/maintaining/index.html +4 -4
- data/site/docs/maintaining/merging-a-pull-request/index.html +6 -8
- data/site/docs/maintaining/reviewing-a-pull-request/index.html +4 -4
- data/site/docs/maintaining/special-labels/index.html +4 -4
- data/site/docs/maintaining/triaging-an-issue/index.html +4 -4
- data/site/docs/migrations/index.html +4 -4
- data/site/docs/pages/index.html +8 -12
- data/site/docs/pagination/index.html +13 -21
- data/site/docs/permalinks/index.html +43 -34
- data/site/docs/plugins/index.html +51 -79
- data/site/docs/posts/index.html +26 -48
- data/site/docs/quickstart/index.html +6 -8
- data/site/docs/resources/index.html +45 -21
- data/site/docs/sites/index.html +4 -4
- data/site/docs/static-files/index.html +12 -16
- data/site/docs/structure/index.html +6 -8
- data/site/docs/templates/index.html +36 -68
- data/site/docs/themes/index.html +32 -49
- data/site/docs/troubleshooting/index.html +44 -82
- data/site/docs/upgrading/0-to-2/index.html +7 -9
- data/site/docs/upgrading/2-to-3/index.html +19 -31
- data/site/docs/upgrading/index.html +4 -4
- data/site/docs/usage/index.html +20 -30
- data/site/docs/variables/index.html +26 -10
- data/site/docs/windows/index.html +36 -58
- data/site/feed.xml +47 -53
- data/site/help/index.html +3 -3
- data/site/index.html +3 -3
- data/site/latest_version.txt +1 -1
- data/site/news/2013/05/05/jekyll-1-0-0-released/index.html +16 -8
- data/site/news/2013/05/08/jekyll-1-0-1-released/index.html +16 -8
- data/site/news/2013/05/12/jekyll-1-0-2-released/index.html +16 -8
- data/site/news/2013/06/07/jekyll-1-0-3-released/index.html +16 -8
- data/site/news/2013/07/14/jekyll-1-1-0-released/index.html +16 -8
- data/site/news/2013/07/24/jekyll-1-1-1-released/index.html +16 -8
- data/site/news/2013/07/25/jekyll-1-0-4-released/index.html +16 -8
- data/site/news/2013/07/25/jekyll-1-1-2-released/index.html +16 -8
- data/site/news/2013/09/06/jekyll-1-2-0-released/index.html +16 -8
- data/site/news/2013/09/14/jekyll-1-2-1-released/index.html +16 -8
- data/site/news/2013/10/28/jekyll-1-3-0-rc1-released/index.html +16 -8
- data/site/news/2013/11/04/jekyll-1-3-0-released/index.html +16 -8
- data/site/news/2013/11/26/jekyll-1-3-1-released/index.html +16 -8
- data/site/news/2013/12/07/jekyll-1-4-0-released/index.html +16 -8
- data/site/news/2013/12/09/jekyll-1-4-1-released/index.html +16 -8
- data/site/news/2013/12/16/jekyll-1-4-2-released/index.html +16 -8
- data/site/news/2014/01/13/jekyll-1-4-3-released/index.html +16 -8
- data/site/news/2014/03/24/jekyll-1-5-0-released/index.html +16 -8
- data/site/news/2014/03/27/jekyll-1-5-1-released/index.html +16 -8
- data/site/news/2014/05/06/jekyll-turns-2-0-0/index.html +16 -8
- data/site/news/2014/05/08/jekyll-2-0-3-released/index.html +16 -8
- data/site/news/2014/06/04/jekyll-stickers-1-dollar-stickermule/index.html +16 -8
- data/site/news/2014/06/28/jekyll-turns-21-i-mean-2-1-0/index.html +16 -8
- data/site/news/2014/07/01/jekyll-2-1-1-released/index.html +16 -8
- data/site/news/2014/07/29/jekyll-2-2-0-released/index.html +16 -8
- data/site/news/2014/08/10/jekyll-2-3-0-released/index.html +16 -8
- data/site/news/2014/09/09/jekyll-2-4-0-released/index.html +16 -8
- data/site/news/2014/11/05/jekylls-midlife-crisis-jekyll-turns-2-5-0/index.html +16 -8
- data/site/news/2014/11/09/jekyll-2-5-1-released/index.html +16 -8
- data/site/news/2014/11/12/jekyll-2-5-2-released/index.html +16 -8
- data/site/news/2014/12/17/alfredxing-welcome-to-jekyll-core/index.html +16 -8
- data/site/news/2014/12/22/jekyll-2-5-3-released/index.html +16 -8
- data/site/news/2015/01/20/jekyll-meet-and-greet/index.html +16 -8
- data/site/news/2015/01/24/jekyll-3-0-0-beta1-released/index.html +17 -9
- data/site/news/2015/02/26/introducing-jekyll-talk/index.html +16 -8
- data/site/news/2015/10/26/jekyll-3-0-released/index.html +16 -8
- data/site/news/2015/11/17/jekyll-3-0-1-released/index.html +16 -8
- data/site/news/2016/01/20/jekyll-3-0-2-released/index.html +16 -8
- data/site/news/2016/01/24/jekyll-3-1-0-released/index.html +16 -8
- data/site/news/2016/01/28/jekyll-3-1-1-released/index.html +16 -8
- data/site/news/2016/02/08/jekyll-3-0-3-released/index.html +16 -8
- data/site/news/2016/02/19/jekyll-3-1-2-released/index.html +16 -8
- data/site/news/2016/03/10/making-it-easier-to-contribute-to-jekyll/index.html +16 -8
- data/site/news/2016/04/19/jekyll-3-0-4-released/index.html +20 -12
- data/site/news/2016/04/19/jekyll-3-1-3-released/index.html +16 -8
- data/site/news/2016/04/26/jekyll-3-0-5-released/index.html +16 -8
- data/site/news/2016/05/18/jekyll-3-1-4-released/index.html +16 -8
- data/site/news/2016/05/18/jekyll-3-1-5-released/index.html +16 -8
- data/site/news/2016/05/19/jekyll-3-1-6-released/index.html +16 -8
- data/site/news/2016/06/03/update-on-jekyll-s-google-summer-of-code-projects/index.html +16 -8
- data/site/news/2016/07/26/jekyll-3-2-0-released/index.html +16 -8
- data/site/news/2016/08/02/jekyll-3-2-1-released/index.html +16 -8
- data/site/news/2016/08/24/jekyll-admin-initial-release/index.html +16 -8
- data/site/news/2016/10/06/jekyll-3-3-is-here/index.html +16 -8
- data/site/news/2016/11/14/jekyll-3-3-1-released/index.html +16 -8
- data/site/news/2017/01/18/jekyll-3-4-0-released/index.html +16 -8
- data/site/news/2017/03/02/jekyll-3-4-1-released/index.html +27 -29
- data/site/news/2017/03/09/jekyll-3-4-2-released/index.html +23 -17
- data/site/news/2017/03/21/jekyll-3-4-3-released/index.html +20 -14
- data/site/news/2017/06/15/jekyll-3-5-0-released/index.html +21 -13
- data/site/news/2017/07/17/jekyll-3-5-1-released/index.html +18 -10
- data/site/news/2017/08/12/jekyll-3-5-2-released/index.html +573 -0
- data/site/news/2017/09/21/jekyll-3-6-0-released/index.html +565 -0
- data/site/news/index.html +122 -48
- data/site/news/releases/index.html +122 -48
- data/site/sitemap.xml +64 -52
- data/site/tutorials/convert-site-to-jekyll/index.html +80 -138
- data/site/tutorials/custom-404-page/index.html +13 -21
- data/site/tutorials/home/index.html +4 -4
- data/site/tutorials/navigation/index.html +144 -180
- data/site/tutorials/orderofinterpretation/index.html +27 -45
- metadata +8 -5
@@ -4,28 +4,28 @@
|
|
4
4
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
5
5
|
<meta charset="UTF-8">
|
6
6
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
7
|
-
<meta name="generator" content="Jekyll v3.
|
7
|
+
<meta name="generator" content="Jekyll v3.6.0">
|
8
8
|
<link type="application/atom+xml" rel="alternate" href="https://jekyllrb.com/feed.xml" title="Jekyll • Simple, blog-aware, static sites">
|
9
9
|
<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
10
|
<link rel="stylesheet" href="//fonts.googleapis.com/css?family=Lato:300,300italic,400,400italic,700,700italic,900">
|
11
11
|
<link rel="stylesheet" href="/css/screen.css">
|
12
12
|
<link rel="icon" type="image/x-icon" href="/favicon.ico">
|
13
|
-
<!-- Begin Jekyll SEO tag v2.
|
14
|
-
<title>
|
15
|
-
<meta property="og:title" content="
|
13
|
+
<!-- Begin Jekyll SEO tag v2.3.0 -->
|
14
|
+
<title>Buddy | Jekyll • Simple, blog-aware, static sites</title>
|
15
|
+
<meta property="og:title" content="Buddy">
|
16
16
|
<meta property="og:locale" content="en_US">
|
17
|
-
<meta name="description" content="
|
18
|
-
<meta property="og:description" content="
|
17
|
+
<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.">
|
18
|
+
<meta property="og: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.">
|
19
19
|
<link rel="canonical" href="https://jekyllrb.com/docs/continuous-integration/buddyworks/">
|
20
20
|
<meta property="og:url" content="https://jekyllrb.com/docs/continuous-integration/buddyworks/">
|
21
21
|
<meta property="og:site_name" content="Jekyll • Simple, blog-aware, static sites">
|
22
22
|
<meta property="og:type" content="article">
|
23
|
-
<meta property="article:published_time" content="2017-
|
23
|
+
<meta property="article:published_time" content="2017-10-24T08:07:43-07:00">
|
24
24
|
<meta name="twitter:card" content="summary">
|
25
25
|
<meta name="twitter:site" content="@jekyllrb">
|
26
26
|
<meta name="google-site-verification" content="onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY">
|
27
27
|
<script type="application/ld+json">
|
28
|
-
{"
|
28
|
+
{"name":null,"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.","url":"https://jekyllrb.com/docs/continuous-integration/buddyworks/","headline":"Buddy","dateModified":"2017-10-24T08:07:43-07:00","datePublished":"2017-10-24T08:07:43-07:00","sameAs":null,"@type":"BlogPosting","author":null,"image":null,"publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://jekyllrb.com/img/logo-2x.png"}},"mainEntityOfPage":{"@type":"WebPage","@id":"https://jekyllrb.com/docs/continuous-integration/buddyworks/"},"@context":"http://schema.org"}</script>
|
29
29
|
<!-- End Jekyll SEO tag -->
|
30
30
|
|
31
31
|
<!--[if lt IE 9]>
|
@@ -286,8 +286,8 @@
|
|
286
286
|
<div class="improve right hide-on-mobiles">
|
287
287
|
<a href="https://github.com/jekyll/jekyll/edit/master/docs/_docs/continuous-integration/buddyworks.md"><i class="fa fa-pencil"></i> Improve this page</a>
|
288
288
|
</div>
|
289
|
-
<h1>
|
290
|
-
<p><a href="https://buddy.works">
|
289
|
+
<h1>Buddy</h1>
|
290
|
+
<p><a href="https://buddy.works">Buddy</a> is a <a href="https://www.docker.com/">Docker</a>-based CI server that you can set up in 15-20 minutes to build, test, and deploy your Jekyll websites. It supports <a href="https://github.com">GitHub</a>, <a href="https://bitbucket.org/">Bitbucket</a>, and <a href="https://gitlab.com">GitLab</a> 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.</p>
|
291
291
|
|
292
292
|
<h2 id="1-getting-started">1. Getting started</h2>
|
293
293
|
|
@@ -308,8 +308,7 @@
|
|
308
308
|
|
309
309
|
<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>
|
310
310
|
|
311
|
-
<div class="language-ruby highlighter-rouge">
|
312
|
-
<pre class="highlight"><code><span class="o">-</span> <span class="ss">pipeline: </span><span class="s2">"Build and Deploy Jekyll site"</span>
|
311
|
+
<div class="language-ruby highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="o">-</span> <span class="ss">pipeline: </span><span class="s2">"Build and Deploy Jekyll site"</span>
|
313
312
|
<span class="ss">trigger_mode: </span><span class="s2">"ON_EVERY_PUSH"</span>
|
314
313
|
<span class="ss">ref_name: </span><span class="s2">"master"</span>
|
315
314
|
<span class="ss">actions:
|
@@ -320,16 +319,15 @@
|
|
320
319
|
<span class="ss">execute_commands:
|
321
320
|
</span><span class="o">-</span> <span class="s2">"chown jekyll:jekyll $WORKING_DIR"</span>
|
322
321
|
<span class="o">-</span> <span class="s2">"jekyll build"</span>
|
323
|
-
</code></pre>
|
324
|
-
</div>
|
322
|
+
</code></pre></div></div>
|
325
323
|
|
326
324
|
<h2 id="4-setting-up-on-premises-server">4. Setting up on-premises server</h2>
|
327
325
|
|
328
|
-
<p>The self-hosted version of
|
326
|
+
<p>The self-hosted version of Buddy can be installed on any type of server supporting Docker, including <a href="https://buddy.works/knowledge/standalone/installation-linux">Linux</a>, <a href="https://buddy.works/knowledge/standalone/installation-mac-osx">Mac</a>, <a href="https://buddy.works/knowledge/standalone/installation-amazon-ec2">AWS EC2</a>, <a href="https://buddy.works/knowledge/standalone/installation-digitalocean">DigitalOcean</a>, and <a href="https://buddy.works/knowledge/standalone/installation-azure">Microsoft Azure</a>.</p>
|
329
327
|
|
330
328
|
<h2 id="5-questions">5. Questions?</h2>
|
331
329
|
|
332
|
-
<p>This entire guide is open-source. Go ahead and <a href="https://github.com/jekyll/jekyll/edit/master/docs/_docs/continuous-integration/buddyworks.md">edit it</a> if you want to expand it or have a fix or <a href="https://jekyllrb.com/help/">ask for help</a> if you run into trouble and need assistance.
|
330
|
+
<p>This entire guide is open-source. Go ahead and <a href="https://github.com/jekyll/jekyll/edit/master/docs/_docs/continuous-integration/buddyworks.md">edit it</a> if you want to expand it or have a fix or <a href="https://jekyllrb.com/help/">ask for help</a> if you run into trouble and need assistance. Buddy also has an <a href="http://forum.buddy.works/">online community</a> for help.</p>
|
333
331
|
|
334
332
|
|
335
333
|
|
@@ -4,13 +4,13 @@
|
|
4
4
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
5
5
|
<meta charset="UTF-8">
|
6
6
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
7
|
-
<meta name="generator" content="Jekyll v3.
|
7
|
+
<meta name="generator" content="Jekyll v3.6.0">
|
8
8
|
<link type="application/atom+xml" rel="alternate" href="https://jekyllrb.com/feed.xml" title="Jekyll • Simple, blog-aware, static sites">
|
9
9
|
<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
10
|
<link rel="stylesheet" href="//fonts.googleapis.com/css?family=Lato:300,300italic,400,400italic,700,700italic,900">
|
11
11
|
<link rel="stylesheet" href="/css/screen.css">
|
12
12
|
<link rel="icon" type="image/x-icon" href="/favicon.ico">
|
13
|
-
<!-- Begin Jekyll SEO tag v2.
|
13
|
+
<!-- Begin Jekyll SEO tag v2.3.0 -->
|
14
14
|
<title>CircleCI | Jekyll • Simple, blog-aware, static sites</title>
|
15
15
|
<meta property="og:title" content="CircleCI">
|
16
16
|
<meta property="og:locale" content="en_US">
|
@@ -20,12 +20,12 @@
|
|
20
20
|
<meta property="og:url" content="https://jekyllrb.com/docs/continuous-integration/circleci/">
|
21
21
|
<meta property="og:site_name" content="Jekyll • Simple, blog-aware, static sites">
|
22
22
|
<meta property="og:type" content="article">
|
23
|
-
<meta property="article:published_time" content="2017-
|
23
|
+
<meta property="article:published_time" content="2017-10-24T08:07:43-07:00">
|
24
24
|
<meta name="twitter:card" content="summary">
|
25
25
|
<meta name="twitter:site" content="@jekyllrb">
|
26
26
|
<meta name="google-site-verification" content="onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY">
|
27
27
|
<script type="application/ld+json">
|
28
|
-
{"
|
28
|
+
{"name":null,"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.","url":"https://jekyllrb.com/docs/continuous-integration/circleci/","headline":"CircleCI","dateModified":"2017-10-24T08:07:43-07:00","datePublished":"2017-10-24T08:07:43-07:00","sameAs":null,"@type":"BlogPosting","author":null,"image":null,"publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://jekyllrb.com/img/logo-2x.png"}},"mainEntityOfPage":{"@type":"WebPage","@id":"https://jekyllrb.com/docs/continuous-integration/circleci/"},"@context":"http://schema.org"}</script>
|
29
29
|
<!-- End Jekyll SEO tag -->
|
30
30
|
|
31
31
|
<!--[if lt IE 9]>
|
@@ -305,15 +305,13 @@
|
|
305
305
|
|
306
306
|
<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>
|
307
307
|
|
308
|
-
<div class="language-yaml highlighter-rouge">
|
309
|
-
<pre class="highlight"><code><span class="s">source 'https://rubygems.org'</span>
|
308
|
+
<div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="s">source 'https://rubygems.org'</span>
|
310
309
|
|
311
310
|
<span class="s">ruby '2.4.0'</span>
|
312
311
|
|
313
312
|
<span class="s">gem 'jekyll'</span>
|
314
313
|
<span class="s">gem 'html-proofer'</span>
|
315
|
-
</code></pre>
|
316
|
-
</div>
|
314
|
+
</code></pre></div></div>
|
317
315
|
|
318
316
|
<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>
|
319
317
|
|
@@ -321,30 +319,25 @@
|
|
321
319
|
|
322
320
|
<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>
|
323
321
|
|
324
|
-
<div class="highlighter-rouge">
|
325
|
-
<pre class="highlight"><code>dependencies:
|
322
|
+
<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>dependencies:
|
326
323
|
post:
|
327
324
|
- bundle exec jekyll build
|
328
|
-
</code></pre>
|
329
|
-
</div>
|
325
|
+
</code></pre></div></div>
|
330
326
|
|
331
327
|
<h3 id="html-proofer">HTML Proofer</h3>
|
332
328
|
|
333
329
|
<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>
|
334
330
|
|
335
|
-
<div class="language-yaml highlighter-rouge">
|
336
|
-
<
|
337
|
-
<span class="s">post</span><span class="pi">:</span>
|
331
|
+
<div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">test</span><span class="pi">:</span>
|
332
|
+
<span class="na">post</span><span class="pi">:</span>
|
338
333
|
<span class="pi">-</span> <span class="s">bundle exec htmlproofer ./_site --check-html --disable-external</span>
|
339
|
-
</code></pre>
|
340
|
-
</div>
|
334
|
+
</code></pre></div></div>
|
341
335
|
|
342
336
|
<h2 id="complete-example-circleyml-file">Complete Example circle.yml File</h2>
|
343
337
|
|
344
338
|
<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
339
|
|
346
|
-
<div class="highlighter-rouge">
|
347
|
-
<pre class="highlight"><code>machine:
|
340
|
+
<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>machine:
|
348
341
|
environment:
|
349
342
|
NOKOGIRI_USE_SYSTEM_LIBRARIES: true # speeds up installation of html-proofer
|
350
343
|
|
@@ -361,8 +354,7 @@ deployment:
|
|
361
354
|
branch: master
|
362
355
|
commands:
|
363
356
|
- rsync -va --delete ./_site username@my-website:/var/html
|
364
|
-
</code></pre>
|
365
|
-
</div>
|
357
|
+
</code></pre></div></div>
|
366
358
|
|
367
359
|
<h2 id="questions">Questions?</h2>
|
368
360
|
|
@@ -4,13 +4,13 @@
|
|
4
4
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
5
5
|
<meta charset="UTF-8">
|
6
6
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
7
|
-
<meta name="generator" content="Jekyll v3.
|
7
|
+
<meta name="generator" content="Jekyll v3.6.0">
|
8
8
|
<link type="application/atom+xml" rel="alternate" href="https://jekyllrb.com/feed.xml" title="Jekyll • Simple, blog-aware, static sites">
|
9
9
|
<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
10
|
<link rel="stylesheet" href="//fonts.googleapis.com/css?family=Lato:300,300italic,400,400italic,700,700italic,900">
|
11
11
|
<link rel="stylesheet" href="/css/screen.css">
|
12
12
|
<link rel="icon" type="image/x-icon" href="/favicon.ico">
|
13
|
-
<!-- Begin Jekyll SEO tag v2.
|
13
|
+
<!-- Begin Jekyll SEO tag v2.3.0 -->
|
14
14
|
<title>Continuous Integration | Jekyll • Simple, blog-aware, static sites</title>
|
15
15
|
<meta property="og:title" content="Continuous Integration">
|
16
16
|
<meta property="og:locale" content="en_US">
|
@@ -20,12 +20,12 @@
|
|
20
20
|
<meta property="og:url" content="https://jekyllrb.com/docs/continuous-integration/">
|
21
21
|
<meta property="og:site_name" content="Jekyll • Simple, blog-aware, static sites">
|
22
22
|
<meta property="og:type" content="article">
|
23
|
-
<meta property="article:published_time" content="2017-
|
23
|
+
<meta property="article:published_time" content="2017-10-24T08:07:43-07:00">
|
24
24
|
<meta name="twitter:card" content="summary">
|
25
25
|
<meta name="twitter:site" content="@jekyllrb">
|
26
26
|
<meta name="google-site-verification" content="onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY">
|
27
27
|
<script type="application/ld+json">
|
28
|
-
{"
|
28
|
+
{"name":null,"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:","url":"https://jekyllrb.com/docs/continuous-integration/","headline":"Continuous Integration","dateModified":"2017-10-24T08:07:43-07:00","datePublished":"2017-10-24T08:07:43-07:00","sameAs":null,"@type":"BlogPosting","author":null,"image":null,"publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://jekyllrb.com/img/logo-2x.png"}},"mainEntityOfPage":{"@type":"WebPage","@id":"https://jekyllrb.com/docs/continuous-integration/"},"@context":"http://schema.org"}</script>
|
29
29
|
<!-- End Jekyll SEO tag -->
|
30
30
|
|
31
31
|
<!--[if lt IE 9]>
|
@@ -292,7 +292,7 @@
|
|
292
292
|
<ul>
|
293
293
|
<li><a href="travis-ci">Travis CI</a></li>
|
294
294
|
<li><a href="circleci">CircleCI</a></li>
|
295
|
-
<li><a href="buddyworks">
|
295
|
+
<li><a href="buddyworks">Buddy</a></li>
|
296
296
|
</ul>
|
297
297
|
|
298
298
|
|
@@ -4,13 +4,13 @@
|
|
4
4
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
5
5
|
<meta charset="UTF-8">
|
6
6
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
7
|
-
<meta name="generator" content="Jekyll v3.
|
7
|
+
<meta name="generator" content="Jekyll v3.6.0">
|
8
8
|
<link type="application/atom+xml" rel="alternate" href="https://jekyllrb.com/feed.xml" title="Jekyll • Simple, blog-aware, static sites">
|
9
9
|
<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
10
|
<link rel="stylesheet" href="//fonts.googleapis.com/css?family=Lato:300,300italic,400,400italic,700,700italic,900">
|
11
11
|
<link rel="stylesheet" href="/css/screen.css">
|
12
12
|
<link rel="icon" type="image/x-icon" href="/favicon.ico">
|
13
|
-
<!-- Begin Jekyll SEO tag v2.
|
13
|
+
<!-- Begin Jekyll SEO tag v2.3.0 -->
|
14
14
|
<title>Travis CI | Jekyll • Simple, blog-aware, static sites</title>
|
15
15
|
<meta property="og:title" content="Travis CI">
|
16
16
|
<meta property="og:locale" content="en_US">
|
@@ -20,12 +20,12 @@
|
|
20
20
|
<meta property="og:url" content="https://jekyllrb.com/docs/continuous-integration/travis-ci/">
|
21
21
|
<meta property="og:site_name" content="Jekyll • Simple, blog-aware, static sites">
|
22
22
|
<meta property="og:type" content="article">
|
23
|
-
<meta property="article:published_time" content="2017-
|
23
|
+
<meta property="article:published_time" content="2017-10-24T08:07:43-07:00">
|
24
24
|
<meta name="twitter:card" content="summary">
|
25
25
|
<meta name="twitter:site" content="@jekyllrb">
|
26
26
|
<meta name="google-site-verification" content="onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY">
|
27
27
|
<script type="application/ld+json">
|
28
|
-
{"
|
28
|
+
{"name":null,"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.","url":"https://jekyllrb.com/docs/continuous-integration/travis-ci/","headline":"Travis CI","dateModified":"2017-10-24T08:07:43-07:00","datePublished":"2017-10-24T08:07:43-07:00","sameAs":null,"@type":"BlogPosting","author":null,"image":null,"publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://jekyllrb.com/img/logo-2x.png"}},"mainEntityOfPage":{"@type":"WebPage","@id":"https://jekyllrb.com/docs/continuous-integration/travis-ci/"},"@context":"http://schema.org"}</script>
|
29
29
|
<!-- End Jekyll SEO tag -->
|
30
30
|
|
31
31
|
<!--[if lt IE 9]>
|
@@ -318,14 +318,12 @@ or write a Ruby script which utilizes the gem.</p>
|
|
318
318
|
|
319
319
|
<h3 id="the-html-proofer-executable">The HTML Proofer Executable</h3>
|
320
320
|
|
321
|
-
<div class="language-sh highlighter-rouge">
|
322
|
-
<
|
323
|
-
<span class="nb">set</span> -e <span class="c"># halt script on error</span>
|
321
|
+
<div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="c">#!/usr/bin/env bash</span>
|
322
|
+
<span class="nb">set</span> <span class="nt">-e</span> <span class="c"># halt script on error</span>
|
324
323
|
|
325
324
|
bundle <span class="nb">exec </span>jekyll build
|
326
325
|
bundle <span class="nb">exec </span>htmlproofer ./_site
|
327
|
-
</code></pre>
|
328
|
-
</div>
|
326
|
+
</code></pre></div></div>
|
329
327
|
|
330
328
|
<p>Some options can be specified via command-line switches. Check out the
|
331
329
|
<code class="highlighter-rouge">html-proofer</code> README for more information about these switches, or run
|
@@ -333,22 +331,18 @@ bundle <span class="nb">exec </span>htmlproofer ./_site
|
|
333
331
|
|
334
332
|
<p>For example to avoid testing external sites, use this command:</p>
|
335
333
|
|
336
|
-
<div class="language-sh highlighter-rouge">
|
337
|
-
|
338
|
-
</code></pre>
|
339
|
-
</div>
|
334
|
+
<div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>bundle <span class="nb">exec </span>htmlproofer ./_site <span class="nt">--disable-external</span>
|
335
|
+
</code></pre></div></div>
|
340
336
|
|
341
337
|
<h3 id="the-html-proofer-library">The HTML Proofer Library</h3>
|
342
338
|
|
343
339
|
<p>You can also invoke <code class="highlighter-rouge">html-proofer</code> in Ruby scripts (e.g. in a Rakefile):</p>
|
344
340
|
|
345
|
-
<div class="language-ruby highlighter-rouge">
|
346
|
-
<pre class="highlight"><code><span class="c1">#!/usr/bin/env ruby</span>
|
341
|
+
<div class="language-ruby highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="c1">#!/usr/bin/env ruby</span>
|
347
342
|
|
348
343
|
<span class="nb">require</span> <span class="s1">'html-proofer'</span>
|
349
344
|
<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>
|
350
|
-
</code></pre>
|
351
|
-
</div>
|
345
|
+
</code></pre></div></div>
|
352
346
|
|
353
347
|
<p>Options are given as a second argument to <code class="highlighter-rouge">.new</code>, and are encoded in a
|
354
348
|
symbol-keyed Ruby Hash. For more information about the configuration options,
|
@@ -363,77 +357,65 @@ an explanation of each line.</p>
|
|
363
357
|
|
364
358
|
<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>
|
365
359
|
|
366
|
-
<div class="language-ruby highlighter-rouge">
|
367
|
-
<pre class="highlight"><code><span class="n">source</span> <span class="s2">"https://rubygems.org"</span>
|
360
|
+
<div class="language-ruby highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="n">source</span> <span class="s2">"https://rubygems.org"</span>
|
368
361
|
|
369
362
|
<span class="n">gem</span> <span class="s2">"jekyll"</span>
|
370
363
|
<span class="n">gem</span> <span class="s2">"html-proofer"</span>
|
371
|
-
</code></pre>
|
372
|
-
</div>
|
364
|
+
</code></pre></div></div>
|
373
365
|
|
374
366
|
<p>Your <code class="highlighter-rouge">.travis.yml</code> file should look like this:</p>
|
375
367
|
|
376
|
-
<div class="language-yaml highlighter-rouge">
|
377
|
-
<
|
378
|
-
<span class="s">rvm</span><span class="pi">:</span>
|
368
|
+
<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>
|
369
|
+
<span class="na">rvm</span><span class="pi">:</span>
|
379
370
|
<span class="pi">-</span> <span class="s">2.3.3</span>
|
380
371
|
|
381
|
-
<span class="
|
372
|
+
<span class="na">before_script</span><span class="pi">:</span>
|
382
373
|
<span class="pi">-</span> <span class="s">chmod +x ./script/cibuild</span> <span class="c1"># or do this locally and commit</span>
|
383
374
|
|
384
375
|
<span class="c1"># Assume bundler is being used, therefore</span>
|
385
376
|
<span class="c1"># the `install` step will run `bundle install` by default.</span>
|
386
|
-
<span class="
|
377
|
+
<span class="na">script</span><span class="pi">:</span> <span class="s">./script/cibuild</span>
|
387
378
|
|
388
379
|
<span class="c1"># branch whitelist, only for GitHub Pages</span>
|
389
|
-
<span class="
|
390
|
-
<span class="
|
380
|
+
<span class="na">branches</span><span class="pi">:</span>
|
381
|
+
<span class="na">only</span><span class="pi">:</span>
|
391
382
|
<span class="pi">-</span> <span class="s">gh-pages</span> <span class="c1"># test the gh-pages branch</span>
|
392
383
|
<span class="pi">-</span> <span class="s">/pages-(.*)/</span> <span class="c1"># test every branch which starts with "pages-"</span>
|
393
384
|
|
394
|
-
<span class="
|
395
|
-
<span class="
|
385
|
+
<span class="na">env</span><span class="pi">:</span>
|
386
|
+
<span class="na">global</span><span class="pi">:</span>
|
396
387
|
<span class="pi">-</span> <span class="s">NOKOGIRI_USE_SYSTEM_LIBRARIES=true</span> <span class="c1"># speeds up installation of html-proofer</span>
|
397
388
|
|
398
|
-
<span class="
|
399
|
-
</code></pre>
|
400
|
-
</div>
|
389
|
+
<span class="na">sudo</span><span class="pi">:</span> <span class="no">false</span> <span class="c1"># route your build to the container-based infrastructure for a faster build</span>
|
390
|
+
</code></pre></div></div>
|
401
391
|
|
402
392
|
<p>Ok, now for an explanation of each line:</p>
|
403
393
|
|
404
|
-
<div class="language-yaml highlighter-rouge">
|
405
|
-
|
406
|
-
</code></pre>
|
407
|
-
</div>
|
394
|
+
<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>
|
395
|
+
</code></pre></div></div>
|
408
396
|
|
409
397
|
<p>This line tells Travis to use a Ruby build container. It gives your script
|
410
398
|
access to Bundler, RubyGems, and a Ruby runtime.</p>
|
411
399
|
|
412
|
-
<div class="language-yaml highlighter-rouge">
|
413
|
-
<pre class="highlight"><code><span class="s">rvm</span><span class="pi">:</span>
|
400
|
+
<div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">rvm</span><span class="pi">:</span>
|
414
401
|
<span class="pi">-</span> <span class="s">2.3.3</span>
|
415
|
-
</code></pre>
|
416
|
-
</div>
|
402
|
+
</code></pre></div></div>
|
417
403
|
|
418
404
|
<p>RVM is a popular Ruby Version Manager (like rbenv, chruby, etc). This
|
419
405
|
directive tells Travis the Ruby version to use when running your test
|
420
406
|
script.</p>
|
421
407
|
|
422
|
-
<div class="language-yaml highlighter-rouge">
|
423
|
-
<pre class="highlight"><code><span class="s">before_script</span><span class="pi">:</span>
|
408
|
+
<div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">before_script</span><span class="pi">:</span>
|
424
409
|
<span class="pi">-</span> <span class="s">chmod +x ./script/cibuild</span>
|
425
|
-
</code></pre>
|
426
|
-
</div>
|
410
|
+
</code></pre></div></div>
|
427
411
|
|
428
412
|
<p>The build script file needs to have the <em>executable</em> attribute set or
|
429
413
|
Travis will fail with a permission denied error. You can also run this
|
430
414
|
locally and commit the permissions directly, thus rendering this step
|
431
415
|
irrelevant.</p>
|
432
416
|
|
433
|
-
<div class="language-yaml highlighter-rouge">
|
434
|
-
|
435
|
-
</code></pre>
|
436
|
-
</div>
|
417
|
+
<div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">script</span><span class="pi">:</span> <span class="s">./script/cibuild</span>
|
418
|
+
</code></pre></div></div>
|
437
419
|
|
438
420
|
<p>Travis allows you to run any arbitrary shell script to test your site. One
|
439
421
|
convention is to put all scripts for your project in the <code class="highlighter-rouge">script</code>
|
@@ -441,22 +423,18 @@ directory, and to call your test script <code class="highlighter-rouge">cibuild<
|
|
441
423
|
customizable. If your script won’t change much, you can write your test
|
442
424
|
incantation here directly:</p>
|
443
425
|
|
444
|
-
<div class="language-yaml highlighter-rouge">
|
445
|
-
<
|
446
|
-
|
447
|
-
</code></pre>
|
448
|
-
</div>
|
426
|
+
<div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">install</span><span class="pi">:</span> <span class="s">gem install jekyll html-proofer</span>
|
427
|
+
<span class="na">script</span><span class="pi">:</span> <span class="s">jekyll build && htmlproofer ./_site</span>
|
428
|
+
</code></pre></div></div>
|
449
429
|
|
450
430
|
<p>The <code class="highlighter-rouge">script</code> directive can be absolutely any valid shell command.</p>
|
451
431
|
|
452
|
-
<div class="language-yaml highlighter-rouge">
|
453
|
-
<
|
454
|
-
<span class="
|
455
|
-
<span class="s">only</span><span class="pi">:</span>
|
432
|
+
<div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="c1"># branch whitelist, only for GitHub Pages</span>
|
433
|
+
<span class="na">branches</span><span class="pi">:</span>
|
434
|
+
<span class="na">only</span><span class="pi">:</span>
|
456
435
|
<span class="pi">-</span> <span class="s">gh-pages</span> <span class="c1"># test the gh-pages branch</span>
|
457
436
|
<span class="pi">-</span> <span class="s">/pages-(.*)/</span> <span class="c1"># test every branch which starts with "pages-"</span>
|
458
|
-
</code></pre>
|
459
|
-
</div>
|
437
|
+
</code></pre></div></div>
|
460
438
|
|
461
439
|
<p>You want to ensure the Travis builds for your site are being run only on
|
462
440
|
the branch or branches which contain your site. One means of ensuring this
|
@@ -470,12 +448,10 @@ prefixed, exemplified above with the <code class="highlighter-rouge">/pages-(.*)
|
|
470
448
|
<p>The <code class="highlighter-rouge">branches</code> directive is completely optional. Travis will build from every
|
471
449
|
push to any branch of your repo if leave it out.</p>
|
472
450
|
|
473
|
-
<div class="language-yaml highlighter-rouge">
|
474
|
-
<
|
475
|
-
<span class="s">global</span><span class="pi">:</span>
|
451
|
+
<div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">env</span><span class="pi">:</span>
|
452
|
+
<span class="na">global</span><span class="pi">:</span>
|
476
453
|
<span class="pi">-</span> <span class="s">NOKOGIRI_USE_SYSTEM_LIBRARIES=true</span> <span class="c1"># speeds up installation of html-proofer</span>
|
477
|
-
</code></pre>
|
478
|
-
</div>
|
454
|
+
</code></pre></div></div>
|
479
455
|
|
480
456
|
<p>Using <code class="highlighter-rouge">html-proofer</code>? You’ll want this environment variable. Nokogiri, used
|
481
457
|
to parse HTML files in your compiled site, comes bundled with libraries
|
@@ -491,10 +467,8 @@ environment variable <code class="highlighter-rouge">NOKOGIRI_USE_SYSTEM_LIBRARI
|
|
491
467
|
servers, which Jekyll will mistakenly read and explode on.</p>
|
492
468
|
</div>
|
493
469
|
|
494
|
-
<div class="language-yaml highlighter-rouge">
|
495
|
-
|
496
|
-
</code></pre>
|
497
|
-
</div>
|
470
|
+
<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>
|
471
|
+
</code></pre></div></div>
|
498
472
|
|
499
473
|
<p>By default you should supply the <code class="highlighter-rouge">sudo: false</code> command to Travis. This command
|
500
474
|
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
|
@@ -502,10 +476,8 @@ explicitly tells Travis to run your build on Travis’s <a href="https://docs.tr
|
|
502
476
|
speed up your build. If you have any trouble with your build, or if your build
|
503
477
|
does need <code class="highlighter-rouge">sudo</code> access, modify the line to <code class="highlighter-rouge">sudo: required</code>.</p>
|
504
478
|
|
505
|
-
<div class="language-yaml highlighter-rouge">
|
506
|
-
|
507
|
-
</code></pre>
|
508
|
-
</div>
|
479
|
+
<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>
|
480
|
+
</code></pre></div></div>
|
509
481
|
|
510
482
|
<h3 id="troubleshooting">Troubleshooting</h3>
|
511
483
|
|