README.md

   1 # Jekyll Kickstart
   2
   3 Create your Jekyll blog in minutes, without needing to set up local development.
   4
   5 [**Theme Demo >>**](http://jekyllkickstart.com)
   6
   7 ## 5 Minute Blog Setup on GitHub Pages
   8
   9 #### 1) Fork Jekyll Kickstart
  10
  11 Click the fork button at the top right of the repository.
  12
  13 #### 2) Rename it to be your GitHub user site
  14
  15 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!
  16
  17 #### 3) Your blog is live!
  18
  19 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.
  20
  21 #### 4) Customize your blog
  22
  23 Input your details by simply editing the configuration file. Go to your forked repository and open up _config.yml. In there you'll be able to input your:
  24
  25 - Blog name
  26 - Description
  27 - Avatar
  28 - Social links
  29 - Disqus comments code
  30 - Google Analytics code
  31
  32 #### 5) Publish your first post
  33
  34 Go to the _posts folder and edit the Hello World post that's there to create your first post! Jekyll pulls the date of the post from the filename, so change that to today's date.
  35
  36 #### Publishing New Content
  37
  38 To publish new blog posts, go into the _posts folder and click the New File button. Name your post in this format: year-month-day-Title.md, save it, and you're set!
  39
  40 #### Setting up your own domain name
  41
  42 Follow the latest [GitHub Pages Custom Domain Guide](https://help.github.com/articles/setting-up-a-custom-domain-with-pages) to set up your custom domain name. I've created the CNAME file already, so that you can easily edit it within the repository.
  43
  44 ## Customizing The Theme
  45
  46 #### Hacking without a local development environment
  47
  48 If you're just looking to make a couple of quick theme changes, then this might do the trick for you.
  49
  50 #### Local Development
  51
  52 #### 1) Install Dependancies
  53
  54
  55
  56 ## Get notified when I release new themes
  57
  58 If you'd like me to let you know when I release a new theme, just [drop me your email for updates](http://getresponse.com).
  59
  60 Next up: A Jekyll based portfolio site theme to showcase projects and content.
  61
  62 ## Questions or requests?
  63
  64 [Open an Issue](https://github.com/barryclark/jekyll-kickstart/issues/new) and let's chat!
  65
  66 ## Alternative Jekyll starting points
  67
  68 This wasn't what you were looking for? Here are some other Jekyll starting points that might hit the spot:
  69
  70 - [Left by Zach Holman](https://github.com/holman/left) - Jekyll theme with a sidebar
  71 - [Hazelnut by Mig Reyes](https://github.com/migreyes/hazelnut) - Includes sweet Pow workflows
  72 - [Octopress by Brandon Mathis](https://github.com/imathis/octopress) - Another established starting point with lots of options
  73 - [mojombo.github.io by Tom Preston-Werner](https://github.com/mojombo/mojombo.github.io) - TPW's original Jekyll theme