jekyll 1.0.4 → 1.1.1

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 (90) hide show
  1. checksums.yaml +14 -6
  2. data/{CONTRIBUTING.md → CONTRIBUTING.markdown} +19 -1
  3. data/History.markdown +172 -85
  4. data/README.markdown +45 -0
  5. data/Rakefile +43 -18
  6. data/bin/jekyll +31 -1
  7. data/features/create_sites.feature +18 -0
  8. data/features/include_tag.feature +35 -0
  9. data/features/pagination.feature +28 -0
  10. data/features/post_excerpts.feature +50 -0
  11. data/features/step_definitions/jekyll_steps.rb +27 -11
  12. data/features/support/env.rb +9 -0
  13. data/jekyll.gemspec +32 -7
  14. data/lib/jekyll.rb +2 -1
  15. data/lib/jekyll/commands/new.rb +15 -3
  16. data/lib/jekyll/configuration.rb +23 -22
  17. data/lib/jekyll/converters/markdown/kramdown_parser.rb +4 -15
  18. data/lib/jekyll/convertible.rb +4 -0
  19. data/lib/jekyll/core_ext.rb +11 -0
  20. data/lib/jekyll/excerpt.rb +113 -0
  21. data/lib/jekyll/generators/pagination.rb +93 -23
  22. data/lib/jekyll/page.rb +1 -3
  23. data/lib/jekyll/post.rb +15 -55
  24. data/lib/jekyll/related_posts.rb +2 -1
  25. data/lib/jekyll/site.rb +33 -41
  26. data/lib/jekyll/stevenson.rb +25 -4
  27. data/lib/jekyll/tags/include.rb +46 -2
  28. data/lib/site_template/_config.yml +1 -0
  29. data/lib/site_template/css/main.css +0 -5
  30. data/site/_config.yml +1 -0
  31. data/site/_includes/docs_contents.html +12 -3
  32. data/site/_includes/docs_contents_mobile.html +7 -1
  33. data/site/_includes/news_contents.html +23 -0
  34. data/site/_includes/news_contents_mobile.html +11 -0
  35. data/site/_includes/news_item.html +24 -0
  36. data/site/_includes/primary-nav-items.html +4 -1
  37. data/site/_includes/top.html +2 -0
  38. data/site/_layouts/news.html +19 -0
  39. data/site/_layouts/news_item.html +27 -0
  40. data/site/_posts/2013-05-06-jekyll-1-0-0-released.markdown +23 -0
  41. data/site/_posts/2013-05-08-jekyll-1-0-1-released.markdown +27 -0
  42. data/site/_posts/2013-05-12-jekyll-1-0-2-released.markdown +28 -0
  43. data/site/_posts/2013-06-07-jekyll-1-0-3-released.markdown +25 -0
  44. data/site/_posts/2013-07-14-jekyll-1-1-0-released.markdown +27 -0
  45. data/site/_posts/2013-07-24-jekyll-1-1-1-released.markdown +31 -0
  46. data/site/css/style.css +125 -17
  47. data/site/docs/configuration.md +10 -1
  48. data/site/docs/contributing.md +21 -3
  49. data/site/docs/deployment-methods.md +2 -2
  50. data/site/docs/drafts.md +20 -0
  51. data/site/docs/extras.md +24 -3
  52. data/site/docs/github-pages.md +25 -0
  53. data/site/docs/history.md +150 -85
  54. data/site/docs/index.md +1 -17
  55. data/site/docs/installation.md +3 -2
  56. data/site/docs/migrations.md +2 -2
  57. data/site/docs/pagination.md +12 -0
  58. data/site/docs/plugins.md +97 -76
  59. data/site/docs/quickstart.md +32 -0
  60. data/site/docs/resources.md +0 -1
  61. data/site/docs/structure.md +15 -0
  62. data/site/docs/templates.md +26 -4
  63. data/site/docs/troubleshooting.md +22 -7
  64. data/site/docs/upgrading.md +6 -1
  65. data/site/docs/variables.md +12 -2
  66. data/site/feed.xml +36 -0
  67. data/site/freenode.txt +1 -0
  68. data/site/img/article-footer.png +0 -0
  69. data/site/img/footer-arrow.png +0 -0
  70. data/site/img/footer-logo.png +0 -0
  71. data/site/img/logo-2x.png +0 -0
  72. data/site/img/octojekyll.png +0 -0
  73. data/site/img/tube.png +0 -0
  74. data/site/img/tube1x.png +0 -0
  75. data/site/index.html +1 -1
  76. data/site/news/index.md +10 -0
  77. data/site/news/releases/index.md +10 -0
  78. data/test/source/+/foo.md +7 -0
  79. data/test/source/_includes/params.html +7 -0
  80. data/test/source/_posts/2013-07-22-post-excerpt-with-layout.markdown +23 -0
  81. data/test/test_configuration.rb +9 -0
  82. data/test/test_excerpt.rb +62 -0
  83. data/test/test_generated_site.rb +1 -1
  84. data/test/test_page.rb +9 -0
  85. data/test/test_pager.rb +31 -37
  86. data/test/test_post.rb +2 -1
  87. data/test/test_related_posts.rb +6 -1
  88. data/test/test_tags.rb +90 -0
  89. metadata +62 -23
  90. data/README.textile +0 -45
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  layout: docs
3
3
  title: Welcome
