joeandem.com Joe and Em

Style Guide

Markdown (or Textile), Liquid, HTML & CSS go in. Static sites come out ready for deployment.

Headings

Heading 1

Heading 2

Heading 3

Heading 4

Heading 5
Heading 6

Blockquote

No more databases, comment moderation, or pesky updates to install—just your content.

  • 2 lbs strawberries, hulled and halved
  • 2 stalks rhubarb, sliced
  • 1/2 cup sugar
  • 3 cups flour (I used pastry)
  • 2 teaspoons baking powder
  • 1 teaspoon baking soda
  • 2 tablespoons sugar
  • 1/2 teaspoon salt
  • 8 tablespoons (1 stick) unsalted butter, cut into small pieces
  • 2 cups buttermilk

Unordered List

  • Jekyll
  • Ruby
  • Markdown
  • Liquid

Ordered List

  1. Jekyll
  2. Ruby
  3. Markdown
  4. Liquid

This is an example inline link.

Paragraph w/ strong, em, etc.

These are just a few of the available configuration options. Many configuration options can either be specified as flags on the command line, or alternatively (and more commonly) they can be specified in a _config.yml file at the root of the source directory. Jekyll will automatically use the options from this file when run. For example, if you place the following lines in your _config.yml file.

Image

Photo by Geo Darwin.

Video

Default Code Block

This is code blog.

Definition Lists

Definition Title
Definition Description

Paragraphs w/ Aligned Images

The Jekyll gem makes a jekyll executable available to you in your Terminal window. You can use this command in a number of ways.

Photo by Niklas Rhöse.

This site aims to be a comprehensive guide to Jekyll. We’ll cover topics such as getting your site up and running, creating and managing your content, customizing the way your site works and looks, deploying to various environments, and give you some advice on participating in the future development of Jekyll itself.

Jekyll is a simple, blog-aware, static site generator. It takes a template directory containing raw text files in various formats, runs it through a converter (like Markdown) and our Liquid renderer, and spits out a complete, ready-to-publish static website suitable for serving with your favorite web server. Jekyll also happens to be the engine behind GitHub Pages, which means you can use Jekyll to host your project’s page, blog, or website from GitHub’s servers for free.

Photo by Stefan Johnson.

Throughout this guide there are a number of small-but-handy pieces of information that can make using Jekyll easier, more interesting, and less hazardous. Here’s what to look out for.

If you come across anything along the way that we haven’t covered, or if you know of a tip you think others would find handy, please file an issue and we’ll see about including it in this guide.

The front matter is where Jekyll starts to get really cool. Any file that contains a YAML front matter block will be processed by Jekyll as a special file. The front matter must be the first thing in the file and must take the form of valid YAML set between triple-dashed lines.

The Jekyll gem makes a jekyll executable available to you in your Terminal window. You can use this command in a number of ways.

If you come across anything along the way that we haven’t covered, or if you know of a tip you think others would find handy, please file an issue and we’ll see about including it in this guide.