jekyll-docs 3.3.1 → 3.4.0

data/site/docs/themes/index.html

@@ -4,7 +4,7 @@
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   <meta charset="UTF-8">
   <meta name="viewport" content="width=device-width,initial-scale=1">
-  <meta name="generator" content="Jekyll v3.3.1">
+  <meta name="generator" content="Jekyll v3.4.0">
   <link type="application/atom+xml" rel="alternate" href="https://jekyllrb.com/feed.xml" title="Jekyll • Simple, blog-aware, static sites">
   <link rel="alternate" type="application/atom+xml" title="Recent commits to Jekyll’s master branch" href="https://github.com/jekyll/jekyll/commits/master.atom">
   <link rel="stylesheet" href="//fonts.googleapis.com/css?family=Lato:300,300italic,400,400italic,700,700italic,900">
@@ -13,13 +13,13 @@
   <!-- Begin Jekyll SEO tag v2.1.0 -->
 <title>Themes - Jekyll • Simple, blog-aware, static sites</title>
 <meta property="og:title" content="Themes">
-<meta name="description" content="Jekyll has an extensive theme system, which allows you to leverage community-maintained templates and styles to customize your site’s presentation. Jekyll themes package layouts, includes, and stylesheets in a way that can be overridden by your site’s content.">
-<meta property="og:description" content="Jekyll has an extensive theme system, which allows you to leverage community-maintained templates and styles to customize your site’s presentation. Jekyll themes package layouts, includes, and stylesheets in a way that can be overridden by your site’s content.">
+<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.">
+<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.">
 <link rel="canonical" href="https://jekyllrb.com/docs/themes/">
 <meta property="og:url" content="https://jekyllrb.com/docs/themes/">
 <meta property="og:site_name" content="Jekyll • Simple, blog-aware, static sites">
 <meta property="og:type" content="article">
-<meta property="article:published_time" content="2017-01-20T13:17:57-08:00">
+<meta property="article:published_time" content="2017-03-22T08:06:48-07:00">
 <meta name="twitter:card" content="summary">
 <meta name="twitter:site" content="@jekyllrb">
 <meta name="google-site-verification" content="onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY">
@@ -27,8 +27,8 @@
 {"@context": "http://schema.org",
 "@type": "BlogPosting",
 "headline": "Themes",
-"datePublished": "2017-01-20T13:17:57-08:00",
-"description": "Jekyll has an extensive theme system, which allows you to leverage community-maintained templates and styles to customize your site’s presentation. Jekyll themes package layouts, includes, and stylesheets in a way that can be overridden by your site’s content.",
+"datePublished": "2017-03-22T08:06:48-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"}},
@@ -192,6 +192,10 @@
 
   
   
+  <option value="/docs/includes/">Includes</option>
+
+  
+  
   <option value="/docs/permalinks/">Permalinks</option>
 
   
@@ -286,93 +290,234 @@
             <a href="https://github.com/jekyll/jekyll/edit/master/docs/_docs/themes.md"><i class="fa fa-pencil"></i>  Improve this page</a>
           </div>
           <h1>Themes</h1>
