Welcome

This site aims to be a comprehensive guide to Jekyll. We’ll cover topics such as getting your site up and running, creating and managing content, customizing your build, and deploying.

What is Jekyll, exactly?

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

You create your content as text files (Markdown), and organize them into folders. Then, you build the shell of your site using Liquid-enhanced HTML templates. Jekyll automatically stitches the content and templates together, generating a website made entirely of static assets, suitable for uploading to any server.

Jekyll happens to be the engine behind GitHub Pages, so you can host your project’s Jekyll page/blog/website on GitHub’s servers for free.

Throughout this guide, you’ll see these special sections that help you get the most out of Jekyll:

ProTips™

Tips and tricks that'll make you a Jekyll wizard!

Notes

Extra tidbits that are sometimes necessary to understand Jekyll.

Warnings

Common pitfalls to avoid.

Unreleased

Features planned for future versions of Jekyll, but not available yet.

If you find anything we haven’t covered, or would like to share a tip that others might find handy, please file an issue and we’ll see about adding it to the guide.

Back