summaryrefslogtreecommitdiff
path: root/src/Text/Hakyll/Renderable.hs
diff options
context:
space:
mode:
Diffstat (limited to 'src/Text/Hakyll/Renderable.hs')
-rw-r--r--src/Text/Hakyll/Renderable.hs12
1 files changed, 8 insertions, 4 deletions
diff --git a/src/Text/Hakyll/Renderable.hs b/src/Text/Hakyll/Renderable.hs
index 12aff5b..549899c 100644
--- a/src/Text/Hakyll/Renderable.hs
+++ b/src/Text/Hakyll/Renderable.hs
@@ -1,14 +1,18 @@
module Text.Hakyll.Renderable
- ( Renderable,
- toContext,
- getDependencies,
- getURL
+ ( Renderable(toContext, getDependencies, getURL)
) where
import System.FilePath
import Text.Template
+-- | A class for datatypes that can be rendered to pages.
class Renderable a where
+ -- | Get a context to do substitutions with.
toContext :: a -> IO Context
+
+ -- | Get the dependencies for the renderable. This is used for cache
+ -- invalidation.
getDependencies :: a -> [FilePath]
+
+ -- | Get the destination for the renderable.
getURL :: a -> FilePath