summaryrefslogtreecommitdiff
path: root/src/Text/Hakyll/Renderables.hs
diff options
context:
space:
mode:
authorJasper Van der Jeugt <jaspervdj@gmail.com>2010-01-17 12:37:55 +0100
committerJasper Van der Jeugt <jaspervdj@gmail.com>2010-01-17 12:37:55 +0100
commitaa44d6c0da442887155a47c77f03209224517af0 (patch)
treeb9c1d8fe6bed4eb1922d737f8817d851d8a34f5d /src/Text/Hakyll/Renderables.hs
parent003734442486876153911d339f07d4379e8dca20 (diff)
downloadhakyll-aa44d6c0da442887155a47c77f03209224517af0.tar.gz
Documentation++.
Diffstat (limited to 'src/Text/Hakyll/Renderables.hs')
-rw-r--r--src/Text/Hakyll/Renderables.hs9
1 files changed, 7 insertions, 2 deletions
diff --git a/src/Text/Hakyll/Renderables.hs b/src/Text/Hakyll/Renderables.hs
index 780f1e4..0fd66b4 100644
--- a/src/Text/Hakyll/Renderables.hs
+++ b/src/Text/Hakyll/Renderables.hs
@@ -19,10 +19,15 @@ data CustomPage = CustomPage
}
-- | Create a custom page.
+--
+-- The association list given maps keys to values for substitution. Note
+-- that as value, you can either give a @String@ or a @Hakyll String@.
+-- A @Hakyll String@ is preferred for more complex data, since it allows
+-- dependency checking. A @String@ is obviously more simple to use in some
+-- cases.
createCustomPage :: String -- ^ Destination of the page, relative to _site.
-> [FilePath] -- ^ Dependencies of the page.
- -> [(String, Either String (Hakyll String))] -- ^ Key - value
- -- mapping.
+ -> [(String, Either String (Hakyll String))] -- ^ Mapping.
-> CustomPage
createCustomPage = CustomPage