Quick Start

First, install Hoxton:

$ npm install -g hoxton

In order for Hoxton to know how to build your site you'll need to specify a .yml config file.

Your config can be called whatever you like. The default that Hoxton will look like is config.yml in the root of your project.

You will also need a theme. You can download a sample theme to get going for now and paste it into your project.

Additionally you'll need some markdown files. These too can be anywhere you like.

Assuming your folder looks like:

- docs/
    - introduction.md
    - dogs.md
    - cats.md
- theme/
- config.yml

You'll need to specify the structure of your site in your config.yaml like so:

title: 'Animals.js'
theme: 'theme/'
pages:
    - Introductions: 'docs/home.md'
    - How Dogs Work: 'docs/dogs.md'
    - How To Setup a Cat: 'docs/cats.md'

For each page you have to specify the location of the markdown file that corresponds to that page.

If you want to break up your pages in sections you can check out the full configuration options.

To see what it looks like, run:

$ hoxton --serve --watch

This will watch for file changes and rebuild your site as you make changes.