You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Parker Moore 6cc5341779 Merge pull request #883 from liliakai/0.12.1-release 9 years ago
lib Bump version in gemspec and in jekyll.rb 9 years ago
test Fix Kramdown tests: they now use numerical HTML entities 9 years ago
History.txt Relax Kramdown requirement to 0.14 instead of 0.14.1 9 years ago
jekyll.gemspec Avoid breaking change in latest directory_watcher 9 years ago


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

h2. 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":

h2. 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

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