2014-04-26 21:32:28 +00:00
# Jekyll Now
2014-02-07 13:49:36 +00:00
2014-06-03 00:27:16 +00:00
**Jekyll** is a static site generator that's perfect for GitHub hosted blogs ([Jekyll Repository](https://github.com/jekyll/jekyll))
2014-05-19 12:45:13 +00:00
2014-05-29 00:26:13 +00:00
**Jekyll Now** makes it easier to create your Jekyll blog, by eliminating a lot of the up front setup.
2014-05-19 12:45:13 +00:00
2014-05-29 00:26:13 +00:00
- You don't need to touch the command line
- You don't need to install/configure ruby, rvm/rbenv, ruby gems :relaxed:
- You don't need to install runtime dependancies like markdown processors, Pygments, etc
2014-08-01 11:39:19 +00:00
- If you're on Windows, this will make setting up Jekyll a lot easier
2014-05-29 00:26:55 +00:00
- It's easy to try out, you can just delete your forked repository if you don't like it
2014-04-26 22:12:23 +00:00
2014-06-22 20:12:55 +00:00
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!
2014-05-27 03:47:39 +00:00
2014-06-13 12:52:46 +00:00
![Jekyll Now Theme Screenshot ](/images/jekyll-now-theme-screenshot.jpg "Jekyll Now Theme Screenshot" )
2014-04-30 12:52:28 +00:00
## Quick Start
2014-04-26 21:32:28 +00:00
2014-05-19 12:45:13 +00:00
### Step 1) Fork Jekyll Now to your User Repository
2014-04-26 22:12:23 +00:00
2014-06-11 12:52:43 +00:00
Fork this repo, then rename the repository to yourgithubusername.github.io.
2014-05-29 00:01:06 +00:00
2014-10-18 04:11:18 +00:00
Your Jekyll blog will often be viewable immediately at < http: / / yourgithubusername . github . io > (if it's not, you can often force it to build by completing step 2)
2014-04-26 22:12:23 +00:00
2014-04-26 22:28:24 +00:00
![Step 1 ](/images/step1.gif "Step 1" )
2014-04-26 22:12:23 +00:00
2014-06-11 12:52:43 +00:00
### Step 2) Customize and view your site
2014-04-26 20:50:07 +00:00
2014-06-01 23:05:41 +00:00
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.
2014-05-21 12:19:40 +00:00
2014-10-18 04:11:18 +00:00
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 > - if not, give it ten minutes as GitHub suggests and it'll appear soon
2014-06-11 12:52:43 +00:00
2014-06-15 20:30:16 +00:00
> There are 3 different ways that you can make changes to your blog's files:
2014-06-01 23:05:41 +00:00
2014-06-15 20:30:16 +00:00
> 1. Edit files within your new username.github.io repository in the browser at GitHub.com (shown below).
2014-06-15 20:51:57 +00:00
> 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.
2014-06-15 20:30:16 +00:00
> 3. Clone down your repository and make updates locally, then push them to your GitHub repository.
2014-04-26 20:50:07 +00:00
2014-05-29 01:08:15 +00:00
![_config.yml ](/images/config.png "_config.yml" )
2015-02-23 06:03:16 +00:00
2014-04-26 23:04:20 +00:00
### Step 3) Publish your first blog post
2014-04-26 20:50:07 +00:00
2014-07-31 01:08:03 +00:00
Edit `/_posts/2014-3-3-Hello-World.md` to publish your first blog post. This [Markdown Cheatsheet ](http://www.jekyllnow.com/Markdown-Style-Guide/ ) might come in handy.
2014-04-26 20:50:07 +00:00
2014-05-29 01:08:15 +00:00
![First Post ](/images/first-post.png "First Post" )
2014-04-26 22:12:23 +00:00
2014-06-11 13:21:48 +00:00
> 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
2014-04-26 20:50:07 +00:00
2014-07-30 23:53:10 +00:00
## Local Development
2015-01-11 20:22:11 +00:00
1. Install Jekyll and plug-ins in one fell swoop. `gem install github-pages` This mirrors the plug-ins used by GitHub Pages on your local machine including Jekyll, Sass, etc.
2014-10-13 14:16:44 +00:00
2. Clone down your fork `git clone git@github.com:yourusername/yourusername.github.io.git`
2014-10-06 23:10:59 +00:00
3. Serve the site and watch for markup/sass changes `jekyll serve`
4. View your website at http://0.0.0.0:4000
5. Commit any changes and push everything to the master branch of your GitHub user repository. GitHub Pages will then rebuild and serve your website.
2014-04-26 23:04:20 +00:00
## Moar!
2014-08-01 12:16:48 +00:00
I've created a more detailed walkthrough, [**Build A Blog With Jekyll And GitHub Pages** ](http://www.smashingmagazine.com/2014/08/01/build-blog-jekyll-github-pages/ ) over at the Smashing Magazine website. Check it out if you'd like a more detailed walkthrough and some background on Jekyll. :metal:
2014-04-30 12:52:28 +00:00
It covers:
2014-05-29 00:41:47 +00:00
- A more detailed walkthrough of setting up your Jekyll blog
- Common issues that you might encounter while using Jekyll
- Importing from Wordpress, using your own domain name, and blogging in your favorite editor
- Theming in Jekyll, with Liquid templating examples
- A quick look at Jekyll 2.0’ s new features, including Sass/Coffeescript support and Collections
2014-04-26 23:04:20 +00:00
## Jekyll Now Features
2014-03-03 02:39:47 +00:00
2014-05-19 12:13:11 +00:00
✓ Command-line free _fork-first workflow_ , using GitHub.com to create, customize and post to your blog
2014-05-19 12:11:18 +00:00
✓ Fully responsive and mobile optimized base theme (**[Theme Demo](http://jekyllnow.com)**)
✓ Sass/Coffeescript support using Jekyll 2.0
2014-04-26 23:10:21 +00:00
✓ Free hosting on your GitHub Pages user site
✓ Markdown blogging
2014-03-03 02:43:58 +00:00
✓ Syntax highlighting
✓ Disqus commenting
✓ Google Analytics integration
2014-05-19 22:02:27 +00:00
✓ SVG social icons for your footer
2014-06-03 00:16:45 +00:00
✓ 3 http requests, including your avatar
2014-03-03 02:43:58 +00:00
✘ No installing dependancies
2014-05-19 12:11:18 +00:00
✘ No need to set up local development
2014-03-03 02:43:58 +00:00
✘ No configuring plugins
✘ No need to spend time on theming
2014-05-29 00:41:47 +00:00
✘ More time to code other things ... wait ✓!
2014-03-03 02:39:47 +00:00
2014-06-13 00:55:33 +00:00
## Questions?
2014-02-25 14:09:15 +00:00
2014-04-20 00:42:04 +00:00
[Open an Issue ](https://github.com/barryclark/jekyll-now/issues/new ) and let's chat!
2014-02-25 14:02:27 +00:00
2014-06-14 13:03:31 +00:00
## Other forkable themes
2014-06-13 00:55:33 +00:00
2014-10-18 10:21:51 +00:00
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:
2014-06-13 00:55:33 +00:00
- [Hyde ](https://github.com/poole/hyde ) by MDO
- [Lanyon ](https://github.com/poole/lanyon ) by MDO
- [mojombo.github.io ](https://github.com/mojombo/mojombo.github.io ) by Tom Preston-Werner
- [Left ](https://github.com/holman/left ) by Zach Holman
2014-08-14 22:59:51 +00:00
- [Minimal Mistakes ](https://github.com/mmistakes/minimal-mistakes ) by Michael Rose
- [Skinny Bones ](https://github.com/mmistakes/skinny-bones-jekyll ) by Michael Rose
2014-06-13 00:55:33 +00:00
2014-04-26 20:50:07 +00:00
## Credits
2014-03-02 16:45:51 +00:00
2014-10-18 10:21:51 +00:00
- [Jekyll ](https://github.com/jekyll/jekyll ) - Thanks to its creators, contributors and maintainers.
2015-02-23 06:03:16 +00:00
- [SVG icons ](https://github.com/neilorangepeel/Free-Social-Icons ) - Thanks, Neil Orange Peel. They're beautiful.
2014-07-30 22:41:02 +00:00
- [Solarized Light Pygments ](https://gist.github.com/edwardhotchkiss/2005058 ) - Thanks, Edward.
2014-06-16 04:18:29 +00:00
- [Joel Glovier ](http://joelglovier.com/writing/ ) - Great Jekyll articles. I used Joel's feed.xml in this repository.
2014-07-30 23:54:38 +00:00
- [David Furnes ](https://github.com/dfurnes ), [Jon Uy ](https://github.com/jonuy ), [Luke Patton ](https://github.com/lkpttn ) - Thanks for the design/code reviews.
2015-03-01 21:22:45 +00:00
- [Bart Kiers ](https://github.com/bkiers ), [Florian Simon ](https://github.com/vermluh ), [Henry Stanley ](https://github.com/henryaj ), [Hun Jae Lee ](https://github.com/hunjaelee ), [Javier Cejudo ](https://github.com/javiercejudo ), [Peter Etelej ](https://github.com/etelej ), [Ben Abbott ](https://github.com/jaminscript ), [Ray Nicholus ](https://github.com/rnicholus ), [Erin Grand ](https://github.com/eringrand ), [Léo Colombaro ](https://github.com/LeoColomb ), [Dean Attali ](https://github.com/daattali ) - Thanks for your [fantastic contributions ](https://github.com/barryclark/jekyll-now/commits/master ) to the project!
2014-07-31 12:52:11 +00:00