-          <p>Jekyll has an extensive theme system, which allows you to leverage community-maintained templates and styles to customize your site’s presentation. Jekyll themes package layouts, includes, and stylesheets in a way that can be overridden by your site’s content.</p>
+          <p>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.</p>
+
+<h2 id="understanding-gem-based-themes">Understanding gem-based themes</h2>
+
+<p>When you <a href="/docs/quickstart">create a new Jekyll site</a> (by running the <code class="highlighter-rouge">jekyll new &lt;PATH&gt;</code> command), Jekyll installs a site that uses a gem-based theme called <a href="https://github.com/jekyll/minima">Minima</a>.</p>
+
+<p>With gem-based themes, some of the site’s directories (such as the <code class="highlighter-rouge">assets</code>, <code class="highlighter-rouge">_layouts</code>, <code class="highlighter-rouge">_includes</code>, and <code class="highlighter-rouge">_sass</code> directories) are stored in the theme’s gem, hidden from your immediate view. Yet all of the necessary directories will be read and processed during Jekyll’s build process.</p>
+
+<p>In the case of Minima, you see only the following files in your Jekyll site directory:</p>
+
+<div class="highlighter-rouge">
+<pre class="highlight"><code>├── Gemfile
+├── Gemfile.lock
+├── _config.yml
+├── _posts
+│   └── 2016-12-04-welcome-to-jekyll.markdown
+├── about.md
+└── index.md
+</code></pre>
+</div>
+
+<p>The <code class="highlighter-rouge">Gemfile</code> and <code class="highlighter-rouge">Gemfile.lock</code> files are used by Bundler to keep track of the required gems and gem versions you need to build your Jekyll site.</p>
+
+<p>Gem-based themes make it easy for theme developers to make updates available to anyone who has the theme gem. When there’s an update, theme developers push the update to RubyGems.</p>
+
+<p>If you have the theme gem, you can (if you desire) run <code class="highlighter-rouge">bundle update</code> to update all gems in your project. Or you can run <code class="highlighter-rouge">bundle update &lt;THEME&gt;</code>, replacing <code class="highlighter-rouge">&lt;THEME&gt;</code> with the theme name, such as <code class="highlighter-rouge">minima</code>, to just update the theme gem. Any new files or updates the theme developer has made (such as to stylesheets or includes) will be pulled into your project automatically.</p>
+
+<p>The goal of gem-based themes is to allow you to get all the benefits of a robust, continually updated theme without having all the theme’s files getting in your way and over-complicating what might be your primary focus: creating content.</p>
+
+<h2 id="overriding-theme-defaults">Overriding theme defaults</h2>
+
+<p>Jekyll themes set default layouts, includes, and stylesheets. However, you can override any of the theme defaults with your own site content.</p>
+
+<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>
+
+<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>
+
+<ul>
+  <li><code class="highlighter-rouge">/assets</code></li>
+  <li><code class="highlighter-rouge">/_layouts</code></li>
+  <li><code class="highlighter-rouge">/_includes</code></li>
+  <li><code class="highlighter-rouge">/_sass</code></li>
+</ul>
 
-<h2 id="installing-a-theme">Installing a theme</h2>
+<p class="note info">Refer to your selected theme’s documentation and source repository for more information on what files you can override.</p>
+
+<p>To locate theme’s files on your computer:</p>
 
 <ol>
   <li>
-    <p>To install a theme, first, add the theme to your site’s <code class="highlighter-rouge">Gemfile</code>:</p>
+    <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>
 
-    <div class="highlighter-rouge">
-<pre class="highlight"><code> gem 'my-awesome-jekyll-theme'
-</code></pre>
-    </div>
+    <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>
   </li>
-  <li>Save the changes to your <code class="highlighter-rouge">Gemfile</code>
-</li>
-  <li>Run the command <code class="highlighter-rouge">bundle install</code> to install the theme</li>
   <li>
-    <p>Finally, activate the theme by adding the following to your site’s <code class="highlighter-rouge">_config.yml</code>:</p>
+    <p>Open the theme’s directory in Finder or Explorer:</p>
+
+    <div class="language-shell highlighter-rouge">
+<pre class="highlight"><code><span class="c"># On MacOS</span>
+open <span class="k">$(</span>bundle show minima<span class="k">)</span>
+<span class="c"># On Windows</span>
+explorer /usr/local/lib/ruby/gems/2.3.0/gems/minima-2.1.0
+</code></pre>
+    </div>
+
+    <p>A Finder or Explorer window opens showing the theme’s files and directories. The Minima theme gem contains these files:</p>
 
     <div class="highlighter-rouge">
-<pre class="highlight"><code> theme: my-awesome-jekyll-theme
+<pre class="highlight"><code> ├── LICENSE.txt
+ ├── README.md
+ ├── _includes
+ │   ├── disqus_comments.html
+ │   ├── footer.html
+ │   ├── google-analytics.html
+ │   ├── head.html
+ │   ├── header.html
+ │   ├── icon-github.html
+ │   ├── icon-github.svg
+ │   ├── icon-twitter.html
+ │   └── icon-twitter.svg
+ ├── _layouts
+ │   ├── default.html
+ │   ├── home.html
+ │   ├── page.html
+ │   └── post.html
+ ├── _sass
+ │   ├── minima
+ │   │   ├── _base.scss
+ │   │   ├── _layout.scss
+ │   │   └── _syntax-highlighting.scss
+ │   └── minima.scss
+ └── assets
+     └── main.scss
 </code></pre>
     </div>
