Jekyll is a blog-aware, static site generator in Ruby
Ruby
Pull request Compare This branch is 17 commits ahead, 8716 commits behind jekyll:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
features
lib
test
.gitignore
History.txt
README.textile
Rakefile
VERSION.yml
jekyll.gemspec

README.textile

Jekyll

By Tom Preston-Werner, Nick Quaranto, and many awesome contributors!

Jekyll is a simple, blog aware, static site generator. It takes a template directory (representing the raw form of a website), runs it through Textile or Markdown and Liquid converters, and spits out a complete, static website suitable for serving with Apache or your favorite web server. This is also the engine behind GitHub Pages, which you can use to host your project’s page or blog right here from GitHub.

Getting Started

Diving In

Runtime Dependencies

  • RedCloth: Textile support (Ruby)
  • Liquid: Templating system (Ruby)
  • Classifier: Generating related posts (Ruby)
  • Maruku: Default markdown engine (Ruby)
  • Directory Watcher: Auto-regeneration of sites (Ruby)
  • Open4: Talking to pygments for syntax highlighting (Ruby)
  • Pygments: Syntax highlighting (Python)

Developer Dependencies

  • Shoulda: Test framework (Ruby)
  • RR: Mocking (Ruby)
  • RedGreen: Nicer test output (Ruby)

Changes in this fork

Archives support

Based on the Mikewest Jekyll Fork, i have adding this functionality to the last version of jekyll (0.5.7 at this moment). It generates a folder structure by years, months and days. The layouts used to render this views are test/source/layouts/archivemonthly.html, layouts/archiveyearly.html and layouts/archivedaily.html. We can then have the following code in, for example, archive/index.html:

Tagging support

Based also on the Mikewest Jekyll Fork, it generates for each tag declarated in a post definition, a view based on test/source/layouts/tag_index.html. In addition, now you can ask for {% site.tags_list%} that returns an array of all tags used in all posts of your blog, order by name. With this you can iterate and generate the typical tag list with links to each tag view.

Post excerpt

Based on a Gaizka patch that has been ported to the current jekyll version. With this you can generate a summary for each of your posts. You must define a variable in each post view, called ‘extended’ with the marker that you will use to differenciate between the summary and the content:

title: New post
extended: ‘:myseparatortag:’

And then simply, in the body of your post, put your marker. Now when you call {{post.content}} in an iterator for example, it would return your excerpt, that is from the beginning of the post until the marker.

You can understand better all the new funcionality reading the tests and features or taking a look to the code of my jekyll blog

License

(The MIT License)

Copyright © 2008 Tom Preston-Werner

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the ‘Software’), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED ‘AS IS’, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.