73 lines
2.8 KiB
Markdown
73 lines
2.8 KiB
Markdown
# Jekyll Kickstart
|
|
|
|
Create your Jekyll blog in minutes, without needing to set up local development.
|
|
|
|
[**Theme Demo >>**](http://jekyllkickstart.com)
|
|
|
|
## 5 Minute Blog Setup on GitHub Pages
|
|
|
|
#### 1) Fork Jekyll Kickstart
|
|
|
|
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!
|
|
|
|
#### 3) Your blog is live!
|
|
|
|
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
|
|
|
|
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:
|
|
|
|
- Blog name
|
|
- Description
|
|
- Avatar
|
|
- Social links
|
|
- Disqus comments code
|
|
- Google Analytics code
|
|
|
|
#### 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.
|
|
|
|
#### Publishing New Content
|
|
|
|
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!
|
|
|
|
#### Setting 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.
|
|
|
|
## Customizing The Theme
|
|
|
|
#### 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.
|
|
|
|
#### Local Development
|
|
|
|
#### 1) Install Dependancies
|
|
|
|
|
|
|
|
## Get notified when I release new themes
|
|
|
|
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).
|
|
|
|
Next up: A Jekyll based portfolio site theme to showcase projects and content.
|
|
|
|
## Questions or requests?
|
|
|
|
[Open an Issue](https://github.com/barryclark/jekyll-kickstart/issues/new) and let's chat!
|
|
|
|
## 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](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
|
|
- [mojombo.github.io by Tom Preston-Werner](https://github.com/mojombo/mojombo.github.io) - TPW's original Jekyll theme |