jekyll-docs 3.4.3 → 3.5.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (130) hide show
  1. checksums.yaml +4 -4
  2. data/lib/jekyll-docs.rb +1 -1
  3. data/site/404.html +5 -11
  4. data/site/community/index.html +9 -15
  5. data/site/css/screen.css +1 -1468
  6. data/site/docs/assets/index.html +20 -16
  7. data/site/docs/collections/index.html +115 -109
  8. data/site/docs/conduct/index.html +19 -15
  9. data/site/docs/configuration/index.html +39 -23
  10. data/site/docs/continuous-integration/buddyworks/index.html +728 -0
  11. data/site/docs/continuous-integration/circleci/index.html +19 -15
  12. data/site/docs/continuous-integration/index.html +20 -15
  13. data/site/docs/continuous-integration/travis-ci/index.html +21 -18
  14. data/site/docs/contributing/index.html +20 -16
  15. data/site/docs/datafiles/index.html +23 -15
  16. data/site/docs/deployment-methods/index.html +24 -20
  17. data/site/docs/drafts/index.html +19 -15
  18. data/site/docs/extras/index.html +31 -16
  19. data/site/docs/frontmatter/index.html +28 -15
  20. data/site/docs/github-pages/index.html +21 -17
  21. data/site/docs/history/index.html +521 -315
  22. data/site/docs/home/index.html +16 -15
  23. data/site/docs/includes/index.html +21 -17
  24. data/site/docs/installation/index.html +41 -31
  25. data/site/docs/maintaining/affinity-team-captain/index.html +19 -15
  26. data/site/docs/maintaining/avoiding-burnout/index.html +19 -15
  27. data/site/docs/maintaining/becoming-a-maintainer/index.html +19 -15
  28. data/site/docs/maintaining/index.html +19 -15
  29. data/site/docs/maintaining/merging-a-pull-request/index.html +19 -15
  30. data/site/docs/maintaining/reviewing-a-pull-request/index.html +19 -15
  31. data/site/docs/maintaining/special-labels/index.html +23 -15
  32. data/site/docs/maintaining/triaging-an-issue/index.html +20 -16
  33. data/site/docs/migrations/index.html +19 -15
  34. data/site/docs/pages/index.html +19 -15
  35. data/site/docs/pagination/index.html +19 -15
  36. data/site/docs/permalinks/index.html +19 -15
  37. data/site/docs/plugins/index.html +36 -23
  38. data/site/docs/posts/index.html +23 -19
  39. data/site/docs/quickstart/index.html +18 -17
  40. data/site/docs/resources/index.html +19 -15
  41. data/site/docs/sites/index.html +22 -15
  42. data/site/docs/static-files/index.html +52 -15
  43. data/site/docs/structure/index.html +19 -15
  44. data/site/docs/templates/index.html +29 -25
  45. data/site/docs/themes/index.html +65 -39
  46. data/site/docs/troubleshooting/index.html +41 -19
  47. data/site/docs/upgrading/0-to-2/index.html +19 -15
  48. data/site/docs/upgrading/2-to-3/index.html +20 -16
  49. data/site/docs/upgrading/index.html +22 -15
  50. data/site/docs/usage/index.html +20 -16
  51. data/site/docs/variables/index.html +19 -15
  52. data/site/docs/windows/index.html +135 -136
  53. data/site/feed.xml +228 -180
  54. data/site/help/index.html +11 -13
  55. data/site/img/jekylllayoutconcept.png +0 -0
  56. data/site/index.html +7 -14
  57. data/site/latest_version.txt +1 -1
  58. data/site/news/2013/05/05/jekyll-1-0-0-released/index.html +33 -19
  59. data/site/news/2013/05/08/jekyll-1-0-1-released/index.html +33 -19
  60. data/site/news/2013/05/12/jekyll-1-0-2-released/index.html +33 -19
  61. data/site/news/2013/06/07/jekyll-1-0-3-released/index.html +33 -19
  62. data/site/news/2013/07/14/jekyll-1-1-0-released/index.html +33 -19
  63. data/site/news/2013/07/24/jekyll-1-1-1-released/index.html +33 -19
  64. data/site/news/2013/07/25/jekyll-1-0-4-released/index.html +33 -19
  65. data/site/news/2013/07/25/jekyll-1-1-2-released/index.html +33 -19
  66. data/site/news/2013/09/06/jekyll-1-2-0-released/index.html +33 -19
  67. data/site/news/2013/09/14/jekyll-1-2-1-released/index.html +33 -19
  68. data/site/news/2013/10/28/jekyll-1-3-0-rc1-released/index.html +33 -19
  69. data/site/news/2013/11/04/jekyll-1-3-0-released/index.html +33 -19
  70. data/site/news/2013/11/26/jekyll-1-3-1-released/index.html +33 -19
  71. data/site/news/2013/12/07/jekyll-1-4-0-released/index.html +33 -19
  72. data/site/news/2013/12/09/jekyll-1-4-1-released/index.html +33 -19
  73. data/site/news/2013/12/16/jekyll-1-4-2-released/index.html +33 -19
  74. data/site/news/2014/01/13/jekyll-1-4-3-released/index.html +33 -19
  75. data/site/news/2014/03/24/jekyll-1-5-0-released/index.html +33 -19
  76. data/site/news/2014/03/27/jekyll-1-5-1-released/index.html +33 -19
  77. data/site/news/2014/05/06/jekyll-turns-2-0-0/index.html +33 -19
  78. data/site/news/2014/05/08/jekyll-2-0-3-released/index.html +33 -19
  79. data/site/news/2014/06/04/jekyll-stickers-1-dollar-stickermule/index.html +35 -21
  80. data/site/news/2014/06/28/jekyll-turns-21-i-mean-2-1-0/index.html +33 -19
  81. data/site/news/2014/07/01/jekyll-2-1-1-released/index.html +33 -19
  82. data/site/news/2014/07/29/jekyll-2-2-0-released/index.html +33 -19
  83. data/site/news/2014/08/10/jekyll-2-3-0-released/index.html +33 -19
  84. data/site/news/2014/09/09/jekyll-2-4-0-released/index.html +33 -19
  85. data/site/news/2014/11/05/jekylls-midlife-crisis-jekyll-turns-2-5-0/index.html +33 -19
  86. data/site/news/2014/11/09/jekyll-2-5-1-released/index.html +33 -19
  87. data/site/news/2014/11/12/jekyll-2-5-2-released/index.html +33 -19
  88. data/site/news/2014/12/17/alfredxing-welcome-to-jekyll-core/index.html +33 -19
  89. data/site/news/2014/12/22/jekyll-2-5-3-released/index.html +33 -19
  90. data/site/news/2015/01/20/jekyll-meet-and-greet/index.html +33 -19
  91. data/site/news/2015/01/24/jekyll-3-0-0-beta1-released/index.html +33 -19
  92. data/site/news/2015/02/26/introducing-jekyll-talk/index.html +33 -19
  93. data/site/news/2015/10/26/jekyll-3-0-released/index.html +33 -19
  94. data/site/news/2015/11/17/jekyll-3-0-1-released/index.html +33 -19
  95. data/site/news/2016/01/20/jekyll-3-0-2-released/index.html +33 -19
  96. data/site/news/2016/01/24/jekyll-3-1-0-released/index.html +33 -19
  97. data/site/news/2016/01/28/jekyll-3-1-1-released/index.html +33 -19
  98. data/site/news/2016/02/08/jekyll-3-0-3-released/index.html +33 -19
  99. data/site/news/2016/02/19/jekyll-3-1-2-released/index.html +33 -19
  100. data/site/news/2016/03/10/making-it-easier-to-contribute-to-jekyll/index.html +33 -19
  101. data/site/news/2016/04/19/jekyll-3-0-4-released/index.html +33 -19
  102. data/site/news/2016/04/19/jekyll-3-1-3-released/index.html +33 -19
  103. data/site/news/2016/04/26/jekyll-3-0-5-released/index.html +33 -19
  104. data/site/news/2016/05/18/jekyll-3-1-4-released/index.html +33 -19
  105. data/site/news/2016/05/18/jekyll-3-1-5-released/index.html +33 -19
  106. data/site/news/2016/05/19/jekyll-3-1-6-released/index.html +33 -19
  107. data/site/news/2016/06/03/update-on-jekyll-s-google-summer-of-code-projects/index.html +33 -19
  108. data/site/news/2016/07/26/jekyll-3-2-0-released/index.html +35 -21
  109. data/site/news/2016/08/02/jekyll-3-2-1-released/index.html +34 -20
  110. data/site/news/2016/08/24/jekyll-admin-initial-release/index.html +33 -19
  111. data/site/news/2016/10/06/jekyll-3-3-is-here/index.html +35 -21
  112. data/site/news/2016/11/14/jekyll-3-3-1-released/index.html +34 -20
  113. data/site/news/2017/01/18/jekyll-3-4-0-released/index.html +36 -22
  114. data/site/news/2017/03/02/jekyll-3-4-1-released/index.html +651 -0
  115. data/site/news/2017/03/09/jekyll-3-4-2-released/index.html +592 -0
  116. data/site/news/2017/03/21/jekyll-3-4-3-released/index.html +588 -0
  117. data/site/news/2017/06/15/jekyll-3-5-0-released/index.html +581 -0
  118. data/site/news/2017/07/17/jekyll-3-5-1-released/index.html +561 -0
  119. data/site/news/index.html +405 -22
  120. data/site/news/releases/index.html +405 -22
  121. data/site/philosophy.html +46 -0
  122. data/site/sitemap.xml +95 -48
  123. data/site/tutorials/convert-site-to-jekyll/index.html +851 -0
  124. data/site/tutorials/custom-404-page/index.html +366 -0
  125. data/site/tutorials/home/index.html +323 -0
  126. data/site/tutorials/index.html +10 -0
  127. data/site/tutorials/navigation/index.html +908 -0
  128. data/site/tutorials/orderofinterpretation/index.html +459 -0
  129. metadata +20 -7
  130. data/site/feed.xslt.xml +0 -4
