Included an email list for theme updates
[jekyll-now.git] / README.md
blob3b879375dccb1e20a23ffa9c4bb883b02e8a4695
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 like the one below giving you more time to spend on writing epic blog posts!
14 ![Jekyll Now Theme Screenshot](/images/jekyll-now-theme-screenshot.jpg "Jekyll Now Theme Screenshot")
16 ## Quick Start
18 ### Step 1) Fork Jekyll Now to your User Repository
20 Fork this repo, then rename the repository to yourgithubusername.github.io.
22 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)
24 ![Step 1](/images/step1.gif "Step 1")
26 ### Step 2) Customize and view your site
28 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.
30 Making a change to _config.yml (or any file in your repository) will force GitHub Pages to rebuild your site with jekyll. Your rebuilt site will be viewable a few seconds later at <http://yourgithubusername.github.io>
32 > There are 3 different ways that you can make changes to your blog's files:
34 > 1. Edit files within your new username.github.io repository in the browser at GitHub.com (shown below).
35 > 2. Use a third party GitHub content editor, like [Prose by Development Seed](http://prose.io). It's optimized for use with Jekyll making markdown editing, writing drafts, and uploading images really easy.
36 > 3. Clone down your repository and make updates locally, then push them to your GitHub repository.
38 ![_config.yml](/images/config.png "_config.yml")
39   
40 ### Step 3) Publish your first blog post
42 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.
44 ![First Post](/images/first-post.png "First Post")
46 > You can add additional posts in the browser on GitHub.com too! Just 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
49 ## Moar!
51 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:
53 It covers:
55 - A more detailed walkthrough of setting up your Jekyll blog
56 - Common issues that you might encounter while using Jekyll
57 - Importing from Wordpress, using your own domain name, and blogging in your favorite editor
58 - Theming in Jekyll, with Liquid templating examples
59 - A quick look at Jekyll 2.0’s new features, including Sass/Coffeescript support and Collections
61 ## Jekyll Now Features
63 ✓ Command-line free _fork-first workflow_, using GitHub.com to create, customize and post to your blog  
64 ✓ Fully responsive and mobile optimized base theme (**[Theme Demo](http://jekyllnow.com)**)  
65 ✓ Sass/Coffeescript support using Jekyll 2.0  
66 ✓ Free hosting on your GitHub Pages user site  
67 ✓ Markdown blogging  
68 ✓ Syntax highlighting  
69 ✓ Disqus commenting  
70 ✓ Google Analytics integration  
71 ✓ SVG social icons for your footer  
72 ✓ 3 http requests, including your avatar  
73 ✓ Emoji in blog posts! :sparkling_heart: :sparkling_heart: :sparkling_heart:  
75 ✘ No installing dependancies  
76 ✘ No need to set up local development  
77 ✘ No configuring plugins  
78 ✘ No need to spend time on theming  
79 ✘ More time to code other things ... wait ✓!  
81 ## Questions?
83 [Open an Issue](https://github.com/barryclark/jekyll-now/issues/new) and let's chat!
85 ## Get my new themes
87 If you'd like me to let you know when I release a new theme, just [drop me your email for updates](http://eepurl.com/XUZpT). I'm currently working on a hacker portfolio site theme.
89 ## Other forkable themes
91 You can use the [Quick Start](https://github.com/barryclark/jekyll-now#quick-start) workflow with other themes that are set up to be forked too! Here are some of  my favorites:
93 - [Hyde](https://github.com/poole/hyde) by MDO
94 - [Lanyon](https://github.com/poole/lanyon) by MDO
95 - [mojombo.github.io](https://github.com/mojombo/mojombo.github.io) by Tom Preston-Werner
96 - [Left](https://github.com/holman/left) by Zach Holman
98 ## Credits
100 - [Jekyll](https://github.com/jekyll/jekyll) - Thanks to it's creators, contributors and maintainers.
101 - [SVG icons](https://github.com/neilorangepeel/Free-Social-Icons) - Thanks, Neil Orange Peel. They're beautiful. 
102 - [Joel Glovier](http://joelglovier.com/writing/) - Great Jekyll articles. I used Joel's feed.xml in this repository.
103 - Design & Code reviews - Thanks to [David Furnes](https://github.com/dfurnes), [Jon Uy](https://github.com/jonuy),