jekyll-docs 3.6.2.0 → 3.7.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (147) hide show
  1. checksums.yaml +5 -5
  2. data/lib/jekyll-docs.rb +7 -5
  3. data/site/404.html +5 -6
  4. data/site/community/index.html +9 -297
  5. data/site/conduct/index.html +3 -2
  6. data/site/css/screen.css +1 -1
  7. data/site/docs/assets/index.html +46 -30
  8. data/site/docs/code_of_conduct/index.html +44 -28
  9. data/site/docs/collections/index.html +85 -48
  10. data/site/docs/conduct/index.html +44 -28
  11. data/site/docs/configuration/index.html +66 -35
  12. data/site/docs/continuous-integration/buddyworks/index.html +55 -39
  13. data/site/docs/continuous-integration/circleci/index.html +65 -49
  14. data/site/docs/continuous-integration/index.html +44 -28
  15. data/site/docs/continuous-integration/travis-ci/index.html +45 -29
  16. data/site/docs/contributing/index.html +53 -33
  17. data/site/docs/datafiles/index.html +71 -62
  18. data/site/docs/deployment-methods/index.html +49 -33
  19. data/site/docs/drafts/index.html +44 -28
  20. data/site/docs/extras/index.html +44 -28
  21. data/site/docs/frontmatter/index.html +55 -39
  22. data/site/docs/github-pages/index.html +107 -111
  23. data/site/docs/history/index.html +299 -115
  24. data/site/docs/home/index.html +45 -29
  25. data/site/docs/includes/index.html +51 -34
  26. data/site/docs/index.html +3 -2
  27. data/site/docs/installation/index.html +65 -49
  28. data/site/docs/maintaining/affinity-team-captain/index.html +46 -30
  29. data/site/docs/maintaining/avoiding-burnout/index.html +44 -28
  30. data/site/docs/maintaining/becoming-a-maintainer/index.html +45 -29
  31. data/site/docs/maintaining/index.html +44 -28
  32. data/site/docs/maintaining/merging-a-pull-request/index.html +45 -29
  33. data/site/docs/maintaining/reviewing-a-pull-request/index.html +45 -29
  34. data/site/docs/maintaining/special-labels/index.html +44 -28
  35. data/site/docs/maintaining/triaging-an-issue/index.html +45 -29
  36. data/site/docs/migrations/index.html +44 -28
  37. data/site/docs/pages/index.html +48 -32
  38. data/site/docs/pagination/index.html +105 -84
  39. data/site/docs/permalinks/index.html +48 -32
  40. data/site/docs/plugins/index.html +97 -58
  41. data/site/docs/posts/index.html +126 -71
  42. data/site/docs/quickstart/index.html +48 -32
  43. data/site/docs/resources/index.html +46 -29
  44. data/site/docs/sites/index.html +44 -28
  45. data/site/docs/static-files/index.html +44 -28
  46. data/site/docs/structure/index.html +44 -28
  47. data/site/docs/support/index.html +725 -0
  48. data/site/docs/templates/index.html +77 -54
  49. data/site/docs/themes/index.html +63 -37
  50. data/site/docs/troubleshooting/index.html +56 -40
  51. data/site/docs/upgrading/0-to-2/index.html +45 -29
  52. data/site/docs/upgrading/2-to-3/index.html +50 -34
  53. data/site/docs/upgrading/index.html +63 -31
  54. data/site/docs/usage/index.html +68 -44
  55. data/site/docs/variables/index.html +44 -28
  56. data/site/docs/windows/index.html +66 -54
  57. data/site/feed.xml +81 -108
  58. data/site/github.html +3 -2
  59. data/site/help/index.html +66 -46
  60. data/site/img/jekyll-sticker.jpg +0 -0
  61. data/site/img/jekylllayoutconcept.png +0 -0
  62. data/site/img/twitter-card.png +0 -0
  63. data/site/index.html +43 -27
  64. data/site/issues.html +3 -2
  65. data/site/jekyllconf/index.html +315 -0
  66. data/site/latest_version.txt +1 -1
  67. data/site/news/2013/05/05/jekyll-1-0-0-released/index.html +69 -33
  68. data/site/news/2013/05/08/jekyll-1-0-1-released/index.html +69 -33
  69. data/site/news/2013/05/12/jekyll-1-0-2-released/index.html +69 -33
  70. data/site/news/2013/06/07/jekyll-1-0-3-released/index.html +69 -33
  71. data/site/news/2013/07/14/jekyll-1-1-0-released/index.html +69 -33
  72. data/site/news/2013/07/24/jekyll-1-1-1-released/index.html +81 -45
  73. data/site/news/2013/07/25/jekyll-1-0-4-released/index.html +69 -33
  74. data/site/news/2013/07/25/jekyll-1-1-2-released/index.html +69 -33
  75. data/site/news/2013/09/06/jekyll-1-2-0-released/index.html +69 -33
  76. data/site/news/2013/09/14/jekyll-1-2-1-released/index.html +69 -33
  77. data/site/news/2013/10/28/jekyll-1-3-0-rc1-released/index.html +69 -33
  78. data/site/news/2013/11/04/jekyll-1-3-0-released/index.html +69 -33
  79. data/site/news/2013/11/26/jekyll-1-3-1-released/index.html +69 -33
  80. data/site/news/2013/12/07/jekyll-1-4-0-released/index.html +69 -33
  81. data/site/news/2013/12/09/jekyll-1-4-1-released/index.html +69 -33
  82. data/site/news/2013/12/16/jekyll-1-4-2-released/index.html +69 -33
  83. data/site/news/2014/01/13/jekyll-1-4-3-released/index.html +69 -33
  84. data/site/news/2014/03/24/jekyll-1-5-0-released/index.html +69 -33
  85. data/site/news/2014/03/27/jekyll-1-5-1-released/index.html +69 -33
  86. data/site/news/2014/05/06/jekyll-turns-2-0-0/index.html +69 -33
  87. data/site/news/2014/05/08/jekyll-2-0-3-released/index.html +69 -33
  88. data/site/news/2014/06/04/jekyll-stickers-1-dollar-stickermule/index.html +69 -33
  89. data/site/news/2014/06/28/jekyll-turns-21-i-mean-2-1-0/index.html +69 -33
  90. data/site/news/2014/07/01/jekyll-2-1-1-released/index.html +69 -33
  91. data/site/news/2014/07/29/jekyll-2-2-0-released/index.html +69 -33
  92. data/site/news/2014/08/10/jekyll-2-3-0-released/index.html +69 -33
  93. data/site/news/2014/09/09/jekyll-2-4-0-released/index.html +69 -33
  94. data/site/news/2014/11/05/jekylls-midlife-crisis-jekyll-turns-2-5-0/index.html +70 -34
  95. data/site/news/2014/11/09/jekyll-2-5-1-released/index.html +69 -33
  96. data/site/news/2014/11/12/jekyll-2-5-2-released/index.html +69 -33
  97. data/site/news/2014/12/17/alfredxing-welcome-to-jekyll-core/index.html +69 -33
  98. data/site/news/2014/12/22/jekyll-2-5-3-released/index.html +70 -34
  99. data/site/news/2015/01/20/jekyll-meet-and-greet/index.html +69 -33
  100. data/site/news/2015/01/24/jekyll-3-0-0-beta1-released/index.html +70 -34
  101. data/site/news/2015/02/26/introducing-jekyll-talk/index.html +69 -33
  102. data/site/news/2015/10/26/jekyll-3-0-released/index.html +69 -33
  103. data/site/news/2015/11/17/jekyll-3-0-1-released/index.html +69 -33
  104. data/site/news/2016/01/20/jekyll-3-0-2-released/index.html +69 -33
  105. data/site/news/2016/01/24/jekyll-3-1-0-released/index.html +69 -33
  106. data/site/news/2016/01/28/jekyll-3-1-1-released/index.html +71 -35
  107. data/site/news/2016/02/08/jekyll-3-0-3-released/index.html +69 -33
  108. data/site/news/2016/02/19/jekyll-3-1-2-released/index.html +69 -33
  109. data/site/news/2016/03/10/making-it-easier-to-contribute-to-jekyll/index.html +69 -33
  110. data/site/news/2016/04/19/jekyll-3-0-4-released/index.html +69 -33
  111. data/site/news/2016/04/19/jekyll-3-1-3-released/index.html +69 -33
  112. data/site/news/2016/04/26/jekyll-3-0-5-released/index.html +69 -33
  113. data/site/news/2016/05/18/jekyll-3-1-4-released/index.html +69 -33
  114. data/site/news/2016/05/18/jekyll-3-1-5-released/index.html +69 -33
  115. data/site/news/2016/05/19/jekyll-3-1-6-released/index.html +69 -33
  116. data/site/news/2016/06/03/update-on-jekyll-s-google-summer-of-code-projects/index.html +69 -33
  117. data/site/news/2016/07/26/jekyll-3-2-0-released/index.html +69 -33
  118. data/site/news/2016/08/02/jekyll-3-2-1-released/index.html +70 -34
  119. data/site/news/2016/08/24/jekyll-admin-initial-release/index.html +69 -33
  120. data/site/news/2016/10/06/jekyll-3-3-is-here/index.html +69 -33
  121. data/site/news/2016/11/14/jekyll-3-3-1-released/index.html +69 -33
  122. data/site/news/2017/01/02/jekyll-3-7-0-released/index.html +626 -0
  123. data/site/news/2017/01/18/jekyll-3-4-0-released/index.html +69 -33
  124. data/site/news/2017/03/02/jekyll-3-4-1-released/index.html +69 -33
  125. data/site/news/2017/03/09/jekyll-3-4-2-released/index.html +69 -33
  126. data/site/news/2017/03/21/jekyll-3-4-3-released/index.html +69 -33
  127. data/site/news/2017/06/15/jekyll-3-5-0-released/index.html +71 -35
  128. data/site/news/2017/07/17/jekyll-3-5-1-released/index.html +69 -33
  129. data/site/news/2017/08/12/jekyll-3-5-2-released/index.html +69 -33
  130. data/site/news/2017/09/21/jekyll-3-6-0-released/index.html +69 -33
  131. data/site/news/2017/10/19/diversity-open-source/index.html +631 -0
  132. data/site/news/2017/10/21/jekyll-3-6-2-released/index.html +627 -0
  133. data/site/news/index.html +270 -49
  134. data/site/news/releases/index.html +204 -49
  135. data/site/redirects.json +1 -0
  136. data/site/sitemap.xml +77 -57
  137. data/site/tutorials/convert-site-to-jekyll/index.html +58 -31
  138. data/site/tutorials/custom-404-page/index.html +70 -42
  139. data/site/tutorials/home/index.html +53 -29
  140. data/site/tutorials/index.html +3 -2
  141. data/site/tutorials/navigation/index.html +70 -38
  142. data/site/tutorials/orderofinterpretation/index.html +61 -34
  143. data/site/tutorials/video-walkthroughs/index.html +352 -0
  144. metadata +17 -12
  145. data/site/CNAME +0 -1
  146. data/site/icomoon-selection.json +0 -96
  147. data/site/readme.md +0 -23
