HUGO
News Docs Themes Community GitHub

fmt.Warnidf

Log a suppressible WARNING from a template.

Syntax

fmt.Warnidf ID FORMAT [INPUT]

Returns

string

Alias

warnidf
New in v0.123.0

The documentation for Go’s fmt package describes the structure and content of the format string.

The warnidf function evaluates the format string, then prints the result to the WARNING log. Unlike the warnf function, you may suppress warnings logged by the warnidf function by adding the message ID to the ignoreLogs array in your site configuration.

This template code:

{{ warnidf "warning-42" "You should consider fixing this." }}

Produces this console log:

WARN You should consider fixing this.
You can suppress this warning by adding the following to your site configuration:
ignoreLogs = ['warning-42']

To suppress this message:

ignoreLogs:
- warning-42
ignoreLogs = ['warning-42']
{
   "ignoreLogs": [
      "warning-42"
   ]
}