findcommonground.uk/README.md

73 lines
2.8 KiB
Markdown
Raw Normal View History

2014-02-27 00:54:39 +00:00
# Jekyll Kickstart
2014-02-07 13:49:36 +00:00
2014-02-25 13:44:16 +00:00
Create your Jekyll blog in minutes, without needing to set up local development.
2014-02-07 13:49:36 +00:00
2014-02-27 00:54:39 +00:00
[**Theme Demo >>**](http://jekyllkickstart.com)
2014-02-25 13:47:34 +00:00
## 5 Minute Blog Setup on GitHub Pages
2014-02-27 00:54:39 +00:00
#### 1) Fork Jekyll Kickstart
2014-02-25 01:21:26 +00:00
Click the fork button at the top right of the repository.
2014-02-25 13:47:34 +00:00
#### 2) Rename it to be your GitHub user site
2014-02-25 01:21:26 +00:00
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!
2014-02-25 13:47:34 +00:00
#### 3) Your blog is live!
2014-02-25 01:21:26 +00:00
2014-03-02 16:02:38 +00:00
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.
2014-02-25 01:21:26 +00:00
2014-02-25 13:47:34 +00:00
#### 4) Customize your blog
2014-02-25 01:21:26 +00:00
2014-03-02 16:02:38 +00:00
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:
2014-02-25 01:21:26 +00:00
- Blog name
- Description
- Avatar
2014-02-25 13:44:16 +00:00
- Social links
2014-02-25 01:21:26 +00:00
- Disqus comments code
- Google Analytics code
2014-02-25 13:47:34 +00:00
#### 5) Publish your first post
2014-02-25 01:21:26 +00:00
2014-03-02 16:03:48 +00:00
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.
2014-02-25 01:21:26 +00:00
2014-03-02 16:02:38 +00:00
#### Publishing New Content
2014-02-25 01:21:26 +00:00
2014-03-02 16:02:38 +00:00
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!
2014-02-25 01:21:26 +00:00
2014-03-02 16:02:38 +00:00
#### Setting up your own domain name
2014-02-25 01:21:26 +00:00
2014-03-02 16:02:38 +00:00
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.
2014-02-25 01:21:26 +00:00
2014-02-25 13:47:34 +00:00
## Customizing The Theme
2014-02-25 01:21:26 +00:00
2014-02-25 13:47:34 +00:00
#### Hacking without a local development environment
2014-02-25 01:21:26 +00:00
2014-02-25 01:25:15 +00:00
If you're just looking to make a couple of quick theme changes, then this might do the trick for you.
2014-02-25 01:21:26 +00:00
2014-02-25 13:47:34 +00:00
#### Local Development
2014-02-25 13:44:16 +00:00
2014-02-25 13:47:34 +00:00
#### 1) Install Dependancies
2014-02-25 01:21:26 +00:00
2014-02-25 14:09:15 +00:00
## Get notified when I release new themes
2014-02-25 01:21:26 +00:00
2014-02-25 14:09:15 +00:00
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).
2014-02-25 01:21:26 +00:00
2014-02-25 14:09:15 +00:00
Next up: A Jekyll based portfolio site theme to showcase projects and content.
2014-02-25 14:02:27 +00:00
2014-02-25 14:09:15 +00:00
## Questions or requests?
2014-02-27 00:54:39 +00:00
[Open an Issue](https://github.com/barryclark/jekyll-kickstart/issues/new) and let's chat!
2014-02-25 14:02:27 +00:00
2014-02-25 13:47:34 +00:00
## Alternative Jekyll starting points
2014-02-25 01:21:26 +00:00
This wasn't what you were looking for? Here are some other Jekyll starting points that might hit the spot:
2014-02-25 01:25:15 +00:00
- [Left by Zach Holman](https://github.com/holman/left) - Jekyll theme with a sidebar
- [Hazelnut by Mig Reyes](https://github.com/migreyes/hazelnut) - Includes sweet Pow workflows
- [Octopress by Brandon Mathis](https://github.com/imathis/octopress) - Another established starting point with lots of options
2014-03-02 15:53:37 +00:00
- [mojombo.github.io by Tom Preston-Werner](https://github.com/mojombo/mojombo.github.io) - TPW's original Jekyll theme