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>Themes - Jekyll • Simple, blog-aware, static sites</title>
13
+ <!-- Begin Jekyll SEO tag v2.2.3 -->
14
+ <title>Themes | Jekyll • Simple, blog-aware, static sites</title>
15
15
  <meta property="og:title" content="Themes">
16
+ <meta property="og:locale" content="en_US">
16
17
  <meta name="description" content="Jekyll has an extensive theme system that allows you to leverage community-maintained templates and styles to customize your site’s presentation. Jekyll themes package up layouts, includes, and stylesheets in a way that can be overridden by your site’s content.">
17
18
  <meta property="og:description" content="Jekyll has an extensive theme system that allows you to leverage community-maintained templates and styles to customize your site’s presentation. Jekyll themes package up layouts, includes, and stylesheets in a way that can be overridden by your site’s content.">
18
19
  <link rel="canonical" href="https://jekyllrb.com/docs/themes/">
19
20
  <meta property="og:url" content="https://jekyllrb.com/docs/themes/">
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": "Themes",
30
- "datePublished": "2017-03-22T08:08:47-07:00",
31
- "description": "Jekyll has an extensive theme system that allows you to leverage community-maintained templates and styles to customize your site’s presentation. Jekyll themes package up layouts, includes, and stylesheets in a way that can be overridden by your site’s content.",
32
- "publisher": {"@type": "Organization",
33
- "logo": {"@type": "ImageObject",
34
- "url": "https://jekyllrb.com/img/logo-2x.png"}},
35
- "url": "https://jekyllrb.com/docs/themes/"}</script>
28
+ {"@context":"http://schema.org","@type":"BlogPosting","headline":"Themes","datePublished":"2017-07-17T13:16:40-07:00","dateModified":"2017-07-17T13:16:40-07:00","description":"Jekyll has an extensive theme system that allows you to leverage community-maintained templates and styles to customize your site’s presentation. Jekyll themes package up layouts, includes, and stylesheets in a way that can be overridden by your site’s content.","publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://jekyllrb.com/img/logo-2x.png"}},"mainEntityOfPage":{"@type":"WebPage","@id":"https://jekyllrb.com/docs/themes/"},"url":"https://jekyllrb.com/docs/themes/"}</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
 
@@ -323,26 +320,17 @@
323
320
 
324
321
  <p>Jekyll themes set default layouts, includes, and stylesheets. However, you can override any of the theme defaults with your own site content.</p>
325
322
 
326
- <p>For example, if your selected theme has a <code class="highlighter-rouge">page</code> layout, you can override the theme’s layout by creating your own <code class="highlighter-rouge">page</code> layout in the <code class="highlighter-rouge">_layouts</code> directory (that is, <code class="highlighter-rouge">_layouts/page.html</code>).</p>
327
-
328
- <p>Jekyll will look first to your site’s content before looking to the theme’s defaults for any requested file in the following folders:</p>
329
-
330
- <ul>
331
- <li><code class="highlighter-rouge">/assets</code></li>
332
- <li><code class="highlighter-rouge">/_layouts</code></li>
333
- <li><code class="highlighter-rouge">/_includes</code></li>
334
- <li><code class="highlighter-rouge">/_sass</code></li>
335
- </ul>
323
+ <p>To replace layouts or includes in your theme, make a copy in your <code class="highlighter-rouge">_layouts</code> or <code class="highlighter-rouge">_includes</code> directory of the specific file you wish to modify, or create the file from scratch giving it the same name as the file you wish to override.</p>
336
324
 
337
- <p class="note info">Refer to your selected theme’s documentation and source repository for more information on what files you can override.</p>
325
+ <p>For example, if your selected theme has a <code class="highlighter-rouge">page</code> layout, you can override the theme’s layout by creating your own <code class="highlighter-rouge">page</code> layout in the <code class="highlighter-rouge">_layouts</code> directory (that is, <code class="highlighter-rouge">_layouts/page.html</code>).</p>
338
326
 
339
- <p>To locate theme’s files on your computer:</p>
327
+ <p>To locate a theme’s files on your computer:</p>
340
328
 