@@ -4,14 +4,16 @@
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.6.2">
7
+ <meta name="generator" content="Jekyll v3.7.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
+ <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css">
11
12
  <link rel="stylesheet" href="/css/screen.css">
12
13
  <link rel="icon" type="image/x-icon" href="/favicon.ico">
13
- <!-- Begin Jekyll SEO tag v2.3.0 -->
14
+ <!-- Begin Jekyll SEO tag v2.4.0 -->
14
15
  <title>Configuration | Jekyll • Simple, blog-aware, static sites</title>
16
+ <meta name="generator" content="Jekyll v3.7.0">
15
17
  <meta property="og:title" content="Configuration">
16
18
  <meta property="og:locale" content="en_US">
17
19
  <meta name="description" content="Jekyll allows you to concoct your sites in any way you can dream up, and it’s thanks to the powerful and flexible configuration options that this is possible. These options can either be specified in a _config.yml file placed in your site’s root directory, or can be specified as flags for the jekyll executable in the terminal.">
@@ -20,12 +22,12 @@
20
22
  <meta property="og:url" content="https://jekyllrb.com/docs/configuration/">
21
23
  <meta property="og:site_name" content="Jekyll • Simple, blog-aware, static sites">
22
24
  <meta property="og:type" content="article">
23
- <meta property="article:published_time" content="2017-10-24T09:12:04-07:00">
25
+ <meta property="article:published_time" content="2018-01-03T02:41:17-08:00">
24
26
  <meta name="twitter:card" content="summary">