+
+    <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>
+
+    <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>
   </li>
 </ol>
 
-<p class="note info">You can have multiple themes listed in your site’s Gemfile, but only one theme can be selected in your site’s <code class="highlighter-rouge">_config.yml</code>.</p>
+<h2 id="converting-gem-based-themes-to-regular-themes">Converting gem-based themes to regular themes</h2>
 
-<h2 id="overriding-theme-defaults">Overriding theme defaults</h2>
+<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>
 
-<p>Jekyll themes set default layouts, includes, and stylesheets, that can be overridden by your site’s content. 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> folder (e.g., <code class="highlighter-rouge">_layouts/page.html</code>).</p>
+<p>To do this, copy the files from the theme gem’s directory into your Jekyll site directory. (For example, copy them to <code class="highlighter-rouge">/myblog</code> if you created your Jekyll site at <code class="highlighter-rouge">/myblog</code>. See the previous section for details.)</p>
 
-<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>
+<p>Then remove references to the theme gem in <code class="highlighter-rouge">Gemfile</code> and configuration. For example, to remove <code class="highlighter-rouge">minima</code>:</p>
 
 <ul>
-  <li><code class="highlighter-rouge">/assets</code></li>
-  <li><code class="highlighter-rouge">/_layouts</code></li>
-  <li><code class="highlighter-rouge">/_includes</code></li>
-  <li><code class="highlighter-rouge">/_sass</code></li>
+  <li>Open <code class="highlighter-rouge">Gemfile</code> and remove <code class="highlighter-rouge">gem "minima", "~&gt; 2.0"</code>.</li>
+  <li>Open <code class="highlighter-rouge">_config.yml</code> and remove <code class="highlighter-rouge">theme: minima</code>.</li>
 </ul>
 
-<p class="note info">Refer to your selected theme’s documentation and source repository for more information on what files you can override.</p>
+<p>Now <code class="highlighter-rouge">bundle update</code> will no longer get updates for the theme gem.</p>
+
+<h2 id="installing-a-theme">Installing a gem-based theme</h2>
+
+<p>The <code class="highlighter-rouge">jekyll new &lt;PATH&gt;</code> command isn’t the only way to create a new Jekyll site with a gem-based theme. You can also find gem-based themes online and incorporate them into your Jekyll project.</p>
+
+<p>For example, search for <a href="https://rubygems.org/search?utf8=%E2%9C%93&amp;query=jekyll-theme">jekyll theme on RubyGems</a> to find other gem-based themes. (Note that not all themes are using <code class="highlighter-rouge">jekyll-theme</code> as a convention in the theme name.)</p>
 
-<p>To locate theme’s files on your computer, 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. Then copy the files you want to override, from the returned path to your root folder.</p>
+<p>To install a gem-based theme:</p>
 
-<h2 id="creating-a-theme">Creating a theme</h2>
+<ol>
+  <li>
+    <p>Add the theme to your site’s <code class="highlighter-rouge">Gemfile</code>:</p>
+
+    <div class="language-sh highlighter-rouge">
+<pre class="highlight"><code>gem <span class="s2">"jekyll-theme-awesome"</span>
+</code></pre>
+    </div>
+  </li>
+  <li>
+    <p>Install the theme:</p>
+
+    <div class="language-sh highlighter-rouge">
+<pre class="highlight"><code>bundle install
+</code></pre>
+    </div>
+  </li>
+  <li>
+    <p>Add the following to your site’s <code class="highlighter-rouge">_config.yml</code> to activate the theme:</p>
+
+    <div class="language-sh highlighter-rouge">
+<pre class="highlight"><code>theme: jekyll-theme-awesome
+</code></pre>
+    </div>
+  </li>
+  <li>
+    <p>Build your site:</p>
+
+    <div class="language-sh highlighter-rouge">
+<pre class="highlight"><code>bundle <span class="nb">exec </span>jekyll serve
+</code></pre>
+    </div>
+  </li>
+</ol>
+
+<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>
 
