docs: Document relativeURLs
authorCameron Moore <moorereason@gmail.com>
Sat, 7 May 2016 19:39:40 +0000 (14:39 -0500)
committerCameron Moore <moorereason@gmail.com>
Sat, 7 May 2016 21:52:18 +0000 (16:52 -0500)
Fixes #1342

docs/content/extras/urls.md

index ddd6fed7c4dfd4cce05bde9d38088e70ca0ed8a7..95e80a0cfc9c9a54d9510e473f71abb3a06f2d1a 100644 (file)
@@ -1,7 +1,7 @@
 ---
 aliases:
 - /doc/urls/
-lastmod: 2015-12-08
+lastmod: 2016-05-07
 date: 2014-01-03
 menu:
   main:
@@ -61,3 +61,11 @@ Or, if you are on Windows and do not have `grep` installed:
 
     hugo config | FINDSTR /I canon
 
+## Relative URLs
+
+By default, all relative URLs are left unchanged by Hugo,
+which can be problematic when you want to make your site browsable from a local file system.
+
+Setting `relativeURLs` to `true` in the site configuration will cause Hugo to rewrite all relative URLs to be relative to the current content.
+
+For example, if the `/post/first/` page contained a link with a relative URL of `/about/`, Hugo would rewrite that URL to `../../about/`.