RubyGems - jekyll - Versions diffs - 3.9.4 → 4.0.0.pre.alpha1 - Mend

jekyll 3.9.4 → 4.0.0.pre.alpha1

Files changed (96) hide show

checksums.yaml +4 -4
data/.rubocop.yml +27 -50
data/LICENSE +1 -1
data/README.markdown +46 -17
data/lib/blank_template/_config.yml +3 -0
data/lib/blank_template/_layouts/default.html +12 -0
data/lib/blank_template/_sass/main.scss +9 -0
data/lib/blank_template/assets/css/main.scss +4 -0
data/lib/blank_template/index.md +8 -0
data/lib/jekyll/cache.rb +183 -0
data/lib/jekyll/cleaner.rb +2 -1
data/lib/jekyll/collection.rb +78 -8
data/lib/jekyll/command.rb +31 -6
data/lib/jekyll/commands/build.rb +11 -20
data/lib/jekyll/commands/clean.rb +2 -0
data/lib/jekyll/commands/doctor.rb +15 -8
data/lib/jekyll/commands/help.rb +1 -1
data/lib/jekyll/commands/new.rb +37 -42
data/lib/jekyll/commands/new_theme.rb +30 -28
data/lib/jekyll/commands/serve/live_reload_reactor.rb +6 -10
data/lib/jekyll/commands/serve/servlet.rb +15 -19
data/lib/jekyll/commands/serve.rb +46 -86
data/lib/jekyll/configuration.rb +26 -26
data/lib/jekyll/converters/identity.rb +18 -0
data/lib/jekyll/converters/markdown/kramdown_parser.rb +1 -10
data/lib/jekyll/converters/markdown.rb +49 -40
data/lib/jekyll/converters/smartypants.rb +34 -14
data/lib/jekyll/convertible.rb +11 -13
data/lib/jekyll/deprecator.rb +1 -3
data/lib/jekyll/document.rb +44 -41
data/lib/jekyll/drops/collection_drop.rb +2 -3
data/lib/jekyll/drops/document_drop.rb +2 -1
data/lib/jekyll/drops/drop.rb +3 -6
data/lib/jekyll/drops/excerpt_drop.rb +4 -0
data/lib/jekyll/drops/site_drop.rb +4 -13
data/lib/jekyll/drops/unified_payload_drop.rb +1 -0
data/lib/jekyll/drops/url_drop.rb +1 -0
data/lib/jekyll/entry_filter.rb +2 -1
data/lib/jekyll/excerpt.rb +45 -34
data/lib/jekyll/external.rb +10 -5
data/lib/jekyll/filters/date_filters.rb +6 -3
data/lib/jekyll/filters/grouping_filters.rb +1 -2
data/lib/jekyll/filters/url_filters.rb +6 -1
data/lib/jekyll/filters.rb +72 -31
data/lib/jekyll/frontmatter_defaults.rb +35 -19
data/lib/jekyll/hooks.rb +2 -3
data/lib/jekyll/liquid_extensions.rb +0 -2
data/lib/jekyll/liquid_renderer/file.rb +14 -3
data/lib/jekyll/liquid_renderer/table.rb +67 -65
data/lib/jekyll/liquid_renderer.rb +13 -1
data/lib/jekyll/log_adapter.rb +5 -1
data/lib/jekyll/mime.types +80 -195
data/lib/jekyll/page.rb +10 -11
data/lib/jekyll/page_without_a_file.rb +0 -4
data/lib/jekyll/plugin.rb +5 -11
data/lib/jekyll/plugin_manager.rb +2 -0
data/lib/jekyll/reader.rb +38 -8
data/lib/jekyll/readers/data_reader.rb +5 -5
data/lib/jekyll/readers/layout_reader.rb +2 -12
data/lib/jekyll/readers/post_reader.rb +29 -17
data/lib/jekyll/readers/static_file_reader.rb +1 -1
data/lib/jekyll/readers/theme_assets_reader.rb +7 -5
data/lib/jekyll/regenerator.rb +4 -12
data/lib/jekyll/renderer.rb +14 -25
data/lib/jekyll/site.rb +78 -34
data/lib/jekyll/static_file.rb +47 -11
data/lib/jekyll/stevenson.rb +7 -5
data/lib/jekyll/tags/highlight.rb +22 -52
data/lib/jekyll/tags/include.rb +27 -48
data/lib/jekyll/tags/link.rb +11 -7
data/lib/jekyll/tags/post_url.rb +17 -16
data/lib/jekyll/theme.rb +12 -23
data/lib/jekyll/theme_builder.rb +91 -89
data/lib/jekyll/url.rb +3 -2
data/lib/jekyll/utils/ansi.rb +1 -1
data/lib/jekyll/utils/exec.rb +0 -1
data/lib/jekyll/utils/internet.rb +2 -4
data/lib/jekyll/utils/platforms.rb +8 -8
data/lib/jekyll/utils/thread_event.rb +1 -5
data/lib/jekyll/utils/win_tz.rb +47 -18
data/lib/jekyll/utils.rb +5 -4
data/lib/jekyll/version.rb +1 -1
data/lib/jekyll.rb +5 -0
data/lib/site_template/.gitignore +2 -0
data/lib/site_template/404.html +1 -0
data/lib/site_template/_config.yml +17 -5
data/lib/site_template/_posts/0000-00-00-welcome-to-jekyll.markdown.erb +5 -1
data/lib/theme_template/gitignore.erb +1 -0
data/rubocop/jekyll/assert_equal_literal_actual.rb +149 -0
metadata +75 -48
data/lib/jekyll/commands/serve/mime_types_charset.json +0 -71
data/lib/jekyll/converters/markdown/rdiscount_parser.rb +0 -37
data/lib/jekyll/converters/markdown/redcarpet_parser.rb +0 -112
data/lib/jekyll/utils/rouge.rb +0 -22
/data/lib/site_template/{about.md → about.markdown} +0 -0
/data/lib/site_template/{index.md → index.markdown} +0 -0

