Wrote some more documentation.

This commit is contained in:
Jasper Van der Jeugt 2010-01-24 10:30:19 +01:00
parent 6c94ad7992
commit 59e3c7f277
4 changed files with 9 additions and 2 deletions

View file

@ -1,3 +1,5 @@
-- | Module used for CSS compression. The compression is currently in a simple
-- state, but would typically reduce the number of bytes by about 25%.
module Text.Hakyll.CompressCSS
( compressCSS
) where

View file

@ -1,10 +1,10 @@
-- | A module for dealing with "Page"s. This module is mostly internally used.
module Text.Hakyll.Page
( Page
, fromContext
, getValue
, getBody
, readPage
, splitAtDelimiters
) where
import qualified Data.Map as M

View file

@ -1,3 +1,5 @@
-- | Module containing rendering functions. All these functions are used to
-- render files to the @_site@ directory.
module Text.Hakyll.Render
( depends
, render

View file

@ -1,3 +1,4 @@
-- | Miscellaneous text manipulation functions.
module Text.Hakyll.Util
( trim
, stripHTML
@ -26,6 +27,8 @@ stripHTML str = let (beforeTag, rest) = break (== '<') str
-- | Make a HTML link.
--
-- > link "foo" "bar.html" == "<a href='bar.html'>foo</a>"
link :: String -> String -> String
link :: String -- ^ Link text.
-> String -- ^ Link destination.
-> String
link text destination = "<a href=\"" ++ destination ++ "\">"
++ text ++ "</a>"