jekyll-docs 3.3.1 → 3.4.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (125) hide show
  1. checksums.yaml +4 -4
  2. data/site/404.html +3 -3
  3. data/site/community/index.html +5 -5
  4. data/site/css/screen.css +7 -6
  5. data/site/docs/assets/index.html +13 -5
  6. data/site/docs/collections/index.html +132 -29
  7. data/site/docs/conduct/index.html +16 -5
  8. data/site/docs/configuration/index.html +26 -8
  9. data/site/docs/continuous-integration/circleci/index.html +761 -0
  10. data/site/docs/continuous-integration/index.html +25 -245
  11. data/site/docs/continuous-integration/travis-ci/index.html +916 -0
  12. data/site/docs/contributing/index.html +41 -5
  13. data/site/docs/datafiles/index.html +14 -6
  14. data/site/docs/deployment-methods/index.html +17 -7
  15. data/site/docs/drafts/index.html +13 -5
  16. data/site/docs/extras/index.html +17 -6
  17. data/site/docs/frontmatter/index.html +13 -5
  18. data/site/docs/github-pages/index.html +68 -47
  19. data/site/docs/history/index.html +132 -9
  20. data/site/docs/home/index.html +13 -5
  21. data/site/docs/includes/index.html +824 -0
  22. data/site/docs/installation/index.html +16 -6
  23. data/site/docs/maintaining/affinity-team-captain/index.html +16 -5
  24. data/site/docs/maintaining/avoiding-burnout/index.html +16 -5
  25. data/site/docs/maintaining/becoming-a-maintainer/index.html +17 -6
  26. data/site/docs/maintaining/index.html +16 -5
  27. data/site/docs/maintaining/merging-a-pull-request/index.html +21 -6
  28. data/site/docs/maintaining/reviewing-a-pull-request/index.html +16 -5
  29. data/site/docs/maintaining/special-labels/index.html +16 -5
  30. data/site/docs/maintaining/triaging-an-issue/index.html +16 -5
  31. data/site/docs/migrations/index.html +13 -5
  32. data/site/docs/pages/index.html +33 -50
  33. data/site/docs/pagination/index.html +16 -5
  34. data/site/docs/permalinks/index.html +148 -66
  35. data/site/docs/plugins/index.html +39 -14
  36. data/site/docs/posts/index.html +32 -5
  37. data/site/docs/quickstart/index.html +57 -18
  38. data/site/docs/resources/index.html +21 -10
  39. data/site/docs/sites/index.html +18 -7
  40. data/site/docs/static-files/index.html +15 -7
  41. data/site/docs/structure/index.html +47 -32
  42. data/site/docs/templates/index.html +85 -89
  43. data/site/docs/themes/index.html +214 -63
  44. data/site/docs/troubleshooting/index.html +16 -5
  45. data/site/docs/upgrading/0-to-2/index.html +16 -5
  46. data/site/docs/upgrading/2-to-3/index.html +17 -6
  47. data/site/docs/upgrading/index.html +16 -5
  48. data/site/docs/usage/index.html +21 -6
  49. data/site/docs/variables/index.html +14 -6
  50. data/site/docs/windows/index.html +35 -10
  51. data/site/feed.xml +41 -22
  52. data/site/fonts/FontAwesome.eot +0 -0
  53. data/site/fonts/FontAwesome.svg +12 -0
  54. data/site/fonts/FontAwesome.ttf +0 -0
  55. data/site/fonts/FontAwesome.woff +0 -0
  56. data/site/help/index.html +3 -3
  57. data/site/icomoon-selection.json +96 -0
  58. data/site/index.html +3 -3
  59. data/site/latest_version.txt +1 -1
  60. data/site/news/2013/05/05/jekyll-1-0-0-released/index.html +12 -8
  61. data/site/news/2013/05/08/jekyll-1-0-1-released/index.html +11 -7
  62. data/site/news/2013/05/12/jekyll-1-0-2-released/index.html +11 -7
  63. data/site/news/2013/06/07/jekyll-1-0-3-released/index.html +11 -7
  64. data/site/news/2013/07/14/jekyll-1-1-0-released/index.html +11 -7
  65. data/site/news/2013/07/24/jekyll-1-1-1-released/index.html +12 -8
  66. data/site/news/2013/07/25/jekyll-1-0-4-released/index.html +11 -7
  67. data/site/news/2013/07/25/jekyll-1-1-2-released/index.html +11 -7
  68. data/site/news/2013/09/06/jekyll-1-2-0-released/index.html +11 -7
  69. data/site/news/2013/09/14/jekyll-1-2-1-released/index.html +11 -7
  70. data/site/news/2013/10/28/jekyll-1-3-0-rc1-released/index.html +11 -7
  71. data/site/news/2013/11/04/jekyll-1-3-0-released/index.html +11 -7
  72. data/site/news/2013/11/26/jekyll-1-3-1-released/index.html +11 -7
  73. data/site/news/2013/12/07/jekyll-1-4-0-released/index.html +11 -7
  74. data/site/news/2013/12/09/jekyll-1-4-1-released/index.html +11 -7
  75. data/site/news/2013/12/16/jekyll-1-4-2-released/index.html +11 -7
  76. data/site/news/2014/01/13/jekyll-1-4-3-released/index.html +11 -7
  77. data/site/news/2014/03/24/jekyll-1-5-0-released/index.html +11 -7
  78. data/site/news/2014/03/27/jekyll-1-5-1-released/index.html +11 -7
  79. data/site/news/2014/05/06/jekyll-turns-2-0-0/index.html +11 -7
  80. data/site/news/2014/05/08/jekyll-2-0-3-released/index.html +11 -7
  81. data/site/news/2014/06/04/jekyll-stickers-1-dollar-stickermule/index.html +12 -8
  82. data/site/news/2014/06/28/jekyll-turns-21-i-mean-2-1-0/index.html +12 -8
  83. data/site/news/2014/07/01/jekyll-2-1-1-released/index.html +11 -7
  84. data/site/news/2014/07/29/jekyll-2-2-0-released/index.html +11 -7
  85. data/site/news/2014/08/10/jekyll-2-3-0-released/index.html +11 -7
  86. data/site/news/2014/09/09/jekyll-2-4-0-released/index.html +11 -7
  87. data/site/news/2014/11/05/jekylls-midlife-crisis-jekyll-turns-2-5-0/index.html +11 -7
  88. data/site/news/2014/11/09/jekyll-2-5-1-released/index.html +11 -7
  89. data/site/news/2014/11/12/jekyll-2-5-2-released/index.html +11 -7
  90. data/site/news/2014/12/17/alfredxing-welcome-to-jekyll-core/index.html +12 -8
  91. data/site/news/2014/12/22/jekyll-2-5-3-released/index.html +11 -7
  92. data/site/news/2015/01/20/jekyll-meet-and-greet/index.html +11 -7
  93. data/site/news/2015/01/24/jekyll-3-0-0-beta1-released/index.html +11 -7
  94. data/site/news/2015/02/26/introducing-jekyll-talk/index.html +11 -7
  95. data/site/news/2015/10/26/jekyll-3-0-released/index.html +11 -7
  96. data/site/news/2015/11/17/jekyll-3-0-1-released/index.html +11 -7
  97. data/site/news/2016/01/20/jekyll-3-0-2-released/index.html +11 -7
  98. data/site/news/2016/01/24/jekyll-3-1-0-released/index.html +11 -7
  99. data/site/news/2016/01/28/jekyll-3-1-1-released/index.html +11 -7
  100. data/site/news/2016/02/08/jekyll-3-0-3-released/index.html +11 -7
  101. data/site/news/2016/02/19/jekyll-3-1-2-released/index.html +11 -7
  102. data/site/news/2016/03/10/making-it-easier-to-contribute-to-jekyll/index.html +11 -7
  103. data/site/news/2016/04/19/jekyll-3-0-4-released/index.html +11 -7
  104. data/site/news/2016/04/19/jekyll-3-1-3-released/index.html +11 -8
  105. data/site/news/2016/04/26/jekyll-3-0-5-released/index.html +11 -7
  106. data/site/news/2016/05/18/jekyll-3-1-4-released/index.html +11 -7
  107. data/site/news/2016/05/18/jekyll-3-1-5-released/index.html +11 -7
  108. data/site/news/2016/05/19/jekyll-3-1-6-released/index.html +11 -7
  109. data/site/news/2016/06/03/update-on-jekyll-s-google-summer-of-code-projects/index.html +11 -7
  110. data/site/news/2016/07/26/jekyll-3-2-0-released/index.html +11 -7
  111. data/site/news/2016/08/02/jekyll-3-2-1-released/index.html +11 -7
  112. data/site/news/2016/08/24/jekyll-admin-initial-release/index.html +12 -8
  113. data/site/news/2016/10/06/jekyll-3-3-is-here/index.html +12 -8
  114. data/site/news/2016/11/14/jekyll-3-3-1-released/index.html +11 -7
  115. data/site/news/2017/01/18/jekyll-3-4-0-released/index.html +570 -0
  116. data/site/news/index.html +81 -15
  117. data/site/news/releases/index.html +78 -12
  118. data/site/readme.md +9 -2
  119. data/site/sitemap.xml +59 -43
  120. metadata +14 -10
  121. data/site/fonts/fontawesome-webfont.eot +0 -0
  122. data/site/fonts/fontawesome-webfont.svg +0 -640
  123. data/site/fonts/fontawesome-webfont.ttf +0 -0
  124. data/site/fonts/fontawesome-webfont.woff +0 -0
  125. data/site/fonts/fontawesome-webfont.woff2 +0 -0