25
27
  <meta name="twitter:site" content="@jekyllrb">
26
28
  <meta name="google-site-verification" content="onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY">
27
29
  <script type="application/ld+json">
28
- {"name":null,"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.","url":"https://jekyllrb.com/docs/configuration/","headline":"Configuration","dateModified":"2017-10-24T09:12:04-07:00","datePublished":"2017-10-24T09:12:04-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/configuration/"},"@context":"http://schema.org"}</script>
30
+ {"headline":"Configuration","dateModified":"2018-01-03T02:41:17-08:00","datePublished":"2018-01-03T02:41:17-08:00","mainEntityOfPage":{"@type":"WebPage","@id":"https://jekyllrb.com/docs/configuration/"},"publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://jekyllrb.com/img/logo-2x.png"}},"url":"https://jekyllrb.com/docs/configuration/","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.","@type":"BlogPosting","@context":"http://schema.org"}</script>
29
31
  <!-- End Jekyll SEO tag -->
30
32
 
31
33
  <!--[if lt IE 9]>
@@ -37,8 +39,17 @@
37
39
 
38
40
  <body class="wrap">
39
41
  <header>
40
- <nav class="mobile-nav show-on-mobiles">
41
- <ul>
42
+ <div class="flexbox">
43
+ <div class="center-on-mobiles">
44
+ <h1>
45
+ <a href="/" class="logo">
46
+ <span class="sr-only">Jekyll</span>
47
+ <img src="/img/logo-2x.png" width="140" height="65" alt="Jekyll Logo">
48
+ </a>
49
+ </h1>
50
+ </div>
51
+ <nav class="main-nav hide-on-mobiles">
52
+ <ul>
42
53
  <li class="">
43
54
  <a href="/">Home</a>
44
55
  </li>
@@ -48,29 +59,29 @@
48
59
  <li class="">
49
60
  <a href="/news/">News</a>
50
61
  </li>
51
- <li class="">
52
- <a href="/community/">Community</a>
53
- </li>
54
62
  <li class="">
55
63
  <a href="/help/">Help</a>
56
64
  </li>
57
- <li>
58
- <a href="https://github.com/jekyll/jekyll">GitHub</a>
59
- </li>
60
65
  </ul>
61
66
 
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>
67
+ </nav>
68
+ <div class="search hide-on-mobiles">
69
+ <input type="text" id="docsearch-input" placeholder="Search the docs…">
70
+
71
71
  </div>
72
- <nav class="main-nav unit two-thirds hide-on-mobiles">
72
+ <div class="meta hide-on-mobiles">
73
73
  <ul>
