-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | A simple static site generator library.
--   
--   A simple static site generator library , mainly aimed at creating
--   blogs.
@package hakyll
@version 0.1

module Text.Hakyll.Util
toDestination :: FilePath -> FilePath
toCache :: FilePath -> FilePath

-- | Given a path to a file, try to make the path writable by making all
--   directories on the path.
makeDirectories :: FilePath -> IO ()

-- | Get all contents of a directory. Note that files starting with a dot
--   (.) will be ignored.
getRecursiveContents :: FilePath -> IO [FilePath]

-- | Trim a string (drop spaces and tabs at both sides).
trim :: String -> String

-- | Split a list at a certain element.
split :: (Eq a) => a -> [a] -> [[a]]

-- | Check is a cache file is still valid.
isCacheFileValid :: FilePath -> FilePath -> IO Bool

module Text.Hakyll.Page

-- | A Page is basically key-value mapping. Certain keys have special
--   meanings, like for example url, body and title.
type Page = Map String PageValue

-- | We use a ByteString for obvious reasons.
type PageValue = ByteString

-- | Add a key-value mapping to the Page.
addContext :: String -> String -> Page -> Page

-- | Get the URL for a certain page. This should always be defined. If not,
--   it will return trash.html.
getURL :: Page -> String

-- | Get the body for a certain page. When not defined, the body will be
--   empty.
getBody :: Page -> PageValue

-- | Read a page from a file. Metadata is supported, and if the filename
--   has a .markdown extension, it will be rendered using pandoc. Note that
--   pages are not templates, so they should not contain $identifiers.
readPage :: FilePath -> IO Page

-- | Create a key-value mapping page from an association list.
pageFromList :: [(String, String)] -> Page

-- | Concat the bodies of pages, and return the result.
concatPages :: [Page] -> PageValue

-- | Concat certain values of pages, and return the result.
concatPagesWith :: String -> [Page] -> PageValue

module Text.Hakyll.Render
renderPage :: FilePath -> Page -> IO Page
renderAndWrite :: FilePath -> Page -> IO ()
static :: FilePath -> IO ()
staticDirectory :: FilePath -> IO ()