Developing with Jekyll

Jekyll can also be used on your local machine with or without themes to generate any type of web site. Create a repository on GitHub for your project, pull down the up-to-date code, and use Jekyll’s built in development server to work on your laptop.

Basically, Jekyll provides a stack of web development tools that operate over a directory of text files to output a site. You could install and use these tools separately, but bundling them into a single app makes the process simpler and more powerful. The Jekyll stack includes:

For basic information about these components check the Reference page.

There is not a GUI, Jekyll uses a handful of terminal commands to do everything. Create a new project with jekyll new project-name and start the local development server with jekyll serve.

jekyll project and terminal

Although Jekyll supports plugins, gh-pages only allows a few standard ones, so avoid them if you want to use the automatic build.

Project Directory Tour

A Jekyll project is simply a directory of files, the source code for building a web site. A few directories have specialized uses for Jekyll and are denoted with an _ underscore beginning the name.

For example, check out the repository used to build this site, go-go-ghpages. Fork it and start editing file to see how it works!

Basic Workflow

Set up a repository on GitHub and active gh-pages.