docs: Document refLinksErrorLevel and refLinksNotFoundURL
authorBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>
Thu, 19 Jul 2018 13:03:35 +0000 (15:03 +0200)
committerBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>
Thu, 19 Jul 2018 13:04:00 +0000 (15:04 +0200)
See #4964

docs/content/en/content-management/cross-references.md
docs/content/en/getting-started/configuration.md

index 2980719e9e45ac672094e38f11915df6795bd2a5..56599e47cdc33852465a73e10bcfd4c8d3f318ff 100644 (file)
@@ -123,6 +123,19 @@ Few examples:
 ## Version 1.0 {#version-1-dot-0}
 ```
 
+
+## Ref and RelRef Configuration
+
+The behaviour can, since Hugo 0.45, be configured in `config.toml`:
+
+
+refLinksErrorLevel ("ERROR") 
+: When using `ref` or `relref` to resolve page links and a link cannot resolved, it will be logged with this logg level. Valid values are `ERROR` (default) or `WARNING`. Any `ERROR` will fail the build (`exit -1`).
+
+refLinksNotFoundURL
+: URL to be used as a placeholder when a page reference cannot be found in `ref` or `relref`. Is used as-is.
+
+
 [built-in Hugo shortcodes]: /content-management/shortcodes/#using-the-built-in-shortcodes
 [lists]: /templates/lists/
 [output formats]: /templates/output-formats/
index 7b0ca2a011c75bb5bdaf02f7007a8323abc9727b..18f9e7025dc0981a77dad65f9a799101c506a3b1 100644 (file)
@@ -183,6 +183,12 @@ related
 relativeURLs (false)
 : Enable this to make all relative URLs relative to content root. Note that this does not affect absolute URLs.
 
+refLinksErrorLevel ("ERROR") 
+: When using `ref` or `relref` to resolve page links and a link cannot resolved, it will be logged with this logg level. Valid values are `ERROR` (default) or `WARNING`. Any `ERROR` will fail the build (`exit -1`).
+
+refLinksNotFoundURL
+: URL to be used as a placeholder when a page reference cannot be found in `ref` or `relref`. Is used as-is.
+
 rssLimit (unlimited)
 : Maximum number of items in the RSS feed.