kidwellj/findcommonground.uk
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Readme updates

Browse source
This commit is contained in:
Barry Clark 2014-02-25 08:47:34 -05:00
parent 2c07e25d6d
commit 1faf98e5fd
1 changed files with 14 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
README.md
View file

@ -8,23 +8,23 @@ Create your Jekyll blog in minutes, without needing to set up local development.
- Syntax highlighting - Syntax highlighting
- Disqus and Google Analytics integration - Disqus and Google Analytics integration
### 5 Minute Blog Setup on GitHub Pages ## 5 Minute Blog Setup on GitHub Pages
##### 1) Fork Jekyll Boilerplate #### 1) Fork Jekyll Boilerplate
Click the fork button at the top right of the repository. Click the fork button at the top right of the repository.
##### 2) Rename it to be your GitHub user site #### 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! 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. 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! #### 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. 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 #### 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: 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:
@ -35,37 +35,37 @@ You can quickly update a lot by simply editing the configuration file. Go to the
- Disqus comments code - Disqus comments code
- Google Analytics code - Google Analytics code
##### 5) Publish your first post #### 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. 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.
Ok, so writing your blog post might take more than 5 minutes, but once you've got it written you're set! 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 ## Set up your own domain name
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. 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.
### Publishing New Content ## Publishing New Content
Alternative flow for publishing content, without needing Local Development Environment Alternative flow for publishing content, without needing Local Development Environment
### Customizing The Theme ## Customizing The Theme
##### Hacking without a local development environment #### 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. If you're just looking to make a couple of quick theme changes, then this might do the trick for you.
##### Local Development #### Local Development
##### 1) Install Dependancies #### 1) Install Dependancies
### Get notified when I release updates or a new theme ## Get notified when I release updates or a new theme
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). 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).
### Alternative Jekyll starting points ## Alternative Jekyll starting points
This wasn't what you were looking for? Here are some other Jekyll starting points that might hit the spot: This wasn't what you were looking for? Here are some other Jekyll starting points that might hit the spot: