Merge branch 'master' into docs-usage-help

.rubocop.yml

@@ -22,6 +22,8 @@ Metrics/BlockLength:
   Exclude:
     - test/**/*.rb
     - lib/jekyll/configuration.rb
+    - rake/*.rake
+    - jekyll.gemspec
 Metrics/ClassLength:
   Exclude:
     - !ruby/regexp /features\/.*.rb$/
@@ -32,6 +34,8 @@ Metrics/CyclomaticComplexity:
 Metrics/LineLength:
   Exclude:
     - !ruby/regexp /features\/.*.rb/
+    - Rakefile
+    - rake/*.rake
   Max: 90
   Severity: warning
 Metrics/MethodLength:
@@ -44,6 +48,14 @@ Metrics/ParameterLists:
   Max: 4
 Metrics/PerceivedComplexity:
   Max: 8
+Security/MarshalLoad:
+  Exclude:
+    - !ruby/regexp /test\/.*.rb$/
+    - lib/jekyll/regenerator.rb
+Security/YAMLLoad:
+  Exclude:
+    - !ruby/regexp /features\/.*.rb/
+    - !ruby/regexp /test\/.*.rb$/
 Style/Alias:
   Enabled: false
 Style/AlignArray:
@@ -127,5 +139,7 @@ Style/StringLiterals:
   EnforcedStyle: double_quotes
 Style/StringLiteralsInInterpolation:
   EnforcedStyle: double_quotes
+Style/TrailingCommaInLiteral:
+  EnforcedStyleForMultiline: consistent_comma
 Style/UnneededCapitalW:
   Enabled: false

Gemfile

@@ -25,7 +25,7 @@ group :test do
   gem "nokogiri"
   gem "rspec"
   gem "rspec-mocks"
-  gem "rubocop", "~> 0.44.1"
+  gem "rubocop", "~> 0.47"
   gem "test-theme", :path => File.expand_path("./test/fixtures/test-theme", File.dirname(__FILE__))
 
   gem "jruby-openssl" if RUBY_ENGINE == "jruby"
@@ -88,12 +88,12 @@ end
 
 group :site do
   if ENV["PROOF"]
-    gem "html-proofer", "~> 2.0"
+    gem "html-proofer", "~> 3.4"
   end
 
   gem "jekyll-avatar"
   gem "jekyll-mentions"
   gem "jekyll-seo-tag"
   gem "jekyll-sitemap"
-  gem "jemoji", "0.5.1"
+  gem "jemoji"
 end

History.markdown

@@ -1,5 +1,22 @@
 ## HEAD
 
+### Minor Enhancements
+
+  * Add connector param to `array_to_sentence_string` filter (#5597)
+  * Adds `group_by_exp` filter (#5513)
+  * Use the current year for the LICENSE of theme (#5712)
+  * Update License (#5713)
+  * Use Addressable instead of URI to decode (#5726)
+  * throw IncludeTagError if error occurs in included file (#5767)
+
+### Bug Fixes
+
+  * Escaped regular expressions when using `post_url`. (#5605)
+  * fix date parsing in file names to be stricter (#5609)
+  * Add a module to re-define `ENV["TZ"]` in Windows (#5612)
+  * Use each instead of map to actually return nothing (#5668)
+  * include: fix 'no implicit conversion of nil to String' (#5750)
+
 ### Site Enhancements
 
   * Remove instructions to install Jekyll 2 on Windows (#5582)
@@ -16,21 +33,10 @@
   * Add Jekyll-Post to list of plugins (#5705)
   * Add jekyll-numbered-headings (#5688)
   * Docs: move permalinks from documents into config (#5544)
-
+  * Sort gems in `docs/_config.yml` (#5746)
-### Minor Enhancements
+  * [site] Use defaults for docs and news-items (#5744)
-
+  * Improve collections docs (#5691)
-  * Add connector param to array_to_sentence_string filter (#5597)
+  * Fix #5730: add gcc and make to the list of requirements (#5731)
-  * Adds group_by_exp filter (#5513)
-  * Use the current year for the LICENSE of theme (#5712)
-  * Update License (#5713)
-  * Use Addressable instead of URI to decode (#5726)
-
-### Bug Fixes
-
-  * Escaped regular expressions when using post_url. (#5605)
-  * fix date parsing in file names to be stricter (#5609)
-  * Add a module to re-define `ENV["TZ"]` in Windows (#5612)
-  * Use each instead of map to actually return nothing (#5668)
 
 ### Development Fixes
 
@@ -41,6 +47,15 @@
   * Bump to rake 12.0 (#5670)
   * Rubocop Gemfile (#5671)
   * update Classifier-Reborn to 2.1.0 (#5711)
+  * Rubocop: fix Rakefile and gemspec (#5745)
+  * Use `assert_nil` (#5725)
+  * Sort gems in `jekyll.gemspec` (#5746)
+  * Rubocop: Require consistent comma in multiline literals (#5761)
+  * Bump rubocop (#5765)
+  * New rubocop security checks (#5768)
+  * test/helper: fix flaky plugin path test by removing calls to Dir.chdir without a block (#5779)
+  * Use latest jemoji gem (#5782)
+  * Bump htmlproofer (#5781)
 
 ### Documentation
 
@@ -58,6 +73,12 @@
   * Replace a dead link with a web-archived one (#5738)
   * Remove duplicate paragraph. (#5740)
   * Addition of a sample "typical post" (#5473)
+  * Fix a minor grammatical mistake on themes' document ### -dev (#5748)
+  * Correct comments in data_reader.rb (#5621)
+  * Add jekyll-pre-commit to plugins list (#5752)
+  * Update quickstart.md (#5758)
+  * Correct minor typo (#5764)
+  * Fix a markdown link to look properly on the web (#5769)
 
 ## 3.3.1 / 2016-11-14
 

Rakefile

@@ -1,13 +1,13 @@
-require 'rubygems'
+require "rubygems"
-require 'rake'
+require "rake"
-require 'rdoc'
+require "rdoc"
-require 'date'
+require "date"
-require 'yaml'
+require "yaml"
 
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), *%w[lib]))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "lib"))
-require 'jekyll/version'
+require "jekyll/version"
 
-Dir.glob('rake/**.rake').each { |f| import f }
+Dir.glob("rake/**.rake").each { |f| import f }
 
 #############################################################################
 #
@@ -36,21 +36,21 @@ def gemspec_file
 end
 
 def gem_file
-  "#{name}-#{Gem::Version.new(version).to_s}.gem"
+  "#{name}-#{Gem::Version.new(version)}.gem"
 end
 
 def normalize_bullets(markdown)
-  markdown.gsub(/\n\s{2}\*{1}/, "\n-")
+  markdown.gsub(%r!\n\s{2}\*{1}!, "\n-")
 end
 
 def linkify_prs(markdown)
-  markdown.gsub(/#(\d+)/) do |word|
+  markdown.gsub(%r!#(\d+)!) do |word|
     "[#{word}]({{ site.repository }}/issues/#{word.delete("#")})"
   end
 end
 
 def linkify_users(markdown)
-  markdown.gsub(/(@\w+)/) do |username|
+  markdown.gsub(%r!(@\w+)!) do |username|
     "[#{username}](https://github.com/#{username.delete("@")})"
   end
 end
@@ -60,13 +60,13 @@ def linkify(markdown)
 end
 
 def liquid_escape(markdown)
-  markdown.gsub(/(`{[{%].+[}%]}`)/, "{% raw %}\\1{% endraw %}")
+  markdown.gsub(%r!(`{[{%].+[}%]}`)!, "{% raw %}\\1{% endraw %}")
 end
 
 def custom_release_header_anchors(markdown)
-  header_regexp = /^(\d{1,2})\.(\d{1,2})\.(\d{1,2}) \/ \d{4}-\d{2}-\d{2}/
+  header_regexp = %r!^(\d{1,2})\.(\d{1,2})\.(\d{1,2}) \/ \d{4}-\d{2}-\d{2}!
-  section_regexp = /^### \w+ \w+$/
+  section_regexp = %r!^### \w+ \w+$!
-  markdown.split(/^##\s/).map do |release_notes|
+  markdown.split(%r!^##\s!).map do |release_notes|
     _, major, minor, patch = *release_notes.match(header_regexp)
     release_notes
       .gsub(header_regexp, "\\0\n{: #v\\1-\\2-\\3}")
@@ -75,11 +75,11 @@ def custom_release_header_anchors(markdown)
 end
 
 def sluffigy(header)
-  header.gsub(/#/, '').strip.downcase.gsub(/\s+/, '-')
+  header.delete("#").strip.downcase.gsub(%r!\s+!, "-")
 end
 
 def remove_head_from_history(markdown)
-  index = markdown =~ /^##\s+\d+\.\d+\.\d+/
+  index = markdown =~ %r!^##\s+\d+\.\d+\.\d+!
   markdown[index..-1]
 end
 
@@ -88,20 +88,23 @@ def converted_history(markdown)
     custom_release_header_anchors(
       liquid_escape(
         linkify(
-          normalize_bullets(markdown)))))
+          normalize_bullets(markdown)
+        )
+      )
+    )
+  )
 end
 
 def siteify_file(file, overrides_front_matter = {})
-  abort "You seem to have misplaced your #{file} file. I can haz?" unless File.exists?(file)
+  abort "You seem to have misplaced your #{file} file. I can haz?" unless File.exist?(file)
   title = begin
-            File.read(file).match(/\A# (.*)$/)[1]
+            File.read(file).match(%r!\A# (.*)$!)[1]
           rescue
             File.basename(file, ".*").downcase.capitalize
           end
   slug  = File.basename(file, ".markdown").downcase
   front_matter = {
     "title"     => title,
-    "layout"    => "docs",
     "permalink" => "/docs/#{slug}/",
     "note"      => "This file is autogenerated. Edit /#{file} instead."
   }.merge(overrides_front_matter)
@@ -115,7 +118,7 @@ def content_for(file)
   when "History.markdown"
     converted_history(contents)
   else
-    contents.gsub(/\A# .*\n\n?/, "")
+    contents.gsub(%r!\A# .*\n\n?!, "")
   end
 end
 
@@ -128,23 +131,23 @@ end
 multitask :default => [:test, :features]
 
 task :spec => :test
-require 'rake/testtask'
+require "rake/testtask"
 Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
+  test.libs << "lib" << "test"
-  test.pattern = 'test/**/test_*.rb'
+  test.pattern = "test/**/test_*.rb"
   test.verbose = true
 end
 