@@ -4,35 +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.4.3">
7
+ <meta name="generator" content="Jekyll v3.5.1">
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.1.0 -->
14
- <title>Configuration - Jekyll • Simple, blog-aware, static sites</title>
13
+ <!-- Begin Jekyll SEO tag v2.2.3 -->
14
+ <title>Configuration | Jekyll • Simple, blog-aware, static sites</title>
15
15
  <meta property="og:title" content="Configuration">
16
+ <meta property="og:locale" content="en_US">
16
17
  <meta name="description" content="Jekyll allows you to concoct your sites in any way you can dream up, and it’s thanks to the powerful and flexible configuration options that this is possible. These options can either be specified in a _config.yml file placed in your site’s root directory, or can be specified as flags for the jekyll executable in the terminal.">
17
18
  <meta property="og:description" content="Jekyll allows you to concoct your sites in any way you can dream up, and it’s thanks to the powerful and flexible configuration options that this is possible. These options can either be specified in a _config.yml file placed in your site’s root directory, or can be specified as flags for the jekyll executable in the terminal.">
18
19
  <link rel="canonical" href="https://jekyllrb.com/docs/configuration/">
19
20
  <meta property="og:url" content="https://jekyllrb.com/docs/configuration/">
20
21
  <meta property="og:site_name" content="Jekyll • Simple, blog-aware, static sites">
