From 894d2a0415a64b3a40840b5adbe11523b5eff097 Mon Sep 17 00:00:00 2001 From: Ashwin Maroli Date: Fri, 4 Nov 2016 00:50:54 +0530 Subject: [PATCH 01/90] test double slash when input = '/' --- test/test_filters.rb | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/test/test_filters.rb b/test/test_filters.rb index 9a0f87d4..380f1d23 100644 --- a/test/test_filters.rb +++ b/test/test_filters.rb @@ -368,6 +368,24 @@ class TestFilters < JekyllUnitTest assert_equal "http://example.com/base", filter.absolute_url(page_url) end + should "not append a forward slash if input is '/'" do + page_url = "/" + filter = make_filter_mock({ + "url" => "http://example.com", + "baseurl" => "/base" + }) + refute_equal "http://example.com/base//", filter.absolute_url(page_url) + end + + should "not append a forward slash if input is '/' and nil 'baseurl'" do + page_url = "/" + filter = make_filter_mock({ + "url" => "http://example.com", + "baseurl" => nil + }) + refute_equal "http://example.com//", filter.absolute_url(page_url) + end + should "normalize international URLs" do page_url = "" filter = make_filter_mock({ From 9192e66b7b9cdbeff43598c55d4a34f67a83f888 Mon Sep 17 00:00:00 2001 From: Ashwin Maroli Date: Fri, 4 Nov 2016 01:17:54 +0530 Subject: [PATCH 02/90] assert instead of refuting --- test/test_filters.rb | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/test/test_filters.rb b/test/test_filters.rb index 380f1d23..66091c28 100644 --- a/test/test_filters.rb +++ b/test/test_filters.rb @@ -374,7 +374,7 @@ class TestFilters < JekyllUnitTest "url" => "http://example.com", "baseurl" => "/base" }) - refute_equal "http://example.com/base//", filter.absolute_url(page_url) + assert_equal "http://example.com/base/", filter.absolute_url(page_url) end should "not append a forward slash if input is '/' and nil 'baseurl'" do @@ -383,7 +383,7 @@ class TestFilters < JekyllUnitTest "url" => "http://example.com", "baseurl" => nil }) - refute_equal "http://example.com//", filter.absolute_url(page_url) + assert_equal "http://example.com/", filter.absolute_url(page_url) end should "normalize international URLs" do From 47e400549a7af16c953f2f158c68ec5b1f012d3a Mon Sep 17 00:00:00 2001 From: Frank Taillandier Date: Wed, 9 Nov 2016 22:42:14 +0100 Subject: [PATCH 03/90] [docs] info about the help command usage --- docs/_docs/quickstart.md | 2 ++ docs/_docs/usage.md | 7 +++++++ 2 files changed, 9 insertions(+) diff --git a/docs/_docs/quickstart.md b/docs/_docs/quickstart.md index 969b5384..2d341cc0 100644 --- a/docs/_docs/quickstart.md +++ b/docs/_docs/quickstart.md @@ -25,4 +25,6 @@ advantage of all the awesome configuration options Jekyll makes available. If you're running into problems, ensure you have all the [requirements installed][Installation]. +When in doubt, use the help command to remind you of all available options and usage, it also works with the new, build and serve subcommands, e.g. jekyll help new or jekyll help build. + [Installation]: /docs/installation/ diff --git a/docs/_docs/usage.md b/docs/_docs/usage.md index 3d2413d4..9f91d437 100644 --- a/docs/_docs/usage.md +++ b/docs/_docs/usage.md @@ -97,5 +97,12 @@ $ jekyll build --source _source --destination _deploy For more about the possible configuration options, see the [configuration](../configuration/) page. +
+
Call for help
+

+ The help command is always here to remind you of all available options and usage, and also works with the build, serve and new subcommands, e.g jekyll help new or jekyll help build. +

+
+ If you're interested in browsing these docs on-the-go, install the `jekyll-docs` gem and run `jekyll docs` in your terminal. From ed9520cd3b4a39d45ec972b3dc4b612ef8b3500b Mon Sep 17 00:00:00 2001 From: Roger Ogden Date: Fri, 2 Dec 2016 16:58:31 -0700 Subject: [PATCH 04/90] Fixes #5498 Updated data_reader.rb comments to more accurately reflect read() and read_data_to() functionality. --- lib/jekyll/readers/data_reader.rb | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/lib/jekyll/readers/data_reader.rb b/lib/jekyll/readers/data_reader.rb index 0afbad61..da11f1da 100644 --- a/lib/jekyll/readers/data_reader.rb +++ b/lib/jekyll/readers/data_reader.rb @@ -7,20 +7,20 @@ module Jekyll @entry_filter = EntryFilter.new(site) end - # Read all the files in //_drafts and create a new Draft - # object with each one. + # Read all the files in and adds them to @content # # dir - The String relative path of the directory to read. # - # Returns nothing. + # Returns @content, a Hash of the .yaml, .yml, + # .json, and .csv files in the base directory def read(dir) base = site.in_source_dir(dir) read_data_to(base, @content) @content end - # Read and parse all yaml files under and add them to the - # variable. + # Read and parse all .yaml, .yml, .json, and .csv + # files under and add them to the variable. # # dir - The string absolute path of the directory to read. # data - The variable to which data will be added. From 7b73abcdd9a5f784198408e1ce4c3121b9394115 Mon Sep 17 00:00:00 2001 From: Roger Ogden Date: Fri, 2 Dec 2016 17:18:30 -0700 Subject: [PATCH 05/90] Deleted trailing whitespace on line 22 --- lib/jekyll/readers/data_reader.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/jekyll/readers/data_reader.rb b/lib/jekyll/readers/data_reader.rb index da11f1da..6744ae05 100644 --- a/lib/jekyll/readers/data_reader.rb +++ b/lib/jekyll/readers/data_reader.rb @@ -19,7 +19,7 @@ module Jekyll @content end - # Read and parse all .yaml, .yml, .json, and .csv + # Read and parse all .yaml, .yml, .json, and .csv # files under and add them to the variable. # # dir - The string absolute path of the directory to read. From 6e2449b482ae22b039b441959a275dcf29cbd755 Mon Sep 17 00:00:00 2001 From: Parker Moore Date: Wed, 7 Dec 2016 10:13:14 -0800 Subject: [PATCH 06/90] Write Jekyll::Utils::Exec.run for running shell commands. --- features/support/helpers.rb | 16 +++++----------- lib/jekyll/commands/new.rb | 7 +++---- lib/jekyll/utils.rb | 3 ++- lib/jekyll/utils/exec.rb | 25 +++++++++++++++++++++++++ test/helper.rb | 8 ++++---- test/test_new_command.rb | 18 +++++++++--------- 6 files changed, 48 insertions(+), 29 deletions(-) create mode 100644 lib/jekyll/utils/exec.rb diff --git a/features/support/helpers.rb b/features/support/helpers.rb index 1340808a..50afa3a8 100644 --- a/features/support/helpers.rb +++ b/features/support/helpers.rb @@ -1,6 +1,5 @@ require "fileutils" require "jekyll" -require "open3" require "time" require "safe_yaml/load" @@ -106,21 +105,16 @@ end # rubocop:disable Metrics/AbcSize def run_in_shell(*args) - i, o, e, p = Open3.popen3(*args) - out = o.read.strip - err = e.read.strip + p, output = Jekyll::Utils::Exec.run(*args) - [i, o, e].each(&:close) - - File.write(Paths.status_file, p.value.exitstatus) + File.write(Paths.status_file, p.exitstatus) File.open(Paths.output_file, "wb") do |f| f.puts "$ " << args.join(" ") - f.puts out - f.puts err - f.puts "EXIT STATUS: #{p.value.exitstatus}" + f.puts output + f.puts "EXIT STATUS: #{p.exitstatus}" end - p.value + p end # rubocop:enable Metrics/AbcSize diff --git a/lib/jekyll/commands/new.rb b/lib/jekyll/commands/new.rb index 8319bd7e..7edb5574 100644 --- a/lib/jekyll/commands/new.rb +++ b/lib/jekyll/commands/new.rb @@ -133,10 +133,9 @@ RUBY Jekyll::External.require_with_graceful_fail "bundler" Jekyll.logger.info "Running bundle install in #{path.cyan}..." Dir.chdir(path) do - if ENV["CI"] - system("bundle", "install", "--quiet") - else - system("bundle", "install") + _, output = Jekyll::Utils::Exec.run("bundle", "install", "--quiet") + output.to_s.each_line do |line| + Jekyll.logger.info(line) end end end diff --git a/lib/jekyll/utils.rb b/lib/jekyll/utils.rb index f870ea85..31d15e85 100644 --- a/lib/jekyll/utils.rb +++ b/lib/jekyll/utils.rb @@ -2,8 +2,9 @@ module Jekyll module Utils extend self - autoload :Platforms, "jekyll/utils/platforms" autoload :Ansi, "jekyll/utils/ansi" + autoload :Exec, "jekyll/utils/exec" + autoload :Platforms, "jekyll/utils/platforms" # Constants for use in #slugify SLUGIFY_MODES = %w(raw default pretty ascii).freeze diff --git a/lib/jekyll/utils/exec.rb b/lib/jekyll/utils/exec.rb new file mode 100644 index 00000000..e37685b2 --- /dev/null +++ b/lib/jekyll/utils/exec.rb @@ -0,0 +1,25 @@ +require 'open3' + +module Jekyll + module Utils + module Exec + extend self + + # Runs a program in a sub-shell. + # + # *args - a list of strings containing the program name and arguments + # + # Returns a Process::Status and a String of output in an array in + # that order. + def run(*args) + stdin, stdout, stderr, process = Open3.popen3(*args) + out = stdout.read.strip + err = stderr.read.strip + + [stdin, stdout, stderr].each(&:close) + [process.value, out + err] + end + + end + end +end diff --git a/test/helper.rb b/test/helper.rb index 0c6935a0..b919f2a3 100644 --- a/test/helper.rb +++ b/test/helper.rb @@ -159,11 +159,11 @@ class JekyllUnitTest < Minitest::Test end def capture_output - stderr = StringIO.new - Jekyll.logger = Logger.new stderr + buffer = StringIO.new + Jekyll.logger = Logger.new(buffer) yield - stderr.rewind - return stderr.string.to_s + buffer.rewind + buffer.string.to_s end alias_method :capture_stdout, :capture_output alias_method :capture_stderr, :capture_output diff --git a/test/test_new_command.rb b/test/test_new_command.rb index 982de1da..78e6ac6f 100644 --- a/test/test_new_command.rb +++ b/test/test_new_command.rb @@ -25,14 +25,14 @@ class TestNewCommand < JekyllUnitTest should "create a new directory" do refute_exist @full_path - Jekyll::Commands::New.process(@args) + capture_output { Jekyll::Commands::New.process(@args) } assert_exist @full_path end should "create a Gemfile" do gemfile = File.join(@full_path, "Gemfile") refute_exist @full_path - capture_stdout { Jekyll::Commands::New.process(@args) } + capture_output { Jekyll::Commands::New.process(@args) } assert_exist gemfile assert_match(%r!gem "jekyll", "#{Jekyll::VERSION}"!, File.read(gemfile)) assert_match(%r!gem "github-pages"!, File.read(gemfile)) @@ -54,7 +54,7 @@ class TestNewCommand < JekyllUnitTest end static_template_files << "/Gemfile" - capture_stdout { Jekyll::Commands::New.process(@args) } + capture_output { Jekyll::Commands::New.process(@args) } new_site_files = dir_contents(@full_path).reject do |f| File.extname(f) == ".markdown" @@ -76,7 +76,7 @@ class TestNewCommand < JekyllUnitTest f.gsub! "0000-00-00", stubbed_date end - capture_stdout { Jekyll::Commands::New.process(@args) } + capture_output { Jekyll::Commands::New.process(@args) } new_site_files = dir_contents(@full_path).select do |f| erb_template_files.include? f @@ -87,7 +87,7 @@ class TestNewCommand < JekyllUnitTest should "create blank project" do blank_contents = %w(/_drafts /_layouts /_posts /index.html) - capture_stdout { Jekyll::Commands::New.process(@args, "--blank") } + capture_output { Jekyll::Commands::New.process(@args, "--blank") } output = Jekyll.logger.messages.last bundle_message = "Running bundle install in #{@full_path.cyan}..." assert_same_elements blank_contents, dir_contents(@full_path) @@ -95,13 +95,13 @@ class TestNewCommand < JekyllUnitTest end should "force created folder" do - capture_stdout { Jekyll::Commands::New.process(@args) } - output = capture_stdout { Jekyll::Commands::New.process(@args, "--force") } + capture_output { Jekyll::Commands::New.process(@args) } + output = capture_output { Jekyll::Commands::New.process(@args, "--force") } assert_match(%r!New jekyll site installed in!, output) end should "skip bundle install when opted to" do - capture_stdout { Jekyll::Commands::New.process(@args, "--skip-bundle") } + capture_output { Jekyll::Commands::New.process(@args, "--skip-bundle") } output = Jekyll.logger.messages.last bundle_message = "Bundle install skipped." assert_includes output, bundle_message @@ -120,7 +120,7 @@ class TestNewCommand < JekyllUnitTest should "create a new directory" do refute_exist @site_name_with_spaces - capture_stdout { Jekyll::Commands::New.process(@multiple_args) } + capture_output { Jekyll::Commands::New.process(@multiple_args) } assert_exist @site_name_with_spaces end end From 18c2b0827ec7022687376c129eb9c95abaf841ac Mon Sep 17 00:00:00 2001 From: Parker Moore Date: Wed, 7 Dec 2016 17:53:45 -0800 Subject: [PATCH 07/90] Appease rubocop. --- features/support/helpers.rb | 2 -- lib/jekyll/utils/exec.rb | 2 +- 2 files changed, 1 insertion(+), 3 deletions(-) diff --git a/features/support/helpers.rb b/features/support/helpers.rb index 50afa3a8..87cf717c 100644 --- a/features/support/helpers.rb +++ b/features/support/helpers.rb @@ -102,8 +102,6 @@ def run_jekyll(args) end # - -# rubocop:disable Metrics/AbcSize def run_in_shell(*args) p, output = Jekyll::Utils::Exec.run(*args) diff --git a/lib/jekyll/utils/exec.rb b/lib/jekyll/utils/exec.rb index e37685b2..33403dbc 100644 --- a/lib/jekyll/utils/exec.rb +++ b/lib/jekyll/utils/exec.rb @@ -1,4 +1,4 @@ -require 'open3' +require "open3" module Jekyll module Utils From 3c139a09f10af478d3dac83b4301fa325a1537b5 Mon Sep 17 00:00:00 2001 From: Parker Moore Date: Wed, 7 Dec 2016 18:00:47 -0800 Subject: [PATCH 08/90] Care about things. --- lib/jekyll/commands/new.rb | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/lib/jekyll/commands/new.rb b/lib/jekyll/commands/new.rb index 7edb5574..1e62a8c6 100644 --- a/lib/jekyll/commands/new.rb +++ b/lib/jekyll/commands/new.rb @@ -121,22 +121,23 @@ RUBY # unless the user opts to generate a blank blog or skip 'bundle install'. def after_install(path, options = {}) - Jekyll.logger.info "New jekyll site installed in #{path.cyan}." - Jekyll.logger.info "Bundle install skipped." if options["skip-bundle"] - unless options["blank"] || options["skip-bundle"] bundle_install path end + + Jekyll.logger.info "New jekyll site installed in #{path.cyan}." + Jekyll.logger.info "Bundle install skipped." if options["skip-bundle"] end def bundle_install(path) Jekyll::External.require_with_graceful_fail "bundler" Jekyll.logger.info "Running bundle install in #{path.cyan}..." Dir.chdir(path) do - _, output = Jekyll::Utils::Exec.run("bundle", "install", "--quiet") + process, output = Jekyll::Utils::Exec.run("bundle", "install") output.to_s.each_line do |line| - Jekyll.logger.info(line) + Jekyll.logger.info("Bundler:".green, line.strip) unless line.to_s.empty? end + raise SystemExit unless process.success? end end end From f5eb869e58dba5e25fbcab52584a8f45b08b7b4d Mon Sep 17 00:00:00 2001 From: Tom Johnson Date: Sun, 25 Dec 2016 20:34:20 -0800 Subject: [PATCH 09/90] Improve collections docs See https://github.com/jekyll/jekyll/pull/5630 for more details on the update. @jekyll/documentation @DirtyF --- docs/_docs/collections.md | 128 +++++++++++++++++++++++++++++++------- 1 file changed, 106 insertions(+), 22 deletions(-) diff --git a/docs/_docs/collections.md b/docs/_docs/collections.md index 22a86e60..06f8fd75 100644 --- a/docs/_docs/collections.md +++ b/docs/_docs/collections.md @@ -7,12 +7,18 @@ permalink: /docs/collections/ Not everything is a post or a page. Maybe you want to document the various methods in your open source project, members of a team, or talks at a conference. Collections allow you to define a new type of document that behave -like Pages or Posts do normally, but also have their own unique properties and +like Pages or Posts do normally but which also have their own unique properties and 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,11 +47,11 @@ defaults: layout: page ``` -### Step 2: Add your content +### Step 2: Add your content {#step2} -Create a corresponding folder (e.g. `/_my_collection`) and add +Create a corresponding folder (for example, `/_my_collection`) and add documents. YAML Front Matter is read in as data if it exists, and everything -after it is stuck in the Document's `content` attribute. If no YAML Front +after it is available in the document's `content` attribute. If no YAML Front Matter is provided, Jekyll will not generate the file in your collection.
@@ -56,7 +62,7 @@ your _config.yml file, with the addition of the preceding _
-### 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 +79,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 `/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 `/awesome/some_subdir/some_doc/index.html`. -
Don't forget to add YAML for processing

@@ -95,6 +88,21 @@ written out to `/awesome/some_subdir/some_doc/index.html`.

+## 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: +
@@ -149,14 +157,90 @@ written out to `/awesome/some_subdir/some_doc/index.html`.
+## 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]
+**Output**: + +``` +├── apidocs +│   └── mydocs +│   └── doc1.html +``` + +**Permalink configuration 2**: `/:collection/:path/:title:output_ext`
+**Output**: + +``` +├── apidocs +│   └── mydocs +│   └── doc1.html +``` + +**Permalink configuration 3**: No collection permalinks configured, but `pretty` configured for pages/posts.
+**Output**: + +``` +├── apidocs +│   └── mydocs +│   └── doc1 +│   └── index.html +``` + +**Permalink configuration 4**: `/awesome/:path/:title.html`
+**Output**: + +``` +├── awesome +│   └── mydocs +│   └── doc1.html +``` + +**Permalink configuration 5**: `/awesome/:path/:title/`
+**Output**: + +``` +├── awesome +│   └── mydocs +│   └── doc1 +│   └── index.html +``` + +**Permalink configuration 6**: `/awesome/:title.html`
+**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 through 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 -(e.g. `site.albums` is an array of documents, much like `site.pages` and +(for example, `site.albums` is an array of documents, much like `site.pages` and `site.posts`). See below for how to access attributes of those documents. The collections are also available under `site.collections`, with the metadata @@ -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): From 9e1c61381894d320729d5a651021b91f9a2d34a3 Mon Sep 17 00:00:00 2001 From: Tom Johnson Date: Sun, 25 Dec 2016 20:37:24 -0800 Subject: [PATCH 10/90] Improve template docs See https://github.com/jekyll/jekyll/pull/5630 for more details on the update. @jekyll/documentation @DirtyF --- docs/_docs/templates.md | 173 +++++++++++++++++----------------------- 1 file changed, 71 insertions(+), 102 deletions(-) diff --git a/docs/_docs/templates.md b/docs/_docs/templates.md index 79b5fdae..31fdd457 100644 --- a/docs/_docs/templates.md +++ b/docs/_docs/templates.md @@ -421,56 +421,15 @@ The default is `default`. They are as follows (with what they filter): ### Includes -If you have small page fragments that you wish to include in multiple places on -your site, you can use the `include` tag. +If you have small page fragments that you want to include in multiple places on your site, you can use the `include` tag: ```liquid {% raw %}{% include footer.html %}{% endraw %} ``` -Jekyll expects all include files to be placed in an `_includes` directory at the -root of your source directory. This will embed the contents of -`/_includes/footer.html` into the calling file. +Jekyll expects all include files to be placed in an `_includes` directory at the root of your source directory. In the above example, this will embed the contents of `_includes/footer.html` into the calling file. -
-
ProTip™: Use variables as file name
-

- - The name of the file you wish to embed can be literal (as in the example above), - or you can use a variable, using liquid-like variable syntax as in - {% raw %}{% include {{my_variable}} %}{% endraw %}. - -

-
- -You can also pass parameters to an include. Omit the quotation marks to send a variable's value. Liquid curly brackets should not be used here: - -```liquid -{% raw %}{% include footer.html param="value" variable-param=page.variable %}{% endraw %} -``` - -These parameters are available via Liquid in the include: - -```liquid -{% raw %}{{ include.param }}{% endraw %} -``` - -#### Including files relative to another file - -You can also choose to include file fragments relative to the current file: - -```liquid -{% raw %}{% include_relative somedir/footer.html %}{% endraw %} -``` - -You won't need to place your included content within the `_includes` directory. Instead, -the inclusion is specifically relative to the file where the tag is being used. For example, -if `_posts/2014-09-03-my-file.markdown` uses the `include_relative` tag, the included file -must be within the `_posts` directory, or one of its subdirectories. You cannot include -files in other locations. - -All the other capabilities of the `include` tag are available to the `include_relative` tag, -such as using variables. +For more advanced information on using includes, see [Includes](../includes). ### Code snippet highlighting @@ -530,64 +489,6 @@ site. If you use `linenos`, you might want to include an additional CSS class definition for the `.lineno` class in `syntax.css` to distinguish the line numbers from the highlighted code. -### Link - -If you want to include a link to a collection's document, a post, a page -or a file the `link` tag will generate the correct permalink URL for the path -you specify. - -You must include the file extension when using the `link` tag. - -```liquid -{% raw %} -{{ site.baseurl }}{% link _collection/name-of-document.md %} -{{ site.baseurl }}{% link _posts/2016-07-26-name-of-post.md %} -{{ site.baseurl }}{% link news/index.html %} -{{ site.baseurl }}{% link /assets/files/doc.pdf %} -{% endraw %} -``` - -You can also use this tag to create a link in Markdown as follows: - -```liquid -{% raw %} -[Link to a document]({{ site.baseurl }}{% link _collection/name-of-document.md %}) -[Link to a post]({{ site.baseurl }}{% link _posts/2016-07-26-name-of-post.md %}) -[Link to a page]({{ site.baseurl }}{% link news/index.html %}) -[Link to a file]({{ site.baseurl }}{% link /assets/files/doc.pdf %}) -{% endraw %} -``` - -### Post URL - -If you would like to include a link to a post on your site, the `post_url` tag -will generate the correct permalink URL for the post you specify. - -```liquid -{% raw %} -{{ site.baseurl }}{% post_url 2010-07-21-name-of-post %} -{% endraw %} -``` - -If you organize your posts in subdirectories, you need to include subdirectory -path to the post: - -```liquid -{% raw %} -{{ site.baseurl }}{% post_url /subdir/2010-07-21-name-of-post %} -{% endraw %} -``` - -There is no need to include the file extension when using the `post_url` tag. - -You can also use this tag to create a link to a post in Markdown as follows: - -```liquid -{% raw %} -[Name of Link]({{ site.baseurl }}{% post_url 2010-07-21-name-of-post %}) -{% endraw %} -``` - ### Gist Use the `gist` tag to easily embed a GitHub Gist onto your site. This works @@ -609,3 +510,71 @@ You may also optionally specify the filename in the gist to display: To use the `gist` tag, you'll need to add the [jekyll-gist](https://github.com/jekyll/jekyll-gist) gem to your project. + +## Links + +### Linking to pages {#link} + +To link to a post, a page, collection item, or file, the `link` tag will generate the correct permalink URL for the path you specify. For example, if you use the `link` tag to link to `mypage.html`, even if you change your permalink style to include the file extension or omit it, the URL formed by the `link` tag will always be valid. + +You must include the file's original extension when using the `link` tag. Here are some examples: + +```liquid +{% raw %} +{{ site.baseurl }}{% link _collection/name-of-document.md %} +{{ site.baseurl }}{% link _posts/2016-07-26-name-of-post.md %} +{{ site.baseurl }}{% link news/index.html %} +{{ site.baseurl }}{% link /assets/files/doc.pdf %} +{% endraw %} +``` + +You can also use the `link` tag to create a link in Markdown as follows: + +```liquid +{% raw %} +[Link to a document]({{ site.baseurl }}{% link _collection/name-of-document.md %}) +[Link to a post]({{ site.baseurl }}{% link _posts/2016-07-26-name-of-post.md %}) +[Link to a page]({{ site.baseurl }}{% link news/index.html %}) +[Link to a file]({{ site.baseurl }}{% link /assets/files/doc.pdf %}) +{% endraw %} +``` + +Including `{% raw %}{{site.baseurl}}{% endraw %}` is optional — it depends on whether you want the link to be absolute or root-relative. + +The path to the post, page, or collection is defined as the path relative to the root directory (where your config file is) to the file, not the path from your existing page to the other page. + +For example, suppose you're creating a link `page_a.md` (stored in `pages/folder1/folder2`) to `page_b.md` (stored in `pages/folder1`). Your path in the link would not be `../page_b.html`. Instead, it would be `/pages/folder1/page_b.md`. + +If you're unsure of the path, add `{% raw %}{{page.path}}{% endraw %}` to the page and it will display the path. + +One major benefit of using the `link` tag is link validation. If the link doesn't exist, Jekyll won't build your site. This is a good thing, as it will alert you to a broken link so you can fix it (rather than allowing you to build and deploy a site with broken links). + +Note you cannot add filters to `link` tags. For example, you cannot append a string using Liquid filters, such as `{% raw %}{% link mypage.html | append: "#section1" %} {% endraw %}`. To link to sections on a page, you will need to use regular HTML or Markdown linking techniques. + +### Linking to posts + +If you want like to include a link to a post on your site, the `post_url` tag will generate the correct permalink URL for the post you specify. + +```liquid +{% raw %} +{{ site.baseurl }}{% post_url 2010-07-21-name-of-post %} +{% endraw %} +``` + +If you organize your posts in subdirectories, you need to include subdirectory path to the post: + +```liquid +{% raw %} +{{ site.baseurl }}{% post_url /subdir/2010-07-21-name-of-post %} +{% endraw %} +``` + +There is no need to include the file extension when using the `post_url` tag. + +You can also use this tag to create a link to a post in Markdown as follows: + +```liquid +{% raw %} +[Name of Link]({{ site.baseurl }}{% post_url 2010-07-21-name-of-post %}) +{% endraw %} +``` From b37b433b60a5bce9470b4415e6c62c45fca7fb07 Mon Sep 17 00:00:00 2001 From: Tom Johnson Date: Mon, 26 Dec 2016 18:48:42 -0800 Subject: [PATCH 11/90] made requested updates I made the requested updates. Mostly just small formatting improvements. --- docs/_docs/templates.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/_docs/templates.md b/docs/_docs/templates.md index 31fdd457..b6c1ef6f 100644 --- a/docs/_docs/templates.md +++ b/docs/_docs/templates.md @@ -421,13 +421,13 @@ The default is `default`. They are as follows (with what they filter): ### Includes -If you have small page fragments that you want to include in multiple places on your site, you can use the `include` tag: +If you have small page snippets that you want to include in multiple places on your site, save the snippets as *include files* and insert them where required, by using the `include` tag: ```liquid {% raw %}{% include footer.html %}{% endraw %} ``` -Jekyll expects all include files to be placed in an `_includes` directory at the root of your source directory. In the above example, this will embed the contents of `_includes/footer.html` into the calling file. +Jekyll expects all **include files** to be placed in an `_includes` directory at the root of your source directory. In the above example, this will embed the contents of `_includes/footer.html` into the calling file. For more advanced information on using includes, see [Includes](../includes). @@ -539,7 +539,7 @@ You can also use the `link` tag to create a link in Markdown as follows: {% endraw %} ``` -Including `{% raw %}{{site.baseurl}}{% endraw %}` is optional — it depends on whether you want the link to be absolute or root-relative. +(Including `{% raw %}{{site.baseurl}}{% endraw %}` is optional — it depends on whether you want to preface the page URL with the `baseurl` value.) The path to the post, page, or collection is defined as the path relative to the root directory (where your config file is) to the file, not the path from your existing page to the other page. From 6c5f6ce164c7535aa23e4351c37f151119786283 Mon Sep 17 00:00:00 2001 From: Tom Johnson Date: Mon, 26 Dec 2016 19:48:38 -0800 Subject: [PATCH 12/90] Made requested updates on this topic Made minor grammar updates --- docs/_docs/collections.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/_docs/collections.md b/docs/_docs/collections.md index 06f8fd75..ee0747be 100644 --- a/docs/_docs/collections.md +++ b/docs/_docs/collections.md @@ -7,7 +7,7 @@ permalink: /docs/collections/ Not everything is a post or a page. Maybe you want to document the various methods in your open source project, members of a team, or talks at a conference. Collections allow you to define a new type of document that behave -like Pages or Posts do normally but which also have their own unique properties and +like Pages or Posts do normally, but also have their own unique properties and namespace. ## Using Collections @@ -51,7 +51,7 @@ defaults: Create a corresponding folder (for example, `/_my_collection`) and add documents. YAML Front Matter is read in as data if it exists, and everything -after it is available in the document's `content` attribute. If no YAML Front +after it is accessible via the document's `content` attribute. If no YAML Front Matter is provided, Jekyll will not generate the file in your collection.
From 2c8b826460e2c4b6cc4c0b9a3ef556c9e358622d Mon Sep 17 00:00:00 2001 From: Tom Johnson Date: Wed, 28 Dec 2016 23:00:06 -0800 Subject: [PATCH 13/90] made requested change **includes** --> *includes* --- docs/_docs/templates.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/_docs/templates.md b/docs/_docs/templates.md index b6c1ef6f..32050813 100644 --- a/docs/_docs/templates.md +++ b/docs/_docs/templates.md @@ -427,7 +427,7 @@ If you have small page snippets that you want to include in multiple places on y {% raw %}{% include footer.html %}{% endraw %} ``` -Jekyll expects all **include files** to be placed in an `_includes` directory at the root of your source directory. In the above example, this will embed the contents of `_includes/footer.html` into the calling file. +Jekyll expects all *include files* to be placed in an `_includes` directory at the root of your source directory. In the above example, this will embed the contents of `_includes/footer.html` into the calling file. For more advanced information on using includes, see [Includes](../includes). From caf5c00842f600f643d12394c8bb2aa3b53a15b2 Mon Sep 17 00:00:00 2001 From: Tom Johnson Date: Thu, 29 Dec 2016 00:29:45 -0800 Subject: [PATCH 14/90] made requested updates --- docs/_docs/collections.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/docs/_docs/collections.md b/docs/_docs/collections.md index ee0747be..7c606177 100644 --- a/docs/_docs/collections.md +++ b/docs/_docs/collections.md @@ -96,7 +96,7 @@ You can customize the [Permalinks](../permalinks/) for your collection's documen collections: my_collection: output: true - permalink: /awesome/:path/:title.output_ext + 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. @@ -237,11 +237,12 @@ Based on this scenario, here are a few permalink options. ### Collections -Each collection is accessible through the `site` 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 -(for example, `site.albums` is an array of documents, much like `site.pages` and -`site.posts`). See below for how to access attributes of those documents. +`site.albums`. + +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: From c8ef313d036b8d1f1f5eb02c43dce030689e892e Mon Sep 17 00:00:00 2001 From: Tom Johnson Date: Thu, 29 Dec 2016 09:31:30 -0800 Subject: [PATCH 15/90] fixing sentence in dispute --- docs/_docs/collections.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/_docs/collections.md b/docs/_docs/collections.md index 7c606177..149fdea6 100644 --- a/docs/_docs/collections.md +++ b/docs/_docs/collections.md @@ -49,10 +49,10 @@ defaults: ### Step 2: Add your content {#step2} -Create a corresponding folder (for example, `/_my_collection`) and add -documents. YAML Front Matter is read in as data if it exists, and everything -after it is accessible via the document's `content` attribute. If no YAML Front -Matter is provided, Jekyll will not generate the file in your collection. +Create a corresponding folder (e.g. `/_my_collection`) and add +documents. YAML front matter is processed if the front matter exists, and everything +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.
Be sure to name your directories correctly
From 4b51c1da587051a8a222a103d9fd196285d4d89d Mon Sep 17 00:00:00 2001 From: Pat Hawks Date: Thu, 5 Jan 2017 17:08:04 -0600 Subject: [PATCH 16/90] Use `assert_nil` --- test/test_front_matter_defaults.rb | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/test/test_front_matter_defaults.rb b/test/test_front_matter_defaults.rb index 93cbf4b4..30c713ac 100644 --- a/test/test_front_matter_defaults.rb +++ b/test/test_front_matter_defaults.rb @@ -21,7 +21,7 @@ class TestFrontMatterDefaults < JekyllUnitTest should "affect only the specified path and type" do assert_equal @affected.data["key"], "val" - assert_equal @not_affected.data["key"], nil + assert_nil @not_affected.data["key"] end end @@ -45,7 +45,7 @@ class TestFrontMatterDefaults < JekyllUnitTest should "affect only the specified path" do assert_equal @affected.data["key"], "val" - assert_equal @not_affected.data["key"], nil + assert_nil @not_affected.data["key"] end end @@ -69,7 +69,7 @@ class TestFrontMatterDefaults < JekyllUnitTest should "affect only the specified path and all types" do assert_equal @affected.data["key"], "val" - assert_equal @not_affected.data["key"], nil + assert_nil @not_affected.data["key"] end end From 368294b2a937440413a13cfa84cab4947c49c0f5 Mon Sep 17 00:00:00 2001 From: Pat Hawks Date: Fri, 6 Jan 2017 05:55:50 -0600 Subject: [PATCH 17/90] Update tests to be position independent --- test/test_new_command.rb | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/test/test_new_command.rb b/test/test_new_command.rb index 78e6ac6f..a02f1565 100644 --- a/test/test_new_command.rb +++ b/test/test_new_command.rb @@ -40,12 +40,11 @@ class TestNewCommand < JekyllUnitTest should "display a success message" do Jekyll::Commands::New.process(@args) - output = Jekyll.logger.messages[-3] - output_last = Jekyll.logger.messages.last - success_message = "New jekyll site installed in #{@full_path.cyan}." - bundle_message = "Running bundle install in #{@full_path.cyan}..." + output = Jekyll.logger.messages + success_message = "New jekyll site installed in #{@full_path.cyan}. " + bundle_message = "Running bundle install in #{@full_path.cyan}... " assert_includes output, success_message - assert_includes output_last, bundle_message + assert_includes output, bundle_message end should "copy the static files in site template to the new directory" do From 203be72c473fb7c37f976410a902904fa4f24fd2 Mon Sep 17 00:00:00 2001 From: Pat Hawks Date: Fri, 6 Jan 2017 05:57:21 -0600 Subject: [PATCH 18/90] Remove unnecessary "rubocop:enable" --- features/support/helpers.rb | 1 - 1 file changed, 1 deletion(-) diff --git a/features/support/helpers.rb b/features/support/helpers.rb index 87cf717c..6613b8ea 100644 --- a/features/support/helpers.rb +++ b/features/support/helpers.rb @@ -114,7 +114,6 @@ def run_in_shell(*args) p end -# rubocop:enable Metrics/AbcSize # From 02a8ce5585cd69077b345fc9675e166dc186dff9 Mon Sep 17 00:00:00 2001 From: Frank Taillandier Date: Sun, 8 Jan 2017 15:15:48 +0100 Subject: [PATCH 19/90] add spaces to variables --- docs/_docs/templates.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/_docs/templates.md b/docs/_docs/templates.md index 32050813..404e3704 100644 --- a/docs/_docs/templates.md +++ b/docs/_docs/templates.md @@ -539,13 +539,13 @@ You can also use the `link` tag to create a link in Markdown as follows: {% endraw %} ``` -(Including `{% raw %}{{site.baseurl}}{% endraw %}` is optional — it depends on whether you want to preface the page URL with the `baseurl` value.) +(Including `{% raw %}{{ site.baseurl }}{% endraw %}` is optional — it depends on whether you want to preface the page URL with the `baseurl` value.) The path to the post, page, or collection is defined as the path relative to the root directory (where your config file is) to the file, not the path from your existing page to the other page. For example, suppose you're creating a link `page_a.md` (stored in `pages/folder1/folder2`) to `page_b.md` (stored in `pages/folder1`). Your path in the link would not be `../page_b.html`. Instead, it would be `/pages/folder1/page_b.md`. -If you're unsure of the path, add `{% raw %}{{page.path}}{% endraw %}` to the page and it will display the path. +If you're unsure of the path, add `{% raw %}{{ page.path }}{% endraw %}` to the page and it will display the path. One major benefit of using the `link` tag is link validation. If the link doesn't exist, Jekyll won't build your site. This is a good thing, as it will alert you to a broken link so you can fix it (rather than allowing you to build and deploy a site with broken links). From 0ebc832e1b21b712f108ad0892c869be2893ef85 Mon Sep 17 00:00:00 2001 From: Kurt Anderson Date: Mon, 9 Jan 2017 08:01:58 -0500 Subject: [PATCH 20/90] Remove duplicate paragraph. --- docs/_docs/github-pages.md | 6 ------ 1 file changed, 6 deletions(-) diff --git a/docs/_docs/github-pages.md b/docs/_docs/github-pages.md index 710f702e..0a00f2fa 100644 --- a/docs/_docs/github-pages.md +++ b/docs/_docs/github-pages.md @@ -132,12 +132,6 @@ stored in a specially named `gh-pages` branch or in a `docs` folder on the will become available under a subpath of your user pages subdomain, such as `username.github.io/project` (unless a custom domain is specified). -The Jekyll project repository itself is a perfect example: the -[master branch]({{ site.repository }}) contains the actual software project -for Jekyll, however the Jekyll website (that you’re looking at right now) is -contained in the [docs folder]({{ site.repository }}/tree/master/docs) of the -same repository. - The Jekyll project repository itself is a perfect example of this branch structure—the [master branch]({{ site.repository }}) contains the actual software project for Jekyll, and the Jekyll website that you’re From 74fe613072d377c747ab37a4cc47f08f91a922b3 Mon Sep 17 00:00:00 2001 From: jekyllbot Date: Mon, 9 Jan 2017 05:16:12 -0800 Subject: [PATCH 21/90] Update history to reflect merge of #5740 [ci skip] --- History.markdown | 1 + 1 file changed, 1 insertion(+) diff --git a/History.markdown b/History.markdown index baf346a1..c0764538 100644 --- a/History.markdown +++ b/History.markdown @@ -56,6 +56,7 @@ * Improve pages docs (#5692) * Added new includes.md topic to docs (#5696) * Replace a dead link with a web-archived one (#5738) + * Remove duplicate paragraph. (#5740) ## 3.3.1 / 2016-11-14 From 8a5672fdffd87e586c2f97b5f77b7ca7aa7c53c2 Mon Sep 17 00:00:00 2001 From: Kenton Hansen Date: Mon, 10 Oct 2016 15:55:40 -0500 Subject: [PATCH 22/90] Addition of a sample "typical post" So, I thought this section in the docs would be a good place to put the anatomy of a post .md file. --- site/_docs/posts.md | 255 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 255 insertions(+) create mode 100644 site/_docs/posts.md diff --git a/site/_docs/posts.md b/site/_docs/posts.md new file mode 100644 index 00000000..bc8628c9 --- /dev/null +++ b/site/_docs/posts.md @@ -0,0 +1,255 @@ +--- +layout: docs +title: Writing posts +permalink: /docs/posts/ +--- + +One of Jekyll’s best aspects is that it is “blog aware”. What does this mean, +exactly? Well, simply put, it means that blogging is baked into Jekyll’s +functionality. If you write articles and publish them online, you can publish +and maintain a blog simply by managing a folder of text-files on your computer. +Compared to the hassle of configuring and maintaining databases and web-based +CMS systems, this will be a welcome change! + +## The Posts Folder + +As explained on the [directory structure](../structure/) page, the `_posts` +folder is where your blog posts will live. These files are generally +[Markdown](https://daringfireball.net/projects/markdown/) or HTML, but can +be other formats with the proper converter installed. +All posts must have [YAML Front Matter](../frontmatter/), and they will be +converted from their source format into an HTML page that is part of your +static site. + +### Creating Post Files + +To create a new post, all you need to do is create a file in the `_posts` +directory. How you name files in this folder is important. Jekyll requires blog +post files to be named according to the following format: + +```sh +YEAR-MONTH-DAY-title.MARKUP +``` + +Where `YEAR` is a four-digit number, `MONTH` and `DAY` are both two-digit +numbers, and `MARKUP` is the file extension representing the format used in the +file. For example, the following are examples of valid post filenames: + +```sh +2011-12-31-new-years-eve-is-awesome.md +2012-09-12-how-to-write-a-blog.md +``` + +
+
ProTip™: Link to other posts
+

+ Use the post_url + tag to link to other posts without having to worry about the URL's + breaking when the site permalink style changes. +

+
+ +### Content Formats + +All blog post files must begin with [YAML Front Matter](../frontmatter/). After +that, it's simply a matter of deciding which format you prefer. Jekyll supports +[Markdown](https://daringfireball.net/projects/markdown/) out of the box, +and has [myriad extensions for other formats as well](/docs/plugins/#converters-1), +including the popular [Textile](http://redcloth.org/textile) format. These +formats each have their own way of marking up different types of content +within a post, so you should familiarize yourself with these formats and +decide which one best suits your needs. + +
+
Be aware of character sets
+

+ Content processors can modify certain characters to make them look nicer. + For example, the smart extension in Redcarpet converts standard, + ASCII quotation characters to curly, Unicode ones. In order for the browser + to display those characters properly, define the charset meta value by + including <meta charset="utf-8"> in the + <head> of your layout. +

+
+ +## Including images and resources + +Chances are, at some point, you'll want to include images, downloads, or other +digital assets along with your text content. While the syntax for linking to +these resources differs between Markdown and Textile, the problem of working +out where to store these files in your site is something everyone will face. + +Because of Jekyll’s flexibility, there are many solutions to how to do this. +One common solution is to create a folder in the root of the project directory +called something like `assets` or `downloads`, into which any images, downloads +or other resources are placed. Then, from within any post, they can be linked +to using the site’s root as the path for the asset to include. Again, this will +depend on the way your site’s (sub)domain and path are configured, but here are +some examples (in Markdown) of how you could do this using the `site.url` +variable in a post. + +Including an image asset in a post: + +```text +... which is shown in the screenshot below: +![My helpful screenshot]({% raw %}{{ site.url }}{% endraw %}/assets/screenshot.jpg) +``` + +Linking to a PDF for readers to download: + +```text +... you can [get the PDF]({% raw %}{{ site.url }}{% endraw %}/assets/mydoc.pdf) directly. +``` + +
+
ProTip™: Link using just the site root URL
+

+ You can skip the {% raw %}{{ site.url }}{% endraw %} variable + if you know your site will only ever be displayed at the + root URL of your domain. In this case you can reference assets directly with + just /path/file.jpg. +

+
+ +## A typical post + +Jekyll can handle many different iterations of the idea you might associate with a "post," however a standard blog style post, including an Title, Layout, Publishing Date, and Categories might look like this: + +``` +--- +layout: post +title: "Welcome to Jekyll!" +date: 2015-11-17 16:16:01 -0600 +categories: jekyll update +--- +You’ll find this post in your `_posts` directory. Go ahead and edit it and re-build the site to see your changes. You can rebuild the site in many different ways, but the most common way is to run `jekyll serve`, which launches a web server and auto-regenerates your site when a file is updated. + +To add new posts, simply add a file in the `_posts` directory that follows the convention `YYYY-MM-DD-name-of-post.ext` and includes the necessary front matter. Take a look at the source for this post to get an idea about how it works. + +``` +Everything in between the first and second `---` are part of the YAML Front Matter, and everything after the second `---` will be rendered with Markdown and show up as "Content." + +## Displaying an index of posts + +It’s all well and good to have posts in a folder, but a blog is no use unless +you have a list of posts somewhere. Creating an index of posts on another page +(or in a [template](../templates/)) is easy, thanks to the [Liquid template +language](https://docs.shopify.com/themes/liquid/basics) and its tags. Here’s a +basic example of how to create a list of links to your blog posts: + +```html + +``` + +Of course, you have full control over how (and where) you display your posts, +and how you structure your site. You should read more about [how templates +work](../templates/) with Jekyll if you want to know more. + +Note that the `post` variable only exists inside the `for` loop above. If +you wish to access the currently-rendering page/posts's variables (the +variables of the post/page that has the `for` loop in it), use the `page` +variable instead. + +## Post excerpts + +Each post automatically takes the first block of text, from the beginning of +the content to the first occurrence of `excerpt_separator`, and sets it as the `post.excerpt`. +Take the above example of an index of posts. Perhaps you want to include +a little hint about the post's content by adding the first paragraph of each of +your posts: + +```html + +``` + +Because Jekyll grabs the first paragraph you will not need to wrap the excerpt +in `p` tags, which is already done for you. These tags can be removed with the +following if you'd prefer: + +```html +{% raw %}{{ post.excerpt | remove: '

' | remove: '

' }}{% endraw %} +``` + +If you don't like the automatically-generated post excerpt, it can be +explicitly overridden by adding an `excerpt` value to your post's YAML +Front Matter. Alternatively, you can choose to define a custom +`excerpt_separator` in the post's YAML front matter: + +```text +--- +excerpt_separator: +--- + +Excerpt + +Out-of-excerpt +``` + +You can also set the `excerpt_separator` globally in your `_config.yml` +configuration file. + +Completely disable excerpts by setting your `excerpt_separator` to `""`. + +Also, as with any output generated by Liquid tags, you can pass the +`| strip_html` filter to remove any html tags in the output. This is +particularly helpful if you wish to output a post excerpt as a +`meta="description"` tag within the post `head`, or anywhere else having +html tags along with the content is not desirable. + +## Highlighting code snippets + +Jekyll also has built-in support for syntax highlighting of code snippets using +either Pygments or Rouge, and including a code snippet in any post is easy. +Just use the dedicated Liquid tag as follows: + +```text +{% raw %}{% highlight ruby %}{% endraw %} +def show + @widget = Widget(params[:id]) + respond_to do |format| + format.html # show.html.erb + format.json { render json: @widget } + end +end +{% raw %}{% endhighlight %}{% endraw %} +``` + +And the output will look like this: + +```ruby +def show + @widget = Widget(params[:id]) + respond_to do |format| + format.html # show.html.erb + format.json { render json: @widget } + end +end +``` + +
+
ProTip™: Show line numbers
+

+ You can make code snippets include line-numbers by adding the word + linenos to the end of the opening highlight tag like this: + {% raw %}{% highlight ruby linenos %}{% endraw %}. +

+
+ +These basics should be enough to get you started writing your first posts. When +you’re ready to dig into what else is possible, you might be interested in +doing things like [customizing post permalinks](../permalinks/) or +using [custom variables](../variables/) in your posts and elsewhere on your +site. From b1291605b36d978f0fab9fcc7de48879a67ace86 Mon Sep 17 00:00:00 2001 From: Kenton Hansen Date: Mon, 10 Oct 2016 16:46:42 -0500 Subject: [PATCH 23/90] Changes to 'bundle exec jekyll serve' Updated to be consistent with the rest of documentation. --- site/_docs/posts.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/site/_docs/posts.md b/site/_docs/posts.md index bc8628c9..d4d8f15d 100644 --- a/site/_docs/posts.md +++ b/site/_docs/posts.md @@ -122,7 +122,7 @@ title: "Welcome to Jekyll!" date: 2015-11-17 16:16:01 -0600 categories: jekyll update --- -You’ll find this post in your `_posts` directory. Go ahead and edit it and re-build the site to see your changes. You can rebuild the site in many different ways, but the most common way is to run `jekyll serve`, which launches a web server and auto-regenerates your site when a file is updated. +You’ll find this post in your `_posts` directory. Go ahead and edit it and re-build the site to see your changes. You can rebuild the site in many different ways, but the most common way is to run `bundle exec jekyll serve`, which launches a web server and auto-regenerates your site when a file is updated. To add new posts, simply add a file in the `_posts` directory that follows the convention `YYYY-MM-DD-name-of-post.ext` and includes the necessary front matter. Take a look at the source for this post to get an idea about how it works. From e60769731afc143ca3e2b7fc082be5ec17e16ad9 Mon Sep 17 00:00:00 2001 From: Frank Taillandier Date: Mon, 9 Jan 2017 15:25:59 +0100 Subject: [PATCH 24/90] Report modifications to docs --- docs/_docs/posts.md | 18 ++++ site/_docs/posts.md | 255 -------------------------------------------- 2 files changed, 18 insertions(+), 255 deletions(-) delete mode 100644 site/_docs/posts.md diff --git a/docs/_docs/posts.md b/docs/_docs/posts.md index 40aa8365..d4d8f15d 100644 --- a/docs/_docs/posts.md +++ b/docs/_docs/posts.md @@ -111,6 +111,24 @@ Linking to a PDF for readers to download:

+## A typical post + +Jekyll can handle many different iterations of the idea you might associate with a "post," however a standard blog style post, including an Title, Layout, Publishing Date, and Categories might look like this: + +``` +--- +layout: post +title: "Welcome to Jekyll!" +date: 2015-11-17 16:16:01 -0600 +categories: jekyll update +--- +You’ll find this post in your `_posts` directory. Go ahead and edit it and re-build the site to see your changes. You can rebuild the site in many different ways, but the most common way is to run `bundle exec jekyll serve`, which launches a web server and auto-regenerates your site when a file is updated. + +To add new posts, simply add a file in the `_posts` directory that follows the convention `YYYY-MM-DD-name-of-post.ext` and includes the necessary front matter. Take a look at the source for this post to get an idea about how it works. + +``` +Everything in between the first and second `---` are part of the YAML Front Matter, and everything after the second `---` will be rendered with Markdown and show up as "Content." + ## Displaying an index of posts It’s all well and good to have posts in a folder, but a blog is no use unless diff --git a/site/_docs/posts.md b/site/_docs/posts.md deleted file mode 100644 index d4d8f15d..00000000 --- a/site/_docs/posts.md +++ /dev/null @@ -1,255 +0,0 @@ ---- -layout: docs -title: Writing posts -permalink: /docs/posts/ ---- - -One of Jekyll’s best aspects is that it is “blog aware”. What does this mean, -exactly? Well, simply put, it means that blogging is baked into Jekyll’s -functionality. If you write articles and publish them online, you can publish -and maintain a blog simply by managing a folder of text-files on your computer. -Compared to the hassle of configuring and maintaining databases and web-based -CMS systems, this will be a welcome change! - -## The Posts Folder - -As explained on the [directory structure](../structure/) page, the `_posts` -folder is where your blog posts will live. These files are generally -[Markdown](https://daringfireball.net/projects/markdown/) or HTML, but can -be other formats with the proper converter installed. -All posts must have [YAML Front Matter](../frontmatter/), and they will be -converted from their source format into an HTML page that is part of your -static site. - -### Creating Post Files - -To create a new post, all you need to do is create a file in the `_posts` -directory. How you name files in this folder is important. Jekyll requires blog -post files to be named according to the following format: - -```sh -YEAR-MONTH-DAY-title.MARKUP -``` - -Where `YEAR` is a four-digit number, `MONTH` and `DAY` are both two-digit -numbers, and `MARKUP` is the file extension representing the format used in the -file. For example, the following are examples of valid post filenames: - -```sh -2011-12-31-new-years-eve-is-awesome.md -2012-09-12-how-to-write-a-blog.md -``` - -
-
ProTip™: Link to other posts
-

- Use the post_url - tag to link to other posts without having to worry about the URL's - breaking when the site permalink style changes. -

-
- -### Content Formats - -All blog post files must begin with [YAML Front Matter](../frontmatter/). After -that, it's simply a matter of deciding which format you prefer. Jekyll supports -[Markdown](https://daringfireball.net/projects/markdown/) out of the box, -and has [myriad extensions for other formats as well](/docs/plugins/#converters-1), -including the popular [Textile](http://redcloth.org/textile) format. These -formats each have their own way of marking up different types of content -within a post, so you should familiarize yourself with these formats and -decide which one best suits your needs. - -
-
Be aware of character sets
-

- Content processors can modify certain characters to make them look nicer. - For example, the smart extension in Redcarpet converts standard, - ASCII quotation characters to curly, Unicode ones. In order for the browser - to display those characters properly, define the charset meta value by - including <meta charset="utf-8"> in the - <head> of your layout. -

-
- -## Including images and resources - -Chances are, at some point, you'll want to include images, downloads, or other -digital assets along with your text content. While the syntax for linking to -these resources differs between Markdown and Textile, the problem of working -out where to store these files in your site is something everyone will face. - -Because of Jekyll’s flexibility, there are many solutions to how to do this. -One common solution is to create a folder in the root of the project directory -called something like `assets` or `downloads`, into which any images, downloads -or other resources are placed. Then, from within any post, they can be linked -to using the site’s root as the path for the asset to include. Again, this will -depend on the way your site’s (sub)domain and path are configured, but here are -some examples (in Markdown) of how you could do this using the `site.url` -variable in a post. - -Including an image asset in a post: - -```text -... which is shown in the screenshot below: -![My helpful screenshot]({% raw %}{{ site.url }}{% endraw %}/assets/screenshot.jpg) -``` - -Linking to a PDF for readers to download: - -```text -... you can [get the PDF]({% raw %}{{ site.url }}{% endraw %}/assets/mydoc.pdf) directly. -``` - -
-
ProTip™: Link using just the site root URL
-

- You can skip the {% raw %}{{ site.url }}{% endraw %} variable - if you know your site will only ever be displayed at the - root URL of your domain. In this case you can reference assets directly with - just /path/file.jpg. -