-<p>Jekyll themes are distributed as Ruby gems. Don’t worry, Jekyll will help you scaffold a new theme with the <code class="highlighter-rouge">new-theme</code> command. Just run <code class="highlighter-rouge">jekyll new-theme</code> with the theme name as an argument:</p>
+<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>
+
+<h2 id="creating-a-gem-based-theme">Creating a gem-based theme</h2>
+
+<p>If you’re a Jekyll theme developer (rather than just a consumer of themes), you can package up your theme in RubyGems and allow users to install it through Bundler.</p>
+
+<p>If you’re unfamiliar with creating Ruby gems, don’t worry. Jekyll will help you scaffold a new theme with the <code class="highlighter-rouge">new-theme</code> command. Run <code class="highlighter-rouge">jekyll new-theme</code> with the theme name as an argument.</p>
+
+<p>Here is an example:</p>
 
 <div class="language-sh highlighter-rouge">
-<pre class="highlight"><code>jekyll new-theme my-awesome-theme
-             create /path/to/my-awesome-theme/_layouts
-             create /path/to/my-awesome-theme/_includes
-             create /path/to/my-awesome-theme/_sass
-             create /path/to/my-awesome-theme/_layouts/page.html
-             create /path/to/my-awesome-theme/_layouts/post.html
-             create /path/to/my-awesome-theme/_layouts/default.html
-             create /path/to/my-awesome-theme/Gemfile
-             create /path/to/my-awesome-theme/my-awesome-theme.gemspec
-             create /path/to/my-awesome-theme/README.md
-             create /path/to/my-awesome-theme/LICENSE.txt
-         initialize /path/to/my-awesome-theme/.git
-             create /path/to/my-awesome-theme/.gitignore
-Your new Jekyll theme, my-awesome-theme, is ready <span class="k">for </span>you <span class="k">in</span> /path/to/my-awesome-theme!
-For <span class="nb">help </span>getting started, <span class="nb">read</span> /path/to/my-awesome-theme/README.md.
+<pre class="highlight"><code>jekyll new-theme jekyll-theme-awesome
+    create /path/to/jekyll-theme-awesome/_layouts
+    create /path/to/jekyll-theme-awesome/_includes
+    create /path/to/jekyll-theme-awesome/_sass
+    create /path/to/jekyll-theme-awesome/_layouts/page.html
+    create /path/to/jekyll-theme-awesome/_layouts/post.html
+    create /path/to/jekyll-theme-awesome/_layouts/default.html
+    create /path/to/jekyll-theme-awesome/Gemfile
+    create /path/to/jekyll-theme-awesome/jekyll-theme-awesome.gemspec
+    create /path/to/jekyll-theme-awesome/README.md
+    create /path/to/jekyll-theme-awesome/LICENSE.txt
+    initialize /path/to/jekyll-theme-awesome/.git
+    create /path/to/jekyll-theme-awesome/.gitignore
+Your new Jekyll theme, jekyll-theme-awesome, is ready <span class="k">for </span>you <span class="k">in</span> /path/to/jekyll-theme-awesome!
+For <span class="nb">help </span>getting started, <span class="nb">read</span> /path/to/jekyll-theme-awesome/README.md.
 </code></pre>
 </div>
 
-<p>Add your template files in the corresponding folders, complete the <code class="highlighter-rouge">.gemspec</code> and the README files according to your needs.</p>
+<p>Add your template files in the corresponding folders. Then complete the <code class="highlighter-rouge">.gemspec</code> and the README files according to your needs.</p>
 
 <h3 id="layouts-and-includes">Layouts and includes</h3>
 
 <p>Theme layouts and includes work just like they work in any Jekyll site. Place layouts in your theme’s <code class="highlighter-rouge">/_layouts</code> folder, and place includes in your themes <code class="highlighter-rouge">/_includes</code> folder.</p>
 
-<p>For example, if your theme has a <code class="highlighter-rouge">/_layouts/page.html</code> file, and a page has <code class="highlighter-rouge">layout: page</code> in its YAML front matter, Jekyll will first look to the site’s <code class="highlighter-rouge">_layouts</code> folder for a the <code class="highlighter-rouge">page</code> layout, and if none exists, will use your theme’s <code class="highlighter-rouge">page</code> layout.</p>
+<p>For example, if your theme has a <code class="highlighter-rouge">/_layouts/page.html</code> file, and a page has <code class="highlighter-rouge">layout: page</code> in its YAML front matter, Jekyll will first look to the site’s <code class="highlighter-rouge">_layouts</code> folder for the <code class="highlighter-rouge">page</code> layout, and if none exists, will use your theme’s <code class="highlighter-rouge">page</code> layout.</p>
 
 <h3 id="assets">Assets</h3>
 
