hugo/docs/content/extras/permalinks.md
Anthony Fok 5d6dfe81b8 [Docs] Use <dl> for definition lists of variables
Hopefully making them more semantic and easier to read,
though it is raw HTML so it is slightly more work to maintain.

Also made minor revisions to some of the variable descriptions
to be more informative, e.g. `:monthname` in permalinks use
full English names ("January" etc.)
2015-01-19 01:30:38 -07:00

2.2 KiB
Raw Blame History

aliases date menu next notoc prev title weight
/doc/permalinks/
2013-11-18
main
parent
extras
/extras/shortcodes true /extras/menus Permalinks 70

By default, content is laid out into the target publishdir (public) namespace matching its layout within the contentdir hierarchy. The permalinks site configuration option allows you to adjust this on a per-section basis. This will change where the files are written to and will change the page's internal "canonical" location, such that template references to .RelPermalink will honour the adjustments made as a result of the mappings in this option.

For instance, if one of your sections is called post, and you want to adjust the canonical path to be hierarchical based on the year and month, then you might use:

permalinks:
  post: /:year/:month/:title/

Only the content under post/ will be so rewritten. A file named content/post/sample-entry which contains a line date: 2013-11-18T19:20:00-05:00 might end up with the rendered page appearing at public/2013/11/sample-entry/index.html and be reachable via the URL http://yoursite.example.com/2013/11/sample-entry/.

The following is a list of values that can be used in a permalink definition. All references to time are dependent on the content's date.

:year
the 4-digit year
:month
the 2-digit zero-padded month (01, 02, …, 12)
:monthname
the name of the month in English (“January”, “February”, …)
:day
the 2-digit zero-padded day (01, 02, …, 31)
:weekday
the 1-digit day of the week (Sunday = 0)
:weekdayname
the name of the day of the week in English (“Sunday”, “Monday”, …)
:yearday
the 1- to 3-digit day of the year, in the range [1,365] or [1,366]
:section
the contents section
:title
the contents title
:slug
the contents slug (or title if no slug)
:filename
the contents filename (without extension)