RubyGems - jekyll - Versions diffs - 0.12.1 → 1.0.0.beta1 - Mend

jekyll 0.12.1 → 1.0.0.beta1

Potentially problematic release.

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

Files changed (124) hide show

data/CONTRIBUTING.md +67 -0
data/Gemfile +1 -1
data/History.txt +50 -6
data/README.textile +10 -6
data/Rakefile +74 -36
data/bin/jekyll +78 -276
data/cucumber.yml +3 -1
data/features/create_sites.feature +1 -1
data/features/drafts.feature +25 -0
data/features/site_configuration.feature +1 -1
data/features/step_definitions/jekyll_steps.rb +13 -3
data/features/support/env.rb +3 -1
data/jekyll.gemspec +73 -17
data/lib/jekyll.rb +31 -21
data/lib/jekyll/command.rb +12 -0
data/lib/jekyll/commands/build.rb +81 -0
data/lib/jekyll/commands/serve.rb +28 -0
data/lib/jekyll/converter.rb +1 -3
data/lib/jekyll/converters/identity.rb +13 -14
data/lib/jekyll/converters/markdown.rb +128 -128
data/lib/jekyll/converters/textile.rb +37 -37
data/lib/jekyll/convertible.rb +6 -4
data/lib/jekyll/core_ext.rb +9 -1
data/lib/jekyll/draft.rb +35 -0
data/lib/jekyll/errors.rb +1 -3
data/lib/jekyll/filters.rb +13 -4
data/lib/jekyll/generator.rb +1 -4
data/lib/jekyll/generators/pagination.rb +46 -46
data/lib/jekyll/layout.rb +0 -2
data/lib/jekyll/mime.types +1588 -0
data/lib/jekyll/page.rb +24 -8
data/lib/jekyll/plugin.rb +0 -2
data/lib/jekyll/post.rb +66 -40
data/lib/jekyll/site.rb +96 -20
data/lib/jekyll/static_file.rb +0 -2
data/lib/jekyll/tags/gist.rb +19 -0
data/lib/jekyll/tags/highlight.rb +63 -62
data/lib/jekyll/tags/include.rb +25 -25
data/lib/jekyll/tags/post_url.rb +30 -25
data/script/bootstrap +2 -0
data/site/.gitignore +4 -0
data/site/CNAME +1 -0
data/site/README +1 -0
data/site/_config.yml +5 -0
data/site/_includes/analytics.html +32 -0
data/site/_includes/docs_contents.html +82 -0
data/site/_includes/footer.html +15 -0
data/site/_includes/header.html +26 -0
data/site/_includes/section_nav.html +22 -0
data/site/_includes/top.html +14 -0
data/site/_layouts/default.html +12 -0
data/site/_layouts/docs.html +21 -0
data/site/_posts/2012-07-01-configuration.md +277 -0
data/site/_posts/2012-07-01-contributing.md +66 -0
data/site/_posts/2012-07-01-deployment-methods.md +108 -0
data/site/_posts/2012-07-01-extras.md +103 -0
data/site/_posts/2012-07-01-frontmatter.md +120 -0
data/site/_posts/2012-07-01-github-pages.md +34 -0
data/site/_posts/2012-07-01-heroku.md +8 -0
data/site/_posts/2012-07-01-home.md +47 -0
data/site/_posts/2012-07-01-installation.md +43 -0
data/site/_posts/2012-07-01-migrations.md +180 -0
data/site/_posts/2012-07-01-pages.md +62 -0
data/site/_posts/2012-07-01-pagination.md +116 -0
data/site/_posts/2012-07-01-permalinks.md +163 -0
data/site/_posts/2012-07-01-plugins.md +384 -0
data/site/_posts/2012-07-01-posts.md +106 -0
data/site/_posts/2012-07-01-resources.md +49 -0
data/site/_posts/2012-07-01-sites.md +28 -0
data/site/_posts/2012-07-01-structure.md +95 -0
data/site/_posts/2012-07-01-templates.md +217 -0
data/site/_posts/2012-07-01-troubleshooting.md +108 -0
data/site/_posts/2012-07-01-usage.md +38 -0
data/site/_posts/2012-07-01-variables.md +166 -0
data/site/css/grid.css +62 -0
data/site/css/normalize.css +504 -0
data/site/css/pygments.css +70 -0
data/site/css/style.css +697 -0
data/site/docs/index.html +11 -0
data/site/favicon.png +0 -0
data/site/img/article-footer.png +0 -0
data/site/img/footer-arrow.png +0 -0
data/site/img/footer-logo.png +0 -0
data/site/img/logo-2x.png +0 -0
data/site/img/octojekyll.png +0 -0
data/site/img/tube.png +0 -0
data/site/img/tube1x.png +0 -0
data/site/index.html +77 -0
data/site/js/modernizr-2.5.3.min.js +4 -0
data/test/fixtures/broken_front_matter2.erb +4 -0
data/test/fixtures/broken_front_matter3.erb +7 -0
data/test/fixtures/exploit_front_matter.erb +4 -0
data/test/helper.rb +16 -0
data/test/source/_posts/2013-01-12-nil-layout.textile +6 -0
data/test/source/_posts/2013-01-12-no-layout.textile +5 -0
data/test/source/contacts/bar.html +5 -0
data/test/source/contacts/index.html +5 -0
data/test/test_configuration.rb +7 -8
data/test/test_convertible.rb +29 -0
data/test/test_core_ext.rb +22 -0
data/test/test_generated_site.rb +1 -1
data/test/test_kramdown.rb +3 -3
data/test/test_page.rb +88 -2
data/test/test_post.rb +42 -6
data/test/test_rdiscount.rb +1 -1
data/test/test_redcarpet.rb +1 -1
data/test/test_redcloth.rb +6 -6
data/test/test_site.rb +73 -8
data/test/test_tags.rb +36 -13
metadata +150 -19
data/lib/jekyll/migrators/csv.rb +0 -26
data/lib/jekyll/migrators/drupal.rb +0 -103
data/lib/jekyll/migrators/enki.rb +0 -49
data/lib/jekyll/migrators/joomla.rb +0 -53
data/lib/jekyll/migrators/marley.rb +0 -52
data/lib/jekyll/migrators/mephisto.rb +0 -84
data/lib/jekyll/migrators/mt.rb +0 -86
data/lib/jekyll/migrators/posterous.rb +0 -67
data/lib/jekyll/migrators/rss.rb +0 -47
data/lib/jekyll/migrators/textpattern.rb +0 -58
data/lib/jekyll/migrators/tumblr.rb +0 -195
data/lib/jekyll/migrators/typo.rb +0 -51
data/lib/jekyll/migrators/wordpress.rb +0 -294
data/lib/jekyll/migrators/wordpressdotcom.rb +0 -70

