Go to file
Barry Clark 749ed2cc87 Documentation++ 2014-02-24 20:24:01 -05:00
_includes Lots of style updates 2014-02-12 20:42:49 -05:00
_layouts Documentation++ 2014-02-24 20:21:26 -05:00
_posts Syntax highlighting. 2014-02-18 20:26:49 -05:00
images Lots of style updates 2014-02-12 20:42:49 -05:00
scss Syntax highlighting. 2014-02-18 20:26:49 -05:00
.gitignore Include site name in header 2014-02-07 08:36:03 -05:00
Gruntfile.js First commit of base theme. 2014-02-06 19:18:00 -05:00
README.md Documentation++ 2014-02-24 20:24:01 -05:00
_config.yml Syntax highlighting. 2014-02-18 20:26:49 -05:00
about.md Lots of style updates 2014-02-12 20:42:49 -05:00
index.html Style Guide, and all markdown content styled 2014-02-17 20:34:55 -05:00
sitemap.xml First commit of base theme. 2014-02-06 19:18:00 -05:00
style.css Syntax highlighting. 2014-02-18 20:26:49 -05:00

README.md

Jekyll Boilerplate

Create your Jekyll blog in minutes, without setting up local development.

[THEME PIC!]

Your Blog:

  • Fully responsive design
  • Syntax highlighting
  • Disqus and Google Analytics integration

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!

Hosting your Jekyll blog on your GitHub user account takes care of a LOT of the hard work for us. You'll see shortly.

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 quickly update a lot by simply editing the configuration file. Go to the base directory and open up _config.yml. In there you'll be able to edit your:

  • Blog name
  • Description
  • Avatar
  • Disqus comments code
  • Google Analytics code
  • Social links
5) Publish your first post

Go to the _posts folder and you'll see the post that's currently being displayed. Just edit that 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.

Ok, so writing your blog post might take more than 5 minutes, but once you've got it written you're set!

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

Without setting up local development

I realize that's pretty filthy, but if you're just looking to make a couple of quick changes, it might work well for you.

Local Development 1) Install Dependancies

Get notified when a new theme is released

I'm working on a portfolio site theme right now, and more to come after that. If you'd like me to let you know when I release a new theme, just drop me your email for updates.

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