summaryrefslogtreecommitdiff
path: root/web/index.markdown
blob: 68681b760a0f87688f9d55aa231274ab05d9df80 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
---
title: Home
---

# Overview

Hakyll is a [Haskell](http://haskell.org) library for generating static sites,
mostly aimed at small-to-medium sites and personal blogs. It is written in a
very configurable way and uses an [xmonad](http://xmonad.org)-like DSL for
configuration.

Integration with [pandoc](http://johnmacfarlane.net/pandoc/) gives us markdown
and TeX support, including syntax highlighting and other goodies.

# The Hakyll System

## Write your content in whatever format you prefer

![Write your content](/images/hakyll-system-1.png)

## Create compilation rules in a Haskell EDSL

![Write your rules](/images/hakyll-system-2.png)

## Compile it to HTML and upload it!

![Compile it](/images/hakyll-system-3.png)

# Getting Started

You can get the latest version from hackage using `cabal install hakyll`. Then,
you can:

- read the [tutorials](/tutorials.html);
- mail the [google discussion group](http://groups.google.com/group/hakyll);
- ask questions on the IRC channel: `#hakyll` on
  [freenode](http://freenode.net/).