-require 'rdoc/task'
+require "rdoc/task"
 Rake::RDocTask.new do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
+  rdoc.rdoc_dir = "rdoc"
   rdoc.title = "#{name} #{version}"
-  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include("README*")
-  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.rdoc_files.include("lib/**/*.rb")
 end
 
 begin
-  require 'cucumber/rake/task'
+  require "cucumber/rake/task"
   Cucumber::Rake::Task.new(:features) do |t|
     t.profile = "travis"
   end
@@ -152,9 +155,9 @@ begin
     t.profile = "html_report"
   end
 rescue LoadError
-  desc 'Cucumber rake task not available'
+  desc "Cucumber rake task not available"
   task :features do
-    abort 'Cucumber rake task is not available. Be sure to install cucumber as a gem or plugin'
+    abort "Cucumber rake task is not available. Be sure to install cucumber as a gem or plugin"
   end
 end
 

docs/_config.yml

@@ -10,6 +10,21 @@ help_url: https://github.com/jekyll/jekyll-help
 
 timezone: America/Los_Angeles
 
+defaults:
+  -
+    scope:
+      path: "_docs"
+      type: "docs"
+    values:
+      layout: "docs"
+  -
+    scope:
+      path: "_posts"
+      type: "posts"
+    values:
+      layout: "news_item"
+
+
 collections:
   docs:
     permalink: /:collection/:path/
