Jekyll

Build Status Code Climate

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

  • Classifier: Generating related posts (Ruby)
  • Directory Watcher: Auto-regeneration of sites (Ruby)
  • Kramdown: Markdown-superset converter (Ruby)
  • Liquid: Templating system (Ruby)
  • Maruku: Default markdown engine (Ruby)

Developer Dependencies

  • RDiscount: Discount Markdown Processor (Ruby)
  • RedCloth: Textile support (Ruby)
  • RedGreen: Nicer test output (Ruby)
  • RR: Mocking (Ruby)
  • Shoulda: Test framework (Ruby)

License

See LICENSE.