jekyll 1.0.0.beta3 → 1.0.0.beta4

Sign up to get free protection for your applications and to get access to all the features.

Potentially problematic release.


This version of jekyll might be problematic. Click here for more details.

data/CONTRIBUTING.md CHANGED
@@ -15,9 +15,10 @@ following in mind:
15
15
  would be appreciated, and once merged it will be transferred over to the main
16
16
  wiki.
17
17
  * If your contribution changes any Jekyll behavior, make sure to update the
18
- documentation. It lives in site/_posts. If the docs are missing information,
18
+ documentation. It lives in `site/_posts`. If the docs are missing information,
19
19
  please feel free to add it in. Great docs make a great project!
20
- * Please follow the [Github Ruby Styleguide](https://github.com/styleguide/ruby) when modifying Ruby code.
20
+ * Please follow the [GitHub Ruby Styleguide](https://github.com/styleguide/ruby)
21
+ when modifying Ruby code.
21
22
 
22
23
  Test Dependencies
23
24
  -----------------
data/History.txt CHANGED
@@ -4,7 +4,13 @@
4
4
  * Refactored jekyll commands into subcommands: build, serve, and migrate. (#690)
5
5
  * Removed importers/migrators from main project, migrated to jekyll-import sub-gem (#793)
6
6
  * Added ability to render drafts in _drafts folder via command line (#833)
7
+ * Add ordinal date permalink style (/:categories/:year/:y_day/:title.html) (#928)
7
8
  * Minor Enhancements
9
+ * Add paginator.previous_page_path and paginator.next_page_path (#942)
10
+ * Backwards compatibility for 'auto' (#821, #934)
11
+ * Added date_to_rfc822 used on RSS feeds (#892)
12
+ * Upgrade version of pygments.rb to 0.4.2 (#927)
13
+ * Added short month (e.g. "Sep") to permalink style options for posts (#890)
8
14
  * Expose site.baseurl to Liquid templates (#869)
9
15
  * Adds excerpt attribute to posts which contains first paragraph of content (#837)
10
16
  * Accept custom configuration file via CLI (#863)
@@ -30,6 +36,8 @@
30
36
  * Add source and destination directory protection (#535)
31
37
  * Better YAML error message (#718)
32
38
  * Bug Fixes
39
+ * Fix cascade problem with site.baseurl, site.port and site.host. (#935)
40
+ * Filter out directories with valid post names (#875)
33
41
  * Fix symlinked static files not being correctly built in unsafe mode (#909)
34
42
  * Fix integration with directory_watcher 1.4.x (#916)
35
43
  * Accepting strings as arguments to jekyll-import command (#910)
@@ -48,9 +56,11 @@
48
56
  * Add SVG support to Jekyll/WEBrick. (#407, #406)
49
57
  * Prevent custom destination from causing continuous regen on watch (#528, #820, #862)
50
58
  * Site Enhancements
59
+ * Clean up site docs to prepare for 1.0 release (#918)
51
60
  * Bring site into master branch with better preview/deploy (#709)
52
61
  * Redesigned site (#583)
53
62
  * Development fixes
63
+ * Exclude Cucumber 1.2.4, which causes tests to fail in 1.9.2 (#938)
54
64
  * Added "features:html" rake task for debugging purposes, cleaned up
55
65
  cucumber profiles (#832)
56
66
  * Explicitly require HTTPS rubygems source in Gemfile (#826)
data/README.textile CHANGED
@@ -31,7 +31,6 @@ h2. Runtime Dependencies
31
31
  * Kramdown: Markdown-superset converter (Ruby)
32
32
  * Liquid: Templating system (Ruby)
33
33
  * Maruku: Default markdown engine (Ruby)
34
- * Pygments: Syntax highlighting (Python)
35
34
 
36
35
  h2. Developer Dependencies
37
36
 
@@ -43,4 +42,4 @@ h2. Developer Dependencies
43
42
 
44
43
  h2. License
45
44
 
46
- See LICENSE.
45
+ See "LICENSE":https://github.com/mojombo/jekyll/blob/master/LICENSE.
data/bin/jekyll CHANGED
@@ -75,10 +75,7 @@ command :serve do |c|
75
75
  c.option '-b', '--baseurl [URL]', 'Base URL'
76
76
 
77
77
  c.action do |args, options|
78
- options.default :port => '4000',
79
- :host => '0.0.0.0',
80
- :baseurl => '/',
81
- :serving => true
78
+ options.default :serving => true
82
79
 
83
80
  options = normalize_options(options.__hash__)
84
81
  options = Jekyll.configuration(options)
@@ -21,28 +21,24 @@ Given /^I have an? "(.*)" page(?: with (.*) "(.*)")? that contains "(.*)"$/ do |
21
21
  ---
22
22
  #{text}
23
23
  EOF
24
- f.close
25
24
  end
26
25
  end
27
26
 
28
27
  Given /^I have an? "(.*)" file that contains "(.*)"$/ do |file, text|
29
28
  File.open(file, 'w') do |f|
30
29
  f.write(text)
31
- f.close
32
30
  end
33
31
  end
34
32
 
35
33
  Given /^I have a (.*) layout that contains "(.*)"$/ do |layout, text|
36
34
  File.open(File.join('_layouts', layout + '.html'), 'w') do |f|
37
35
  f.write(text)
38
- f.close
39
36
  end
40
37
  end
41
38
 
42
39
  Given /^I have a (.*) theme that contains "(.*)"$/ do |layout, text|
43
40
  File.open(File.join('_theme', layout + '.html'), 'w') do |f|
44
41
  f.write(text)
45
- f.close
46
42
  end
47
43
  end
48
44
 
@@ -87,7 +83,6 @@ Given /^I have the following (draft|post)s?(?: (.*) "(.*)")?:$/ do |status, dire
87
83
  ---
88
84
  #{content}
89
85
  EOF
90
- f.close
91
86
  end
92
87
  end
93
88
  end
@@ -95,7 +90,6 @@ end
95
90
  Given /^I have a configuration file with "(.*)" set to "(.*)"$/ do |key, value|
96
91
  File.open('_config.yml', 'w') do |f|
97
92
  f.write("#{key}: #{value}\n")
98
- f.close
99
93
  end
100
94
  end
101
95
 
@@ -104,7 +98,6 @@ Given /^I have a configuration file with:$/ do |table|
104
98
  table.hashes.each do |row|
105
99
  f.write("#{row["key"]}: #{row["value"]}\n")
106
100
  end
107
- f.close
108
101
  end
109
102
  end
110
103
 
@@ -114,7 +107,6 @@ Given /^I have a configuration file with "([^\"]*)" set to:$/ do |key, table|
114
107
  table.hashes.each do |row|
115
108
  f.write("- #{row["value"]}\n")
116
109
  end
117
- f.close
118
110
  end
119
111
  end
120
112
 
data/jekyll.gemspec CHANGED
@@ -4,9 +4,9 @@ Gem::Specification.new do |s|
4
4
  s.rubygems_version = '1.3.5'
5
5
 
6
6
  s.name = 'jekyll'
7
- s.version = '1.0.0.beta3'
7
+ s.version = '1.0.0.beta4'
8
8
  s.license = 'MIT'
9
- s.date = '2013-04-04'
9
+ s.date = '2013-04-09'
10
10
  s.rubyforge_project = 'jekyll'
11
11
 
12
12
  s.summary = "A simple, blog aware, static site generator."
@@ -28,7 +28,7 @@ Gem::Specification.new do |s|
28
28
  s.add_runtime_dependency('directory_watcher', "~> 1.4.1")
29
29
  s.add_runtime_dependency('maruku', "~> 0.5")
30
30
  s.add_runtime_dependency('kramdown', "~> 0.14")
31
- s.add_runtime_dependency('pygments.rb', "~> 0.3.2")
31
+ s.add_runtime_dependency('pygments.rb', "~> 0.4.2")
32
32
  s.add_runtime_dependency('commander', "~> 4.1.3")
33
33
  s.add_runtime_dependency('safe_yaml', "~> 0.7.0")
34
34
 
@@ -37,7 +37,7 @@ Gem::Specification.new do |s|
37
37
  s.add_development_dependency('redgreen', "~> 1.2")
38
38
  s.add_development_dependency('shoulda', "~> 3.3.2")
39
39
  s.add_development_dependency('rr', "~> 1.0")
40
- s.add_development_dependency('cucumber', "~> 1.2.1")
40
+ s.add_development_dependency('cucumber', "~> 1.2.1", '!= 1.2.4')
41
41
  s.add_development_dependency('RedCloth', "~> 4.2")
42
42
  s.add_development_dependency('rdiscount', "~> 1.6")
43
43
  s.add_development_dependency('redcarpet', "~> 2.2.2")
@@ -192,6 +192,7 @@ Gem::Specification.new do |s|
192
192
  test/source/_posts/2013-01-02-post-excerpt.markdown
193
193
  test/source/_posts/2013-01-12-nil-layout.textile
194
194
  test/source/_posts/2013-01-12-no-layout.textile
195
+ test/source/_posts/2013-03-19-not-a-post.markdown/.gitkeep
195
196
  test/source/about.html
196
197
  test/source/category/_posts/2008-9-23-categories.textile
197
198
  test/source/contacts.html
data/lib/jekyll.rb CHANGED
@@ -52,7 +52,7 @@ require_all 'jekyll/tags'
52
52
  SafeYAML::OPTIONS[:suppress_warnings] = true
53
53
 
54
54
  module Jekyll
55
- VERSION = '1.0.0.beta3'
55
+ VERSION = '1.0.0.beta4'
56
56
 
57
57
  # Default options. Overriden by values in _config.yml.
58
58
  # Strings rather than symbols are used for compatability with YAML.
@@ -64,17 +64,20 @@ module Jekyll
64
64
  'keep_files' => ['.git','.svn'],
65
65
 
66
66
  'future' => true, # remove and make true just default
67
- 'pygments' => true, # remove and make true just default
67
+ 'pygments' => true, # remove and make true just default
68
68
 
69
69
  'markdown' => 'maruku',
70
70
  'permalink' => 'date',
71
- 'baseurl' => '',
71
+ 'baseurl' => '/',
72
72
  'include' => ['.htaccess'],
73
73
  'paginate_path' => 'page:num',
74
74
 
75
75
  'markdown_ext' => 'markdown,mkd,mkdn,md',
76
76
  'textile_ext' => 'textile',
77
77
 
78
+ 'port' => '4000',
79
+ 'host' => '0.0.0.0',
80
+
78
81
  'excerpt_separator' => "\n\n",
79
82
 
80
83
  'maruku' => {
@@ -152,6 +155,13 @@ module Jekyll
152
155
  config = {}
153
156
  end
154
157
 
158
+ # Provide backwards-compatibility
159
+ if config['auto']
160
+ $stderr.puts "Deprecation: ".rjust(20) + "'auto' has been changed to " +
161
+ "'watch'. Please update your configuration to use 'watch'."
162
+ config['watch'] = config['auto']
163
+ end
164
+
155
165
  # Merge DEFAULTS < _config.yml < override
156
166
  Jekyll::DEFAULTS.deep_merge(config).deep_merge(override)
157
167
  end
@@ -56,6 +56,20 @@ module Jekyll
56
56
  date.xmlschema
57
57
  end
58
58
 
59
+ # Format a date according to RFC-822
60
+ #
61
+ # date - The Time to format.
62
+ #
63
+ # Examples
64
+ #
65
+ # date_to_rfc822(Time.now)
66
+ # # => "Sun, 24 Apr 2011 12:34:46 +0000"
67
+ #
68
+ # Returns the formatted String.
69
+ def date_to_rfc822(date)
70
+ date.rfc822
71
+ end
72
+
59
73
  # XML escape a string for use. Replaces any special characters with
60
74
  # appropriate HTML entity replacements.
61
75
  #
@@ -37,7 +37,7 @@ module Jekyll
37
37
  if num_page > 1
38
38
  newpage = Page.new(site, site.source, page.dir, page.name)
39
39
  newpage.pager = pager
40
- newpage.dir = File.join(page.dir, paginate_path(site, num_page))
40
+ newpage.dir = File.join(page.dir, Pager.paginate_path(site.config, num_page))
41
41
  site.pages << newpage
42
42
  else
43
43
  page.pager = pager
@@ -45,16 +45,12 @@ module Jekyll
45
45
  end
46
46
  end
47
47
 
48
- private
49
- def paginate_path(site, num_page)
50
- format = site.config['paginate_path']
51
- format.sub(':num', num_page.to_s)
52
- end
53
48
  end
54
49
  end
55
50
 
56
51
  class Pager
57
- attr_reader :page, :per_page, :posts, :total_posts, :total_pages, :previous_page, :next_page
52
+ attr_reader :page, :per_page, :posts, :total_posts, :total_pages,
53
+ :previous_page, :previous_page_path, :next_page, :next_page_path
58
54
 
59
55
  # Calculate the number of pages.
60
56
  #
@@ -76,6 +72,18 @@ module Jekyll
76
72
  file == 'index.html' && !config['paginate'].nil?
77
73
  end
78
74
 
75
+ # Static: Return the pagination path of the page
76
+ #
77
+ # site_config - the site config
78
+ # num_page - the pagination page number
79
+ #
80
+ # Returns the pagination path as a string
81
+ def self.paginate_path(site_config, num_page)
82
+ return nil if num_page.nil? || num_page <= 1
83
+ format = site_config['paginate_path']
84
+ format.sub(':num', num_page.to_s)
85
+ end
86
+
79
87
  # Initialize a new Pager.
80
88
  #
81
89
  # config - The Hash configuration of the site.
@@ -98,7 +106,9 @@ module Jekyll
98
106
  @total_posts = all_posts.size
99
107
  @posts = all_posts[init..offset]
100
108
  @previous_page = @page != 1 ? @page - 1 : nil
109
+ @previous_page_path = Pager.paginate_path(config, @previous_page)
101
110
  @next_page = @page != @total_pages ? @page + 1 : nil
111
+ @next_page_path = Pager.paginate_path(config, @next_page)
102
112
  end
103
113
 
104
114
  # Convert this Pager's data to a Hash suitable for use by Liquid.
@@ -112,7 +122,9 @@ module Jekyll
112
122
  'total_posts' => total_posts,
113
123
  'total_pages' => total_pages,
114
124
  'previous_page' => previous_page,
115
- 'next_page' => next_page
125
+ 'previous_page_path' => previous_page_path,
126
+ 'next_page' => next_page,
127
+ 'next_page_path' => next_page_path
116
128
  }
117
129
  end
118
130
  end
data/lib/jekyll/post.rb CHANGED
@@ -146,6 +146,8 @@ module Jekyll
146
146
  "/:categories/:title.html"
147
147
  when :date
148
148
  "/:categories/:year/:month/:day/:title.html"
149
+ when :ordinal
150
+ "/:categories/:year/:y_day/:title.html"
149
151
  else
150
152
  self.site.permalink_style.to_s
151
153
  end
@@ -169,6 +171,8 @@ module Jekyll
169
171
  "i_day" => date.strftime("%d").to_i.to_s,
170
172
  "i_month" => date.strftime("%m").to_i.to_s,
171
173
  "categories" => categories.map { |c| URI.escape(c.to_s) }.join('/'),
174
+ "short_month" => date.strftime("%b"),
175
+ "y_day" => date.strftime("%j"),
172
176
  "output_ext" => self.output_ext
173
177
  }.inject(template) { |result, token|
174
178
  result.gsub(/:#{Regexp.escape token.first}/, token.last)
data/lib/jekyll/site.rb CHANGED
@@ -405,6 +405,7 @@ module Jekyll
405
405
  base = File.join(self.source, dir, subfolder)
406
406
  return [] unless File.exists?(base)
407
407
  entries = Dir.chdir(base) { filter_entries(Dir['**/*']) }
408
+ entries.delete_if { |e| File.directory?(File.join(base, e)) }
408
409
  end
409
410
 
410
411
  # Aggregate post information
@@ -5,68 +5,80 @@ prev_section: structure
5
5
  next_section: frontmatter
6
6
  ---
7
7
 
8
- Jekyll allows you to concoct your sites in any way you can dream up, and it’s thanks to the powerful and flexible configuration options that this is possible. These options can either be specified in a `_config.yml` file placed in your site’s root directory, or can be specified as flags for the `jekyll` executable in the terminal.
8
+ Jekyll allows you to concoct your sites in any way you can dream up, and it’s
9
+ thanks to the powerful and flexible configuration options that this is possible.
10
+ These options can either be specified in a `_config.yml` file placed in your
11
+ site’s root directory, or can be specified as flags for the `jekyll` executable
12
+ in the terminal.
9
13
 
10
14
  ## Configuration Settings
11
15
 
12
16
  ### Global Configuration
13
17
 
14
- The table below lists the available settings for Jekyll, and the various <code class="option">options</code> (specifed in the configuration file) and <code class="flag">flags</code> (specified on the command-line) that control them.
18
+ The table below lists the available settings for Jekyll, and the various <code
19
+ class="option">options</code> (specifed in the configuration file) and <code
20
+ class="flag">flags</code> (specified on the command-line) that control them.
15
21
 
16
22
  <table>
17
23
  <thead>
18
24
  <tr>
19
25
  <th>Setting</th>
20
- <th><span class="option">Options</span> and <span class="flag">Flags</span></th>
26
+ <th>
27
+ <span class="option">Options</span> and <span class="flag">Flags</span>
28
+ </th>
21
29
  </tr>
22
30
  </thead>
23
31
  <tbody>
24
32
  <tr class='setting'>
25
33
  <td>
26
34
  <p class='name'><strong>Site Source</strong></p>
27
- <p class='description'>Changes the directory where Jekyll will look to transform files</p>
35
+ <p class='description'>Change the directory where Jekyll will read files</p>
28
36
  </td>
29
37
  <td class="align-center">
30
- <p><code class="option">source: [string]</code></p>
31
- <p><code class="flag">--source [source]</code></p>
38
+ <p><code class="option">source: DIR</code></p>
39
+ <p><code class="flag">-s, --source DIR</code></p>
32
40
  </td>
33
41
  </tr>
34
42
  <tr class='setting'>
35
43
  <td>
36
44
  <p class='name'><strong>Site Destination</strong></p>
37
- <p class='description'>Changes the directory where Jekyll will write files to</p>
45
+ <p class='description'>Change the directory where Jekyll will write files</p>
38
46
  </td>
39
47
  <td class="align-center">
40
- <p><code class="option">destination: [string]</code></p>
41
- <p><code class="flag">--destination</code></p>
48
+ <p><code class="option">destination: DIR</code></p>
49
+ <p><code class="flag">-d, --destination DIR</code></p>
42
50
  </td>
43
51
  </tr>
44
52
  <tr class='setting'>
45
53
  <td>
46
54
  <p class='name'><strong>Safe</strong></p>
47
- <p class='description'>Disables <a href="../plugins">custom plugins</a>.</p>
55
+ <p class='description'>Disable <a href="../plugins">custom plugins</a>.</p>
48
56
  </td>
49
57
  <td class="align-center">
50
- <p><code class="option">safe: [boolean]</code></p>
58
+ <p><code class="option">safe: BOOL</code></p>
51
59
  <p><code class="flag">--safe</code></p>
52
60
  </td>
53
61
  </tr>
54
62
  <tr class='setting'>
55
63
  <td>
56
64
  <p class='name'><strong>Exclude</strong></p>
57
- <p class="description">A list of directories and files to exclude from the conversion</p>
65
+ <p class="description">Exclude directories and/or files from the conversion</p>
58
66
  </td>
59
67
  <td class='align-center'>
60
- <p><code class="option">exclude: [dir1, file1, dir2]</code></p>
68
+ <p><code class="option">exclude: [DIR, FILE, ...]</code></p>
61
69
  </td>
62
70
  </tr>
63
71
  <tr class='setting'>
64
72
  <td>
65
73
  <p class='name'><strong>Include</strong></p>
66
- <p class="description">A list of directories and files to specifically include in the conversion. <code>.htaccess</code> is a good example since dotfiles are excluded by default.</p>
74
+ <p class="description">
75
+ Force inclusion of directories and/or files in the conversion.
76
+ <code>.htaccess</code> is a good example since dotfiles are excluded
77
+ by default.
78
+ </p>
67
79
  </td>
68
80
  <td class='align-center'>
69
- <p><code class="option">include: [dir1, file1, dir2]</code></p>
81
+ <p><code class="option">include: [DIR, FILE, ...]</code></p>
70
82
  </td>
71
83
  </tr>
72
84
  </tbody>
@@ -85,90 +97,58 @@ The table below lists the available settings for Jekyll, and the various <code c
85
97
  <tr class='setting'>
86
98
  <td>
87
99
  <p class='name'><strong>Regeneration</strong></p>
88
- <p class='description'>Enables auto-regeneration of the site when files are modified. Off by default.</p>
89
- </td>
90
- <td class="align-center">
91
- <p><code class="flag">--watch</code></p>
92
- </td>
93
- </tr>
94
- <tr class='setting'>
95
- <td>
96
- <p class='name'><strong>URL</strong></p>
97
- <p class='description'>Sets <code>site.url</code>, useful for environment switching</p>
100
+ <p class='description'>Enable auto-regeneration of the site when files are modified.</p>
98
101
  </td>
99
102
  <td class="align-center">
100
- <p><code class="option">url: [URL]</code></p>
101
- <p><code class="flag">--url [URL]</code></p>
103
+ <p><code class="flag">-w, --watch</code></p>
102
104
  </td>
103
105
  </tr>
104
106
  <tr class='setting'>
105
107
  <td>
106
- <p class='name'><strong>Markdown</strong></p>
107
- <p class="description">Uses RDiscount or <code>[engine]</code> instead of Maruku.</p>
108
+ <p class='name'><strong>Configuration</strong></p>
109
+ <p class="description">Specify a config file. Overrides settings in <code>_config.yml</code></p>
108
110
  </td>
109
111
  <td class='align-center'>
110
- <p><code class="option">markdown: [engine]</code></p>
111
- <p><code class="flag">--markdown [rdiscount|kramdown|redcarpet]</code></p>
112
+ <p><code class="flag">--config FILE</code></p>
112
113
  </td>
113
114
  </tr>
114
115
  <tr class='setting'>
115
116
  <td>
116
- <p class='name'><strong>Pygments</strong></p>
117
- <p class="description">Enables highlight tag with Pygments.</p>
117
+ <p class='name'><strong>Drafts</strong></p>
118
+ <p class="description">Process and render draft posts.</p>
118
119
  </td>
119
120
  <td class='align-center'>
120
- <p><code class="option">pygments: [boolean]</code></p>
121
- <p><code class="flag">--pygments</code></p>
121
+ <p><code class="flag">--drafts</code></p>
122
122
  </td>
123
123
  </tr>
124
124
  <tr class='setting'>
125
125
  <td>
126
126
  <p class='name'><strong>Future</strong></p>
127
- <p class="description">Publishes posts with a future date</p>
127
+ <p class="description">Publish posts with a future date.</p>
128
128
  </td>
129
129
  <td class='align-center'>
130
- <p><code class="option">future: [boolean]</code></p>
130
+ <p><code class="option">future: BOOL</code></p>
131
131
  <p><code class="flag">--future</code></p>
132
132
  </td>
133
133
  </tr>
134
134
  <tr class='setting'>
135
135
  <td>
136
136
  <p class='name'><strong>LSI</strong></p>
137
- <p class="description">Produces an index for related posts.</p>
137
+ <p class="description">Produce an index for related posts.</p>
138
138
  </td>
139
139
  <td class='align-center'>
140
- <p><code class="option">lsi: [boolean]</code></p>
140
+ <p><code class="option">lsi: BOOL</code></p>
141
141
  <p><code class="flag">--lsi</code></p>
142
142
  </td>
143
143
  </tr>
144
- <tr class='setting'>
145
- <td>
146
- <p class='name'><strong>Permalink</strong></p>
147
- <p class="description">Controls the URLs that posts are generated with. Please refer to the <a href="../permalinks">Permalinks</a> page for more info.</p>
148
- </td>
149
- <td class='align-center'>
150
- <p><code class="option">permalink: [style]</code></p>
151
- <p><code class="flag">--permalink [style]</code></p>
152
- </td>
153
- </tr>
154
- <tr class='setting'>
155
- <td>
156
- <p class='name'><strong>Pagination</strong></p>
157
- <p class="description">Splits your posts up over multiple subdirectories called "page2", "page3", ... "pageN"</p>
158
- </td>
159
- <td class='align-center'>
160
- <p><code class="option">paginate: [per_page]</code></p>
161
- <p><code class="flag">--paginate [per_page]</code></p>
162
- </td>
163
- </tr>
164
144
  <tr class='setting'>
165
145
  <td>
166
146
  <p class='name'><strong>Limit Posts</strong></p>
167
- <p class="description">Limits the number of posts to parse and publish</p>
147
+ <p class="description">Limit the number of posts to parse and publish.</p>
168
148
  </td>
169
149
  <td class='align-center'>
170
- <p><code class="option">limit_posts: [max_posts]</code></p>
171
- <p><code class="flag">--limit_posts [max_posts]</code></p>
150
+ <p><code class="option">limit_posts: NUM</code></p>
151
+ <p><code class="flag">--limit_posts NUM</code></p>
172
152
  </td>
173
153
  </tr>
174
154
  </tbody>
@@ -191,31 +171,31 @@ before your site is served.
191
171
  <tr class='setting'>
192
172
  <td>
193
173
  <p class='name'><strong>Local Server Port</strong></p>
194
- <p class='description'>Changes the port that the Jekyll server will run on</p>
174
+ <p class='description'>Listen on the given port.</p>
195
175
  </td>
196
176
  <td class="align-center">
197
- <p><code class="option">port: [integer]</code></p>
198
- <p><code class="flag">--port [port]</code></p>
177
+ <p><code class="option">port: PORT</code></p>
178
+ <p><code class="flag">--port PORT</code></p>
199
179
  </td>
200
180
  </tr>
201
181
  <tr class='setting'>
202
182
  <td>
203
183
  <p class='name'><strong>Local Server Hostname</strong></p>
204
- <p class='description'>Changes the hostname that the Jekyll server will run on</p>
184
+ <p class='description'>Listen at the given hostname.</p>
205
185
  </td>
206
186
  <td class="align-center">
207
- <p><code class="option">host: [string]</code></p>
208
- <p><code class="flag">--host [hostname]</code></p>
187
+ <p><code class="option">host: HOSTNAME</code></p>
188
+ <p><code class="flag">--host HOSTNAME</code></p>
209
189
  </td>
210
190
  </tr>
211
191
  <tr class='setting'>
212
192
  <td>
213
193
  <p class='name'><strong>Base URL</strong></p>
214
- <p class='description'>Serve website from a given base URL</p>
194
+ <p class='description'>Serve website with the given base URL</p>
215
195
  </td>
216
196
  <td class="align-center">
217
- <p><code class="option">baseurl: [BASE_URL]</code></p>
218
- <p><code class="flag">--baseurl [url]</code></p>
197
+ <p><code class="option">baseurl: URL</code></p>
198
+ <p><code class="flag">--baseurl URL</code></p>
219
199
  </td>
220
200
  </tr>
221
201
  </tbody>
@@ -223,14 +203,38 @@ before your site is served.
223
203
 
224
204
  <div class="note warning">
225
205
  <h5>Do not use tabs in configuration files</h5>
226
- <p>This will either lead to parsing errors, or Jekyll will revert to the default settings. Use spaces instead.</p>
206
+ <p>
207
+ This will either lead to parsing errors, or Jekyll will revert to the
208
+ default settings. Use spaces instead.
209
+ </p>
227
210
  </div>
228
211
 
229
212
  ## Default Configuration
230
213
 
231
- Jekyll runs with the following configuration options by default. Unless alternative settings for these options are explicitly specified in the configuration file or on the command-line, Jekyll will run using these options.
214
+ Jekyll runs with the following configuration options by default. Unless
215
+ alternative settings for these options are explicitly specified in the
216
+ configuration file or on the command-line, Jekyll will run using these options.
232
217
 
233
218
  {% highlight yaml %}
219
+ source: .
220
+ destination: ./_site
221
+ plugins: ./_plugins
222
+ layouts: ./_layouts
223
+ keep_files: ['.git','.svn']
224
+
225
+ future: true
226
+ pygments: false
227
+
228
+ markdown: maruku
229
+ permalink: date
230
+ include: ['.htaccess']
231
+ paginate_path: 'page:num'
232
+
233
+ markdown_ext: markdown,mkd,mkdn,md
234
+ textile_ext: textile
235
+
236
+ excerpt_separator: "\n\n"
237
+
234
238
  safe: false
235
239
  watch: false
236
240
  server: false
@@ -238,16 +242,7 @@ host: 0.0.0.0
238
242
  port: 4000
239
243
  baseurl: /
240
244
  url: http://localhost:4000
241
-
242
- source: .
243
- destination: ./_site
244
- plugins: ./_plugins
245
-
246
- future: true
247
245
  lsi: false
248
- pygments: false
249
- markdown: maruku
250
- permalink: date
251
246
 
252
247
  maruku:
253
248
  use_tex: false
@@ -259,11 +254,15 @@ maruku:
259
254
  rdiscount:
260
255
  extensions: []
261
256
 
257
+ redcarpet:
258
+ extensions: []
259
+
262
260
  kramdown:
263
- auto_ids: true,
261
+ auto_ids: true
264
262
  footnote_nr: 1
265
263
  entity_output: as_char
266
264
  toc_levels: 1..6
265
+ smart_quotes: lsquo,rsquo,ldquo,rdquo
267
266
  use_coderay: false
268
267
 
269
268
  coderay:
@@ -274,4 +273,6 @@ kramdown:
274
273
  coderay_bold_every: 10
275
274
  coderay_css: style
276
275
 
276
+ redcloth:
277
+ hard_breaks: true
277
278
  {% endhighlight %}