@@ -28,14 +43,14 @@ twitter:
 logo: /img/logo-2x.png
 
 gems:
-  - jekyll-feed
-  - jekyll-redirect-from
-  - jemoji
-  - jekyll-sitemap
-  - jekyll-seo-tag
   - jekyll-avatar
+  - jekyll-feed
   - jekyll-mentions
+  - jekyll-redirect-from
+  - jekyll-seo-tag
+  - jekyll-sitemap
+  - jemoji
 
 exclude:
-  - README.md
   - .gitignore
+  - README.md

docs/_docs/assets.md

@@ -1,5 +1,4 @@
 ---
-layout: docs
 title: Assets
 permalink: /docs/assets/
 ---

docs/_docs/collections.md

@@ -1,5 +1,4 @@
 ---
-layout: docs
 title: Collections
 permalink: /docs/collections/
 ---
@@ -12,7 +11,13 @@ namespace.
 
 ## Using Collections
 
-### Step 1: Tell Jekyll to read in your collection
+To start using collections, follow these 3 steps:
+
+* [Step 1: Tell Jekyll to read in your collection](#step1)
+* [Step 2: Add your content](#step2)
+* [Step 3: Optionally render your collection's documents into independent files](#step3)
+
+### Step 1: Tell Jekyll to read in your collection {#step1}
 
 Add the following to your site's `_config.yml` file, replacing `my_collection`
 with the name of your collection:
@@ -41,12 +46,12 @@ defaults:
       layout: page
 ```
 
-### Step 2: Add your content
+### Step 2: Add your content {#step2}
 
 Create a corresponding folder (e.g. `<source>/_my_collection`) and add
-documents. YAML Front Matter is read in as data if it exists, and everything
+documents. YAML front matter is processed if the front matter exists, and everything
-after it is stuck in the Document's `content` attribute. If no YAML Front
+after the front matter is pushed into the document's `content` attribute. If no YAML front
-Matter is provided, Jekyll will not generate the file in your collection.
+matter is provided, Jekyll will not generate the file in your collection.
 
 <div class="note info">
   <h5>Be sure to name your directories correctly</h5>
@@ -56,7 +61,7 @@ your <code>_config.yml</code> file, with the addition of the preceding <code>_</
   </p>
 </div>
 
-### Step 3: Optionally render your collection's documents into independent files
+### Step 3: Optionally render your collection's documents into independent files {#step3}
 
 If you'd like Jekyll to create a public-facing, rendered version of each
 document in your collection, set the `output` key to `true` in your collection
@@ -73,19 +78,6 @@ For example, if you have `_my_collection/some_subdir/some_doc.md`,
 it will be rendered using Liquid and the Markdown converter of your
 choice and written out to `<dest>/my_collection/some_subdir/some_doc.html`.
 
-As for posts with [Permalinks](../permalinks/), the document
-URL can be customized by setting `permalink` metadata for the collection:
-
-```yaml
-collections:
-  my_collection:
-    output: true
-    permalink: /awesome/:path/
-```
-
-For example, if you have `_my_collection/some_subdir/some_doc.md`, it will be
-written out to `<dest>/awesome/some_subdir/some_doc/index.html`.
-
 <div class="note info">
   <h5>Don't forget to add YAML for processing</h5>
   <p>
@@ -95,6 +87,21 @@ written out to `<dest>/awesome/some_subdir/some_doc/index.html`.
   </p>
 </div>
 
+## Configuring permalinks for collections {#permalinks}
+
+You can customize the [Permalinks](../permalinks/) for your collection's documents by setting `permalink` property in the collection's configuration as follows:
+
+```yaml
+collections:
+  my_collection:
+    output: true
+    permalink: /awesome/:path/:title.:output_ext
+```
+
+In this example, the collection documents will the have the URL of `awesome` followed by the path to the document and its file extension.
+
+Collections have the following template variables available for permalinks:
+
 <div class="mobile-side-scroller">
 <table>
   <thead>
@@ -149,15 +156,92 @@ written out to `<dest>/awesome/some_subdir/some_doc/index.html`.
 </table>
 </div>
 
+## Permalink examples for collections
+
+Depending on how you declare the permalinks in your configuration file, the permalinks and paths get written differently in the `_site` folder. A few examples will help clarify the options.
+
+Let's say your collection is called `apidocs` with `doc1.md` in your collection. `doc1.md` is grouped inside a folder called `mydocs`. Your project's source directory for the collection looks this:
+
+```
+├── \_apidocs
+│   └── mydocs
+│       └── doc1.md
+```
+
+Based on this scenario, here are a few permalink options.
+
+**Permalink configuration 1**: [Nothing configured] <br/>
+**Output**:
+
+```
+├── apidocs
+│   └── mydocs
+│       └── doc1.html
+```
+
+**Permalink configuration 2**: `/:collection/:path/:title:output_ext`  <br/>
+**Output**:
+
+```
+├── apidocs
+│   └── mydocs
+│       └── doc1.html
+```
+
+**Permalink configuration 3**: No collection permalinks configured, but `pretty` configured for pages/posts. <br/>
+**Output**:
+
+```
+├── apidocs
+│   └── mydocs
+│       └── doc1
+│           └── index.html
+```
+
+**Permalink configuration 4**: `/awesome/:path/:title.html`   <br/>
+**Output**:
+
+```
+├── awesome
+│   └── mydocs
+│       └── doc1.html
+```
+
+**Permalink configuration 5**: `/awesome/:path/:title/`  <br/>
+**Output**:
+
+```
+├── awesome
+│   └── mydocs
+│       └── doc1
+│           └── index.html
+```
+
+**Permalink configuration 6**: `/awesome/:title.html` <br/>
+**Output**:  
+
+```
+├── awesome
+│   └── doc1.html
+```
+
+**Permalink configuration 7**: `:title.html`
+**Output**:
+
+```
+├── doc1.html
+```
+
 ## Liquid Attributes
 
 ### Collections
 
-Each collection is accessible via the `site` Liquid variable. For example, if
+Each collection is accessible as a field on the `site` variable. For example, if
 you want to access the `albums` collection found in `_albums`, you'd use
-`site.albums`. Each collection is itself an array of documents
+`site.albums`. 
-(e.g. `site.albums` is an array of documents, much like `site.pages` and
+
-`site.posts`). See below for how to access attributes of those documents.
+Each collection is itself an array of documents (e.g., `site.albums` is an array of documents, much like `site.pages` and
+`site.posts`). See the table below for how to access attributes of those documents.
 
 The collections are also available under `site.collections`, with the metadata
 you specified in your `_config.yml` (if present) and the following information:
@@ -335,7 +419,7 @@ file, each document has the following attributes:
 
 Attributes from the YAML front matter can be accessed as data anywhere in the
 site. Using the above example for configuring a collection as `site.albums`,
-one might have front matter in an individual file structured as follows (which
+you might have front matter in an individual file structured as follows (which
 must use a supported markup format, and cannot be saved with a `.yaml`
 extension):
 

docs/_docs/conduct.md

@@ -1,6 +1,5 @@
 ---
 title: Code of Conduct
-layout: docs
 permalink: "/docs/conduct/"
 note: This file is autogenerated. Edit /CONDUCT.markdown instead.
 redirect_from: "/conduct/index.html"

docs/_docs/configuration.md

@@ -1,5 +1,4 @@
 ---
-layout: docs
 title: Configuration
 permalink: /docs/configuration/
 ---

docs/_docs/continuous-integration.md

@@ -1,5 +1,4 @@
 ---
-layout: docs
 title: Continuous Integration
 permalink: /docs/continuous-integration/
 ---

docs/_docs/contributing.md

@@ -1,6 +1,5 @@
 ---
 title: Contributing
-layout: docs
 permalink: "/docs/contributing/"
 note: This file is autogenerated. Edit /.github/CONTRIBUTING.markdown instead.
 ---

docs/_docs/datafiles.md

@@ -1,5 +1,4 @@
 ---
-layout: docs
 title: Data Files
 permalink: /docs/datafiles/
 ---

docs/_docs/deployment-methods.md

@@ -1,5 +1,4 @@
 ---
-layout: docs
 title: Deployment methods
 permalink: /docs/deployment-methods/
 ---

docs/_docs/drafts.md

@@ -1,5 +1,4 @@
 ---
-layout: docs
 title: Working with drafts
 permalink: /docs/drafts/
 ---

docs/_docs/extras.md

@@ -1,5 +1,4 @@
 ---
-layout: docs
 title: Extras
 permalink: /docs/extras/
 ---

docs/_docs/frontmatter.md

@@ -1,5 +1,4 @@
 ---
-layout: docs
 title: Front Matter
 permalink: /docs/frontmatter/
 ---

docs/_docs/github-pages.md

@@ -1,5 +1,4 @@
 ---
-layout: docs
 title: GitHub Pages
 permalink: /docs/github-pages/
 ---
@@ -139,7 +138,7 @@ looking at right now is contained in the [docs
 folder]({{ site.repository }}/tree/master/docs) of the same repository.
 
 Please refer to GitHub official documentation on
-[user, organization and projets pages](https://help.github.com/articles/user-organization-and-project-pages/)
+[user, organization and project pages](https://help.github.com/articles/user-organization-and-project-pages/)
 to see more detailed examples.
 
 <div class="note warning">

docs/_docs/history.md

@@ -1,6 +1,5 @@
 ---
 title: History
-layout: docs
 permalink: "/docs/history/"
 note: This file is autogenerated. Edit /History.markdown instead.
 ---

docs/_docs/includes.md

@@ -1,5 +1,4 @@
 ---
-layout: docs
 title: Includes
 permalink: /docs/includes/
 ---

docs/_docs/index.md

@@ -1,5 +1,4 @@
 ---
-layout: docs
 title: Welcome
 permalink: /docs/home/
 redirect_from: /docs/index.html

docs/_docs/installation.md

@@ -1,5 +1,4 @@
 ---
-layout: docs
 title: Installation
 permalink: /docs/installation/
 ---
@@ -21,6 +20,7 @@ requirements you’ll need to make sure your system has before you start.
 - [NodeJS](https://nodejs.org/), or another JavaScript runtime (Jekyll 2 and
 earlier, for CoffeeScript support).
 - [Python 2.7](https://www.python.org/downloads/) (for Jekyll 2 and earlier)
+- [GCC](https://gcc.gnu.org/install/) and [Make](https://www.gnu.org/software/make/) (in case your system doesn't have them installed, which you can check by running `gcc -v` and `make -v` in your system's command line interface)
 
 <div class="note info">
   <h5>Running Jekyll on Windows</h5>

docs/_docs/maintaining/affinity-team-captain.md

@@ -1,6 +1,5 @@
 ---
 title: Affinity Team Captains
-layout: docs
 ---
 
 **This guide is for affinity team captains.** These special people are **team maintainers** of one of our [affinity teams][] and help triage and evaluate the issues and contributions of others. You may find what is written here interesting, but it’s definitely not for everyone.

docs/_docs/maintaining/avoiding-burnout.md

@@ -1,6 +1,5 @@
 ---
 title: "Avoiding Burnout"
-layout: docs
 ---
 
 **This guide is for maintainers.** These special people have **write access** to one or more of Jekyll's repositories and help merge the contributions of others. You may find what is written here interesting, but it’s definitely not for everyone.

docs/_docs/maintaining/becoming-a-maintainer.md

@@ -1,6 +1,5 @@
 ---
 title: "Becoming a Maintainer"
-layout: docs
 ---
 
 **This guide is for contributors.** These special people have contributed to one or more of Jekyll's repositories, but do not yet have write access to any. You may find what is written here interesting, but it’s definitely not for everyone.

docs/_docs/maintaining/index.md

@@ -1,5 +1,4 @@
 ---
-layout: docs
 title: Maintaining Jekyll
 permalink: /docs/maintaining/
 ---

docs/_docs/maintaining/merging-a-pull-request.md

@@ -1,6 +1,5 @@
 ---
 title: "Merging a Pull Request"
-layout: docs
 ---
 
 **This guide is for maintainers.** These special people have **write access** to one or more of Jekyll's repositories and help merge the contributions of others. You may find what is written here interesting, but it’s definitely not for everyone.

docs/_docs/maintaining/reviewing-a-pull-request.md

@@ -1,6 +1,5 @@
 ---
 title: "Reviewing a Pull Request"
-layout: docs
 ---
 
 **This guide is for maintainers.** These special people have **write access** to one or more of Jekyll's repositories and help merge the contributions of others. You may find what is written here interesting, but it’s definitely not for everyone.

docs/_docs/maintaining/special-labels.md

@@ -1,6 +1,5 @@
 ---
 title: "Special Labels"
-layout: docs
 ---
 
 **This guide is for maintainers.** These special people have **write access** to one or more of Jekyll's repositories and help merge the contributions of others. You may find what is written here interesting, but it’s definitely not for everyone.

docs/_docs/maintaining/triaging-an-issue.md

@@ -1,6 +1,5 @@
 ---
 title: "Triaging an Issue"
-layout: docs
 ---
 
 **This guide is for maintainers.** These special people have **write access** to one or more of Jekyll's repositories and help merge the contributions of others. You may find what is written here interesting, but it’s definitely not for everyone.

docs/_docs/migrations.md

@@ -1,5 +1,4 @@
 ---
-layout: docs
 title: Blog migrations
 permalink: /docs/migrations/
 ---

docs/_docs/pages.md

@@ -1,5 +1,4 @@
 ---
-layout: docs
 title: Creating pages
 permalink: /docs/pages/
 ---

docs/_docs/pagination.md

@@ -1,5 +1,4 @@
 ---
-layout: docs
 title: Pagination
 permalink: /docs/pagination/
 ---

docs/_docs/permalinks.md

@@ -1,5 +1,4 @@
 ---
-layout: docs
 title: Permalinks
 permalink: /docs/permalinks/
 ---

docs/_docs/plugins.md

@@ -1,5 +1,4 @@
 ---
-layout: docs
 title: Plugins
 permalink: /docs/plugins/
 ---
@@ -919,6 +918,7 @@ LESS.js files during generation.
 - [jekyll-migrate-permalink](https://github.com/mpchadwick/jekyll-migrate-permalink): Adds a `migrate-permalink` sub-command to help deal with side effects of changing your permalink.
 - [Jekyll-Post](https://github.com/robcrocombe/jekyll-post): A CLI tool to easily draft, edit, and publish Jekyll posts.
 - [jekyll-numbered-headings](https://github.com/muratayusuke/jekyll-numbered-headings): Adds ordered number to headings.
+- [jekyll-pre-commit](https://github.com/mpchadwick/jekyll-pre-commit): A framework for running checks against your posts using a git pre-commit hook before you publish them.
 
 #### Editors
 

docs/_docs/posts.md

@@ -1,5 +1,4 @@
 ---
-layout: docs
 title: Writing posts
 permalink: /docs/posts/
 ---

docs/_docs/quickstart.md

@@ -1,11 +1,10 @@
 ---
-layout: docs
 title: Quick-start guide
 permalink: /docs/quickstart/
 ---
 
-If you already have [Ruby](https://www.ruby-lang.org/en/downloads/) and [RubyGems](https://rubygems.org/pages/download) installed (see Jekyll's [requirements](/docs/
+If you already have a full [Ruby](https://www.ruby-lang.org/en/downloads/) development environment with all headers and [RubyGems](https://rubygems.org/pages/download) installed (see Jekyll's [requirements](/docs/installation/#requirements/)), you can create a new Jekyll site by doing the following:
-/#requirements/)), you can create a new Jekyll site by doing the following:
+
 
 ```sh
 # Install Jekyll and Bundler gems through RubyGems
@@ -23,6 +22,8 @@ If you already have [Ruby](https://www.ruby-lang.org/en/downloads/) and [RubyGem
 # Now browse to http://localhost:4000
 ```
 
+If you encounter any unexpected errors during the above, please refer to the already-mentioned [requirements](/docs/installation/#requirements/) page, as you might be missing development headers or other prerequisites.
+
 ## About Bundler
 
 `gem install jekyll bundler` installs the [jekyll](https://rubygems.org/gems/jekyll/) and [bundler](https://rubygems.org/gems/bundler) gems through [RubyGems](https://rubygems.org/). You need only to install the gems one time — not every time you create a new Jekyll project. Here are some additional details:

docs/_docs/resources.md

@@ -1,5 +1,4 @@
 ---
-layout: docs
 title: Resources
 permalink: /docs/resources/
 ---

docs/_docs/sites.md

@@ -1,5 +1,4 @@
 ---
-layout: docs
 title: Sites using Jekyll
 permalink: /docs/sites/
 ---

docs/_docs/static_files.md

@@ -1,5 +1,4 @@
 ---
-layout: docs
 title: Static Files
 permalink: /docs/static-files/
 ---

docs/_docs/structure.md

@@ -1,5 +1,4 @@
 ---
-layout: docs
 title: Directory structure
 permalink: /docs/structure/
 ---

docs/_docs/templates.md

@@ -1,5 +1,4 @@
 ---
-layout: docs
 title: Templates
 permalink: /docs/templates/
 ---

docs/_docs/themes.md

@@ -1,5 +1,4 @@
 ---
-layout: docs
 title: Themes
 permalink: /docs/themes/
 ---
@@ -67,7 +66,7 @@ Add your template files in the corresponding folders, complete the `.gemspec` an
 
 Theme layouts and includes work just like they work in any Jekyll site. Place layouts in your theme's `/_layouts` folder, and place includes in your themes `/_includes` folder.
 
-For example, if your theme has a `/_layouts/page.html` file, and a page has `layout: page` in its YAML front matter, Jekyll will first look to the site's `_layouts` folder for a the `page` layout, and if none exists, will use your theme's `page` layout.
+For example, if your theme has a `/_layouts/page.html` file, and a page has `layout: page` in its YAML front matter, Jekyll will first look to the site's `_layouts` folder for the `page` layout, and if none exists, will use your theme's `page` layout.
 
 ### Assets
 

docs/_docs/troubleshooting.md

@@ -1,5 +1,4 @@
 ---
-layout: docs
 title: Troubleshooting
 permalink: /docs/troubleshooting/
 ---

docs/_docs/upgrading/0-to-2.md

@@ -1,5 +1,4 @@
 ---
-layout: docs
 title: Upgrading from 0.x to 2.x
 permalink: /docs/upgrading/0-to-2/
 ---

docs/_docs/upgrading/2-to-3.md

@@ -1,5 +1,4 @@
 ---
-layout: docs
 title: Upgrading from 2.x to 3.x
 permalink: /docs/upgrading/2-to-3/
 ---

docs/_docs/usage.md

@@ -1,5 +1,4 @@
 ---
-layout: docs
 title: Basic Usage
 permalink: /docs/usage/
 ---

docs/_docs/variables.md

@@ -1,5 +1,4 @@
 ---
-layout: docs
 title: Variables
 permalink: /docs/variables/
 ---

docs/_docs/windows.md

@@ -1,5 +1,4 @@
 ---
-layout: docs
 title: Jekyll on Windows
 permalink: /docs/windows/
 ---
@@ -16,7 +15,8 @@ A quick way to install Jekyll is to follow the [installation instructions by Dav
  2. Install Ruby via Chocolatey: `choco install ruby -y`
  3. Reopen a command prompt and install Jekyll: `gem install jekyll`
 
-Updates in the infrastructure of Ruby may cause SSL errors when attempting to use `gem install` with versions of the RubyGems package older than 2.6. (The RubyGems package installed via the Chocolatey tool is version 2.3) If you have installed an older version, you can update the RubyGems package using the directions [here.][ssl-certificate-update]
+Updates in the infrastructure of Ruby may cause SSL errors when attempting to use `gem install` with versions of the RubyGems package older than 2.6. (The RubyGems package installed via the Chocolatey tool is version 2.3) If you have installed an older version, you can update the RubyGems package using the directions [here][ssl-certificate-update].
+
 [ssl-certificate-update]: http://guides.rubygems.org/ssl-certificate-update/#installing-using-update-packages
 
 For a more conventional way of installing Jekyll you can follow this [complete guide to install Jekyll 3 on Windows by Sverrir Sigmundarson][windows-installjekyll3].

docs/_posts/2013-05-06-jekyll-1-0-0-released.markdown

@@ -1,5 +1,4 @@
 ---
-layout: news_item
 title: "Jekyll 1.0.0 Released"
 date: "2013-05-06 02:12:52 +0200"
 author: parkr

docs/_posts/2013-05-08-jekyll-1-0-1-released.markdown

@@ -1,5 +1,4 @@
 ---
-layout: news_item
 title: "Jekyll 1.0.1 Released"
 date: "2013-05-08 23:46:11 +0200"
 author: parkr

docs/_posts/2013-05-12-jekyll-1-0-2-released.markdown

@@ -1,5 +1,4 @@
 ---
-layout: news_item
 title: "Jekyll 1.0.2 Released"
 date: "2013-05-12 14:45:00 +0200"
 author: parkr

docs/_posts/2013-06-07-jekyll-1-0-3-released.markdown

@@ -1,5 +1,4 @@
 ---
-layout: news_item
 title: "Jekyll 1.0.3 Released"
 date: "2013-06-07 21:02:13 +0200"
 author: parkr

docs/_posts/2013-07-14-jekyll-1-1-0-released.markdown

@@ -1,5 +1,4 @@
 ---
-layout: news_item
 title: "Jekyll 1.1.0 Released"
 date: "2013-07-14 19:38:02 +0200"
 author: parkr

docs/_posts/2013-07-24-jekyll-1-1-1-released.markdown

@@ -1,5 +1,4 @@
 ---
-layout: news_item
 title: "Jekyll 1.1.1 Released"
 date: "2013-07-24 22:24:14 +0200"
 author: parkr

docs/_posts/2013-07-25-jekyll-1-0-4-released.markdown

@@ -1,5 +1,4 @@
 ---
-layout: news_item
 title: "Jekyll 1.0.4 Released"
 date: "2013-07-25 09:08:38 +0200"
 author: mattr-

docs/_posts/2013-07-25-jekyll-1-1-2-released.markdown

@@ -1,5 +1,4 @@
 ---
-layout: news_item
 title: "Jekyll 1.1.2 Released"
 date: "2013-07-25 09:08:38 +0200"
 author: parkr

docs/_posts/2013-09-06-jekyll-1-2-0-released.markdown

@@ -1,5 +1,4 @@
 ---
-layout: news_item
 title: "Jekyll 1.2.0 Released"
 date: "2013-09-06 22:02:41 -0400"
 author: parkr

docs/_posts/2013-09-14-jekyll-1-2-1-released.markdown

@@ -1,5 +1,4 @@
 ---
-layout: news_item
 title: 'Jekyll 1.2.1 Released'
 date: 2013-09-14 20:46:50 -0400
 author: parkr

docs/_posts/2013-10-28-jekyll-1-3-0-rc1-released.markdown

@@ -1,5 +1,4 @@
 ---
-layout: news_item
 title: 'Jekyll 1.3.0.rc1 Released'
 date: 2013-10-28 20:14:39 -0500
 author: mattr-

docs/_posts/2013-11-04-jekyll-1-3-0-released.markdown

@@ -1,5 +1,4 @@
 ---
-layout: news_item
 title: 'Jekyll 1.3.0 Released'
 date: 2013-11-04 21:46:02 -0600
 author: mattr-

docs/_posts/2013-11-26-jekyll-1-3-1-released.markdown

@@ -1,5 +1,4 @@
 ---
-layout: news_item
 title: 'Jekyll 1.3.1 Released'
 date: 2013-11-26 19:52:20 -0600
 author: mattr-

docs/_posts/2013-12-07-jekyll-1-4-0-released.markdown

@@ -1,5 +1,4 @@
 ---
-layout: news_item
 title: 'Jekyll 1.4.0 Released'
 date: 2013-12-07 13:55:28 -0600
 author: mattr-

docs/_posts/2013-12-09-jekyll-1-4-1-released.markdown

@@ -1,5 +1,4 @@
 ---
-layout: news_item
 title: 'Jekyll 1.4.1 Released'
 date: 2013-12-09 20:44:13 -0600
 author: mattr-

docs/_posts/2013-12-16-jekyll-1-4-2-released.markdown

@@ -1,5 +1,4 @@
 ---
-layout: news_item
 title: 'Jekyll 1.4.2 Released'
 date: 2013-12-16 19:48:13 -0500
 author: parkr

docs/_posts/2014-01-13-jekyll-1-4-3-released.markdown

@@ -1,5 +1,4 @@
 ---
-layout: news_item
 title: 'Jekyll 1.4.3 Released'
 date: 2014-01-13 17:43:32 -0800
 author: benbalter

docs/_posts/2014-03-24-jekyll-1-5-0-released.markdown

@@ -1,5 +1,4 @@
 ---
-layout: news_item
 title: 'Jekyll 1.5.0 Released'
 date: 2014-03-24 20:37:59 -0400
 author: parkr

docs/_posts/2014-03-27-jekyll-1-5-1-released.markdown

@@ -1,5 +1,4 @@
 ---
-layout: news_item
 title: 'Jekyll 1.5.1 Released'
 date: 2014-03-27 22:43:48 -0400
 author: parkr

docs/_posts/2014-05-06-jekyll-turns-2-0-0.markdown

@@ -1,5 +1,4 @@
 ---
-layout: news_item
 title: 'Jekyll turns 2.0.0'
 author: parkr
 version: 2.0.0

docs/_posts/2014-05-08-jekyll-2-0-3-released.markdown

@@ -1,5 +1,4 @@
 ---
-layout: news_item
 title: 'Jekyll 2.0.3 Released'
 date: 2014-05-08 22:43:17 -0400
 author: parkr

docs/_posts/2014-06-04-jekyll-stickers-1-dollar-stickermule.markdown

@@ -1,5 +1,4 @@
 ---
-layout: news_item
 title: 'Pick Up your $1 Jekyll Sticker'
 date: 2014-06-04 15:46:53 -0400
 author: parkr

docs/_posts/2014-06-28-jekyll-turns-21-i-mean-2-1-0.markdown

@@ -1,5 +1,4 @@
 ---
-layout: news_item
 title: 'Jekyll Turns 21! Err... I mean 2.1.0.'
 date: 2014-06-28 17:26:59 -0400
 author: parkr

docs/_posts/2014-07-01-jekyll-2-1-1-released.markdown

@@ -1,5 +1,4 @@
 ---
-layout: news_item
 title: 'Jekyll 2.1.1 Released'
 date: 2014-07-01 20:16:43 -0400
 author: parkr

docs/_posts/2014-07-29-jekyll-2-2-0-released.markdown

@@ -1,5 +1,4 @@
 ---
-layout: news_item
 title: 'Jekyll 2.2.0 Released'
 date: 2014-07-29 18:59:13 -0400
 author: parkr

docs/_posts/2014-08-10-jekyll-2-3-0-released.markdown

@@ -1,5 +1,4 @@
 ---
-layout: news_item
 title: 'Jekyll 2.3.0 Released'
 date: 2014-08-10 20:38:34 -0400
 author: parkr

docs/_posts/2014-09-09-jekyll-2-4-0-released.markdown

@@ -1,5 +1,4 @@
 ---
-layout: news_item
 title: 'A Wild Jekyll 2.4.0 Appeared!'
 date: 2014-09-09 21:10:33 -0700
 author: parkr

docs/_posts/2014-11-06-jekylls-midlife-crisis-jekyll-turns-2-5-0.markdown

@@ -1,5 +1,4 @@
 ---
-layout: news_item
 title: "Jekyll's Mid-Life Crisis (Or, Jekyll turns 2.5.0)"
 date: 2014-11-05 10:48:22 -0800
 author: parkr

docs/_posts/2014-11-08-jekyll-2-5-1-released.markdown

@@ -1,5 +1,4 @@
 ---
-layout: news_item
 title: 'Jekyll 2.5.1 Released'
 date: 2014-11-09 09:47:52 -0800
 author: parkr

docs/_posts/2014-11-12-jekyll-2-5-2-released.markdown

@@ -1,5 +1,4 @@
 ---
-layout: news_item
 title: 'Jekyll 2.5.2 Released'
 date: 2014-11-12 18:49:08 -0800
 author: parkr

docs/_posts/2014-12-17-alfredxing-welcome-to-jekyll-core.md

@@ -1,5 +1,4 @@
 ---
-layout: news_item
 title: 'Alfred Xing has joined the Jekyll core team'
 date: 2014-12-17 11:16:21 -0800
 author: parkr

docs/_posts/2014-12-22-jekyll-2-5-3-released.markdown

@@ -1,5 +1,4 @@
 ---
-layout: news_item
 title: 'Jekyll Release for the Holidays! v2.5.3 Out'
 date: 2014-12-22 09:03:30 -0500
 author: parkr

docs/_posts/2015-01-20-jekyll-meet-and-greet.markdown

@@ -1,5 +1,4 @@
 ---
-layout: news_item
 title: "Jekyll Meet & Greet at GitHub HQ"
 date: "2015-01-20 19:23:12 -0800"
 author: parkr

docs/_posts/2015-01-24-jekyll-3-0-0-beta1-released.markdown

@@ -1,5 +1,4 @@
 ---
-layout: news_item
 title: 'Jekyll 3.0.0.beta1 Released'
 date: 2015-01-24 00:42:31 -0800
 author: parkr

docs/_posts/2015-02-26-introducing-jekyll-talk.markdown

@@ -1,5 +1,4 @@
 ---
-layout: news_item
 title: 'Join the Discussion at Jekyll Talk'
 date: 2015-02-26 21:06:51 -0800
 author: alfredxing
@@ -12,4 +11,4 @@ The forum was set up by [@envygeeks](https://github.com/envygeeks) to build a co
 
 There's already been a lot of interesting topics, including a [site showcase](https://talk.jekyllrb.com/t/showcase-sites-made-using-jekyll/18) and [a poll for Jekyll 3.0 priorities](https://talk.jekyllrb.com/t/poll-installation-priorities-for-3-0/106/9).
 
-Come join the fun!
+Come join the fun!

docs/_posts/2015-10-26-jekyll-3-0-released.markdown

@@ -1,5 +1,4 @@
 ---
-layout: news_item
 title: 'Jekyll 3.0 Released'
 date: 2015-10-26 15:37:30 -0700
 author: parkr

docs/_posts/2015-11-17-jekyll-3-0-1-released.markdown

@@ -1,5 +1,4 @@
 ---
-layout: news_item
 title: 'Jekyll 3.0.1 Released'
 date: 2015-11-17 22:04:39 -0800
 author: parkr

docs/_posts/2016-01-20-jekyll-3-0-2-released.markdown

@@ -1,5 +1,4 @@
 ---
-layout: news_item
 title: 'Jekyll 3.0.2 Released'
 date: 2016-01-20 14:08:18 -0800
 author: parkr

docs/_posts/2016-01-24-jekyll-3-1-0-released.markdown

@@ -1,5 +1,4 @@
 ---
-layout: news_item
 title: 'Jekyll 3.1.0 Released'
 date: 2016-01-24 13:16:12 -0800
 author: parkr

docs/_posts/2016-01-28-jekyll-3-1-1-released.markdown

@@ -1,5 +1,4 @@
 ---
-layout: news_item
 title: 'Jekyll 3.1.1 Released'
 date: 2016-01-28 17:21:50 -0800
 author: parkr

docs/_posts/2016-02-08-jekyll-3-0-3-released.markdown

@@ -1,5 +1,4 @@
 ---
-layout: news_item
 title: 'Jekyll 3.0.3 Released'
 date: 2016-02-08 10:39:08 -0800
 author: parkr

docs/_posts/2016-02-19-jekyll-3-1-2-released.markdown

@@ -1,5 +1,4 @@
 ---
-layout: news_item
 title: 'Jekyll 3.1.2 Released!'
 date: 2016-02-19 15:24:00 -0800
 author: parkr

docs/_posts/2016-03-10-making-it-easier-to-contribute-to-jekyll.md

@@ -1,7 +1,6 @@
 ---
 title: Making it easier to contribute to Jekyll
 description: We've made it easier to contribute to Jekyll by updating our contributing documentation and introducing Jekyll Affinity Teams, teams dedicated to specific aspects of the project.
-layout: news_item
 author: benbalter
 categories: [community]
 ---

docs/_posts/2016-04-19-jekyll-3-0-4-released.markdown

@@ -1,5 +1,4 @@
 ---
-layout: news_item
 title: 'Jekyll 3.0.4 Released'
 date: 2016-04-19 10:26:12 -0700
 author: parkr

docs/_posts/2016-04-19-jekyll-3-1-3-released.markdown

@@ -1,5 +1,4 @@
 ---
-layout: news_item
 title: 'Jekyll 3.1.3 Released'
 date: 2016-04-19 10:26:16 -0700
 author: parkr
@@ -15,4 +14,3 @@ v3.1.3 is a patch release which fixes the follow two issues:
 Both of these issues have been resolved. For more information, check out [the full history](/docs/history/#v3-1-3).
 
 Happy Jekylling!
-

docs/_posts/2016-04-26-jekyll-3-0-5-released.markdown

@@ -1,5 +1,4 @@
 ---
-layout: news_item
 title: 'Jekyll 3.0.5 Released'
 date: 2016-04-26 17:40:44 -0700
 author: parkr

docs/_posts/2016-05-18-jekyll-3-1-4-released.markdown

@@ -1,5 +1,4 @@
 ---
-layout: news_item
 title: 'Jekyll 3.1.4 "Stability Sam" Released'
 date: 2016-05-18 16:50:37 -0700
 author: parkr

docs/_posts/2016-05-18-jekyll-3-1-5-released.markdown

@@ -1,5 +1,4 @@
 ---
-layout: news_item
 title: 'Jekyll 3.1.5 Released'
 date: 2016-05-18 21:35:27 -0700
 author: parkr

docs/_posts/2016-05-19-jekyll-3-1-6-released.markdown

@@ -1,5 +1,4 @@
 ---
-layout: news_item
 title: 'Jekyll 3.1.6 Released'
 date: 2016-05-19 12:48:14 -0700
 author: parkr

docs/_posts/2016-06-03-update-on-jekyll-s-google-summer-of-code-projects.markdown

@@ -1,5 +1,4 @@
 ---
-layout: news_item
 title: "Jekyll's Google Summer of Code Project: The CMS You Always Wanted"
 date: "2016-06-03 13:21:02 -0700"
 author: parkr

docs/_posts/2016-07-26-jekyll-3-2-0-released.markdown

@@ -1,5 +1,4 @@
 ---
-layout: news_item
 title: 'Jekyll turns 3.2'
 date: 2016-07-26 15:06:49 -0700
 author: parkr

docs/_posts/2016-08-02-jekyll-3-2-1-released.markdown

@@ -1,5 +1,4 @@
 ---
-layout: news_item
 title: 'Jekyll 3.2.1 Released with Fix for Windows'
 date: 2016-08-02 13:20:11 -0700
 author: parkr