cnunciato / jekyll-starter

A super-simple starter-kit for a bare-bones Jekyll instance.

jekyll-starter

A super-simple starter kit for a bare-bones Jekyll instance. To use, just install Jekyll (if you haven't already):

gem install jekyll

... then:

mkdir my-new-blog; cd my-new-blog
git clone git://github.com/cnunciato/jekyll-starter.git .

... and then finally:

jekyll --server

Then open your browser and hit http://localhost:5000.

That'll get you a home page and one post. The rest is all you! See the Jekyll docs for details.

Keep in mind that at this point, you'll have a cloned version of my repository, which you might not want. To start fresh with a commit history of your own (which I'd recommend, unless you plan on contributing to this project), do this from the root of my-new-blog:

rm -rf .git
git init
git add .
git commit -am "my first commit"

What This Actually Does

All this kit does is set you up with the typical Jekyll directory structure, a sample index.html file, a sample post, a shared header and footer, and a couple of tweaks to the default configuration (port 5000, auto-regenerate true). That's it -- no categories, no tags, no Twitter or Disqus integration, no fanciness. Deliberately simple, just the basics. I know I wanted this when I first got started with Jekyll, so here it is -- hopefully helpful to you, too.

To create a new post, just:

touch _posts/yyyy-mm-dd-url-friendly-title.markdown

... where yyyy-mm-dd is a date (e.g., 2012-08-31) and url-friendly-title is, well, a URL-friendly title. Then inside that post, be sure to add at least the minimal YAML front matter (see the _posts folder for an example):

---
layout: post
title: "My Second Post"
---

It was a dark and stormy night...

Enjoy.

jekyll-starter's Issues

Update jekyll command

Jekyll is now using jekyll serve and commands using --serve and --server are deprecated.
Please update them in the README

Update clone URL in README

The clone URL in your README doesn't allow read access. I had to use git://github.com/cnunciato/jekyll-starter.git instead:

sarah@REVENANT ~/Documents/Jekyll
$ git clone [email protected]:cnunciato/jekyll-starter.git portfolio
Cloning into 'portfolio'...
Permission denied (publickey).
fatal: Could not read from remote repository.

Please make sure you have the correct access rights
and the repository exists.
sarah@REVENANT ~/Documents/Jekyll
$ git clone git://github.com/cnunciato/jekyll-starter.git portfolio
Cloning into 'portfolio'...
remote: Counting objects: 80, done.
remote: Compressing objects: 100% (61/61), done.
remote: Total 80 (delta 31), reused 52 (delta 6)
Receiving objects: 100% (80/80), 7.88 KiB, done.
Resolving deltas: 100% (31/31), done.
sarah@REVENANT ~/Documents/Jekyll
$