github/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2025-03-14 15:33:38 +00:00
Code Issues Projects Releases Packages Wiki Activity

Add doc for absURL and relURL

Browse source 
Also group URL related functions in doc.
This commit is contained in:
bep 2015-05-11 19:08:52 +02:00
parent be4f48652d
commit be82355570
1 changed files with 36 additions and 24 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

60
docs/content/templates/functions.md
View file

@ -309,12 +309,6 @@ This will run the string through the Markdown processesor. The result will be de
e.g. `{{ .Title | markdownify }}`
### ref, relref
Looks up a content page by relative path or logical name to return the permalink (`ref`) or relative permalink (`relref`). Requires a Node or Page object (usually satisfied with `.`). Used in the [`ref` and `relref` shortcodes]({{% ref "extras/crossreferences.md" %}}).
e.g. {{ ref . "about.md" }}
### replace
Replace all occurences of the search string with the replacement string.
@ -377,6 +371,42 @@ Example: Given `style = "color: red;"` defined in the front matter of your `.md`
Note: "ZgotmplZ" is a special value that indicates that unsafe content reached a
CSS or URL context.
### title
Convert all characters in string to titlecase.
e.g. `{{title "BatMan"}}` → "Batman"
### trim
Trim returns a slice of the string with all leading and trailing characters contained in cutset removed.
e.g. `{{ trim "++Batman--" "+-" }}` → "Batman"
### upper
Convert all characters in string to uppercase.
e.g. `{{upper "BatMan"}}` → "BATMAN"
## Urls
### absURL, relURL
Both `absURL` and `relURL` considers the configured value of `baseURL`, so given a `baseURL` set to `http://mysite.com/hugo/`:
* `{{ "mystyle.css" | absURL }}` → "http://mysite.com/hugo/mystyle.css"
* `{{ "mystyle.css" | relURL }}` → "/hugo/mystyle.css"
**Note:** If `canonifyUrls` is enabled, the last example above will be "/mystyle.css". These functions are smart about missing slashes, but will not add one to the end if not present.
### ref, relref
Looks up a content page by relative path or logical name to return the permalink (`ref`) or relative permalink (`relref`). Requires a Node or Page object (usually satisfied with `.`). Used in the [`ref` and `relref` shortcodes]({{% ref "extras/crossreferences.md" %}}).
e.g. {{ ref . "about.md" }}
### safeURL
Declares the provided string as a "safe" URL or URL substring (see [RFC 3986][]).
@ -417,24 +447,6 @@ With this change, we finally get `<li><a href="irc://irc.freenode.net/#golang">I
as intended.
### title
Convert all characters in string to titlecase.
e.g. `{{title "BatMan"}}` → "Batman"
### trim
Trim returns a slice of the string with all leading and trailing characters contained in cutset removed.
e.g. `{{ trim "++Batman--" "+-" }}` → "Batman"
### upper
Convert all characters in string to uppercase.
e.g. `{{upper "BatMan"}}` → "BATMAN"
### urlize
Takes a string and sanitizes it for usage in URLs, converts spaces to "-".