Wrote about index url's in a tutorial.

1 files changed, 32 insertions, 0 deletions

diff --git a/examples/hakyll/tutorial7.markdown b/examples/hakyll/tutorial7.markdown
index 0fd6d75..cc6485a 100644
--- a/examples/hakyll/tutorial7.markdown
+++ b/examples/hakyll/tutorial7.markdown
@@ -17,3 +17,35 @@ refresh in your browser. There is one more thing to note: this will not update
 your site automatically when `hakyll.hs` changes. So if you make any changes to
 the configuration file, you'll have to compile it again, and then you can enter
 `preview` mode again.
+
+## Pretty URL's
+
+There is an option in Hakyll to produce pretty URL's, which is disabled by
+default because it can be confusing when you're first introduced to Hakyll.
+
+It can be enabled this way:
+
+~~~~~{.haskell}
+import Text.Hakyll
+import Text.Hakyll.Hakyll
+
+myHakyllConfiguration :: HakyllConfiguration
+myHakyllConfiguration = defaultHakyllConfiguration
+    { enableIndexUrl = True
+    }
+
+main = hakyllWithConfiguration HakyllConfiguration $ do
+    -- Further code here
+~~~~~
+
+The effect will be that the internal `toUrl` function will behave differently.
+A few examples:
+
+- `about.html` will be rendered to `about/index.html`.
+- `posts/2010-02-16-a-post.markdown` will be rendered to
+  `posts/2010-02-16-a-post/index.html`.
+- However, `index.markdown` will still be rendered to `index.html`. Likewise,
+  `posts/index.html` would be rendered to `posts.index.html`.
+
+The benefit of this is simply prettier URL's. That is, if you consider
+`example.com/about` prettier than `example.com/about.html`.