-<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 may ship any kind of asset here: SCSS, an image, a webfont, etc. These files behave just like pages and static files in Jekyll: if the file has <a href="/docs/frontmatter/">YAML front matter</a> at the top, then it will be rendered. If it does not have YAML front matter, it will simply be copied over into the resulting site. This allows theme creators to ship a default <code class="highlighter-rouge">/assets/styles.scss</code> file which their layouts can depend on as <code class="highlighter-rouge">/assets/styles.css</code>.</p>
+<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>
+
+<ul>
+  <li>If the file has <a href="../docs/frontmatter/">YAML front matter</a> at the top, it will be rendered.</li>
+  <li>If the file does not have YAML front matter, it will simply be copied over into the resulting site.</li>
+</ul>
+
+<p>This allows theme creators to ship a default <code class="highlighter-rouge">/assets/styles.scss</code> file which their layouts can depend on as <code class="highlighter-rouge">/assets/styles.css</code>.</p>
 
 <p>All files in <code class="highlighter-rouge">/assets</code> will be output into the compiled site in the <code class="highlighter-rouge">/assets</code> folder just as you’d expect from using Jekyll on your sites.</p>
 
 <h3 id="stylesheets">Stylesheets</h3>
 
-<p>Your theme’s stylesheets should be placed in your theme’s <code class="highlighter-rouge">/_sass</code> folder, again, just as you would when authoring a Jekyll site. Your theme’s styles can be included in the user’s stylesheet using the <code class="highlighter-rouge">@import</code> directive.</p>
+<p>Your theme’s stylesheets should be placed in your theme’s <code class="highlighter-rouge">_sass</code> folder, again, just as you would when authoring a Jekyll site.</p>
+
+<div class="highlighter-rouge">
+<pre class="highlight"><code>_sass
+├── jekyll-theme-awesome.scss
+</code></pre>
+</div>
+
+<p>Your theme’s styles can be included in the user’s stylesheet using the <code class="highlighter-rouge">@import</code> directive.</p>
+
+<div class="language-css highlighter-rouge">
+<pre class="highlight"><code><span class="k">@import</span> <span class="s1">"{{ site.theme }}"</span><span class="p">;</span>
+</code></pre>
+</div>
 
 <h3 id="documenting-your-theme">Documenting your theme</h3>
 
@@ -386,32 +531,31 @@ For <span class="nb">help </span>getting started, <span class="nb">read</span> /
 
 <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>
 
-<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>
+<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>
 
 <h3 id="publishing-your-theme">Publishing your theme</h3>
 
-<p>Themes are published via <a href="https://rubygems.org">RubyGems.org</a>. You’ll need a RubyGems account, which you can <a href="https://rubygems.org/sign_up">create for free</a>.</p>
+<p>Themes are published via <a href="https://rubygems.org">RubyGems.org</a>. You will need a RubyGems account, which you can <a href="https://rubygems.org/sign_up">create for free</a>.</p>
 
 <ol>
   <li>
-    <p>First, package your theme, by running the following command, replacing <code class="highlighter-rouge">my-awesome-jekyll-theme</code> with the name of your theme:</p>
+    <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>
 
-    <div class="highlighter-rouge">
-<pre class="highlight"><code> gem build my-awesome-jekyll-theme.gemspec
+    <div class="language-sh highlighter-rouge">
+<pre class="highlight"><code>gem build jekyll-theme-awesome.gemspec
 </code></pre>
     </div>
   </li>
   <li>
-    <p>Next, push your packaged theme up to the RubyGems service, by running the following command, again replacing <code class="highlighter-rouge">my-awesome-jekyll-theme</code> with the name of your theme:</p>
+    <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>
 
-    <div class="highlighter-rouge">
-<pre class="highlight"><code> gem push my-awesome-jekyll-theme-*.gem
+    <div class="language-sh highlighter-rouge">
+<pre class="highlight"><code>gem push jekyll-theme-awesome-<span class="k">*</span>.gem
 </code></pre>
     </div>
   </li>
   <li>