74
+ <li>
75
+ <a href="https://github.com/jekyll/jekyll/releases/tag/v3.7.0">v3.7.0</a>
76
+ </li>
77
+ <li>
78
+ <a href="https://github.com/jekyll/jekyll">GitHub</a>
79
+ </li>
80
+ </ul>
81
+ </div>
82
+ </div>
83
+ <nav class="mobile-nav show-on-mobiles">
84
+ <ul>
74
85
  <li class="">
75
86
  <a href="/">Home</a>
76
87
  </li>
@@ -80,9 +91,6 @@
80
91
  <li class="">
81
92
  <a href="/news/">News</a>
82
93
  </li>
83
- <li class="">
84
- <a href="/community/">Community</a>
85
- </li>
86
94
  <li class="">
87
95
  <a href="/help/">Help</a>
88
96
  </li>
@@ -91,8 +99,7 @@
91
99
  </li>
92
100
  </ul>
93
101
 
94
- </nav>
95
- </div>
102
+ </nav>
96
103
  </header>
97
104
 
98
105
 
@@ -390,7 +397,7 @@ in the terminal.</p>
390
397
  <a href="https://en.wikipedia.org/wiki/Tz_database">IANA Time Zone
391
398
  Database</a> is valid, e.g. <code>America/New_York</code>. A list of all
392
399
  available values can be found <a href="https://en.wikipedia.org/wiki/List_of_tz_database_time_zones">
393
- here</a>. The default is the local time zone, as set by your operating system.
400
+ here</a>. When serving on a local machine, the default time zone is set by your operating system. But when served on a remote host/server, the default time zone depends on the server's setting or location.
394
401
  </p>
395
402
  </td>
396
403
  <td class="align-center">
@@ -827,6 +834,19 @@ The different types that are available to you are <code class="highlighter-rouge
827
834
  <p>In this example, the <code class="highlighter-rouge">layout</code> is set to <code class="highlighter-rouge">default</code> inside the
828
835
  <a href="../collections/">collection</a> with the name <code class="highlighter-rouge">my_collection</code>.</p>
829
836
 
837
+ <p>It is also possible to use glob patterns when matching defaults. For example, it is possible to set specific layout for each <code class="highlighter-rouge">special-page.html</code> in any subfolder of <code class="highlighter-rouge">section</code> folder.<span class="version-badge" title="This feature is available starting version 3.7.0">3.7.0</span></p>
838
+ <div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">collections</span><span class="pi">:</span>
839
+ <span class="na">my_collection</span><span class="pi">:</span>
840
+ <span class="na">output</span><span class="pi">:</span> <span class="no">true</span>
841
+
842
+ <span class="na">defaults</span><span class="pi">:</span>
843
+ <span class="pi">-</span>
844
+ <span class="na">scope</span><span class="pi">:</span>
845
+ <span class="na">path</span><span class="pi">:</span> <span class="s2">"</span><span class="s">section/*/special-page.html"</span>
846
+ <span class="na">values</span><span class="pi">:</span>
847
+ <span class="na">layout</span><span class="pi">:</span> <span class="s2">"</span><span class="s">specific-layout"</span>
848
+ </code></pre></div></div>
849
+
830
850
  <h3 id="precedence">Precedence</h3>
831
851
 
832
852
  <p>Jekyll will apply all of the configuration settings you specify in the <code class="highlighter-rouge">defaults</code> section of your <code class="highlighter-rouge">_config.yml</code> file. However, you can choose to override settings from other scope/values pair by specifying a more specific path for the scope.</p>
@@ -877,12 +897,13 @@ file or on the command-line.</p>
877
897
  </div>
878
898
 
879
899
  <div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="c1"># Where things are</span>
880
- <span class="na">source</span><span class="pi">:</span> <span class="s">.</span>
881
- <span class="na">destination</span><span class="pi">:</span> <span class="s">./_site</span>
882
- <span class="na">plugins_dir</span><span class="pi">:</span> <span class="s">_plugins</span>
883
- <span class="na">layouts_dir</span><span class="pi">:</span> <span class="s">_layouts</span>
884
- <span class="na">data_dir</span><span class="pi">:</span> <span class="s">_data</span>
885
- <span class="na">includes_dir</span><span class="pi">:</span> <span class="s">_includes</span>
900
+ <span class="na">source</span><span class="pi">:</span> <span class="s">.</span>
901
+ <span class="na">destination</span><span class="pi">:</span> <span class="s">./_site</span>
902
+ <span class="na">collections_dir</span><span class="pi">:</span> <span class="s">.</span>
903
+ <span class="na">plugins_dir</span><span class="pi">:</span> <span class="s">_plugins</span>
904
+ <span class="na">layouts_dir</span><span class="pi">:</span> <span class="s">_layouts</span>
905
+ <span class="na">data_dir</span><span class="pi">:</span> <span class="s">_data</span>
906
+ <span class="na">includes_dir</span><span class="pi">:</span> <span class="s">_includes</span>
886
907
  <span class="na">collections</span><span class="pi">:</span>
887
908
  <span class="na">posts</span><span class="pi">:</span>
888
909
  <span class="na">output</span><span class="pi">:</span> <span class="no">true</span>
