summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJasper Van der Jeugt <jaspervdj@gmail.com>2010-01-28 14:55:25 +0100
committerJasper Van der Jeugt <jaspervdj@gmail.com>2010-01-28 14:55:25 +0100
commit3f5df5ea59a904cb8b14703667b10053f9651f50 (patch)
treeb5e9aaf5c8ae36f132e67c3220531efedb9d9700
parent0d2cfb08a777f3a6459c14e40a52633cb1a2aa90 (diff)
downloadhakyll-3f5df5ea59a904cb8b14703667b10053f9651f50.tar.gz
Some more documentation.
-rw-r--r--src/Text/Hakyll/Renderables.hs7
1 files changed, 7 insertions, 0 deletions
diff --git a/src/Text/Hakyll/Renderables.hs b/src/Text/Hakyll/Renderables.hs
index fef88e6..c6954b8 100644
--- a/src/Text/Hakyll/Renderables.hs
+++ b/src/Text/Hakyll/Renderables.hs
@@ -49,6 +49,13 @@ createCustomPage = CustomPage
-- item in the list is created by applying the given template to every
-- renderable. You can also specify additional context to be included in the
-- @CustomPage@.
+--
+-- > let customPage = createListingWith
+-- > "index.html" -- Destination of the page.
+-- > "templates/postitem.html" -- Path to template to
+-- > -- render the items with.
+-- > posts -- ^ Renderables to create the list with.
+-- > [("title", "Home")] -- ^ Additional context
createListing :: (Renderable a)
=> String -- ^ Destination of the page.
-> FilePath -- ^ Template to render all items with.