21
22
  <meta property="og:type" content="article">
22
- <meta property="article:published_time" content="2017-03-22T08:08:47-07:00">
23
+ <meta property="article:published_time" content="2017-07-17T13:16:40-07:00">
23
24
  <meta name="twitter:card" content="summary">
24
25
  <meta name="twitter:site" content="@jekyllrb">
25
26
  <meta name="google-site-verification" content="onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY">
26
27
  <script type="application/ld+json">
27
- {"@context": "http://schema.org",
28
- "@type": "BlogPosting",
29
- "headline": "Configuration",
30
- "datePublished": "2017-03-22T08:08:47-07:00",
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
- "publisher": {"@type": "Organization",
33
- "logo": {"@type": "ImageObject",
34
- "url": "https://jekyllrb.com/img/logo-2x.png"}},
35
- "url": "https://jekyllrb.com/docs/configuration/"}</script>
28
+ {"@context":"http://schema.org","@type":"BlogPosting","headline":"Configuration","datePublished":"2017-07-17T13:16:40-07:00","dateModified":"2017-07-17T13:16:40-07:00","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.","publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://jekyllrb.com/img/logo-2x.png"}},"mainEntityOfPage":{"@type":"WebPage","@id":"https://jekyllrb.com/docs/configuration/"},"url":"https://jekyllrb.com/docs/configuration/"}</script>
36
29
  <!-- End Jekyll SEO tag -->
37
30
 
38
31
  <!--[if lt IE 9]>
@@ -62,7 +55,7 @@
62
55
  <a href="/help/">Help</a>
63
56
  </li>
64
57
  <li>
65
- <a href="https://github.com/jekyll/jekyll"><span class="hide-on-mobiles">View on </span>GitHub</a>
58
+ <a href="https://github.com/jekyll/jekyll">GitHub</a>
66
59
  </li>
67
60
  </ul>
68
61
 
@@ -94,7 +87,7 @@
94
87
  <a href="/help/">Help</a>
95
88
  </li>
96
89
  <li>
97
- <a href="https://github.com/jekyll/jekyll"><span class="hide-on-mobiles">View on </span>GitHub</a>
90
+ <a href="https://github.com/jekyll/jekyll">GitHub</a>
98
91
  </li>
99
92
  </ul>
100
93
 
@@ -126,6 +119,10 @@
126
119
 
127
120
 
128
121
 
122
+ <option value="/docs/windows/">Jekyll on Windows</option>
123
+
124
+
125
+
129
126
  <option value="/docs/usage/">Basic Usage</option>
130
127
 
131
128
 
@@ -592,6 +589,18 @@ in the terminal.</p>
592
589
  <p><code class="flag">--profile</code></p>
593
590
  </td>
594
591
  </tr>
592
+ <tr class="setting">
593
+ <td>
594
+ <p class="name"><strong>Strict Front Matter</strong></p>
595
+ <p class="description">
596
+ Cause a build to fail if there is a YAML syntax error in a page's front matter.
597
+ </p>
598
+ </td>
599
+ <td class="align-center">
600
+ <p><code class="option">strict_front_matter: BOOL</code></p>
601
+ <p><code class="flag">--strict_front_matter</code></p>
602
+ </td>
603
+ </tr>
595
604
  </tbody>
596
605
  </table>
597
606
  </div>
@@ -898,12 +907,13 @@ file or on the command-line.</p>
898
907
  <span class="s">output</span><span class="pi">:</span> <span class="s">true</span>
899
908
 
