From 00c74ee7ffae71fd5f47d555160354a775e26151 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Bj=C3=B8rn=20Erik=20Pedersen?= Date: Thu, 19 Jul 2018 15:03:35 +0200 Subject: [PATCH] docs: Document refLinksErrorLevel and refLinksNotFoundURL See #4964 --- .../en/content-management/cross-references.md | 13 +++++++++++++ docs/content/en/getting-started/configuration.md | 6 ++++++ 2 files changed, 19 insertions(+) diff --git a/docs/content/en/content-management/cross-references.md b/docs/content/en/content-management/cross-references.md index 2980719e..56599e47 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 7b0ca2a0..18f9e702 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. -- 2.30.2