data/lib/jekyll/commands/serve/servlet.rb CHANGED Viewed

@@ -43,7 +43,7 @@ module Jekyll
       # This class inserts the LiveReload script tags into HTML as it is served
       class BodyProcessor
-        HEAD_TAG_REGEX = %r!<head>|<head[^(er)][^<]*>!
+        HEAD_TAG_REGEX = %r!<head>|<head[^(er)][^<]*>!.freeze
         attr_reader :content_length, :new_body, :livereload_added
@@ -121,9 +121,7 @@ module Jekyll
           if @options["livereload_max_delay"]
             src += "&amp;maxdelay=#{@options["livereload_max_delay"]}"
           end
-          if @options["livereload_port"]
-            src += "&amp;port=#{@options["livereload_port"]}"
-          end
+          src += "&amp;port=#{@options["livereload_port"]}" if @options["livereload_port"]
           src
         end
       end
@@ -137,13 +135,14 @@ module Jekyll
         def initialize(server, root, callbacks)
           # So we can access them easily.
           @jekyll_opts = server.config[:JekyllOptions]
-          @mime_types_charset = server.config[:MimeTypesCharset]
           set_defaults
           super
         end
         def search_index_file(req, res)
-          super || search_file(req, res, ".html")
+          super ||
+            search_file(req, res, ".html") ||
+            search_file(req, res, ".xhtml")
         end
         # Add the ability to tap file.html the same way that Nginx does on our
@@ -152,7 +151,9 @@ module Jekyll
         def search_file(req, res, basename)
           # /file.* > /file/index.html > /file.html
-          super || super(req, res, "#{basename}.html")
+          super ||
+            super(req, res, "#{basename}.html") ||
+            super(req, res, "#{basename}.xhtml")
         end
         # rubocop:disable Naming/MethodName
@@ -173,7 +174,7 @@ module Jekyll
             end
           end
-          conditionally_inject_charset(res)
+          validate_and_ensure_charset(req, res)
           res.header.merge!(@headers)
           rtn
         end
@@ -181,20 +182,15 @@ module Jekyll
         private
