aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 940be05a1bdd87868c2dcbfca6db6c1000aa61b7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
# Jekyll Now

Jekyll Now is an effort to make it easier to create your Jekyll blog by eliminating a lot of the up front setup (particularly the frustrating bits!).

- No need to touch the command line
- No need to install/configure ruby, rvm/rbenv, ruby gems (my favorite part!)
- No need to install runtime dependancies like markdown processors, Pygments, etc
- No cleanup, you can simply delete your repository if you don't like it

In just a couple of minutes you'll be set up with a blog like this one - [**Theme Demo**](http://jekyllnow.com). 

## Quick Start

### Step 1) Fork Jekyll Now to your User Repository

Fork this repo, then rename the repository to yourgithubusername.github.io. Your Jekyll blog can then immediately be viewed at that URL.

![Step 1](/images/step1.gif "Step 1")
  

### Step 2) Customize your site

Enter your site name, description, avatar and many other options by editing the _config.yml file. In seconds you can add in social icons, Google Analytics tracking and Disqus commenting here too!

![_config.yml](/images/config.jpg "_config.yml")
  

### Step 3) Publish your first blog post

Edit the Hello World markdown file in /_posts/ to publish your first blog post.

![First Post](/images/first-post.jpg "First Post")

To add additional posts you can hit the + icon in the /_posts/ folder 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


## Moar!

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:

It covers:

- a
- b

## Jekyll Now Features

✓ Command-line free _fork-first workflow_, using GitHub.com to create, customize and post to your blog  
✓ Fully responsive and mobile optimized base theme (**[Theme Demo](http://jekyllnow.com)**)  
✓ Sass/Coffeescript support using Jekyll 2.0  
✓ Free hosting on your GitHub Pages user site  
✓ Markdown blogging  
✓ Syntax highlighting  
✓ Disqus commenting  
✓ RSS feed and Sitemap.xml good to go  
✓ Google Analytics integration  
✓ SVG social icons for your footer  
✓ Speed - only 3 http requests, including your avatar  
✓ Emoji! :sparkling_heart: :sparkling_heart: :sparkling_heart:  

✘ No installing dependancies  
✘ No need to set up local development  
✘ No configuring plugins  
✘ No need to spend time on theming  
✘ No setting up hosting  
✘ More time to code other things! ... wait that's a ✓  

## Questions? Suggestions?

[Open an Issue](https://github.com/barryclark/jekyll-now/issues/new) and let's chat!

## Wanna get 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). I'm currently working on a personal portfolio site Jekyll Now theme.

## Credits

- [SVG icons](https://github.com/neilorangepeel/Free-Social-Icons) are by Neil Orange Peel, the they're beautiful. 
- [Joel Glovier](http://joelglovier.com/writing/) for some of his great Jekyll articles—I used feed.xml and sitemap.xml
- [Jekyll](https://github.com/jekyll/jekyll), duh! Thanks to it's creators and contributors.
- Code/Design reviews, thanks to X, Y, Z.