-
- -## A typical post - -Jekyll can handle many different iterations of the idea you might associate with a "post," however a standard blog style post, including an Title, Layout, Publishing Date, and Categories might look like this: - -``` ---- -layout: post -title: "Welcome to Jekyll!" -date: 2015-11-17 16:16:01 -0600 -categories: jekyll update ---- -You’ll find this post in your `_posts` directory. Go ahead and edit it and re-build the site to see your changes. You can rebuild the site in many different ways, but the most common way is to run `bundle exec jekyll serve`, which launches a web server and auto-regenerates your site when a file is updated. - -To add new posts, simply add a file in the `_posts` directory that follows the convention `YYYY-MM-DD-name-of-post.ext` and includes the necessary front matter. Take a look at the source for this post to get an idea about how it works. - -``` -Everything in between the first and second `---` are part of the YAML Front Matter, and everything after the second `---` will be rendered with Markdown and show up as "Content." - -## Displaying an index of posts - -It’s all well and good to have posts in a folder, but a blog is no use unless -you have a list of posts somewhere. Creating an index of posts on another page -(or in a [template](../templates/)) is easy, thanks to the [Liquid template -language](https://docs.shopify.com/themes/liquid/basics) and its tags. Here’s a -basic example of how to create a list of links to your blog posts: - -```html - -``` - -Of course, you have full control over how (and where) you display your posts, -and how you structure your site. You should read more about [how templates -work](../templates/) with Jekyll if you want to know more. - -Note that the `post` variable only exists inside the `for` loop above. If -you wish to access the currently-rendering page/posts's variables (the -variables of the post/page that has the `for` loop in it), use the `page` -variable instead. - -## Post excerpts - -Each post automatically takes the first block of text, from the beginning of -the content to the first occurrence of `excerpt_separator`, and sets it as the `post.excerpt`. -Take the above example of an index of posts. Perhaps you want to include -a little hint about the post's content by adding the first paragraph of each of -your posts: - -```html - -``` - -Because Jekyll grabs the first paragraph you will not need to wrap the excerpt -in `p` tags, which is already done for you. These tags can be removed with the -following if you'd prefer: - -```html -{% raw %}{{ post.excerpt | remove: '

' | remove: '

' }}{% endraw %} -``` - -If you don't like the automatically-generated post excerpt, it can be -explicitly overridden by adding an `excerpt` value to your post's YAML -Front Matter. Alternatively, you can choose to define a custom -`excerpt_separator` in the post's YAML front matter: - -```text ---- -excerpt_separator: ---- - -Excerpt - -Out-of-excerpt -``` - -You can also set the `excerpt_separator` globally in your `_config.yml` -configuration file. - -Completely disable excerpts by setting your `excerpt_separator` to `""`. - -Also, as with any output generated by Liquid tags, you can pass the -`| strip_html` filter to remove any html tags in the output. This is -particularly helpful if you wish to output a post excerpt as a -`meta="description"` tag within the post `head`, or anywhere else having -html tags along with the content is not desirable. - -## Highlighting code snippets - -Jekyll also has built-in support for syntax highlighting of code snippets using -either Pygments or Rouge, and including a code snippet in any post is easy. -Just use the dedicated Liquid tag as follows: - -```text -{% raw %}{% highlight ruby %}{% endraw %} -def show - @widget = Widget(params[:id]) - respond_to do |format| - format.html # show.html.erb - format.json { render json: @widget } - end -end -{% raw %}{% endhighlight %}{% endraw %} -``` - -And the output will look like this: - -```ruby -def show - @widget = Widget(params[:id]) - respond_to do |format| - format.html # show.html.erb - format.json { render json: @widget } - end -end -``` - -
-
ProTip™: Show line numbers
-

- You can make code snippets include line-numbers by adding the word - linenos to the end of the opening highlight tag like this: - {% raw %}{% highlight ruby linenos %}{% endraw %}. -

