|
1 | 1 | # Jekyll Boilerplate |
2 | 2 |
|
3 | | -Create your Jekyll blog in minutes. |
| 3 | +Create your Jekyll blog in minutes, without setting up local development. |
4 | 4 |
|
5 | | -A clean, one-column theme from which to kick off your Jekyll blog. |
| 5 | +[THEME PIC!] |
6 | 6 |
|
7 | | -### Sites based on Jekyll Boilerplate |
| 7 | +Your Blog Features: |
8 | 8 |
|
9 | | -- <http://barryclark.co> |
10 | | -- Send your site to barry@barryclark.co and I'll add it |
| 9 | +- One column fully responsive design |
| 10 | +- Syntax highlighting |
| 11 | +- Minimal (X http requests) |
| 12 | +- Disqus commenting |
11 | 13 |
|
12 | | -### Good alternative Jekyll starting points |
| 14 | +### 5 Minute Blog Setup on GitHub Pages |
13 | 15 |
|
14 | | -- Looking for a theme with a sidebar? [Left by Zach Holman](https://github.com/holman/left) |
15 | | -- Looking for a starting point with sweet Pow workflows? [Hazelnut by Mig Reyes](https://github.com/migreyes/hazelnut) |
16 | | -- Looking for a bulkier starting point with more options? [Octopress by Brandon Mathis](https://github.com/imathis/octopress) |
17 | | -- Looking for where it all began? [mojombo.github.io by Tom Preston-Werner](https://github.com/mojombo/mojombo.github.io) |
| 16 | +##### 1) Fork Jekyll Boilerplate |
| 17 | + |
| 18 | +Click the fork button at the top right of the repository. |
| 19 | + |
| 20 | +##### 2) Rename it to be your GitHub user site |
| 21 | + |
| 22 | +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! |
| 23 | + |
| 24 | +Hosting your Jekyll blog on your GitHub user account takes care of a LOT of the hard work for us. You'll see shortly. |
| 25 | + |
| 26 | +##### 3) Your blog is live! |
| 27 | + |
| 28 | +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. |
| 29 | + |
| 30 | +##### 4) Customize your blog |
| 31 | + |
| 32 | +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: |
| 33 | + |
| 34 | +- Blog name |
| 35 | +- Description |
| 36 | +- Avatar |
| 37 | +- Disqus comments code |
| 38 | +- Google Analytics code |
| 39 | +- Social links |
| 40 | + |
| 41 | +##### 5) Publish your first post |
| 42 | + |
| 43 | +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! |
| 44 | + |
| 45 | +Jekyll pulls the date of the post from the filename, so you can edit that to today's date. |
| 46 | + |
| 47 | +Ok, so writing your blog post might take more than 5 minutes, but once you've got it written you're set! |
| 48 | + |
| 49 | +### Set up your own domain name (optional) |
| 50 | + |
| 51 | +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. |
| 52 | + |
| 53 | +### Publishing New Content |
| 54 | + |
| 55 | +Alternative flow for publishing content, without needing Local Development Environment |
| 56 | + |
| 57 | +### Customizing The Theme |
| 58 | + |
| 59 | +##### Without setting up local development |
| 60 | + |
| 61 | +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. |
| 62 | + |
| 63 | +##### Local Development 1) Install Dependancies |
| 64 | + |
| 65 | + |
| 66 | + |
| 67 | +### Get notified when a new theme is released |
| 68 | + |
| 69 | +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](http://getresponse.com). |
| 70 | + |
| 71 | +### Alternative Jekyll starting points |
| 72 | + |
| 73 | +This wasn't what you were looking for? Here are some other Jekyll starting points that might hit the spot: |
| 74 | + |
| 75 | +[Left by Zach Holman](https://github.com/holman/left) - Jekyll theme with a sidebar |
| 76 | +[Hazelnut by Mig Reyes](https://github.com/migreyes/hazelnut) - Includes sweet Pow workflows |
| 77 | +[Octopress by Brandon Mathis](https://github.com/imathis/octopress) - Another established starting point with lots of options |
| 78 | +[mojombo.github.io by Tom Preston-Werner](https://github.com/mojombo/mojombo.github.io) - TPW's original Jekyll theme |
0 commit comments