Skip to content

Usage

Jump to bottom
rbwestmoreland edited this page Jul 13, 2012 · 21 revisions

Directory and File Convention

typeset uses directory and file conventions in order to keep things simple. Any directory or file that begins with an underscore (_) will not be served.

.
|--_includes
|--_layouts
|--_posts
|--_config.yml
`--favicon.ico
  • _includes This is where your html snippets lives.
  • _layouts This is where your layouts lives.
  • _posts This is where your posts live.
  • _config.yml This is your site's configuration file.

Other directories and files

They can go pretty much anywhere you like. Just follow typeset's directory and file convention and you'll be alright.

Tutorial

Adding A New Post

Add a new markdown or textile file to the _posts directory.

.
|--_includes
|--_layouts
|--_posts
|   `--hello-world.md
|--_config.yml
`--favicon.ico

Let's open hello-world.md and see what it looks like.

---
title: Hello World
date: 2012-06-19 16:46:51 -04:00
permalink: 
 - posts/hello-world
---
This is my first typeset post!

This typeset flavored YAML front matter, the bits between the ---.

  • title: The title of your post
  • date: The publish date of your post
  • permalink: A list of relative permalinks for your post
  • everything after ---: The body of your post.

Congratulations! You just wrote your first post using typeset!

Don't stop here. There's so much more you can do with typeset. Choose your adventure:

Clone this wiki locally