summaryrefslogtreecommitdiff
path: root/examples
diff options
context:
space:
mode:
authorJasper Van der Jeugt <jaspervdj@gmail.com>2010-01-05 10:58:01 +0100
committerJasper Van der Jeugt <jaspervdj@gmail.com>2010-01-05 10:58:01 +0100
commitdbb9a0e1946fab03714ce52e605d6c1a5322aad6 (patch)
tree71bc61e95836ce666940b1d7f611fe30fd023564 /examples
parent222cc516272014eb2de0c4ac6137ebb6f620238e (diff)
downloadhakyll-dbb9a0e1946fab03714ce52e605d6c1a5322aad6.tar.gz
Some work on the hakyll website.
Diffstat (limited to 'examples')
-rw-r--r--examples/hakyll/about.markdown5
-rw-r--r--examples/hakyll/hakyll.hs3
-rw-r--r--examples/hakyll/philosophy.markdown28
-rw-r--r--examples/hakyll/reference.markdown10
-rw-r--r--examples/hakyll/templates/default.html3
5 files changed, 48 insertions, 1 deletions
diff --git a/examples/hakyll/about.markdown b/examples/hakyll/about.markdown
index 2091ee8..67fa46d 100644
--- a/examples/hakyll/about.markdown
+++ b/examples/hakyll/about.markdown
@@ -1,6 +1,7 @@
---
title: About
---
+
## Code
The code for Hakyll is freely available on
@@ -21,3 +22,7 @@ following awesome projects:
Hakyll is available under a BSD license. Note, however, that pandoc is
released under a GPL license. Since you'll probably use Hakyll with pandoc,
you will have to license your code under a GPL-compatible license.
+
+## Authors
+
+Hakyll was written by [Jasper Van der Jeugt](http://jaspervdj.be).
diff --git a/examples/hakyll/hakyll.hs b/examples/hakyll/hakyll.hs
index 3ae68e4..960b82a 100644
--- a/examples/hakyll/hakyll.hs
+++ b/examples/hakyll/hakyll.hs
@@ -12,6 +12,7 @@ main = hakyll $ do
directory css "css"
directory static "images"
directory static "examples"
+ directory static "reference"
tutorials <- liftM (sort . filter (=~ "tutorial[0-9]*.markdown")) $ getRecursiveContents "."
let tutorialList = renderAndConcat "templates/tutorialitem.html"
@@ -25,6 +26,8 @@ main = hakyll $ do
mapM_ render' $ [ "about.markdown"
, "index.markdown"
+ , "philosophy.markdown"
+ , "reference.markdown"
] ++ tutorials
where render' = renderChain ["templates/default.html"] . createPagePath
diff --git a/examples/hakyll/philosophy.markdown b/examples/hakyll/philosophy.markdown
new file mode 100644
index 0000000..775f239
--- /dev/null
+++ b/examples/hakyll/philosophy.markdown
@@ -0,0 +1,28 @@
+---
+title: Philosophy
+---
+
+## Small-to-medium sites
+
+Hakyll was written to be used for small-to-medium sites. You can do some
+advanced things with it, but don't use it to build a big online shop.
+
+## Hakyll.hs
+
+It should be possible to put all configuration in one file, so data and
+configuration can be strictly separated. In addition, we think this file should
+never exceed a 100 lines of code.
+
+## High-level
+
+Hakyll tries to provide as many high-level functions as possible for common
+tasks, while the lower-level functions should also be accessible. If you think
+you're writing something that can be used for many sites, please send a patch,
+our your `hakyll.hs`, and we will see what we can do.
+
+## Well-documented
+
+A key to being easy-to-use is documentation. That's why we try to provide as
+many working examples as possible. If you ever create a site using hakyll,
+please consider open-sourcing it, as people might be able to learn from your
+code.
diff --git a/examples/hakyll/reference.markdown b/examples/hakyll/reference.markdown
new file mode 100644
index 0000000..9b4d9e4
--- /dev/null
+++ b/examples/hakyll/reference.markdown
@@ -0,0 +1,10 @@
+---
+title: Reference
+---
+
+## Reference
+
+We keep a copy of the reference of the latest stable version here. This
+reference is automatically generated by
+[Haddock](http://www.haskell.org/haddock/). You can
+[find it here](reference/index.html).
diff --git a/examples/hakyll/templates/default.html b/examples/hakyll/templates/default.html
index bb6918f..6b04b9e 100644
--- a/examples/hakyll/templates/default.html
+++ b/examples/hakyll/templates/default.html
@@ -24,8 +24,10 @@
<h2>Navigation</h2>
<div id="navigation">
<a href="index.html">home</a>
+ <a href="philosophy.html">philosophy</a>
<a href="about.html">about</a>
<a href="tutorials.html">tutorials</a>
+ <a href="reference.html">reference</a>
</div>
</div>
@@ -35,7 +37,6 @@
<div id="footer">
Site proudly generated by <a href="http://github.com/jaspervdj/hakyll">hakyll</a>.
- Hakyll and this site were written by <a href="http://jaspervdj.be/">Jasper Van der Jeugt</a>.
</div>
</div>
</body>