@@ -947,6 +968,7 @@ file or on the command-line.</p>
947
968
  <span class="na">input</span><span class="pi">:</span> <span class="s">GFM</span>
948
969
  <span class="na">hard_wrap</span><span class="pi">:</span> <span class="no">false</span>
949
970
  <span class="na">footnote_nr</span><span class="pi">:</span> <span class="s">1</span>
971
+ <span class="na">show_warnings</span><span class="pi">:</span> <span class="no">false</span>
950
972
  </code></pre></div></div>
951
973
 
952
974
  <h2 id="liquid-options">Liquid Options</h2>
@@ -1320,7 +1342,7 @@ configuration file.</p>
1320
1342
  <footer>
1321
1343
  <div class="grid">
1322
1344
  <div class="unit one-third center-on-mobiles">
1323
- <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>
1345
+ <p>The contents of this website are <br>© 2018 under the terms of the <a href="https://github.com/jekyll/jekyll/blob/master/LICENSE">MIT License</a>.</p>
1324
1346
  </div>
1325
1347
  <div class="unit two-thirds align-right center-on-mobiles">
1326
1348
  <p>
@@ -1398,6 +1420,15 @@ configuration file.</p>
1398
1420
  </script>
1399
1421
 
1400
1422
 
1423
+ <script type="text/javascript" src="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.js"></script>
1424
+ <script type="text/javascript"> docsearch({
1425
+ apiKey: '50fe39c839958dfad797000f33e2ec17',
1426
+ indexName: 'jekyllrb',
1427
+ inputSelector: '#docsearch-input',
1428
+ enhancedSearchInput: true,
1429
+ debug: false // Set debug to true if you want to inspect the dropdown
1430
+ });
1431
+ </script>
1401
1432
 
1402
1433
  </body>
1403
1434
  </html>
@@ -4,14 +4,16 @@
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.6.2">
7
+ <meta name="generator" content="Jekyll v3.7.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
+ <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css">
11
12
  <link rel="stylesheet" href="/css/screen.css">
12
13
  <link rel="icon" type="image/x-icon" href="/favicon.ico">
13
- <!-- Begin Jekyll SEO tag v2.3.0 -->
14
+ <!-- Begin Jekyll SEO tag v2.4.0 -->
14
15
  <title>Buddy | Jekyll • Simple, blog-aware, static sites</title>
16
+ <meta name="generator" content="Jekyll v3.7.0">
15
17
  <meta property="og:title" content="Buddy">
16
18
  <meta property="og:locale" content="en_US">
17
19
  <meta name="description" content="Buddy is a Docker-based CI server that you can set up in 15-20 minutes to build, test, and deploy your Jekyll websites. It supports GitHub, Bitbucket, and GitLab repositories, and can be installed on-premises or used in cloud. The following guide will show you how to set up a free environment to build and test your Jekyll project.">
@@ -20,12 +22,12 @@
20
22
  <meta property="og:url" content="https://jekyllrb.com/docs/continuous-integration/buddyworks/">
21
23
  <meta property="og:site_name" content="Jekyll • Simple, blog-aware, static sites">
22
24
  <meta property="og:type" content="article">
23
- <meta property="article:published_time" content="2017-10-24T09:12:04-07:00">
25
+ <meta property="article:published_time" content="2018-01-03T02:41:17-08:00">
24
26
  <meta name="twitter:card" content="summary">
25
27
  <meta name="twitter:site" content="@jekyllrb">
26
28
  <meta name="google-site-verification" content="onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY">
27
29
  <script type="application/ld+json">
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-24T09:12:04-07:00","datePublished":"2017-10-24T09:12:04-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>
30
+ {"headline":"Buddy","dateModified":"2018-01-03T02:41:17-08:00","datePublished":"2018-01-03T02:41:17-08:00","mainEntityOfPage":{"@type":"WebPage","@id":"https://jekyllrb.com/docs/continuous-integration/buddyworks/"},"publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://jekyllrb.com/img/logo-2x.png"}},"url":"https://jekyllrb.com/docs/continuous-integration/buddyworks/","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.","@type":"BlogPosting","@context":"http://schema.org"}</script>
29
31
  <!-- End Jekyll SEO tag -->
30
32
 
31
33
  <!--[if lt IE 9]>
@@ -37,8 +39,17 @@
37
39
 
38
40
  <body class="wrap">
39
41
  <header>
40
- <nav class="mobile-nav show-on-mobiles">
41
- <ul>
42
+ <div class="flexbox">
43
+ <div class="center-on-mobiles">
44
+ <h1>
45
+ <a href="/" class="logo">
46
+ <span class="sr-only">Jekyll</span>
47
+ <img src="/img/logo-2x.png" width="140" height="65" alt="Jekyll Logo">
48
+ </a>
49
+ </h1>
50
+ </div>
51
+ <nav class="main-nav hide-on-mobiles">
52
+ <ul>
42
53
  <li class="">
43
54
  <a href="/">Home</a>
44
55
  </li>
@@ -48,29 +59,29 @@
48
59
  <li class="">
49
60
  <a href="/news/">News</a>
50
61
  </li>
