Hakyll.Web.Html

Provides utilities to manipulate HTML pages

Generic

withTags :: (Tag String -> Tag String) -> String -> String

Map over all tags in the document

withTagList :: ([Tag String] -> [Tag String]) -> String -> String

Map over all tags (as list) in the document

Headers

demoteHeaders :: String -> String

Map every h1 to an h2, h2 to h3, etc.

demoteHeadersBy :: Int -> String -> String

Maps any hN to an hN+amount for any amount > 0 && 1 <= N+amount <= 6.

Url manipulation

getUrls :: [Tag String] -> [String]

Extract URLs from tags' attributes. Those would be the same URLs on which withUrls would act.

withUrls :: (String -> String) -> String -> String

Apply a function to each URL on a webpage

toUrl :: FilePath -> String

Convert a filepath to an URL starting from the site root

Example:

toUrl "foo/bar.html"

Result:

"/foo/bar.html"

This also sanitizes the URL, e.g. converting spaces into '%20'

toSiteRoot :: String -> String

Get the relative url to the site root, for a given (absolute) url

isExternal :: String -> Bool

Check if an URL links to an external HTTP(S) source

Stripping/escaping

stripTags :: String -> String

Strip all HTML tags from a string

Example:

stripTags "<p>foo</p>"

Result:

"foo"

This also works for incomplete tags

Example:

stripTags "<p>foo</p"

Result:

"foo"

escapeHtml :: String -> String

HTML-escape a string

Example:

escapeHtml "Me & Dean"

Result:

"Me & Dean"