44fc490 · hakyll · git.iko.soy

git.iko.soy/hakyll

Minor changes in Page haddocks

commit44fc490a418d1d102633d74626e6343c827a5758 authorJasper Van der Jeugt <jaspervdj@gmail.com> dateMon 30 May 2011, 11:45 (15 years ago) parent7f7494c

2 files changed+7−4

compare with master

unifiedsplit

src/Hakyll/Core/Compiler.hs+1−1 src/Hakyll/Web/Page.hs+6−3

src/Hakyll/Core/Compiler.hs+1−1

@@ -230,7 +230,7 @@ getDependency id' = CompilerM $ do

230230 Found x -> return x

231231 where

232232 notFound =

233− "Hakyll.Core.Compiler.getDependency: " ++ show id' ++ " was "

233+ "Hakyll.Core.Compiler.getDependency: " ++ show id' ++ " was " ++

234234 "not found in the cache, the cache might be corrupted or " ++

235235 "the item you are referring to might not exist"

236236 wrongType e r =

src/Hakyll/Web/Page.hs+6−3

@@ -3,13 +3,16 @@

33-- A page is an important concept in Hakyll. It is a key-value mapping, and has

44-- one field with an arbitrary type. A 'Page' thus consists of

55--

6−-- * a key-value mapping (of the type @Map String String@);

6+-- * metadata (of the type @Map String String@);

77--

8−-- * a value (of the type @a@).

8+-- * the actual value (of the type @a@).

99--

1010-- Usually, the value will be a 'String' as well, and the value will be the body

1111-- of the page.

1212--

13+-- However, this is certainly no restriction. For example, @Page ByteString@

14+-- could be used to represent a binary item (e.g. an image) and some metadata.

15+--

1316-- Pages can be constructed using Haskell, but they are usually parsed from a

1417-- file. The file format for pages is pretty straightforward.

1518--

@@ -18,7 +21,7 @@

1821--

1922-- This is a valid page with two lines. If we load this in Hakyll, there would

2023-- be no metadata, and the body would be the given text. Let's look at a page

21−-- with some metadata.

24+-- with some metadata:

2225--

2326-- > ---

2427-- > title: Alice's Adventures in Wonderland