900
909
  <span class="c1"># Handling Reading</span>
901
- <span class="s">safe</span><span class="pi">:</span> <span class="s">false</span>
902
- <span class="s">include</span><span class="pi">:</span> <span class="pi">[</span><span class="s2">"</span><span class="s">.htaccess"</span><span class="pi">]</span>
903
- <span class="s">exclude</span><span class="pi">:</span> <span class="pi">[</span><span class="s2">"</span><span class="s">node_modules"</span><span class="pi">,</span> <span class="s2">"</span><span class="s">vendor/bundle/"</span><span class="pi">,</span> <span class="s2">"</span><span class="s">vendor/cache/"</span><span class="pi">,</span> <span class="s2">"</span><span class="s">vendor/gems/"</span><span class="pi">,</span> <span class="s2">"</span><span class="s">vendor/ruby/"</span><span class="pi">]</span>
904
- <span class="s">keep_files</span><span class="pi">:</span> <span class="pi">[</span><span class="s2">"</span><span class="s">.git"</span><span class="pi">,</span> <span class="s2">"</span><span class="s">.svn"</span><span class="pi">]</span>
905
- <span class="s">encoding</span><span class="pi">:</span> <span class="s2">"</span><span class="s">utf-8"</span>
906
- <span class="s">markdown_ext</span><span class="pi">:</span> <span class="s2">"</span><span class="s">markdown,mkdown,mkdn,mkd,md"</span>
910
+ <span class="s">safe</span><span class="pi">:</span> <span class="s">false</span>
911
+ <span class="s">include</span><span class="pi">:</span> <span class="pi">[</span><span class="s2">"</span><span class="s">.htaccess"</span><span class="pi">]</span>
912
+ <span class="s">exclude</span><span class="pi">:</span> <span class="pi">[</span><span class="s2">"</span><span class="s">Gemfile"</span><span class="pi">,</span> <span class="s2">"</span><span class="s">Gemfile.lock"</span><span class="pi">,</span> <span class="s2">"</span><span class="s">node_modules"</span><span class="pi">,</span> <span class="s2">"</span><span class="s">vendor/bundle/"</span><span class="pi">,</span> <span class="s2">"</span><span class="s">vendor/cache/"</span><span class="pi">,</span> <span class="s2">"</span><span class="s">vendor/gems/"</span><span class="pi">,</span> <span class="s2">"</span><span class="s">vendor/ruby/"</span><span class="pi">]</span>
913
+ <span class="s">keep_files</span><span class="pi">:</span> <span class="pi">[</span><span class="s2">"</span><span class="s">.git"</span><span class="pi">,</span> <span class="s2">"</span><span class="s">.svn"</span><span class="pi">]</span>
914
+ <span class="s">encoding</span><span class="pi">:</span> <span class="s2">"</span><span class="s">utf-8"</span>
915
+ <span class="s">markdown_ext</span><span class="pi">:</span> <span class="s2">"</span><span class="s">markdown,mkdown,mkdn,mkd,md"</span>
916
+ <span class="s">strict_front_matter</span><span class="pi">:</span> <span class="s">false</span>
907
917
 
908
918
  <span class="c1"># Filtering Content</span>
909
919
  <span class="s">show_drafts</span><span class="pi">:</span> <span class="s">null</span>
@@ -913,7 +923,7 @@ file or on the command-line.</p>
913
923
 
914
924
  <span class="c1"># Plugins</span>
915
925
  <span class="s">whitelist</span><span class="pi">:</span> <span class="pi">[]</span>
916
- <span class="s">gems</span><span class="pi">:</span> <span class="pi">[]</span>
926
+ <span class="s">plugins</span><span class="pi">:</span> <span class="pi">[]</span>
917
927
 
918
928
  <span class="c1"># Conversion</span>
919
929
  <span class="s">markdown</span><span class="pi">:</span> <span class="s">kramdown</span>
@@ -950,7 +960,6 @@ file or on the command-line.</p>
950
960
 
951
961
  <span class="s">kramdown</span><span class="pi">:</span>
952
962
  <span class="s">auto_ids</span><span class="pi">:</span> <span class="s">true</span>
953
- <span class="s">footnote_nr</span><span class="pi">:</span> <span class="s">1</span>
954
963
  <span class="s">entity_output</span><span class="pi">:</span> <span class="s">as_char</span>
955
964
  <span class="s">toc_levels</span><span class="pi">:</span> <span class="s">1..6</span>
956
965
  <span class="s">smart_quotes</span><span class="pi">:</span> <span class="s">lsquo,rsquo,ldquo,rdquo</span>
@@ -1113,6 +1122,9 @@ configuration file.</p>
1113
1122
 
1114
1123
 
1115
1124
 
1125
+
1126
+
1127
+
1116
1128
 
1117
1129
 
1118
1130
 
@@ -1158,6 +1170,10 @@ configuration file.</p>
1158
1170
 
1159
1171
 
1160
1172
 
