findcommonground.uk/README.md

85 lines
3.6 KiB
Markdown
Raw Normal View History

2014-04-26 21:32:28 +00:00
# Jekyll Now
2014-02-07 13:49:36 +00:00
2014-05-19 12:53:40 +00:00
Jekyll Now is an effort to make it easier to set up your Jekyll blog, eliminating the following up front work:
- No need to touch the command line
- No need to install/configure ruby, rvm/rbenv, ruby gems (my least favorite part, as I'm not a rubyist)
- No need to install runtime dependancies like markdown processors, Pygments, etc
- No need to spend too much time on theming
2014-05-19 12:48:19 +00:00
- No cleanup, you can simply delete your repository if you don't like it
The Jekyll Now base theme is fully responsive, clean, and minimal (3 http requests including social icons and your avatar).
2014-05-19 12:48:19 +00:00
[![Jekyll Now Theme Screenshot](/images/jekyll-now-theme-screenshot.jpg "Jekyll Now Theme Screenshot")](https://raw.githubusercontent.com/barryclark/jekyll-now/master/images/jekyll-now-theme-screenshot-big.jpg)
2014-04-26 22:12:23 +00:00
2014-04-30 12:52:28 +00:00
## Quick Start
2014-04-26 21:32:28 +00:00
### Step 1) Fork Jekyll Now to your User Repository
2014-04-26 22:12:23 +00:00
2014-04-26 23:15:42 +00:00
With this fork first setup you can get a feel for what Jekyll is like extremely quickly. Fork this repo, then make sure that you rename your fork to yourgithubusername.github.io. Your Jekyll blog can then immediately be viewed at that URL.
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 23:04:20 +00:00
2014-04-26 22:12:23 +00:00
2014-04-26 23:04:20 +00:00
### Step 2) Customize your site
2014-04-26 20:50:07 +00:00
2014-04-26 22:12:23 +00:00
You can now edit your site name, gravatar and other options using the _config.yml file.
2014-04-26 20:50:07 +00:00
![_config.yml](/images/config.jpg "_config.yml")
2014-04-26 23:04:20 +00:00
2014-04-26 20:50:07 +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-04-26 22:28:24 +00:00
Your site is customized and looking great. Now you just have to write that epic blog post! We're going to edit the existing Hello World post for your first post.
2014-04-26 20:50:07 +00:00
![First Post](/images/first-post.jpg "First Post")
2014-04-26 22:12:23 +00:00
2014-04-26 22:28:24 +00:00
To add additional posts you can hit the + icon in the _posts folder (shown at the end of the video) 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-04-26 23:04:20 +00:00
## 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:
2014-04-30 12:52:28 +00:00
It covers:
- a
- b
2014-04-26 23:04:20 +00:00
## Jekyll Now Features
2014-03-03 02:39:47 +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
✓ RSS feed and Sitemap.xml good to go
2014-03-03 02:43:58 +00:00
✓ Google Analytics integration
✓ SVG social icons for your footer
✓ Speed - only 3 http requests, including your avatar
2014-05-19 12:08:02 +00:00
✓ Emoji! :sparkling_heart: :sparkling_heart: :sparkling_heart:
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
✘ No setting up hosting
2014-03-03 02:45:05 +00:00
✘ More time to code other things! ... wait that's a ✓
2014-03-03 02:39:47 +00:00
2014-04-26 23:15:42 +00:00
## Questions? Suggestions?
2014-02-25 14:09:15 +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-05-19 12:16:53 +00:00
## Wanna get new themes?
2014-03-02 16:45:51 +00:00
2014-04-26 20:50:07 +00:00
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
2014-03-02 16:45:51 +00:00
2014-05-19 12:16:53 +00:00
- [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.