From 878ca8f3b02e99e736edaf5c7f0ba376ff3fe282 Mon Sep 17 00:00:00 2001
From: Jasper Van der Jeugt <jaspervdj@gmail.com>
Date: Sat, 12 Feb 2011 20:33:46 +0100
Subject: Document RelativizeUrls module

---
 src/Hakyll/Web/RelativizeUrls.hs | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

(limited to 'src/Hakyll/Web/RelativizeUrls.hs')

diff --git a/src/Hakyll/Web/RelativizeUrls.hs b/src/Hakyll/Web/RelativizeUrls.hs
index 2a3b98f..40a5847 100644
--- a/src/Hakyll/Web/RelativizeUrls.hs
+++ b/src/Hakyll/Web/RelativizeUrls.hs
@@ -1,3 +1,19 @@
+-- | This module exposes a function which can relativize URL's on a webpage.
+--
+-- This means that one can deploy the resulting site on
+-- @http:\/\/example.com\/@, but also on @http:\/\/example.com\/some-folder\/@
+-- without having to change anything (simply copy over the files).
+--
+-- To use it, you should use absolute URL's from the site root everywhere. For
+-- example, use
+--
+-- > <img src="/images/lolcat.png" alt="Funny zomgroflcopter" />
+--
+-- in a blogpost. When running this through the relativize URL's module, this
+-- will result in (suppose your blogpost is located at @\/posts\/foo.html@:
+--
+-- > <img src="../images/lolcat.png" alt="Funny zomgroflcopter" />
+--
 module Hakyll.Web.RelativizeUrls
     ( relativizeUrls
     ) where
-- 
cgit v1.2.3