summaryrefslogtreecommitdiff
path: root/examples
diff options
context:
space:
mode:
authorJasper Van der Jeugt <jaspervdj@gmail.com>2011-02-12 20:33:46 +0100
committerJasper Van der Jeugt <jaspervdj@gmail.com>2011-02-12 20:33:46 +0100
commit878ca8f3b02e99e736edaf5c7f0ba376ff3fe282 (patch)
treeb4885986b046da5af6312897d90dff23291e14ff /examples
parent1e0c875d6efd67bda010573fc8bb935eef2ea225 (diff)
downloadhakyll-878ca8f3b02e99e736edaf5c7f0ba376ff3fe282.tar.gz
Document RelativizeUrls module
Diffstat (limited to 'examples')
-rw-r--r--examples/brochure/hakyll.hs2
-rw-r--r--examples/hakyll/tutorial.markdown18
2 files changed, 15 insertions, 5 deletions
diff --git a/examples/brochure/hakyll.hs b/examples/brochure/hakyll.hs
index e84f14c..483265a 100644
--- a/examples/brochure/hakyll.hs
+++ b/examples/brochure/hakyll.hs
@@ -14,5 +14,5 @@ main = hakyll $ do
forM_ ["about.rst", "index.markdown", "code.lhs"] $ \page -> do
route page $ setExtension "html"
compile page $ defaultPageRead
- >>> require "templates/default.html" (flip applyTemplate)
+ >>> defaultApplyTemplate "templates/default.html"
>>> defaultRelativizeUrls
diff --git a/examples/hakyll/tutorial.markdown b/examples/hakyll/tutorial.markdown
index 3fa870f..bf534f3 100644
--- a/examples/hakyll/tutorial.markdown
+++ b/examples/hakyll/tutorial.markdown
@@ -73,7 +73,7 @@ main = hakyll $ do
forM_ ["about.rst", "index.markdown", "code.lhs"] $ \page -> do
route page $ setExtension "html"
compile page $ defaultPageRead
- >>> require "templates/default.html" (flip applyTemplate)
+ >>> defaultApplyTemplate "templates/default.html"
>>> defaultRelativizeUrls
~~~~~
@@ -133,7 +133,7 @@ Next, we're going to render some pages. We're going to style the results a
little, so we're going to need a [template]. We simply compile a template using
the `defaultTemplateRead` compiler, it's good enough in most cases.
-[template]: TODO: link
+[template]: /reference/Hakyll-Web-Template.html
We don't use a route for these templates, after all, we don't want to route them
anywhere, we just want to use them to style our pages a little.
@@ -142,6 +142,13 @@ anywhere, we just want to use them to style our pages a little.
compile "templates/*" defaultTemplateRead
~~~~~
+We can conclude that some rules do not *directly* add an output page on our
+site. In this case, we compile the template so it is available to the compiler
+later[^1].
+
+[^1]: Actually, since the rules DSL is declarative, we could also add the
+ template compile rule at the bottom -- this would make no difference.
+
Now, it's time to actually render our pages. We use the `forM_` monad combinator
so we can describe all files at once.
@@ -162,10 +169,13 @@ DSL there.
### The Compiler DSL
The gist of it is that the `Compiler a b` type has two parameters -- it is an
-Arrow, and we can chain compilers using the `>>>` operator.
+Arrow, and we can chain compilers using the `>>>` operator. The [compiler]
+reference page has some more information on this subject.
+
+[compiler]: /reference/Hakyll-Core-Compiler.html
~~~~~{.haskell}
compile page $ defaultPageRead
- >>> require "templates/default.html" (flip applyTemplate)
+ >>> defaultApplyTemplate "templates/default.html"
>>> defaultRelativizeUrls
~~~~~