@@ -0,0 +1,15 @@
+<footer>
+  <div class="content">
+    <div class="grid4 first">
+      <p>By <a href="http://tom.preston-werner.com">Tom Preston-Werner</a>, <a href="http://quaran.to/">Nick Quaranto</a>, and many more <a href="https://github.com/mojombo/jekyll/graphs/contributors">awesome contributors</a>.</p>
+    </div>
+    <div class="grid8 align-right">
+      <p>Proudly hosted by</p>
+      <a href="https://github.com">
+        <img src="{{ site.url }}/img/footer-logo.png" alt="GitHub • Social coding">
+      </a>
+    </div>
+    <div class="clear"></div>
+  </div>
+</footer>
+<div class="clear"></div>

data/site/_includes/header.html ADDED

@@ -0,0 +1,26 @@
+<header>
+  <div class="content">
+    <div class="grid3 first">
+      <h1>
+        <a href="{{ site.url }}/">
+          <span>Jekyll</span>
+          <img src="{{ site.url }}/img/logo-2x.png" width="249px" height="115px" alt="">
+        </a>
+      </h1>
+    </div>
+    <nav class="grid6">
+      <ul>
+        <li {% if page.overview %}class="current"{% endif %}>
+          <a href="{{ site.url }}/">Overview</a>
+        </li>
+        <li {% unless page.overview %}class="current"{% endunless %}>
+          <a href="{{ site.url }}/docs">Documentation</a>
+        </li>
+        <li class="">
+          <a href="https://github.com/mojombo/jekyll">View on GitHub</a>
+        </li>
+      </ul>
+    </nav>
+    <div class="clear"></div>
+  </div>
+</header>

data/site/_includes/section_nav.html ADDED

@@ -0,0 +1,22 @@
+<div class="section-nav">
+  <div class="left align-right">
+    {% if page.prev_section != null %}
+      <a href="{{ site.url }}/docs/{{ page.prev_section }}" class="prev">
+        Back
+      </a>
+    {% else %}
+      <span class="prev disabled">Back</span>
+    {% endif %}
+  </div>
+  <div class="right align-left">
+    {% if page.next_section != null %}
+      <a href="{{ site.url }}/docs/{{ page.next_section }}" class="next">
+        Next
+      </a>
+    {% else %}
+      <span class="next disabled">Next</span>
+    {% endif %}
+  </div>
+  <div class="clear"></div>
+</div>

data/site/_includes/top.html ADDED

@@ -0,0 +1,14 @@
+<!DOCTYPE HTML>
+<html lang="en-US">
+<head>
+  <meta charset="UTF-8">
+  <title>{{ page.title }}</title>
+  <link href='http://fonts.googleapis.com/css?family=Lato:100,300,400,700,900,100italic,300italic,400italic,700italic,900italic' rel='stylesheet' type='text/css'>
+  <link href='http://fonts.googleapis.com/css?family=Arizonia' rel='stylesheet' type='text/css'>
+  <link rel="stylesheet" href="{{ site.url }}/css/normalize.css" />
+  <link rel="stylesheet" href="{{ site.url }}/css/grid.css" />
+  <link rel="stylesheet" href="{{ site.url }}/css/style.css" />
+  <link rel="stylesheet" href="{{ site.url }}/css/pygments.css" />
+  <link rel="icon" type="image/x-icon" href="{{ site.url }}/favicon.png" />
+  <script src="{{ site.url }}/js/modernizr-2.5.3.min.js"></script>
+</head>

data/site/_layouts/default.html ADDED

@@ -0,0 +1,12 @@
+{% include top.html %}
+<body>
+  {% include header.html %}
+  {{ content }}
+  {% include footer.html %}
+  {% include analytics.html %}
+</body>
+</html>

data/site/_layouts/docs.html ADDED

@@ -0,0 +1,21 @@
+---
+layout: default
+---
+  <section class="docs">
+    <div class="content">
+      <div class="grid10 first">
+        <article>
+          <h1>{{ page.title }}</h1>
+          {{ content }}
+          {% include section_nav.html %}
+        </article>
+      </div>
+      {% include docs_contents.html %}
+      <div class="clear"></div>
+    </div>
+  </section>

data/site/_posts/2012-07-01-configuration.md ADDED

@@ -0,0 +1,277 @@
+---
+layout: docs
+title: Configuration
+prev_section: structure
+next_section: frontmatter
+---
+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.
+## Configuration Settings
+### Global Configuration
+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.
+<table>
+  <thead>
+    <tr>
+      <th>Setting</th>
+      <th><span class="option">Options</span> and <span class="flag">Flags</span></th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr class='setting'>
+      <td>
+        <p class='name'><strong>Site Source</strong></p>
+        <p class='description'>Changes the directory where Jekyll will look to transform files</p>
+      </td>
+      <td class="align-center">
+        <p><code class="option">source: [string]</code></p>
+        <p><code class="flag">--source [source]</code></p>
+      </td>
+    </tr>
+    <tr class='setting'>
+      <td>
+        <p class='name'><strong>Site Destination</strong></p>
+        <p class='description'>Changes the directory where Jekyll will write files to</p>
+      </td>
+      <td class="align-center">
+        <p><code class="option">destination: [string]</code></p>
+        <p><code class="flag">--destination</code></p>
+      </td>
+    </tr>
+    <tr class='setting'>
+      <td>
+        <p class='name'><strong>Safe</strong></p>
+        <p class='description'>Disables <a href="../plugins">custom plugins</a>.</p>
+      </td>
+      <td class="align-center">
+        <p><code class="option">safe: [boolean]</code></p>
+        <p><code class="flag">--safe</code></p>
+      </td>
+    </tr>
+    <tr class='setting'>
+      <td>
+        <p class='name'><strong>Exclude</strong></p>
+        <p class="description">A list of directories and files to exclude from the conversion</p>
+      </td>
+      <td class='align-center'>
+        <p><code class="option">exclude: [dir1, file1, dir2]</code></p>
+      </td>
+    </tr>
+    <tr class='setting'>
+      <td>
+        <p class='name'><strong>Include</strong></p>
+        <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>
+      </td>
+      <td class='align-center'>
+        <p><code class="option">include: [dir1, file1, dir2]</code></p>
+      </td>
+    </tr>
+  </tbody>
+</table>
+### Build Command Options
+<table>
+  <thead>
+    <tr>
+      <th>Setting</th>
+      <th><span class="option">Options</span> and <span class="flag">Flags</span></th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr class='setting'>
+      <td>
+        <p class='name'><strong>Regeneration</strong></p>
+        <p class='description'>Enables auto-regeneration of the site when files are modified. Off by default.</p>
+      </td>
+      <td class="align-center">
+        <p><code class="flag">--watch</code></p>
+      </td>
+    </tr>
+    <tr class='setting'>
+      <td>
+        <p class='name'><strong>URL</strong></p>
+        <p class='description'>Sets <code>site.url</code>, useful for environment switching</p>
+      </td>
+      <td class="align-center">
+        <p><code class="option">url: [URL]</code></p>
+        <p><code class="flag">--url [URL]</code></p>
+      </td>
+    </tr>
+    <tr class='setting'>
+      <td>
+        <p class='name'><strong>Markdown</strong></p>
+        <p class="description">Uses RDiscount or <code>[engine]</code> instead of Maruku.</p>
+      </td>
+      <td class='align-center'>
+        <p><code class="option">markdown: [engine]</code></p>
+        <p><code class="flag">--markdown [rdiscount|kramdown|redcarpet]</code></p>
+      </td>
+    </tr>
+    <tr class='setting'>
+      <td>
+        <p class='name'><strong>Pygments</strong></p>
+        <p class="description">Enables highlight tag with Pygments.</p>
+      </td>
+      <td class='align-center'>
+        <p><code class="option">pygments: [boolean]</code></p>
+        <p><code class="flag">--pygments</code></p>
+      </td>
+    </tr>
+    <tr class='setting'>
+      <td>
+        <p class='name'><strong>Future</strong></p>
+        <p class="description">Publishes posts with a future date</p>
+      </td>
+      <td class='align-center'>
+        <p><code class="option">future: [boolean]</code></p>
+        <p><code class="flag">--future</code></p>
+      </td>
+    </tr>
+    <tr class='setting'>
+      <td>
+        <p class='name'><strong>LSI</strong></p>
+        <p class="description">Produces an index for related posts.</p>
+      </td>
+      <td class='align-center'>
+        <p><code class="option">lsi: [boolean]</code></p>
+        <p><code class="flag">--lsi</code></p>
+      </td>
+    </tr>
+    <tr class='setting'>
+      <td>
+        <p class='name'><strong>Permalink</strong></p>
+        <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>
+      </td>
+      <td class='align-center'>
+        <p><code class="option">permalink: [style]</code></p>
+        <p><code class="flag">--permalink [style]</code></p>
+      </td>
+    </tr>
+    <tr class='setting'>
+      <td>
+        <p class='name'><strong>Pagination</strong></p>
+        <p class="description">Splits your posts up over multiple subdirectories called "page2", "page3", ... "pageN"</p>
+      </td>
+      <td class='align-center'>
+        <p><code class="option">paginate: [per_page]</code></p>
+        <p><code class="flag">--paginate [per_page]</code></p>
+      </td>
+    </tr>
+    <tr class='setting'>
+      <td>
+        <p class='name'><strong>Limit Posts</strong></p>
+        <p class="description">Limits the number of posts to parse and publish</p>
+      </td>
+      <td class='align-center'>
+        <p><code class="option">limit_posts: [max_posts]</code></p>
+        <p><code class="flag">--limit_posts [max_posts]</code></p>
+      </td>
+    </tr>
+  </tbody>
+</table>
+### Serve Command Options
+In addition to the options below, the `serve` sub-command can accept any of the options
+for the `build` sub-command, which are then applied to the site build which occurs right
+before your site is served.
+<table>
+  <thead>
+    <tr>
+      <th>Setting</th>
+      <th><span class="option">Options</span> and <span class="flag">Flags</span></th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr class='setting'>
+      <td>
+        <p class='name'><strong>Local Server Port</strong></p>
+        <p class='description'>Changes the port that the Jekyll server will run on</p>
+      </td>
+      <td class="align-center">
+        <p><code class="option">port: [integer]</code></p>
+        <p><code class="flag">--port [port]</code></p>
+      </td>
+    </tr>
+    <tr class='setting'>
+      <td>
+        <p class='name'><strong>Local Server Hostname</strong></p>
+        <p class='description'>Changes the hostname that the Jekyll server will run on</p>
+      </td>
+      <td class="align-center">
+        <p><code class="option">host: [string]</code></p>
+        <p><code class="flag">--host [hostname]</code></p>
+      </td>
+    </tr>
+    <tr class='setting'>
+      <td>
+        <p class='name'><strong>Base URL</strong></p>
+        <p class='description'>Serve website from a given base URL</p>
+      </td>
+      <td class="align-center">
+        <p><code class="option">baseurl: [BASE_URL]</code></p>
+        <p><code class="flag">--baseurl [url]</code></p>
+      </td>
+    </tr>
+  </tbody>
+</table>
+<div class="note warning">
+  <h5>Do not use tabs in configuration files</h5>
+  <p>This will either lead to parsing errors, or Jekyll will revert to the default settings. Use spaces instead.</p>
+</div>
+## Default Configuration
+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.
+{% highlight yaml %}
+safe:        false
+watch:       false
+server:      false
+host:        0.0.0.0
+port:        4000
+baseurl:     /
+url:         http://localhost:4000
+source:      .
+destination: ./_site
+plugins:     ./_plugins
+future:      true
+lsi:         false
+pygments:    false
+markdown:    maruku
+permalink:   date
+maruku:
+  use_tex:    false
+  use_divs:   false
+  png_engine: blahtex
+  png_dir:    images/latex
+  png_url:    /images/latex
+rdiscount:
+  extensions: []
+kramdown:
+  auto_ids: true,
+  footnote_nr: 1
+  entity_output: as_char
+  toc_levels: 1..6
+  use_coderay: false
+  coderay:
+    coderay_wrap: div
+    coderay_line_numbers: inline
+    coderay_line_numbers_start: 1
+    coderay_tab_width: 4
+    coderay_bold_every: 10
+    coderay_css: style
+{% endhighlight %}

data/site/_posts/2012-07-01-contributing.md ADDED

@@ -0,0 +1,66 @@
+---
+layout: docs
+title: Contributing
+prev_section: deployment-methods
+next_section: troubleshooting
+---
+Contributions to Jekyll are always welcome, however there’s a few things that you should keep in mind to improve your chances of having your changes merged in.
+## Workflow
+Here’s the most typical way to get your change merged into the project:
+1. Fork the project [on GitHub](https://github.com/mojombo/jekyll) and clone it down to your local machine.
+2. Create a topic branch to contain your change.
+3. Hack away, add tests. Not necessarily in that order.
+4. Make sure all the existing tests still pass.
+5. If necessary, rebase your commits into logical chunks, without errors.
+6. Push the branch up to your fork on GitHub.
+7. Create an issue on GitHub with a link to your branch.
+<div class="note warning">
+  <h5>Contributions will not be accepted without tests</h5>
+  <p>If you’re creating a small fix or patch to an existing feature, just
+    a simple test will do.</p>
+</div>
+## Tests
+We’re big on tests, so please be sure to include them. Please stay in the confines of the current test suite and use [Shoulda](https://github.com/thoughtbot/shoulda) and [RR](https://github.com/btakita/rr).
+### Tests for brand-new features
+If it’s a brand new feature, make sure to create a new [Cucumber](https://github.com/cucumber/cucumber/) feature and reuse steps where appropriate. Also, whipping up some documentation in your fork’s `gh-pages` branch would be appreciated, so the main website can be updated as soon as your new feature is merged.
+### Test dependencies
+To run the test suite and build the gem you’ll need to install Jekyll’s dependencies. Jekyll uses Bundler, so a quick run of the bundle command and you’re all set!
+{% highlight bash %}
+$ bundle
+{% endhighlight %}
+Before you start, run the tests and make sure that they pass (to confirm
+your environment is configured properly):
+{% highlight bash %}
+$ rake test
+$ rake features
+{% endhighlight %}
+## Common Gotchas
+- If you want to bump the gem version, please put that in a separate
+  commit. This way, the maintainers can control when the gem gets released.
+- Try to keep your patch(es) based from [the latest commit on
+  mojombo/jekyll](https://github.com/mojombo/jekyll/commits/master). The easier it is to apply your work, the less work
+  the maintainers have to do, which is always a good thing.
+- Please don’t tag your GitHub issue with labels like “fix” or “feature”.
+  The maintainers actively read the issues and will label it once they come
+  across it.
+<div class="note">
+  <h5>Let us know what could be better!</h5>
+  <p>Both using and hacking on Jekyll should be fun, simple, and easy, so if for some reason you find it’s a pain, please <a href="https://github.com/mojombo/jekyll/issues/new">create an issue</a> on GitHub describing your experience so we can make it better.</p>
+</div>