341
329
  <ol>
342
330
  <li>
343
- <p>Run <code class="highlighter-rouge">bundle show</code> followed by the name of the theme’s gem, e.g., <code class="highlighter-rouge">bundle show minima</code> for default Jekyll’s theme.</p>
331
+ <p>Run <code class="highlighter-rouge">bundle show</code> followed by the name of the theme’s gem, e.g., <code class="highlighter-rouge">bundle show minima</code> for Jekyll’s default theme.</p>
344
332
 
345
- <p>This returns the location of the gem-based theme files. For example, Minima theme’s files are located in <code class="highlighter-rouge">/usr/local/lib/ruby/gems/2.3.0/gems/minima-2.1.0</code> on macOS.</p>
333
+ <p>This returns the location of the gem-based theme files. For example, the Minima theme’s files might be located in <code class="highlighter-rouge">/usr/local/lib/ruby/gems/2.3.0/gems/minima-2.1.0</code> on macOS.</p>
346
334
  </li>
347
335
  <li>
348
336
  <p>Open the theme’s directory in Finder or Explorer:</p>
@@ -385,13 +373,28 @@ explorer /usr/local/lib/ruby/gems/2.3.0/gems/minima-2.1.0
385
373
  └── main.scss
386
374
  </code></pre>
387
375
  </div>
388
-
389
- <p>With a clear understanding of the theme’s files, you can now override any theme file by creating a similarly named file in your Jekyll site directory.</p>
390
-
391
- <p>Let’s say you want to override Minima’s footer. In your Jekyll site, create an <code class="highlighter-rouge">_includes</code> folder and add a file in it called <code class="highlighter-rouge">footer.html</code>. Jekyll will now use your site’s <code class="highlighter-rouge">footer.html</code> file instead of the <code class="highlighter-rouge">footer.html</code> file from the Minima theme gem.</p>
392
376
  </li>
393
377
  </ol>
394
378
 
379
+ <p>With a clear understanding of the theme’s files, you can now override any theme file by creating a similarly named file in your Jekyll site directory.</p>
380
+
381
+ <p>Let’s say, for a second example, you want to override Minima’s footer. In your Jekyll site, create an <code class="highlighter-rouge">_includes</code> folder and add a file in it called <code class="highlighter-rouge">footer.html</code>. Jekyll will now use your site’s <code class="highlighter-rouge">footer.html</code> file instead of the <code class="highlighter-rouge">footer.html</code> file from the Minima theme gem.</p>
382
+
383
+ <p>To modify any stylesheet you must take the extra step of also copying the main sass file (<code class="highlighter-rouge">_sass/minima.scss</code> in the Minima theme) into the <code class="highlighter-rouge">_sass</code> directory in your site’s source.</p>
384
+
385
+ <p>Jekyll will look first to your site’s content before looking to the theme’s defaults for any requested file in the following folders:</p>
386
+
387
+ <ul>
388
+ <li><code class="highlighter-rouge">/assets</code></li>
389
+ <li><code class="highlighter-rouge">/_layouts</code></li>
390
+ <li><code class="highlighter-rouge">/_includes</code></li>
391
+ <li><code class="highlighter-rouge">/_sass</code></li>
392
+ </ul>
393
+
394
+ <p>Note that making copies of theme files will prevent you from receiving any theme updates on those files. An alternative, to continue getting theme updates on all stylesheets, is to use higher specificity CSS selectors in your own additional, originally named CSS files.</p>
395
+
396
+ <p class="note info">Refer to your selected theme’s documentation and source repository for more information on what files you can override.</p>
397
+
395
398
  <h2 id="converting-gem-based-themes-to-regular-themes">Converting gem-based themes to regular themes</h2>
396
399
 
397
400
  <p>Suppose you want to get rid of the gem-based theme and convert it to a regular theme, where all files are present in your Jekyll site directory, with nothing stored in the theme gem.</p>
@@ -450,7 +453,7 @@ explorer /usr/local/lib/ruby/gems/2.3.0/gems/minima-2.1.0
450
453
  </li>