-
- -These basics should be enough to get you started writing your first posts. When -you’re ready to dig into what else is possible, you might be interested in -doing things like [customizing post permalinks](../permalinks/) or -using [custom variables](../variables/) in your posts and elsewhere on your -site. From 86fc58491c494c6acfb25d5e6a8d9f4a4c6c754f Mon Sep 17 00:00:00 2001 From: jekyllbot Date: Mon, 9 Jan 2017 06:36:52 -0800 Subject: [PATCH 25/90] Update history to reflect merge of #5473 [ci skip] --- History.markdown | 1 + 1 file changed, 1 insertion(+) diff --git a/History.markdown b/History.markdown index c0764538..b578b9bf 100644 --- a/History.markdown +++ b/History.markdown @@ -57,6 +57,7 @@ * Added new includes.md topic to docs (#5696) * Replace a dead link with a web-archived one (#5738) * Remove duplicate paragraph. (#5740) + * Addition of a sample "typical post" (#5473) ## 3.3.1 / 2016-11-14 From 5ac3e0a866d7a2abfa4a081183160874bc082f7e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Zlatan=20Vasovi=C4=87?= Date: Sat, 7 Jan 2017 11:12:50 +0100 Subject: [PATCH 26/90] Fix #5730: add gcc and make to the list of requirements --- docs/_docs/installation.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/_docs/installation.md b/docs/_docs/installation.md index 54dfd9fc..1fb1ca36 100644 --- a/docs/_docs/installation.md +++ b/docs/_docs/installation.md @@ -21,6 +21,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)
Running Jekyll on Windows
From 74e6ef83c9aa274a4ebf2efea372c7479feae68c Mon Sep 17 00:00:00 2001 From: Frank Taillandier Date: Mon, 9 Jan 2017 21:10:24 +0100 Subject: [PATCH 27/90] Use defaults in config All docs stored in _docs inherit from docs layout All news items stored in _posts inherit from news-item layout --- Rakefile | 1 - docs/_config.yml | 15 +++++++++++++++ docs/_docs/assets.md | 1 - docs/_docs/collections.md | 1 - docs/_docs/conduct.md | 1 - docs/_docs/configuration.md | 1 - docs/_docs/continuous-integration.md | 1 - docs/_docs/contributing.md | 1 - docs/_docs/datafiles.md | 1 - docs/_docs/deployment-methods.md | 1 - docs/_docs/drafts.md | 1 - docs/_docs/extras.md | 1 - docs/_docs/frontmatter.md | 1 - docs/_docs/github-pages.md | 1 - docs/_docs/history.md | 1 - docs/_docs/includes.md | 1 - docs/_docs/index.md | 1 - docs/_docs/installation.md | 1 - docs/_docs/maintaining/affinity-team-captain.md | 1 - docs/_docs/maintaining/avoiding-burnout.md | 1 - docs/_docs/maintaining/becoming-a-maintainer.md | 1 - docs/_docs/maintaining/index.md | 1 - docs/_docs/maintaining/merging-a-pull-request.md | 1 - .../_docs/maintaining/reviewing-a-pull-request.md | 1 - docs/_docs/maintaining/special-labels.md | 1 - docs/_docs/maintaining/triaging-an-issue.md | 1 - docs/_docs/migrations.md | 1 - docs/_docs/pages.md | 1 - docs/_docs/pagination.md | 1 - docs/_docs/permalinks.md | 1 - docs/_docs/plugins.md | 1 - docs/_docs/posts.md | 1 - docs/_docs/quickstart.md | 1 - docs/_docs/resources.md | 1 - docs/_docs/sites.md | 1 - docs/_docs/static_files.md | 1 - docs/_docs/structure.md | 1 - docs/_docs/templates.md | 1 - docs/_docs/themes.md | 1 - docs/_docs/troubleshooting.md | 1 - docs/_docs/upgrading/0-to-2.md | 1 - docs/_docs/upgrading/2-to-3.md | 1 - docs/_docs/usage.md | 1 - docs/_docs/variables.md | 1 - docs/_docs/windows.md | 1 - .../2013-05-06-jekyll-1-0-0-released.markdown | 1 - .../2013-05-08-jekyll-1-0-1-released.markdown | 1 - .../2013-05-12-jekyll-1-0-2-released.markdown | 1 - .../2013-06-07-jekyll-1-0-3-released.markdown | 1 - .../2013-07-14-jekyll-1-1-0-released.markdown | 1 - .../2013-07-24-jekyll-1-1-1-released.markdown | 1 - .../2013-07-25-jekyll-1-0-4-released.markdown | 1 - .../2013-07-25-jekyll-1-1-2-released.markdown | 1 - .../2013-09-06-jekyll-1-2-0-released.markdown | 1 - .../2013-09-14-jekyll-1-2-1-released.markdown | 1 - .../2013-10-28-jekyll-1-3-0-rc1-released.markdown | 1 - .../2013-11-04-jekyll-1-3-0-released.markdown | 1 - .../2013-11-26-jekyll-1-3-1-released.markdown | 1 - .../2013-12-07-jekyll-1-4-0-released.markdown | 1 - .../2013-12-09-jekyll-1-4-1-released.markdown | 1 - .../2013-12-16-jekyll-1-4-2-released.markdown | 1 - .../2014-01-13-jekyll-1-4-3-released.markdown | 1 - .../2014-03-24-jekyll-1-5-0-released.markdown | 1 - .../2014-03-27-jekyll-1-5-1-released.markdown | 1 - .../_posts/2014-05-06-jekyll-turns-2-0-0.markdown | 1 - .../2014-05-08-jekyll-2-0-3-released.markdown | 1 - ...-jekyll-stickers-1-dollar-stickermule.markdown | 1 - ...14-06-28-jekyll-turns-21-i-mean-2-1-0.markdown | 1 - .../2014-07-01-jekyll-2-1-1-released.markdown | 1 - .../2014-07-29-jekyll-2-2-0-released.markdown | 1 - .../2014-08-10-jekyll-2-3-0-released.markdown | 1 - .../2014-09-09-jekyll-2-4-0-released.markdown | 1 - ...lls-midlife-crisis-jekyll-turns-2-5-0.markdown | 1 - .../2014-11-08-jekyll-2-5-1-released.markdown | 1 - .../2014-11-12-jekyll-2-5-2-released.markdown | 1 - ...014-12-17-alfredxing-welcome-to-jekyll-core.md | 1 - .../2014-12-22-jekyll-2-5-3-released.markdown | 1 - .../2015-01-20-jekyll-meet-and-greet.markdown | 1 - ...015-01-24-jekyll-3-0-0-beta1-released.markdown | 1 - .../2015-02-26-introducing-jekyll-talk.markdown | 3 +-- .../2015-10-26-jekyll-3-0-released.markdown | 1 - .../2015-11-17-jekyll-3-0-1-released.markdown | 1 - .../2016-01-20-jekyll-3-0-2-released.markdown | 1 - .../2016-01-24-jekyll-3-1-0-released.markdown | 1 - .../2016-01-28-jekyll-3-1-1-released.markdown | 1 - .../2016-02-08-jekyll-3-0-3-released.markdown | 1 - .../2016-02-19-jekyll-3-1-2-released.markdown | 1 - ...10-making-it-easier-to-contribute-to-jekyll.md | 1 - .../2016-04-19-jekyll-3-0-4-released.markdown | 1 - .../2016-04-19-jekyll-3-1-3-released.markdown | 2 -- .../2016-04-26-jekyll-3-0-5-released.markdown | 1 - .../2016-05-18-jekyll-3-1-4-released.markdown | 1 - .../2016-05-18-jekyll-3-1-5-released.markdown | 1 - .../2016-05-19-jekyll-3-1-6-released.markdown | 1 - ...kyll-s-google-summer-of-code-projects.markdown | 1 - .../2016-07-26-jekyll-3-2-0-released.markdown | 1 - .../2016-08-02-jekyll-3-2-1-released.markdown | 1 - ...16-08-24-jekyll-admin-initial-release.markdown | 1 - docs/_posts/2016-10-06-jekyll-3-3-is-here.md | 1 - .../2016-11-14-jekyll-3-3-1-released.markdown | 1 - rake/site.rake | 1 - 101 files changed, 16 insertions(+), 102 deletions(-) diff --git a/Rakefile b/Rakefile index 58aecfaf..4f11a64e 100644 --- a/Rakefile +++ b/Rakefile @@ -101,7 +101,6 @@ def siteify_file(file, overrides_front_matter = {}) 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) diff --git a/docs/_config.yml b/docs/_config.yml index 32ae74bb..f3dcb08d 100644 --- a/docs/_config.yml +++ b/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/ diff --git a/docs/_docs/assets.md b/docs/_docs/assets.md index 4908a400..7418f984 100644 --- a/docs/_docs/assets.md +++ b/docs/_docs/assets.md @@ -1,5 +1,4 @@ --- -layout: docs title: Assets permalink: /docs/assets/ --- diff --git a/docs/_docs/collections.md b/docs/_docs/collections.md index 22a86e60..8a1c3a1a 100644 --- a/docs/_docs/collections.md +++ b/docs/_docs/collections.md @@ -1,5 +1,4 @@ --- -layout: docs title: Collections permalink: /docs/collections/ --- diff --git a/docs/_docs/conduct.md b/docs/_docs/conduct.md index d68c5ec5..7ba30a5a 100644 --- a/docs/_docs/conduct.md +++ b/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" diff --git a/docs/_docs/configuration.md b/docs/_docs/configuration.md index 9df1c85f..e4c35b8a 100644 --- a/docs/_docs/configuration.md +++ b/docs/_docs/configuration.md @@ -1,5 +1,4 @@ --- -layout: docs title: Configuration permalink: /docs/configuration/ --- diff --git a/docs/_docs/continuous-integration.md b/docs/_docs/continuous-integration.md index 54b3466c..c2e8a31f 100644 --- a/docs/_docs/continuous-integration.md +++ b/docs/_docs/continuous-integration.md @@ -1,5 +1,4 @@ --- -layout: docs title: Continuous Integration permalink: /docs/continuous-integration/ --- diff --git a/docs/_docs/contributing.md b/docs/_docs/contributing.md index 9ccac293..724c6641 100644 --- a/docs/_docs/contributing.md +++ b/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. --- diff --git a/docs/_docs/datafiles.md b/docs/_docs/datafiles.md index 21799169..221ee4d3 100644 --- a/docs/_docs/datafiles.md +++ b/docs/_docs/datafiles.md @@ -1,5 +1,4 @@ --- -layout: docs title: Data Files permalink: /docs/datafiles/ --- diff --git a/docs/_docs/deployment-methods.md b/docs/_docs/deployment-methods.md index cefb4d32..33edec59 100644 --- a/docs/_docs/deployment-methods.md +++ b/docs/_docs/deployment-methods.md @@ -1,5 +1,4 @@ --- -layout: docs title: Deployment methods permalink: /docs/deployment-methods/ --- diff --git a/docs/_docs/drafts.md b/docs/_docs/drafts.md index d5513f75..c4b4f9f0 100644 --- a/docs/_docs/drafts.md +++ b/docs/_docs/drafts.md @@ -1,5 +1,4 @@ --- -layout: docs title: Working with drafts permalink: /docs/drafts/ --- diff --git a/docs/_docs/extras.md b/docs/_docs/extras.md index 9064d967..67236e71 100644 --- a/docs/_docs/extras.md +++ b/docs/_docs/extras.md @@ -1,5 +1,4 @@ --- -layout: docs title: Extras permalink: /docs/extras/ --- diff --git a/docs/_docs/frontmatter.md b/docs/_docs/frontmatter.md index 6dd8e5fe..cb55c444 100644 --- a/docs/_docs/frontmatter.md +++ b/docs/_docs/frontmatter.md @@ -1,5 +1,4 @@ --- -layout: docs title: Front Matter permalink: /docs/frontmatter/ --- diff --git a/docs/_docs/github-pages.md b/docs/_docs/github-pages.md index 0a00f2fa..cc738704 100644 --- a/docs/_docs/github-pages.md +++ b/docs/_docs/github-pages.md @@ -1,5 +1,4 @@ --- -layout: docs title: GitHub Pages permalink: /docs/github-pages/ --- diff --git a/docs/_docs/history.md b/docs/_docs/history.md index 5d07eb40..03767126 100644 --- a/docs/_docs/history.md +++ b/docs/_docs/history.md @@ -1,6 +1,5 @@ --- title: History -layout: docs permalink: "/docs/history/" note: This file is autogenerated. Edit /History.markdown instead. --- diff --git a/docs/_docs/includes.md b/docs/_docs/includes.md index 94c56894..ae6409cd 100644 --- a/docs/_docs/includes.md +++ b/docs/_docs/includes.md @@ -1,5 +1,4 @@ --- -layout: docs title: Includes permalink: /docs/includes/ --- diff --git a/docs/_docs/index.md b/docs/_docs/index.md index 5e08d760..ff5e8cce 100644 --- a/docs/_docs/index.md +++ b/docs/_docs/index.md @@ -1,5 +1,4 @@ --- -layout: docs title: Welcome permalink: /docs/home/ redirect_from: /docs/index.html diff --git a/docs/_docs/installation.md b/docs/_docs/installation.md index 54dfd9fc..d264997d 100644 --- a/docs/_docs/installation.md +++ b/docs/_docs/installation.md @@ -1,5 +1,4 @@ --- -layout: docs title: Installation permalink: /docs/installation/ --- diff --git a/docs/_docs/maintaining/affinity-team-captain.md b/docs/_docs/maintaining/affinity-team-captain.md index 02247d2d..bafa4e9d 100644 --- a/docs/_docs/maintaining/affinity-team-captain.md +++ b/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. diff --git a/docs/_docs/maintaining/avoiding-burnout.md b/docs/_docs/maintaining/avoiding-burnout.md index 1d1d93b1..e6acf402 100644 --- a/docs/_docs/maintaining/avoiding-burnout.md +++ b/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. diff --git a/docs/_docs/maintaining/becoming-a-maintainer.md b/docs/_docs/maintaining/becoming-a-maintainer.md index e4a1840c..00abef54 100644 --- a/docs/_docs/maintaining/becoming-a-maintainer.md +++ b/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. diff --git a/docs/_docs/maintaining/index.md b/docs/_docs/maintaining/index.md index 5c4da4db..383bc6ee 100644 --- a/docs/_docs/maintaining/index.md +++ b/docs/_docs/maintaining/index.md @@ -1,5 +1,4 @@ --- -layout: docs title: Maintaining Jekyll permalink: /docs/maintaining/ --- diff --git a/docs/_docs/maintaining/merging-a-pull-request.md b/docs/_docs/maintaining/merging-a-pull-request.md index 80ad6f7c..9aee4153 100644 --- a/docs/_docs/maintaining/merging-a-pull-request.md +++ b/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. diff --git a/docs/_docs/maintaining/reviewing-a-pull-request.md b/docs/_docs/maintaining/reviewing-a-pull-request.md index 12f7a35f..a0a6e353 100644 --- a/docs/_docs/maintaining/reviewing-a-pull-request.md +++ b/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. diff --git a/docs/_docs/maintaining/special-labels.md b/docs/_docs/maintaining/special-labels.md index eea366e9..a8696174 100644 --- a/docs/_docs/maintaining/special-labels.md +++ b/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. diff --git a/docs/_docs/maintaining/triaging-an-issue.md b/docs/_docs/maintaining/triaging-an-issue.md index 4802b61b..bc87d96e 100644 --- a/docs/_docs/maintaining/triaging-an-issue.md +++ b/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. diff --git a/docs/_docs/migrations.md b/docs/_docs/migrations.md index 961762f7..fd8676a4 100644 --- a/docs/_docs/migrations.md +++ b/docs/_docs/migrations.md @@ -1,5 +1,4 @@ --- -layout: docs title: Blog migrations permalink: /docs/migrations/ --- diff --git a/docs/_docs/pages.md b/docs/_docs/pages.md index 258fd6a2..398d1987 100644 --- a/docs/_docs/pages.md +++ b/docs/_docs/pages.md @@ -1,5 +1,4 @@ --- -layout: docs title: Creating pages permalink: /docs/pages/ --- diff --git a/docs/_docs/pagination.md b/docs/_docs/pagination.md index b32b934c..b05b6bb2 100644 --- a/docs/_docs/pagination.md +++ b/docs/_docs/pagination.md @@ -1,5 +1,4 @@ --- -layout: docs title: Pagination permalink: /docs/pagination/ --- diff --git a/docs/_docs/permalinks.md b/docs/_docs/permalinks.md index b8fd5ec6..bcb39e54 100644 --- a/docs/_docs/permalinks.md +++ b/docs/_docs/permalinks.md @@ -1,5 +1,4 @@ --- -layout: docs title: Permalinks permalink: /docs/permalinks/ --- diff --git a/docs/_docs/plugins.md b/docs/_docs/plugins.md index 4a5e61cf..ce174f12 100644 --- a/docs/_docs/plugins.md +++ b/docs/_docs/plugins.md @@ -1,5 +1,4 @@ --- -layout: docs title: Plugins permalink: /docs/plugins/ --- diff --git a/docs/_docs/posts.md b/docs/_docs/posts.md index d4d8f15d..f43b72e8 100644 --- a/docs/_docs/posts.md +++ b/docs/_docs/posts.md @@ -1,5 +1,4 @@ --- -layout: docs title: Writing posts permalink: /docs/posts/ --- diff --git a/docs/_docs/quickstart.md b/docs/_docs/quickstart.md index d15a9eb1..984275f7 100644 --- a/docs/_docs/quickstart.md +++ b/docs/_docs/quickstart.md @@ -1,5 +1,4 @@ --- -layout: docs title: Quick-start guide permalink: /docs/quickstart/ --- diff --git a/docs/_docs/resources.md b/docs/_docs/resources.md index 2042b1a6..0f90fae8 100644 --- a/docs/_docs/resources.md +++ b/docs/_docs/resources.md @@ -1,5 +1,4 @@ --- -layout: docs title: Resources permalink: /docs/resources/ --- diff --git a/docs/_docs/sites.md b/docs/_docs/sites.md index 28e464ba..65401551 100644 --- a/docs/_docs/sites.md +++ b/docs/_docs/sites.md @@ -1,5 +1,4 @@ --- -layout: docs title: Sites using Jekyll permalink: /docs/sites/ --- diff --git a/docs/_docs/static_files.md b/docs/_docs/static_files.md index 55a72747..523c29df 100644 --- a/docs/_docs/static_files.md +++ b/docs/_docs/static_files.md @@ -1,5 +1,4 @@ --- -layout: docs title: Static Files permalink: /docs/static-files/ --- diff --git a/docs/_docs/structure.md b/docs/_docs/structure.md index bdfaab59..6735d6e0 100644 --- a/docs/_docs/structure.md +++ b/docs/_docs/structure.md @@ -1,5 +1,4 @@ --- -layout: docs title: Directory structure permalink: /docs/structure/ --- diff --git a/docs/_docs/templates.md b/docs/_docs/templates.md index 79b5fdae..26bd804a 100644 --- a/docs/_docs/templates.md +++ b/docs/_docs/templates.md @@ -1,5 +1,4 @@ --- -layout: docs title: Templates permalink: /docs/templates/ --- diff --git a/docs/_docs/themes.md b/docs/_docs/themes.md index c7d6d574..e01a4d15 100644 --- a/docs/_docs/themes.md +++ b/docs/_docs/themes.md @@ -1,5 +1,4 @@ --- -layout: docs title: Themes permalink: /docs/themes/ --- diff --git a/docs/_docs/troubleshooting.md b/docs/_docs/troubleshooting.md index 191953ec..aae024bd 100644 --- a/docs/_docs/troubleshooting.md +++ b/docs/_docs/troubleshooting.md @@ -1,5 +1,4 @@ --- -layout: docs title: Troubleshooting permalink: /docs/troubleshooting/ --- diff --git a/docs/_docs/upgrading/0-to-2.md b/docs/_docs/upgrading/0-to-2.md index 9de63455..5f9d2320 100644 --- a/docs/_docs/upgrading/0-to-2.md +++ b/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/ --- diff --git a/docs/_docs/upgrading/2-to-3.md b/docs/_docs/upgrading/2-to-3.md index 0d145b9c..a378d2f7 100644 --- a/docs/_docs/upgrading/2-to-3.md +++ b/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/ --- diff --git a/docs/_docs/usage.md b/docs/_docs/usage.md index e6f1a0db..c8860373 100644 --- a/docs/_docs/usage.md +++ b/docs/_docs/usage.md @@ -1,5 +1,4 @@ --- -layout: docs title: Basic Usage permalink: /docs/usage/ --- diff --git a/docs/_docs/variables.md b/docs/_docs/variables.md index 1d4e2091..f32bddd6 100644 --- a/docs/_docs/variables.md +++ b/docs/_docs/variables.md @@ -1,5 +1,4 @@ --- -layout: docs title: Variables permalink: /docs/variables/ --- diff --git a/docs/_docs/windows.md b/docs/_docs/windows.md index 8d7bb8bc..62fb69b4 100644 --- a/docs/_docs/windows.md +++ b/docs/_docs/windows.md @@ -1,5 +1,4 @@ --- -layout: docs title: Jekyll on Windows permalink: /docs/windows/ --- diff --git a/docs/_posts/2013-05-06-jekyll-1-0-0-released.markdown b/docs/_posts/2013-05-06-jekyll-1-0-0-released.markdown index 538cb565..ae5d3f9c 100644 --- a/docs/_posts/2013-05-06-jekyll-1-0-0-released.markdown +++ b/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 diff --git a/docs/_posts/2013-05-08-jekyll-1-0-1-released.markdown b/docs/_posts/2013-05-08-jekyll-1-0-1-released.markdown index 90edcc26..5b7a2c35 100644 --- a/docs/_posts/2013-05-08-jekyll-1-0-1-released.markdown +++ b/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 diff --git a/docs/_posts/2013-05-12-jekyll-1-0-2-released.markdown b/docs/_posts/2013-05-12-jekyll-1-0-2-released.markdown index 2a2b97e6..e5466362 100644 --- a/docs/_posts/2013-05-12-jekyll-1-0-2-released.markdown +++ b/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 diff --git a/docs/_posts/2013-06-07-jekyll-1-0-3-released.markdown b/docs/_posts/2013-06-07-jekyll-1-0-3-released.markdown index 566ae668..88f8ad41 100644 --- a/docs/_posts/2013-06-07-jekyll-1-0-3-released.markdown +++ b/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 diff --git a/docs/_posts/2013-07-14-jekyll-1-1-0-released.markdown b/docs/_posts/2013-07-14-jekyll-1-1-0-released.markdown index 12b3d921..8d00b98b 100644 --- a/docs/_posts/2013-07-14-jekyll-1-1-0-released.markdown +++ b/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 diff --git a/docs/_posts/2013-07-24-jekyll-1-1-1-released.markdown b/docs/_posts/2013-07-24-jekyll-1-1-1-released.markdown index 6741a89e..90b81847 100644 --- a/docs/_posts/2013-07-24-jekyll-1-1-1-released.markdown +++ b/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 diff --git a/docs/_posts/2013-07-25-jekyll-1-0-4-released.markdown b/docs/_posts/2013-07-25-jekyll-1-0-4-released.markdown index 635d0e6c..2e234c0e 100644 --- a/docs/_posts/2013-07-25-jekyll-1-0-4-released.markdown +++ b/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- diff --git a/docs/_posts/2013-07-25-jekyll-1-1-2-released.markdown b/docs/_posts/2013-07-25-jekyll-1-1-2-released.markdown index ed16ca71..f308ca12 100644 --- a/docs/_posts/2013-07-25-jekyll-1-1-2-released.markdown +++ b/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 diff --git a/docs/_posts/2013-09-06-jekyll-1-2-0-released.markdown b/docs/_posts/2013-09-06-jekyll-1-2-0-released.markdown index ae5448c2..76090527 100644 --- a/docs/_posts/2013-09-06-jekyll-1-2-0-released.markdown +++ b/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 diff --git a/docs/_posts/2013-09-14-jekyll-1-2-1-released.markdown b/docs/_posts/2013-09-14-jekyll-1-2-1-released.markdown index 832dbd06..5f759e20 100644 --- a/docs/_posts/2013-09-14-jekyll-1-2-1-released.markdown +++ b/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 diff --git a/docs/_posts/2013-10-28-jekyll-1-3-0-rc1-released.markdown b/docs/_posts/2013-10-28-jekyll-1-3-0-rc1-released.markdown index 1e3e44ce..65e98700 100644 --- a/docs/_posts/2013-10-28-jekyll-1-3-0-rc1-released.markdown +++ b/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- diff --git a/docs/_posts/2013-11-04-jekyll-1-3-0-released.markdown b/docs/_posts/2013-11-04-jekyll-1-3-0-released.markdown index 1e325117..f70408cd 100644 --- a/docs/_posts/2013-11-04-jekyll-1-3-0-released.markdown +++ b/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- diff --git a/docs/_posts/2013-11-26-jekyll-1-3-1-released.markdown b/docs/_posts/2013-11-26-jekyll-1-3-1-released.markdown index 4b4c37d5..baf8dea0 100644 --- a/docs/_posts/2013-11-26-jekyll-1-3-1-released.markdown +++ b/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- diff --git a/docs/_posts/2013-12-07-jekyll-1-4-0-released.markdown b/docs/_posts/2013-12-07-jekyll-1-4-0-released.markdown index d7a0c14f..1b9d4b7a 100644 --- a/docs/_posts/2013-12-07-jekyll-1-4-0-released.markdown +++ b/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- diff --git a/docs/_posts/2013-12-09-jekyll-1-4-1-released.markdown b/docs/_posts/2013-12-09-jekyll-1-4-1-released.markdown index 63407158..9d754857 100644 --- a/docs/_posts/2013-12-09-jekyll-1-4-1-released.markdown +++ b/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- diff --git a/docs/_posts/2013-12-16-jekyll-1-4-2-released.markdown b/docs/_posts/2013-12-16-jekyll-1-4-2-released.markdown index afc92147..e4329adc 100644 --- a/docs/_posts/2013-12-16-jekyll-1-4-2-released.markdown +++ b/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 diff --git a/docs/_posts/2014-01-13-jekyll-1-4-3-released.markdown b/docs/_posts/2014-01-13-jekyll-1-4-3-released.markdown index a97bcec4..8338ffb6 100644 --- a/docs/_posts/2014-01-13-jekyll-1-4-3-released.markdown +++ b/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 diff --git a/docs/_posts/2014-03-24-jekyll-1-5-0-released.markdown b/docs/_posts/2014-03-24-jekyll-1-5-0-released.markdown index 5b103dc2..717424ab 100644 --- a/docs/_posts/2014-03-24-jekyll-1-5-0-released.markdown +++ b/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 diff --git a/docs/_posts/2014-03-27-jekyll-1-5-1-released.markdown b/docs/_posts/2014-03-27-jekyll-1-5-1-released.markdown index e8a4096a..2105ad4d 100644 --- a/docs/_posts/2014-03-27-jekyll-1-5-1-released.markdown +++ b/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 diff --git a/docs/_posts/2014-05-06-jekyll-turns-2-0-0.markdown b/docs/_posts/2014-05-06-jekyll-turns-2-0-0.markdown index 82555514..af2a6774 100644 --- a/docs/_posts/2014-05-06-jekyll-turns-2-0-0.markdown +++ b/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 diff --git a/docs/_posts/2014-05-08-jekyll-2-0-3-released.markdown b/docs/_posts/2014-05-08-jekyll-2-0-3-released.markdown index ac5e9d75..e98e32c8 100644 --- a/docs/_posts/2014-05-08-jekyll-2-0-3-released.markdown +++ b/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 diff --git a/docs/_posts/2014-06-04-jekyll-stickers-1-dollar-stickermule.markdown b/docs/_posts/2014-06-04-jekyll-stickers-1-dollar-stickermule.markdown index 5ba126d2..8ef37c54 100644 --- a/docs/_posts/2014-06-04-jekyll-stickers-1-dollar-stickermule.markdown +++ b/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 diff --git a/docs/_posts/2014-06-28-jekyll-turns-21-i-mean-2-1-0.markdown b/docs/_posts/2014-06-28-jekyll-turns-21-i-mean-2-1-0.markdown index 82d01a18..c3fd4bb6 100644 --- a/docs/_posts/2014-06-28-jekyll-turns-21-i-mean-2-1-0.markdown +++ b/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 diff --git a/docs/_posts/2014-07-01-jekyll-2-1-1-released.markdown b/docs/_posts/2014-07-01-jekyll-2-1-1-released.markdown index 81423539..c73a055d 100644 --- a/docs/_posts/2014-07-01-jekyll-2-1-1-released.markdown +++ b/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 diff --git a/docs/_posts/2014-07-29-jekyll-2-2-0-released.markdown b/docs/_posts/2014-07-29-jekyll-2-2-0-released.markdown index ca7aee48..6b726f17 100644 --- a/docs/_posts/2014-07-29-jekyll-2-2-0-released.markdown +++ b/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 diff --git a/docs/_posts/2014-08-10-jekyll-2-3-0-released.markdown b/docs/_posts/2014-08-10-jekyll-2-3-0-released.markdown index 63fe2b45..07afc3c0 100644 --- a/docs/_posts/2014-08-10-jekyll-2-3-0-released.markdown +++ b/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 diff --git a/docs/_posts/2014-09-09-jekyll-2-4-0-released.markdown b/docs/_posts/2014-09-09-jekyll-2-4-0-released.markdown index e8dda676..11cb738e 100644 --- a/docs/_posts/2014-09-09-jekyll-2-4-0-released.markdown +++ b/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 diff --git a/docs/_posts/2014-11-06-jekylls-midlife-crisis-jekyll-turns-2-5-0.markdown b/docs/_posts/2014-11-06-jekylls-midlife-crisis-jekyll-turns-2-5-0.markdown index cc5de7c0..012b6155 100644 --- a/docs/_posts/2014-11-06-jekylls-midlife-crisis-jekyll-turns-2-5-0.markdown +++ b/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 diff --git a/docs/_posts/2014-11-08-jekyll-2-5-1-released.markdown b/docs/_posts/2014-11-08-jekyll-2-5-1-released.markdown index 3237e48d..2f6e3b51 100644 --- a/docs/_posts/2014-11-08-jekyll-2-5-1-released.markdown +++ b/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 diff --git a/docs/_posts/2014-11-12-jekyll-2-5-2-released.markdown b/docs/_posts/2014-11-12-jekyll-2-5-2-released.markdown index 3eab8998..cff18248 100644 --- a/docs/_posts/2014-11-12-jekyll-2-5-2-released.markdown +++ b/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 diff --git a/docs/_posts/2014-12-17-alfredxing-welcome-to-jekyll-core.md b/docs/_posts/2014-12-17-alfredxing-welcome-to-jekyll-core.md index 1951f0a4..51f55028 100644 --- a/docs/_posts/2014-12-17-alfredxing-welcome-to-jekyll-core.md +++ b/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 diff --git a/docs/_posts/2014-12-22-jekyll-2-5-3-released.markdown b/docs/_posts/2014-12-22-jekyll-2-5-3-released.markdown index 7743fd8e..491007cd 100644 --- a/docs/_posts/2014-12-22-jekyll-2-5-3-released.markdown +++ b/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 diff --git a/docs/_posts/2015-01-20-jekyll-meet-and-greet.markdown b/docs/_posts/2015-01-20-jekyll-meet-and-greet.markdown index ed273f9d..eee8d5e7 100644 --- a/docs/_posts/2015-01-20-jekyll-meet-and-greet.markdown +++ b/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 diff --git a/docs/_posts/2015-01-24-jekyll-3-0-0-beta1-released.markdown b/docs/_posts/2015-01-24-jekyll-3-0-0-beta1-released.markdown index 9ba83b04..c63f184b 100644 --- a/docs/_posts/2015-01-24-jekyll-3-0-0-beta1-released.markdown +++ b/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 diff --git a/docs/_posts/2015-02-26-introducing-jekyll-talk.markdown b/docs/_posts/2015-02-26-introducing-jekyll-talk.markdown index 90863c12..468ae4c8 100644 --- a/docs/_posts/2015-02-26-introducing-jekyll-talk.markdown +++ b/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! \ No newline at end of file +Come join the fun! diff --git a/docs/_posts/2015-10-26-jekyll-3-0-released.markdown b/docs/_posts/2015-10-26-jekyll-3-0-released.markdown index e7cf9db4..37d075c4 100644 --- a/docs/_posts/2015-10-26-jekyll-3-0-released.markdown +++ b/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 diff --git a/docs/_posts/2015-11-17-jekyll-3-0-1-released.markdown b/docs/_posts/2015-11-17-jekyll-3-0-1-released.markdown index 71412c6b..3eb3cb71 100644 --- a/docs/_posts/2015-11-17-jekyll-3-0-1-released.markdown +++ b/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 diff --git a/docs/_posts/2016-01-20-jekyll-3-0-2-released.markdown b/docs/_posts/2016-01-20-jekyll-3-0-2-released.markdown index 88f8888f..c12cde34 100644 --- a/docs/_posts/2016-01-20-jekyll-3-0-2-released.markdown +++ b/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 diff --git a/docs/_posts/2016-01-24-jekyll-3-1-0-released.markdown b/docs/_posts/2016-01-24-jekyll-3-1-0-released.markdown index 42768b9f..7e91aa1d 100644 --- a/docs/_posts/2016-01-24-jekyll-3-1-0-released.markdown +++ b/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 diff --git a/docs/_posts/2016-01-28-jekyll-3-1-1-released.markdown b/docs/_posts/2016-01-28-jekyll-3-1-1-released.markdown index b5932b0a..cddfbf26 100644 --- a/docs/_posts/2016-01-28-jekyll-3-1-1-released.markdown +++ b/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 diff --git a/docs/_posts/2016-02-08-jekyll-3-0-3-released.markdown b/docs/_posts/2016-02-08-jekyll-3-0-3-released.markdown index 0c260cc6..442dfeb9 100644 --- a/docs/_posts/2016-02-08-jekyll-3-0-3-released.markdown +++ b/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 diff --git a/docs/_posts/2016-02-19-jekyll-3-1-2-released.markdown b/docs/_posts/2016-02-19-jekyll-3-1-2-released.markdown index 77544510..807621f6 100644 --- a/docs/_posts/2016-02-19-jekyll-3-1-2-released.markdown +++ b/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 diff --git a/docs/_posts/2016-03-10-making-it-easier-to-contribute-to-jekyll.md b/docs/_posts/2016-03-10-making-it-easier-to-contribute-to-jekyll.md index d735b682..9d806049 100644 --- a/docs/_posts/2016-03-10-making-it-easier-to-contribute-to-jekyll.md +++ b/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] --- diff --git a/docs/_posts/2016-04-19-jekyll-3-0-4-released.markdown b/docs/_posts/2016-04-19-jekyll-3-0-4-released.markdown index d2cc4ec6..9aa9b822 100644 --- a/docs/_posts/2016-04-19-jekyll-3-0-4-released.markdown +++ b/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 diff --git a/docs/_posts/2016-04-19-jekyll-3-1-3-released.markdown b/docs/_posts/2016-04-19-jekyll-3-1-3-released.markdown index cd478e22..6b0892ac 100644 --- a/docs/_posts/2016-04-19-jekyll-3-1-3-released.markdown +++ b/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! - diff --git a/docs/_posts/2016-04-26-jekyll-3-0-5-released.markdown b/docs/_posts/2016-04-26-jekyll-3-0-5-released.markdown index 9696713a..5ac21545 100644 --- a/docs/_posts/2016-04-26-jekyll-3-0-5-released.markdown +++ b/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 diff --git a/docs/_posts/2016-05-18-jekyll-3-1-4-released.markdown b/docs/_posts/2016-05-18-jekyll-3-1-4-released.markdown index 161d4746..738fc12e 100644 --- a/docs/_posts/2016-05-18-jekyll-3-1-4-released.markdown +++ b/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 diff --git a/docs/_posts/2016-05-18-jekyll-3-1-5-released.markdown b/docs/_posts/2016-05-18-jekyll-3-1-5-released.markdown index c341b37b..0ca981a6 100644 --- a/docs/_posts/2016-05-18-jekyll-3-1-5-released.markdown +++ b/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 diff --git a/docs/_posts/2016-05-19-jekyll-3-1-6-released.markdown b/docs/_posts/2016-05-19-jekyll-3-1-6-released.markdown index 45e7312f..e31951eb 100644 --- a/docs/_posts/2016-05-19-jekyll-3-1-6-released.markdown +++ b/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 diff --git a/docs/_posts/2016-06-03-update-on-jekyll-s-google-summer-of-code-projects.markdown b/docs/_posts/2016-06-03-update-on-jekyll-s-google-summer-of-code-projects.markdown index 0f4ce2de..c3d01cdd 100644 --- a/docs/_posts/2016-06-03-update-on-jekyll-s-google-summer-of-code-projects.markdown +++ b/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 diff --git a/docs/_posts/2016-07-26-jekyll-3-2-0-released.markdown b/docs/_posts/2016-07-26-jekyll-3-2-0-released.markdown index 2e62cc32..4cf4b6f7 100644 --- a/docs/_posts/2016-07-26-jekyll-3-2-0-released.markdown +++ b/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 diff --git a/docs/_posts/2016-08-02-jekyll-3-2-1-released.markdown b/docs/_posts/2016-08-02-jekyll-3-2-1-released.markdown index f4d17e04..f2bdaec8 100644 --- a/docs/_posts/2016-08-02-jekyll-3-2-1-released.markdown +++ b/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 diff --git a/docs/_posts/2016-08-24-jekyll-admin-initial-release.markdown b/docs/_posts/2016-08-24-jekyll-admin-initial-release.markdown index 1f6fa154..e256a5c7 100644 --- a/docs/_posts/2016-08-24-jekyll-admin-initial-release.markdown +++ b/docs/_posts/2016-08-24-jekyll-admin-initial-release.markdown @@ -1,5 +1,4 @@ --- -layout: news_item title: "Jekyll Admin Initial Release" date: "2016-08-25 09:50:00 +0300" author: mertkahyaoglu diff --git a/docs/_posts/2016-10-06-jekyll-3-3-is-here.md b/docs/_posts/2016-10-06-jekyll-3-3-is-here.md index 0b51e31e..8c756ef7 100644 --- a/docs/_posts/2016-10-06-jekyll-3-3-is-here.md +++ b/docs/_posts/2016-10-06-jekyll-3-3-is-here.md @@ -1,5 +1,4 @@ --- -layout: news_item title: 'Jekyll 3.3 is here with better theme support, new URL filters, and tons more' date: 2016-10-06 11:10:38 -0700 author: parkr diff --git a/docs/_posts/2016-11-14-jekyll-3-3-1-released.markdown b/docs/_posts/2016-11-14-jekyll-3-3-1-released.markdown index a5a88376..0a357ea2 100644 --- a/docs/_posts/2016-11-14-jekyll-3-3-1-released.markdown +++ b/docs/_posts/2016-11-14-jekyll-3-3-1-released.markdown @@ -1,5 +1,4 @@ --- -layout: news_item title: 'Jekyll 3.3.1 Released' date: 2016-11-14 14:29:59 -0800 author: parkr diff --git a/rake/site.rake b/rake/site.rake index 51978aed..2fb4172a 100644 --- a/rake/site.rake +++ b/rake/site.rake @@ -92,7 +92,6 @@ namespace :site do File.open(filename, "wb") do |post| post.puts("---") - post.puts("layout: news_item") post.puts("title: 'Jekyll #{release} Released'") post.puts("date: #{Time.new.strftime('%Y-%m-%d %H:%M:%S %z')}") post.puts("author: ") From 0c9c236c4863c996043d7eed068a324d4e421bf9 Mon Sep 17 00:00:00 2001 From: Frank Taillandier Date: Mon, 9 Jan 2017 21:31:57 +0100 Subject: [PATCH 28/90] rubocup -a --- Rakefile | 68 ++++++++++++++++++++++++++++++-------------------------- 1 file changed, 36 insertions(+), 32 deletions(-) diff --git a/Rakefile b/Rakefile index 58aecfaf..5353717e 100644 --- a/Rakefile +++ b/Rakefile @@ -1,13 +1,13 @@ -require 'rubygems' -require 'rake' -require 'rdoc' -require 'date' -require 'yaml' +require "rubygems" +require "rake" +require "rdoc" +require "date" +require "yaml" -$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), *%w[lib])) -require 'jekyll/version' +$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "lib")) +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}/ - section_regexp = /^### \w+ \w+$/ - markdown.split(/^##\s/).map do |release_notes| + header_regexp = %r!^(\d{1,2})\.(\d{1,2})\.(\d{1,2}) \/ \d{4}-\d{2}-\d{2}! + section_regexp = %r!^### \w+ \w+$! + 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,13 +88,17 @@ 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 @@ -115,7 +119,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 +132,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.pattern = 'test/**/test_*.rb' + test.libs << "lib" << "test" + 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('lib/**/*.rb') + rdoc.rdoc_files.include("README*") + 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 +156,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 From 8bf9c37cf5f03fe6975f462531959d4bc5978a5b Mon Sep 17 00:00:00 2001 From: Frank Taillandier Date: Mon, 9 Jan 2017 21:32:11 +0100 Subject: [PATCH 29/90] rubocop -a --- jekyll.gemspec | 52 +++++++++++++++++++++++++------------------------- 1 file changed, 26 insertions(+), 26 deletions(-) diff --git a/jekyll.gemspec b/jekyll.gemspec index 734df2e4..ca12fa0d 100644 --- a/jekyll.gemspec +++ b/jekyll.gemspec @@ -1,42 +1,42 @@ # coding: utf-8 -lib = File.expand_path('../lib', __FILE__) +lib = File.expand_path("../lib", __FILE__) $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib) -require 'jekyll/version' +require "jekyll/version" Gem::Specification.new do |s| s.specification_version = 2 if s.respond_to? :specification_version= - s.required_rubygems_version = Gem::Requirement.new('>= 0') if s.respond_to? :required_rubygems_version= - s.rubygems_version = '2.2.2' - s.required_ruby_version = '>= 2.0.0' + s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version= + s.rubygems_version = "2.2.2" + s.required_ruby_version = ">= 2.0.0" - s.name = 'jekyll' + s.name = "jekyll" s.version = Jekyll::VERSION - s.license = 'MIT' + s.license = "MIT" - s.summary = 'A simple, blog aware, static site generator.' - s.description = 'Jekyll is a simple, blog aware, static site generator.' + s.summary = "A simple, blog aware, static site generator." + s.description = "Jekyll is a simple, blog aware, static site generator." - s.authors = ['Tom Preston-Werner'] - s.email = 'tom@mojombo.com' - s.homepage = 'https://github.com/jekyll/jekyll' + s.authors = ["Tom Preston-Werner"] + s.email = "tom@mojombo.com" + s.homepage = "https://github.com/jekyll/jekyll" all_files = `git ls-files -z`.split("\x0") - s.files = all_files.grep(%r{^(exe|lib)/|^.rubocop.yml$}) - s.executables = all_files.grep(%r{^exe/}) { |f| File.basename(f) } + s.files = all_files.grep(%r!^(exe|lib)/|^.rubocop.yml$!) + s.executables = all_files.grep(%r!^exe/!) { |f| File.basename(f) } s.bindir = "exe" - s.require_paths = ['lib'] + s.require_paths = ["lib"] - s.rdoc_options = ['--charset=UTF-8'] - s.extra_rdoc_files = %w[README.markdown LICENSE] + s.rdoc_options = ["--charset=UTF-8"] + s.extra_rdoc_files = %w(README.markdown LICENSE) - s.add_runtime_dependency('liquid', '~> 3.0') - s.add_runtime_dependency('kramdown', '~> 1.3') - s.add_runtime_dependency('mercenary', '~> 0.3.3') - s.add_runtime_dependency('safe_yaml', '~> 1.0') - s.add_runtime_dependency('colorator', '~> 1.0') - s.add_runtime_dependency('rouge', '~> 1.7') - s.add_runtime_dependency('jekyll-sass-converter', '~> 1.0') - s.add_runtime_dependency('jekyll-watch', '~> 1.1') + s.add_runtime_dependency("liquid", "~> 3.0") + s.add_runtime_dependency("kramdown", "~> 1.3") + s.add_runtime_dependency("mercenary", "~> 0.3.3") + s.add_runtime_dependency("safe_yaml", "~> 1.0") + s.add_runtime_dependency("colorator", "~> 1.0") + s.add_runtime_dependency("rouge", "~> 1.7") + s.add_runtime_dependency("jekyll-sass-converter", "~> 1.0") + s.add_runtime_dependency("jekyll-watch", "~> 1.1") s.add_runtime_dependency("pathutil", "~> 0.9") - s.add_runtime_dependency('addressable', '~> 2.4') + s.add_runtime_dependency("addressable", "~> 2.4") end From 10b96b26bc82bfbedfe4be4a3914b50b4532fb6e Mon Sep 17 00:00:00 2001 From: Frank Taillandier Date: Mon, 9 Jan 2017 21:39:19 +0100 Subject: [PATCH 30/90] Sort dependencies --- jekyll.gemspec | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/jekyll.gemspec b/jekyll.gemspec index 734df2e4..b36bed9f 100644 --- a/jekyll.gemspec +++ b/jekyll.gemspec @@ -29,14 +29,14 @@ Gem::Specification.new do |s| s.rdoc_options = ['--charset=UTF-8'] s.extra_rdoc_files = %w[README.markdown LICENSE] - s.add_runtime_dependency('liquid', '~> 3.0') - s.add_runtime_dependency('kramdown', '~> 1.3') - s.add_runtime_dependency('mercenary', '~> 0.3.3') - s.add_runtime_dependency('safe_yaml', '~> 1.0') - s.add_runtime_dependency('colorator', '~> 1.0') - s.add_runtime_dependency('rouge', '~> 1.7') - s.add_runtime_dependency('jekyll-sass-converter', '~> 1.0') - s.add_runtime_dependency('jekyll-watch', '~> 1.1') + s.add_runtime_dependency("addressable", "~> 2.4") + s.add_runtime_dependency("colorator", "~> 1.0") + s.add_runtime_dependency("jekyll-sass-converter", "~> 1.0") + s.add_runtime_dependency("jekyll-watch", "~> 1.1") + s.add_runtime_dependency("kramdown", "~> 1.3") + s.add_runtime_dependency("liquid", "~> 3.0") + s.add_runtime_dependency("mercenary", "~> 0.3.3") s.add_runtime_dependency("pathutil", "~> 0.9") - s.add_runtime_dependency('addressable', '~> 2.4') + s.add_runtime_dependency("rouge", "~> 1.7") + s.add_runtime_dependency("safe_yaml", "~> 1.0") end From 335d9b3881fc5f8ef6ebf5ce3a392d9c80420e4b Mon Sep 17 00:00:00 2001 From: Frank Taillandier Date: Mon, 9 Jan 2017 21:39:42 +0100 Subject: [PATCH 31/90] sort gems --- docs/_config.yml | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/_config.yml b/docs/_config.yml index 32ae74bb..cc7476e2 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -28,14 +28,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 From fb83ebadf61326bb628d6baa72b8db7711db6e6d Mon Sep 17 00:00:00 2001 From: jekyllbot Date: Mon, 9 Jan 2017 14:10:03 -0800 Subject: [PATCH 32/90] Update history to reflect merge of #5745 [ci skip] --- History.markdown | 1 + 1 file changed, 1 insertion(+) diff --git a/History.markdown b/History.markdown index b578b9bf..d5891406 100644 --- a/History.markdown +++ b/History.markdown @@ -41,6 +41,7 @@ * Bump to rake 12.0 (#5670) * Rubocop Gemfile (#5671) * update Classifier-Reborn to 2.1.0 (#5711) + * Rubocop: fix Rakefile and gemspec (#5745) ### Documentation From 47550935cb63d9432bb773fdd9e96ed926058e8d Mon Sep 17 00:00:00 2001 From: jekyllbot Date: Mon, 9 Jan 2017 14:14:03 -0800 Subject: [PATCH 33/90] Update history to reflect merge of #5725 [ci skip] --- History.markdown | 1 + 1 file changed, 1 insertion(+) diff --git a/History.markdown b/History.markdown index d5891406..8ff70c6b 100644 --- a/History.markdown +++ b/History.markdown @@ -42,6 +42,7 @@ * Rubocop Gemfile (#5671) * update Classifier-Reborn to 2.1.0 (#5711) * Rubocop: fix Rakefile and gemspec (#5745) + * Use `assert_nil` (#5725) ### Documentation From 4ef69b948c4d903047e4992cc68e5dfbc15b5717 Mon Sep 17 00:00:00 2001 From: yoostk Date: Tue, 10 Jan 2017 15:03:46 +0900 Subject: [PATCH 34/90] Fix a minor grammatical mistake on themes' document --- docs/_docs/themes.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/_docs/themes.md b/docs/_docs/themes.md index c7d6d574..81a77d20 100644 --- a/docs/_docs/themes.md +++ b/docs/_docs/themes.md @@ -67,7 +67,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 From c48daa9d5b5768acdc0e30908844fc7ae604e1ef Mon Sep 17 00:00:00 2001 From: Frank Taillandier Date: Tue, 10 Jan 2017 10:34:16 +0100 Subject: [PATCH 35/90] normalize whitespace --- jekyll.gemspec | 19 +++++++++---------- 1 file changed, 9 insertions(+), 10 deletions(-) diff --git a/jekyll.gemspec b/jekyll.gemspec index 4ddac2fa..71b5f31e 100644 --- a/jekyll.gemspec +++ b/jekyll.gemspec @@ -29,15 +29,14 @@ Gem::Specification.new do |s| s.rdoc_options = ["--charset=UTF-8"] s.extra_rdoc_files = %w(README.markdown LICENSE) - s.add_runtime_dependency("addressable", "~> 2.4") - s.add_runtime_dependency("colorator", "~> 1.0") + s.add_runtime_dependency("addressable", "~> 2.4") + s.add_runtime_dependency("colorator", "~> 1.0") s.add_runtime_dependency("jekyll-sass-converter", "~> 1.0") - s.add_runtime_dependency("jekyll-watch", "~> 1.1") - s.add_runtime_dependency("kramdown", "~> 1.3") - s.add_runtime_dependency("liquid", "~> 3.0") - s.add_runtime_dependency("mercenary", "~> 0.3.3") - s.add_runtime_dependency("pathutil", "~> 0.9") - s.add_runtime_dependency("rouge", "~> 1.7") - s.add_runtime_dependency("safe_yaml", "~> 1.0") - + s.add_runtime_dependency("jekyll-watch", "~> 1.1") + s.add_runtime_dependency("kramdown", "~> 1.3") + s.add_runtime_dependency("liquid", "~> 3.0") + s.add_runtime_dependency("mercenary", "~> 0.3.3") + s.add_runtime_dependency("pathutil", "~> 0.9") + s.add_runtime_dependency("rouge", "~> 1.7") + s.add_runtime_dependency("safe_yaml", "~> 1.0") end From f785d6f8d14ffb65588f4536a2ddc86bf8b3b6dc Mon Sep 17 00:00:00 2001 From: jekyllbot Date: Tue, 10 Jan 2017 01:45:46 -0800 Subject: [PATCH 36/90] Update history to reflect merge of #5748 [ci skip] --- History.markdown | 1 + 1 file changed, 1 insertion(+) diff --git a/History.markdown b/History.markdown index 8ff70c6b..de38e96d 100644 --- a/History.markdown +++ b/History.markdown @@ -60,6 +60,7 @@ * 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 (#5748) ## 3.3.1 / 2016-11-14 From 0210022c757e6d931db508e160217c2088a39e64 Mon Sep 17 00:00:00 2001 From: jekyllbot Date: Tue, 10 Jan 2017 01:46:18 -0800 Subject: [PATCH 37/90] Update history to reflect merge of #5746 [ci skip] --- History.markdown | 1 + 1 file changed, 1 insertion(+) diff --git a/History.markdown b/History.markdown index de38e96d..61315abe 100644 --- a/History.markdown +++ b/History.markdown @@ -24,6 +24,7 @@ * Use the current year for the LICENSE of theme (#5712) * Update License (#5713) * Use Addressable instead of URI to decode (#5726) + * Sort gems (#5746) ### Bug Fixes From faa67bcd62e3d55e07301c86f95d77267fe2082a Mon Sep 17 00:00:00 2001 From: Parker Moore Date: Tue, 10 Jan 2017 12:12:55 -0500 Subject: [PATCH 38/90] include: fix 'no implicit conversion of nil to String' This is when either 'dir' or 'file' is nil. --- lib/jekyll/tags/include.rb | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/lib/jekyll/tags/include.rb b/lib/jekyll/tags/include.rb index 67461750..cf052197 100644 --- a/lib/jekyll/tags/include.rb +++ b/lib/jekyll/tags/include.rb @@ -112,8 +112,8 @@ eos def locate_include_file(context, file, safe) includes_dirs = tag_includes_dirs(context) includes_dirs.each do |dir| - path = File.join(dir, file) - return path if valid_include_file?(path, dir, safe) + path = File.join(dir.to_s, file.to_s) + return path if valid_include_file?(path, dir.to_s, safe) end raise IOError, "Could not locate the included file '#{file}' in any of "\ "#{includes_dirs}. Ensure it exists in one of those directories and, "\ @@ -163,7 +163,7 @@ eos end def valid_include_file?(path, dir, safe) - !(outside_site_source?(path, dir, safe) || !File.exist?(path)) + !(outside_site_source?(path, dir, safe) || !File.file?(path)) end def outside_site_source?(path, dir, safe) From 22368896fb6776766e82b746fb96bb55fcbbdd0d Mon Sep 17 00:00:00 2001 From: Parker Moore Date: Tue, 10 Jan 2017 12:17:42 -0500 Subject: [PATCH 39/90] Rearrange some pieces of History.markdown. --- History.markdown | 33 +++++++++++++++++---------------- 1 file changed, 17 insertions(+), 16 deletions(-) diff --git a/History.markdown b/History.markdown index 61315abe..887a2165 100644 --- a/History.markdown +++ b/History.markdown @@ -1,5 +1,20 @@ ## 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) + +### 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) + ### Site Enhancements * Remove instructions to install Jekyll 2 on Windows (#5582) @@ -16,22 +31,7 @@ * Add Jekyll-Post to list of plugins (#5705) * Add jekyll-numbered-headings (#5688) * Docs: move permalinks from documents into config (#5544) - -### 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) - * Sort gems (#5746) - -### 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) + * Sort gems in `docs/_config.yml` (#5746) ### Development Fixes @@ -44,6 +44,7 @@ * update Classifier-Reborn to 2.1.0 (#5711) * Rubocop: fix Rakefile and gemspec (#5745) * Use `assert_nil` (#5725) + * Sort gems in `jekyll.gemspec` (#5746) ### Documentation From 4f84b522b518d51864917fd1a70bbbc455039ac0 Mon Sep 17 00:00:00 2001 From: jekyllbot Date: Tue, 10 Jan 2017 12:05:59 -0800 Subject: [PATCH 40/90] Update history to reflect merge of #5621 [ci skip] --- History.markdown | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/History.markdown b/History.markdown index 887a2165..d7950127 100644 --- a/History.markdown +++ b/History.markdown @@ -64,6 +64,10 @@ * Addition of a sample "typical post" (#5473) * Fix a minor grammatical mistake on themes' document (#5748) +### -dev + + * Correct comments in data_reader.rb (#5621) + ## 3.3.1 / 2016-11-14 ### Minor Enhancements From c198b08ee87f7441eaf0ddc8a23014553860e3c8 Mon Sep 17 00:00:00 2001 From: Max Chadwick Date: Tue, 10 Jan 2017 22:50:30 -0500 Subject: [PATCH 41/90] Add jekyll-pre-commit to plugins list --- docs/_docs/plugins.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/_docs/plugins.md b/docs/_docs/plugins.md index 4a5e61cf..05fe1434 100644 --- a/docs/_docs/plugins.md +++ b/docs/_docs/plugins.md @@ -919,6 +919,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 From 07d161c2ce8707d7320fbaf09af898e075f4a240 Mon Sep 17 00:00:00 2001 From: jekyllbot Date: Wed, 11 Jan 2017 01:42:10 -0800 Subject: [PATCH 42/90] Update history to reflect merge of #5752 [ci skip] --- History.markdown | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/History.markdown b/History.markdown index d7950127..2d769ba8 100644 --- a/History.markdown +++ b/History.markdown @@ -62,11 +62,9 @@ * 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 (#5748) - -### -dev - + * 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) ## 3.3.1 / 2016-11-14 From d77ed5e608254123c6d0d0850338e6193ef38d84 Mon Sep 17 00:00:00 2001 From: Frank Taillandier Date: Wed, 11 Jan 2017 10:49:21 +0100 Subject: [PATCH 43/90] Add missing merge labels for jekyllbot --- docs/_docs/maintaining/merging-a-pull-request.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/_docs/maintaining/merging-a-pull-request.md b/docs/_docs/maintaining/merging-a-pull-request.md index 80ad6f7c..c7efe0b5 100644 --- a/docs/_docs/maintaining/merging-a-pull-request.md +++ b/docs/_docs/maintaining/merging-a-pull-request.md @@ -38,8 +38,9 @@ The categories match the H3's in the history/changelog file, and they are: 1. Major Enhancements (`+major`) – major updates or breaking changes to the code which necessitate a major version bump (v3 ~> v4) 2. Minor Enhancements (`+minor`) – minor updates (feature, enhancement) which necessitate a minor version bump (v3.1 ~> v3.2) 3. Bug Fixes (`+bug`) – corrections to code which do not change or add functionality, which necessitate a patch version bump (v3.1.0 ~> v3.1.1) -4. Site Enhancements (`+site`) – changes to the source of https://jekyllrb.com, found in `site/` +4. Site Enhancements (`+site` or `+doc`) – changes to the source or the documentation found in `docs/` and published on https://jekyllrb.com, 5. Development Fixes (`+dev`) – changes which do not affect user-facing functionality or documentation, such as test fixes or bumping internal dependencies +6. Forward Ports (`+port`) — forward-port changes, e.g. from v3.1.4. Once @jekyllbot has merged the pull request, you should see three things: From 02858fdf089bce0e4bb7901ef8e5b13d61e91c01 Mon Sep 17 00:00:00 2001 From: Parker Moore Date: Wed, 11 Jan 2017 12:05:56 -0500 Subject: [PATCH 44/90] include: improve boolean logic in #valid_include_file? --- lib/jekyll/tags/include.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/jekyll/tags/include.rb b/lib/jekyll/tags/include.rb index cf052197..ca74087d 100644 --- a/lib/jekyll/tags/include.rb +++ b/lib/jekyll/tags/include.rb @@ -163,7 +163,7 @@ eos end def valid_include_file?(path, dir, safe) - !(outside_site_source?(path, dir, safe) || !File.file?(path)) + !outside_site_source?(path, dir, safe) && File.file?(path) end def outside_site_source?(path, dir, safe) From 8ae2673ebae7c9d2a7c75e3e3e95729cde04cdfc Mon Sep 17 00:00:00 2001 From: jekyllbot Date: Wed, 11 Jan 2017 09:13:39 -0800 Subject: [PATCH 45/90] Update history to reflect merge of #5744 [ci skip] --- History.markdown | 1 + 1 file changed, 1 insertion(+) diff --git a/History.markdown b/History.markdown index 2d769ba8..bb10365f 100644 --- a/History.markdown +++ b/History.markdown @@ -32,6 +32,7 @@ * Add jekyll-numbered-headings (#5688) * Docs: move permalinks from documents into config (#5544) * Sort gems in `docs/_config.yml` (#5746) + * [site] Use defaults for docs and news-items (#5744) ### Development Fixes From 538cff15e9a9d68d7bf6c5727b8592d3cccaf332 Mon Sep 17 00:00:00 2001 From: Frank Taillandier Date: Wed, 11 Jan 2017 20:57:34 +0100 Subject: [PATCH 46/90] report @parkr feedback --- docs/_docs/maintaining/merging-a-pull-request.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/_docs/maintaining/merging-a-pull-request.md b/docs/_docs/maintaining/merging-a-pull-request.md index c7efe0b5..ed34adf1 100644 --- a/docs/_docs/maintaining/merging-a-pull-request.md +++ b/docs/_docs/maintaining/merging-a-pull-request.md @@ -38,9 +38,10 @@ The categories match the H3's in the history/changelog file, and they are: 1. Major Enhancements (`+major`) – major updates or breaking changes to the code which necessitate a major version bump (v3 ~> v4) 2. Minor Enhancements (`+minor`) – minor updates (feature, enhancement) which necessitate a minor version bump (v3.1 ~> v3.2) 3. Bug Fixes (`+bug`) – corrections to code which do not change or add functionality, which necessitate a patch version bump (v3.1.0 ~> v3.1.1) -4. Site Enhancements (`+site` or `+doc`) – changes to the source or the documentation found in `docs/` and published on https://jekyllrb.com, -5. Development Fixes (`+dev`) – changes which do not affect user-facing functionality or documentation, such as test fixes or bumping internal dependencies -6. Forward Ports (`+port`) — forward-port changes, e.g. from v3.1.4. +4. Documentation (`+doc`) - changes to the documentation found in `docs/_docs/` +5. Site Enhancements (`+site`) – changes to the source of [https://jekyllrb.com](https://jekyllrb.com) found in `docs/` +6. Development Fixes (`+dev`) – changes which do not affect user-facing functionality or documentation, such as test fixes or bumping internal dependencies +7. Forward Ports (`+port`) — bug fixes applied to a previous version of Jekyll pulled onto `master`, e.g. cherry-picked commits from `3-1-stable` to `master` Once @jekyllbot has merged the pull request, you should see three things: From 2fc4fdfe79223d7869417efb8c26ededaedda06c Mon Sep 17 00:00:00 2001 From: BlueberryFoxtrot Date: Thu, 12 Jan 2017 17:39:21 +0100 Subject: [PATCH 47/90] Update quickstart.md --- docs/_docs/quickstart.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/_docs/quickstart.md b/docs/_docs/quickstart.md index 984275f7..e84f87be 100644 --- a/docs/_docs/quickstart.md +++ b/docs/_docs/quickstart.md @@ -3,7 +3,7 @@ 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/installation/#requirements/)), you can create a new Jekyll site by doing the following: +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: ```sh # Install Jekyll and Bundler gems through RubyGems @@ -21,6 +21,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: From 1d885911bce091a8d8f89df410896809ec6e8bd4 Mon Sep 17 00:00:00 2001 From: Pat Hawks Date: Thu, 12 Jan 2017 17:52:29 -0600 Subject: [PATCH 48/90] Rubocop: Require consistent comma in multiline literals --- .rubocop.yml | 2 + features/support/formatter.rb | 2 +- features/support/helpers.rb | 4 +- lib/jekyll/commands/doctor.rb | 2 +- lib/jekyll/commands/serve.rb | 12 +-- lib/jekyll/commands/serve/servlet.rb | 2 +- lib/jekyll/configuration.rb | 10 +- .../converters/markdown/kramdown_parser.rb | 2 +- .../converters/markdown/redcarpet_parser.rb | 2 +- lib/jekyll/document.rb | 6 +- lib/jekyll/drops/jekyll_drop.rb | 2 +- lib/jekyll/entry_filter.rb | 2 +- lib/jekyll/filters/grouping_filters.rb | 2 +- lib/jekyll/hooks.rb | 14 +-- lib/jekyll/log_adapter.rb | 2 +- lib/jekyll/page.rb | 4 +- lib/jekyll/plugin.rb | 2 +- lib/jekyll/readers/data_reader.rb | 2 +- lib/jekyll/readers/post_reader.rb | 2 +- lib/jekyll/regenerator.rb | 2 +- lib/jekyll/static_file.rb | 6 +- lib/jekyll/tags/highlight.rb | 4 +- lib/jekyll/theme_builder.rb | 2 +- lib/jekyll/utils/ansi.rb | 2 +- test/helper.rb | 12 +-- test/test_collections.rb | 18 ++-- test/test_commands_serve.rb | 12 +-- test/test_configuration.rb | 50 +++++----- test/test_doctor_command.rb | 4 +- test/test_document.rb | 94 +++++++++---------- test/test_drop.rb | 2 +- test/test_entry_filter.rb | 2 +- test/test_excerpt.rb | 4 +- test/test_filters.rb | 78 +++++++-------- test/test_front_matter_defaults.rb | 58 ++++++------ test/test_kramdown.rb | 24 ++--- test/test_layout_reader.rb | 2 +- test/test_liquid_renderer.rb | 2 +- test/test_page.rb | 6 +- test/test_plugin_manager.rb | 8 +- test/test_rdiscount.rb | 4 +- test/test_redcarpet.rb | 4 +- test/test_regenerator.rb | 12 +-- test/test_related_posts.rb | 2 +- test/test_sass.rb | 2 +- test/test_site.rb | 8 +- test/test_static_file.rb | 6 +- test/test_tags.rb | 54 +++++------ 48 files changed, 281 insertions(+), 279 deletions(-) diff --git a/.rubocop.yml b/.rubocop.yml index 0324c412..67f212ae 100644 --- a/.rubocop.yml +++ b/.rubocop.yml @@ -127,5 +127,7 @@ Style/StringLiterals: EnforcedStyle: double_quotes Style/StringLiteralsInInterpolation: EnforcedStyle: double_quotes +Style/TrailingCommaInLiteral: + EnforcedStyleForMultiline: consistent_comma Style/UnneededCapitalW: Enabled: false diff --git a/features/support/formatter.rb b/features/support/formatter.rb index 22237010..79d14664 100644 --- a/features/support/formatter.rb +++ b/features/support/formatter.rb @@ -16,7 +16,7 @@ module Jekyll :pending => "\u203D".yellow, :undefined => "\u2718".red, :passed => "\u2714".green, - :skipped => "\u203D".blue + :skipped => "\u203D".blue, }.freeze # diff --git a/features/support/helpers.rb b/features/support/helpers.rb index 1340808a..b8044a7c 100644 --- a/features/support/helpers.rb +++ b/features/support/helpers.rb @@ -142,7 +142,7 @@ def location(folder, direction) end [before || ".", - after || "."] + after || ".",] end # @@ -160,7 +160,7 @@ def seconds_agnostic_datetime(datetime = Time.now) [ Regexp.escape(date), "#{time}:\\d{2}", - Regexp.escape(zone) + Regexp.escape(zone), ] \ .join("\\ ") end diff --git a/lib/jekyll/commands/doctor.rb b/lib/jekyll/commands/doctor.rb index c7f387df..59004c96 100644 --- a/lib/jekyll/commands/doctor.rb +++ b/lib/jekyll/commands/doctor.rb @@ -35,7 +35,7 @@ module Jekyll fsnotify_buggy?(site), !deprecated_relative_permalinks(site), !conflicting_urls(site), - !urls_only_differ_by_case(site) + !urls_only_differ_by_case(site), ].all? end diff --git a/lib/jekyll/commands/serve.rb b/lib/jekyll/commands/serve.rb index e0da4807..16913595 100644 --- a/lib/jekyll/commands/serve.rb +++ b/lib/jekyll/commands/serve.rb @@ -10,9 +10,9 @@ module Jekyll "ssl_key" => ["--ssl-key [KEY]", "X.509 (SSL) Private Key."], "port" => ["-P", "--port [PORT]", "Port to listen on"], "show_dir_listing" => ["--show-dir-listing", - "Show a directory listing instead of loading your index file."], + "Show a directory listing instead of loading your index file.",], "skip_initial_build" => ["skip_initial_build", "--skip-initial-build", - "Skips the initial site build which occurs before the server is started."] + "Skips the initial site build which occurs before the server is started.",], }.freeze # @@ -88,7 +88,7 @@ module Jekyll index.rhtml index.cgi index.xml - ) + ), } opts[:DirectoryIndex] = [] if opts[:JekyllOptions]["show_dir_listing"] @@ -116,8 +116,8 @@ module Jekyll WEBrick::Config::FileHandler.merge({ :FancyIndexing => true, :NondisclosureName => [ - ".ht*", "~*" - ] + ".ht*", "~*", + ], }) end @@ -139,7 +139,7 @@ module Jekyll :prefix => ssl_enabled ? "https" : "http", :address => address, :port => port, - :baseurl => baseurl ? "#{baseurl}/" : "" + :baseurl => baseurl ? "#{baseurl}/" : "", }) end diff --git a/lib/jekyll/commands/serve/servlet.rb b/lib/jekyll/commands/serve/servlet.rb index d0dd22af..3ae5cf32 100644 --- a/lib/jekyll/commands/serve/servlet.rb +++ b/lib/jekyll/commands/serve/servlet.rb @@ -6,7 +6,7 @@ module Jekyll class Servlet < WEBrick::HTTPServlet::FileHandler DEFAULTS = { "Cache-Control" => "private, max-age=0, proxy-revalidate, " \ - "no-store, no-cache, must-revalidate" + "no-store, no-cache, must-revalidate", }.freeze def initialize(server, root, callbacks) diff --git a/lib/jekyll/configuration.rb b/lib/jekyll/configuration.rb index 8dc1807d..27e245e4 100644 --- a/lib/jekyll/configuration.rb +++ b/lib/jekyll/configuration.rb @@ -58,15 +58,15 @@ module Jekyll "defaults" => [], "liquid" => { - "error_mode" => "warn" + "error_mode" => "warn", }, "rdiscount" => { - "extensions" => [] + "extensions" => [], }, "redcarpet" => { - "extensions" => [] + "extensions" => [], }, "kramdown" => { @@ -76,8 +76,8 @@ module Jekyll "smart_quotes" => "lsquo,rsquo,ldquo,rdquo", "input" => "GFM", "hard_wrap" => false, - "footnote_nr" => 1 - } + "footnote_nr" => 1, + }, }.map { |k, v| [k, v.freeze] }].freeze class << self diff --git a/lib/jekyll/converters/markdown/kramdown_parser.rb b/lib/jekyll/converters/markdown/kramdown_parser.rb index dd71c6c1..a7252f1a 100644 --- a/lib/jekyll/converters/markdown/kramdown_parser.rb +++ b/lib/jekyll/converters/markdown/kramdown_parser.rb @@ -11,7 +11,7 @@ module Jekyll "line_numbers" => "inline", "line_number_start" => 1, "tab_width" => 4, - "wrap" => "div" + "wrap" => "div", }.freeze def initialize(config) diff --git a/lib/jekyll/converters/markdown/redcarpet_parser.rb b/lib/jekyll/converters/markdown/redcarpet_parser.rb index b5ec99f5..aa170feb 100644 --- a/lib/jekyll/converters/markdown/redcarpet_parser.rb +++ b/lib/jekyll/converters/markdown/redcarpet_parser.rb @@ -21,7 +21,7 @@ class Jekyll::Converters::Markdown::RedcarpetParser code, { :lexer => lang, - :options => { :encoding => "utf-8" } + :options => { :encoding => "utf-8" }, } ), lang diff --git a/lib/jekyll/document.rb b/lib/jekyll/document.rb index ad5884ef..fecd5828 100644 --- a/lib/jekyll/document.rb +++ b/lib/jekyll/document.rb @@ -196,7 +196,7 @@ module Jekyll @url = URL.new({ :template => url_template, :placeholders => url_placeholders, - :permalink => permalink + :permalink => permalink, }).to_s end @@ -469,14 +469,14 @@ module Jekyll "category", "categories" ) - ).map(&:to_s).flatten.uniq + ).map(&:to_s).flatten.uniq, }) end private def populate_tags merge_data!({ - "tags" => Utils.pluralized_array_from_hash(data, "tag", "tags").flatten + "tags" => Utils.pluralized_array_from_hash(data, "tag", "tags").flatten, }) end diff --git a/lib/jekyll/drops/jekyll_drop.rb b/lib/jekyll/drops/jekyll_drop.rb index 50163d74..e3d2eb38 100644 --- a/lib/jekyll/drops/jekyll_drop.rb +++ b/lib/jekyll/drops/jekyll_drop.rb @@ -20,7 +20,7 @@ module Jekyll def to_h @to_h ||= { "version" => version, - "environment" => environment + "environment" => environment, } end diff --git a/lib/jekyll/entry_filter.rb b/lib/jekyll/entry_filter.rb index 5f3431d8..e4187d42 100644 --- a/lib/jekyll/entry_filter.rb +++ b/lib/jekyll/entry_filter.rb @@ -2,7 +2,7 @@ module Jekyll class EntryFilter attr_reader :site SPECIAL_LEADING_CHARACTERS = [ - ".", "_", "#", "~" + ".", "_", "#", "~", ].freeze def initialize(site, base_directory = nil) diff --git a/lib/jekyll/filters/grouping_filters.rb b/lib/jekyll/filters/grouping_filters.rb index a16901d9..e7a904a4 100644 --- a/lib/jekyll/filters/grouping_filters.rb +++ b/lib/jekyll/filters/grouping_filters.rb @@ -54,7 +54,7 @@ module Jekyll array << { "name" => item.first, "items" => item.last, - "size" => item.last.size + "size" => item.last.size, } end end diff --git a/lib/jekyll/hooks.rb b/lib/jekyll/hooks.rb index 9083b27a..5f21b5f6 100644 --- a/lib/jekyll/hooks.rb +++ b/lib/jekyll/hooks.rb @@ -6,7 +6,7 @@ module Jekyll PRIORITY_MAP = { :low => 10, :normal => 20, - :high => 30 + :high => 30, }.freeze # initial empty hooks @@ -17,26 +17,26 @@ module Jekyll :post_read => [], :pre_render => [], :post_render => [], - :post_write => [] + :post_write => [], }, :pages => { :post_init => [], :pre_render => [], :post_render => [], - :post_write => [] + :post_write => [], }, :posts => { :post_init => [], :pre_render => [], :post_render => [], - :post_write => [] + :post_write => [], }, :documents => { :post_init => [], :pre_render => [], :post_render => [], - :post_write => [] - } + :post_write => [], + }, } # map of all hooks and their priorities @@ -64,7 +64,7 @@ module Jekyll :post_init => [], :pre_render => [], :post_render => [], - :post_write => [] + :post_write => [], } unless @registry[owner][event] diff --git a/lib/jekyll/log_adapter.rb b/lib/jekyll/log_adapter.rb index 70173b91..965f3295 100644 --- a/lib/jekyll/log_adapter.rb +++ b/lib/jekyll/log_adapter.rb @@ -6,7 +6,7 @@ module Jekyll :debug => ::Logger::DEBUG, :info => ::Logger::INFO, :warn => ::Logger::WARN, - :error => ::Logger::ERROR + :error => ::Logger::ERROR, }.freeze # Public: Create a new instance of a log writer diff --git a/lib/jekyll/page.rb b/lib/jekyll/page.rb index 7619966d..324a867d 100644 --- a/lib/jekyll/page.rb +++ b/lib/jekyll/page.rb @@ -98,7 +98,7 @@ module Jekyll @url ||= URL.new({ :template => template, :placeholders => url_placeholders, - :permalink => permalink + :permalink => permalink, }).to_s end @@ -108,7 +108,7 @@ module Jekyll { :path => @dir, :basename => basename, - :output_ext => output_ext + :output_ext => output_ext, } end diff --git a/lib/jekyll/plugin.rb b/lib/jekyll/plugin.rb index bcc1bf7e..4680be32 100644 --- a/lib/jekyll/plugin.rb +++ b/lib/jekyll/plugin.rb @@ -5,7 +5,7 @@ module Jekyll :highest => 100, :lowest => -100, :normal => 0, - :high => 10 + :high => 10, }.freeze # diff --git a/lib/jekyll/readers/data_reader.rb b/lib/jekyll/readers/data_reader.rb index 6744ae05..1083d62b 100644 --- a/lib/jekyll/readers/data_reader.rb +++ b/lib/jekyll/readers/data_reader.rb @@ -54,7 +54,7 @@ module Jekyll when ".csv" CSV.read(path, { :headers => true, - :encoding => site.config["encoding"] + :encoding => site.config["encoding"], }).map(&:to_hash) else SafeYAML.load_file(path) diff --git a/lib/jekyll/readers/post_reader.rb b/lib/jekyll/readers/post_reader.rb index 123709e7..70688875 100644 --- a/lib/jekyll/readers/post_reader.rb +++ b/lib/jekyll/readers/post_reader.rb @@ -57,7 +57,7 @@ module Jekyll path = @site.in_source_dir(File.join(dir, magic_dir, entry)) Document.new(path, { :site => @site, - :collection => @site.posts + :collection => @site.posts, }) end.reject(&:nil?) end diff --git a/lib/jekyll/regenerator.rb b/lib/jekyll/regenerator.rb index 4d89da2e..09ff309a 100644 --- a/lib/jekyll/regenerator.rb +++ b/lib/jekyll/regenerator.rb @@ -40,7 +40,7 @@ module Jekyll metadata[path] = { "mtime" => File.mtime(path), - "deps" => [] + "deps" => [], } cache[path] = true end diff --git a/lib/jekyll/static_file.rb b/lib/jekyll/static_file.rb index 927a9b47..53b945d4 100644 --- a/lib/jekyll/static_file.rb +++ b/lib/jekyll/static_file.rb @@ -101,7 +101,7 @@ module Jekyll "name" => name, "extname" => extname, "modified_time" => modified_time, - "path" => File.join("", relative_path) + "path" => File.join("", relative_path), } end @@ -112,7 +112,7 @@ module Jekyll @collection.relative_directory.size..relative_path.size], :output_ext => "", :name => "", - :title => "" + :title => "", } end @@ -125,7 +125,7 @@ module Jekyll else ::Jekyll::URL.new({ :template => @collection.url_template, - :placeholders => placeholders + :placeholders => placeholders, }) end.to_s.gsub(%r!/$!, "") end diff --git a/lib/jekyll/tags/highlight.rb b/lib/jekyll/tags/highlight.rb index 43b0c62f..86b9171b 100644 --- a/lib/jekyll/tags/highlight.rb +++ b/lib/jekyll/tags/highlight.rb @@ -54,7 +54,7 @@ eos [:hl_lines, opts.fetch(:hl_lines, nil)], [:linenos, opts.fetch(:linenos, nil)], [:encoding, opts.fetch(:encoding, "utf-8")], - [:cssclass, opts.fetch(:cssclass, nil)] + [:cssclass, opts.fetch(:cssclass, nil)], ].reject { |f| f.last.nil? }] else opts @@ -125,7 +125,7 @@ eos def add_code_tag(code) code_attributes = [ "class=\"language-#{@lang.to_s.tr("+", "-")}\"", - "data-lang=\"#{@lang}\"" + "data-lang=\"#{@lang}\"", ].join(" ") "
"\
         "#{code.chomp}
