jekyll 1.1.2 → 1.2.0

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.

Files changed (75) hide show
  1. checksums.yaml +6 -14
  2. data/History.markdown +71 -0
  3. data/README.markdown +13 -3
  4. data/Rakefile +11 -2
  5. data/bin/jekyll +6 -5
  6. data/features/permalinks.feature +20 -0
  7. data/features/site_data.feature +6 -0
  8. data/features/step_definitions/jekyll_steps.rb +1 -1
  9. data/jekyll.gemspec +8 -3
  10. data/lib/jekyll.rb +3 -1
  11. data/lib/jekyll/cleaner.rb +73 -0
  12. data/lib/jekyll/commands/doctor.rb +40 -2
  13. data/lib/jekyll/commands/new.rb +2 -2
  14. data/lib/jekyll/commands/serve.rb +10 -3
  15. data/lib/jekyll/configuration.rb +14 -1
  16. data/lib/jekyll/converters/markdown.rb +1 -1
  17. data/lib/jekyll/converters/markdown/kramdown_parser.rb +4 -8
  18. data/lib/jekyll/converters/markdown/rdiscount_parser.rb +3 -1
  19. data/lib/jekyll/convertible.rb +14 -4
  20. data/lib/jekyll/core_ext.rb +0 -8
  21. data/lib/jekyll/deprecator.rb +13 -9
  22. data/lib/jekyll/generators/pagination.rb +1 -1
  23. data/lib/jekyll/page.rb +33 -34
  24. data/lib/jekyll/post.rb +48 -51
  25. data/lib/jekyll/site.rb +11 -50
  26. data/lib/jekyll/stevenson.rb +1 -1
  27. data/lib/jekyll/tags/include.rb +19 -13
  28. data/lib/jekyll/url.rb +67 -0
  29. data/lib/site_template/_layouts/default.html +20 -22
  30. data/site/_config.yml +3 -1
  31. data/site/_includes/docs_contents.html +50 -50
  32. data/site/_includes/docs_contents_mobile.html +25 -25
  33. data/site/_includes/footer.html +1 -1
  34. data/site/_includes/primary-nav-items.html +3 -3
  35. data/site/_includes/section_nav.html +2 -2
  36. data/site/_includes/top.html +1 -1
  37. data/site/_posts/2013-05-08-jekyll-1-0-1-released.markdown +1 -1
  38. data/site/_posts/2013-05-12-jekyll-1-0-2-released.markdown +1 -1
  39. data/site/_posts/2013-06-07-jekyll-1-0-3-released.markdown +1 -1
  40. data/site/_posts/2013-07-14-jekyll-1-1-0-released.markdown +2 -2
  41. data/site/_posts/2013-07-24-jekyll-1-1-1-released.markdown +4 -4
  42. data/site/_posts/2013-07-25-jekyll-1-0-4-released.markdown +7 -7
  43. data/site/_posts/2013-07-25-jekyll-1-1-2-released.markdown +6 -6
  44. data/site/_posts/2013-09-06-jekyll-1-2-0-released.markdown +23 -0
  45. data/site/css/normalize.css +1 -504
  46. data/site/docs/configuration.md +46 -6
  47. data/site/docs/contributing.md +3 -3
  48. data/site/docs/deployment-methods.md +2 -2
  49. data/site/docs/frontmatter.md +2 -2
  50. data/site/docs/github-pages.md +2 -2
  51. data/site/docs/history.md +265 -265
  52. data/site/docs/index.md +1 -1
  53. data/site/docs/installation.md +4 -4
  54. data/site/docs/migrations.md +14 -11
  55. data/site/docs/pages.md +1 -1
  56. data/site/docs/pagination.md +1 -1
  57. data/site/docs/permalinks.md +2 -2
  58. data/site/docs/plugins.md +18 -10
  59. data/site/docs/posts.md +9 -8
  60. data/site/docs/resources.md +2 -2
  61. data/site/docs/sites.md +1 -1
  62. data/site/docs/structure.md +9 -9
  63. data/site/docs/templates.md +4 -3
  64. data/site/docs/troubleshooting.md +11 -3
  65. data/site/docs/usage.md +8 -3
  66. data/site/docs/variables.md +7 -7
  67. data/site/feed.xml +1 -1
  68. data/site/index.html +3 -3
  69. data/test/source/_posts/2013-08-01-mkdn-extension.mkdn +0 -0
  70. data/test/test_configuration.rb +14 -0
  71. data/test/test_excerpt.rb +16 -0
  72. data/test/test_generated_site.rb +1 -1
  73. data/test/test_post.rb +7 -0
  74. data/test/test_url.rb +28 -0
  75. metadata +27 -21
