diff options
Diffstat (limited to 'src/Hakyll/Web')
| -rw-r--r-- | src/Hakyll/Web/Page.hs | 9 |
1 files changed, 6 insertions, 3 deletions
diff --git a/src/Hakyll/Web/Page.hs b/src/Hakyll/Web/Page.hs index bcc3aba..7520215 100644 --- a/src/Hakyll/Web/Page.hs +++ b/src/Hakyll/Web/Page.hs @@ -3,13 +3,16 @@ -- A page is an important concept in Hakyll. It is a key-value mapping, and has -- one field with an arbitrary type. A 'Page' thus consists of -- --- * a key-value mapping (of the type @Map String String@); +-- * metadata (of the type @Map String String@); -- --- * a value (of the type @a@). +-- * the actual value (of the type @a@). -- -- Usually, the value will be a 'String' as well, and the value will be the body -- of the page. -- +-- However, this is certainly no restriction. For example, @Page ByteString@ +-- could be used to represent a binary item (e.g. an image) and some metadata. +-- -- Pages can be constructed using Haskell, but they are usually parsed from a -- file. The file format for pages is pretty straightforward. -- @@ -18,7 +21,7 @@ -- -- This is a valid page with two lines. If we load this in Hakyll, there would -- be no metadata, and the body would be the given text. Let's look at a page --- with some metadata. +-- with some metadata: -- -- > --- -- > title: Alice's Adventures in Wonderland |