findcommonground.uk/README.md

73 lines
3 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-04-26 22:12:23 +00:00
Create your Jekyll blog in minutes, without touching the command line.
I wrote a more detailed walkthrough including details of a lot of the workflow benefits and intro to Jekyll here: [Getting Started With Jekyll](#). You can use the Setup guide below to try Jekyll Now out fast.
2014-04-26 21:32:28 +00:00
### Setup
##### Step 1) Fork Jekyll Now
2014-04-26 20:50:07 +00:00
2014-04-26 22:12:23 +00:00
I love starting out by forking first as you can get a feel for what Jekyll is like _extremely quickly_. You don't have to set up a local development environment, install dependancies and figure out how the Jekyll build process works to get your site up and running.
![Step 1](/images/step1.gif "Step 1")
2014-04-26 22:20:31 +00:00
_Make to use yourgithubusername.github.io instead of souploaf.github.io!_
2014-04-26 22:12:23 +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
2014-04-26 22:12:23 +00:00
![Step 2](/images/step2.gif "Step 2")
2014-04-26 20:50:07 +00:00
2014-04-26 22:12:23 +00:00
##### Step 3) Publish your first blog post
2014-04-26 20:50:07 +00:00
2014-04-26 22:12:23 +00:00
Your site is customized and looking great. Now you just have to write that epic blog post!
2014-04-26 20:50:07 +00:00
2014-04-26 22:12:23 +00:00
![Step 3](/images/step3.gif "Step 3")
2014-04-26 22:20:31 +00:00
_You can just 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
2014-04-26 20:50:07 +00:00
## Features
2014-03-03 02:39:47 +00:00
2014-03-03 02:45:05 +00:00
✓ Fully responsive and mobile optimized theme ([Theme Demo](http://jekyllkickstart.com))
2014-03-03 02:43:58 +00:00
✓ Workflow using GitHub.com to create, customize and post to your blog
✓ Host on your free GitHub Pages user site
✓ Blog in markdown!
✓ Syntax highlighting
✓ Disqus commenting
✓ Google Analytics integration
✓ Optional Grunt workflow for local development using SASS
✘ No setting up local development
✘ No installing dependancies
✘ 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 20:50:07 +00:00
## More things you can do without touching the command line
#### Publish new content
2014-02-25 01:21:26 +00:00
2014-03-02 16:02:38 +00:00
To publish new blog posts, go into the _posts folder and click the New File button. Name your post in this format: year-month-day-Title.md, save it, and you're set!
2014-02-25 01:21:26 +00:00
(You can also publish new content via command line by git cloning down your repo, and pushing up your new markdown files)
#### Set up your domain name
2014-02-25 01:21:26 +00:00
2014-04-26 20:50:07 +00:00
Follow the latest [GitHub Pages Custom Domain Guide](https://help.github.com/articles/setting-up-a-custom-domain-with-pages) to set up your custom domain name. I've created the CNAME file already, so that you can easily edit it within the repository.
2014-04-26 20:50:07 +00:00
## Any questions?
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-03-02 16:45:51 +00:00
## Get notified when I release new themes
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-04-26 20:50:07 +00:00
- SVG icons
- Code/design reviewers
- Jekyll!