-        #
-        # Inject charset based on Jekyll config only if our mime-types database contains
-        # the charset metadata.
-        #
-        # Refer `script/vendor-mimes` in the repository for further details.
-        def conditionally_inject_charset(res)
-          typ = res.header["content-type"]
-          return unless @mime_types_charset.key?(typ)
-          return if %r!;\s*charset=!.match?(typ)
+        def validate_and_ensure_charset(_req, res)
+          key = res.header.keys.grep(%r!content-type!i).first
+          typ = res.header[key]
-          res.header["content-type"] = "#{typ}; charset=#{@jekyll_opts["encoding"]}"
+          unless typ =~ %r!;\s*charset=!
+            res.header[key] = "#{typ}; charset=#{@jekyll_opts["encoding"]}"
+          end
         end
-        #
         def set_defaults
           hash_ = @jekyll_opts.fetch("webrick", {}).fetch("headers", {})
           DEFAULTS.each_with_object(@headers = hash_) do |(key, val), hash|

data/lib/jekyll/commands/serve.rb CHANGED Viewed

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
-require "thread"
 module Jekyll
   module Commands
     class Serve < Command
@@ -19,31 +17,36 @@ module Jekyll
           "host"                 => ["host", "-H", "--host [HOST]", "Host to bind to"],
           "open_url"             => ["-o", "--open-url", "Launch your site in a browser"],
           "detach"               => ["-B", "--detach",
-            "Run the server in the background",],
+                                     "Run the server in the background",],
           "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.",],
           "livereload"           => ["-l", "--livereload",
-            "Use LiveReload to automatically refresh browsers",],
+                                     "Use LiveReload to automatically refresh browsers",],
           "livereload_ignore"    => ["--livereload-ignore ignore GLOB1[,GLOB2[,...]]",
-            Array,
-            "Files for LiveReload to ignore. Remember to quote the values so your shell "\
-            "won't expand them",],
+                                     Array,
+                                     "Files for LiveReload to ignore. " \
+                                     "Remember to quote the values so your shell " \
+                                     "won't expand them",],
           "livereload_min_delay" => ["--livereload-min-delay [SECONDS]",
-            "Minimum reload delay",],
+                                     "Minimum reload delay",],
           "livereload_max_delay" => ["--livereload-max-delay [SECONDS]",
-            "Maximum reload delay",],
+                                     "Maximum reload delay",],
           "livereload_port"      => ["--livereload-port [PORT]", Integer,
-            "Port for LiveReload to listen on",],
+                                     "Port for LiveReload to listen on",],
         }.freeze
         DIRECTORY_INDEX = %w(
           index.htm
           index.html
           index.rhtml
+          index.xht
+          index.xhtml
           index.cgi
           index.xml
           index.json
@@ -72,25 +75,17 @@ module Jekyll
               opts["serving"] = true
               opts["watch"]   = true unless opts.key?("watch")
-              start(opts)
-            end
-          end
-        end
+              # Set the reactor to nil so any old reactor will be GCed.
+              # We can't unregister a hook so while running tests we don't want to
+              # inadvertently keep using a reactor created by a previous test.
+              @reload_reactor = nil
-        #
-        def start(opts)
-          # Set the reactor to nil so any old reactor will be GCed.
-          # We can't unregister a hook so in testing when Serve.start is
-          # called multiple times we don't want to inadvertently keep using
-          # a reactor created by a previous test when our test might not
-          @reload_reactor = nil
+              config = configuration_from_options(opts)
+              config["url"] = default_url(config) if Jekyll.env == "development"
-          config = configuration_from_options(opts)
-          if Jekyll.env == "development"
-            config["url"] = default_url(config)
+              process_with_graceful_fail(cmd, config, Build, Serve)
+            end
           end
-          [Build, Serve].each { |klass| klass.process(config) }
         end
         #
@@ -98,7 +93,10 @@ module Jekyll
         def process(opts)
           opts = configuration_from_options(opts)
           destination = opts["destination"]
-          register_reload_hooks(opts) if opts["livereload"]
+          if opts["livereload"]
+            validate_options(opts)
+            register_reload_hooks(opts)
+          end
           setup(destination)
           start_up_webrick(opts, destination)
@@ -111,11 +109,12 @@ module Jekyll
         # Perform logical validation of CLI options
         private
         def validate_options(opts)
           if opts["livereload"]
             if opts["detach"]
-              Jekyll.logger.warn "Warning:",
-                "--detach and --livereload are mutually exclusive. Choosing --livereload"
+              Jekyll.logger.warn "Warning:", "--detach and --livereload are mutually exclusive." \
+                                 " Choosing --livereload"
               opts["detach"] = false
             end
             if opts["ssl_cert"] || opts["ssl_key"]
@@ -130,18 +129,15 @@ module Jekyll
               opts["watch"] = true
             end
           elsif %w(livereload_min_delay
-              livereload_max_delay
-              livereload_ignore
-              livereload_port).any? { |o| opts[o] }
+                   livereload_max_delay
+                   livereload_ignore
+                   livereload_port).any? { |o| opts[o] }
             Jekyll.logger.abort_with "--livereload-min-delay, "\
                "--livereload-max-delay, --livereload-ignore, and "\
                "--livereload-port require the --livereload option."
           end
         end
