summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorJasper Van der Jeugt <m@jaspervdj.be>2011-11-28 09:23:48 +0100
committerJasper Van der Jeugt <m@jaspervdj.be>2011-11-28 09:23:48 +0100
commit9ba8e1b07b44ca4a3c2e6e60f6d03de1d3ee1cc6 (patch)
tree96719a06b2c54534d5159013246a07bf123d2823 /src
parent973f77cc68ea25a31ac941cff043c9ae11680d44 (diff)
downloadhakyll-9ba8e1b07b44ca4a3c2e6e60f6d03de1d3ee1cc6.tar.gz
Update hamlet docs
Diffstat (limited to 'src')
-rw-r--r--src/Hakyll/Web/Template.hs20
1 files changed, 19 insertions, 1 deletions
diff --git a/src/Hakyll/Web/Template.hs b/src/Hakyll/Web/Template.hs
index c5c7ff8..b33d1f3 100644
--- a/src/Hakyll/Web/Template.hs
+++ b/src/Hakyll/Web/Template.hs
@@ -39,7 +39,25 @@
--
-- In addition to the native format, Hakyll also supports hamlet templates. For
-- more information on hamlet templates, please refer to:
--- <http://hackage.haskell.org/package/hamlet>.
+-- <http://hackage.haskell.org/package/hamlet>. Internally, hamlet templates are
+-- converted to hakyll templates -- which means that you can only use variable
+-- insertion (and not all hamlet's features).
+--
+-- This is an example of a valid hamlet template. You should place them in
+-- files with a @.hamlet@ extension:
+--
+-- > !!!
+-- > <html>
+-- > <head>
+-- > <meta charset="UTF-8">
+-- > <title> MyAweSomeCompany - #{title}
+-- > <body>
+-- > <h1> MyAweSomeCompany - #{title}
+-- > <div id="navigation">
+-- > <a href="/index.html"> Home
+-- > <a href="/about.html"> About
+-- > <a href="/code.html"> Code
+-- > #{body}
--
module Hakyll.Web.Template
( Template