-    <p>To release a new version of your theme, simply update the version number in the gemspec file, ( <code class="highlighter-rouge">my-awesome-jekyll-theme.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>
+    <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>
   </li>
 </ol>
 
@@ -479,6 +623,9 @@ We recommend that you follow <a href="http://semver.org/">Semantic Versioning</a
   
 
   
+  
+
+  
   
 
   
@@ -592,6 +739,10 @@ We recommend that you follow <a href="http://semver.org/">Semantic Versioning</a
 
   
   
+  <li class=""><a href="/docs/includes/">Includes</a></li>
+
+  
+  
   <li class=""><a href="/docs/permalinks/">Permalinks</a></li>
 
   
@@ -740,7 +891,7 @@ We recommend that you follow <a href="http://semver.org/">Semantic Versioning</a
 </script>
 
   
-  <!-- Gauges (http://gaug.es/) -->
+  <!-- Gauges (http://get.gaug.es/) -->
   <script>
     var _gauges = _gauges || [];
     (function() {
@@ -757,7 +908,7 @@ We recommend that you follow <a href="http://semver.org/">Semantic Versioning</a
 
 
 
-  <!-- Google Analytics (http://google.com/analytics) -->
+  <!-- Google Analytics (https://www.google.com/analytics) -->
   <script>
     !function(j,e,k,y,l,L){j.GoogleAnalyticsObject=y,j[y]||(j[y]=function(){
     (j[y].q=j[y].q||[]).push(arguments)}),j[y].l=+new Date,l=e.createElement(k),

data/site/docs/troubleshooting/index.html

@@ -4,7 +4,7 @@
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   <meta charset="UTF-8">
   <meta name="viewport" content="width=device-width,initial-scale=1">
-  <meta name="generator" content="Jekyll v3.3.1">
+  <meta name="generator" content="Jekyll v3.4.0">
   <link type="application/atom+xml" rel="alternate" href="https://jekyllrb.com/feed.xml" title="Jekyll • Simple, blog-aware, static sites">
   <link rel="alternate" type="application/atom+xml" title="Recent commits to Jekyll’s master branch" href="https://github.com/jekyll/jekyll/commits/master.atom">
   <link rel="stylesheet" href="//fonts.googleapis.com/css?family=Lato:300,300italic,400,400italic,700,700italic,900">
@@ -19,7 +19,7 @@
 <meta property="og:url" content="https://jekyllrb.com/docs/troubleshooting/">
 <meta property="og:site_name" content="Jekyll • Simple, blog-aware, static sites">
 <meta property="og:type" content="article">
-<meta property="article:published_time" content="2017-01-20T13:17:57-08:00">
+<meta property="article:published_time" content="2017-03-22T08:06:48-07:00">
 <meta name="twitter:card" content="summary">
 <meta name="twitter:site" content="@jekyllrb">
 <meta name="google-site-verification" content="onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY">
@@ -27,7 +27,7 @@
 {"@context": "http://schema.org",
 "@type": "BlogPosting",
 "headline": "Troubleshooting",
-"datePublished": "2017-01-20T13:17:57-08:00",
+"datePublished": "2017-03-22T08:06:48-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",
@@ -192,6 +192,10 @@
 
   
   
+  <option value="/docs/includes/">Includes</option>
+
+  
+  
   <option value="/docs/permalinks/">Permalinks</option>
 
   
@@ -602,6 +606,9 @@ The issue is caused by trying to copy a non-existing symlink.</p>
   
 
   
+  
+
+  
   
 
   
@@ -715,6 +722,10 @@ The issue is caused by trying to copy a non-existing symlink.</p>
 
   
   
+  <li class=""><a href="/docs/includes/">Includes</a></li>
+
+  
+  
   <li class=""><a href="/docs/permalinks/">Permalinks</a></li>
 
   
@@ -863,7 +874,7 @@ The issue is caused by trying to copy a non-existing symlink.</p>
 </script>
 
   
-  <!-- Gauges (http://gaug.es/) -->
+  <!-- Gauges (http://get.gaug.es/) -->
   <script>
     var _gauges = _gauges || [];
     (function() {
@@ -880,7 +891,7 @@ The issue is caused by trying to copy a non-existing symlink.</p>
 
 
 
-  <!-- Google Analytics (http://google.com/analytics) -->
+  <!-- Google Analytics (https://www.google.com/analytics) -->
   <script>
     !function(j,e,k,y,l,L){j.GoogleAnalyticsObject=y,j[y]||(j[y]=function(){
     (j[y].q=j[y].q||[]).push(arguments)}),j[y].l=+new Date,l=e.createElement(k),