Example: including, excluding, and/or ignoring certain labels
1. exclude_labels excludes pages with those labels
exclude_labels contains a list of label names that is used to exclude pages with those labels from being built. For example, setting:
exclude_labels = [ "exclude-me" ]
would prevent any issue with the label named exclude-me from being included in the ribbity site.
2. include_only_labels includes only pages with at least one of those labels
Likewise, include_only_labels contains a list of label names that is used to choose pages to build. For example,
setting:
include_only_labels = [ "include-only-me" ]
means that only pages with the label named include-only-me will be built.
3. ignore_labels provides labels to be ignored for cross-referencing etc.
You may want to ignore various labels from showing up in labels.md and elsewhere; most specifically, if you have only one label in include_only_labels, then that's going to be a pretty meaningless label for cross-referencing (since all pages will have it!)
So,
ignore_labels = [ "include-only-me" ]
will omit any mention of that label on any page.
Categories
This example belongs to the following categories: