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

Install the gem
Read up about its Usage and Configuration
Take a gander at some existing Sites
Fork and Contribute your own modifications
Have questions? Post them on the Mailing List

Diving In

Migrate from your previous system
Learn how the YAML Front Matter works
Put information on your site with Template Data
Customize the Permalinks your posts are generated with
Use the built-in Liquid Extensions to make your life easier

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)

License