451
454
  </ol>
452
455
 
453
- <p>You can have multiple themes listed in your site’s <code class="highlighter-rouge">Gemfile</code>, but only one theme can be selected in your site’s <code class="highlighter-rouge">_config.yml</code>. {: .note .info }</p>
456
+ <p class="note info">You can have multiple themes listed in your site’s <code class="highlighter-rouge">Gemfile</code>, but only one theme can be selected in your site’s <code class="highlighter-rouge">_config.yml</code>.</p>
454
457
 
455
458
  <p>If you’re publishing your Jekyll site on <a href="https://pages.github.com/">GitHub Pages</a>, note that GitHub Pages supports only some gem-based themes. See <a href="https://pages.github.com/themes/">Supported Themes</a> in GitHub’s documentation to see which themes are supported.</p>
456
459
 
@@ -494,7 +497,7 @@ For <span class="nb">help </span>getting started, <span class="nb">read</span> /
494
497
  <p>Any file in <code class="highlighter-rouge">/assets</code> will be copied over to the user’s site upon build unless they have a file with the same relative path. You can ship any kind of asset here: SCSS, an image, a webfont, etc. These files behave like pages and static files in Jekyll:</p>
495
498
 
496
499
  <ul>
497
- <li>If the file has <a href="../docs/frontmatter/">YAML front matter</a> at the top, it will be rendered.</li>
500
+ <li>If the file has <a href="/docs/frontmatter/">YAML front matter</a> at the top, it will be rendered.</li>
498
501
  <li>If the file does not have YAML front matter, it will simply be copied over into the resulting site.</li>
499
502
  </ul>
500
503
 
@@ -519,6 +522,12 @@ For <span class="nb">help </span>getting started, <span class="nb">read</span> /
519
522
  </code></pre>
520
523
  </div>
521
524
 
525
+ <h3 id="theme-gem-dependencies">Theme-gem dependencies</h3>
526
+
527
+ <p>From <code class="highlighter-rouge">v3.5</code>, Jekyll will automatically require all whitelisted <code class="highlighter-rouge">runtime_dependencies</code> of your theme-gem even if they’re not explicitly included under the <code class="highlighter-rouge">gems</code> array in the site’s config file. (NOTE: whitelisting is only required when building or serving with the <code class="highlighter-rouge">--safe</code> option.)</p>
528
+
529
+ <p>With this, the end-user need not keep track of the plugins required to be included in their config file for their theme-gem to work as intended.</p>
530
+
522
531
  <h3 id="documenting-your-theme">Documenting your theme</h3>
523
532
 
524
533
  <p>Your theme should include a <code class="highlighter-rouge">/README.md</code> file, which explains how site authors can install and use your theme. What layouts are included? What includes? Do they need to add anything special to their site’s configuration file?</p>
@@ -531,7 +540,7 @@ For <span class="nb">help </span>getting started, <span class="nb">read</span> /
531
540
 
532
541
  <p>To preview your theme as you’re authoring it, it may be helpful to add dummy content in, for example, <code class="highlighter-rouge">/index.html</code> and <code class="highlighter-rouge">/page.html</code> files. This will allow you to use the <code class="highlighter-rouge">jekyll build</code> and <code class="highlighter-rouge">jekyll serve</code> commands to preview your theme, just as you’d preview a Jekyll site.</p>
533
542
 
534
- <p>If you do preview your theme locally, be sure to add <code class="highlighter-rouge">/_site</code> to your theme’s <code class="highlighter-rouge">.gitignore</code> file to prevent the compiled site from also being included when you distribute your theme. {: .info .note}</p>
543
+ <p class="info note">If you do preview your theme locally, be sure to add <code class="highlighter-rouge">/_site</code> to your theme’s <code class="highlighter-rouge">.gitignore</code> file to prevent the compiled site from also being included when you distribute your theme.</p>
535
544
 
536
545
  <h3 id="publishing-your-theme">Publishing your theme</h3>
537
546
 
