Jekyll Boilerplate

Create your Jekyll blog in minutes, without needing to set up local development.

Theme Demo Site

5 Minute Blog Setup on GitHub Pages

1) Fork Jekyll Boilerplate

Click the fork button at the top right of the repository.

2) Rename it to be your GitHub user site

After forking, click the Settings button on your new repository and change the repository name to username.github.io -- make sure that username is replaced with your GitHub username!

3) Your blog is live!

You can now go to http://username.github.io and you'll see your site live! This can take up to 10 minutes to update, but often it's there right away.

4) Customize your blog

You can input your details by simply editing the configuration file. Go to the base directory and open up _config.yml. In there you'll be able to input your:

• Blog name
• Description
• Avatar
• Social links
• Disqus comments code
• Google Analytics code

5) Publish your first post

Go to the _posts folder and simply edit the one that's there to create your first blog post! Jekyll pulls the date of the post from the filename, so you can edit that to today's date.

Set up your own domain name

Follow the latest GitHub Pages Custom Domain Guide to set up your custom domain name. I've created the CNAME file already, so that you can easily edit it within the repository.

Publishing New Content

Alternative flow for publishing content, without needing Local Development Environment

Customizing The Theme

Hacking without a local development environment

If you're just looking to make a couple of quick theme changes, then this might do the trick for you.

Local Development

1) Install Dependancies

Get notified when I release new themes

If you'd like me to let you know when I release a new theme, just drop me your email for updates.

Next up: A Jekyll based portfolio site theme to showcase projects and content.

Questions or requests?

Open an Issue and let's chat!

Alternative Jekyll starting points

This wasn't what you were looking for? Here are some other Jekyll starting points that might hit the spot:

• Left by Zach Holman - Jekyll theme with a sidebar
• Hazelnut by Mig Reyes - Includes sweet Pow workflows
• Octopress by Brandon Mathis - Another established starting point with lots of options
• mojombo.github.io by Tom Preston-Werner - TPW's original Jekyll theme

License

The MIT License (MIT)

Copyright (c) 2014 Barry Clark

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.