on master help sign in
Some work on the hakyll website.
dbb9a0eJasper Van der Jeugt
examples/hakyll/about.markdown+5
@@ -1,6 +1,7 @@
1---
1---
2title: About
2title: About
3---
3---
4+
4## Code
5## Code
5
6
6The code for Hakyll is freely available on
7The code for Hakyll is freely available on
@@ -21,3 +22,7 @@ following awesome projects:
21Hakyll is available under a BSD license. Note, however, that pandoc is
22Hakyll is available under a BSD license. Note, however, that pandoc is
22released under a GPL license. Since you'll probably use Hakyll with pandoc,
23released under a GPL license. Since you'll probably use Hakyll with pandoc,
23you will have to license your code under a GPL-compatible license.
24you will have to license your code under a GPL-compatible license.
25+
26+## Authors
27+
28+Hakyll was written by [Jasper Van der Jeugt](http://jaspervdj.be).
examples/hakyll/hakyll.hs+3
@@ -12,6 +12,7 @@ main = hakyll $ do
12 directory css "css"
12 directory css "css"
13 directory static "images"
13 directory static "images"
14 directory static "examples"
14 directory static "examples"
15+ directory static "reference"
15
16
16 tutorials <- liftM (sort . filter (=~ "tutorial[0-9]*.markdown")) $ getRecursiveContents "."
17 tutorials <- liftM (sort . filter (=~ "tutorial[0-9]*.markdown")) $ getRecursiveContents "."
17 let tutorialList = renderAndConcat "templates/tutorialitem.html"
18 let tutorialList = renderAndConcat "templates/tutorialitem.html"
@@ -25,6 +26,8 @@ main = hakyll $ do
25
26
26 mapM_ render' $ [ "about.markdown"
27 mapM_ render' $ [ "about.markdown"
27 , "index.markdown"
28 , "index.markdown"
29+ , "philosophy.markdown"
30+ , "reference.markdown"
28 ] ++ tutorials
31 ] ++ tutorials
29
32
30 where render' = renderChain ["templates/default.html"] . createPagePath
33 where render' = renderChain ["templates/default.html"] . createPagePath
examples/hakyll/philosophy.markdownnew file+28
@@ -0,0 +1,28 @@
1+---
2+title: Philosophy
3+---
4+
5+## Small-to-medium sites
6+
7+Hakyll was written to be used for small-to-medium sites. You can do some
8+advanced things with it, but don't use it to build a big online shop.
9+
10+## Hakyll.hs
11+
12+It should be possible to put all configuration in one file, so data and
13+configuration can be strictly separated. In addition, we think this file should
14+never exceed a 100 lines of code.
15+
16+## High-level
17+
18+Hakyll tries to provide as many high-level functions as possible for common
19+tasks, while the lower-level functions should also be accessible. If you think
20+you're writing something that can be used for many sites, please send a patch,
21+our your `hakyll.hs`, and we will see what we can do.
22+
23+## Well-documented
24+
25+A key to being easy-to-use is documentation. That's why we try to provide as
26+many working examples as possible. If you ever create a site using hakyll,
27+please consider open-sourcing it, as people might be able to learn from your
28+code.
examples/hakyll/reference.markdownnew file+10
@@ -0,0 +1,10 @@
1+---
2+title: Reference
3+---
4+
5+## Reference
6+
7+We keep a copy of the reference of the latest stable version here. This
8+reference is automatically generated by
9+[Haddock](http://www.haskell.org/haddock/). You can
10+[find it here](reference/index.html).
examples/hakyll/templates/default.html+2−1
@@ -24,8 +24,10 @@
24 <h2>Navigation</h2>
24 <h2>Navigation</h2>
25 <div id="navigation">
25 <div id="navigation">
26 <a href="index.html">home</a>
26 <a href="index.html">home</a>
27+ <a href="philosophy.html">philosophy</a>
27 <a href="about.html">about</a>
28 <a href="about.html">about</a>
28 <a href="tutorials.html">tutorials</a>
29 <a href="tutorials.html">tutorials</a>
30+ <a href="reference.html">reference</a>
29 </div>
31 </div>
30 </div>
32 </div>
31
33
@@ -35,7 +37,6 @@
35
37
36 <div id="footer">
38 <div id="footer">
37 Site proudly generated by <a href="http://github.com/jaspervdj/hakyll">hakyll</a>.
39 Site proudly generated by <a href="http://github.com/jaspervdj/hakyll">hakyll</a>.
38− Hakyll and this site were written by <a href="http://jaspervdj.be/">Jasper Van der Jeugt</a>.
39 </div>
40 </div>
40 </div>
41 </div>
41 </body>
42 </body>