@@ -3,13 +3,16 @@
3-- A page is an important concept in Hakyll. It is a key-value mapping, and has
3-- A page is an important concept in Hakyll. It is a key-value mapping, and has
4-- one field with an arbitrary type. A 'Page' thus consists of
4-- one field with an arbitrary type. A 'Page' thus consists of
6−-- * a key-value mapping (of the type @Map String String@);
6+-- * metadata (of the type @Map String String@);
8−-- * a value (of the type @a@).
8+-- * the actual value (of the type @a@).
10-- Usually, the value will be a 'String' as well, and the value will be the body
10-- Usually, the value will be a 'String' as well, and the value will be the body
11-- of the page.
11-- of the page.
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.
13-- Pages can be constructed using Haskell, but they are usually parsed from a
16-- Pages can be constructed using Haskell, but they are usually parsed from a
14-- file. The file format for pages is pretty straightforward.
17-- file. The file format for pages is pretty straightforward.
@@ -18,7 +21,7 @@
19-- This is a valid page with two lines. If we load this in Hakyll, there would
22-- This is a valid page with two lines. If we load this in Hakyll, there would
20-- be no metadata, and the body would be the given text. Let's look at a page
23-- 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:
24-- > title: Alice's Adventures in Wonderland
27-- > title: Alice's Adventures in Wonderland