From 229cedfc500f60021b61b6f16d86d9c2a06cb933 Mon Sep 17 00:00:00 2001 From: Parker Moore Date: Wed, 6 Aug 2014 16:01:47 -0400 Subject: [PATCH] Reorganize and update default configuration settings. #2456. --- lib/jekyll/configuration.rb | 58 +++++++++++++----------- site/_docs/configuration.md | 89 ++++++++++++++++++++++--------------- 2 files changed, 85 insertions(+), 62 deletions(-) diff --git a/lib/jekyll/configuration.rb b/lib/jekyll/configuration.rb index 23a8bcc5..97f2e261 100644 --- a/lib/jekyll/configuration.rb +++ b/lib/jekyll/configuration.rb @@ -6,47 +6,55 @@ module Jekyll # Default options. Overridden by values in _config.yml. # Strings rather than symbols are used for compatibility with YAML. DEFAULTS = { + # Where things are 'source' => Dir.pwd, 'destination' => File.join(Dir.pwd, '_site'), 'plugins' => '_plugins', 'layouts' => '_layouts', 'data_source' => '_data', - 'keep_files' => ['.git','.svn'], - 'gems' => [], 'collections' => nil, - 'timezone' => nil, # use the local timezone - - 'encoding' => 'utf-8', # always use utf-8 encoding. NEVER FORGET - + # Handling Reading 'safe' => false, - 'detach' => false, # default to not detaching the server - 'show_drafts' => nil, - 'limit_posts' => 0, - 'lsi' => false, - 'future' => true, # remove and make true just default - 'unpublished' => false, - - 'relative_permalinks' => false, - - 'markdown' => 'kramdown', - 'highlighter' => 'pygments', - 'permalink' => 'date', - 'baseurl' => '', 'include' => ['.htaccess'], 'exclude' => [], - 'paginate_path' => '/page:num', - + 'keep_files' => ['.git','.svn'], + 'encoding' => 'utf-8', 'markdown_ext' => 'markdown,mkdown,mkdn,mkd,md', 'textile_ext' => 'textile', - 'quiet' => false, - 'port' => '4000', - 'host' => '0.0.0.0', + # Filtering Content + 'show_drafts' => nil, + 'limit_posts' => 0, + 'future' => true, # remove and make true just default + 'unpublished' => false, + # Plugins + 'whitelist' => [], + 'gems' => [], + + # Conversion + 'markdown' => 'kramdown', + 'highlighter' => 'pygments', + 'lsi' => false, 'excerpt_separator' => "\n\n", - 'defaults' => [], + # Serving + 'detach' => false, # default to not detaching the server + 'port' => '4000', + 'host' => '0.0.0.0', + 'baseurl' => '', + + # Backwards-compatibility options + 'relative_permalinks' => false, + + # Output Configuration + 'permalink' => 'date', + 'paginate_path' => '/page:num', + 'timezone' => nil, # use the local timezone + + 'quiet' => false, + 'defaults' => [], 'maruku' => { 'use_tex' => false, diff --git a/site/_docs/configuration.md b/site/_docs/configuration.md index 835e8b6f..4c1a0e4d 100644 --- a/site/_docs/configuration.md +++ b/site/_docs/configuration.md @@ -400,42 +400,57 @@ configuration file or on the command-line, Jekyll will run using these options. {% highlight yaml %} +# Where things are source: . destination: ./_site plugins: ./_plugins layouts: ./_layouts -include: ['.htaccess'] -exclude: [] -keep_files: ['.git','.svn'] -gems: [] -timezone: nil -encoding: nil +data_source: ./_data +collections: nil -future: true -show_drafts: false +# Handling Reading +safe: false +include: [".htaccess"] +exclude: [] +keep_files: [".git", ".svn"] +encoding: "utf-8" +markdown_ext: "markdown,mkdown,mkdn,mkd,md" +textile_ext: "textile" + +# Filtering Content +show_drafts: nil limit_posts: 0 +future: true +unpublished: false + +# Plugins +whitelist: [] +gems: [] + +# Conversion +markdown: kramdown highlighter: pygments - -relative_permalinks: true - -permalink: date -paginate_path: 'page:num' -paginate: nil - -markdown: kramdown -markdown_ext: markdown,mkdown,mkdn,mkd,md -textile_ext: textile - +lsi: false excerpt_separator: "\n\n" -safe: false -watch: false # deprecated -server: false # deprecated -host: 0.0.0.0 -port: 4000 -baseurl: "" -lsi: false +# Serving +detach: false +port: 4000 +host: 0.0.0.0 +baseurl: "" # does not include hostname +# Backwards-compatibility +relative_permalinks: false + +# Outputting +permalink: date +paginate_path: /page:num +timezone: nil + +quiet: false +defaults: [] + +# Markdown Processors maruku: use_tex: false use_divs: false @@ -451,20 +466,20 @@ redcarpet: extensions: [] kramdown: - auto_ids: true - footnote_nr: 1 + auto_ids: true + footnote_nr: 1 entity_output: as_char - toc_levels: 1..6 - smart_quotes: lsquo,rsquo,ldquo,rdquo - use_coderay: false + toc_levels: 1..6 + smart_quotes: lsquo,rsquo,ldquo,rdquo + use_coderay: false coderay: - coderay_wrap: div - coderay_line_numbers: inline - coderay_line_numbers_start: 1 - coderay_tab_width: 4 - coderay_bold_every: 10 - coderay_css: style + coderay_wrap: div + coderay_line_numbers: inline + coderay_line_number_start: 1 + coderay_tab_width: 4 + coderay_bold_every: 10 + coderay_css: style redcloth: hard_breaks: true