jekyll-lair is a template to use when you're starting out using jekyll for a static website project. It's pretty opinionated, and may not be for everybody, but, seeing as how it provides almost no functionality of it's own, that's probably not a bad thing.
It's about 30 minutes worth of work that you don't have to do.
jekyll-lair constists of a particular directory layout, a couple pre-included plugins (mostly from the list at the jekyll project's wiki), and a Rakefile to manage simple steps, like starting a preview server, etc, etc.
Importantly, it's not a framework. It doesn't include base styles, a template switcher, any jquery plugins, yahoo widgets or google+ buttons. Where there are common pieces of markup that get used a lot (google analytics), they're included in the _includes directory, but not in the default layout.
If you want something to build your blog off of, see the Octopress project.
All of these are really easy to change; they're included simply by plugins that are in by default and some Rake tasks.
- scss for stylesheets
- coffeescript for javascript
- jasmine for BDD of javascript/coffeescript.
- the default layout is from HTML5 Boilerplate, and then cut way down.
There's about seventeen steps I run through everytime I start out a new project (usually static mockups). I'm tired of it.
I use a standard markup base and a couple specific plugins in almost every project I run, so they're included here. A good number of them come from the various gists linked to in the jekyll project's wiki page for plugins. Credit is given where there's no explicit licence, and the license is included if there is.
If I'm using a plugin you wrote and you'd rather I not be, please, let me know so I can pull it.
The excellent Octopress project is great for running a blog, and if that's your goal, I'd highly recommend looking at it before using jekyll-lair. It feels way too heavy for something that's not a blog though, and most of my static projects end up pulling more than half of what's there.
Plus, where there's a will, there's a git init.
-
Get the project into directory.
This isn't a project you clone. You can, if you'd like to contribute a fix for something (hint hint), but in general, this is a template you You can download the zipball, or, from the commandline:
$ wget https://github.com/lygaret/jekyll-lair/tarball/master | tar -xz . -
Install required libraries.
$ bundle install -
Run the preview server.
$ rake preview -
Profit!
Visit http://localhost:4500/
-
rake configprints the current configuration from
_config.ymland exits. Use this to see how your config file gets merged with the defaults. -
rake generateruns jekyll, with it's output going to
public. -
rake previewstarts jekyll, with the
autoandserver, making the site you're working on available at http://localhost:9292/.You can configure the preview server using the
_config.ymlfile. See the section marked off as "Jekyll Preview Configuration". -
rake archivegenerates an archive of the
_publicdirectory of the site, placing it at public_archive.tgz.To change the location where the archive is saved, or change the archive to be a zipfile rather than a tarball, change the
lair.archiveobject in_config.yml.