sixones-jekyll

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

• RedCloth: Textile support
• Liquid: Templating system
• Classifier: Generating related posts
• Maruku: Default markdown engine
• Directory Watcher: Auto-regeneration of sites
• Open4: Talking to pygments for syntax highlighting

h2. Custom Filters

Jekyll can use custom liquid filters for the rendering of your site, these can be created in the same way as standard liquid filters. Before a filter will work through Jekyll you need to include the filter module:

include Jekyll::Filters::Custom

Filters are expected inside a _filters directory at the root of your source directory.

Jekyll custom liquid filter example:

module MyModule
	module StringFilter
		include Jekyll::Filters::Custom

		def my_filter(arg)
			"Hello World!"
		end
	end
end

You would then be able to use the filter inside your templates:

{{ "arg" | my_filter }}

Custom filters can be enable by running Jekyll with the flag:

$ jekyll --custom-filters

You can also use the custom_filters property in the YML config.

h2. License

(The MIT License)

Copyright (c) 2008 Tom Preston-Werner

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.