Home

Jekyll is a simple, blog aware, static site generator.

It takes a template directory (representing the raw form of a website), runs it through Markdown or Textile and Liquid converters, and produces a static website suitable for any web server.

Jekyll is also the engine behind GitHub Pages, which you can use to host a blog or repository page on GitHub. See Using Jekyll with Pages.

Getting Started

• Install the gem.
• Read up about its Usage and Configuration.
• See some existing Sites.
• Have questions? Post them on the Mailing List or join us at #Jekyll on Freenode (chat.freenode.net).
• Want to know How Jekyll works?

Tutorials

• http://jekyllbootstrap.com
  Provides detailed explanations, examples, and code to make getting started with Jekyll easier.

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.
• Highlight code, include other files, and transform text with Liquid Extensions.
• Add your own Converters, Generators, and Tags with Plugins.
• Fork and Contribute your own modifications.

Tips & Tricks

• Using Jekyll with Pages. Particularly notable: “The Pages server will not build with plugins that are not marked as safe. Note that this includes all plugins in the _plugins folder”.
• Tips for working with GitHub Pages Integration. Code example reuse, and keeping documentation up to date.
• Use Simple Form to integrate a simple contact form.
• Deploy to heroku without a third-party buildpack.
• Host your Jekyll site on AWS S3.