1173
+ <li class=""><a href="/docs/windows/">Jekyll on Windows</a></li>
1174
+
1175
+
1176
+
1161
1177
  <li class=""><a href="/docs/usage/">Basic Usage</a></li>
1162
1178
 
1163
1179
 
@@ -0,0 +1,728 @@
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.5.1">
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.2.3 -->
14
+ <title>BuddyWorks | Jekyll • Simple, blog-aware, static sites</title>
15
+ <meta property="og:title" content="BuddyWorks">
16
+ <meta property="og:locale" content="en_US">
17
+ <meta name="description" content="BuddyWorks 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="BuddyWorks 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
+ <link rel="canonical" href="https://jekyllrb.com/docs/continuous-integration/buddyworks/">
20
+ <meta property="og:url" content="https://jekyllrb.com/docs/continuous-integration/buddyworks/">
21
+ <meta property="og:site_name" content="Jekyll • Simple, blog-aware, static sites">
22
+ <meta property="og:type" content="article">
23
+ <meta property="article:published_time" content="2017-07-17T13:16:40-07:00">
24
+ <meta name="twitter:card" content="summary">
25
+ <meta name="twitter:site" content="@jekyllrb">
26
+ <meta name="google-site-verification" content="onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY">
27
+ <script type="application/ld+json">
28
+ {"@context":"http://schema.org","@type":"BlogPosting","headline":"BuddyWorks","datePublished":"2017-07-17T13:16:40-07:00","dateModified":"2017-07-17T13:16:40-07:00","description":"BuddyWorks 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.","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/"},"url":"https://jekyllrb.com/docs/continuous-integration/buddyworks/"}</script>
29
+ <!-- End Jekyll SEO tag -->
30
+
31
+ <!--[if lt IE 9]>
32
+ <script src="/js/html5shiv.min.js"></script>
33
+ <script src="/js/respond.min.js"></script>
34
+ <![endif]-->
35
+ </head>
36
+
37
+
38
+ <body class="wrap">
39
+ <header>
40
+ <nav class="mobile-nav show-on-mobiles">
41
+ <ul>
42
+ <li class="">
43
+ <a href="/">Home</a>
44
+ </li>
45
+ <li class="current">
46
+ <a href="/docs/home/">Docs</a>
47
+ </li>
48
+ <li class="">
49
+ <a href="/news/">News</a>
50
+ </li>
51
+ <li class="">
52
+ <a href="/community/">Community</a>
53
+ </li>
54
+ <li class="">
55
+ <a href="/help/">Help</a>
56
+ </li>
57
+ <li>
58
+ <a href="https://github.com/jekyll/jekyll">GitHub</a>
59
+ </li>
60
+ </ul>
61
+
62
+ </nav>
63
+ <div class="grid">
64
+ <div class="unit one-third center-on-mobiles">
65
+ <h1>
66
+ <a href="/">
67
+ <span class="sr-only">Jekyll</span>
68
+ <img src="/img/logo-2x.png" width="249" height="115" alt="Jekyll Logo">
69
+ </a>
70
+ </h1>
71
+ </div>
72
+ <nav class="main-nav unit two-thirds hide-on-mobiles">
73
+ <ul>
74
+ <li class="">
75
+ <a href="/">Home</a>
76
+ </li>
77
+ <li class="current">
78
+ <a href="/docs/home/">Docs</a>
79
+ </li>
80
+ <li class="">
81
+ <a href="/news/">News</a>
82
+ </li>
83
+ <li class="">
84
+ <a href="/community/">Community</a>
85
+ </li>
86
+ <li class="">
87
+ <a href="/help/">Help</a>
88
+ </li>
89
+ <li>
90
+ <a href="https://github.com/jekyll/jekyll">GitHub</a>
91
+ </li>
92
+ </ul>
93
+
94
+ </nav>
95
+ </div>
96
+ </header>
97
+
98
+
99
+ <section class="docs">
100
+ <div class="grid">
101
+
102
+ <div class="docs-nav-mobile unit whole show-on-mobiles">
103
+ <select onchange="if (this.value) window.location.href=this.value">
104
+ <option value="">Navigate the docs…</option>
105
+
106
+ <optgroup label="Getting Started">
107
+
108
+
109
+
110
+ <option value="/docs/home/">Welcome</option>
111
+
112
+
113
+
114
+ <option value="/docs/quickstart/">Quick-start guide</option>
115
+
116
+
117
+
118
+ <option value="/docs/installation/">Installation</option>
119
+
120
+
121
+
122
+ <option value="/docs/windows/">Jekyll on Windows</option>
123
+
124
+
125
+
126
+ <option value="/docs/usage/">Basic Usage</option>
127
+
128
+
129
+
130
+ <option value="/docs/structure/">Directory structure</option>
131
+
132
+
133
+
134
+ <option value="/docs/configuration/">Configuration</option>
135
+
136
+
137
+ </optgroup>
138
+
139
+ <optgroup label="Your Content">
140
+
141
+
142
+
143
+ <option value="/docs/frontmatter/">Front Matter</option>
144
+
145
+
146
+
147
+ <option value="/docs/posts/">Writing posts</option>
148
+
149
+
150
+
151
+ <option value="/docs/drafts/">Working with drafts</option>
152
+
153
+
154
+
155
+ <option value="/docs/pages/">Creating pages</option>
156
+
157
+
158
+
159
+ <option value="/docs/static-files/">Static Files</option>
160
+
161
+
162
+
163
+ <option value="/docs/variables/">Variables</option>
164
+
165
+
166
+
167
+ <option value="/docs/collections/">Collections</option>
168
+
169
+
170
+
171
+ <option value="/docs/datafiles/">Data Files</option>
172
+
173
+
174
+
175
+ <option value="/docs/assets/">Assets</option>
176
+
177
+
178
+
179
+ <option value="/docs/migrations/">Blog migrations</option>
180
+
181
+
182
+ </optgroup>
183
+
184
+ <optgroup label="Customization">
185
+
186
+
187
+
188
+ <option value="/docs/templates/">Templates</option>
189
+
190
+
191
+
192
+ <option value="/docs/includes/">Includes</option>
193
+
194
+
195
+
196
+ <option value="/docs/permalinks/">Permalinks</option>
197
+
198
+
199
+
200
+ <option value="/docs/pagination/">Pagination</option>
201
+
202
+
203
+
204
+ <option value="/docs/plugins/">Plugins</option>
205
+
206
+
207
+
208
+ <option value="/docs/themes/">Themes</option>
209
+
210
+
211
+
212
+ <option value="/docs/extras/">Extras</option>
213
+
214
+
215
+ </optgroup>
216
+
217
+ <optgroup label="Deployment">
218
+
219
+
220
+
221
+ <option value="/docs/github-pages/">GitHub Pages</option>
222
+
223
+
224
+
225
+ <option value="/docs/deployment-methods/">Deployment methods</option>
226
+
227
+
228
+
229
+ <option value="/docs/continuous-integration/">Continuous Integration</option>
230
+
231
+
232
+ </optgroup>
233
+
234
+ <optgroup label="Miscellaneous">
235
+
236
+
237
+
238
+ <option value="/docs/troubleshooting/">Troubleshooting</option>
239
+
240
+
241
+
242
+ <option value="/docs/sites/">Sites using Jekyll</option>
243
+
244
+
245
+
246
+ <option value="/docs/resources/">Resources</option>
247
+
248
+
249
+
250
+ <option value="/docs/upgrading/0-to-2/">Upgrading from 0.x to 2.x</option>
251
+
252
+
253
+
254
+ <option value="/docs/upgrading/2-to-3/">Upgrading from 2.x to 3.x</option>
255
+
256
+
257
+ </optgroup>
258
+
259
+ <optgroup label="Meta">
260
+
261
+
262
+
263
+ <option value="/docs/contributing/">Contributing</option>
264
+
265
+
266
+
267
+ <option value="/docs/maintaining/">Maintaining Jekyll</option>
268
+
269
+
270
+
271
+ <option value="/docs/conduct/">Code of Conduct</option>
272
+
273
+
274
+
275
+ <option value="/docs/history/">History</option>
276
+
277
+
278
+ </optgroup>
279
+
280
+ </select>
281
+ </div>
282
+
283
+
284
+ <div class="unit four-fifths">
285
+ <article>
286
+ <div class="improve right hide-on-mobiles">
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
+ </div>
289
+ <h1>BuddyWorks</h1>
290
+ <p><a href="https://buddy.works">BuddyWorks</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
+
292
+ <h2 id="1-getting-started">1. Getting started</h2>
293
+
294
+ <ol>
295
+ <li>Log in at <a href="https://buddy.works">https://buddy.works</a> with your GitHub/Bitbucket account or email</li>
296
+ <li>Choose your Git provider and select or push your Jekyll Project</li>
297
+ <li>Create a new pipeline and set the trigger mode to ‘On every push’</li>
298
+ <li>Add and configure the Jekyll action and save the pipeline</li>
299
+ </ol>
300
+
301
+ <h2 id="2-how-it-works">2. How it works</h2>
302
+
303
+ <p>Whenever you make a push to the selected branch, the Jekyll action runs <code class="highlighter-rouge">jekyll build</code> in an isolated <a href="https://hub.docker.com/r/jekyll/jekyll/">Jekyll Docker image</a>. The output is generated to the <code class="highlighter-rouge">/filesystem</code> directory, and can be further deployed to FTP/SFTP and IaaS services. You can add your own commands, install additional packages, attach services, and run Selenium tests, as well as add other actions down the pipeline, eg. a Slack notification or an SSH script that will restart your server.</p>
304
+
305
+ <p><img src="https://buddy.works/data/blog/_images/buddyworks-jekyll-small.png" alt="Jekyll Build"></p>
306
+
307
+ <h2 id="3-using-yaml-for-configuration">3. Using YAML for configuration</h2>
308
+
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
+
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>
313
+ <span class="ss">trigger_mode: </span><span class="s2">"ON_EVERY_PUSH"</span>
314
+ <span class="ss">ref_name: </span><span class="s2">"master"</span>
315
+ <span class="ss">actions:
316
+ </span><span class="o">-</span> <span class="ss">action: </span><span class="s2">"Execute: jekyll build"</span>
317
+ <span class="ss">type: </span><span class="s2">"BUILD"</span>
318
+ <span class="ss">docker_image_name: </span><span class="s2">"jekyll/jekyll"</span>
319
+ <span class="ss">docker_image_tag: </span><span class="s2">"latest"</span>
320
+ <span class="ss">execute_commands:
321
+ </span><span class="o">-</span> <span class="s2">"chown jekyll:jekyll $WORKING_DIR"</span>
322
+ <span class="o">-</span> <span class="s2">"jekyll build"</span>
323
+ </code></pre>
324
+ </div>
325
+
326
+ <h2 id="4-setting-up-on-premises-server">4. Setting up on-premises server</h2>
327
+
328
+ <p>The self-hosted version of BuddyWorks 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
+
330
+ <h2 id="5-questions">5. Questions?</h2>
331
+
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. BuddyWorks also has an <a href="http://forum.buddy.works/">online community</a> for help.</p>
333
+
334
+
335
+
336
+
337
+
338
+
339
+
340
+
341
+
342
+
343
+
344
+
345
+
346
+
347
+
348
+
349
+
350
+
351
+
352
+
353
+
354
+
355
+
356
+
357
+
358
+
359
+
360
+
361
+
362
+
363
+
364
+
365
+
366
+
367
+
368
+
369
+
370
+
371
+
372
+
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
+ </article>
450
+ </div>
451
+
452
+ <div class="unit one-fifth hide-on-mobiles">
453
+ <aside>
454
+
455
+ <h4>Getting Started</h4>
456
+ <ul>
457
+
458
+
459
+
460
+ <li class=""><a href="/docs/home/">Welcome</a></li>
461
+
462
+
463
+
464
+ <li class=""><a href="/docs/quickstart/">Quick-start guide</a></li>
465
+
466
+
467
+
468
+ <li class=""><a href="/docs/installation/">Installation</a></li>
469
+
470
+
471
+
472
+ <li class=""><a href="/docs/windows/">Jekyll on Windows</a></li>
473
+
474
+
475
+
476
+ <li class=""><a href="/docs/usage/">Basic Usage</a></li>
477
+
478
+
479
+
480
+ <li class=""><a href="/docs/structure/">Directory structure</a></li>
481
+
482
+
483
+
484
+ <li class=""><a href="/docs/configuration/">Configuration</a></li>
485
+
486
+ </ul>
487
+
488
+
489
+ <h4>Your Content</h4>
490
+ <ul>
491
+
492
+
493
+
494
+ <li class=""><a href="/docs/frontmatter/">Front Matter</a></li>
495
+
496
+
497
+
498
+ <li class=""><a href="/docs/posts/">Writing posts</a></li>
499
+
500
+
501
+
502
+ <li class=""><a href="/docs/drafts/">Working with drafts</a></li>
503
+
504
+
505
+
506
+ <li class=""><a href="/docs/pages/">Creating pages</a></li>
507
+
508
+
509
+
510
+ <li class=""><a href="/docs/static-files/">Static Files</a></li>
511
+
512
+
513
+
514
+ <li class=""><a href="/docs/variables/">Variables</a></li>
515
+
516
+
517
+
518
+ <li class=""><a href="/docs/collections/">Collections</a></li>
519
+
520
+
521
+
522
+ <li class=""><a href="/docs/datafiles/">Data Files</a></li>
523
+
524
+
525
+
526
+ <li class=""><a href="/docs/assets/">Assets</a></li>
527
+
528
+
529
+
530
+ <li class=""><a href="/docs/migrations/">Blog migrations</a></li>
531
+
532
+ </ul>
533
+
534
+
535
+ <h4>Customization</h4>
536
+ <ul>
537
+
538
+
539
+
540
+ <li class=""><a href="/docs/templates/">Templates</a></li>
541
+
542
+
543
+
544
+ <li class=""><a href="/docs/includes/">Includes</a></li>
545
+
546
+
547
+
548
+ <li class=""><a href="/docs/permalinks/">Permalinks</a></li>
549
+
550
+
551
+
552
+ <li class=""><a href="/docs/pagination/">Pagination</a></li>
553
+
554
+
555
+
556
+ <li class=""><a href="/docs/plugins/">Plugins</a></li>
557
+
558
+
559
+
560
+ <li class=""><a href="/docs/themes/">Themes</a></li>
561
+
562
+
563
+
564
+ <li class=""><a href="/docs/extras/">Extras</a></li>
565
+
566
+ </ul>
567
+
568
+
569
+ <h4>Deployment</h4>
570
+ <ul>
571
+
572
+
573
+
574
+ <li class=""><a href="/docs/github-pages/">GitHub Pages</a></li>
575
+
576
+
577
+
578
+ <li class=""><a href="/docs/deployment-methods/">Deployment methods</a></li>
579
+
580
+
581
+
582
+ <li class=""><a href="/docs/continuous-integration/">Continuous Integration</a></li>
583
+
584
+ </ul>
585
+
586
+
587
+ <h4>Miscellaneous</h4>
588
+ <ul>
589
+
590
+
591
+
592
+ <li class=""><a href="/docs/troubleshooting/">Troubleshooting</a></li>
593
+
594
+
595
+
596
+ <li class=""><a href="/docs/sites/">Sites using Jekyll</a></li>
597
+
598
+
599
+
600
+ <li class=""><a href="/docs/resources/">Resources</a></li>
601
+
602
+
603
+
604
+ <li class=""><a href="/docs/upgrading/0-to-2/">Upgrading from 0.x to 2.x</a></li>
605
+
606
+
607
+
608
+ <li class=""><a href="/docs/upgrading/2-to-3/">Upgrading from 2.x to 3.x</a></li>
609
+
610
+ </ul>
611
+
612
+
613
+ <h4>Meta</h4>
614
+ <ul>
615
+
616
+
617
+
618
+ <li class=""><a href="/docs/contributing/">Contributing</a></li>
619
+
620
+
621
+
622
+ <li class=""><a href="/docs/maintaining/">Maintaining Jekyll</a></li>
623
+
624
+
625
+
626
+ <li class=""><a href="/docs/conduct/">Code of Conduct</a></li>
627
+
628
+
629
+
630
+ <li class=""><a href="/docs/history/">History</a></li>
631
+
632
+ </ul>
633
+
634
+
635
+ </aside>
636
+ </div>
637
+
638
+
639
+ <div class="clear"></div>
640
+
641
+ </div>
642
+ </section>
643
+
644
+
645
+ <footer>
646
+ <div class="grid">
647
+ <div class="unit one-third center-on-mobiles">
648
+ <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>
649
+ </div>
650
+ <div class="unit two-thirds align-right center-on-mobiles">
651
+ <p>
652
+ Proudly hosted by
653
+ <a href="https://github.com">
654
+ <img src="/img/footer-logo.png" width="100" height="30" alt="GitHub • Social coding">
655
+ </a>
656
+ </p>
657
+ </div>
658
+ </div>
659
+ </footer>
660
+
661
+ <script>
662
+ var anchorForId = function (id) {
663
+ var anchor = document.createElement("a");
664
+ anchor.className = "header-link";
665
+ anchor.href = "#" + id;
666
+ anchor.innerHTML = "<span class=\"sr-only\">Permalink</span><i class=\"fa fa-link\"></i>";
667
+ anchor.title = "Permalink";
668
+ return anchor;
669
+ };
670
+
671
+ var linkifyAnchors = function (level, containingElement) {
672
+ var headers = containingElement.getElementsByTagName("h" + level);
673
+ for (var h = 0; h < headers.length; h++) {
674
+ var header = headers[h];
675
+
676
+ if (typeof header.id !== "undefined" && header.id !== "") {
677
+ header.appendChild(anchorForId(header.id));
678
+ }
679
+ }
680
+ };
681
+
682
+ document.onreadystatechange = function () {
683
+ if (this.readyState === "complete") {
684
+ var contentBlock = document.getElementsByClassName("docs")[0] || document.getElementsByClassName("news")[0];
685
+ if (!contentBlock) {
686
+ return;
687
+ }
688
+ for (var level = 1; level <= 6; level++) {
689
+ linkifyAnchors(level, contentBlock);
690
+ }
691
+ }
692
+ };
693
+ </script>
694
+
695
+
696
+ <!-- Gauges (http://get.gaug.es/) -->
697
+ <script>
698
+ var _gauges = _gauges || [];
699
+ (function() {
700
+ var t = document.createElement('script');
701
+ t.type = 'text/javascript';
702
+ t.async = true;
703
+ t.id = 'gauges-tracker';
704
+ t.setAttribute('data-site-id', '503c5af6613f5d0f19000027');
705
+ t.src = '//secure.gaug.es/track.js';
706
+ var s = document.getElementsByTagName('script')[0];
707
+ s.parentNode.insertBefore(t, s);
708
+ })();
709
+ </script>
710
+
711
+
712
+
713
+ <!-- Google Analytics (https://www.google.com/analytics) -->
714
+ <script>
715
+ !function(j,e,k,y,l,L){j.GoogleAnalyticsObject=y,j[y]||(j[y]=function(){
716
+ (j[y].q=j[y].q||[]).push(arguments)}),j[y].l=+new Date,l=e.createElement(k),
717
+ L=e.getElementsByTagName(k)[0],l.src='//www.google-analytics.com/analytics.js',
718
+ L.parentNode.insertBefore(l,L)}(window,document,'script','ga');
719
+
720
+ ga('create', 'UA-50755011-1', 'jekyllrb.com');
721
+ ga('send', 'pageview');
722
+
723
+ </script>
724
+
725
+
726
+
727
+ </body>
728
+ </html>