4
- next_section: installation
4
+ next_section: quickstart
5
5
  permalink: /docs/home/
6
6
  ---
7
7
 
@@ -24,22 +24,6 @@ behind [GitHub Pages](http://pages.github.com), which means you can use Jekyll
24
24
  to host your project’s page, blog, or website from GitHub’s servers **for
25
25
  free**.
26
26
 
27
- ## Quick-start guide
28
-
29
- For the impatient, here's how to get a boilerplate Jekyll site up and running.
30
-
31
- {% highlight bash %}
32
- ~ $ gem install jekyll
33
- ~ $ jekyll new myblog
34
- ~ $ cd myblog
35
- ~/myblog $ jekyll serve
36
- # => Now browse to http://localhost:4000
37
- {% endhighlight %}
38
-
39
- That's nothing, though. The real magic happens when you start creating blog
40
- posts, using the front-matter to control templates and layouts, and taking
41
- advantage of all the awesome configuration options Jekyll makes available.
42
-
43
27
  ## ProTips™, Notes, and Warnings
44
28
 
45
29
  Throughout this guide there are a number of small-but-handy pieces of
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  layout: docs
3
3
  title: Installation
4
- prev_section: home
4
+ prev_section: quickstart
5
5
  next_section: usage
6
6
  permalink: /docs/installation/
7
7
  ---
@@ -58,7 +58,8 @@ Check out [the extras page](../extras) for more information.
58
58
  <p>
59
59
  If you’re the kind of person who is using Jekyll, then chances are you’ll
60
60
  want to enable syntax highlighting using Pygments. You should really
61
- <a href="../extras">check out how to do that</a> before you go any further.
61
+ <a href="../templates/#code_snippet_highlighting">check out how to do
62
+ that</a> before you go any further.
62
63
  </p>
63
64
  </div>
64
65
 
@@ -57,7 +57,7 @@ exported file is saved as `wordpress.xml`, here is the command you need to run:
57
57
 
58
58
  {% highlight bash %}
59
59
  $ ruby -rubygems -e 'require "jekyll/jekyll-import/wordpressdotcom";
60
- JekyllImport::WordpressDotCom.process("wordpress.xml")'
60
+ JekyllImport::WordpressDotCom.process({ :source => "wordpress.xml" })'
61
61
  {% endhighlight %}
62
62
 
63
63
  <div class="note">
@@ -185,7 +185,7 @@ $ ruby -rubygems -e 'require "jekyll/jekyll-import/mephisto";
185
185
  ## Blogger (Blogspot)
186
186
 
187
187
  To import posts from Blogger, see [this post about migrating from Blogger to
188
- Jekyll](http://coolaj86.info/articles/migrate-from-blogger-to-jekyll.html). If
188
+ Jekyll](http://blog.coolaj86.com/articles/migrate-from-blogger-to-jekyll.html). If
189
189
  that doesn’t work for you, you might want to try some of the following
190
190
  alternatives:
191
191
 
@@ -32,6 +32,18 @@ paginate: 5
32
32
  The number should be the maximum number of Posts you’d like to be displayed per-
33
33
  page in the generated site.
34
34
 
35
+ You may also specify where the destination of the pagination pages:
36
+
37
+ {% highlight yaml %}
38
+ paginate_path: "blog/page:num"
39
+ {% endhighlight %}
40
+
41
+ This will read in `blog/index.html`, send it each pagination page in Liquid as `paginator`
42
+ and write the output to `blog/page:num`, where `:num` is the pagination page number,
43
+ starting with `2`. If a site has 12 posts and specifies `paginate: 5`, Jekyll will write
44
+ `blog/index.html` with the first 5 posts, `blog/page2/index.html` with the next 5 posts
45
+ and `blog/page3/index.html` with the last 2 posts into the destination directory.
46
+
35
47
  ## Liquid Attributes Available
36
48
 
37
49
  The pagination plugin exposes the `paginator` liquid object with the following
@@ -350,85 +350,106 @@ end
350
350
 
351
351
  ## Available Plugins
352
352
 
353
- There are a few useful, prebuilt plugins at the following locations:
354
-
355
- - [Truncate HTML while preserving markup structure](https://github.com/MattHall/truncatehtml) by [Matt Hall](http://codebeef.com)
356
- - [Generic Blog Plugins by Jose Diaz-Gonzalez](https://github.com/josegonzalez/josediazgonzalez.com/tree/master/_plugins): Contains plugins for tags, categories, archives, as well as a few Liquid extensions
357
- - [Domain Name Filter by Lawrence Woodman](https://github.com/LawrenceWoodman/domain_name-liquid_filter): Filters the input text so that just the domain name is left
358
- - [Jekyll Plugins by Recursive Design](http://recursive-design.com/projects/jekyll-plugins/): Plugin to generate Project pages from GitHub readmes, a Category page plugin, and a Sitemap generator
359
- - [Tag Cloud Plugin from a Jekyll walk-through](http://vitobotta.com/how-to-migrate-from-wordpress-to-jekyll/): Plugin to generate a tag cloud
360
- - [Pygments Cache Path by Raimonds Simanovskis](https://github.com/rsim/blog.rayapps.com/blob/master/_plugins/pygments_cache_patch.rb): Plugin to cache syntax-highlighted code from Pygments
353
+ You can find a few useful plugins at the following locations:
354
+
355
+ #### Generators
356
+
357
+ - [ArchiveGenerator by Ilkka Laukkanen](https://gist.github.com/707909): Uses [this archive page](https://gist.github.com/707020) to generate archives.
358
+ - [LESS.js Generator by Andy Fowler](https://gist.github.com/642739): Renders LESS.js files during generation.
359
+ - [Version Reporter by Blake Smith](https://gist.github.com/449491): Creates a version.html file containing the Jekyll version.
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
+ - [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
+ - [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
+ - [Projectlist by Frederic Hemberger](https://github.com/fhemberger/jekyll-projectlist): Renders files in a directory as a single page instead of separate posts.
364
+
365
+ #### Converters
366
+
367
+ - [Jade plugin by John Papandriopoulos](https://github.com/snappylabs/jade-jekyll-plugin): Jade converter for Jekyll.
368
+ - [HAML plugin by Sam Z](https://gist.github.com/517556): HAML converter for Jekyll.
369
+ - [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.
371
+ - [LESS Converter by Jason Graham](https://gist.github.com/639920): Convert LESS files to CSS.
372
+ - [LESS Converter by Josh Brown](https://gist.github.com/760265): Simple LESS converter.
373
+ - [Upcase Converter by Blake Smith](https://gist.github.com/449463): An example Jekyll converter.
374
+ - [CoffeeScript Converter by phaer](https://gist.github.com/959938): A [CoffeeScript](http://coffeescript.org) to Javascript converter.
375
+ - [Markdown References by Olov Lassus](https://github.com/olov/jekyll-references): Keep all your markdown reference-style link definitions in one \_references.md file.
376
+ - [Stylus Converter](https://gist.github.com/988201): Convert .styl to .css.
377
+ - [ReStructuredText Converter](https://github.com/xdissent/jekyll-rst): Converts ReST documents to HTML with Pygments syntax highlighting.
378
+ - [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.
380
+ - [ReStructuredText Converter](https://github.com/xdissent/jekyll-rst): Converts ReST documents to HTML with Pygments syntax highlighting.
381
+ - [Transform Layouts](https://gist.github.com/1472645): Allows HAML layouts (you need a HAML Converter plugin for this to work).
382
+
383
+ #### Filters
384
+
385
+ - [Truncate HTML](https://github.com/MattHall/truncatehtml) by [Matt Hall](http://codebeef.com): A Jekyll filter that truncates HTML while preserving markup structure.
386
+ - [Domain Name Filter by Lawrence Woodman](https://github.com/LawrenceWoodman/domain_name-liquid_filter): Filters the input text so that just the domain name is left.
387
+ - [Summarize Filter by Mathieu Arnold](https://gist.github.com/731597): Remove markup after a `<div id="extended">` tag.
388
+ - [URL encoding by James An](https://gist.github.com/919275): Percent encoding for URIs.
389
+ - [JSON Filter](https://gist.github.com/1850654) by [joelverhagen](https://github.com/joelverhagen): Filter that takes input text and outputs it as JSON. Great for rendering JavaScript.
390
+ - [i18n_filter](https://github.com/gacha/gacha.id.lv/blob/master/_plugins/i18n_filter.rb): Liquid filter to use I18n localization.
391
+ - [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
+ - [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
+ - [Jekyll-timeago](https://github.com/markets/jekyll-timeago): Converts a time value to the time ago in words.
394
+
395
+ #### Tags
396
+
361
397
  - [Delicious Plugin by Christian Hellsten](https://github.com/christianhellsten/jekyll-plugins): Fetches and renders bookmarks from delicious.com.
362
- - [Ultraviolet plugin by Steve Alex](https://gist.github.com/480380): Jekyll Plugin for Ultraviolet
363
- - [HAML plugin by Sam Z](https://gist.github.com/517556): HAML plugin for jekyll
364
- - [ArchiveGenerator by Ilkka Laukkanen](https://gist.github.com/707909): Uses [this archive page](https://gist.github.com/707020) to generate archives
365
- - [Tag Cloud Plugin by Ilkka Laukkanen](https://gist.github.com/710577): Jekyll tag cloud / tag pages plugin
366
- - [HAML/SASS Converter by Adam Pearson](https://gist.github.com/481456): Simple haml-sass conversion for jekyll. [Fork](https://gist.github.com/528642) by Sam X
367
- - [SASS scss Converter by Mark Wolfe](https://gist.github.com/960150): Jekyll Converter which uses the new css compatible syntax, based on the one written by Sam X.
368
- - [GIT Tag by Alexandre Girard](https://gist.github.com/730347): Jekyll plugin to add Git activity inside a list
369
- - [Draft/Publish Plugin by Michael Ivey](https://gist.github.com/49630)
370
- - [Less.js generator by Andy Fowler](https://gist.github.com/642739): Jekyll plugin to render less.js files during generation.
371
- - [Less Converter by Jason Graham](https://gist.github.com/639920): A Jekyll plugin to convert a .less file to .css
372
- - [Less Converter by Josh Brown](https://gist.github.com/760265)
373
-
374
- - [MathJax Liquid Tags by Jessy Cowan-Sharp](https://gist.github.com/834610): A simple liquid tag for Jekyll that converts and into inline math, and and into block equations, by replacing with the appropriate MathJax script tags.
375
- - [Non-JS Gist Tag by Brandon Tilley](https://gist.github.com/1027674) A Liquid tag for Jekyll sites that allows embedding Gists and showing code for non-JavaScript enabled browsers and readers.
376
- - [Growl Notification Generator by Tate Johnson](https://gist.github.com/490101)
377
- - [Growl Notification Hook by Tate Johnson](https://gist.github.com/525267): Better alternative to the above, but requires his “hook” fork.
378
- - [Version Reporter by Blake Smith](https://gist.github.com/449491)
379
- - [Upcase Converter by Blake Smith](https://gist.github.com/449463)
380
- - [Render Time Tag by Blake Smith](https://gist.github.com/449509)
381
- - [Summarize Filter by Mathieu Arnold](https://gist.github.com/731597)
382
- - [Status.net/OStatus Tag by phaer](https://gist.github.com/912466)
383
- - [CoffeeScript converter by phaer](https://gist.github.com/959938): Put this file in `plugins` and write a YAML header to your .coffee files. See [http://coffeescript.org](http://coffeescript.org) for more info
384
- - [Raw Tag by phaer.](https://gist.github.com/1020852): Keeps liquid from parsing text betweeen `{{ "{% raw " }}%}` and `{{ "{% endraw " }}%}`
385
- - [URL encoding by James An](https://gist.github.com/919275)
386
- - [Sitemap.xml Generator by Michael Levin](http://www.kinnetica.com/projects/jekyll-sitemap-generator/)
387
- - [Markdown references by Olov Lassus](https://github.com/olov/jekyll-references): Keep all your markdown reference-style link definitions in one file (_references.md)
388
- - [Full-text search by Pascal Widdershoven](https://github.com/PascalW/jekyll_indextank): Add full-text search to your Jekyll site with this plugin and a bit of JavaScript.
389
- - [Stylus Converter](https://gist.github.com/988201) Convert .styl to .css.
390
- - [Embed.ly client by Robert Böhnke](https://github.com/robb/jekyll-embedly-client) Autogenerate embeds from URLs using oEmbed.
398
+ - [Ultraviolet Plugin by Steve Alex](https://gist.github.com/480380): Jekyll tag for the [Ultraviolet](http://ultraviolet.rubyforge.org/) code highligher.
399
+ - [Tag Cloud Plugin by Ilkka Laukkanen](https://gist.github.com/710577): Generate a tag cloud that links to tag pages.
400
+ - [GIT Tag by Alexandre Girard](https://gist.github.com/730347): Add Git activity inside a list.
401
+ - [MathJax Liquid Tags by Jessy Cowan-Sharp](https://gist.github.com/834610): Simple liquid tags for Jekyll that convert inline math and block equations to the appropriate MathJax script tags.
402
+ - [Non-JS Gist Tag by Brandon Tilley](https://gist.github.com/1027674) A Liquid tag that embeds Gists and shows code for non-JavaScript enabled browsers and readers.
403
+ - [Render Time Tag by Blake Smith](https://gist.github.com/449509): Displays the time a Jekyll page was generated.
404
+ - [Status.net/OStatus Tag by phaer](https://gist.github.com/912466): Displays the notices in a given status.net/ostatus feed.
405
+ - [Raw Tag by phaer](https://gist.github.com/1020852): Keeps liquid from parsing text betweeen `raw` tags.
406
+ - [Embed.ly client by Robert Böhnke](https://github.com/robb/jekyll-embedly-client): Autogenerate embeds from URLs using oEmbed.
391
407
  - [Logarithmic Tag Cloud](https://gist.github.com/2290195): Flexible. Logarithmic distribution. Documentation inline.
392
- - [Related Posts by Lawrence Woodman](https://github.com/LawrenceWoodman/related_posts-jekyll_plugin): Overrides `site.related_posts` to use categories to assess relationship
393
- - [AliasGenerator by Thomas Mango](https://github.com/tsmango/jekyll_alias_generator): Generates redirect pages for posts when an alias configuration is specified in the YAML Front Matter.
408
+ - [oEmbed Tag by Tammo van Lessen](https://gist.github.com/1455726): Enables easy content embedding (e.g. from YouTube, Flickr, Slideshare) via oEmbed.
394
409
  - [FlickrSetTag by Thomas Mango](https://github.com/tsmango/jekyll_flickr_set_tag): Generates image galleries from Flickr sets.
395
- - [Projectlist by Frederic Hemberger](https://github.com/fhemberger/jekyll-projectlist): Loads all files from a directory and renders the entries into a single page, instead of creating separate posts.
396
- - [Tiered Archives by Eli Naeher](https://gist.github.com/88cda643aa7e3b0ca1e5): creates a tiered template variable that allows you to create archives grouped by year and month.
397
- - [Jammit generator by Vladimir Andrijevik](https://gist.github.com/1224971): enables use of [Jammit](http://documentcloud.github.com/jammit/) for JavaScript and CSS packaging.
398
- - [oEmbed Tag by Tammo van Lessen](https://gist.github.com/1455726): enables easy content embedding (e.g. from YouTube, Flickr, Slideshare) via oEmbed.
399
- - [Company website and blog plugins](https://github.com/flatterline/jekyll-plugins) by Flatterline, a [Ruby on Rails development company](http://flatterline.com/): portfolio/project page generator, team/individual page generator, author bio liquid template tag for use on posts and a few other smaller plugins.
400
- - [Transform Layouts](https://gist.github.com/1472645) Monkey patching allowing HAML layouts (you need a HAML Converter plugin for this to work)
401
- - [ReStructuredText converter](https://github.com/xdissent/jekyll-rst): Converts ReST documents to HTML with Pygments syntax highlighting.
402
- - [Tweet Tag by Scott W. Bradley](https://github.com/scottwb/jekyll-tweet-tag): Liquid tag for [Embedded Tweets](https://dev.twitter.com/docs/embedded-tweets) using Twitter’s shortcodes
403
- - [jekyll-localization](https://github.com/blackwinter/jekyll-localization): Jekyll plugin that adds localization features to the rendering engine.
404
- - [jekyll-rendering](https://github.com/blackwinter/jekyll-rendering): Jekyll plugin to provide alternative rendering engines.
405
- - [jekyll-pagination](https://github.com/blackwinter/jekyll-pagination): Jekyll plugin to extend the pagination generator.
406
- - [jekyll-tagging](https://github.com/pattex/jekyll-tagging): Jekyll plugin to automatically generate a tag cloud and tag pages.
407
- - [jekyll-contentblocks](https://github.com/rustygeldmacher/jekyll-contentblocks): Lets you use Rails-like content_for tags in your templates, for passing content from your posts up to your layouts.
408
- - [Generate YouTube Embed (tag)](https://gist.github.com/1805814) by [joelverhagen](https://github.com/joelverhagen): Jekyll plugin which allows you to embed a YouTube video in your page with the YouTube ID. Optionally specify width and height dimensions. Like “oEmbed Tag” but just for YouTube.
409
- - [JSON Filter](https://gist.github.com/1850654) by [joelverhagen](https://github.com/joelverhagen): filter that takes input text and outputs it as JSON. Great for rendering JavaScript.
410
- - [jekyll-beastiepress](https://github.com/okeeblow/jekyll-beastiepress): FreeBSD utility tags for Jekyll sites.
411
- - [jsonball](https://gist.github.com/1895282): reads json files and produces maps for use in jekylled files
412
- - [redcarpet2](https://github.com/nono/Jekyll-plugins): use Redcarpet2 for rendering markdown
413
- - [bibjekyll](https://github.com/pablooliveira/bibjekyll): render BibTeX-formatted bibliographies/citations included in posts/pages using bibtex2html
414
- - [jekyll-citation](https://github.com/archome/jekyll-citation): render BibTeX-formatted bibliographies/citations included in posts/pages (pure Ruby)
415
- - [jekyll-scholar](https://github.com/inukshuk/jekyll-scholar): Jekyll extensions for the blogging scholar
416
- - [jekyll-asset_bundler](https://github.com/moshen/jekyll-asset_bundler): bundles and minifies JavaScript and CSS
417
- - [Jekyll Dribbble Set Tag](https://github.com/ericdfields/Jekyll-Dribbble-Set-Tag): builds Dribbble image galleries from any user
418
- - [debbugs](https://gist.github.com/2218470): allows posting links to Debian BTS easily
419
- - [refheap_tag](https://github.com/aburdette/refheap_tag): Liquid tag that allows embedding pastes from [refheap](https://refheap.com)
420
- - [i18n_filter](https://github.com/gacha/gacha.id.lv/blob/master/_plugins/i18n_filter.rb): Liquid filter to use I18n localization.
421
- - [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.
422
- - [flickr](http://jonasforsberg.se/2012/04/15/flickr-plugin-for-jekyll/): Embed photos from flickr right into your posts.
423
- - [jekyll-devonly_tag](https://gist.github.com/2403522): A block tag for including markup only during development.
424
- - [Jekyll plugins by Aucor](https://github.com/aucor/jekyll-plugins): Plugins for eg. trimming unwanted newlines/whitespace and sorting pages by weight attribute.
425
- - [Only first paragraph](https://github.com/sebcioz/jekyll-only_first_p): Show only first paragrpaph of page/post.
426
- - [jekyll-pandoc-plugin](https://github.com/dsanson/jekyll-pandoc-plugin): use pandoc for rendering markdown.
427
- - [File compressor](https://gist.github.com/2758691) by [mytharcher](https://github.com/mytharcher): Compress HTML (\*.html) and JavaScript(\*.js) files when output.
428
- - [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/)
429
- - [excerpts](http://blog.darkrefraction.com/2012/jekyll-excerpt-plugin.html) by [drawoc](https://github.com/drawoc): provides a nice way to implement page excerpts.
430
- - [jekyll-minibundle](https://github.com/tkareine/jekyll-minibundle): Asset bundling and cache busting using external minification tool of your choice, no gem dependencies.
431
- - [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 with a Liquid tag.
410
+ - [Tweet Tag by Scott W. Bradley](https://github.com/scottwb/jekyll-tweet-tag): Liquid tag for [Embedded Tweets](https://dev.twitter.com/docs/embedded-tweets) using Twitter’s shortcodes.
411
+ - [Jekyll-contentblocks](https://github.com/rustygeldmacher/jekyll-contentblocks): Lets you use Rails-like content_for tags in your templates, for passing content from your posts up to your layouts.
412
+ - [Generate YouTube Embed](https://gist.github.com/1805814) by [joelverhagen](https://github.com/joelverhagen): Jekyll plugin which allows you to embed a YouTube video in your page with the YouTube ID. Optionally specify width and height dimensions. Like “oEmbed Tag” but just for YouTube.
413
+ - [Jekyll-beastiepress](https://github.com/okeeblow/jekyll-beastiepress): FreeBSD utility tags for Jekyll sites.
414
+ - [Jsonball](https://gist.github.com/1895282): Reads json files and produces maps for use in Jekyll files.
415
+ - [Bibjekyll](https://github.com/pablooliveira/bibjekyll): Render BibTeX-formatted bibliographies/citations included in posts and pages using bibtex2html.
416
+ - [Jekyll-citation](https://github.com/archome/jekyll-citation): Render BibTeX-formatted bibliographies/citations included in posts and pages (pure Ruby).
417
+ - [Jekyll Dribbble Set Tag](https://github.com/ericdfields/Jekyll-Dribbble-Set-Tag): Builds Dribbble image galleries from any user.
418
+ - [Debbugs](https://gist.github.com/2218470): Allows posting links to Debian BTS easily.
419
+ - [Refheap_tag](https://github.com/aburdette/refheap_tag): Liquid tag that allows embedding pastes from [refheap](https://refheap.com).
420
+ - [Jekyll-devonly_tag](https://gist.github.com/2403522): A block tag for including markup only during development.
421
+ - [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
+ - [Youku and Tudou Embed](https://gist.github.com/Yexiaoxing/5891929): Liquid plugin for embedding Youku and Tudou videos.
423
+ - [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).
425
+ - [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.
426
+
427
+ #### Collections
428
+
429
+ - [Jekyll Plugins by Recursive Design](http://recursive-design.com/projects/jekyll-plugins/): Plugins to generate Project pages from GitHub readmes, a Category page, and a Sitemap generator.
430
+ - [Company website and blog plugins](https://github.com/flatterline/jekyll-plugins) by Flatterline, a [Ruby on Rails development company](http://flatterline.com/): Portfolio/project page generator, team/individual page generator, an author bio liquid tag for use on posts, and a few other smaller plugins.
431
+ - [Jekyll plugins by Aucor](https://github.com/aucor/jekyll-plugins): Plugins for trimming unwanted newlines/whitespace and sorting pages by weight attribute.
432
+
433
+ #### Other
434
+
435
+ - [Pygments Cache Path by Raimonds Simanovskis](https://github.com/rsim/blog.rayapps.com/blob/master/_plugins/pygments_cache_patch.rb): Plugin to cache syntax-highlighted code from Pygments.
436
+ - [Draft/Publish Plugin by Michael Ivey](https://gist.github.com/49630): Save posts as drafts.
437
+ - [Growl Notification Generator by Tate Johnson](https://gist.github.com/490101): Send Jekyll notifications to Growl.
438
+ - [Growl Notification Hook by Tate Johnson](https://gist.github.com/525267): Better alternative to the above, but requires his “hook” fork.
439
+ - [Related Posts by Lawrence Woodman](https://github.com/LawrenceWoodman/related_posts-jekyll_plugin): Overrides `site.related_posts` to use categories to assess relationship.
440
+ - [Tiered Archives by Eli Naeher](https://gist.github.com/88cda643aa7e3b0ca1e5): Create tiered template variable that allows you to group archives by year and month.
441
+ - [Jekyll-localization](https://github.com/blackwinter/jekyll-localization): Jekyll plugin that adds localization features to the rendering engine.
442
+ - [Jekyll-rendering](https://github.com/blackwinter/jekyll-rendering): Jekyll plugin to provide alternative rendering engines.
443
+ - [Jekyll-pagination](https://github.com/blackwinter/jekyll-pagination): Jekyll plugin to extend the pagination generator.
444
+ - [Jekyll-tagging](https://github.com/pattex/jekyll-tagging): Jekyll plugin to automatically generate a tag cloud and tag pages.
445
+ - [Jekyll-scholar](https://github.com/inukshuk/jekyll-scholar): Jekyll extensions for the blogging scholar.
446
+ - [Jekyll-asset_bundler](https://github.com/moshen/jekyll-asset_bundler): Bundles and minifies JavaScript and CSS.
447
+ - [Jekyll-assets](http://ixti.net/jekyll-assets/) by [ixti](https://github.com/ixti): Rails-alike assets pipeline (write assets in CoffeeScript, Sass, LESS etc; specify dependencies for automatic bundling using simple declarative comments in assets; minify and compress; use JST templates; cache bust; and many-many more).
448
+ - [File compressor](https://gist.github.com/2758691) by [mytharcher](https://github.com/mytharcher): Compress HTML and JavaScript files on site build.
449
+ - [Jekyll-minibundle](https://github.com/tkareine/jekyll-minibundle): Asset bundling and cache busting using external minification tool of your choice. No gem dependencies.
450
+ - [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
+ - [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
+ - [grunt-jekyll](https://github.com/dannygarcia/grunt-jekyll): A straightforward [Grunt](http://gruntjs.com/) plugin for Jekyll.
432
453
 
433
454
  <div class="note info">
434
455
  <h5>Jekyll Plugins Wanted</h5>
@@ -0,0 +1,32 @@
1
+ ---
2
+ layout: docs
3
+ title: Quick-start guide
4
+ prev_section: home
5
+ next_section: installation
6
+ permalink: /docs/quickstart/
7
+ ---
8
+
9
+ For the impatient, here's how to get a boilerplate Jekyll site up and running.
10
+
11
+ {% highlight bash %}
12
+ ~ $ gem install jekyll
13
+ ~ $ jekyll new myblog
14
+ ~ $ cd myblog
15
+ ~/myblog $ jekyll serve
16
+ # => Now browse to http://localhost:4000
17
+ {% endhighlight %}
18
+
19
+ That's nothing, though. The real magic happens when you start creating blog
20
+ posts, using the front-matter to control templates and layouts, and taking
21
+ advantage of all the awesome configuration options Jekyll makes available.
22
+
23
+ <div class="note info">
24
+ <h5>Redcarpet is the default Markdown engine for new sites</h5>
25
+ <p>In Jekyll 1.1, we switched the default markdown engine for sites
26
+ generated with <code>jekyll new</code> to Redcarpet</p>
27
+ </div>
28
+
29
+ If you're running into problems, ensure you have all the [requirements
30
+ installed][Installation].
31
+
32
+ [Installation]: /docs/installation/
@@ -26,7 +26,6 @@ Jekyll’s growing use is producing a wide variety of tutorials, frameworks, ext
26
26
  #### Integrating Jekyll with Git
27
27
 
28
28
  - [Blogging with Git, Emacs and Jekyll](http://metajack.im/2009/01/23/blogging-with-git-emacs-and-jekyll/)
29
- - [Using Git to maintain your blog](http://matedriven.com.ar/2009/04/28/using-git-to-maintain-your-blog.html) (step by step guide)
30
29
 
31
30
  #### Other hacks
32
31
 
@@ -19,6 +19,9 @@ A basic Jekyll site usually looks something like this:
19
19
  {% highlight bash %}
20
20
  .
21
21
  ├── _config.yml
22
+ ├── _drafts
23
+ | ├── begin-with-the-crazy-ideas.textile
24
+ | └── on-simplicity-in-technology.markdown
22
25
  ├── _includes
23
26
  | ├── footer.html
24
27
  | └── header.html
@@ -57,6 +60,18 @@ An overview of what each of these does:
57
60
  </p>
58
61
  </td>
59
62
  </tr>
63
+ <tr>
64
+ <td>
65
+ <p><code>_drafts</code></p>
66
+ </td>
67
+ <td>
68
+ <p>
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>.
71
+
72
+ </p>
73
+ </td>
74
+ </tr>
60
75
  <tr>
61
76
  <td>
62
77
  <p><code>_includes</code></p>
@@ -185,19 +185,31 @@ If you have small page fragments that you wish to include in multiple places on
185
185
  your site, you can use the `include` tag.
186
186
 
187
187
  {% highlight ruby %}
188
- {% raw %}{% include sig.md %}{% endraw %}
188
+ {% raw %}{% include footer.html %}{% endraw %}
189
189
  {% endhighlight %}
190
190
 
191
191
  Jekyll expects all include files to be placed in an `_includes` directory at the
192
192
  root of your source directory. This will embed the contents of
193
- `<source>/_includes/sig.md` into the calling file.
193
+ `<source>/_includes/footer.html` into the calling file.
194
+
195
+ You can also pass parameters to an include:
196
+
197
+ {% highlight ruby %}
198
+ {% raw %}{% include footer.html param="value" %}{% endraw %}
199
+ {% endhighlight %}
200
+
201
+ These parameters are available via Liquid in the include:
202
+
203
+ {% highlight ruby %}
204
+ {% raw %}{{ include.param }}{% endraw %}
205
+ {% endhighlight %}
194
206
 
195
207
  ### Code snippet highlighting
196
208
 
197
209
  Jekyll has built in support for syntax highlighting of [over 100
198
210
  languages](http://pygments.org/languages/) thanks to
199
- [Pygments](http://pygments.org/). When you run Jekyll, make sure you run it
200
- with `pygments` set to `true` in your configuration file.
211
+ [Pygments](http://pygments.org/). To use Pygments, you must have Python installed on your
212
+ system and set `pygments` to `true` in your site's configuration file.
201
213
 
202
214
  To render a code block with syntax highlighting, surround your code as follows:
203
215
 
@@ -281,3 +293,13 @@ You may also optionally specify the filename in the gist to display:
281
293
  {% gist 5555251 result.md %}
282
294
  {% endraw %}
283
295
  {% endhighlight %}
296
+
297
+ The `gist` tag also works with private gists:
298
+
299
+ {% highlight text %}
300
+ {% raw %}
301
+ {% gist 931c1c8d465a04042403 %}
302
+ {% endraw %}
303
+ {% endhighlight %}
304
+
305
+ The private gist syntax also supports filenames.
@@ -1,12 +1,15 @@
1
1
  ---
2
2
  layout: docs
3
3
  title: Troubleshooting
4
- prev_section: contributing
4
+ prev_section: deployment-methods
5
5
  next_section: sites
6
6
  permalink: /docs/troubleshooting/
7
7
  ---
8
8
 
9
- If you ever run into problems installing or using Jekyll, heres a few tips that might be of help. If the problem you’re experiencing isn’t covered below, please [report an issue](https://github.com/mojombo/jekyll/issues/new) so the Jekyll community can make everyone’s experience better.
9
+ If you ever run into problems installing or using Jekyll, here's a few tips
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
12
+ Jekyll community can make everyone’s experience better.
10
13
 
11
14
  ## Installation Problems
12
15
 
@@ -24,7 +27,8 @@ On Red Hat, CentOS, and Fedora systems you can do this by running:
24
27
  sudo yum install ruby-devel
25
28
  {% endhighlight %}
26
29
 
27
- On [NearlyFreeSpeech](http://nearlyfreespeech.net/) you need to run the command with the following environment variable:
30
+ On [NearlyFreeSpeech](http://nearlyfreespeech.net/) you need to run the
31
+ command with the following environment variable:
28
32
 
29
33
  {% highlight bash %}
30
34
  RB_USER_INSTALL=true gem install jekyll
@@ -36,6 +40,14 @@ On OSX, you may need to update RubyGems:
36
40
  sudo gem update --system
37
41
  {% endhighlight %}
38
42
 
43
+ If you still have issues, you may need to [use XCode to install Command Line
44
+ Tools](http://www.zlu.me/blog/2012/02/21/install-native-ruby-gem-in-mountain-lion-preview/)
45
+ that will allow you to install native gems using the following command:
46
+
47
+ {% highlight bash %}
48
+ sudo gem install jekyll
49
+ {% endhighlight %}
50
+
39
51
  To install RubyGems on Gentoo:
40
52
 
41
53
  {% highlight bash %}
@@ -47,7 +59,8 @@ DevKit](http://wiki.github.com/oneclick/rubyinstaller/development-kit).
47
59
 
48
60
  ## Problems running Jekyll
49
61
 
50
- On Debian or Ubuntu, you may need to add /var/lib/gems/1.8/bin/ to your path in order to have the `jekyll` executable be available in your Terminal.
62
+ On Debian or Ubuntu, you may need to add `/var/lib/gems/1.8/bin/` to your path
63
+ in order to have the `jekyll` executable be available in your Terminal.
51
64
 
52
65
  ## Base-URL Problems
53
66
 
@@ -71,14 +84,16 @@ http://localhost:4000/blog
71
84
 
72
85
  ## Configuration problems
73
86
 
74
-
75
- The order of precedence for conflicting [configuration settings](../configuration) is as follows:
87
+ The order of precedence for conflicting [configuration settings](../configuration)
88
+ is as follows:
76
89
 
77
90
  1. Command-line flags
78
91
  2. Configuration file settings
79
92
  3. Defaults
80
93
 
81
- That is: defaults are overridden by options specified in `_config.yml`, and flags specified at the command-line will override all other settings specified elsewhere.
94
+ That is: defaults are overridden by options specified in `_config.yml`,
95
+ and flags specified at the command-line will override all other settings
96
+ specified elsewhere.
82
97
 
83
98
  ## Markup Problems
84
99