docs: Clarify difference between slug and url

This commit is contained in:
digitalcraftsman 2016-09-16 17:37:35 +02:00
parent e80453a991
commit 742911146a

View file

@ -102,13 +102,12 @@ Field names are always normalized to lowercase (e.g. `camelCase: true` is availa
* **publishdate** If in the future, content will not be rendered unless `hugo` is called with `--buildFuture` * **publishdate** If in the future, content will not be rendered unless `hugo` is called with `--buildFuture`
* **expirydate** Content already expired will not be rendered unless `hugo` is called with `--buildExpired` * **expirydate** Content already expired will not be rendered unless `hugo` is called with `--buildExpired`
* **type** The type of the content (will be derived from the directory automatically if unset) * **type** The type of the content (will be derived from the directory automatically if unset)
* **isCJKLanguage** If true, explicitly treat the content as CJKLanguage (.Summary and .WordCount can work properly in CJKLanguage) * **isCJKLanguage** If true, explicitly treat the content as CJKLanguage (`.Summary` and `.WordCount` can work properly in CJKLanguage)
* **weight** Used for sorting * **weight** Used for sorting
* **markup** *(Experimental)* Specify `"rst"` for reStructuredText (requires * **markup** *(Experimental)* Specify `"rst"` for reStructuredText (requires
`rst2html`) or `"md"` (default) for Markdown `rst2html`) or `"md"` (default) for Markdown
* **slug** The token to appear in the tail of the URL, * **slug** appears as tail of the url. It can be used to change the part of the url that is based on the filename.
*or*<br> * **url** The full path to the content from the web root. It makes no assumptions about the path of the content file. It also ignores any language prefixes of the multilingual feature.
* **url** The full path to the content from the web root.<br>
*If neither `slug` or `url` is present, the filename will be used.* *If neither `slug` or `url` is present, the filename will be used.*