Minor readme update
[jekyll-now.git] / README.md
blobc809d3604344cb0999414c70aca75c84f5fede7a
1 # Jekyll Now
3 **Jekyll** is a static site generator that's perfect for GitHub hosted blogs ([Jekyll Repository](https://github.com/jekyll/jekyll))
5 **Jekyll Now** makes it easier to create your Jekyll blog, by eliminating a lot of the up front setup.
7 - You don't need to touch the command line
8 - You don't need to install/configure ruby, rvm/rbenv, ruby gems :relaxed:
9 - You don't need to install runtime dependancies like markdown processors, Pygments, etc
10 - It's easy to try out, you can just delete your forked repository if you don't like it
12 In a few minutes you'll be set up with a minimal, responsive blog ([**Theme Demo**](http://jekyllnow.com)) giving you more time to spend on making your blog awesome!
14 ## Quick Start
16 ### Step 1) Fork Jekyll Now to your User Repository
18 Fork this repo, then rename the repository to yourgithubusername.github.io.
20 Your Jekyll blog will often be viewable immediately at <http://yourgithubusername.github.io> (if it's not, you can force it to build by completing step 2)
22 ![Step 1](/images/step1.gif "Step 1")
24 ### Step 2) Customize and view your site
26 Enter your site name, description, avatar and many other options by editing the _config.yml file. You can easily turn on Google Analytics tracking, Disqus commenting and social icons here too.
28 Making a change to _config.yml (or any file in your repository) will force GitHub Pages to rebuild your site with jekyll. After making a change your updates will be viewable a few seconds later at <http://yourgithubusername.github.io>
30 > There are 2 different ways that you can make changes to your blog's files:
32 > 1. Edit files within your new username.github.io repository in the browser at GitHub.com (shown below)
33 > 2. Clone down your repository and make updates locally, then push them to your GitHub repository
35 ![_config.yml](/images/config.png "_config.yml")
36   
37 ### Step 3) Publish your first blog post
39 Edit `/_posts/2014-3-3-Hello-World.md` to publish your first blog post. This [Markdown Cheatsheet](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet) might come in handy.
41 ![First Post](/images/first-post.png "First Post")
43 To add additional posts you can hit the + icon in `/_posts/` to create new content. Just make sure to include the [front-matter](http://jekyllrb.com/docs/frontmatter/) block at the top of each new blog post and make sure the post's filename is in this format: year-month-day-title.md
46 ## Moar!
48 I've created a more detailed walkthrough of [**Getting Started With Jekyll**](#), check it out if you'd like a more detailed walkthrough and some background on Jekyll. :metal:
50 It covers:
52 - A more detailed walkthrough of setting up your Jekyll blog
53 - Common issues that you might encounter while using Jekyll
54 - Importing from Wordpress, using your own domain name, and blogging in your favorite editor
55 - Theming in Jekyll, with Liquid templating examples
56 - A quick look at Jekyll 2.0’s new features, including Sass/Coffeescript support and Collections
58 ## Jekyll Now Features
60 ✓ Command-line free _fork-first workflow_, using GitHub.com to create, customize and post to your blog  
61 ✓ Fully responsive and mobile optimized base theme (**[Theme Demo](http://jekyllnow.com)**)  
62 ✓ Sass/Coffeescript support using Jekyll 2.0  
63 ✓ Free hosting on your GitHub Pages user site  
64 ✓ Markdown blogging  
65 ✓ Syntax highlighting  
66 ✓ Disqus commenting  
67 ✓ Google Analytics integration  
68 ✓ SVG social icons for your footer  
69 ✓ 3 http requests, including your avatar  
70 ✓ Emoji in blog posts! :sparkling_heart: :sparkling_heart: :sparkling_heart:  
72 ✘ No installing dependancies  
73 ✘ No need to set up local development  
74 ✘ No configuring plugins  
75 ✘ No need to spend time on theming  
76 ✘ More time to code other things ... wait ✓!  
78 ## Questions? Suggestions?
80 [Open an Issue](https://github.com/barryclark/jekyll-now/issues/new) and let's chat!
82 ## Get new themes
84 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 currently working on a personal portfolio site Jekyll Now theme.
86 ## Credits
88 - [Jekyll](https://github.com/jekyll/jekyll) - Thanks to it's creators, contributors and maintainers.
89 - [SVG icons](https://github.com/neilorangepeel/Free-Social-Icons) - Thanks, Neil Orange Peel, the they're beautiful. 
90 - [Joel Glovier](http://joelglovier.com/writing/) - Great Jekyll articles. I used Joel's feed.xml and sitemap.xml in this repository.
91 - Design & Code reviews - Thanks to [David Furnes](https://github.com/dfurnes), [Jon Uy](https://github.com/jonuy),