-        #
-        private
         # rubocop:disable Metrics/AbcSize
         def register_reload_hooks(opts)
           require_relative "serve/live_reload_reactor"
@@ -179,7 +175,6 @@ module Jekyll
         # when we get ready to party, checking for an setting up an error page
         # and making sure our destination exists.
-        private
         def setup(destination)
           require_relative "serve/servlet"
@@ -194,15 +189,11 @@ module Jekyll
           end
         end
-        #
-        private
         def webrick_opts(opts)
           opts = {
             :JekyllOptions      => opts,
             :DoNotReverseLookup => true,
             :MimeTypes          => mime_types,
-            :MimeTypesCharset   => mime_types_charset,
             :DocumentRoot       => opts["destination"],
             :StartCallback      => start_callback(opts["detach"]),
             :StopCallback       => stop_callback(opts["detach"]),
@@ -218,13 +209,8 @@ module Jekyll
           opts
         end
-        #
-        private
         def start_up_webrick(opts, destination)
-          if opts["livereload"]
-            @reload_reactor.start(opts)
-          end
+          @reload_reactor.start(opts) if opts["livereload"]
           @server = WEBrick::HTTPServer.new(webrick_opts(opts)).tap { |o| o.unmount("") }
           @server.mount(opts["baseurl"].to_s, Servlet, destination, file_handler_opts)
@@ -235,20 +221,15 @@ module Jekyll
         end
         # Recreate NondisclosureName under utf-8 circumstance
-        private
         def file_handler_opts
-          WEBrick::Config::FileHandler.merge({
+          WEBrick::Config::FileHandler.merge(
             :FancyIndexing     => true,
             :NondisclosureName => [
               ".ht*", "~*",
-            ],
-          })
+            ]
+          )
         end
-        #
-        private
         def server_address(server, options = {})
           format_url(
             server.config[:SSLEnable],
@@ -258,19 +239,14 @@ module Jekyll
           )
         end
-        private
         def format_url(ssl_enabled, address, port, baseurl = nil)
-          format("%<prefix>s://%<address>s:%<port>i%<baseurl>s", {
-            :prefix  => ssl_enabled ? "https" : "http",
-            :address => address,
-            :port    => port,
-            :baseurl => baseurl ? "#{baseurl}/" : "",
-          })
+          format("%<prefix>s://%<address>s:%<port>i%<baseurl>s",
+                 :prefix  => ssl_enabled ? "https" : "http",
+                 :address => address,
+                 :port    => port,
+                 :baseurl => baseurl ? "#{baseurl}/" : "")
         end
-        #
-        private
         def default_url(opts)
           config = configuration_from_options(opts)
           format_url(
@@ -280,14 +256,12 @@ module Jekyll
           )
         end
-        #
-        private
         def launch_browser(server, opts)
           address = server_address(server, opts)
           return system "start", address if Utils::Platforms.windows?
           return system "xdg-open", address if Utils::Platforms.linux?
           return system "open", address if Utils::Platforms.osx?
           Jekyll.logger.error "Refusing to launch browser; " \
             "Platform launcher unknown."
         end
@@ -295,8 +269,6 @@ module Jekyll
         # Keep in our area with a thread or detach the server as requested
         # by the user.  This method determines what we do based on what you
         # ask us to do.
-        private
         def boot_or_detach(server, opts)
           if opts["detach"]
             pid = Process.fork do
@@ -305,7 +277,8 @@ module Jekyll
             Process.detach(pid)
             Jekyll.logger.info "Server detached with pid '#{pid}'.", \
-              "Run `pkill -f jekyll' or `kill -9 #{pid}' to stop the server."
+                               "Run `pkill -f jekyll' or `kill -9 #{pid}'" \
+                               " to stop the server."
           else
             t = Thread.new { server.start }
             trap("INT") { server.shutdown }
@@ -314,8 +287,6 @@ module Jekyll
         end
         # Make the stack verbose if the user requests it.
-        private
         def enable_logging(opts)
           opts[:AccessLog] = []
           level = WEBrick::Log.const_get(opts[:JekyllOptions]["verbose"] ? :DEBUG : :WARN)
@@ -325,8 +296,6 @@ module Jekyll
         # Add SSL to the stack if the user triggers --enable-ssl and they
         # provide both types of certificates commonly needed.  Raise if they
         # forget to add one of the certificates.
-        private
         def enable_ssl(opts)
           cert, key, src =
             opts[:JekyllOptions].values_at("ssl_cert", "ssl_key", "source")
@@ -342,13 +311,12 @@ module Jekyll
           opts[:SSLEnable] = true
         end
-        private
         def start_callback(detached)
           unless detached
             proc do
               mutex.synchronize do
                 # Block until EventMachine reactor starts
-                @reload_reactor.started_event.wait unless @reload_reactor.nil?
+                @reload_reactor&.started_event&.wait
                 @running = true
                 Jekyll.logger.info("Server running...", "press ctrl-c to stop.")
                 @run_cond.broadcast
@@ -357,7 +325,6 @@ module Jekyll
           end
         end
-        private
         def stop_callback(detached)
           unless detached
             proc do
@@ -373,18 +340,11 @@ module Jekyll
           end
         end
-        private
         def mime_types
           file = File.expand_path("../mime.types", __dir__)
           WEBrick::HTTPUtils.load_mime_types(file)
         end
-        private
-        def mime_types_charset
-          SafeYAML.load_file(File.expand_path("serve/mime_types_charset.json", __dir__))
-        end
         def read_file(source_dir, file_path)
           File.read(Jekyll.sanitized_path(source_dir, file_path))
         end

data/lib/jekyll/configuration.rb CHANGED Viewed

@@ -9,6 +9,7 @@ module Jekyll
       "source"              => Dir.pwd,
       "destination"         => File.join(Dir.pwd, "_site"),
       "collections_dir"     => "",
+      "cache_dir"           => ".jekyll-cache",
       "plugins_dir"         => "_plugins",
       "layouts_dir"         => "_layouts",
       "data_dir"            => "_data",
@@ -18,10 +19,7 @@ module Jekyll
       # Handling Reading
       "safe"                => false,
       "include"             => [".htaccess"],
-      "exclude"             => %w(
-        Gemfile Gemfile.lock node_modules vendor/bundle/ vendor/cache/ vendor/gems/
-        vendor/ruby/
-      ),
+      "exclude"             => [],
       "keep_files"          => [".git", ".svn"],
       "encoding"            => "utf-8",
       "markdown_ext"        => "markdown,mkdown,mkdn,mkd,md",
@@ -66,14 +64,6 @@ module Jekyll
         "strict_variables" => false,
       },