@@ -539,7 +548,17 @@ For <span class="nb">help </span>getting started, <span class="nb">read</span> /
539
548
 
540
549
  <ol>
541
550
  <li>
542
- <p>First, package your theme, by running the following command, replacing <code class="highlighter-rouge">jekyll-theme-awesome</code> with the name of your theme:</p>
551
+ <p>First, you need to have it in a git repository:</p>
552
+
553
+ <div class="language-sh highlighter-rouge">
554
+ <pre class="highlight"><code>git init <span class="c"># Only the first time</span>
555
+ git add -A
556
+ git commit -m <span class="s2">"Init commit"</span>
557
+ </code></pre>
558
+ </div>
559
+ </li>
560
+ <li>
561
+ <p>Next, package your theme, by running the following command, replacing <code class="highlighter-rouge">jekyll-theme-awesome</code> with the name of your theme:</p>
543
562
 
544
563
  <div class="language-sh highlighter-rouge">
545
564
  <pre class="highlight"><code>gem build jekyll-theme-awesome.gemspec
@@ -547,7 +566,7 @@ For <span class="nb">help </span>getting started, <span class="nb">read</span> /
547
566
  </div>
548
567
  </li>
549
568
  <li>
550
- <p>Next, push your packaged theme up to the RubyGems service, by running the following command, again replacing <code class="highlighter-rouge">jekyll-theme-awesome</code> with the name of your theme:</p>
569
+ <p>Finally, push your packaged theme up to the RubyGems service, by running the following command, again replacing <code class="highlighter-rouge">jekyll-theme-awesome</code> with the name of your theme:</p>
551
570
 
552
571
  <div class="language-sh highlighter-rouge">
553
572
  <pre class="highlight"><code>gem push jekyll-theme-awesome-<span class="k">*</span>.gem
@@ -555,7 +574,7 @@ For <span class="nb">help </span>getting started, <span class="nb">read</span> /
555
574
  </div>
556
575
  </li>
557
576
  <li>
558
- <p>To release a new version of your theme, update the version number in the gemspec file, ( <code class="highlighter-rouge">jekyll-theme-awesome.gemspec</code> in this example ), and then repeat Steps 1 &amp; 2 above. We recommend that you follow <a href="http://semver.org/">Semantic Versioning</a> while bumping your theme-version.</p>
577
+ <p>To release a new version of your theme, update the version number in the gemspec file, ( <code class="highlighter-rouge">jekyll-theme-awesome.gemspec</code> in this example ), and then repeat Steps 1 - 3 above. We recommend that you follow <a href="http://semver.org/">Semantic Versioning</a> while bumping your theme-version.</p>
559
578
  </li>
560
579
  </ol>
561
580
 
@@ -626,6 +645,9 @@ For <span class="nb">help </span>getting started, <span class="nb">read</span> /
626
645
 
627
646
 
628
647
 
648
+
649
+
650
+
629
651
 
630
652
 
631
653
 
@@ -671,6 +693,10 @@ For <span class="nb">help </span>getting started, <span class="nb">read</span> /
671
693
 
672
694
 
673
695
 
696
+ <li class=""><a href="/docs/windows/">Jekyll on Windows</a></li>
697
+
698
+
699
+
674
700
  <li class=""><a href="/docs/usage/">Basic Usage</a></li>
675
701
 
676
702
 
@@ -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>Troubleshooting - Jekyll • Simple, blog-aware, static sites</title>
13
+ <!-- Begin Jekyll SEO tag v2.2.3 -->
14
+ <title>Troubleshooting | Jekyll • Simple, blog-aware, static sites</title>
15
15
  <meta property="og:title" content="Troubleshooting">
16
+ <meta property="og:locale" content="en_US">
16
17
  <meta name="description" content="If you ever run into problems installing or using Jekyll, here are a few tips that might be of help. If the problem you’re experiencing isn’t covered below, please check out our other help resources as well.">
17
18
  <meta property="og:description" content="If you ever run into problems installing or using Jekyll, here are a few tips that might be of help. If the problem you’re experiencing isn’t covered below, please check out our other help resources as well.">