51
- <li class="">
52
- <a href="/community/">Community</a>
53
- </li>
54
62
  <li class="">
55
63
  <a href="/help/">Help</a>
56
64
  </li>
57
- <li>
58
- <a href="https://github.com/jekyll/jekyll">GitHub</a>
59
- </li>
60
65
  </ul>
61
66
 
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>
67
+ </nav>
68
+ <div class="search hide-on-mobiles">
69
+ <input type="text" id="docsearch-input" placeholder="Search the docs…">
70
+
71
71
  </div>
72
- <nav class="main-nav unit two-thirds hide-on-mobiles">
72
+ <div class="meta hide-on-mobiles">
73
73
  <ul>
74
+ <li>
75
+ <a href="https://github.com/jekyll/jekyll/releases/tag/v3.7.0">v3.7.0</a>
76
+ </li>
77
+ <li>
78
+ <a href="https://github.com/jekyll/jekyll">GitHub</a>
79
+ </li>
80
+ </ul>
81
+ </div>
82
+ </div>
83
+ <nav class="mobile-nav show-on-mobiles">
84
+ <ul>
74
85
  <li class="">
75
86
  <a href="/">Home</a>
76
87
  </li>
@@ -80,9 +91,6 @@
80
91
  <li class="">
81
92
  <a href="/news/">News</a>
82
93
  </li>
83
- <li class="">
84
- <a href="/community/">Community</a>
85
- </li>
86
94
  <li class="">
87
95
  <a href="/help/">Help</a>
88
96
  </li>
@@ -91,8 +99,7 @@
91
99
  </li>
92
100
  </ul>
93
101
 
94
- </nav>
95
- </div>
102
+ </nav>
96
103
  </header>
97
104
 
98
105
 
@@ -308,17 +315,17 @@
308
315
 
309
316
  <p>If you prefer configuration as code over GUI, you can generate a <code class="highlighter-rouge">buddy.yml</code> that will create a pipeline with the Jekyll action once you push it to the target branch:</p>
310
317
 
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>
312
- <span class="ss">trigger_mode: </span><span class="s2">"ON_EVERY_PUSH"</span>
313
- <span class="ss">ref_name: </span><span class="s2">"master"</span>
314
- <span class="ss">actions:
315
- </span><span class="o">-</span> <span class="ss">action: </span><span class="s2">"Execute: jekyll build"</span>
316
- <span class="ss">type: </span><span class="s2">"BUILD"</span>
317
- <span class="ss">docker_image_name: </span><span class="s2">"jekyll/jekyll"</span>
318
- <span class="ss">docker_image_tag: </span><span class="s2">"latest"</span>
319
- <span class="ss">execute_commands:
320
- </span><span class="o">-</span> <span class="s2">"chown jekyll:jekyll $WORKING_DIR"</span>
321
- <span class="o">-</span> <span class="s2">"jekyll build"</span>
318
+ <div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="pi">-</span> <span class="na">pipeline</span><span class="pi">:</span> <span class="s2">"</span><span class="s">Build</span><span class="nv"> </span><span class="s">and</span><span class="nv"> </span><span class="s">Deploy</span><span class="nv"> </span><span class="s">Jekyll</span><span class="nv"> </span><span class="s">site"</span>
319
+ <span class="na">trigger_mode</span><span class="pi">:</span> <span class="s2">"</span><span class="s">ON_EVERY_PUSH"</span>
320
+ <span class="na">ref_name</span><span class="pi">:</span> <span class="s2">"</span><span class="s">master"</span>
321
+ <span class="na">actions</span><span class="pi">:</span>
322
+ <span class="pi">-</span> <span class="na">action</span><span class="pi">:</span> <span class="s2">"</span><span class="s">Execute:</span><span class="nv"> </span><span class="s">jekyll</span><span class="nv"> </span><span class="s">build"</span>
323
+ <span class="na">type</span><span class="pi">:</span> <span class="s2">"</span><span class="s">BUILD"</span>
324
+ <span class="na">docker_image_name</span><span class="pi">:</span> <span class="s2">"</span><span class="s">jekyll/jekyll"</span>
325
+ <span class="na">docker_image_tag</span><span class="pi">:</span> <span class="s2">"</span><span class="s">latest"</span>
326
+ <span class="na">execute_commands</span><span class="pi">:</span>
327
+ <span class="pi">-</span> <span class="s2">"</span><span class="s">chown</span><span class="nv"> </span><span class="s">jekyll:jekyll</span><span class="nv"> </span><span class="s">$WORKING_DIR"</span>
328
+ <span class="pi">-</span> <span class="s2">"</span><span class="s">jekyll</span><span class="nv"> </span><span class="s">build"</span>
322
329
  </code></pre></div></div>
323
330
 
324
331
  <h2 id="4-setting-up-on-premises-server">4. Setting up on-premises server</h2>
@@ -643,7 +650,7 @@
643
650
  <footer>
644
651
  <div class="grid">
645
652
  <div class="unit one-third center-on-mobiles">
646
- <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>
653
+ <p>The contents of this website are <br>© 2018 under the terms of the <a href="https://github.com/jekyll/jekyll/blob/master/LICENSE">MIT License</a>.</p>
647
654
  </div>
