Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/gohugoio/hugo.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>2018-07-19 16:03:35 +0300
committerBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>2018-07-19 16:04:00 +0300
commit00c74ee7ffae71fd5f47d555160354a775e26151 (patch)
treeda4a6a287dcbce8f9f04b5471a9afe90d5902a74 /docs
parente25aa655f4227ac064be5fe770d517a80acd46b2 (diff)
docs: Document refLinksErrorLevel and refLinksNotFoundURL
See #4964
Diffstat (limited to 'docs')
-rw-r--r--docs/content/en/content-management/cross-references.md13
-rw-r--r--docs/content/en/getting-started/configuration.md6
2 files changed, 19 insertions, 0 deletions
diff --git a/docs/content/en/content-management/cross-references.md b/docs/content/en/content-management/cross-references.md
index 2980719e9..56599e47c 100644
--- a/docs/content/en/content-management/cross-references.md
+++ b/docs/content/en/content-management/cross-references.md
@@ -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/
diff --git a/docs/content/en/getting-started/configuration.md b/docs/content/en/getting-started/configuration.md
index 7b0ca2a01..18f9e7025 100644
--- a/docs/content/en/getting-started/configuration.md
+++ b/docs/content/en/getting-started/configuration.md
@@ -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.