@@ -4,7 +4,7 @@
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.3.1">
7
+ <meta name="generator" content="Jekyll v3.4.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">
@@ -19,7 +19,7 @@
19
19
  <meta property="og:url" content="https://jekyllrb.com/docs/configuration/">
20
20
  <meta property="og:site_name" content="Jekyll • Simple, blog-aware, static sites">
21
21
  <meta property="og:type" content="article">
22
- <meta property="article:published_time" content="2017-01-20T13:17:57-08:00">
22
+ <meta property="article:published_time" content="2017-03-22T08:06:48-07:00">
23
23
  <meta name="twitter:card" content="summary">
24
24
  <meta name="twitter:site" content="@jekyllrb">
25
25
  <meta name="google-site-verification" content="onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY">
@@ -27,7 +27,7 @@
27
27
  {"@context": "http://schema.org",
28
28
  "@type": "BlogPosting",
29
29
  "headline": "Configuration",
30
- "datePublished": "2017-01-20T13:17:57-08:00",
30
+ "datePublished": "2017-03-22T08:06:48-07:00",
31
31
  "description": "Jekyll allows you to concoct your sites in any way you can dream up, and it’s thanks to the powerful and flexible configuration options that this is possible. These options can either be specified in a _config.yml file placed in your site’s root directory, or can be specified as flags for the jekyll executable in the terminal.",
32
32
  "publisher": {"@type": "Organization",
33
33
  "logo": {"@type": "ImageObject",
@@ -192,6 +192,10 @@
192
192
 
193
193
 
194
194
 
195
+ <option value="/docs/includes/">Includes</option>
196
+
197
+
198
+
195
199
  <option value="/docs/permalinks/">Permalinks</option>
196
200
 
197
201
 
@@ -503,10 +507,20 @@ in the terminal.</p>
503
507
  <p><code class="flag">--future</code></p>
504
508
  </td>
505
509
  </tr>
510
+ <tr class="setting">
511
+ <td>
512
+ <p class="name"><strong>Unpublished</strong></p>
513
+ <p class="description">Render posts that were marked as unpublished.</p>
514
+ </td>
515
+ <td class="align-center">
516
+ <p><code class="option">unpublished: BOOL</code></p>
517
+ <p><code class="flag">--unpublished</code></p>
518
+ </td>
519
+ </tr>
506
520
  <tr class="setting">
507
521
  <td>
508
522
  <p class="name"><strong>LSI</strong></p>
509
- <p class="description">Produce an index for related posts.</p>
523
+ <p class="description">Produce an index for related posts. Requires the <a href="http://www.classifier-reborn.com/">classifier-reborn</a> plugin.</p>
510
524
  </td>
511
525
  <td class="align-center">
512
526
  <p><code class="option">lsi: BOOL</code></p>
@@ -802,8 +816,8 @@ The different types that are available to you are <code class="highlighter-rouge
802
816
 
803
817
  <div class="language-yaml highlighter-rouge">
804
818
  <pre class="highlight"><code><span class="s">collections</span><span class="pi">:</span>
805
- <span class="pi">-</span> <span class="s">my_collection</span><span class="pi">:</span>
806
- <span class="s">output</span><span class="pi">:</span> <span class="s">true</span>
819
+ <span class="s">my_collection</span><span class="pi">:</span>
820
+ <span class="s">output</span><span class="pi">:</span> <span class="s">true</span>
807
821
 
808
822
  <span class="s">defaults</span><span class="pi">:</span>
809
823
  <span class="pi">-</span>
@@ -1212,6 +1226,10 @@ configuration file.</p>
1212
1226
 
1213
1227
 
1214
1228
 
1229
+ <li class=""><a href="/docs/includes/">Includes</a></li>
1230
+
1231
+
1232
+
1215
1233
  <li class=""><a href="/docs/permalinks/">Permalinks</a></li>
1216
1234
 
1217
1235
 
@@ -1360,7 +1378,7 @@ configuration file.</p>
1360
1378
  </script>
1361
1379
 
1362
1380
 
1363
- <!-- Gauges (http://gaug.es/) -->
1381
+ <!-- Gauges (http://get.gaug.es/) -->
1364
1382
  <script>
1365
1383
  var _gauges = _gauges || [];
1366
1384
  (function() {
@@ -1377,7 +1395,7 @@ configuration file.</p>
1377
1395
 
1378
1396
 
1379
1397
 
1380
- <!-- Google Analytics (http://google.com/analytics) -->
1398
+ <!-- Google Analytics (https://www.google.com/analytics) -->
1381
1399
  <script>
1382
1400
  !function(j,e,k,y,l,L){j.GoogleAnalyticsObject=y,j[y]||(j[y]=function(){
1383
1401
  (j[y].q=j[y].q||[]).push(arguments)}),j[y].l=+new Date,l=e.createElement(k),
@@ -0,0 +1,761 @@
1
+ <!DOCTYPE HTML>
2
+ <html lang="en-US">
3
+ <head>
4
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
+ <meta charset="UTF-8">
6
+ <meta name="viewport" content="width=device-width,initial-scale=1">
7
+ <meta name="generator" content="Jekyll v3.4.0">
8
+ <link type="application/atom+xml" rel="alternate" href="https://jekyllrb.com/feed.xml" title="Jekyll • Simple, blog-aware, static sites">
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
+ <link rel="stylesheet" href="//fonts.googleapis.com/css?family=Lato:300,300italic,400,400italic,700,700italic,900">
11
+ <link rel="stylesheet" href="/css/screen.css">
12
+ <link rel="icon" type="image/x-icon" href="/favicon.ico">
13
+ <!-- Begin Jekyll SEO tag v2.1.0 -->
14
+ <title>CircleCI - Jekyll • Simple, blog-aware, static sites</title>
15
+ <meta property="og:title" content="CircleCI">
16
+ <meta name="description" content="Building, testing, and deploying your Jekyll-generated website can quickly be done with CircleCI, a continuous integration &amp; delivery tool. CircleCI supports GitHub and Bitbucket, and you can get started for free using an open-source or private repository.">
17
+ <meta property="og:description" content="Building, testing, and deploying your Jekyll-generated website can quickly be done with CircleCI, a continuous integration &amp; delivery tool. CircleCI supports GitHub and Bitbucket, and you can get started for free using an open-source or private repository.">
18
+ <link rel="canonical" href="https://jekyllrb.com/docs/continuous-integration/circleci/">
19
+ <meta property="og:url" content="https://jekyllrb.com/docs/continuous-integration/circleci/">
20
+ <meta property="og:site_name" content="Jekyll • Simple, blog-aware, static sites">
21
+ <meta property="og:type" content="article">
22
+ <meta property="article:published_time" content="2017-03-22T08:06:48-07:00">
23
+ <meta name="twitter:card" content="summary">
24
+ <meta name="twitter:site" content="@jekyllrb">
25
+ <meta name="google-site-verification" content="onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY">
26
+ <script type="application/ld+json">
27
+ {"@context": "http://schema.org",
28
+ "@type": "BlogPosting",
29
+ "headline": "CircleCI",
30
+ "datePublished": "2017-03-22T08:06:48-07:00",
31
+ "description": "Building, testing, and deploying your Jekyll-generated website can quickly be done with CircleCI, a continuous integration &amp; delivery tool. CircleCI supports GitHub and Bitbucket, and you can get started for free using an open-source or private repository.",
32
+ "publisher": {"@type": "Organization",
33
+ "logo": {"@type": "ImageObject",
34
+ "url": "https://jekyllrb.com/img/logo-2x.png"}},
35
+ "url": "https://jekyllrb.com/docs/continuous-integration/circleci/"}</script>
36
+ <!-- End Jekyll SEO tag -->
37
+
38
+ <!--[if lt IE 9]>
39
+ <script src="/js/html5shiv.min.js"></script>
40
+ <script src="/js/respond.min.js"></script>
41
+ <![endif]-->
42
+ </head>
43
+
44
+
45
+ <body class="wrap">
46
+ <header>
47
+ <nav class="mobile-nav show-on-mobiles">
48
+ <ul>
49
+ <li class="">
50
+ <a href="/">Home</a>
51
+ </li>
52
+ <li class="current">
53
+ <a href="/docs/home/">Docs</a>
54
+ </li>
55
+ <li class="">
56
+ <a href="/news/">News</a>
57
+ </li>
58
+ <li class="">
59
+ <a href="/community/">Community</a>
60
+ </li>
61
+ <li class="">
62
+ <a href="/help/">Help</a>
63
+ </li>
64
+ <li>
65
+ <a href="https://github.com/jekyll/jekyll"><span class="hide-on-mobiles">View on </span>GitHub</a>
66
+ </li>
67
+ </ul>
68
+
69
+ </nav>
70
+ <div class="grid">
71
+ <div class="unit one-third center-on-mobiles">
72
+ <h1>
73
+ <a href="/">
74
+ <span class="sr-only">Jekyll</span>
75
+ <img src="/img/logo-2x.png" width="249" height="115" alt="Jekyll Logo">
76
+ </a>
77
+ </h1>
78
+ </div>
79
+ <nav class="main-nav unit two-thirds hide-on-mobiles">
80
+ <ul>
81
+ <li class="">
82
+ <a href="/">Home</a>
83
+ </li>
84
+ <li class="current">
85
+ <a href="/docs/home/">Docs</a>
86
+ </li>
87
+ <li class="">
88
+ <a href="/news/">News</a>
89
+ </li>
90
+ <li class="">
91
+ <a href="/community/">Community</a>
92
+ </li>
93
+ <li class="">
94
+ <a href="/help/">Help</a>
95
+ </li>
96
+ <li>
97
+ <a href="https://github.com/jekyll/jekyll"><span class="hide-on-mobiles">View on </span>GitHub</a>
98
+ </li>
99
+ </ul>
100
+
101
+ </nav>
102
+ </div>
103
+ </header>
104
+
105
+
106
+ <section class="docs">
107
+ <div class="grid">
108
+
109
+ <div class="docs-nav-mobile unit whole show-on-mobiles">
110
+ <select onchange="if (this.value) window.location.href=this.value">
111
+ <option value="">Navigate the docs…</option>
112
+
113
+ <optgroup label="Getting Started">
114
+
115
+
116
+
117
+ <option value="/docs/home/">Welcome</option>
118
+
119
+
120
+
121
+ <option value="/docs/quickstart/">Quick-start guide</option>
122
+
123
+
124
+
125
+ <option value="/docs/installation/">Installation</option>
126
+
127
+
128
+
129
+ <option value="/docs/usage/">Basic Usage</option>
130
+
131
+
132
+
133
+ <option value="/docs/structure/">Directory structure</option>
134
+
135
+
136
+
137
+ <option value="/docs/configuration/">Configuration</option>
138
+
139
+
140
+ </optgroup>
141
+
142
+ <optgroup label="Your Content">
143
+
144
+
145
+
146
+ <option value="/docs/frontmatter/">Front Matter</option>
147
+
148
+
149
+
150
+ <option value="/docs/posts/">Writing posts</option>
151
+
152
+
153
+
154
+ <option value="/docs/drafts/">Working with drafts</option>
155
+
156
+
157
+
158
+ <option value="/docs/pages/">Creating pages</option>
159
+
160
+
161
+
162
+ <option value="/docs/static-files/">Static Files</option>
163
+
164
+
165
+
166
+ <option value="/docs/variables/">Variables</option>
167
+
168
+
169
+
170
+ <option value="/docs/collections/">Collections</option>
171
+
172
+
173
+
174
+ <option value="/docs/datafiles/">Data Files</option>
175
+
176
+
177
+
178
+ <option value="/docs/assets/">Assets</option>
179
+
180
+
181
+
182
+ <option value="/docs/migrations/">Blog migrations</option>
183
+
184
+
185
+ </optgroup>
186
+
187
+ <optgroup label="Customization">
188
+
189
+
190
+
191
+ <option value="/docs/templates/">Templates</option>
192
+
193
+
194
+
195
+ <option value="/docs/includes/">Includes</option>
196
+
197
+
198
+
199
+ <option value="/docs/permalinks/">Permalinks</option>
200
+
201
+
202
+
203
+ <option value="/docs/pagination/">Pagination</option>
204
+
205
+
206
+
207
+ <option value="/docs/plugins/">Plugins</option>
208
+
209
+
210
+
211
+ <option value="/docs/themes/">Themes</option>
212
+
213
+
214
+
215
+ <option value="/docs/extras/">Extras</option>
216
+
217
+
218
+ </optgroup>
219
+
220
+ <optgroup label="Deployment">
221
+
222
+
223
+
224
+ <option value="/docs/github-pages/">GitHub Pages</option>
225
+
226
+
227
+
228
+ <option value="/docs/deployment-methods/">Deployment methods</option>
229
+
230
+
231
+
232
+ <option value="/docs/continuous-integration/">Continuous Integration</option>
233
+
234
+
235
+ </optgroup>
236
+
237
+ <optgroup label="Miscellaneous">
238
+
239
+
240
+
241
+ <option value="/docs/troubleshooting/">Troubleshooting</option>
242
+
243
+
244
+
245
+ <option value="/docs/sites/">Sites using Jekyll</option>
246
+
247
+
248
+
249
+ <option value="/docs/resources/">Resources</option>
250
+
251
+
252
+
253
+ <option value="/docs/upgrading/0-to-2/">Upgrading from 0.x to 2.x</option>
254
+
255
+
256
+
257
+ <option value="/docs/upgrading/2-to-3/">Upgrading from 2.x to 3.x</option>
258
+
259
+
260
+ </optgroup>
261
+
262
+ <optgroup label="Meta">
263
+
264
+
265
+
266
+ <option value="/docs/contributing/">Contributing</option>
267
+
268
+
269
+
270
+ <option value="/docs/maintaining/">Maintaining Jekyll</option>
271
+
272
+
273
+
274
+ <option value="/docs/conduct/">Code of Conduct</option>
275
+
276
+
277
+
278
+ <option value="/docs/history/">History</option>
279
+
280
+
281
+ </optgroup>
282
+
283
+ </select>
284
+ </div>
285
+
286
+
287
+ <div class="unit four-fifths">
288
+ <article>
289
+ <div class="improve right hide-on-mobiles">
290
+ <a href="https://github.com/jekyll/jekyll/edit/master/docs/_docs/continuous-integration/circleci.md"><i class="fa fa-pencil"></i>  Improve this page</a>
291
+ </div>
292
+ <h1>CircleCI</h1>
293
+ <p>Building, testing, and deploying your Jekyll-generated website can quickly be done with <a href="https://circleci.com/">CircleCI</a>, a continuous integration &amp; delivery tool. CircleCI supports <a href="https://github.com/">GitHub</a> and <a href="https://bitbucket.org/">Bitbucket</a>, and you can get started for free using an open-source or private repository.</p>
294
+
295
+ <h2 id="1-follow-your-project-on-circleci">1. Follow Your Project on CircleCI</h2>
296
+
297
+ <p>To start building your project on CircleCI, all you need to do is ‘follow’ your project from CircleCI’s website:</p>
298
+
299
+ <ol>
300
+ <li>Visit the ‘Add Projects’ page: <a href="https://circleci.com/add-projects">https://circleci.com/add-projects</a>
301
+ </li>
302
+ <li>From the GitHub or Bitbucket tab on the left, choose a user or organization.</li>
303
+ <li>Find your project in the list and click ‘Build project’ on the right.</li>
304
+ <li>The first build will start on its own. You can start telling CircleCI how to build your project by creating a <a href="https://circleci.com/docs/configuration/">circle.yml</a> file in the root of your repository.</li>
305
+ </ol>
306
+
307
+ <h2 id="2-dependencies">2. Dependencies</h2>
308
+
309
+ <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>
310
+
311
+ <div class="language-yaml highlighter-rouge">
312
+ <pre class="highlight"><code><span class="s">source 'https://rubygems.org'</span>
313
+
314
+ <span class="s">ruby '2.4.0'</span>
315
+
316
+ <span class="s">gem 'jekyll'</span>
317
+ <span class="s">gem 'html-proofer'</span>
318
+ </code></pre>
319
+ </div>
320
+
321
+ <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>
322
+
323
+ <h2 id="3-testing">3. Testing</h2>
324
+
325
+ <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>
326
+
327
+ <div class="highlighter-rouge">
328
+ <pre class="highlight"><code>dependencies:
329
+ post:
330
+ - bundle exec jekyll build
331
+ </code></pre>
332
+ </div>
333
+
334
+ <h3 id="html-proofer">HTML Proofer</h3>
335
+
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="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>
337
+
338
+ <div class="language-yaml highlighter-rouge">
339
+ <pre class="highlight"><code><span class="s">test</span><span class="pi">:</span>
340
+ <span class="s">post</span><span class="pi">:</span>
341
+ <span class="pi">-</span> <span class="s">bundle exec htmlproofer ./_site --check-html --disable-external</span>
342
+ </code></pre>
343
+ </div>
344
+
345
+ <h2 id="complete-example-circleyml-file">Complete Example circle.yml File</h2>
346
+
347
+ <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>
348
+
349
+ <div class="highlighter-rouge">
350
+ <pre class="highlight"><code>machine:
351
+ environment:
352
+ NOKOGIRI_USE_SYSTEM_LIBRARIES: true # speeds up installation of html-proofer
353
+
354
+ dependencies:
355
+ post:
356
+ - bundle exec jekyll build
357
+
358
+ test:
359
+ post:
360
+ - bundle exec htmlproofer ./_site --allow-hash-href --check-favicon --check-html --disable-external
361
+
362
+ deployment:
363
+ prod:
364
+ branch: master
365
+ commands:
366
+ - rsync -va --delete ./_site username@my-website:/var/html
367
+ </code></pre>
368
+ </div>
369
+
370
+ <h2 id="questions">Questions?</h2>
371
+
372
+ <p>This entire guide is open-source. Go ahead and <a href="https://github.com/jekyll/jekyll/edit/master/docs/_docs/continuous-integration/circleci.md">edit it</a> if you have a fix or <a href="https://jekyllrb.com/help/">ask for help</a> if you run into trouble and need some help. CircleCI also has an <a href="https://discuss.circleci.com">online community</a> for help.</p>
373
+
374
+
375
+
376
+
377
+
378
+
379
+
380
+
381
+
382
+
383
+
384
+
385
+
386
+
387
+
388
+
389
+
390
+
391
+
392
+
393
+
394
+
395
+
396
+
397
+
398
+
399
+
400
+
401
+
402
+
403
+
404
+
405
+
406
+
407
+
408
+
409
+
410
+
411
+
412
+
413
+
414
+
415
+
416
+
417
+
418
+
419
+
420
+
421
+
422
+
423
+
424
+
425
+
426
+
427
+
428
+
429
+
430
+
431
+
432
+
433
+
434
+
435
+
436
+
437
+
438
+
439
+
440
+
441
+
442
+
443
+
444
+
445
+
446
+
447
+
448
+
449
+
450
+
451
+
452
+
453
+
454
+
455
+
456
+
457
+
458
+
459
+
460
+
461
+
462
+
463
+
464
+
465
+
466
+
467
+
468
+
469
+
470
+
471
+
472
+
473
+
474
+
475
+
476
+
477
+
478
+
479
+
480
+
481
+
482
+
483
+
484
+
485
+
486
+ </article>
487
+ </div>
488
+
489
+ <div class="unit one-fifth hide-on-mobiles">
490
+ <aside>
491
+
492
+ <h4>Getting Started</h4>
493
+ <ul>
494
+
495
+
496
+
497
+ <li class=""><a href="/docs/home/">Welcome</a></li>
498
+
499
+
500
+
501
+ <li class=""><a href="/docs/quickstart/">Quick-start guide</a></li>
502
+
503
+
504
+
505
+ <li class=""><a href="/docs/installation/">Installation</a></li>
506
+
507
+
508
+
509
+ <li class=""><a href="/docs/usage/">Basic Usage</a></li>
510
+
511
+
512
+
513
+ <li class=""><a href="/docs/structure/">Directory structure</a></li>
514
+
515
+
516
+
517
+ <li class=""><a href="/docs/configuration/">Configuration</a></li>
518
+
519
+ </ul>
520
+
521
+
522
+ <h4>Your Content</h4>
523
+ <ul>
524
+
525
+
526
+
527
+ <li class=""><a href="/docs/frontmatter/">Front Matter</a></li>
528
+
529
+
530
+
531
+ <li class=""><a href="/docs/posts/">Writing posts</a></li>
532
+
533
+
534
+
535
+ <li class=""><a href="/docs/drafts/">Working with drafts</a></li>
536
+
537
+
538
+
539
+ <li class=""><a href="/docs/pages/">Creating pages</a></li>
540
+
541
+
542
+
543
+ <li class=""><a href="/docs/static-files/">Static Files</a></li>
544
+
545
+
546
+
547
+ <li class=""><a href="/docs/variables/">Variables</a></li>
548
+
549
+
550
+
551
+ <li class=""><a href="/docs/collections/">Collections</a></li>
552
+
553
+
554
+
555
+ <li class=""><a href="/docs/datafiles/">Data Files</a></li>
556
+
557
+
558
+
559
+ <li class=""><a href="/docs/assets/">Assets</a></li>
560
+
561
+
562
+
563
+ <li class=""><a href="/docs/migrations/">Blog migrations</a></li>
564
+
565
+ </ul>
566
+
567
+
568
+ <h4>Customization</h4>
569
+ <ul>
570
+
571
+
572
+
573
+ <li class=""><a href="/docs/templates/">Templates</a></li>
574
+
575
+
576
+
577
+ <li class=""><a href="/docs/includes/">Includes</a></li>
578
+
579
+
580
+
581
+ <li class=""><a href="/docs/permalinks/">Permalinks</a></li>
582
+
583
+
584
+
585
+ <li class=""><a href="/docs/pagination/">Pagination</a></li>
586
+
587
+
588
+
589
+ <li class=""><a href="/docs/plugins/">Plugins</a></li>
590
+
591
+
592
+
593
+ <li class=""><a href="/docs/themes/">Themes</a></li>
594
+
595
+
596
+
597
+ <li class=""><a href="/docs/extras/">Extras</a></li>
598
+
599
+ </ul>
600
+
601
+
602
+ <h4>Deployment</h4>
603
+ <ul>
604
+
605
+
606
+
607
+ <li class=""><a href="/docs/github-pages/">GitHub Pages</a></li>
608
+
609
+
610
+
611
+ <li class=""><a href="/docs/deployment-methods/">Deployment methods</a></li>
612
+
613
+
614
+
615
+ <li class=""><a href="/docs/continuous-integration/">Continuous Integration</a></li>
616
+
617
+ </ul>
618
+
619
+
620
+ <h4>Miscellaneous</h4>
621
+ <ul>
622
+
623
+
624
+
625
+ <li class=""><a href="/docs/troubleshooting/">Troubleshooting</a></li>
626
+
627
+
628
+
629
+ <li class=""><a href="/docs/sites/">Sites using Jekyll</a></li>
630
+
631
+
632
+
633
+ <li class=""><a href="/docs/resources/">Resources</a></li>
634
+
635
+
636
+
637
+ <li class=""><a href="/docs/upgrading/0-to-2/">Upgrading from 0.x to 2.x</a></li>
638
+
639
+
640
+
641
+ <li class=""><a href="/docs/upgrading/2-to-3/">Upgrading from 2.x to 3.x</a></li>
642
+
643
+ </ul>
644
+
645
+
646
+ <h4>Meta</h4>
647
+ <ul>
648
+
649
+
650
+
651
+ <li class=""><a href="/docs/contributing/">Contributing</a></li>
652
+
653
+
654
+
655
+ <li class=""><a href="/docs/maintaining/">Maintaining Jekyll</a></li>
656
+
657
+
658
+
659
+ <li class=""><a href="/docs/conduct/">Code of Conduct</a></li>
660
+
661
+
662
+
663
+ <li class=""><a href="/docs/history/">History</a></li>
664
+
665
+ </ul>
666
+
667
+
668
+ </aside>
669
+ </div>
670
+
671
+
672
+ <div class="clear"></div>
673
+
674
+ </div>
675
+ </section>
676
+
677
+
678
+ <footer>
679
+ <div class="grid">
680
+ <div class="unit one-third center-on-mobiles">
681
+ <p>The contents of this website are <br>© 2017 under the terms of the <a href="https://github.com/jekyll/jekyll/blob/master/LICENSE">MIT License</a>.</p>
682
+ </div>
683
+ <div class="unit two-thirds align-right center-on-mobiles">
684
+ <p>
685
+ Proudly hosted by
686
+ <a href="https://github.com">
687
+ <img src="/img/footer-logo.png" width="100" height="30" alt="GitHub • Social coding">
688
+ </a>
689
+ </p>
690
+ </div>
691
+ </div>
692
+ </footer>
693
+
694
+ <script>
695
+ var anchorForId = function (id) {
696
+ var anchor = document.createElement("a");
697
+ anchor.className = "header-link";
698
+ anchor.href = "#" + id;
699
+ anchor.innerHTML = "<span class=\"sr-only\">Permalink</span><i class=\"fa fa-link\"></i>";
700
+ anchor.title = "Permalink";
701
+ return anchor;
702
+ };
703
+
704
+ var linkifyAnchors = function (level, containingElement) {
705
+ var headers = containingElement.getElementsByTagName("h" + level);
706
+ for (var h = 0; h < headers.length; h++) {
707
+ var header = headers[h];
708
+
709
+ if (typeof header.id !== "undefined" && header.id !== "") {
710
+ header.appendChild(anchorForId(header.id));
711
+ }
712
+ }
713
+ };
714
+
715
+ document.onreadystatechange = function () {
716
+ if (this.readyState === "complete") {
717
+ var contentBlock = document.getElementsByClassName("docs")[0] || document.getElementsByClassName("news")[0];
718
+ if (!contentBlock) {
719
+ return;
720
+ }
721
+ for (var level = 1; level <= 6; level++) {
722
+ linkifyAnchors(level, contentBlock);
723
+ }
724
+ }
725
+ };
726
+ </script>
727
+
728
+
729
+ <!-- Gauges (http://get.gaug.es/) -->
730
+ <script>
731
+ var _gauges = _gauges || [];
732
+ (function() {
733
+ var t = document.createElement('script');
734
+ t.type = 'text/javascript';
735
+ t.async = true;
736
+ t.id = 'gauges-tracker';
737
+ t.setAttribute('data-site-id', '503c5af6613f5d0f19000027');
738
+ t.src = '//secure.gaug.es/track.js';
739
+ var s = document.getElementsByTagName('script')[0];
740
+ s.parentNode.insertBefore(t, s);
741
+ })();
742
+ </script>
743
+
744
+
745
+
746
+ <!-- Google Analytics (https://www.google.com/analytics) -->
747
+ <script>
748
+ !function(j,e,k,y,l,L){j.GoogleAnalyticsObject=y,j[y]||(j[y]=function(){
749
+ (j[y].q=j[y].q||[]).push(arguments)}),j[y].l=+new Date,l=e.createElement(k),
750
+ L=e.getElementsByTagName(k)[0],l.src='//www.google-analytics.com/analytics.js',
751
+ L.parentNode.insertBefore(l,L)}(window,document,'script','ga');
752
+
753
+ ga('create', 'UA-50755011-1', 'jekyllrb.com');
754
+ ga('send', 'pageview');
755
+
756
+ </script>
757
+
758
+
759
+
760
+ </body>
761
+ </html>