summaryrefslogtreecommitdiff
path: root/web/index.markdown
diff options
context:
space:
mode:
authorJasper Van der Jeugt <jaspervdj@gmail.com>2011-06-13 08:43:28 +0200
committerJasper Van der Jeugt <jaspervdj@gmail.com>2011-06-13 08:43:28 +0200
commitedeef66180f24e4254b512041bee617368fa1eba (patch)
treedf2b6c470dba9fda52a0d3b96fd569d2c74b2c48 /web/index.markdown
parent893b366435739d073d2b6b9cafae868b5d361354 (diff)
downloadhakyll-edeef66180f24e4254b512041bee617368fa1eba.tar.gz
Remove examples from this repo
Diffstat (limited to 'web/index.markdown')
-rw-r--r--web/index.markdown43
1 files changed, 43 insertions, 0 deletions
diff --git a/web/index.markdown b/web/index.markdown
new file mode 100644
index 0000000..ee44cf3
--- /dev/null
+++ b/web/index.markdown
@@ -0,0 +1,43 @@
+---
+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)
+
+## Hakyll 3
+
+Hakyll 3 has been released, and it can be installed by running
+`cabal install hakyll`. For a limited time (but as long as is necessary) you can
+access the old site and documentation [here](/hakyll2).
+
+## Getting Started
+
+You can get the latest version from hackage using `cabal install hakyll`. Then,
+you can:
+
+- read the [tutorial](/tutorial.html);
+- mail the [google discussion group](http://groups.google.com/group/hakyll);
+- ask questions on the IRC channel: `#hakyll` on
+ [freenode](http://freenode.net/).