@@ -48,5 +48,5 @@ hazardous. Here’s what to look out for.
48
48
 
49
49
  If you come across anything along the way that we haven’t covered, or if you
50
50
  know of a tip you think others would find handy, please [file an
51
- issue](https://github.com/mojombo/jekyll/issues/new) and we’ll see about
51
+ issue]({{ site.repository }}/issues/new) and we’ll see about
52
52
  including it in this guide.
@@ -8,7 +8,7 @@ permalink: /docs/installation/
8
8
 
9
9
  Getting Jekyll installed and ready-to-go should only take a few minutes. If it
10
10
  ever becomes a pain in the ass, please [file an
11
- issue](https://github.com/mojombo/jekyll/issues/new) (or submit a pull request)
11
+ issue]({{ site.repository }}/issues/new) (or submit a pull request)
12
12
  describing the issue you encountered and how we might make the process easier.
13
13
 
14
14
  ### Requirements
@@ -42,8 +42,8 @@ $ gem install jekyll
42
42
 
43
43
  All of Jekyll’s gem dependencies are automatically installed by the above
44
44
  command, so you won’t have to worry about them at all. If you have problems
45
- installing Jekyll, check out the [troubleshooting](../troubleshooting) page or
46
- [report an issue](https://github.com/mojombo/jekyll/issues/new) so the Jekyll
45
+ installing Jekyll, check out the [troubleshooting](../troubleshooting/) page or
46
+ [report an issue]({{ site.repository }}/issues/new) so the Jekyll
47
47
  community can improve the experience for everyone.
48
48
 
49
49
  ## Optional Extras
@@ -51,7 +51,7 @@ community can improve the experience for everyone.
51
51
  There are a number of (optional) extra features that Jekyll supports that you
52
52
  may want to install, depending on how you plan to use Jekyll. These extras
53
53
  include LaTeX support, and the use of alternative content rendering engines.
54
- Check out [the extras page](../extras) for more information.
54
+ Check out [the extras page](../extras/) for more information.
55
55
 
56
56
  <div class="note">
57
57
  <h5>ProTip™: Enable Syntax Highlighting</h5>
@@ -49,10 +49,10 @@ Where IMPORTER is the name of the specific importer.
49
49
 
50
50
  ## WordPress
51
51
 
52
- ### Wordpress export files
52
+ ### WordPress export files
53
53
 
54
54
  If hpricot is not already installed, you will need to run `gem install hpricot`.
55
- Next, export your blog using the Wordpress export utility. Assuming that the
55
+ Next, export your blog using the WordPress export utility. Assuming that the
56
56
  exported file is saved as `wordpress.xml`, here is the command you need to run:
57
57
 
58
58
  {% highlight bash %}
@@ -61,13 +61,16 @@ $ ruby -rubygems -e 'require "jekyll/jekyll-import/wordpressdotcom";
61
61
  {% endhighlight %}
62
62
 
63
63
  <div class="note">
64
- <h5>ProTip™: Wordpress.com Export Tool</h5>
65
- <p markdown="1">If you are migrating from a Wordpress.com account, you can access the export tool at the following URL: `https://YOUR-USER-NAME.wordpress.com/wp-admin/export.php`.</p>
64
+ <h5>ProTip™: WordPress.com Export Tool</h5>
65
+ <p markdown="1">If you are migrating from a WordPress.com account, you can
66
+ access the export tool at the following URL:
67
+ `https://YOUR-USER-NAME.wordpress.com/wp-admin/export.php`.</p>
66
68
  </div>
67
69
 
68
- ### Using Wordpress MySQL server connection
70
+ ### Using WordPress MySQL server connection
69
71
 
70
- If you want to import using a direct connection to the Wordpress MySQL server, here's how:
72
+ If you want to import using a direct connection to the WordPress MySQL server,
73
+ here's how:
71
74
 
72
75
  {% highlight bash %}
73
76
  $ ruby -rubygems -e 'require "jekyll/jekyll-import/wordpress";
@@ -85,23 +88,23 @@ $ ruby -rubygems -e 'require "jekyll/jekyll-import/wordpress";
85
88
  JekyllImport::WordPress.process("database", "user", "pass", "127.0.0.1")'
86
89
  {% endhighlight %}
87
90
 
88
- ### Further Wordpress migration alternatives
91
+ ### Further WordPress migration alternatives
89
92
 
90
93
  While the above methods work, they do not import much of the metadata that is
91
- usually stored in Wordpress posts and pages. If you need to export things like
94
+ usually stored in WordPress posts and pages. If you need to export things like
92
95
  pages, tags, custom fields, image attachments and so on, the following resources
93
96
  might be useful to you:
94
97
 
95
98
  - [Exitwp](https://github.com/thomasf/exitwp) is a configurable tool written in
96
- Python for migrating one or more Wordpress blogs into Jekyll (Markdown) format
99
+ Python for migrating one or more WordPress blogs into Jekyll (Markdown) format
97
100
  while keeping as much metadata as possible. Exitwp also downloads attachments
98
101
  and pages.
99
102
  - [A great
100
103
  article](http://vitobotta.com/how-to-migrate-from-wordpress-to-jekyll/) with a
101
- step-by-step guide for migrating a Wordpress blog to Jekyll while keeping most
104
+ step-by-step guide for migrating a WordPress blog to Jekyll while keeping most
102
105
  of the structure and metadata.
103
106
  - [wpXml2Jekyll](https://github.com/theaob/wpXml2Jekyll) is an executable
104
- windows application for creating Markdown posts from your Wordpress XML file.
107
+ windows application for creating Markdown posts from your WordPress XML file.
105
108
 
106
109
  ## Drupal
107
110
 
@@ -6,7 +6,7 @@ next_section: variables
6
6
  permalink: /docs/pages/
7
7
  ---
8
8
 
9
- In addition to [writing posts](../posts), another thing you may want to do with
9
+ In addition to [writing posts](../posts/), another thing you may want to do with
10
10
  your Jekyll site is create static pages. By taking advantage of the way Jekyll
11
11
  copies files and directories, this is easy to do.
12
12
 
@@ -16,7 +16,7 @@ folders you need for paginated listings.
16
16
  <p>
17
17
  Pagination does not work with Markdown or Textile files in your Jekyll site.
18
18
  It will only work when used within HTML files. Since you’ll likely be using
19
- this for the list of Posts, this shouldn't be an issue.
19
+ this for the list of Posts, this shouldnt be an issue.
20
20
  </p>
21
21
  </div>
22
22
 
@@ -7,8 +7,8 @@ permalink: /docs/permalinks/
7
7
  ---
8
8
 
9
9
  Jekyll supports a flexible way to build your site’s URLs. You can specify the
10
- permalinks for your site through the [Configuration](../configuration) or in the
11
- [YAML Front Matter](../frontmatter) for each post. You’re free to choose one of
10
+ permalinks for your site through the [Configuration](../configuration/) or in the
11
+ [YAML Front Matter](../frontmatter/) for each post. You’re free to choose one of
12
12
  the built-in styles to create your links or craft your own. The default style is
13
13
  `date`.
14
14
 
@@ -13,11 +13,11 @@ having to modify the Jekyll source itself.
13
13
  <div class="note info">
14
14
  <h5>Plugins on GitHub Pages</h5>
15
15
  <p>
16
- <a href="http://pages.github.com">GitHub Pages</a> is powered by Jekyll,
16
+ <a href="http://pages.github.com/">GitHub Pages</a> is powered by Jekyll,
17
17
  however all Pages sites are generated using the <code>--safe</code> option
18
18
  to disable custom plugins for security reasons. Unfortunately, this means
19
19
  your plugins won’t work if you’re deploying to GitHub Pages.<br><br>
20
- You can still use GitHub Pages to publish your site, but you'll need to
20
+ You can still use GitHub Pages to publish your site, but youll need to
21
21
  convert the site locally and push the generated static files to your GitHub
22
22
  repository instead of the Jekyll source files.
23
23
  </p>
@@ -156,8 +156,8 @@ Converters should implement at a minimum 3 methods:
156
156
  <p><code>matches</code></p>
157
157
  </td>
158
158
  <td><p>
159
- Does the given extension match this converter's list of acceptable
160
- extensions? Takes one argument: the file's extension (including the
159
+ Does the given extension match this converters list of acceptable
160
+ extensions? Takes one argument: the files extension (including the
161
161
  dot). Must return <code>true</code> if it matches, <code>false</code>
162
162
  otherwise.
163
163
  </p></td>
@@ -313,8 +313,8 @@ There are two flags to be aware of when writing a plugin:
313
313
  allowed. This is used by GitHub Pages to determine which core plugins
314
314
  may be used, and which are unsafe to run. If your plugin does not
315
315
  allow for arbitrary code, execution, set this to <code>true</code>.
316
- GitHub Pages still won't load your plugin, but if you submit it for
317
- inclusion in core, it's best for this to be correct!
316
+ GitHub Pages still wont load your plugin, but if you submit it for
317
+ inclusion in core, its best for this to be correct!
318
318
  </p>
319
319
  </td>
320
320
  </tr>
@@ -360,14 +360,16 @@ You can find a few useful plugins at the following locations:
360
360
  - [Sitemap.xml Generator by Michael Levin](https://github.com/kinnetica/jekyll-plugins): Generates a sitemap.xml file by traversing all of the available posts and pages.
361
361
  - [Full-text search by Pascal Widdershoven](https://github.com/PascalW/jekyll_indextank): Adds full-text search to your Jekyll site with a plugin and a bit of JavaScript.
362
362
  - [AliasGenerator by Thomas Mango](https://github.com/tsmango/jekyll_alias_generator): Generates redirect pages for posts when an alias is specified in the YAML Front Matter.
363
+ - [Pageless Redirect Generator by Nick Quinlan](https://github.com/nquinlan/jekyll-pageless-redirects): Generates redirects based on files in the Jekyll root, with support for htaccess style redirects.
363
364
  - [Projectlist by Frederic Hemberger](https://github.com/fhemberger/jekyll-projectlist): Renders files in a directory as a single page instead of separate posts.
365
+ - [RssGenerator by Assaf Gelber](https://github.com/agelber/jekyll-rss): Automatically creates an RSS 2.0 feed from your posts.
364
366
 
365
367
  #### Converters
366
368
 
367
369
  - [Jade plugin by John Papandriopoulos](https://github.com/snappylabs/jade-jekyll-plugin): Jade converter for Jekyll.
368
370
  - [HAML plugin by Sam Z](https://gist.github.com/517556): HAML converter for Jekyll.
369
371
  - [HAML-Sass Converter by Adam Pearson](https://gist.github.com/481456): Simple HAML-Sass converter for Jekyll. [Fork](https://gist.github.com/528642) by Sam X.
370
- - [Sass SCSS Converter by Mark Wolfe](https://gist.github.com/960150): Sass converter which uses the new CSS compatible syntax, based Sam X's fork above.
372
+ - [Sass SCSS Converter by Mark Wolfe](https://gist.github.com/960150): Sass converter which uses the new CSS compatible syntax, based Sam Xs fork above.
371
373
  - [LESS Converter by Jason Graham](https://gist.github.com/639920): Convert LESS files to CSS.
372
374
  - [LESS Converter by Josh Brown](https://gist.github.com/760265): Simple LESS converter.
373
375
  - [Upcase Converter by Blake Smith](https://gist.github.com/449463): An example Jekyll converter.
@@ -376,7 +378,7 @@ You can find a few useful plugins at the following locations:
376
378
  - [Stylus Converter](https://gist.github.com/988201): Convert .styl to .css.
377
379
  - [ReStructuredText Converter](https://github.com/xdissent/jekyll-rst): Converts ReST documents to HTML with Pygments syntax highlighting.
378
380
  - [Jekyll-pandoc-plugin](https://github.com/dsanson/jekyll-pandoc-plugin): Use pandoc for rendering markdown.
379
- - [Jekyll-pandoc-multiple-formats](https://github.com/fauno/jekyll-pandoc-multiple-formats) by [edsl](https://github.com/edsl): Use pandoc to generate your site in multiple formats. Supports pandoc's markdown extensions.
381
+ - [Jekyll-pandoc-multiple-formats](https://github.com/fauno/jekyll-pandoc-multiple-formats) by [edsl](https://github.com/edsl): Use pandoc to generate your site in multiple formats. Supports pandocs markdown extensions.
380
382
  - [ReStructuredText Converter](https://github.com/xdissent/jekyll-rst): Converts ReST documents to HTML with Pygments syntax highlighting.
381
383
  - [Transform Layouts](https://gist.github.com/1472645): Allows HAML layouts (you need a HAML Converter plugin for this to work).
382
384
 
@@ -391,6 +393,9 @@ You can find a few useful plugins at the following locations:
391
393
  - [Smilify](https://github.com/SaswatPadhi/jekyll_smilify) by [SaswatPadhi](https://github.com/SaswatPadhi): Convert text emoticons in your content to themeable smiley pics ([Demo](http://saswatpadhi.github.com/)).
392
394
  - [Read in X Minutes](https://gist.github.com/zachleat/5792681) by [zachleat](https://github.com/zachleat): Estimates the reading time of a string (for blog post content).
393
395
  - [Jekyll-timeago](https://github.com/markets/jekyll-timeago): Converts a time value to the time ago in words.
396
+ - [pluralize](https://github.com/bdesham/pluralize): Easily combine a number and a word into a gramatically-correct amount like “1 minute” or “2 minute**s**”.
397
+ - [reading_time](https://github.com/bdesham/reading_time): Count words and estimate reading time for a piece of text, ignoring HTML elements that are unlikely to contain running text.
398
+ - [Table of Content Generator](https://github.com/dafi/jekyll-toc-generator): Generate the HTML code containing a table of content (TOC), the TOC can be customized in many way, for example you can decide which pages can be without TOC.
394
399
 
395
400
  #### Tags
396
401
 
@@ -421,8 +426,10 @@ You can find a few useful plugins at the following locations:
421
426
  - [JekyllGalleryTag](https://github.com/redwallhp/JekyllGalleryTag) by [redwallhp](https://github.com/redwallhp): Generates thumbnails from a directory of images and displays them in a grid.
422
427
  - [Youku and Tudou Embed](https://gist.github.com/Yexiaoxing/5891929): Liquid plugin for embedding Youku and Tudou videos.
423
428
  - [Jekyll-swfobject](https://github.com/sectore/jekyll-swfobject): Liquid plugin for embedding Adobe Flash files (.swf) using [SWFObject](http://code.google.com/p/swfobject/).
424
- - [Jekyll Picture Tag](https://github.com/robwierzbowski/jekyll-picture-tag): Easy responsive images for Jekyll. Based on the proposed [`<picture>`](http://picture.responsiveimages.org/) element, polyfilled with Scott Jelh's [Picturefill](https://github.com/scottjehl/picturefill).
429
+ - [Jekyll Picture Tag](https://github.com/robwierzbowski/jekyll-picture-tag): Easy responsive images for Jekyll. Based on the proposed [`<picture>`](http://picture.responsiveimages.org/) element, polyfilled with Scott Jehl’s [Picturefill](https://github.com/scottjehl/picturefill).
425
430
  - [Jekyll Image Tag](https://github.com/robwierzbowski/jekyll-image-tag): Better images for Jekyll. Save image presets, generate resized images, and add classes, alt text, and other attributes.
431
+ - [Ditaa Tag](https://github.com/matze/jekyll-ditaa) by [matze](https://github.com/matze): Renders ASCII diagram art into PNG images and inserts a figure tag.
432
+ - [Good Include](https://github.com/penibelst/jekyll-good-include) by [Anatol Broder](http://penibelst.de/): Strips newlines and whitespaces from the end of include files before processing.
426
433
 
427
434
  #### Collections
428
435
 
@@ -450,12 +457,13 @@ You can find a few useful plugins at the following locations:
450
457
  - [Singlepage-jekyll](https://github.com/JCB-K/singlepage-jekyll) by [JCB-K](https://github.com/JCB-K): Turns Jekyll into a dynamic one-page website.
451
458
  - [generator-jekyllrb](https://github.com/robwierzbowski/generator-jekyllrb): A generator that wraps Jekyll in [Yeoman](http://yeoman.io/), a tool collection and workflow for builing modern web apps.
452
459
  - [grunt-jekyll](https://github.com/dannygarcia/grunt-jekyll): A straightforward [Grunt](http://gruntjs.com/) plugin for Jekyll.
460
+ - [jekyll-postfiles](https://github.com/indirect/jekyll-postfiles): Add `_postfiles` directory and {% raw %}`{{ postfile }}`{% endraw %} tag so the files a post refers to will always be right there inside your repo.
453
461
 
454
462
  <div class="note info">
455
463
  <h5>Jekyll Plugins Wanted</h5>
456
464
  <p>
457
465
  If you have a Jekyll plugin that you would like to see added to this list,
458
- you should <a href="../contributing">read the contributing page</a> to find
466
+ you should <a href="../contributing/">read the contributing page</a> to find
459
467
  out how to make that happen.
460
468
  </p>
461
469
  </div>
@@ -15,11 +15,11 @@ and web-based CMS systems, this will be a welcome change!
15
15
 
16
16
  ## The Posts Folder
17
17
 
18
- As explained on the [directory structure](../structure) page, the `_posts`
18
+ As explained on the [directory structure](../structure/) page, the `_posts`
19
19
  folder is where your blog posts will live. These files can be either
20
20
  [Markdown](http://daringfireball.net/projects/markdown/) or
21
21
  [Textile](http://textile.sitemonks.com/) formatted text files, and as long as
22
- they have [YAML front-matter](../frontmatter), they will be converted from their
22
+ they have [YAML front-matter](../frontmatter/), they will be converted from their
23
23
  source format into an HTML page that is part of your static site.
24
24
 
25
25
  ### Creating Post Files
@@ -43,7 +43,7 @@ file. For example, the following are examples of valid post filenames:
43
43
 
44
44
  ### Content Formats
45
45
 
46
- All blog post files must begin with [YAML front- matter](../frontmatter). After
46
+ All blog post files must begin with [YAML front- matter](../frontmatter/). After
47
47
  that, it's simply a matter of deciding which format you prefer. Jekyll supports
48
48
  two popular content markup formats:
49
49
  [Markdown](http://daringfireball.net/projects/markdown/) and
@@ -95,7 +95,7 @@ Linking to a PDF for readers to download:
95
95
 
96
96
  It’s all well and good to have posts in a folder, but a blog is no use unless
97
97
  you have a list of posts somewhere. Creating an index of posts on another page
98
- (or in a [template](../templates)) is easy, thanks to the [Liquid template
98
+ (or in a [template](../templates/)) is easy, thanks to the [Liquid template
99
99
  language](http://wiki.shopify.com/Liquid) and its tags. Here’s a basic example of how
100
100
  to create a list of links to your blog posts:
101
101
 
@@ -111,7 +111,7 @@ to create a list of links to your blog posts:
111
111
 
112
112
  Of course, you have full control over how (and where) you display your posts,
113
113
  and how you structure your site. You should read more about [how templates
114
- work](../templates) with Jekyll if you want to know more.
114
+ work](../templates/) with Jekyll if you want to know more.
115
115
 
116
116
  ## Post excerpts
117
117
 
@@ -133,7 +133,8 @@ posts:
133
133
  {% endhighlight %}
134
134
 
135
135
  If you don't like the automatically-generated post excerpt, it can be overridden by adding
136
- `excerpt` to your post's YAML front-matter.
136
+ `excerpt` to your post's YAML front-matter. Completely disable it by setting
137
+ your `excerpt_separator` to `""`.
137
138
 
138
139
  ## Highlighting code snippets
139
140
 
@@ -176,5 +177,5 @@ end
176
177
 
177
178
  These basics should be enough to get you started writing your first posts. When
178
179
  you’re ready to dig into what else is possible, you might be interested in doing
179
- things like [customizing post permalinks](../permalinks) or using [custom
180
- variables](../variables) in your posts and elsewhere on your site.
180
+ things like [customizing post permalinks](../permalinks/) or using [custom
181
+ variables](../variables/) in your posts and elsewhere on your site.
@@ -30,9 +30,9 @@ Jekyll’s growing use is producing a wide variety of tutorials, frameworks, ext
30
30
  #### Other hacks
31
31
 
32
32
  - [Integrating Twitter with Jekyll](http://www.justkez.com/integrating-twitter-with-jekyll/)
33
- > “Having migrated Justkez.com to be based on Jekyll, I was pondering how I might include my recent twitterings on the front page of the site. In the Wordpress world, this would have been done via a plugin which may or may not have hung the loading of the page, might have employed caching, but would certainly have had some overheads. … Not in Jekyll.”
33
+ > “Having migrated Justkez.com to be based on Jekyll, I was pondering how I might include my recent twitterings on the front page of the site. In the WordPress world, this would have been done via a plugin which may or may not have hung the loading of the page, might have employed caching, but would certainly have had some overheads. … Not in Jekyll.”
34
34
  - [‘My Jekyll Fork’, by Mike West](http://mikewest.org/2009/11/my-jekyll-fork)
35
- > “Jekyll is a well-architected throwback to a time before Wordpress, when men were men, and HTML was static. I like the ideas it espouses, and have made a few improvements to it’s core. Here, I’ll point out some highlights of my fork in the hopes that they see usage beyond this site.”
35
+ > “Jekyll is a well-architected throwback to a time before WordPress, when men were men, and HTML was static. I like the ideas it espouses, and have made a few improvements to it’s core. Here, I’ll point out some highlights of my fork in the hopes that they see usage beyond this site.”
36
36
  - [‘About this Website’, by Carter Allen](http://cartera.me/2010/08/12/about-this-website/)
37
37
  > “Jekyll is everything that I ever wanted in a blogging engine. Really. It isn’t perfect, but what’s excellent about it is that if there’s something wrong, I know exactly how it works and how to fix it. It runs on the your machine only, and is essentially an added”build" step between you and the browser. I coded this entire site in TextMate using standard HTML5 and CSS3, and then at the end I added just a few little variables to the markup. Presto-chango, my site is built and I am at peace with the world.”
38
38
  - [Generating a Tag Cloud in Jekyll](http://www.justkez.com/generating-a-tag-cloud-in-jekyll/)
@@ -26,4 +26,4 @@ learning purposes.
26
26
  If you would like to explore more examples, you can find a list of sites
27
27
  and their sources on the ["Sites" page in the Jekyll wiki][jekyll-sites].
28
28
 
29
- [jekyll-sites]: https://github.com/mojombo/jekyll/wiki/Sites
29
+ [jekyll-sites]: {{ site.repository }}/wiki/Sites
@@ -53,7 +53,7 @@ An overview of what each of these does:
53
53
  <td>
54
54
  <p>
55
55
 
56
- Stores <a href="../configuration">configuration</a> data. Many of
56
+ Stores <a href="../configuration/">configuration</a> data. Many of
57
57
  these options can be specified from the command line executable but
58
58
  it’s easier to specify them here so you don’t have to remember them.
59
59
 
@@ -67,7 +67,7 @@ An overview of what each of these does:
67
67
  <td>
68
68
  <p>
69
69
 
70
- Drafts are unpublished posts. The format of these files is without a date: <code>title.MARKUP</code>. Learn how to <a href="../drafts">work with drafts</a>.
70
+ Drafts are unpublished posts. The format of these files is without a date: <code>title.MARKUP</code>. Learn how to <a href="../drafts/">work with drafts</a>.
71
71
 
72
72
  </p>
73
73
  </td>
@@ -96,7 +96,7 @@ An overview of what each of these does:
96
96
  <p>
97
97
 
98
98
  These are the templates that wrap posts. Layouts are chosen on a post-
99
- by-post basis in the <a href="../frontmatter">YAML front matter</a>,
99
+ by-post basis in the <a href="../frontmatter/">YAML front matter</a>,
100
100
  which is described in the next section. The liquid tag
101
101
  <code>{% raw %}{{ content }}{% endraw %}</code>
102
102
  is used to inject content into the web page.
@@ -114,7 +114,7 @@ An overview of what each of these does:
114
114
  Your dynamic content, so to speak. The format of these files is
115
115
  important, and must follow the format:
116
116
  <code>YEAR-MONTH-DAY-title.MARKUP</code>.
117
- The <a href="../permalinks">permalinks</a> can be customized for each
117
+ The <a href="../permalinks/">permalinks</a> can be customized for each
118
118
  post, but the date and markup language are determined solely by the
119
119
  file name.
120
120
 
@@ -129,7 +129,7 @@ An overview of what each of these does:
129
129
  <p>
130
130
 
131
131
  This is where the generated site will be placed (by default) once
132
- Jekyll is done transforming it. It's probably a good idea to add this
132
+ Jekyll is done transforming it. Its probably a good idea to add this
133
133
  to your <code>.gitignore</code> file.
134
134
 
135
135
  </p>
@@ -142,10 +142,10 @@ An overview of what each of these does:
142
142
  <td>
143
143
  <p>
144
144
 
145
- Provided that the file has a <a href="../frontmatter">YAML Front
145
+ Provided that the file has a <a href="../frontmatter/">YAML Front
146
146
  Matter</a> section, it will be transformed by Jekyll. The same will
147
147
  happen for any <code>.html</code>, <code>.markdown</code>,
148
- <code>.md</code>, or <code>.textile</code> file in your site's root
148
+ <code>.md</code>, or <code>.textile</code> file in your sites root
149
149
  directory or directories not listed above.
150
150
 
151
151
  </p>
@@ -161,8 +161,8 @@ An overview of what each of these does:
161
161
  Every other directory and file except for those listed above—such as
162
162
  <code>css</code> and <code>images</code> folders,
163
163
  <code>favicon.ico</code> files, and so forth—will be copied verbatim
164
- to the generated site. There are plenty of <a href="../sites">sites
165
- already using Jekyll</a> if you're curious to see how they're laid
164
+ to the generated site. There are plenty of <a href="../sites/">sites
165
+ already using Jekyll</a> if youre curious to see how theyre laid
166
166
  out.
167
167
 
168
168
  </p>
@@ -26,7 +26,7 @@ common tasks easier.
26
26
  <tr>
27
27
  <td>
28
28
  <p class='name'><strong>Date to XML Schema</strong></p>
29
- <p>Convert a Date into XML Schema format.</p>
29
+ <p>Convert a Date into XML Schema (ISO 8601) format.</p>
30
30
  </td>
31
31
  <td class='align-center'>
32
32
  <p>
@@ -294,11 +294,12 @@ You may also optionally specify the filename in the gist to display:
294
294
  {% endraw %}
295
295
  {% endhighlight %}
296
296
 
297
- The `gist` tag also works with private gists:
297
+ The `gist` tag also works with private gists, which require the gist owner's
298
+ github username:
298
299
 
299
300
  {% highlight text %}
300
301
  {% raw %}
301
- {% gist 931c1c8d465a04042403 %}
302
+ {% gist parkr/931c1c8d465a04042403 %}
302
303
  {% endraw %}
303
304
  {% endhighlight %}
304
305
 
@@ -8,7 +8,7 @@ permalink: /docs/troubleshooting/
8
8
 
9
9
  If you ever run into problems installing or using Jekyll, here's a few tips
10
10
  that might be of help. If the problem you’re experiencing isn’t covered below,
11
- please [report an issue](https://github.com/mojombo/jekyll/issues/new) so the
11
+ please [report an issue]({{ site.repository }}/issues/new) so the
12
12
  Jekyll community can make everyone’s experience better.
13
13
 
14
14
  ## Installation Problems
@@ -84,7 +84,7 @@ http://localhost:4000/blog
84
84
 
85
85
  ## Configuration problems
86
86
 
87
- The order of precedence for conflicting [configuration settings](../configuration)
87
+ The order of precedence for conflicting [configuration settings](../configuration/)
88
88
  is as follows:
89
89
 
90
90
  1. Command-line flags
@@ -136,7 +136,15 @@ following error:
136
136
  '{{ "{{" }}' was not properly terminated with regexp: /\}\}/ (Liquid::SyntaxError)
137
137
  {% endhighlight %}
138
138
 
139
+ ### Excerpts
140
+
141
+ Since v1.0.0, Jekyll has had automatically-generated post excerpts. Since
142
+ v1.1.0, Jekyll also passes these excerpts through Liquid, which can cause
143
+ strange errors where references don't exist or a tag hasn't been closed. If you
144
+ run into these errors, try setting `excerpt_separator: ""` in your
145
+ `_config.yml`, or set it to some nonsense string.
146
+
139
147
  <div class="note">
140
148
  <h5>Please report issues you encounter!</h5>
141
- <p>If you come across a bug, please <a href="https://github.com/mojombo/jekyll/issues/new">create an issue</a> on GitHub describing the problem and any work-arounds you find so we can document it here for others.</p>
149
+ <p>If you come across a bug, please <a href="{{ site.repository }}/issues/new">create an issue</a> on GitHub describing the problem and any work-arounds you find so we can document it here for others.</p>
142
150
  </div>
@@ -31,11 +31,16 @@ preview what the generated site will look like in your browser locally.
31
31
  $ jekyll serve
32
32
  # => A development server will run at http://localhost:4000/
33
33
 
34
+ $ jekyll serve --detach
35
+ # => Same as `jekyll serve` but will detach from the current terminal.
36
+ # If you need to kill the server, you can `kill -9 1234` where "1234" is the PID.
37
+ # If you cannot find the PID, then do, `ps aux | grep jekyll` and kill the instance. [Read more](http://unixhelp.ed.ac.uk/shell/jobz5.html).
38
+
34
39
  $ jekyll serve --watch
35
- # => As above, but watch for changes and regenerate automatically.
40
+ # => Same as `jekyll serve`, but watch for changes and regenerate automatically.
36
41
  {% endhighlight %}
37
42
 
38
- This is just a few of the available [configuration options](../configuration).
43
+ This is just a few of the available [configuration options](../configuration/).
39
44
  Many configuration options can either be specified as flags on the command line,
40
45
  or alternatively (and more commonly) they can be specified in a `_config.yml`
41
46
  file at the root of the source directory. Jekyll will automatically use the
@@ -55,4 +60,4 @@ $ jekyll build --source _source --destination _deploy
55
60
  {% endhighlight %}
56
61
 
57
62
  For more about the possible configuration options, see the
58
- [configuration](../configuration) page.
63
+ [configuration](../configuration/) page.