" diff --git a/lib/jekyll/theme_builder.rb b/lib/jekyll/theme_builder.rb index 68a5eeab..f1c97e37 100644 --- a/lib/jekyll/theme_builder.rb +++ b/lib/jekyll/theme_builder.rb @@ -28,7 +28,7 @@ class Jekyll::ThemeBuilder def template_file(filename) [ root.join("theme_template", "#{filename}.erb"), - root.join("theme_template", filename.to_s) + root.join("theme_template", filename.to_s), ].find(&:exist?) end diff --git a/lib/jekyll/utils/ansi.rb b/lib/jekyll/utils/ansi.rb index 4be163c5..8bdd2322 100644 --- a/lib/jekyll/utils/ansi.rb +++ b/lib/jekyll/utils/ansi.rb @@ -17,7 +17,7 @@ module Jekyll :yellow => 33, :white => 37, :blue => 34, - :cyan => 36 + :cyan => 36, }.freeze # Strip ANSI from the current string. It also strips cursor stuff, diff --git a/test/helper.rb b/test/helper.rb index 0c6935a0..e33ddae7 100644 --- a/test/helper.rb +++ b/test/helper.rb @@ -46,7 +46,7 @@ include Jekyll Minitest::Reporters.use! [ Minitest::Reporters::DefaultReporter.new( :color => true - ) + ), ] module Minitest::Assertions @@ -107,9 +107,9 @@ class JekyllUnitTest < Minitest::Test site = fixture_site({ "collections" => { "methods" => { - "output" => true - } - } + "output" => true, + }, + }, }) site.read matching_doc = site.collections["methods"].docs.find do |doc| @@ -133,10 +133,10 @@ class JekyllUnitTest < Minitest::Test def site_configuration(overrides = {}) full_overrides = build_configs(overrides, build_configs({ "destination" => dest_dir, - "incremental" => false + "incremental" => false, })) Configuration.from(full_overrides.merge({ - "source" => source_dir + "source" => source_dir, })) end diff --git a/test/test_collections.rb b/test/test_collections.rb index 0dca8443..0607208b 100644 --- a/test/test_collections.rb +++ b/test/test_collections.rb @@ -91,9 +91,9 @@ class TestCollections < JekyllUnitTest @site = fixture_site({ "collections" => { "methods" => { - "permalink" => "/awesome/:path/" - } - } + "permalink" => "/awesome/:path/", + }, + }, }) @site.process @collection = @site.collections["methods"] @@ -107,7 +107,7 @@ class TestCollections < JekyllUnitTest context "with a collection" do setup do @site = fixture_site({ - "collections" => ["methods"] + "collections" => ["methods"], }) @site.process @collection = @site.collections["methods"] @@ -158,9 +158,9 @@ class TestCollections < JekyllUnitTest "collections" => { "methods" => { "foo" => "bar", - "baz" => "whoo" - } - } + "baz" => "whoo", + }, + }, }) @site.process @collection = @site.collections["methods"] @@ -175,7 +175,7 @@ class TestCollections < JekyllUnitTest setup do @site = fixture_site({ "collections" => ["methods"], - "safe" => true + "safe" => true, }) @site.process @collection = @site.collections["methods"] @@ -198,7 +198,7 @@ class TestCollections < JekyllUnitTest setup do @site = fixture_site({ "collections" => ["with.dots"], - "safe" => true + "safe" => true, }) @site.process @collection = @site.collections["with.dots"] diff --git a/test/test_commands_serve.rb b/test/test_commands_serve.rb index 143dc2a5..fa0f7f67 100644 --- a/test/test_commands_serve.rb +++ b/test/test_commands_serve.rb @@ -86,12 +86,12 @@ class TestCommandsServe < JekyllUnitTest "config" => %w(_config.yml _development.yml), "serving" => true, "watch" => false, # for not having guard output when running the tests - "url" => "http://localhost:4000" + "url" => "http://localhost:4000", } expect(Jekyll::Commands::Serve).to receive(:process).with(custom_options) @merc.execute(:serve, { "config" => %w(_config.yml _development.yml), - "watch" => false }) + "watch" => false, }) end context "in development environment" do @@ -113,7 +113,7 @@ class TestCommandsServe < JekyllUnitTest "port" => "9999", "url" => "https://jekyllrb.com/", "ssl_cert" => "foo", - "ssl_key" => "bar" + "ssl_key" => "bar", }) assert_equal 1, Jekyll.sites.count @@ -146,13 +146,13 @@ class TestCommandsServe < JekyllUnitTest should "raise if enabling without key or cert" do assert_raises RuntimeError do custom_opts({ - "ssl_key" => "foo" + "ssl_key" => "foo", }) end assert_raises RuntimeError do custom_opts({ - "ssl_key" => "foo" + "ssl_key" => "foo", }) end end @@ -166,7 +166,7 @@ class TestCommandsServe < JekyllUnitTest "ssl_cert" => "foo", "source" => "bar", "enable_ssl" => true, - "ssl_key" => "bar" + "ssl_key" => "bar", }) assert result[:SSLEnable] diff --git a/test/test_configuration.rb b/test/test_configuration.rb index 696fc3e9..febc0cbe 100644 --- a/test/test_configuration.rb +++ b/test/test_configuration.rb @@ -4,7 +4,7 @@ require "colorator" class TestConfiguration < JekyllUnitTest test_config = { "source" => new(nil).source_dir, - "destination" => dest_dir + "destination" => dest_dir, } context ".from" do @@ -34,8 +34,8 @@ class TestConfiguration < JekyllUnitTest { "posts" => { "output" => true, - "permalink" => "/:categories/:year/:month/:day/:title:output_ext" - } + "permalink" => "/:categories/:year/:month/:day/:title:output_ext", + }, } ) end @@ -85,8 +85,8 @@ class TestConfiguration < JekyllUnitTest { "posts" => { "output" => true, - "permalink" => "/:categories/:year/:month/:day/:title/" - } + "permalink" => "/:categories/:year/:month/:day/:title/", + }, } ) @@ -109,14 +109,14 @@ class TestConfiguration < JekyllUnitTest :permalink => "date", "baseurl" => "/", :include => [".htaccess"], - :source => "./" + :source => "./", }] @string_keys = Configuration[{ "markdown" => "kramdown", "permalink" => "date", "baseurl" => "/", "include" => [".htaccess"], - "source" => "./" + "source" => "./", }] end should "stringify symbol keys" do @@ -132,7 +132,7 @@ class TestConfiguration < JekyllUnitTest @no_override = {} @one_config_file = { "config" => "config.yml" } @multiple_files = { - "config" => %w(config/site.yml config/deploy.toml configuration.yml) + "config" => %w(config/site.yml config/deploy.toml configuration.yml), } end @@ -205,7 +205,7 @@ class TestConfiguration < JekyllUnitTest "pygments" => true, "plugins" => true, "layouts" => true, - "data_source" => true + "data_source" => true, }] end should "unset 'auto' and 'watch'" do @@ -255,7 +255,7 @@ class TestConfiguration < JekyllUnitTest setup do @config = proc do |val| Configuration[{ - "paginate" => val + "paginate" => val, }] end end @@ -327,7 +327,7 @@ class TestConfiguration < JekyllUnitTest :default => source_dir("_config.yml"), :other => source_dir("_config.live.yml"), :toml => source_dir("_config.dev.toml"), - :empty => "" + :empty => "", } end @@ -372,7 +372,7 @@ class TestConfiguration < JekyllUnitTest Jekyll.logger.log_level = :warn assert_equal \ site_configuration({ "baseurl" => "/you-beautiful-blog-you", - "title" => "My magnificent site, wut" }), + "title" => "My magnificent site, wut", }), Jekyll.configuration(test_config.merge({ "config" => [@paths[:toml]] })) Jekyll.logger.log_level = :info end @@ -435,9 +435,9 @@ class TestConfiguration < JekyllUnitTest "docs" => {}, "posts" => { "output" => true, - "permalink" => "/:categories/:year/:month/:day/:title:output_ext" - } - } + "permalink" => "/:categories/:year/:month/:day/:title:output_ext", + }, + }, }) end @@ -449,9 +449,9 @@ class TestConfiguration < JekyllUnitTest "collections" => { "posts" => { "output" => true, - "permalink" => "/:categories/:year/:month/:day/:title:output_ext" - } - } + "permalink" => "/:categories/:year/:month/:day/:title:output_ext", + }, + }, }) end @@ -461,9 +461,9 @@ class TestConfiguration < JekyllUnitTest "collections" => { "posts" => { "output" => true, - "permalink" => "/:categories/:year/:month/:day/:title:output_ext" - } - } + "permalink" => "/:categories/:year/:month/:day/:title:output_ext", + }, + }, }) end @@ -471,16 +471,16 @@ class TestConfiguration < JekyllUnitTest posts_permalink = "/:year/:title/" conf = Configuration[default_configuration].tap do |c| c["collections"] = { - "posts" => { "permalink" => posts_permalink } + "posts" => { "permalink" => posts_permalink }, } end assert_equal conf.add_default_collections, conf.merge({ "collections" => { "posts" => { "output" => true, - "permalink" => posts_permalink - } - } + "permalink" => posts_permalink, + }, + }, }) end end diff --git a/test/test_doctor_command.rb b/test/test_doctor_command.rb index 652175b9..88614402 100644 --- a/test/test_doctor_command.rb +++ b/test/test_doctor_command.rb @@ -10,7 +10,7 @@ class TestDoctorCommand < JekyllUnitTest should "return success on a valid site/page" do @site = Site.new(Jekyll.configuration({ "source" => File.join(source_dir, "/_urls_differ_by_case_valid"), - "destination" => dest_dir + "destination" => dest_dir, })) @site.process output = capture_stderr do @@ -23,7 +23,7 @@ class TestDoctorCommand < JekyllUnitTest should "return warning for pages only differing by case" do @site = Site.new(Jekyll.configuration({ "source" => File.join(source_dir, "/_urls_differ_by_case_invalid"), - "destination" => dest_dir + "destination" => dest_dir, })) @site.process output = capture_stderr do diff --git a/test/test_document.rb b/test/test_document.rb index 7c9df18c..f274dd53 100644 --- a/test/test_document.rb +++ b/test/test_document.rb @@ -8,7 +8,7 @@ class TestDocument < JekyllUnitTest context "a document in a collection" do setup do @site = fixture_site({ - "collections" => ["methods"] + "collections" => ["methods"], }) @site.process @document = @site.collections["methods"].docs.detect do |d| @@ -118,10 +118,10 @@ class TestDocument < JekyllUnitTest "scope" => { "path"=>"", "type"=>"slides" }, "values" => { "nested" => { - "key" => "myval" - } - } - }] + "key" => "myval", + }, + }, + },], }) @site.process @document = @site.collections["slides"].docs.select { |d| d.is_a?(Document) }.first @@ -143,10 +143,10 @@ class TestDocument < JekyllUnitTest "values" => { "nested" => { "test1" => "default1", - "test2" => "default1" - } - } - }] + "test2" => "default1", + }, + }, + },], }) @site.process @document = @site.collections["slides"].docs[1] @@ -170,10 +170,10 @@ class TestDocument < JekyllUnitTest "scope" => { "path"=>"_slides", "type"=>"slides" }, "values" => { "nested" => { - "key" => "value123" - } - } - }] + "key" => "value123", + }, + }, + },], }) @site.process @document = @site.collections["slides"].docs.first @@ -194,10 +194,10 @@ class TestDocument < JekyllUnitTest "scope" => { "path"=>"somepath", "type"=>"slides" }, "values" => { "nested" => { - "key" => "myval" - } - } - }] + "key" => "myval", + }, + }, + },], }) @site.process @document = @site.collections["slides"].docs.first @@ -213,7 +213,7 @@ class TestDocument < JekyllUnitTest context "a document in a collection with a custom permalink" do setup do @site = fixture_site({ - "collections" => ["slides"] + "collections" => ["slides"], }) @site.process @document = @site.collections["slides"].docs[2] @@ -235,10 +235,10 @@ class TestDocument < JekyllUnitTest "collections" => { "slides" => { "output" => true, - "permalink" => "/slides/test/:name" - } + "permalink" => "/slides/test/:name", + }, }, - "permalink" => "pretty" + "permalink" => "pretty", }) @site.process @document = @site.collections["slides"].docs[0] @@ -263,9 +263,9 @@ class TestDocument < JekyllUnitTest @site = fixture_site({ "collections" => { "slides" => { - "output" => true - } - } + "output" => true, + }, + }, }) @site.permalink_style = :pretty @site.process @@ -287,9 +287,9 @@ class TestDocument < JekyllUnitTest @site = fixture_site({ "collections" => { "slides" => { - "output" => true - } - } + "output" => true, + }, + }, }) @site.permalink_style = :pretty @site.process @@ -307,9 +307,9 @@ class TestDocument < JekyllUnitTest @site = fixture_site({ "collections" => { "slides" => { - "output" => true - } - } + "output" => true, + }, + }, }) @site.process @document = @site.collections["slides"].docs[6] @@ -339,9 +339,9 @@ class TestDocument < JekyllUnitTest "collections" => { "slides" => { "output" => true, - "permalink" => "/slides/:title" - } - } + "permalink" => "/slides/:title", + }, + }, }) @site.process @document = @site.collections["slides"].docs[3] @@ -381,8 +381,8 @@ class TestDocument < JekyllUnitTest context "document with a permalink with dots & a trailing slash" do setup do @site = fixture_site({ "collections" => { - "with.dots" => { "output" => true } - } }) + "with.dots" => { "output" => true }, + }, }) @site.process @document = @site.collections["with.dots"].docs.last @dest_file = dest_dir("with.dots", "permalink.with.slash.tho", "index.html") @@ -406,9 +406,9 @@ class TestDocument < JekyllUnitTest @site = fixture_site({ "collections" => { "slides" => { - "output" => true - } - } + "output" => true, + }, + }, }) @site.process @files = @site.collections["slides"].docs @@ -436,9 +436,9 @@ class TestDocument < JekyllUnitTest @site = fixture_site({ "collections" => { "slides" => { - "output" => true - } - } + "output" => true, + }, + }, }) @site.process @document = @site.collections["slides"].files.find do |doc| @@ -469,9 +469,9 @@ class TestDocument < JekyllUnitTest @site = fixture_site({ "collections" => { "methods" => { - "output" => true - } - } + "output" => true, + }, + }, }) @site.process @document = @site.collections["methods"].docs.find do |doc| @@ -498,9 +498,9 @@ class TestDocument < JekyllUnitTest @site = fixture_site({ "collections" => { "methods" => { - "output" => true - } - } + "output" => true, + }, + }, }) @site.process @document = @site.collections["methods"].docs.find do |doc| diff --git a/test/test_drop.rb b/test/test_drop.rb index 199e94ab..80b0d0ff 100644 --- a/test/test_drop.rb +++ b/test/test_drop.rb @@ -4,7 +4,7 @@ class TestDrop < JekyllUnitTest context "a document drop" do setup do @site = fixture_site({ - "collections" => ["methods"] + "collections" => ["methods"], }) @site.process @document = @site.collections["methods"].docs.detect do |d| diff --git a/test/test_entry_filter.rb b/test/test_entry_filter.rb index f65badc6..7f32653c 100644 --- a/test/test_entry_filter.rb +++ b/test/test_entry_filter.rb @@ -17,7 +17,7 @@ class TestEntryFilter < JekyllUnitTest should "allow regexp filtering" do files = %w(README.md) @site.exclude = [ - %r!README! + %r!README!, ] assert_empty @site.reader.filter_entries( diff --git a/test/test_excerpt.rb b/test/test_excerpt.rb index 0b7e540f..e0960f69 100644 --- a/test/test_excerpt.rb +++ b/test/test_excerpt.rb @@ -4,13 +4,13 @@ class TestExcerpt < JekyllUnitTest def setup_post(file) Document.new(@site.in_source_dir(File.join("_posts", file)), { :site => @site, - :collection => @site.posts + :collection => @site.posts, }).tap(&:read) end def do_render(document) @site.layouts = { - "default" => Layout.new(@site, source_dir("_layouts"), "simple.html") + "default" => Layout.new(@site, source_dir("_layouts"), "simple.html"), } document.output = Jekyll::Renderer.new(@site, document, @site.site_payload).run end diff --git a/test/test_filters.rb b/test/test_filters.rb index e5dedfae..71639ad7 100644 --- a/test/test_filters.rb +++ b/test/test_filters.rb @@ -29,7 +29,7 @@ class TestFilters < JekyllUnitTest @filter = make_filter_mock({ "timezone" => "UTC", "url" => "http://example.com", - "baseurl" => "/base" + "baseurl" => "/base", }) @sample_time = Time.utc(2013, 3, 27, 11, 22, 33) @sample_date = Date.parse("2013-03-27") @@ -39,7 +39,7 @@ class TestFilters < JekyllUnitTest @array_of_objects = [ { "color" => "red", "size" => "large" }, { "color" => "red", "size" => "medium" }, - { "color" => "blue", "size" => "medium" } + { "color" => "blue", "size" => "medium" }, ] end @@ -332,7 +332,7 @@ class TestFilters < JekyllUnitTest page_url = "about/my_favorite_page/" filter = make_filter_mock({ "url" => "http://example.com", - "baseurl" => "base" + "baseurl" => "base", }) assert_equal "http://example.com/base/#{page_url}", filter.absolute_url(page_url) end @@ -341,7 +341,7 @@ class TestFilters < JekyllUnitTest page_url = "about/my_favorite_page/" filter = make_filter_mock({ "url" => "", - "baseurl" => "base" + "baseurl" => "base", }) assert_equal "/base/#{page_url}", filter.absolute_url(page_url) end @@ -350,7 +350,7 @@ class TestFilters < JekyllUnitTest page_url = "about/my_favorite_page/" filter = make_filter_mock({ "url" => nil, - "baseurl" => "base" + "baseurl" => "base", }) assert_equal "/base/#{page_url}", filter.absolute_url(page_url) end @@ -359,7 +359,7 @@ class TestFilters < JekyllUnitTest page_url = "about/my_favorite_page/" filter = make_filter_mock({ "url" => "http://example.com", - "baseurl" => nil + "baseurl" => nil, }) assert_equal "http://example.com/#{page_url}", filter.absolute_url(page_url) end @@ -368,7 +368,7 @@ class TestFilters < JekyllUnitTest page_url = "" filter = make_filter_mock({ "url" => "http://example.com", - "baseurl" => "/base" + "baseurl" => "/base", }) assert_equal "http://example.com/base", filter.absolute_url(page_url) end @@ -377,7 +377,7 @@ class TestFilters < JekyllUnitTest page_url = "" filter = make_filter_mock({ "url" => "http://ümlaut.example.org/", - "baseurl" => nil + "baseurl" => nil, }) assert_equal "http://xn--mlaut-jva.example.org/", filter.absolute_url(page_url) end @@ -409,7 +409,7 @@ class TestFilters < JekyllUnitTest page_url = "about/my_favorite_page/" filter = make_filter_mock({ "url" => "http://example.com", - "baseurl" => nil + "baseurl" => nil, }) assert_equal "/#{page_url}", filter.relative_url(page_url) end @@ -418,7 +418,7 @@ class TestFilters < JekyllUnitTest page_url = "" filter = make_filter_mock({ "url" => "http://example.com", - "baseurl" => "/base" + "baseurl" => "/base", }) assert_equal "/base", filter.relative_url(page_url) end @@ -451,7 +451,7 @@ class TestFilters < JekyllUnitTest "excerpt" => "