648
655
  <div class="unit two-thirds align-right center-on-mobiles">
649
656
  <p>
@@ -721,6 +728,15 @@
721
728
  </script>
722
729
 
723
730
 
731
+ <script type="text/javascript" src="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.js"></script>
732
+ <script type="text/javascript"> docsearch({
733
+ apiKey: '50fe39c839958dfad797000f33e2ec17',
734
+ indexName: 'jekyllrb',
735
+ inputSelector: '#docsearch-input',
736
+ enhancedSearchInput: true,
737
+ debug: false // Set debug to true if you want to inspect the dropdown
738
+ });
739
+ </script>
724
740
 
725
741
  </body>
726
742
  </html>
@@ -4,14 +4,16 @@
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.6.2">
7
+ <meta name="generator" content="Jekyll v3.7.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
+ <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css">
11
12
  <link rel="stylesheet" href="/css/screen.css">
12
13
  <link rel="icon" type="image/x-icon" href="/favicon.ico">
13
- <!-- Begin Jekyll SEO tag v2.3.0 -->
14
+ <!-- Begin Jekyll SEO tag v2.4.0 -->
14
15
  <title>CircleCI | Jekyll • Simple, blog-aware, static sites</title>
16
+ <meta name="generator" content="Jekyll v3.7.0">
15
17
  <meta property="og:title" content="CircleCI">
16
18
  <meta property="og:locale" content="en_US">
17
19
  <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.">
@@ -20,12 +22,12 @@
20
22
  <meta property="og:url" content="https://jekyllrb.com/docs/continuous-integration/circleci/">
21
23
  <meta property="og:site_name" content="Jekyll • Simple, blog-aware, static sites">
22
24
  <meta property="og:type" content="article">
23
- <meta property="article:published_time" content="2017-10-24T09:12:04-07:00">
25
+ <meta property="article:published_time" content="2018-01-03T02:41:17-08:00">
24
26
  <meta name="twitter:card" content="summary">
25
27
  <meta name="twitter:site" content="@jekyllrb">
26
28
  <meta name="google-site-verification" content="onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY">
27
29
  <script type="application/ld+json">
28
- {"name":null,"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.","url":"https://jekyllrb.com/docs/continuous-integration/circleci/","headline":"CircleCI","dateModified":"2017-10-24T09:12:04-07:00","datePublished":"2017-10-24T09:12:04-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>
30
+ {"headline":"CircleCI","dateModified":"2018-01-03T02:41:17-08:00","datePublished":"2018-01-03T02:41:17-08:00","mainEntityOfPage":{"@type":"WebPage","@id":"https://jekyllrb.com/docs/continuous-integration/circleci/"},"publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://jekyllrb.com/img/logo-2x.png"}},"url":"https://jekyllrb.com/docs/continuous-integration/circleci/","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.","@type":"BlogPosting","@context":"http://schema.org"}</script>
29
31
  <!-- End Jekyll SEO tag -->
30
32
 
31
33
  <!--[if lt IE 9]>
@@ -37,8 +39,17 @@
37
39
 
38
40
  <body class="wrap">
39
41
  <header>
40
- <nav class="mobile-nav show-on-mobiles">
41
- <ul>
42
+ <div class="flexbox">
43
+ <div class="center-on-mobiles">
44
+ <h1>
45
+ <a href="/" class="logo">
46
+ <span class="sr-only">Jekyll</span>
47
+ <img src="/img/logo-2x.png" width="140" height="65" alt="Jekyll Logo">
48
+ </a>
49
+ </h1>
50
+ </div>
51
+ <nav class="main-nav hide-on-mobiles">
52
+ <ul>
42
53
  <li class="">
43
54
  <a href="/">Home</a>
44
55
  </li>
@@ -48,29 +59,29 @@
48
59
  <li class="">
49
60
  <a href="/news/">News</a>
50
61
  </li>
51
- <li class="">
52
- <a href="/community/">Community</a>
53
- </li>
54
62
  <li class="">
55
63
  <a href="/help/">Help</a>
56
64
  </li>
57
- <li>
58
- <a href="https://github.com/jekyll/jekyll">GitHub</a>
59
- </li>
60
65
  </ul>
61
66
 
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>
67
+ </nav>
68
+ <div class="search hide-on-mobiles">
69
+ <input type="text" id="docsearch-input" placeholder="Search the docs…">
70
+
71
71
  </div>
72
- <nav class="main-nav unit two-thirds hide-on-mobiles">
72
+ <div class="meta hide-on-mobiles">
73
73
  <ul>
74
+ <li>
75
+ <a href="https://github.com/jekyll/jekyll/releases/tag/v3.7.0">v3.7.0</a>
76
+ </li>
77
+ <li>
78
+ <a href="https://github.com/jekyll/jekyll">GitHub</a>
79
+ </li>
80
+ </ul>
81
+ </div>
82
+ </div>
83
+ <nav class="mobile-nav show-on-mobiles">
84
+ <ul>
74
85
  <li class="">
75
86
  <a href="/">Home</a>
76
87
  </li>
@@ -80,9 +91,6 @@
80
91
  <li class="">
