README.textile

Path: README.textile
Last Update: Tue Apr 09 17:05:11 +0000 2013

h1. 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":pages.github.com, which you can use to host your project‘s page or blog right here from GitHub.

h2. Getting Started

h2. Diving In

h2. 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)
  • Pygments: Syntax highlighting (Python)

h2. Developer Dependencies

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

h2. License

See LICENSE.

[Validate]