jekyll/README.markdown

Jekyll

By Tom Preston-Werner, Nick Quaranto, and many awesome contributors!

Jekyll is a simple, blog aware, static site generator perfect for personal or project sites. Think of it sort of like a file-based CMS, except without all the complexity. Jekyll takes your content, runs it through Markdown converters and Liquid templates, and spits out a complete, static website suitable for serving with Apache, Nginx 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 on GitHub.

Philosophy

Jekyll does what you tell it to do, no more, no less. It doesn't try to outsmart users by making bold assumptions or burden them with needless complexity and configuration. Put simply, Jekyll gets out of your way and allows you to concentrate on what truly matters: your content.

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? Check out #jekyll on irc.freenode.net.

Diving In

• Migrate from your previous system
• Learn how the YAML Front Matter works
• Put information on your site with Variables
• Customize the Permalinks your posts are generated with
• Use the built-in Liquid Extensions to make your life easier
• Use custom Plugins to generate content specific to your site

Runtime Dependencies

• Commander: Command-line interface constructor (Ruby)
• Colorator: Colorizes command line output (Ruby)
• Classifier: Generating related posts (Ruby)
• Directory Watcher: Auto-regeneration of sites (Ruby)
• Liquid: Templating system (Ruby)
• Maruku: Default markdown engine (Ruby)
• Pygments.rb: Syntax highlighting (Ruby/Python)
• RedCarpet: Markdown engine (Ruby)
• Safe YAML: YAML Parser built for security (Ruby)

Developer Dependencies

• Kramdown: Markdown-superset converter (Ruby)
• Launchy: Cross-platform file launcher (Ruby)
• RDiscount: Discount Markdown Processor (Ruby)
• RedCloth: Textile support (Ruby)
• RedGreen: Nicer test output (Ruby)
• RR: Mocking (Ruby)
• Shoulda: Test framework (Ruby)
• SimpleCov: Coverage framework (Ruby)

License

See LICENSE.