Merge pull request #88 from curbengh/url_for-options

docs: url_for option

README.md

@@ -316,7 +316,7 @@ truncate('And they found that many people were sleeping better.', {length: 25, o
 // "And they f... (continued)"
 ```
 
-### url_for(path)
+### url_for(path, {relative: boolean})
 
 Returns a url with the root path prefixed. Output is [encoded](#encodeurlstr) automatically. Requires [`bind(hexo)`](#bindhexo).
 
@@ -330,6 +330,24 @@ url_for('/a/path')
 // /blog/a/path
 ```
 
+Relative link, follows `relative_link` option by default
+e.g. post/page path is '/foo/bar/index.html'
+
+``` yml
+_config.yml
+relative_link: true
+```
+
+``` js
+url_for('/css/style.css')
+// ../../css/style.css
+
+// Override option
+// you could also enable it to output a relative link,
+// even when `relative_link` is disabled
+url_for('/css/style.css', {relative: false})
+// /css/style.css
+
 ## bind(hexo)
 
 Following utilities require `bind(hexo)` / `bind(this)` to parse the user config when initializing:

test/url_for.spec.js

@@ -51,8 +51,9 @@ describe('url_for', () => {
   });
 
   it('internal url (options.relative)', () => {
-    ctx.path = '';
-    urlFor('index.html', {relative: true}).should.eql('index.html');
+    ctx.config.relative_link = false;
+    ctx.path = 'foo/bar/';
+    urlFor('index.html', {relative: true}).should.eql('../../index.html');
 
     ctx.config.relative_link = true;
     urlFor('index.html', {relative: false}).should.eql('/index.html');