Require-Tags

The Require-Tags header determines whether the Tags header must be set on a node.

The Require-Tags header has two valid values:

• true
• false

The default value is false.

When Require-Tags is set to true on a node, then the Tags header must also be set, or the build will fail.

When Require-Tags is set to false (or not set) on a node, then it has no effect.

When to Use the Require-Tags Header

If you want to ensure that every page in a section of your site has at least one tag defined, you can set the Require-Tags header on a parent node, and it will be inherited by all downstream child nodes in that section.

For instance, if you had a node called articles/index, you could add the following header to force all nodes under the articles section to define at least one tag:

+Require-Tags: true

Using the inheritance rules, if you set the header above in articles/index, then the top-level node would not require any tags to be set, but all child nodes (e.g. each article in that section) would be required to define at least one tag.

If you want to avoid setting the Tags header on a child node where Require-Tags is set to true, you can always delete the Require-Tags header locally:

-Require-Tags: *

Tags: headers