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)

License

See LICENSE.