This should be published.

\n", "draft" => false, "categories" => [ - "publish_test" + "publish_test", ], "layout" => "default", "title" => "Publish", @@ -459,7 +459,7 @@ class TestFilters < JekyllUnitTest "date" => "2008-02-02 00:00:00 +0000", "slug" => "published", "ext" => ".markdown", - "tags" => [] + "tags" => [], } actual = JSON.parse(@filter.jsonify(@filter.site.docs_to_write.first.to_liquid)) @@ -475,7 +475,7 @@ class TestFilters < JekyllUnitTest actual = @filter.jsonify(@filter.site.to_liquid) assert_equal JSON.parse(actual)["jekyll"], { "environment" => "development", - "version" => Jekyll::VERSION + "version" => Jekyll::VERSION, } end @@ -491,7 +491,7 @@ class TestFilters < JekyllUnitTest "name" => name, :v => 1, :thing => M.new({ :kay => "jewelers" }), - :stuff => true + :stuff => true, } end end @@ -503,21 +503,21 @@ class TestFilters < JekyllUnitTest "v" => 1, "thing" => [ { - "kay" => "jewelers" - } + "kay" => "jewelers", + }, ], - "stuff" => true + "stuff" => true, }, { "name" => "Smathers", "v" => 1, "thing" => [ { - "kay" => "jewelers" - } + "kay" => "jewelers", + }, ], - "stuff" => true - } + "stuff" => true, + }, ] result = @filter.jsonify([T.new("Jeremiah"), T.new("Smathers")]) assert_equal expected, JSON.parse(result) @@ -533,32 +533,32 @@ class TestFilters < JekyllUnitTest "v" => 1, "thing" => [ { - "kay" => "jewelers" - } + "kay" => "jewelers", + }, ], - "stuff" => true + "stuff" => true, }, { "name" => 1, "v" => 1, "thing" => [ { - "kay" => "jewelers" - } + "kay" => "jewelers", + }, ], - "stuff" => true + "stuff" => true, }, { "name" => 2, "v" => 1, "thing" => [ { - "kay" => "jewelers" - } + "kay" => "jewelers", + }, ], - "stuff" => true - } - ] + "stuff" => true, + }, + ], } result = @filter.jsonify(my_hash) assert_equal expected, JSON.parse(result) @@ -633,7 +633,7 @@ class TestFilters < JekyllUnitTest hash = { "a" => { "tags"=>%w(x y) }, "b" => { "tags"=>["x"] }, - "c" => { "tags"=>%w(y z) } + "c" => { "tags"=>%w(y z) }, } assert_equal 2, @filter.where(hash, "tags", "x").length end @@ -642,7 +642,7 @@ class TestFilters < JekyllUnitTest hash = { "a" => { "tags"=>%w(x y) }, "b" => { "tags"=>"x" }, - "c" => { "tags"=>%w(y z) } + "c" => { "tags"=>%w(y z) }, } assert_equal 2, @filter.where(hash, "tags", "x").length end @@ -651,7 +651,7 @@ class TestFilters < JekyllUnitTest hash = { "a" => { "category"=>"bear" }, "b" => { "category"=>"wolf" }, - "c" => { "category"=>%w(bear lion) } + "c" => { "category"=>%w(bear lion) }, } assert_equal 0, @filter.where(hash, "category", "ear").length end @@ -660,7 +660,7 @@ class TestFilters < JekyllUnitTest hash = { "The Words" => { "rating" => 1.2, "featured" => false }, "Limitless" => { "rating" => 9.2, "featured" => true }, - "Hustle" => { "rating" => 4.7, "featured" => true } + "Hustle" => { "rating" => 4.7, "featured" => true }, } results = @filter.where(hash, "featured", "true") @@ -704,7 +704,7 @@ class TestFilters < JekyllUnitTest hash = { "The Words" => { "rating" => 1.2, "featured" => false }, "Limitless" => { "rating" => 9.2, "featured" => true }, - "Hustle" => { "rating" => 4.7, "featured" => true } + "Hustle" => { "rating" => 4.7, "featured" => true }, } results = @filter.where_exp(hash, "item", "item.featured == true") @@ -725,7 +725,7 @@ class TestFilters < JekyllUnitTest { "id" => "a", "groups" => [1, 2] }, { "id" => "b", "groups" => [2, 3] }, { "id" => "c" }, - { "id" => "d", "groups" => [1, 3] } + { "id" => "d", "groups" => [1, 3] }, ] should "filter with the contains operator over arrays" do results = @filter.where_exp(objects, "obj", "obj.groups contains 1") @@ -807,7 +807,7 @@ class TestFilters < JekyllUnitTest items = [ { "version"=>"1.0", "result"=>"slow" }, { "version"=>"1.1.5", "result"=>"medium" }, - { "version"=>"2.7.3", "result"=>"fast" } + { "version"=>"2.7.3", "result"=>"fast" }, ] result = @filter.group_by_exp(items, "item", "item.version | split: '.' | first") diff --git a/test/test_front_matter_defaults.rb b/test/test_front_matter_defaults.rb index 30c713ac..0d066c11 100644 --- a/test/test_front_matter_defaults.rb +++ b/test/test_front_matter_defaults.rb @@ -7,12 +7,12 @@ class TestFrontMatterDefaults < JekyllUnitTest "defaults" => [{ "scope" => { "path" => "contacts", - "type" => "page" + "type" => "page", }, "values" => { - "key" => "val" - } - }] + "key" => "val", + }, + },], }) @site.process @affected = @site.pages.find { |page| page.relative_path == "contacts/bar.html" } @@ -30,12 +30,12 @@ class TestFrontMatterDefaults < JekyllUnitTest @site = fixture_site({ "defaults" => [{ "scope" => { - "path" => "index.html" + "path" => "index.html", }, "values" => { - "key" => "val" - } - }] + "key" => "val", + }, + },], }) @site.process @@ -54,12 +54,12 @@ class TestFrontMatterDefaults < JekyllUnitTest @site = fixture_site({ "defaults" => [{ "scope" => { - "path" => "win" + "path" => "win", }, "values" => { - "key" => "val" - } - }] + "key" => "val", + }, + },], }) @site.process @@ -78,12 +78,12 @@ class TestFrontMatterDefaults < JekyllUnitTest @site = fixture_site({ "defaults" => [{ "scope" => { - "type" => "page" + "type" => "page", }, "values" => { - "key" => "val" - } - }] + "key" => "val", + }, + },], }) @site.process @@ -103,12 +103,12 @@ class TestFrontMatterDefaults < JekyllUnitTest @site = fixture_site({ "defaults" => [{ "scope" => { - "type" => "pages" + "type" => "pages", }, "values" => { - "key" => "val" - } - }] + "key" => "val", + }, + },], }) @site.process @affected = @site.pages @@ -129,9 +129,9 @@ class TestFrontMatterDefaults < JekyllUnitTest "scope" => { }, "values" => { - "key" => "val" - } - }] + "key" => "val", + }, + },], }) @site.process @affected = @site.pages @@ -149,9 +149,9 @@ class TestFrontMatterDefaults < JekyllUnitTest @site = fixture_site({ "defaults" => [{ "values" => { - "key" => "val" - } - }] + "key" => "val", + }, + },], }) @site.process @affected = @site.pages @@ -171,9 +171,9 @@ class TestFrontMatterDefaults < JekyllUnitTest "destination" => dest_dir, "defaults" => [{ "values" => { - "date" => "2015-01-01 00:00:01" - } - }] + "date" => "2015-01-01 00:00:01", + }, + },], })) end diff --git a/test/test_kramdown.rb b/test/test_kramdown.rb index 0a6332f8..d8f886a4 100644 --- a/test/test_kramdown.rb +++ b/test/test_kramdown.rb @@ -16,9 +16,9 @@ class TestKramdown < JekyllUnitTest "syntax_highlighter" => "rouge", "syntax_highlighter_opts" => { - "bold_every" => 8, "css" => :class - } - } + "bold_every" => 8, "css" => :class, + }, + }, } @config = Jekyll.configuration(@config) @@ -43,8 +43,8 @@ class TestKramdown < JekyllUnitTest override = { "highlighter" => nil, "kramdown" => { - "smart_quotes" => "lsaquo,rsaquo,laquo,raquo" - } + "smart_quotes" => "lsaquo,rsaquo,laquo,raquo", + }, } markdown = Converters::Markdown.new(Utils.deep_merge_hashes(@config, override)) @@ -70,8 +70,8 @@ class TestKramdown < JekyllUnitTest "highlighter" => nil, "markdown" => "kramdown", "kramdown" => { - "syntax_highlighter" => :coderay - } + "syntax_highlighter" => :coderay, + }, } markdown = Converters::Markdown.new(Utils.deep_merge_hashes(@config, override)) @@ -89,8 +89,8 @@ class TestKramdown < JekyllUnitTest override = { "markdown" => "kramdown", "kramdown" => { - "enable_coderay" => true - } + "enable_coderay" => true, + }, } @config.delete("highlighter") @@ -115,9 +115,9 @@ class TestKramdown < JekyllUnitTest "kramdown" => { "syntax_highlighter" => "coderay", "coderay" => { - "hello" => "world" - } - } + "hello" => "world", + }, + }, })) expect(Kramdown::Document).to receive(:new) do |arg1, hash| diff --git a/test/test_layout_reader.rb b/test/test_layout_reader.rb index 133cd6f2..1d32fa57 100644 --- a/test/test_layout_reader.rb +++ b/test/test_layout_reader.rb @@ -4,7 +4,7 @@ class TestLayoutReader < JekyllUnitTest context "reading layouts" do setup do config = Jekyll::Configuration::DEFAULTS.merge({ "source" => source_dir, - "destination" => dest_dir }) + "destination" => dest_dir, }) @site = fixture_site(config) end diff --git a/test/test_liquid_renderer.rb b/test/test_liquid_renderer.rb index 7d429c52..6ba29299 100644 --- a/test/test_liquid_renderer.rb +++ b/test/test_liquid_renderer.rb @@ -16,7 +16,7 @@ class TestLiquidRenderer < JekyllUnitTest expected = [ %r!^Filename\s+|\s+Count\s+|\s+Bytes\s+|\s+Time$!, %r!^-+\++-+\++-+\++-+$!, - %r!^_posts/2010-01-09-date-override\.markdown\s+|\s+\d+\s+|\s+\d+\.\d{2}K\s+|\s+\d+\.\d{3}$! + %r!^_posts/2010-01-09-date-override\.markdown\s+|\s+\d+\s+|\s+\d+\.\d{2}K\s+|\s+\d+\.\d{3}$!, ] # rubocop:enable Metrics/LineLength diff --git a/test/test_page.rb b/test/test_page.rb index 259de185..431c57a6 100644 --- a/test/test_page.rb +++ b/test/test_page.rb @@ -12,7 +12,7 @@ class TestPage < JekyllUnitTest def do_render(page) layouts = { - "default" => Layout.new(@site, source_dir("_layouts"), "simple.html") + "default" => Layout.new(@site, source_dir("_layouts"), "simple.html"), } page.render(layouts, @site.site_payload) end @@ -23,7 +23,7 @@ class TestPage < JekyllUnitTest @site = Site.new(Jekyll.configuration({ "source" => source_dir, "destination" => dest_dir, - "skip_config_files" => true + "skip_config_files" => true, })) end @@ -90,7 +90,7 @@ class TestPage < JekyllUnitTest :permalink => "/properties/", :published => nil, :title => "Properties Page", - :url => "/properties/" + :url => "/properties/", } attrs.each do |attr, val| diff --git a/test/test_plugin_manager.rb b/test/test_plugin_manager.rb index c625c3a8..702df593 100644 --- a/test/test_plugin_manager.rb +++ b/test/test_plugin_manager.rb @@ -68,7 +68,7 @@ class TestPluginManager < JekyllUnitTest should "require plugin files" do site = double({ :safe => false, :config => { "plugins_dir" => "_plugins" }, - :in_source_dir => "/tmp/" }) + :in_source_dir => "/tmp/", }) plugin_manager = PluginManager.new(site) expect(Jekyll::External).to receive(:require_with_graceful_fail) @@ -98,9 +98,9 @@ class TestPluginManager < JekyllUnitTest should "call site's in_source_dir" do site = double({ :config => { - "plugins_dir" => Jekyll::Configuration::DEFAULTS["plugins_dir"] + "plugins_dir" => Jekyll::Configuration::DEFAULTS["plugins_dir"], }, - :in_source_dir => "/tmp/" + :in_source_dir => "/tmp/", }) plugin_manager = PluginManager.new(site) @@ -132,7 +132,7 @@ class TestPluginManager < JekyllUnitTest should "print no deprecation warning if jekyll-paginate is present" do site = double({ - :config => { "paginate" => true, "gems" => ["jekyll-paginate"] } + :config => { "paginate" => true, "gems" => ["jekyll-paginate"] }, }) plugin_manager = PluginManager.new(site) diff --git a/test/test_rdiscount.rb b/test/test_rdiscount.rb index 9390aaed..32289a64 100644 --- a/test/test_rdiscount.rb +++ b/test/test_rdiscount.rb @@ -13,8 +13,8 @@ class TestRdiscount < JekyllUnitTest "markdown" => "rdiscount", "rdiscount" => { "toc_token" => "{:toc}", - "extensions" => %w(smart generate_toc) - } + "extensions" => %w(smart generate_toc), + }, } @markdown = Converters::Markdown.new config diff --git a/test/test_redcarpet.rb b/test/test_redcarpet.rb index 140fabbe..4e979f4d 100644 --- a/test/test_redcarpet.rb +++ b/test/test_redcarpet.rb @@ -12,8 +12,8 @@ class TestRedcarpet < JekyllUnitTest @config = { "markdown" => "redcarpet", "redcarpet" => { - "extensions" => %w(smart strikethrough filter_html) - } + "extensions" => %w(smart strikethrough filter_html), + }, } @markdown = Converters::Markdown.new @config diff --git a/test/test_regenerator.rb b/test/test_regenerator.rb index 03920c83..9e1559d4 100644 --- a/test/test_regenerator.rb +++ b/test/test_regenerator.rb @@ -8,10 +8,10 @@ class TestRegenerator < JekyllUnitTest @site = fixture_site({ "collections" => { "methods" => { - "output" => true - } + "output" => true, + }, }, - "incremental" => true + "incremental" => true, }) @site.read @@ -92,7 +92,7 @@ class TestRegenerator < JekyllUnitTest setup do FileUtils.rm_rf(source_dir(".jekyll-metadata")) @site = fixture_site({ - "incremental" => true + "incremental" => true, }) @site.read @@ -129,7 +129,7 @@ class TestRegenerator < JekyllUnitTest @site = Site.new(Jekyll.configuration({ "source" => source_dir, "destination" => dest_dir, - "incremental" => true + "incremental" => true, })) @site.process @@ -311,7 +311,7 @@ class TestRegenerator < JekyllUnitTest @site = Site.new(Jekyll.configuration({ "source" => source_dir, "destination" => dest_dir, - "incremental" => false + "incremental" => false, })) @site.process diff --git a/test/test_related_posts.rb b/test/test_related_posts.rb index ef7265ef..2d616550 100644 --- a/test/test_related_posts.rb +++ b/test/test_related_posts.rb @@ -28,7 +28,7 @@ class TestRelatedPosts < JekyllUnitTest allow_any_instance_of(Jekyll::RelatedPosts).to receive(:display) @site = fixture_site({ - "lsi" => true + "lsi" => true, }) @site.reset diff --git a/test/test_sass.rb b/test/test_sass.rb index f5241790..3a9df0ae 100644 --- a/test/test_sass.rb +++ b/test/test_sass.rb @@ -5,7 +5,7 @@ class TestSass < JekyllUnitTest setup do @site = Jekyll::Site.new(Jekyll.configuration({ "source" => source_dir, - "destination" => dest_dir + "destination" => dest_dir, })) @site.process @test_css_file = dest_dir("css/main.css") diff --git a/test/test_site.rb b/test/test_site.rb index 81da363d..bbf42d25 100644 --- a/test/test_site.rb +++ b/test/test_site.rb @@ -20,7 +20,7 @@ class TestSite < JekyllUnitTest should "have an array for plugins if passed as an array" do site = Site.new(site_configuration({ - "plugins_dir" => ["/tmp/plugins", "/tmp/otherplugins"] + "plugins_dir" => ["/tmp/plugins", "/tmp/otherplugins"], })) array = if Utils::Platforms.windows? ["C:/tmp/plugins", "C:/tmp/otherplugins"] @@ -485,7 +485,7 @@ class TestSite < JekyllUnitTest context "manipulating the Jekyll environment" do setup do @site = Site.new(site_configuration({ - "incremental" => false + "incremental" => false, })) @site.process @page = @site.pages.find { |p| p.name == "environment.html" } @@ -499,7 +499,7 @@ class TestSite < JekyllUnitTest setup do ENV["JEKYLL_ENV"] = "production" @site = Site.new(site_configuration({ - "incremental" => false + "incremental" => false, })) @site.process @page = @site.pages.find { |p| p.name == "environment.html" } @@ -565,7 +565,7 @@ class TestSite < JekyllUnitTest context "incremental build" do setup do @site = Site.new(site_configuration({ - "incremental" => true + "incremental" => true, })) @site.read end diff --git a/test/test_static_file.rb b/test/test_static_file.rb index 2be800a6..dd3515f6 100644 --- a/test/test_static_file.rb +++ b/test/test_static_file.rb @@ -95,8 +95,8 @@ class TestStaticFile < JekyllUnitTest should "use the _config.yml defaults to determine writability" do defaults = [{ "scope" => { "path" => "private" }, - "values" => { "published" => false } - }] + "values" => { "published" => false }, + },] static_file = setup_static_file_with_defaults( "root", "private/dir/subdir", @@ -146,7 +146,7 @@ class TestStaticFile < JekyllUnitTest "name" => "static_file.txt", "extname" => ".txt", "modified_time" => @static_file.modified_time, - "path" => "/static_file.txt" + "path" => "/static_file.txt", } assert_equal expected, @static_file.to_liquid end diff --git a/test/test_tags.rb b/test/test_tags.rb index fd6dcb97..a636abf6 100644 --- a/test/test_tags.rb +++ b/test/test_tags.rb @@ -17,7 +17,7 @@ class TestTags < JekyllUnitTest info = { :filters => [Jekyll::Filters], :registers => { :site => site } } @converter = site.converters.find { |c| c.class == converter_class } payload = { "highlighter_prefix" => @converter.highlighter_prefix, - "highlighter_suffix" => @converter.highlighter_suffix } + "highlighter_suffix" => @converter.highlighter_suffix, } @result = Liquid::Template.parse(content).render!(payload, info) @result = @converter.convert(@result) @@ -487,7 +487,7 @@ CONTENT end create_post(@content, { - "markdown" => "rdiscount" + "markdown" => "rdiscount", }) end @@ -517,7 +517,7 @@ CONTENT end create_post(@content, { - "markdown" => "redcarpet" + "markdown" => "redcarpet", }) end @@ -541,7 +541,7 @@ CONTENT "permalink" => "pretty", "source" => source_dir, "destination" => dest_dir, - "read_posts" => true + "read_posts" => true, }) end @@ -567,7 +567,7 @@ CONTENT "permalink" => "pretty", "source" => source_dir, "destination" => dest_dir, - "read_posts" => true + "read_posts" => true, }) end @@ -596,7 +596,7 @@ CONTENT "permalink" => "pretty", "source" => source_dir, "destination" => dest_dir, - "read_posts" => true + "read_posts" => true, }) end @@ -628,7 +628,7 @@ CONTENT "permalink" => "pretty", "source" => source_dir, "destination" => dest_dir, - "read_posts" => true + "read_posts" => true, }) end @@ -664,7 +664,7 @@ CONTENT "permalink" => "pretty", "source" => source_dir, "destination" => dest_dir, - "read_posts" => true + "read_posts" => true, }) end end @@ -683,7 +683,7 @@ CONTENT "permalink" => "pretty", "source" => source_dir, "destination" => dest_dir, - "read_posts" => true + "read_posts" => true, }) end end @@ -703,7 +703,7 @@ CONTENT create_post(content, { "source" => source_dir, "destination" => dest_dir, - "read_all" => true + "read_all" => true, }) end @@ -737,7 +737,7 @@ CONTENT "source" => source_dir, "destination" => dest_dir, "collections" => { "methods" => { "output" => true } }, - "read_collections" => true + "read_collections" => true, }) end @@ -764,7 +764,7 @@ CONTENT "source" => source_dir, "destination" => dest_dir, "collections" => { "methods" => { "output" => true } }, - "read_collections" => true + "read_collections" => true, }) end @@ -796,7 +796,7 @@ CONTENT "source" => source_dir, "destination" => dest_dir, "collections" => { "methods" => { "output" => true } }, - "read_collections" => true + "read_collections" => true, }) end end @@ -820,7 +820,7 @@ CONTENT "source" => source_dir, "destination" => dest_dir, "read_posts" => true, - "safe" => true + "safe" => true, }) end @result ||= "" @@ -842,7 +842,7 @@ CONTENT "source" => source_dir, "destination" => dest_dir, "read_posts" => true, - "safe" => true + "safe" => true, }) end assert_match( @@ -868,7 +868,7 @@ CONTENT "permalink" => "pretty", "source" => source_dir, "destination" => dest_dir, - "read_posts" => true + "read_posts" => true, }) end @@ -896,7 +896,7 @@ CONTENT "permalink" => "pretty", "source" => source_dir, "destination" => dest_dir, - "read_posts" => true + "read_posts" => true, }) end @@ -913,7 +913,7 @@ CONTENT "permalink" => "pretty", "source" => source_dir, "destination" => dest_dir, - "read_posts" => true + "read_posts" => true, }) end end @@ -932,7 +932,7 @@ CONTENT "permalink" => "pretty", "source" => source_dir, "destination" => dest_dir, - "read_posts" => true + "read_posts" => true, }) end @@ -959,7 +959,7 @@ CONTENT "permalink" => "pretty", "source" => source_dir, "destination" => dest_dir, - "read_posts" => true + "read_posts" => true, }) end @@ -982,7 +982,7 @@ CONTENT "permalink" => "pretty", "source" => source_dir, "destination" => dest_dir, - "read_posts" => true + "read_posts" => true, }) end @@ -1004,7 +1004,7 @@ CONTENT "permalink" => "pretty", "source" => source_dir, "destination" => dest_dir, - "read_posts" => true + "read_posts" => true, }) end @@ -1030,7 +1030,7 @@ CONTENT "permalink" => "pretty", "source" => source_dir, "destination" => dest_dir, - "read_posts" => true + "read_posts" => true, }) end assert_match( @@ -1125,7 +1125,7 @@ CONTENT "permalink" => "pretty", "source" => source_dir, "destination" => dest_dir, - "read_posts" => true + "read_posts" => true, }) end assert_match "Could not locate the included file 'missing.html' in any of " \ @@ -1150,7 +1150,7 @@ CONTENT "permalink" => "pretty", "source" => source_dir, "destination" => dest_dir, - "read_posts" => true + "read_posts" => true, }) end assert_equal( @@ -1180,7 +1180,7 @@ CONTENT "source" => source_dir, "destination" => dest_dir, "read_posts" => true, - "safe" => true + "safe" => true, }) end @result ||= "" @@ -1202,7 +1202,7 @@ CONTENT "source" => source_dir, "destination" => dest_dir, "read_posts" => true, - "safe" => true + "safe" => true, }) end assert_match( From 27ed81547b12d28a60c51961b82a5723981feb7d Mon Sep 17 00:00:00 2001 From: jekyllbot Date: Thu, 12 Jan 2017 16:41:16 -0800 Subject: [PATCH 49/90] Update history to reflect merge of #5761 [ci skip] --- History.markdown | 1 + 1 file changed, 1 insertion(+) diff --git a/History.markdown b/History.markdown index bb10365f..60c9cf21 100644 --- a/History.markdown +++ b/History.markdown @@ -46,6 +46,7 @@ * Rubocop: fix Rakefile and gemspec (#5745) * Use `assert_nil` (#5725) * Sort gems in `jekyll.gemspec` (#5746) + * Rubocop: Require consistent comma in multiline literals (#5761) ### Documentation From a66fd1fa042752d421e248244ebeed27f7ea0459 Mon Sep 17 00:00:00 2001 From: jekyllbot Date: Fri, 13 Jan 2017 04:59:14 -0500 Subject: [PATCH 50/90] Update history to reflect merge of #5758 [ci skip] --- History.markdown | 1 + 1 file changed, 1 insertion(+) diff --git a/History.markdown b/History.markdown index 60c9cf21..5980801b 100644 --- a/History.markdown +++ b/History.markdown @@ -67,6 +67,7 @@ * 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) ## 3.3.1 / 2016-11-14 From b9ae94387f4b51ddb41dd543515fbfebef59f71f Mon Sep 17 00:00:00 2001 From: jekyllbot Date: Sat, 14 Jan 2017 00:01:33 -0500 Subject: [PATCH 51/90] Update history to reflect merge of #5750 [ci skip] --- History.markdown | 1 + 1 file changed, 1 insertion(+) diff --git a/History.markdown b/History.markdown index 5980801b..2c6b5c7a 100644 --- a/History.markdown +++ b/History.markdown @@ -14,6 +14,7 @@ * 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 From 59cbdf5935541e0088f086ef07770f2d3f595d3c Mon Sep 17 00:00:00 2001 From: Purplecarrot Date: Sat, 14 Jan 2017 10:36:55 +0000 Subject: [PATCH 52/90] Correct minor typo --- docs/_docs/github-pages.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/_docs/github-pages.md b/docs/_docs/github-pages.md index cc738704..886dea88 100644 --- a/docs/_docs/github-pages.md +++ b/docs/_docs/github-pages.md @@ -138,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.
From 7d5f961dbacac7af9d58cb4d900eadb84d26494d Mon Sep 17 00:00:00 2001 From: jekyllbot Date: Sat, 14 Jan 2017 07:41:25 -0500 Subject: [PATCH 53/90] Update history to reflect merge of #5764 [ci skip] --- History.markdown | 1 + 1 file changed, 1 insertion(+) diff --git a/History.markdown b/History.markdown index 2c6b5c7a..216c887b 100644 --- a/History.markdown +++ b/History.markdown @@ -69,6 +69,7 @@ * Correct comments in data_reader.rb (#5621) * Add jekyll-pre-commit to plugins list (#5752) * Update quickstart.md (#5758) + * Correct minor typo (#5764) ## 3.3.1 / 2016-11-14 From 44324828b4b4b807f8a99fab365d6b29234f045f Mon Sep 17 00:00:00 2001 From: Frank Taillandier Date: Sat, 14 Jan 2017 20:00:36 +0100 Subject: [PATCH 54/90] bump Rubocop to latest version --- Gemfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Gemfile b/Gemfile index eda95e5e..ea65fdcc 100644 --- a/Gemfile +++ b/Gemfile @@ -25,7 +25,7 @@ group :test do gem "nokogiri" gem "rspec" gem "rspec-mocks" - gem "rubocop", "~> 0.44.1" + gem "rubocop", "~> 0.46" gem "test-theme", :path => File.expand_path("./test/fixtures/test-theme", File.dirname(__FILE__)) gem "jruby-openssl" if RUBY_ENGINE == "jruby" From 5d52074d2d05c2178bb6791b60c5eafb6a7ea320 Mon Sep 17 00:00:00 2001 From: Frank Taillandier Date: Sat, 14 Jan 2017 20:01:41 +0100 Subject: [PATCH 55/90] appease Rubocop --- test/source/_plugins/dummy.rb | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/test/source/_plugins/dummy.rb b/test/source/_plugins/dummy.rb index bfd46e1c..fd11d0e1 100644 --- a/test/source/_plugins/dummy.rb +++ b/test/source/_plugins/dummy.rb @@ -2,7 +2,6 @@ module Jekyll class Dummy < Generator priority :high - def generate(site) - end + def generate(site) end end end From 39b7af373264efeff89af59c23708366bce1b672 Mon Sep 17 00:00:00 2001 From: Frank Taillandier Date: Sat, 14 Jan 2017 20:05:11 +0100 Subject: [PATCH 56/90] exclude rake tasks and gemspec from metrics exclude from BlockLength and LineLength metrics --- .rubocop.yml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.rubocop.yml b/.rubocop.yml index 67f212ae..87d24743 100644 --- a/.rubocop.yml +++ b/.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: From 6f8bf2e9501b2e2752effd07bd9cd781194a38a8 Mon Sep 17 00:00:00 2001 From: Frank Taillandier Date: Sat, 14 Jan 2017 20:11:30 +0100 Subject: [PATCH 57/90] appease rubocop --- rake/docs.rake | 2 +- rake/release.rake | 2 +- rake/site.rake | 26 +++++++++++++------------- 3 files changed, 15 insertions(+), 15 deletions(-) diff --git a/rake/docs.rake b/rake/docs.rake index aec162b5..fcae4f20 100644 --- a/rake/docs.rake +++ b/rake/docs.rake @@ -7,7 +7,7 @@ namespace :docs do desc "Release #{docs_name} v#{version}" task :release => :build do - unless `git branch` =~ /^\* master$/ + unless `git branch` =~ %r!^\* master$! puts "You must be on the master branch to release!" exit! end diff --git a/rake/release.rake b/rake/release.rake index a78690d8..832b5bb3 100644 --- a/rake/release.rake +++ b/rake/release.rake @@ -6,7 +6,7 @@ desc "Release #{name} v#{version}" task :release => :build do - unless `git branch` =~ /^\* master$/ + unless `git branch` =~ %r!^\* master$! puts "You must be on the master branch to release!" exit! end diff --git a/rake/site.rake b/rake/site.rake index 2fb4172a..63b04fc8 100644 --- a/rake/site.rake +++ b/rake/site.rake @@ -13,7 +13,7 @@ namespace :site do require "jekyll" browser_launched = false - Jekyll::Hooks.register :site, :post_write do |site| + Jekyll::Hooks.register :site, :post_write do |_site| next if browser_launched browser_launched = true Jekyll.logger.info "Opening in browser..." @@ -26,7 +26,7 @@ namespace :site do "source" => File.expand_path(docs_folder), "destination" => File.expand_path("#{docs_folder}/_site"), "watch" => true, - "serving" => true + "serving" => true, } Jekyll::Commands::Build.process(options) Jekyll::Commands::Serve.process(options) @@ -38,7 +38,7 @@ namespace :site do Jekyll::Commands::Build.process({ "profile" => true, "source" => File.expand_path(docs_folder), - "destination" => File.expand_path("#{docs_folder}/_site") + "destination" => File.expand_path("#{docs_folder}/_site"), }) end task :build => :generate @@ -48,7 +48,7 @@ namespace :site do Dir.chdir("#{docs_folder}/_sass") do sh 'curl "https://necolas.github.io/normalize.css/latest/normalize.css" -o "normalize.scss"' sh 'sass "normalize.scss":"_normalize.scss" --style compressed' - rm ['normalize.scss', Dir.glob('*.map')].flatten + rm ["normalize.scss", Dir.glob("*.map")].flatten end end @@ -60,40 +60,40 @@ namespace :site do desc "Create a nicely formatted history page for the jekyll site based on the repo history." task :history do - siteify_file('History.markdown', { "title" => "History" }) + siteify_file("History.markdown", { "title" => "History" }) end desc "Copy the Code of Conduct" task :conduct do front_matter = { "redirect_from" => "/conduct/index.html", - "editable" => false + "editable" => false, } - siteify_file('CONDUCT.markdown', front_matter) + siteify_file("CONDUCT.markdown", front_matter) end desc "Copy the contributing file" task :contributing do - siteify_file('.github/CONTRIBUTING.markdown', "title" => "Contributing") + siteify_file(".github/CONTRIBUTING.markdown", "title" => "Contributing") end desc "Write the site latest_version.txt file" task :version_file do - File.open("#{docs_folder}/latest_version.txt", 'wb') { |f| f.puts(version) } unless version =~ /(beta|rc|alpha)/i + File.open("#{docs_folder}/latest_version.txt", "wb") { |f| f.puts(version) } unless version =~ %r!(beta|rc|alpha)!i end namespace :releases do desc "Create new release post" - task :new, :version do |t, args| + task :new, :version do |_t, args| raise "Specify a version: rake site:releases:new['1.2.3']" unless args.version - today = Time.new.strftime('%Y-%m-%d') + today = Time.new.strftime("%Y-%m-%d") release = args.version.to_s - filename = "#{docs_folder}/_posts/#{today}-jekyll-#{release.split('.').join('-')}-released.markdown" + filename = "#{docs_folder}/_posts/#{today}-jekyll-#{release.split(".").join("-")}-released.markdown" File.open(filename, "wb") do |post| post.puts("---") post.puts("title: 'Jekyll #{release} Released'") - post.puts("date: #{Time.new.strftime('%Y-%m-%d %H:%M:%S %z')}") + post.puts("date: #{Time.new.strftime("%Y-%m-%d %H:%M:%S %z")}") post.puts("author: ") post.puts("version: #{release}") post.puts("categories: [release]") From becdcb5164cbba419abbd0d2f3650ef798d2c393 Mon Sep 17 00:00:00 2001 From: jekyllbot Date: Sun, 15 Jan 2017 03:47:06 -0500 Subject: [PATCH 58/90] Update history to reflect merge of #5765 [ci skip] --- History.markdown | 1 + 1 file changed, 1 insertion(+) diff --git a/History.markdown b/History.markdown index 216c887b..eafd41c4 100644 --- a/History.markdown +++ b/History.markdown @@ -48,6 +48,7 @@ * Use `assert_nil` (#5725) * Sort gems in `jekyll.gemspec` (#5746) * Rubocop: Require consistent comma in multiline literals (#5761) + * Bump rubocop (#5765) ### Documentation From ecd04badf05094cf65062635248cacebce139a38 Mon Sep 17 00:00:00 2001 From: Florian Thomas Date: Sun, 15 Jan 2017 20:35:10 +0100 Subject: [PATCH 59/90] throw IncludeTagError if error occurs in included file fixes #5756 --- features/rendering.feature | 9 +++++++++ lib/jekyll/tags/include.rb | 8 ++++++-- 2 files changed, 15 insertions(+), 2 deletions(-) diff --git a/features/rendering.feature b/features/rendering.feature index 5031ef06..fbe9ce57 100644 --- a/features/rendering.feature +++ b/features/rendering.feature @@ -12,6 +12,15 @@ Feature: Rendering Then I should get a non-zero exit-status And I should see "Liquid Exception" in the build output + Scenario: When receiving bad Liquid in included file + Given I have a _includes directory + And I have a "_includes/invalid.html" file that contains "{% INVALID %}" + And I have a "index.html" page with layout "simple" that contains "{% include invalid.html %}" + And I have a simple layout that contains "{{ content }}" + When I run jekyll build + Then I should get a non-zero exit-status + And I should see "Liquid Exception.*Unknown tag 'INVALID' in.*_includes/invalid\.html" in the build output + Scenario: Render Liquid and place in layout Given I have a "index.html" page with layout "simple" that contains "Hi there, Jekyll {{ jekyll.environment }}!" And I have a simple layout that contains "{{ content }}Ahoy, indeed!" diff --git a/lib/jekyll/tags/include.rb b/lib/jekyll/tags/include.rb index ca74087d..08843047 100644 --- a/lib/jekyll/tags/include.rb +++ b/lib/jekyll/tags/include.rb @@ -155,10 +155,14 @@ eos if cached_partial.key?(path) cached_partial[path] else - cached_partial[path] = context.registers[:site] + unparsed_file = context.registers[:site] .liquid_renderer .file(path) - .parse(read_file(path, context)) + begin + cached_partial[path] = unparsed_file.parse(read_file(path, context)) + rescue Liquid::SyntaxError => ex + raise IncludeTagError.new(ex.message, path) + end end end From a30d81ceb899ea33308503743603dace74d2ac98 Mon Sep 17 00:00:00 2001 From: Frank Taillandier Date: Mon, 16 Jan 2017 10:26:08 +0100 Subject: [PATCH 60/90] bump Rubocop to v47 --- Gemfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Gemfile b/Gemfile index ea65fdcc..f04f7969 100644 --- a/Gemfile +++ b/Gemfile @@ -25,7 +25,7 @@ group :test do gem "nokogiri" gem "rspec" gem "rspec-mocks" - gem "rubocop", "~> 0.46" + 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" From d790477d6dda77c0bea900f2739a076a2b894912 Mon Sep 17 00:00:00 2001 From: Frank Taillandier Date: Mon, 16 Jan 2017 10:43:07 +0100 Subject: [PATCH 61/90] Add security rules --- .rubocop.yml | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/.rubocop.yml b/.rubocop.yml index 87d24743..4193f4b4 100644 --- a/.rubocop.yml +++ b/.rubocop.yml @@ -48,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: From 55993c6c5d5cf2b2ad3d5e5b12b365d4ca9d715c Mon Sep 17 00:00:00 2001 From: Dmitrii Evdokimov Date: Mon, 16 Jan 2017 17:53:04 +0300 Subject: [PATCH 62/90] Fix a markdown link to look properly on the web --- docs/_docs/windows.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/_docs/windows.md b/docs/_docs/windows.md index 62fb69b4..ce7e78c1 100644 --- a/docs/_docs/windows.md +++ b/docs/_docs/windows.md @@ -15,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]. From 036dd3ccc96365ea97797dc61387aac167c54742 Mon Sep 17 00:00:00 2001 From: jekyllbot Date: Mon, 16 Jan 2017 11:05:25 -0500 Subject: [PATCH 63/90] Update history to reflect merge of #5769 [ci skip] --- History.markdown | 1 + 1 file changed, 1 insertion(+) diff --git a/History.markdown b/History.markdown index eafd41c4..0d537420 100644 --- a/History.markdown +++ b/History.markdown @@ -71,6 +71,7 @@ * 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 From 9d70bbba44cc2c62ac96a579050f163b52dc1672 Mon Sep 17 00:00:00 2001 From: jekyllbot Date: Mon, 16 Jan 2017 16:00:07 -0500 Subject: [PATCH 64/90] Update history to reflect merge of #5768 [ci skip] --- History.markdown | 1 + 1 file changed, 1 insertion(+) diff --git a/History.markdown b/History.markdown index 0d537420..c6694c36 100644 --- a/History.markdown +++ b/History.markdown @@ -49,6 +49,7 @@ * Sort gems in `jekyll.gemspec` (#5746) * Rubocop: Require consistent comma in multiline literals (#5761) * Bump rubocop (#5765) + * New rubocop security checks (#5768) ### Documentation From 567a7952dd0a506b04e2e50a1ac29715bc48aa6d Mon Sep 17 00:00:00 2001 From: Parker Moore Date: Mon, 16 Jan 2017 16:25:09 -0500 Subject: [PATCH 65/90] test/helper: fix flaky plugin path test by initializing Configuration::DEFAULTS at start of tests If we do a Dir.chdir before Configuration::DEFAULTS is initialized, then its source and destination values will not be what we expect. We expect that Dir.pwd should stay as the root of the repo but there are some errant calls to Dir.chdir without a block that are still not yet cleaned up. --- test/helper.rb | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/test/helper.rb b/test/helper.rb index 0c6935a0..fcbb7166 100644 --- a/test/helper.rb +++ b/test/helper.rb @@ -30,6 +30,11 @@ require "minitest/profile" require "rspec/mocks" require_relative "../lib/jekyll.rb" +# The default "source" and "destination" values depend on Dir.pwd, +# which changes when we use Dir.chdir without a block. Initialize +# it here so it has Dir.pwd = root of this repo. +Jekyll::Configuration::DEFAULTS + Jekyll.logger = Logger.new(StringIO.new) unless jruby? From aa7e47a30d4db30e644c54fc939ecd526db3c161 Mon Sep 17 00:00:00 2001 From: Parker Moore Date: Mon, 16 Jan 2017 16:43:25 -0500 Subject: [PATCH 66/90] Remove calls to Dir.chdir without a block. This removes the necessity to initialize Jekyll::Configuration::DEFAULTS manually. --- test/helper.rb | 11 +++++------ test/test_static_file.rb | 15 ++++++++------- 2 files changed, 13 insertions(+), 13 deletions(-) diff --git a/test/helper.rb b/test/helper.rb index fcbb7166..28c37ecf 100644 --- a/test/helper.rb +++ b/test/helper.rb @@ -30,11 +30,6 @@ require "minitest/profile" require "rspec/mocks" require_relative "../lib/jekyll.rb" -# The default "source" and "destination" values depend on Dir.pwd, -# which changes when we use Dir.chdir without a block. Initialize -# it here so it has Dir.pwd = root of this repo. -Jekyll::Configuration::DEFAULTS - Jekyll.logger = Logger.new(StringIO.new) unless jruby? @@ -67,6 +62,10 @@ module Minitest::Assertions end module DirectoryHelpers + def root_dir(*subdirs) + File.join(File.dirname(File.dirname(__FILE__)), *subdirs) + end + def dest_dir(*subdirs) test_dir("dest", *subdirs) end @@ -76,7 +75,7 @@ module DirectoryHelpers end def test_dir(*subdirs) - File.join(File.dirname(__FILE__), *subdirs) + root_dir("test", *subdirs) end end diff --git a/test/test_static_file.rb b/test/test_static_file.rb index 2be800a6..c45dcd78 100644 --- a/test/test_static_file.rb +++ b/test/test_static_file.rb @@ -16,33 +16,34 @@ class TestStaticFile < JekyllUnitTest end def setup_static_file(base, dir, name) - StaticFile.new(@site, base, dir, name) + Dir.chdir(@site.source) { StaticFile.new(@site, base, dir, name) } end def setup_static_file_with_collection(base, dir, name, metadata) site = fixture_site("collections" => { "foo" => metadata }) - StaticFile.new(site, base, dir, name, site.collections["foo"]) + Dir.chdir(site.source) do + StaticFile.new(site, base, dir, name, site.collections["foo"]) + end end def setup_static_file_with_defaults(base, dir, name, defaults) site = fixture_site("defaults" => defaults) - StaticFile.new(site, base, dir, name) + Dir.chdir(site.source) do + StaticFile.new(site, base, dir, name) + end end context "A StaticFile" do setup do clear_dest - @old_pwd = Dir.pwd - Dir.chdir source_dir @site = fixture_site @filename = "static_file.txt" make_dummy_file(@filename) - @static_file = setup_static_file(nil, nil, @filename) + @static_file = setup_static_file(@site.source, "", @filename) end teardown do remove_dummy_file(@filename) if File.exist?(source_dir(@filename)) - Dir.chdir @old_pwd end should "have a source file path" do From 448b6ba08ee419f4dd55b9a0ee0d036089077b48 Mon Sep 17 00:00:00 2001 From: jekyllbot Date: Mon, 16 Jan 2017 17:03:42 -0500 Subject: [PATCH 67/90] Update history to reflect merge of #5779 [ci skip] --- History.markdown | 1 + 1 file changed, 1 insertion(+) diff --git a/History.markdown b/History.markdown index c6694c36..dfea615e 100644 --- a/History.markdown +++ b/History.markdown @@ -50,6 +50,7 @@ * 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) ### Documentation From e509cf2139d1a7ee11090b09721344608ecf48f6 Mon Sep 17 00:00:00 2001 From: jekyllbot Date: Mon, 16 Jan 2017 18:38:35 -0500 Subject: [PATCH 68/90] Update history to reflect merge of #5767 [ci skip] --- History.markdown | 1 + 1 file changed, 1 insertion(+) diff --git a/History.markdown b/History.markdown index dfea615e..49783093 100644 --- a/History.markdown +++ b/History.markdown @@ -7,6 +7,7 @@ * 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 From 9a5307c3f9c568dec3703a3f30e6c68f0a751597 Mon Sep 17 00:00:00 2001 From: Parker Moore Date: Mon, 16 Jan 2017 19:17:45 -0500 Subject: [PATCH 69/90] Don't include the theme's includes_path if it is nil. --- lib/jekyll/site.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/jekyll/site.rb b/lib/jekyll/site.rb index 5797df77..3bbeaef3 100644 --- a/lib/jekyll/site.rb +++ b/lib/jekyll/site.rb @@ -435,7 +435,7 @@ module Jekyll private def configure_include_paths @includes_load_paths = Array(in_source_dir(config["includes_dir"].to_s)) - @includes_load_paths << theme.includes_path if self.theme + @includes_load_paths << theme.includes_path if self.theme && theme.includes_path end private From cd8836cf6efe15d4da4c668e8df1a9bfdac71861 Mon Sep 17 00:00:00 2001 From: Frank Taillandier Date: Tue, 17 Jan 2017 02:34:15 +0100 Subject: [PATCH 70/90] bump htmlproofer --- Gemfile | 2 +- script/proof | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/Gemfile b/Gemfile index f04f7969..4ead30a9 100644 --- a/Gemfile +++ b/Gemfile @@ -88,7 +88,7 @@ end group :site do if ENV["PROOF"] - gem "html-proofer", "~> 2.0" + gem "html-proofer", "~> 3.4" end gem "jekyll-avatar" diff --git a/script/proof b/script/proof index 1dd63a28..664e778d 100755 --- a/script/proof +++ b/script/proof @@ -32,4 +32,4 @@ bundle exec jekyll build -s $SOURCE -d $DESTINATION --trace # 3. msg "Proofing..." -time bundle exec htmlproof ./$DESTINATION --url-ignore $INGORE_HREFS $@ +time bundle exec htmlproofer ./$DESTINATION --url-ignore $INGORE_HREFS $@ From c39414a17b43399243190a31df7dfe24eeb3d945 Mon Sep 17 00:00:00 2001 From: Frank Taillandier Date: Tue, 17 Jan 2017 02:59:57 +0100 Subject: [PATCH 71/90] use latest jemoji gem --- Gemfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Gemfile b/Gemfile index f04f7969..97364a11 100644 --- a/Gemfile +++ b/Gemfile @@ -95,5 +95,5 @@ group :site do gem "jekyll-mentions" gem "jekyll-seo-tag" gem "jekyll-sitemap" - gem "jemoji", "0.5.1" + gem "jemoji" end From 67ab1596064eef6a2eb9c1dcc4367915c3efe1b7 Mon Sep 17 00:00:00 2001 From: jekyllbot Date: Mon, 16 Jan 2017 21:38:56 -0500 Subject: [PATCH 72/90] Update history to reflect merge of #5691 [ci skip] --- History.markdown | 1 + 1 file changed, 1 insertion(+) diff --git a/History.markdown b/History.markdown index 49783093..f8433c83 100644 --- a/History.markdown +++ b/History.markdown @@ -35,6 +35,7 @@ * Docs: move permalinks from documents into config (#5544) * Sort gems in `docs/_config.yml` (#5746) * [site] Use defaults for docs and news-items (#5744) + * Improve collections docs (#5691) ### Development Fixes From 5460e711765c99a638a125b1cbaca698ea813297 Mon Sep 17 00:00:00 2001 From: jekyllbot Date: Mon, 16 Jan 2017 21:48:20 -0500 Subject: [PATCH 73/90] Update history to reflect merge of #5731 [ci skip] --- History.markdown | 1 + 1 file changed, 1 insertion(+) diff --git a/History.markdown b/History.markdown index f8433c83..d03a2f6e 100644 --- a/History.markdown +++ b/History.markdown @@ -36,6 +36,7 @@ * Sort gems in `docs/_config.yml` (#5746) * [site] Use defaults for docs and news-items (#5744) * Improve collections docs (#5691) + * Fix #5730: add gcc and make to the list of requirements (#5731) ### Development Fixes From 4ea770e99565f611359f4699e50fd7b9dcb2face Mon Sep 17 00:00:00 2001 From: jekyllbot Date: Tue, 17 Jan 2017 03:22:44 -0500 Subject: [PATCH 74/90] Update history to reflect merge of #5782 [ci skip] --- History.markdown | 1 + 1 file changed, 1 insertion(+) diff --git a/History.markdown b/History.markdown index d03a2f6e..f6f73787 100644 --- a/History.markdown +++ b/History.markdown @@ -54,6 +54,7 @@ * 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) ### Documentation From 9c729033959bf7ef74372a22eb19e67900881aa9 Mon Sep 17 00:00:00 2001 From: jekyllbot Date: Tue, 17 Jan 2017 03:24:08 -0500 Subject: [PATCH 75/90] Update history to reflect merge of #5781 [ci skip] --- History.markdown | 1 + 1 file changed, 1 insertion(+) diff --git a/History.markdown b/History.markdown index f6f73787..25aa3c5a 100644 --- a/History.markdown +++ b/History.markdown @@ -55,6 +55,7 @@ * 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 From b9dedb34774382099b89eff7aa8bb85ed5e39ed5 Mon Sep 17 00:00:00 2001 From: jekyllbot Date: Tue, 17 Jan 2017 03:34:05 -0500 Subject: [PATCH 76/90] Update history to reflect merge of #5312 [ci skip] --- History.markdown | 1 + 1 file changed, 1 insertion(+) diff --git a/History.markdown b/History.markdown index 25aa3c5a..faee4627 100644 --- a/History.markdown +++ b/History.markdown @@ -79,6 +79,7 @@ * Update quickstart.md (#5758) * Correct minor typo (#5764) * Fix a markdown link to look properly on the web (#5769) + * [docs] Info about the help command usage (#5312) ## 3.3.1 / 2016-11-14 From bfb6cf1ca95b57afcacc2e77126774179b14ba92 Mon Sep 17 00:00:00 2001 From: Ashwin Maroli Date: Tue, 17 Jan 2017 14:35:33 +0530 Subject: [PATCH 77/90] bump rubies --- .travis.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.travis.yml b/.travis.yml index 6ff7022c..30eb1fc5 100644 --- a/.travis.yml +++ b/.travis.yml @@ -5,10 +5,10 @@ language: ruby sudo: false rvm: - - &ruby1 2.3.1 - - &ruby2 2.2.5 + - &ruby1 2.3.3 + - &ruby2 2.2.6 - &ruby3 2.1.9 - - &jruby jruby-9.1.2.0 + - &jruby jruby-9.1.7.0 matrix: include: From 39c4054cd1aa5346ff0e6f547bcdb15485998e3a Mon Sep 17 00:00:00 2001 From: jekyllbot Date: Tue, 17 Jan 2017 04:34:19 -0500 Subject: [PATCH 78/90] Update history to reflect merge of #5784 [ci skip] --- History.markdown | 1 + 1 file changed, 1 insertion(+) diff --git a/History.markdown b/History.markdown index faee4627..f2c2abda 100644 --- a/History.markdown +++ b/History.markdown @@ -56,6 +56,7 @@ * 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) + * Bump rubies we test against (#5784) ### Documentation From e1f4d92d023cdbb960eff4a9943bd7930ee50690 Mon Sep 17 00:00:00 2001 From: Frank Taillandier Date: Tue, 17 Jan 2017 18:22:28 +0100 Subject: [PATCH 79/90] add missing class --- docs/_docs/quickstart.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/_docs/quickstart.md b/docs/_docs/quickstart.md index b21d084d..3d126787 100644 --- a/docs/_docs/quickstart.md +++ b/docs/_docs/quickstart.md @@ -37,15 +37,14 @@ If you encounter any unexpected errors during the above, please refer to the alr `jekyll new ` installs a new Jekyll site at the path specified (relative to current directory). In this case, Jekyll will be installed in a directory called `myblog`. Here are some additional details: -* To install the Jekyll site into the directory you're currently in, run `jekyll new .` If the existing directory isn't empty, you can pass the `--force` option with `jekyll new . --force`. +* To install the Jekyll site into the directory you're currently in, run `jekyll new .` If the existing directory isn't empty, you can pass the `--force` option with `jekyll new . --force`. * `jekyll new` automatically initiates `bundle install` to install the dependencies required. (If you don't want Bundler to install the gems, use `jekyll new myblog --skip-bundle`.) * By default, the Jekyll site installed by `jekyll new` uses a gem-based theme called [Minima](https://github.com/jekyll/minima). With [gem-based themes](../themes), some of the directories and files are stored in the theme-gem, hidden from your immediate view. * To learn about other parameters you can include with `jekyll new`, type `jekyll new --help`. When in doubt, use the help command to remind you of all available options and usage, it also works with the new, build and serve subcommands, e.g. jekyll help new or jekyll help build. -{: .info } +{: .note .info } ## Next steps Building a Jekyll site with the default theme is just the first step. The real magic happens when you start creating blog posts, using the front matter to control templates and layouts, and taking advantage of all the awesome configuration options Jekyll makes available. - From 2052280ccd026b0c8711e026ed513a4783566308 Mon Sep 17 00:00:00 2001 From: jekyllbot Date: Tue, 17 Jan 2017 14:56:00 -0500 Subject: [PATCH 80/90] Update history to reflect merge of #5791 [ci skip] --- History.markdown | 1 + 1 file changed, 1 insertion(+) diff --git a/History.markdown b/History.markdown index f2c2abda..5971b779 100644 --- a/History.markdown +++ b/History.markdown @@ -37,6 +37,7 @@ * [site] Use defaults for docs and news-items (#5744) * Improve collections docs (#5691) * Fix #5730: add gcc and make to the list of requirements (#5731) + * Add missing class (#5791) ### Development Fixes From ad8fb9b927908f52565efbf59e3a4198bfd8c82c Mon Sep 17 00:00:00 2001 From: Parker Moore Date: Tue, 17 Jan 2017 16:19:26 -0500 Subject: [PATCH 81/90] Add theme_dir() helper func --- test/helper.rb | 4 ++++ test/test_theme.rb | 9 ++++----- 2 files changed, 8 insertions(+), 5 deletions(-) diff --git a/test/helper.rb b/test/helper.rb index bb9e5a29..ca60f79f 100644 --- a/test/helper.rb +++ b/test/helper.rb @@ -74,6 +74,10 @@ module DirectoryHelpers test_dir("source", *subdirs) end + def theme_dir(*subdirs) + test_dir("fixtures", "test-theme", *subdirs) + end + def test_dir(*subdirs) root_dir("test", *subdirs) end diff --git a/test/test_theme.rb b/test/test_theme.rb index ab1eff43..3d557dc8 100644 --- a/test/test_theme.rb +++ b/test/test_theme.rb @@ -3,7 +3,6 @@ require "helper" class TestTheme < JekyllUnitTest def setup @theme = Theme.new("test-theme") - @expected_root = File.expand_path "./fixtures/test-theme", File.dirname(__FILE__) end context "initializing" do @@ -13,7 +12,7 @@ class TestTheme < JekyllUnitTest end should "know the theme root" do - assert_equal @expected_root, @theme.root + assert_equal theme_dir, @theme.root end should "know the theme version" do @@ -36,13 +35,13 @@ class TestTheme < JekyllUnitTest context "path generation" do [:assets, :_layouts, :_includes, :_sass].each do |folder| should "know the #{folder} path" do - expected = File.expand_path(folder.to_s, @expected_root) + expected = theme_dir(folder.to_s) assert_equal expected, @theme.public_send("#{folder.to_s.tr("_", "")}_path") end end should "generate folder paths" do - expected = File.expand_path("./_sass", @expected_root) + expected = theme_dir("_sass") assert_equal expected, @theme.send(:path_for, :_sass) end @@ -58,7 +57,7 @@ class TestTheme < JekyllUnitTest # no support for symlinks on Windows skip_if_windows "Jekyll does not currently support symlinks on Windows." - expected = File.expand_path("./_layouts", @expected_root) + expected = theme_dir("_layouts") assert_equal expected, @theme.send(:path_for, :_symlink) end end From e0d63c8aa90acd4608cfc34b2dbf2e34c6c7483f Mon Sep 17 00:00:00 2001 From: Parker Moore Date: Tue, 17 Jan 2017 16:19:47 -0500 Subject: [PATCH 82/90] Add test to ensure that if the includes dir isn't in the theme that it won't break the site --- test/test_site.rb | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/test/test_site.rb b/test/test_site.rb index bbf42d25..cee08dfd 100644 --- a/test/test_site.rb +++ b/test/test_site.rb @@ -49,6 +49,17 @@ class TestSite < JekyllUnitTest site = Site.new(site_configuration({ "baseurl" => "/blog" })) assert_equal "/blog", site.baseurl end + + should "only include theme includes_path if the path exists" do + site = fixture_site({ "theme" => "test-theme" }) + assert_equal [source_dir("_includes"), theme_dir("_includes")], site.includes_load_paths + + allow(File).to receive(:directory?).with(theme_dir("_sass")).and_return(true) + allow(File).to receive(:directory?).with(theme_dir("_layouts")).and_return(true) + allow(File).to receive(:directory?).with(theme_dir("_includes")).and_return(false) + site = fixture_site({ "theme" => "test-theme" }) + assert_equal [source_dir("_includes")], site.includes_load_paths + end end context "creating sites" do setup do From 023476049befdd61dd9ffabbc3e871034bc3cd9c Mon Sep 17 00:00:00 2001 From: Parker Moore Date: Tue, 17 Jan 2017 16:21:28 -0500 Subject: [PATCH 83/90] Remove superfluous self. --- lib/jekyll/site.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/jekyll/site.rb b/lib/jekyll/site.rb index 3bbeaef3..87ea719b 100644 --- a/lib/jekyll/site.rb +++ b/lib/jekyll/site.rb @@ -435,7 +435,7 @@ module Jekyll private def configure_include_paths @includes_load_paths = Array(in_source_dir(config["includes_dir"].to_s)) - @includes_load_paths << theme.includes_path if self.theme && theme.includes_path + @includes_load_paths << theme.includes_path if theme && theme.includes_path end private From 130159dda4c1c567edc7ce2104a82f0e090b7048 Mon Sep 17 00:00:00 2001 From: Parker Moore Date: Tue, 17 Jan 2017 17:05:14 -0500 Subject: [PATCH 84/90] Fix rubocop error. --- test/test_site.rb | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/test/test_site.rb b/test/test_site.rb index cee08dfd..65032ebd 100644 --- a/test/test_site.rb +++ b/test/test_site.rb @@ -52,7 +52,8 @@ class TestSite < JekyllUnitTest should "only include theme includes_path if the path exists" do site = fixture_site({ "theme" => "test-theme" }) - assert_equal [source_dir("_includes"), theme_dir("_includes")], site.includes_load_paths + assert_equal [source_dir("_includes"), theme_dir("_includes")], + site.includes_load_paths allow(File).to receive(:directory?).with(theme_dir("_sass")).and_return(true) allow(File).to receive(:directory?).with(theme_dir("_layouts")).and_return(true) From a9c7e14d6079e8cfee9adfd7e54e11954e9c0ba1 Mon Sep 17 00:00:00 2001 From: jekyllbot Date: Tue, 17 Jan 2017 18:59:39 -0500 Subject: [PATCH 85/90] Update history to reflect merge of #5780 [ci skip] --- History.markdown | 1 + 1 file changed, 1 insertion(+) diff --git a/History.markdown b/History.markdown index 5971b779..dcf5a619 100644 --- a/History.markdown +++ b/History.markdown @@ -16,6 +16,7 @@ * 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) + * Don't include the theme's includes_path if it is nil. (#5780) ### Site Enhancements From 0b4a097a40bafd278116a7833f87ae1b6cbdc81a Mon Sep 17 00:00:00 2001 From: jekyllbot Date: Tue, 17 Jan 2017 20:20:36 -0500 Subject: [PATCH 86/90] Update history to reflect merge of #5753 [ci skip] --- History.markdown | 1 + 1 file changed, 1 insertion(+) diff --git a/History.markdown b/History.markdown index dcf5a619..55a65c5e 100644 --- a/History.markdown +++ b/History.markdown @@ -83,6 +83,7 @@ * Correct minor typo (#5764) * Fix a markdown link to look properly on the web (#5769) * [docs] Info about the help command usage (#5312) + * Add missing merge labels for jekyllbot (#5753) ## 3.3.1 / 2016-11-14 From 402eb0dfa548ffbbd11a9b9a1fffa90a0ee40b04 Mon Sep 17 00:00:00 2001 From: jekyllbot Date: Tue, 17 Jan 2017 20:21:49 -0500 Subject: [PATCH 87/90] Update history to reflect merge of #5542 [ci skip] --- History.markdown | 1 + 1 file changed, 1 insertion(+) diff --git a/History.markdown b/History.markdown index 55a65c5e..26abb879 100644 --- a/History.markdown +++ b/History.markdown @@ -17,6 +17,7 @@ * Use each instead of map to actually return nothing (#5668) * include: fix 'no implicit conversion of nil to String' (#5750) * Don't include the theme's includes_path if it is nil. (#5780) + * test double slash when input = '/' (#5542) ### Site Enhancements From 0599c2242570d82230f60b70ffa49d8f363f0e1c Mon Sep 17 00:00:00 2001 From: jekyllbot Date: Wed, 18 Jan 2017 14:15:13 -0500 Subject: [PATCH 88/90] Update history to reflect merge of #5640 [ci skip] --- History.markdown | 1 + 1 file changed, 1 insertion(+) diff --git a/History.markdown b/History.markdown index 26abb879..36e70cb6 100644 --- a/History.markdown +++ b/History.markdown @@ -8,6 +8,7 @@ * Update License (#5713) * Use Addressable instead of URI to decode (#5726) * throw IncludeTagError if error occurs in included file (#5767) + * Write Jekyll::Utils::Exec.run for running shell commands. (#5640) ### Bug Fixes From b6bc85ec7cf70dfdde262eb15b0723b191ad21d0 Mon Sep 17 00:00:00 2001 From: Parker Moore Date: Wed, 18 Jan 2017 14:16:08 -0500 Subject: [PATCH 89/90] Correct 2 Style/TrailingCommaInLiteral rubocop offenses in test_filters.rb --- test/test_filters.rb | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/test/test_filters.rb b/test/test_filters.rb index 8b31a171..d18b57e3 100644 --- a/test/test_filters.rb +++ b/test/test_filters.rb @@ -377,7 +377,7 @@ class TestFilters < JekyllUnitTest page_url = "/" filter = make_filter_mock({ "url" => "http://example.com", - "baseurl" => "/base" + "baseurl" => "/base", }) assert_equal "http://example.com/base/", filter.absolute_url(page_url) end @@ -386,7 +386,7 @@ class TestFilters < JekyllUnitTest page_url = "/" filter = make_filter_mock({ "url" => "http://example.com", - "baseurl" => nil + "baseurl" => nil, }) assert_equal "http://example.com/", filter.absolute_url(page_url) end From b2d93913d09740494d5bfedea9a9f459acdf9353 Mon Sep 17 00:00:00 2001 From: jekyllbot Date: Wed, 18 Jan 2017 15:36:13 -0500 Subject: [PATCH 90/90] Update history to reflect merge of #5694 [ci skip] --- History.markdown | 1 + 1 file changed, 1 insertion(+) diff --git a/History.markdown b/History.markdown index 36e70cb6..e9df1fb4 100644 --- a/History.markdown +++ b/History.markdown @@ -41,6 +41,7 @@ * Improve collections docs (#5691) * Fix #5730: add gcc and make to the list of requirements (#5731) * Add missing class (#5791) + * Improve template docs (#5694) ### Development Fixes