on master help sign in
Update hamlet docs
9ba8e1bJasper Van der Jeugt
src/Hakyll/Web/Template.hs+19−1
@@ -39,7 +39,25 @@
39--
39--
40-- In addition to the native format, Hakyll also supports hamlet templates. For
40-- In addition to the native format, Hakyll also supports hamlet templates. For
41-- more information on hamlet templates, please refer to:
41-- more information on hamlet templates, please refer to:
42−-- <http://hackage.haskell.org/package/hamlet>.
42+-- <http://hackage.haskell.org/package/hamlet>. Internally, hamlet templates are
43+-- converted to hakyll templates -- which means that you can only use variable
44+-- insertion (and not all hamlet's features).
45+--
46+-- This is an example of a valid hamlet template. You should place them in
47+-- files with a @.hamlet@ extension:
48+--
49+-- > !!!
50+-- > <html>
51+-- > <head>
52+-- > <meta charset="UTF-8">
53+-- > <title> MyAweSomeCompany - #{title}
54+-- > <body>
55+-- > <h1> MyAweSomeCompany - #{title}
56+-- > <div id="navigation">
57+-- > <a href="/index.html"> Home
58+-- > <a href="/about.html"> About
59+-- > <a href="/code.html"> Code
60+-- > #{body}
43--
61--
44module Hakyll.Web.Template
62module Hakyll.Web.Template
45 ( Template
63 ( Template