81
92
  <a href="/news/">News</a>
82
93
  </li>
83
- <li class="">
84
- <a href="/community/">Community</a>
85
- </li>
86
94
  <li class="">
87
95
  <a href="/help/">Help</a>
88
96
  </li>
@@ -91,8 +99,7 @@
91
99
  </li>
92
100
  </ul>
93
101
 
94
- </nav>
95
- </div>
102
+ </nav>
96
103
  </header>
97
104
 
98
105
 
@@ -305,12 +312,12 @@
305
312
 
306
313
  <p>The easiest way to manage dependencies for a Jekyll project (with or without CircleCI) is via a <a href="http://bundler.io/gemfile.html">Gemfile</a>. You’d want to have Jekyll, any Jekyll plugins, <a href="#html-proofer">HTML Proofer</a>, and any other gems that you are using in the <code class="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
314
 
308
- <div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="s">source 'https://rubygems.org'</span>
315
+ <div class="language-ruby highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="n">source</span> <span class="s1">'https://rubygems.org'</span>
309
316
 
310
- <span class="s">ruby '2.4.0'</span>
317
+ <span class="n">ruby</span> <span class="s1">'2.4.0'</span>
311
318
 
312
- <span class="s">gem 'jekyll'</span>
313
- <span class="s">gem 'html-proofer'</span>
319
+ <span class="n">gem</span> <span class="s1">'jekyll'</span>
320
+ <span class="n">gem</span> <span class="s1">'html-proofer'</span>
314
321
  </code></pre></div></div>
315
322
 
316
323
  <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,9 +326,9 @@
319
326
 
320
327
  <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>
321
328
 
322
- <div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>dependencies:
323
- post:
324
- - bundle exec jekyll build
329
+ <div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">dependencies</span><span class="pi">:</span>
330
+ <span class="na">post</span><span class="pi">:</span>
331
+ <span class="pi">-</span> <span class="s">bundle exec jekyll build</span>
325
332
  </code></pre></div></div>
326
333
 
327
334
  <h3 id="html-proofer">HTML Proofer</h3>
@@ -337,23 +344,23 @@
337
344
 
338
345
  <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>
339
346
 
340
- <div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>machine:
341
- environment:
342
- NOKOGIRI_USE_SYSTEM_LIBRARIES: true # speeds up installation of html-proofer
347
+ <div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">machine</span><span class="pi">:</span>
348
+ <span class="na">environment</span><span class="pi">:</span>
349
+ <span class="na">NOKOGIRI_USE_SYSTEM_LIBRARIES</span><span class="pi">:</span> <span class="no">true</span> <span class="c1"># speeds up installation of html-proofer</span>
343
350
 
344
- dependencies:
345
- post:
346
- - bundle exec jekyll build
351
+ <span class="na">dependencies</span><span class="pi">:</span>
352
+ <span class="na">post</span><span class="pi">:</span>
353
+ <span class="pi">-</span> <span class="s">bundle exec jekyll build</span>
347
354
 
348
- test:
349
- post:
350
- - bundle exec htmlproofer ./_site --allow-hash-href --check-favicon --check-html --disable-external
355
+ <span class="na">test</span><span class="pi">:</span>
356
+ <span class="na">post</span><span class="pi">:</span>
357
+ <span class="pi">-</span> <span class="s">bundle exec htmlproofer ./_site --allow-hash-href --check-favicon --check-html --disable-external</span>
351
358
 
352
- deployment:
353
- prod:
354
- branch: master
355
- commands:
356
- - rsync -va --delete ./_site username@my-website:/var/html
359
+ <span class="na">deployment</span><span class="pi">:</span>
360
+ <span class="na">prod</span><span class="pi">:</span>
361
+ <span class="na">branch</span><span class="pi">:</span> <span class="s">master</span>
362
+ <span class="na">commands</span><span class="pi">:</span>
363
+ <span class="pi">-</span> <span class="s">rsync -va --delete ./_site username@my-website:/var/html</span>
357
364
  </code></pre></div></div>
358
365
 
359
366
  <h2 id="questions">Questions?</h2>
@@ -674,7 +681,7 @@ deployment:
674
681
  <footer>
675
682
  <div class="grid">
676
683
  <div class="unit one-third center-on-mobiles">
677
- <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>
684
+ <p>The contents of this website are <br>© 2018 under the terms of the <a href="https://github.com/jekyll/jekyll/blob/master/LICENSE">MIT License</a>.</p>
678
685
  </div>
679
686
  <div class="unit two-thirds align-right center-on-mobiles">
680
687
  <p>
@@ -752,6 +759,15 @@ deployment:
752
759
  </script>
753
760
 
754
761
 
762
+ <script type="text/javascript" src="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.js"></script>
763
+ <script type="text/javascript"> docsearch({
764
+ apiKey: '50fe39c839958dfad797000f33e2ec17',
765
+ indexName: 'jekyllrb',
766
+ inputSelector: '#docsearch-input',
767
+ enhancedSearchInput: true,
768
+ debug: false // Set debug to true if you want to inspect the dropdown
769
+ });
770
+ </script>
755
771
 
756
772
  </body>
757
773
  </html>