-      "rdiscount"           => {
-        "extensions" => [],
-      },
-      "redcarpet"           => {
-        "extensions" => [],
-      },
       "kramdown"            => {
         "auto_ids"      => true,
         "toc_levels"    => "1..6",
@@ -100,7 +90,7 @@ module Jekyll
       # problems and backwards-compatibility.
       def from(user_config)
         Utils.deep_merge_hashes(DEFAULTS, Configuration[user_config].stringify_keys)
-          .add_default_collections
+          .add_default_collections.add_default_excludes
       end
     end
@@ -162,7 +152,7 @@ module Jekyll
       # Get configuration from <source>/_config.yml or <source>/<config_file>
       config_files = override["config"]
       if config_files.to_s.empty?
-        default = %w(yml yaml).find(-> { "yml" }) do |ext|
+        default = %w(yml yaml toml).find(-> { "yml" }) do |ext|
           File.exist?(Jekyll.sanitized_path(source(override), "_config.#{ext}"))
         end
         config_files = Jekyll.sanitized_path(source(override), "_config.#{default}")
@@ -177,6 +167,7 @@ module Jekyll
     #
     # Returns this configuration, overridden by the values in the file
     def read_config_file(file)
+      file = File.expand_path(file)
       next_config = safe_load_file(file)
       check_config_is_hash!(next_config, file)
       Jekyll.logger.info "Configuration file:", file
@@ -204,6 +195,7 @@ module Jekyll
       begin
         files.each do |config_file|
           next if config_file.nil? || config_file.empty?
           new_config = read_config_file(config_file)
           configuration = Utils.deep_merge_hashes(configuration, new_config)
         end
@@ -277,7 +269,22 @@ module Jekyll
       config
     end
-    def renamed_key(old, new, config, _ = nil)
+    DEFAULT_EXCLUDES = %w(
+      .sass-cache .jekyll-cache
+      gemfiles Gemfile Gemfile.lock
+      node_modules
+      vendor/bundle/ vendor/cache/ vendor/gems/ vendor/ruby/
+    ).freeze
+    def add_default_excludes
+      config = clone
+      return config if config["exclude"].nil?
+      config["exclude"].concat(DEFAULT_EXCLUDES).uniq!
+      config
+    end
+    def renamed_key(old, new, config)
       if config.key?(old)
         Jekyll::Deprecator.deprecation_message "The '#{old}' configuration" \
           " option has been renamed to '#{new}'. Please update your config" \
@@ -287,6 +294,7 @@ module Jekyll
     end
     private
     def style_to_permalink(permalink_style)
       case permalink_style.to_sym
       when :pretty
@@ -308,14 +316,12 @@ module Jekyll
     # file - the file from which the config was extracted
     #
     # Raises an ArgumentError if given config is not a hash
-    private
     def check_config_is_hash!(extracted_config, file)
       unless extracted_config.is_a?(Hash)
         raise ArgumentError, "Configuration file: (INVALID) #{file}".yellow
       end
     end
-    private
     def check_auto(config)
       if config.key?("auto") || config.key?("watch")
         Jekyll::Deprecator.deprecation_message "Auto-regeneration can no longer" \
@@ -326,7 +332,6 @@ module Jekyll
       end
     end
-    private
     def check_server(config)
       if config.key?("server")
         Jekyll::Deprecator.deprecation_message "The 'server' configuration option" \
@@ -336,7 +341,6 @@ module Jekyll
       end
     end
-    private
     def check_pygments(config)
       if config.key?("pygments")
         Jekyll::Deprecator.deprecation_message "The 'pygments' configuration option" \
@@ -349,7 +353,6 @@ module Jekyll
       end
     end
-    private
     def check_include_exclude(config)
       %w(include exclude).each do |option|
         if config[option].is_a?(String)
@@ -359,11 +362,10 @@ module Jekyll
             " as a list of comma-separated values."
           config[option] = csv_to_array(config[option])
         end
-        config[option].map!(&:to_s) if config[option]
+        config[option]&.map!(&:to_s)
       end
     end
-    private
     def check_coderay(config)
       if (config["kramdown"] || {}).key?("use_coderay")
         Jekyll::Deprecator.deprecation_message "Please change 'use_coderay'" \
@@ -372,7 +374,6 @@ module Jekyll
       end
     end
-    private
     def check_maruku(config)
       if config.fetch("markdown", "kramdown").to_s.casecmp("maruku").zero?
         Jekyll.logger.abort_with "Error:", "You're using the 'maruku' " \
@@ -389,7 +390,6 @@ module Jekyll
     #
     # Raises a Jekyll::Errors::InvalidConfigurationError if the config `plugins`
     # is a string
-    private
     def check_plugins(config)
       if config.key?("plugins") && config["plugins"].is_a?(String)
         Jekyll.logger.error "Configuration Error:", "You specified the" \
@@ -397,8 +397,8 @@ module Jekyll
           " use an array instead. If you wanted to set the directory of your" \
           " plugins, use the config key `plugins_dir` instead."
         raise Jekyll::Errors::InvalidConfigurationError,
-          "'plugins' should not be a string, but was: " \
-          "#{config["plugins"].inspect}. Use 'plugins_dir' instead."
+              "'plugins' should not be a string, but was: " \
+              "#{config["plugins"].inspect}. Use 'plugins_dir' instead."
       end
     end
   end

data/lib/jekyll/converters/identity.rb CHANGED Viewed

@@ -2,19 +2,37 @@
 module Jekyll
   module Converters
+    # Identify converter. Returns same content as given.
+    # For more info on converters see https://jekyllrb.com/docs/plugins/converters/
     class Identity < Converter
       safe true
       priority :lowest
+      # Public: Does the given extension match this converter's list of acceptable extensions?
+      # Takes one argument: the file's extension (including the dot).
+      #
+      # ext - The String extension to check (not relevant here)
+      #
+      # Returns true since it always matches.
       def matches(_ext)
         true
       end
+      # Public: The extension to be given to the output file (including the dot).
+      #
+      # ext - The String extension or original file.
+      #
+      # Returns The String output file extension.
       def output_ext(ext)
         ext
       end
+      # Logic to do the content conversion.
+      #
+      # content - String content of file (without front matter).
+      #
+      # Returns a String of the converted content.
       def convert(content)
         content
       end

data/lib/jekyll/converters/markdown/kramdown_parser.rb CHANGED Viewed

@@ -31,7 +31,6 @@ module Jekyll
         def setup
           @config["syntax_highlighter"] ||= highlighter
           @config["syntax_highlighter_opts"] ||= {}
-          @config["syntax_highlighter_opts"]["default_lang"] ||= "plaintext"
           @config["syntax_highlighter_opts"]["guess_lang"] = @config["guess_lang"]
           @config["coderay"] ||= {} # XXX: Legacy.
           modernize_coderay_config
@@ -52,10 +51,7 @@ module Jekyll
         private
         def load_dependencies
-          return if Kramdown::VERSION.to_i < 2
-          if @config["input"] == "GFM"
-            Jekyll::External.require_with_graceful_fail("kramdown-parser-gfm")
-          end
+          require "kramdown-parser-gfm" if @config["input"] == "GFM"
           if highlighter == "coderay"
             Jekyll::External.require_with_graceful_fail("kramdown-syntax-coderay")
@@ -80,8 +76,6 @@ module Jekyll
         #   config[highlighter]
         # Where `enable_coderay` is now deprecated because Kramdown
         # supports Rouge now too.
-        private
         def highlighter
           return @highlighter if @highlighter
@@ -105,7 +99,6 @@ module Jekyll
           end
         end
-        private
         def strip_coderay_prefix(hash)
           hash.each_with_object({}) do |(key, val), hsh|
             cleaned_key = key.to_s.gsub(%r!\Acoderay_!, "")
@@ -123,8 +116,6 @@ module Jekyll
         # If our highlighter is CodeRay we go in to merge the CodeRay defaults
         # with your "coderay" key if it's there, deprecating it in the
         # process of you using it.
-        private
         def modernize_coderay_config
           unless @config["coderay"].empty?
             Jekyll::Deprecator.deprecation_message(