18
19
  <link rel="canonical" href="https://jekyllrb.com/docs/troubleshooting/">
19
20
  <meta property="og:url" content="https://jekyllrb.com/docs/troubleshooting/">
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": "Troubleshooting",
30
- "datePublished": "2017-03-22T08:08:47-07:00",
31
- "description": "If you ever run into problems installing or using Jekyll, here are a few tips that might be of help. If the problem you’re experiencing isn’t covered below, please check out our other help resources as well.",
32
- "publisher": {"@type": "Organization",
33
- "logo": {"@type": "ImageObject",
34
- "url": "https://jekyllrb.com/img/logo-2x.png"}},
35
- "url": "https://jekyllrb.com/docs/troubleshooting/"}</script>
28
+ {"@context":"http://schema.org","@type":"BlogPosting","headline":"Troubleshooting","datePublished":"2017-07-17T13:16:40-07:00","dateModified":"2017-07-17T13:16:40-07:00","description":"If you ever run into problems installing or using Jekyll, here are a few tips that might be of help. If the problem you’re experiencing isn’t covered below, please check out our other help resources as well.","publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://jekyllrb.com/img/logo-2x.png"}},"mainEntityOfPage":{"@type":"WebPage","@id":"https://jekyllrb.com/docs/troubleshooting/"},"url":"https://jekyllrb.com/docs/troubleshooting/"}</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
 
@@ -306,7 +303,7 @@ that might be of help. If the problem you’re experiencing isn’t covered belo
306
303
  <h2 id="installation-problems">Installation Problems</h2>
307
304
 
308
305
  <p>If you encounter errors during gem installation, you may need to install
309
- the header files for compiling extension modules for Ruby 2.0.0. This
306
+ the header files for compiling extension modules for Ruby 2.x This
310
307
  can be done on Ubuntu or Debian by running:</p>
311
308
 
312
309
  <div class="language-sh highlighter-rouge">
@@ -328,6 +325,17 @@ can be done on Ubuntu or Debian by running:</p>
328
325
  </code></pre>
329
326
  </div>
330
327
 
328
+ <p>On Ubuntu if you get stuck after <code class="highlighter-rouge">bundle exec jekyll serve</code> and see error
329
+ messages like <code class="highlighter-rouge">Could not locate Gemfile</code> or <code class="highlighter-rouge">.bundle/ directory</code>, it’s likely
330
+ because all requirements have not been fully met. Recent stock Ubuntu
331
+ distributions require the installation of both the <code class="highlighter-rouge">ruby</code> and <code class="highlighter-rouge">ruby-all-dev</code>
332
+ packages:</p>
333
+
334
+ <div class="language-sh highlighter-rouge">
335
+ <pre class="highlight"><code>sudo apt-get install ruby ruby-all-dev
336
+ </code></pre>
337
+ </div>
338
+
331
339
  <p>On <a href="https://www.nearlyfreespeech.net/">NearlyFreeSpeech</a> you need to run the
332
340
  following commands before installing Jekyll:</p>
333
341
 
@@ -349,6 +357,13 @@ following commands before installing Jekyll:</p>
349
357
  <p>On Windows, you may need to install <a href="https://wiki.github.com/oneclick/rubyinstaller/development-kit">RubyInstaller
350
358
  DevKit</a>.</p>
351
359
 
360
+ <p>On Android (with Termux) you can install all requirements by running:</p>
361
+
362
+ <div class="language-sh highlighter-rouge">
363
+ <pre class="highlight"><code>apt update <span class="o">&amp;&amp;</span> apt install libffi-dev clang ruby-dev make
364
+ </code></pre>
365
+ </div>
366
+
352
367
  <p>On macOS, you may need to update RubyGems (using <code class="highlighter-rouge">sudo</code> only if necessary):</p>
353
368
 
354
369
  <div class="language-sh highlighter-rouge">
@@ -481,9 +496,9 @@ is as follows:</p>
481
496
  and flags specified at the command-line will override all other settings
482
497
  specified elsewhere.</p>
