findcommonground.uk/README.md

92 lines
4.5 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-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))
**Jekyll Now** makes it easier to create your Jekyll blog, by eliminating a lot of the up front setup.
- 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-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-05-29 00:41:47 +00:00
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!
2014-05-27 03:47:39 +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
Fork this repo, then rename the repository to yourgithubusername.github.io.
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)
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
### Step 2) Customize and view your site
2014-04-26 20:50:07 +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-06-11 12:53:43 +00:00
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>
> There are 2 different ways that you can make changes to your blog's files:
2014-06-01 23:09:54 +00:00
> 1. Edit files within your new username.github.io repository in the browser at GitHub.com (shown below)
> 2. 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")
2014-04-26 23:04:20 +00:00
### Step 3) Publish your first blog post
2014-04-26 20:50:07 +00:00
2014-05-29 12:35:55 +00:00
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.
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
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
2014-04-26 20:50:07 +00:00
2014-04-26 23:04:20 +00:00
## Moar!
2014-05-29 00:41:47 +00:00
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:
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.0s 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
✓ 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-05-29 00:41:47 +00:00
✓ Emoji in blog posts! :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
2014-05-29 00:41:47 +00:00
✘ More time to code other things ... wait ✓!
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 23:24:49 +00:00
## 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-21 12:19:40 +00:00
- [Jekyll](https://github.com/jekyll/jekyll) - Thanks to it's creators, contributors and maintainers.
- [SVG icons](https://github.com/neilorangepeel/Free-Social-Icons) - Thanks, Neil Orange Peel, the they're beautiful.
- [Joel Glovier](http://joelglovier.com/writing/) - Great Jekyll articles. I used Joel's feed.xml and sitemap.xml in this repository.
2014-05-24 15:12:14 +00:00
- Design & Code reviews - Thanks to [David Furnes](https://github.com/dfurnes), [Jon Uy](https://github.com/jonuy),