Sha256: efe2847d64307bf183ba2c8e2b0f191e16e036b0607e703b68ceb479e0c65cdb

Contents?: true

Size: 1.99 KB

Versions: 12

Compression:

Stored size: 1.99 KB

Contents

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

h2. Getting Started

* "Install":http://wiki.github.com/mojombo/jekyll/install the gem
* Read up about its "Usage":http://wiki.github.com/mojombo/jekyll/usage and "Configuration":http://wiki.github.com/mojombo/jekyll/configuration
* Take a gander at some existing "Sites":http://wiki.github.com/mojombo/jekyll/sites
* Fork and "Contribute":http://wiki.github.com/mojombo/jekyll/contribute your own modifications
* Have questions? Post them on the "Mailing List":http://groups.google.com/group/jekyll-rb

h2. Diving In

* "Migrate":http://wiki.github.com/mojombo/jekyll/blog-migrations from your previous system
* Learn how the "YAML Front Matter":http://wiki.github.com/mojombo/jekyll/yaml-front-matter works
* Put information on your site with "Template Data":http://wiki.github.com/mojombo/jekyll/template-data
* Customize the "Permalinks":http://wiki.github.com/mojombo/jekyll/permalinks your posts are generated with
* Use the built-in "Liquid Extensions":http://wiki.github.com/mojombo/jekyll/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

See LICENSE.

Version data entries

12 entries across 12 versions & 4 rubygems

Version Path
jekyll-0.12.1 README.textile
jekyll-reloaded-0.12.2 README.textile
jekyll-0.12.0 README.textile
spinto-jekyll-0.11.2.5 README.textile
jekyll-reloaded-0.12.1 README.textile
jekyll-reloaded-0.12 README.textile
spinto-jekyll-0.11.2.3 README.textile
spinto-jekyll-0.11.2.2 README.textile
spinto-jekyll-0.11.2.1 README.textile
jekyll-0.11.2 README.textile
vanity-1.7.1 vendor/ruby/1.9.1/gems/jekyll-0.11.0/README.textile
jekyll-0.11.0 README.textile