483
498
 
484
- <p>If you encounter an error in building the site, with the error message
485
- “‘0000-00-00-welcome-to-jekyll.markdown.erb’ does not have a valid date in the
486
- YAML front matter.” try including the line <code class="highlighter-rouge">exclude: [vendor]</code>
499
+ <p>If you encounter an error in building the site, with the error message
500
+ “‘0000-00-00-welcome-to-jekyll.markdown.erb’ does not have a valid date in the
501
+ YAML front matter.” try including the line <code class="highlighter-rouge">exclude: [vendor]</code>
487
502
  in <code class="highlighter-rouge">_config.yml</code>.</p>
488
503
 
489
504
  <h2 id="markup-problems">Markup Problems</h2>
@@ -609,6 +624,9 @@ The issue is caused by trying to copy a non-existing symlink.</p>
609
624
 
610
625
 
611
626
 
627
+
628
+
629
+
612
630
 
613
631
 
614
632
 
@@ -654,6 +672,10 @@ The issue is caused by trying to copy a non-existing symlink.</p>
654
672
 
655
673
 
656
674
 
675
+ <li class=""><a href="/docs/windows/">Jekyll on Windows</a></li>
676
+
677
+
678
+
657
679
  <li class=""><a href="/docs/usage/">Basic Usage</a></li>
658
680
 
659
681
 
@@ -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>Upgrading from 0.x to 2.x - Jekyll • Simple, blog-aware, static sites</title>
13
+ <!-- Begin Jekyll SEO tag v2.2.3 -->
14
+ <title>Upgrading from 0.x to 2.x | Jekyll • Simple, blog-aware, static sites</title>
15
15
  <meta property="og:title" content="Upgrading from 0.x to 2.x">
16
+ <meta property="og:locale" content="en_US">
16
17
  <meta name="description" content="Upgrading from an older version of Jekyll? A few things have changed in 1.0 and 2.0 that you’ll want to know about.">
17
18
  <meta property="og:description" content="Upgrading from an older version of Jekyll? A few things have changed in 1.0 and 2.0 that you’ll want to know about.">
18
19
  <link rel="canonical" href="https://jekyllrb.com/docs/upgrading/0-to-2/">
19
20
  <meta property="og:url" content="https://jekyllrb.com/docs/upgrading/0-to-2/">
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": "Upgrading from 0.x to 2.x",
30
- "datePublished": "2017-03-22T08:08:47-07:00",
31
- "description": "Upgrading from an older version of Jekyll? A few things have changed in 1.0 and 2.0 that you’ll want to know about.",
32
- "publisher": {"@type": "Organization",
33
- "logo": {"@type": "ImageObject",
34
- "url": "https://jekyllrb.com/img/logo-2x.png"}},
35
- "url": "https://jekyllrb.com/docs/upgrading/0-to-2/"}</script>
28
+ {"@context":"http://schema.org","@type":"BlogPosting","headline":"Upgrading from 0.x to 2.x","datePublished":"2017-07-17T13:16:40-07:00","dateModified":"2017-07-17T13:16:40-07:00","description":"Upgrading from an older version of Jekyll? A few things have changed in 1.0 and 2.0 that you’ll want to know about.","publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://jekyllrb.com/img/logo-2x.png"}},"mainEntityOfPage":{"@type":"WebPage","@id":"https://jekyllrb.com/docs/upgrading/0-to-2/"},"url":"https://jekyllrb.com/docs/upgrading/0-to-2/"}</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
 
@@ -524,6 +521,9 @@ you’d expect in both environments.</p>
524
521
 
525
522
 
526
523
 
524
+
525
+
526
+
527
527
 
528
528
 
529
529
 
@@ -569,6 +569,10 @@ you’d expect in both environments.</p>
569
569
 
570
570
 
571
571
 
572
+ <li class=""><a href="/docs/windows/">Jekyll on Windows</a></li>
573
+
574
+
575
+
572
576
  <li class=""><a href="/docs/usage/">Basic Usage</a></li>
573
577
 
574
578