HUGO
Menu
GitHub 90529 stars Mastodon

Glob patterns

Look up glob pattern syntax and matching rules for wildcards, character sets, and delimiters, with examples.

A glob pattern is a pattern used to match sets of values. It is a shorthand for specifying multiple targets at once, making it easier to work with groups of data or configurations. 

The table below details the supported glob pattern syntax and its matching behavior. Each example illustrates a specific match type, the pattern used, and the expected boolean result when evaluated against a test string.

Match typeGlob patternTest stringMatch?
Simple wildcardimages/*.jpgimages/a.jpgtrue
Literal matchimages/a\*.jpgimages/a*.jpgtrue
Single-level wildcardimages/*/a.jpgimages/foo/a.jpgtrue
Single-level wildcardimages/*/a.jpgimages/foo/bar/a.jpgfalse
Multi-level wildcardimages/**/a.jpgimages/foo/bar/a.jpgtrue
Multi-level wildcardimages/**/a.jpgimages/a.jpgfalse
Single characterimage.???image.jpgtrue
Single characterimage.???image.aviffalse
Delimiter exclusion?atf/atfalse
Character listimages/a.[jp]pgimages/a.jpgtrue
Negated listimages/a.[!p]pgimages/a.jpgtrue
Character rangeimages/a-[a-c].jpgimages/a-b.jpgtrue
Character rangeimages/a-[a-c].jpgimages/a-z.jpgfalse
Negated rangeimages/a-[!a-c].jpgimages/a-z.jpgtrue
Pattern alternatesimages/*.{jpg,png}images/logo.pngtrue
No matchimages/*.{jpg,png}images/logo.webpfalse

The matching logic follows these rules:

  • Standard wildcard (*) matches any character except for a delimiter.
  • Super wildcard (**) matches any character including delimiters, but when placed between two delimiters it requires at least one intervening character; it does not match zero directories.
  • Single character (?) matches exactly one character, excluding delimiters.
  • Negation (!) matches any character except those specified in a list or range when used inside brackets.
  • Character ranges ([a-z]) match any single character within the specified range.

The delimiter is a slash (/), except when matching version names, where the delimiter is a dot (.).

Glob slices

A glob slice is a slice of glob patterns used to match values such as file paths. A value matches the slice when it matches any of the glob patterns. To exclude the values that match a glob pattern, begin the pattern with an exclamation mark (!) followed by a space. Place negated patterns before the patterns that they limit.

For example, this mount includes the files in the books directory except those in the books/drafts directory:

[[module.mounts]]
source = 'content'
target = 'content'
files = ['! books/drafts/**', 'books/**']

See also: dimension matcher. 

Dimension matchers

A dimension matcher is a string, or a slice of strings, that selects one or more values of a dimension using glob patterns, negated glob patterns, and comparison operators. Each key of a sites matrix or sites complements is a dimension matcher. 

A dimension matcher also accepts comparisons such as >= v2.0.0. See dimension matchers for details.