Type object
File match hugo.toml hugo.json hugo.yaml
Schema URL https://catalog.lintel.tools/schemas/schemastore/hugo/latest.json
Source https://www.schemastore.org/hugo.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Properties

archetypeDir string
Default: "archetypes"
minLength=1
assetDir string
Default: "assets"
minLength=1
baseURL string

The hostname and the path to the root https://gohugo.io/getting-started/configuration/#baseurl

minLength=1
build object
6 nested properties
_merge string
Values: "none" "shallow" "deep"
useResourceCacheWhen string

The time when to use the cached resources in /resources/_gen for PostCSS and ToCSS https://gohugo.io/getting-started/configuration/#configure-build

Default: "fallback"
Values: "never" "always" "fallback"
writeStats boolean

Enable/disable hugo_stats.json writing to the root project directory. Although still functional, the writeStats key will be deprecated in a future release. https://gohugo.io/getting-started/configuration/#configure-build

Default: false
buildStats object

When enabled, creates a hugo_stats.json file in the root of your project. https://gohugo.io/getting-started/configuration/#configure-build

4 nested properties
enable boolean
Default: false
disableClasses boolean
Default: false
disableIDs boolean
Default: false
disableTags boolean
Default: false
noJSConfigInAssets boolean

Enable/disable jsconfig.json writing into your /assets folder with mapping of imports from running js.Build https://gohugo.io/getting-started/configuration/#configure-build

Default: false
cachebusters object[]

Cache busters to support development using Tailwind 3.x's JIT compiler https://gohugo.io/getting-started/configuration/#configure-cache-busters

buildDrafts boolean
Default: false
buildExpired boolean

Include/exclude the content already expired https://gohugo.io/getting-started/configuration/#buildexpired

Default: false
buildFuture boolean

Include/exclude the content with publishDate in the future https://gohugo.io/getting-started/configuration/#buildfuture

Default: false
cacheDir string

The directory where cached files are stored https://gohugo.io/configuration/all/#cachedir

minLength=1
caches Record<string, object>
Default:
{
  "assets": {
    "dir": ":resourceDir/_gen",
    "maxAge": -1
  },
  "getcsv": {
    "dir": ":cacheDir/:project",
    "maxAge": -1
  },
  "getjson": {
    "dir": ":cacheDir/:project",
    "maxAge": -1
  },
  "getresource": {
    "dir": ":cacheDir/:project",
    "maxAge": -1
  },
  "images": {
    "dir": ":resourceDir/_gen",
    "maxAge": -1
  },
  "modules": {
    "dir": ":cacheDir/modules",
    "maxAge": -1
  }
}
1 nested properties
_merge string
Values: "none" "shallow" "deep"
canonifyURLs boolean

Enable/disable relative URLs to absolute conversion https://gohugo.io/getting-started/configuration/#canonifyurls

Default: false
capitalizeListTitles boolean

Enable/disable the automatic capitalize of list titles https://gohugo.io/configuration/all/#capitalizelisttitles

Default: true
cleanDestinationDir boolean

Enable/disable cleaning of the destination directory https://gohugo.io/configuration/all/#cleandestinationdir

Default: false
contentDir string

The directory where content files are stored https://gohugo.io/getting-started/configuration/#contentdir

Default: "content"
minLength=1
dataDir string

The directory where data files are stored https://gohugo.io/getting-started/configuration/#datadir

Default: "data"
minLength=1
defaultContentLanguage string

The default content language for the content without language indicator https://gohugo.io/getting-started/configuration/#defaultcontentlanguage

Default: "en"
minLength=1
defaultContentLanguageInSubdir boolean

Enable/disable rendering the default content language in subdir https://gohugo.io/getting-started/configuration/#defaultcontentlanguageinsubdir

Default: false
defaultOutputFormat string

The default output format for the site https://gohugo.io/configuration/all/#defaultoutputformat

minLength=1
disableAliases boolean

Enable/disable generation of the alias redirects https://gohugo.io/getting-started/configuration/#disablealiases

Default: false
disableDefaultLanguateRedirect boolean

Enable/disable generation of of the alias redirect to the default language when DefaultContentLanguageInSubdir is true https://gohugo.io/configuration/all/#disabledefaultlanguageredirect

Default: false
disableHugoGeneratorInject boolean

Enable/disable injecting a generator meta tag in the HTML head on the home page only https://gohugo.io/getting-started/configuration/#disablehugogeneratorinject

Default: false
disableKinds string[]
uniqueItems=true
disableLiveReload boolean

Enable/disable automatic live reloading of browser window https://gohugo.io/getting-started/configuration/#disablelivereload

Default: false
disablePathToLower boolean

Enable/disable the url/path to lowercase conversion https://gohugo.io/getting-started/configuration/#disablepathtolower

Default: false
enableEmoji boolean

Enable/disable Emoji emoticons support for page content https://gohugo.io/getting-started/configuration/#enableemoji

Default: false
enableGitInfo boolean

Enable/disable .GitInfo object for each page https://gohugo.io/getting-started/configuration/#enablegitinfo

Default: false
enableInlineShortcodes boolean
Default: false
enableMissingTranslationPlaceholders boolean

Enable/disable placeholder substitution instead of the default value or an empty string if a translation is missing https://gohugo.io/getting-started/configuration/#enablemissingtranslationplaceholders

Default: false
enableRobotsTXT boolean

Enable/disable generation of robots.txt file https://gohugo.io/getting-started/configuration/#enablerobotstxt

Default: false
environment string
Examples: "production", "development"
minLength=1
frontmatter object
Default:
{
  "date": [
    "date",
    "publishdate",
    "lastmod"
  ],
  "expiryDate": [
    "expirydate",
    "expiryDate"
  ],
  "lastmod": [
    ":git",
    "lastmod",
    "date",
    "publishdate"
  ],
  "publishDate": [
    "publishdate",
    "date"
  ]
}
5 nested properties
HTTPCache object
2 nested properties
cache object
1 nested properties
for object
2 nested properties
excludes string | string[]
includes string | string[]
polls object[]
i18nDir string

The designated directory for translation tables https://gohugo.io/configuration/all/#i18ndir

Default: "i18n"
minLength=1
footnoteAnchorPrefix string
Default: ""
footnoteReturnLinkContents string
Default: ""
googleAnalytics string
Default: ""
pattern=(UA-\d{4,9}-\d)|(G-\w+)
hasCJKLanguage boolean

Enable/disable auto-detecting Chinese/Japanese/Korean Languages in the content https://gohugo.io/getting-started/configuration/#hascjklanguage

Default: false
ignoreCache boolean

Enable/disable usage of the cache directory

Default: false
ignoreFiles string[]

Array of regular expression used to exclude files from a build https://gohugo.io/configuration/all/#ignorefiles

ignoreLogs string[]

Array of of message identifiers used to suppress warnings and errors https://gohugo.io/configuration/all/#ignorelogs

ignoreVendorPaths string

A glob pattern matching the module paths to exclude from the _vendor directory https://gohugo.io/configuration/all/#ignorevendorpaths

minLength=1
imaging object
Default:
{
  "resampleFilter": "Box",
  "quality": 75,
  "hint": "photo",
  "anchor": "Smart",
  "bgColor": "#ffffff",
  "exif": {
    "includeFields": "",
    "excludeFields": "",
    "disableDate": false,
    "disableLatLong": false
  }
}
7 nested properties
_merge string
Values: "none" "shallow" "deep"
resampleFilter string
Default: "Box"
Values: "NearestNeighbor" "Box" "Linear" "Hermite" "MitchellNetravali" "CatmullRom" "BSpline" "Gaussian" "Lanczos" "Hann" "Hamming" "Blackman" "Bartlett" "Welch" "Cosine"
quality integer
Default: 75
min=0max=100
hint string
Default: "photo"
Values: "picture" "photo" "drawing" "icon" "text"
anchor string

The anchor used when cropping pictures with either .Fill or .Crop https://gohugo.io/content-management/image-processing/#image-processing-config

Default: "Smart"
Values: "Smart" "TopLeft" "Top" "TopRight" "Left" "Center" "Right" "BottomLeft" "Bottom" "BottomRight"
bgColor string
Default: "#ffffff"
pattern=^#(\d|[ABCDEFabcdef]){6}$
exif object
4 nested properties
includeFields string
Default: ""
excludeFields string
Default: ""
disableDate boolean

Enable/disable extracting the 'photo taken' date/time into .Date https://gohugo.io/content-management/image-processing/#image-processing-config

Default: false
disableLatLong boolean

Enable/disable extracting the 'photo taken where' into .Long and .Lat https://gohugo.io/content-management/image-processing/#image-processing-config

Default: false
languageCode string

The language tag as defined by RFC 5646 https://gohugo.io/getting-started/configuration/#languagecode

Default: ""
languages Record<string, object>
Default:
{}
1 nested properties
_merge string
Values: "none" "shallow" "deep"
layoutDir string

The directory containing layout templates https://gohugo.io/configuration/all/#layoutdir

Default: "layouts"
minLength=1
disableLanguages string[]
uniqueItems=true
mainSections string | string[]
markup object
Default:
{
  "asciidocExt": {
    "attributes": {},
    "backend": "html5",
    "extensions": [],
    "failureLevel": "fatal",
    "noHeaderOrFooter": true,
    "preserveTOC": false,
    "safeMode": "unsafe",
    "sectionNumbers": false,
    "trace": false,
    "verbose": false,
    "workingFolderCurrent": false
  },
  "blackFriday": {
    "angledQuotes": false,
    "extensions": null,
    "extensionsMask": null,
    "footnoteAnchorPrefix": "",
    "footnoteReturnLinkContents": "",
    "fractions": true,
    "hrefTargetBlank": false,
    "latexDashes": true,
    "nofollowLinks": false,
    "noreferrerLinks": false,
    "plainIDAnchors": true,
    "skipHTML": false,
    "smartDashes": true,
    "smartypants": true,
    "smartypantsQuotesNBSP": false,
    "taskLists": true
  },
  "defaultMarkdownHandler": "goldmark",
  "goldmark": {
    "extensions": {
      "definitionList": true,
      "footnote": true,
      "linkify": true,
      "linkifyProtocol": "https",
      "strikethrough": true,
      "table": true,
      "taskList": true,
      "typographer": true,
      "extras": null
    },
    "parser": {
      "attribute": {
        "block": false,
        "title": true
      },
      "autoHeadingID": true,
      "autoHeadingIDType": "github",
      "wrapStandAloneImageWithinParagraph": true
    },
    "renderer": {
      "hardWraps": false,
      "unsafe": false,
      "xhtml": false
    }
  },
  "highlight": {
    "anchorLineNos": false,
    "codeFences": true,
    "guessSyntax": false,
    "hl_Lines": "",
    "lineAnchors": "",
    "lineNoStart": 1,
    "lineNos": false,
    "lineNumbersInTable": true,
    "noClasses": true,
    "noHl": false,
    "style": "monokai",
    "tabWidth": 4
  },
  "tableOfContents": {
    "startLevel": 2,
    "endLevel": 3,
    "ordered": false
  }
}
7 nested properties
_merge string
Values: "none" "shallow" "deep"
asciidocExt object
11 nested properties
attributes Record<string, string>
Default:
{}
backend string
Default: "html5"
Values: "html5" "docbook5" "manpage" "html"
extensions string[]
Default:
[]
uniqueItems=true
failureLevel string
Default: "fatal"
safeMode string
Default: "unsafe"
Values: "unsafe" "safe" "server" "secure"
sectionNumbers boolean
Default: false
trace boolean

Include/exclude the backtrace information on errors https://gohugo.io/getting-started/configuration-markup#configure-markup

Default: false
verbose boolean
Default: false
blackfriday object
16 nested properties
extensions array | null
Default: null
uniqueItems=true
extensionsMask string | null
Default: null
footnoteReturnLinkContents string
Default: ""
smartypantsQuotesNBSP boolean
Default: false
defaultMarkdownHandler string
Default: "goldmark"
Values: "goldmark" "blackfriday"
goldmark object
Default:
{
  "extensions": {
    "definitionList": true,
    "footnote": true,
    "linkify": true,
    "linkifyProtocol": "https",
    "strikethrough": true,
    "table": true,
    "taskList": true,
    "typographer": true
  },
  "parser": {
    "attribute": {
      "block": false,
      "title": true
    },
    "autoHeadingID": true,
    "autoHeadingIDType": "github",
    "wrapStandAloneImageWithinParagraph": true
  },
  "renderer": {
    "hardWraps": false,
    "unsafe": false,
    "xhtml": false
  }
}
5 nested properties
duplicateResourceFiles boolean

Enable/disable duplication of resources per language https://gohugo.io/configuration/markup/#duplicateresourcefiles

Default: false
extensions object
Default:
{
  "definitionList": true,
  "footnote": true,
  "linkify": true,
  "linkifyProtocol": "https",
  "strikethrough": true,
  "table": true,
  "taskList": true,
  "typographer": true
}
11 nested properties
linkifyProtocol string
Default: "https"
extras object
Default:
{
  "delete": {
    "enable": false
  },
  "insert": {
    "enable": false
  },
  "mark": {
    "enable": false
  },
  "subscript": {
    "enable": false
  },
  "superscript": {
    "enable": false
  }
}
parser object
Default:
{
  "attribute": {
    "block": false,
    "title": true
  },
  "autoHeadingID": true,
  "autoHeadingIDType": "github",
  "wrapStandAloneImageWithinParagraph": true
}
6 nested properties
attribute object
Default:
{
  "block": false,
  "title": true
}
autoHeadingIDType string
Default: "github"
autoDefinitionTermID boolean

Enable/disable automatically adding id attributes to description list terms https://gohugo.io/configuration/markup/#parserautodefinitiontermid

autoIDType string

The strategy used to automatically generate id attributes https://gohugo.io/configuration/markup/#parserautoidtype

Default: "github"
Values: "github" "github-ascii" "blackfriday"
wrapStandAloneImageWithinParagraph boolean
Default: true
renderHooks object
2 nested properties
image object
link object
renderer object
Default:
{
  "hardWraps": false,
  "unsafe": false,
  "xhtml": false
}
3 nested properties
highlight object
Default:
{
  "anchorLineNos": false,
  "codeFences": true,
  "guessSyntax": false,
  "hl_Lines": "",
  "lineAnchors": "",
  "lineNoStart": 1,
  "lineNos": false,
  "lineNumbersInTable": true,
  "noClasses": true,
  "noHl": false,
  "style": "monokai",
  "tabWidth": 4
}
14 nested properties
anchorLineNos boolean
Default: false
hl_Lines integer | string
Default: ""
hl_inline boolean

Enable/disable rendering the highlighted code without a wrapping container https://gohugo.io/configuration/markup/#hl_inline

Default: false
lineAnchors string

The prefix for the anchors on line numbers https://gohugo.io/getting-started/configuration-markup#highlight

Default: ""
lineNoStart integer
Default: 1
min=1
lineNos boolean | string
Default: false
lineNumbersInTable boolean
Default: true
style string
Default: "monokai"
Values: "abap" "algol" "algol_nu" "arduino" "autumn" "average" "base16-snazzy" "borland" "bw" "catppuccin-frappe" "catppuccin-latte" "catppuccin-macchiato" "catppuccin-mocha" "colorful" "doom-one" "doom-one2" "dracula" "emacs" "friendly" "fruity" "github-dark" "github" "gruvbox-light" "gruvbox" "hr_high_contrast" "hrdark" "igor" "lovelace" "manni" "modus-operandi" "modus-vivendi" "monokai" "monokailight" "murphy" "native" "nord" "onedark" "onesenterprise" "paraiso-dark" "paraiso-light" "pastie" "perldoc" "pygments" "rainbow_dash" "rose-pine-dawn" "rose-pine-moon" "rose-pine" "rrt" "solarized-dark" "solarized-dark256" "solarized-light" "swapoff" "tango" "trac" "vim" "vs" "vulcan" "witchhazel" "xcode-dark" "xcode"
wrapperClass string

The class or classes to use for the outermost element of the highlighted code https://gohugo.io/configuration/markup/#wrapperclass

Default: "highlight"
tableOfContents object
Default:
{
  "endLevel": 3,
  "ordered": false,
  "startLevel": 2
}
3 nested properties
startLevel integer
Default: 2
endLevel integer
Default: 3
ordered boolean
Default: false
mediaTypes Record<string, object>
37 nested properties
_merge string
Values: "none" "shallow" "deep"
application/json object
1 nested properties
suffixes string[]
Default:
[
  "json"
]
uniqueItems=true
application/manifest+json object
1 nested properties
suffixes string[]
Default:
[
  "webmanifest"
]
uniqueItems=true
application/octet-stream object
1 nested properties
suffixes string[]
Default:
[
  "webmanifest"
]
uniqueItems=true
application/pdf object
1 nested properties
suffixes string[]
Default:
[
  "pdf"
]
uniqueItems=true
application/rss+xml object
1 nested properties
suffixes string[]
Default:
[
  "xml",
  "rss"
]
uniqueItems=true
application/toml object
1 nested properties
suffixes string[]
Default:
[
  "toml"
]
uniqueItems=true
application/wasm object
1 nested properties
suffix string[]
Default: "wasm"
uniqueItems=true
application/xml object
1 nested properties
suffixes string[]
Default:
[
  "xml"
]
uniqueItems=true
application/yaml object
1 nested properties
suffixes string[]
Default:
[
  "yaml",
  "yml"
]
uniqueItems=true
font/otf object
1 nested properties
suffixes string[]
Default:
[
  "otf"
]
uniqueItems=true
font/ttf object
1 nested properties
suffixes string[]
Default:
[
  "ttf"
]
uniqueItems=true
image/bmp object
1 nested properties
suffixes string[]
Default:
[
  "bmp"
]
uniqueItems=true
image/gif object
1 nested properties
suffixes string[]
Default:
[
  "gif"
]
uniqueItems=true
image/jpeg object
1 nested properties
suffixes string[]
Default:
[
  "jpg",
  "jpeg",
  "jpe",
  "jif",
  "jfif"
]
uniqueItems=true
image/png object
1 nested properties
suffixes string[]
Default:
[
  "png"
]
uniqueItems=true
image/svg+xml object
1 nested properties
suffixes string[]
Default:
[
  "svg"
]
uniqueItems=true
image/tiff object
1 nested properties
suffixes string[]
Default:
[
  "tif",
  "tiff"
]
uniqueItems=true
image/webp object
1 nested properties
suffixes string[]
Default:
[
  "webp"
]
uniqueItems=true
text/calendar object
1 nested properties
suffixes string[]
Default:
[
  "ics"
]
uniqueItems=true
text/css object
1 nested properties
suffixes string[]
Default:
[
  "css"
]
uniqueItems=true
text/csv object
1 nested properties
suffixes string[]
Default:
[
  "csv"
]
uniqueItems=true
text/html object
1 nested properties
suffixes string[]
Default:
[
  "html"
]
uniqueItems=true
text/javascript object
1 nested properties
suffixes string[]
Default:
[
  "js",
  "jsm",
  "mjs"
]
uniqueItems=true
text/jsx object
1 nested properties
suffixes string[]
Default:
[
  "jsx"
]
uniqueItems=true
text/markdown object
1 nested properties
suffixes string[]
Default:
[
  "md",
  "markdown"
]
uniqueItems=true
text/plain object
1 nested properties
suffixes string[]
Default:
[
  "txt"
]
uniqueItems=true
text/tsx object
1 nested properties
suffixes string[]
Default:
[
  "tsx"
]
uniqueItems=true
text/typescript object
1 nested properties
suffixes string[]
Default:
[
  "ts"
]
uniqueItems=true
text/x-sass object
1 nested properties
suffixes string[]
Default:
[
  "sass"
]
uniqueItems=true
text/x-scss object
1 nested properties
suffixes string[]
Default:
[
  "scss"
]
uniqueItems=true
video/3gpp object
1 nested properties
suffixes string[]
Default:
[
  "3gpp",
  "3gp"
]
uniqueItems=true
video/mp4 object
1 nested properties
suffixes string[]
Default:
[
  "mp4"
]
uniqueItems=true
video/mpeg object
1 nested properties
suffixes string[]
Default:
[
  "mpg",
  "mpeg"
]
uniqueItems=true
video/ogg object
1 nested properties
suffixes string[]
Default:
[
  "ogv"
]
uniqueItems=true
video/webm object
1 nested properties
suffixes string[]
Default:
[
  "webm"
]
uniqueItems=true
video/x-msvideo object
1 nested properties
suffixes string[]
Default:
[
  "avi"
]
uniqueItems=true
menu Record<string, object[]>
1 nested properties
_merge string
Values: "none" "shallow" "deep"
menus Record<string, object[]>
1 nested properties
_merge string
Values: "none" "shallow" "deep"
minify object
Default:
{
  "disableCSS": false,
  "disableHTML": false,
  "disableJS": false,
  "disableJSON": false,
  "disableSVG": false,
  "disableXML": false,
  "minifyOutput": false,
  "tdewolff": {
    "css": {
      "keepCSS2": true,
      "precision": 0
    },
    "html": {
      "keepComments": false,
      "keepConditionalComments": true,
      "keepDefaultAttrVals": true,
      "keepDocumentTags": true,
      "keepEndTags": true,
      "keepQuotes": false,
      "keepWhitespace": false
    },
    "js": {
      "keepVarNames": false,
      "noNullishOperator": false,
      "precision": 0
    },
    "json": {
      "keepNumbers": false,
      "precision": 0
    },
    "svg": {
      "precision": 0
    },
    "xml": {
      "keepWhitespace": false
    }
  }
}
9 nested properties
_merge string
Values: "none" "shallow" "deep"
tdewolff object
6 nested properties
js object
4 nested properties
keepVarNames boolean

Keeps variable names as they are and omits shortening variable names. https://gohugo.io/getting-started/configuration/#configure-minify

Default: false
precision integer

Number of significant digits to preserve for numbers, 0 means no trimming. https://gohugo.io/getting-started/configuration/#configure-minify

Default: 0
version integer

ECMAScript version to use for output, 0 is the latest. https://gohugo.io/getting-started/configuration/#configure-minify

svg object
2 nested properties
keepComments boolean
module object
Default:
{
  "noProxy": "none",
  "noVendor": "",
  "private": "*.*",
  "proxy": "direct",
  "replacements": "",
  "workspace": ""
}
11 nested properties
_merge string
Values: "none" "shallow" "deep"
noVendor string

The glob pattern matching the paths to skip when vendoring https://gohugo.io/hugo-modules/configuration/#module-configuration-top-level

Default: ""
vendorClosest boolean

Enable/disable picking the vendored module closest to the module using it https://gohugo.io/hugo-modules/configuration/#module-configuration-top-level

Default: "true"
proxy string
Default: "direct"
noProxy string

The glob list of the matching paths that should not use the proxy configured above https://gohugo.io/hugo-modules/configuration/#module-configuration-top-level

Default: "none"
Examples: "*.ext", "*.ext1,*.ext2"
pattern=^[^,]+(,[^,]+)*$
private string

The glob list of the matching paths that should be treated as private https://gohugo.io/hugo-modules/configuration/#module-configuration-top-level

Default: "*.*"
Examples: "*.ext", "*.ext1,*.ext2"
pattern=^[^,]+(,[^,]+)*$
workspace string

The workspace file to use. This enables Go workspace mode. https://gohugo.io/hugo-modules/configuration/#module-configuration-top-level

Default: "off"
Examples: "/my/hugo.work", "./hugo.work"
replacements string

The list of the module path to directory replacement mapping https://gohugo.io/hugo-modules/configuration/#module-configuration-top-level

Default: ""
Examples: "path/to/input_directory -> path/to/output_directory", "path/to/input_directory1 -> path/to/output_directory1,path/to/input_directory2 -> path/to/output_directory2"
pattern=^[^,]+ -> [^,]+(,[^,]+ -> [^,]+)*$
hugoVersion object
3 nested properties
min string
pattern=^\d+\.\d+\.\d+.*$
max string
pattern=^\d+\.\d+\.\d+.*$
extended boolean
mounts object[]
newContentEditor string
Default: ""
noBuildLock boolean

Enable/disable creation of the .hugo_build.lock file https://gohugo.io/configuration/all/#nobuildlock

Default: false
noChmod boolean

Enable/disable syncing permission mode of files https://gohugo.io/getting-started/configuration/#nochmod

Default: false
noTimes boolean

Enable/disable syncing modification time of files https://gohugo.io/getting-started/configuration/#notimes

Default: false
outputFormats Record<string, object>
outputs Record<string, string[]>

Enable/disable output formats per page kind https://gohugo.io/configuration/outputs/

Default:
{
  "home": [
    "html",
    "rss"
  ],
  "page": [
    "html"
  ],
  "rss": [
    "rss"
  ],
  "section": [
    "html",
    "rss"
  ],
  "taxonomy": [
    "html",
    "rss"
  ],
  "term": [
    "html",
    "rss"
  ]
}
1 nested properties
_merge string
Values: "none" "shallow" "deep"
page object

UNDOCUMENTED.

paginate integer

The default number of elements per page in pagination https://gohugo.io/getting-started/configuration/#paginate

Default: 10
paginatePath string

The path element used during pagination https://gohugo.io/getting-started/configuration/#paginatepath

Default: "page"
minLength=1
pagination object
3 nested properties
disableAliases boolean

Enable/disable alias generation for the first pager https://gohugo.io/configuration/pagination/#disablealiases

Default: false
pagerSize integer
Default: 10
path string

The segment of each pager URL indicating that the target page is a pager https://gohugo.io/configuration/pagination/#path

Default: "page"
panicOnWarning boolean

Whether to panic on the first WARNING https://gohugo.io/configuration/all/#paniconwarning

Default: false
params object
pluralizeListTitles boolean
Default: true
printI18nWarnings boolean

Enable/disable the logging WARNINGs for each missing translation https://gohugo.io/configuration/all/#printi18nwarnings

Default: false
printPathWarnings boolean

Enable/disable the logging of WARNINGs when publishing two or more files to the same path https://gohugo.io/configuration/all/#printpathwarnings

Default: false
printUnusedTemplates boolean

Enable/disable the logging WARNINGs for each unused template https://gohugo.io/configuration/all/#printunusedtemplates

Default: false
privacy object

Privacy setting for embedded templates https://gohugo.io/configuration/privacy/

7 nested properties
dispus object

Disqus embedded template privacy settings

1 nested properties
disable boolean
Default: false
googleAnalytics object

Google analytics embedded template privacy settings

2 nested properties
disable boolean
Default: false
respectDoNotTrack boolean
Default: false
instagram object

Instagram embedded template privacy settings

2 nested properties
disable boolean
Default: false
simple boolean
Default: false
twitter object

DEPRECATED. Do not use. Deprecated in v0.141.0. Use the x shortcode instead.

3 nested properties
disable boolean
Default: false
enableDNT boolean
Default: false
simple boolean
Default: false
vimeo object

Vimeo embedded template privacy settings

3 nested properties
disable boolean
Default: false
enableDNT boolean
Default: false
simple boolean
Default: false
x object

X embedded template privacy settings https://gohugo.io/shortcodes/x/#privacy

3 nested properties
disable boolean

Enable/disable the X shortcode https://gohugo.io/shortcodes/x/#disable

Default: false
enableDNT boolean

Whether to prevent X from using post and embedded page data for personalized suggestions and ads https://gohugo.io/shortcodes/x/#enablednt

Default: false
simple boolean

Enable/disable usage of javascript in X shortcode https://gohugo.io/shortcodes/x/#simple

Default: false
youtube object

Toutube embedded template privacy settings

2 nested properties
disable boolean
Default: false
privacyEnhanced boolean
Default: false
publishDir string

The directory where Hugo writes the final static site https://gohugo.io/getting-started/configuration/#publishdir

Default: "public"
minLength=1
relativeURLs boolean

Enable/disable making all relative URLs relative to content root https://gohugo.io/getting-started/configuration/#relativeurls

Default: false
refLinksErrorLevel string

The logging level for page links cannot be resolved https://gohugo.io/getting-started/configuration/#reflinkserrorlevel

Default: "ERROR"
Values: "ERROR" "WARNING"
refLinksNotFoundURL string

The placeholder when a page reference cannot be found in ref or relref https://gohugo.io/getting-started/configuration/#reflinksnotfoundurl

removePathAccents boolean

Remove/leave non-spacing marks from composite characters in content paths https://gohugo.io/getting-started/configuration/#removepathaccents

Default: false
renderSegments string[]
resourceDir string

The designated directory for caching output from asset pipelines https://gohugo.io/configuration/all/#resourcedir

Default: "resources"
minLength=1
rssLimit integer

DEPRECATED. Use 'services.rss.limit' instead https://gohugo.io/getting-started/configuration/#rsslimit

Default: -1
min=-1
security object
Default:
{
  "enableInlineShortcodes": false,
  "exec": {
    "allow": [
      "^dart-sass-embedded$",
      "^go$",
      "^npx$",
      "^postcss$"
    ],
    "osEnv": [
      "(?i)^(PATH|PATHEXT|APPDATA|TMP|TEMP|TERM)$"
    ]
  },
  "funcs": {
    "getenv": [
      "^HUGO_"
    ]
  },
  "http": {
    "methods": [
      "(?i)GET|POST"
    ],
    "urls": [
      ".*"
    ]
  }
}
5 nested properties
_merge string
Values: "none" "shallow" "deep"
enableInlineShortcodes boolean
Default: false
exec object
Default:
{
  "allow": [
    "^dart-sass-embedded$",
    "^go$",
    "^npx$",
    "^postcss$"
  ],
  "osEnv": [
    "(?i)^(PATH|PATHEXT|APPDATA|TMP|TEMP|TERM)$"
  ]
}
2 nested properties
allow string[]
Default:
[
  "^dart-sass-embedded$",
  "^go$",
  "^npx$",
  "^postcss$"
]
uniqueItems=true
osEnv string[]
Default:
[
  "(?i)^(PATH|PATHEXT|APPDATA|TMP|TEMP|TERM)$"
]
uniqueItems=true
funcs object
Default:
{
  "getenv": [
    "^HUGO_"
  ]
}
1 nested properties
getenv string[]
Default:
[
  "^HUGO_"
]
uniqueItems=true
http object
Default:
{
  "methods": [
    "(?i)GET|POST"
  ],
  "urls": [
    ".*"
  ]
}
2 nested properties
methods string[]
Default:
[
  "(?i)GET|POST"
]
uniqueItems=true
urls string[]
Default:
[
  ".*"
]
uniqueItems=true
segments Record<string, object>

Map of named segments. Used to build portions of the site independently https://gohugo.io/configuration/segments/

server object

Configuration for builtin development server https://gohugo.io/configuration/server/

2 nested properties
redirects object[]
headers object[]

Array of headers to add to every response https://gohugo.io/configuration/server/#headers

services object
6 nested properties
disqus object
1 nested properties
googleAnalytics object
1 nested properties
instagram object
2 nested properties
accessToken string

DEPRECATED. Do not use. Deprecated in v0.123.0 https://gohugo.io/configuration/services/#instagramaccesstoken

disableInlineCSS boolean

DEPRECATED. Do not use. Deprecated in v0.123.0 https://gohugo.io/configuration/services/#instagramdisableinlinecss

rss object
1 nested properties
limit integer

The maximum number of items to include in an RSS feed https://gohugo.io/configuration/services/#rsslimit

Default: -1
min=-1
twitter object

DEPRECATED. Do not use. Deprecated in v0.141.0. Use the x shortcode instead

1 nested properties
disableInlineCSS boolean
x object
1 nested properties
disableInlineCSS boolean
Default: false
sitemap object
Default:
{
  "changefreq": "",
  "disable": false,
  "filename": "sitemap.xml",
  "priority": -1
}
5 nested properties
_merge string
Values: "none" "shallow" "deep"
changefreq string
Default: ""
Values: "" "always" "hourly" "daily" "weekly" "monthly" "yearly" "never"
disable boolean
Default: false
filename string
Default: "sitemap.xml"
priority number
Default: -1
One of: const: -1 const: -1, variant
staticDir string

The designated directory for static files https://gohugo.io/configuration/all/#staticdir

Default: "static"
minLength=1
summaryLength integer

The length of text in words to show in a .Summary https://gohugo.io/getting-started/configuration/#summarylength

Default: 70
min=0
taxonomies object
Default:
{
  "category": "categories",
  "tag": "tags"
}
3 nested properties
_merge string
Values: "none" "shallow" "deep"
tag string
Default: "tags"
minLength=1
category string
Default: "categories"
minLength=1
templateMetrics boolean

Enable/disable printing template execution metrics to the console https://gohugo.io/troubleshooting/performance/#template-metrics

Default: false
templateMetricsHints boolean

Enable/disable printing template execution improvement hints to the console https://gohugo.io/troubleshooting/performance/#template-metrics

Default: false
themesDir string

The directory where themes are stored https://gohugo.io/getting-started/configuration/#themesdir

Default: "themes"
minLength=1
timeout string

The timeout for generating page contents https://gohugo.io/getting-started/configuration/#timeout

Default: "30s"
pattern=^\d+s$
timeZone string
Values: "Africa/Abidjan" "Africa/Accra" "Africa/Addis_Ababa" "Africa/Algiers" "Africa/Asmara" "Africa/Asmera" "Africa/Bamako" "Africa/Bangui" "Africa/Banjul" "Africa/Bissau" "Africa/Blantyre" "Africa/Brazzaville" "Africa/Bujumbura" "Africa/Cairo" "Africa/Casablanca" "Africa/Ceuta" "Africa/Conakry" "Africa/Dakar" "Africa/Dar_es_Salaam" "Africa/Djibouti" "Africa/Douala" "Africa/El_Aaiun" "Africa/Freetown" "Africa/Gaborone" "Africa/Harare" "Africa/Johannesburg" "Africa/Juba" "Africa/Kampala" "Africa/Khartoum" "Africa/Kigali" "Africa/Kinshasa" "Africa/Lagos" "Africa/Libreville" "Africa/Lome" "Africa/Luanda" "Africa/Lubumbashi" "Africa/Lusaka" "Africa/Malabo" "Africa/Maputo" "Africa/Maseru" "Africa/Mbabane" "Africa/Mogadishu" "Africa/Monrovia" "Africa/Nairobi" "Africa/Ndjamena" "Africa/Niamey" "Africa/Nouakchott" "Africa/Ouagadougou" "Africa/Porto-Novo" "Africa/Sao_Tome" "Africa/Timbuktu" "Africa/Tripoli" "Africa/Tunis" "Africa/Windhoek" "America/Adak" "America/Anchorage" "America/Anguilla" "America/Antigua" "America/Araguaina" "America/Argentina/Buenos_Aires" "America/Argentina/Catamarca" "America/Argentina/ComodRivadavia" "America/Argentina/Cordoba" "America/Argentina/Jujuy" "America/Argentina/La_Rioja" "America/Argentina/Mendoza" "America/Argentina/Rio_Gallegos" "America/Argentina/Salta" "America/Argentina/San_Juan" "America/Argentina/San_Luis" "America/Argentina/Tucuman" "America/Argentina/Ushuaia" "America/Aruba" "America/Asuncion" "America/Atikokan" "America/Atka" "America/Bahia" "America/Bahia_Banderas" "America/Barbados" "America/Belem" "America/Belize" "America/Blanc-Sablon" "America/Boa_Vista" "America/Bogota" "America/Boise" "America/Buenos_Aires" "America/Cambridge_Bay" "America/Campo_Grande" "America/Cancun" "America/Caracas" "America/Catamarca" "America/Cayenne" "America/Cayman" "America/Chicago" "America/Chihuahua" "America/Coral_Harbour" "America/Cordoba" "America/Costa_Rica" "America/Creston" "America/Cuiaba" "America/Curacao" "America/Danmarkshavn" "America/Dawson" "America/Dawson_Creek" "America/Denver" "America/Detroit" "America/Dominica" "America/Edmonton" "America/Eirunepe" "America/El_Salvador" "America/Ensenada" "America/Fort_Nelson" "America/Fort_Wayne" "America/Fortaleza" "America/Glace_Bay" "America/Godthab" "America/Goose_Bay" "America/Grand_Turk" "America/Grenada" "America/Guadeloupe" "America/Guatemala" "America/Guayaquil" "America/Guyana" "America/Halifax" "America/Havana" "America/Hermosillo" "America/Indiana/Indianapolis" "America/Indiana/Knox" "America/Indiana/Marengo" "America/Indiana/Petersburg" "America/Indiana/Tell_City" "America/Indiana/Vevay" "America/Indiana/Vincennes" "America/Indiana/Winamac" "America/Indianapolis" "America/Inuvik" "America/Iqaluit" "America/Jamaica" "America/Jujuy" "America/Juneau" "America/Kentucky/Louisville" "America/Kentucky/Monticello" "America/Knox_IN" "America/Kralendijk" "America/La_Paz" "America/Lima" "America/Los_Angeles" "America/Louisville" "America/Lower_Princes" "America/Maceio" "America/Managua" "America/Manaus" "America/Marigot" "America/Martinique" "America/Matamoros" "America/Mazatlan" "America/Mendoza" "America/Menominee" "America/Merida" "America/Metlakatla" "America/Mexico_City" "America/Miquelon" "America/Moncton" "America/Monterrey" "America/Montevideo" "America/Montreal" "America/Montserrat" "America/Nassau" "America/New_York" "America/Nipigon" "America/Nome" "America/Noronha" "America/North_Dakota/Beulah" "America/North_Dakota/Center" "America/North_Dakota/New_Salem" "America/Nuuk" "America/Ojinaga" "America/Panama" "America/Pangnirtung" "America/Paramaribo" "America/Phoenix" "America/Port-au-Prince" "America/Port_of_Spain" "America/Porto_Acre" "America/Porto_Velho" "America/Puerto_Rico" "America/Punta_Arenas" "America/Rainy_River" "America/Rankin_Inlet" "America/Recife" "America/Regina" "America/Resolute" "America/Rio_Branco" "America/Rosario" "America/Santa_Isabel" "America/Santarem" "America/Santiago" "America/Santo_Domingo" "America/Sao_Paulo" "America/Scoresbysund" "America/Shiprock" "America/Sitka" "America/St_Barthelemy" "America/St_Johns" "America/St_Kitts" "America/St_Lucia" "America/St_Thomas" "America/St_Vincent" "America/Swift_Current" "America/Tegucigalpa" "America/Thule" "America/Thunder_Bay" "America/Tijuana" "America/Toronto" "America/Tortola" "America/Vancouver" "America/Virgin" "America/Whitehorse" "America/Winnipeg" "America/Yakutat" "America/Yellowknife" "Antarctica/Casey" "Antarctica/Davis" "Antarctica/DumontDUrville" "Antarctica/Macquarie" "Antarctica/Mawson" "Antarctica/McMurdo" "Antarctica/Palmer" "Antarctica/Rothera" "Antarctica/South_Pole" "Antarctica/Syowa" "Antarctica/Troll" "Antarctica/Vostok" "Arctic/Longyearbyen" "Asia/Aden" "Asia/Almaty" "Asia/Amman" "Asia/Anadyr" "Asia/Aqtau" "Asia/Aqtobe" "Asia/Ashgabat" "Asia/Ashkhabad" "Asia/Atyrau" "Asia/Baghdad" "Asia/Bahrain" "Asia/Baku" "Asia/Bangkok" "Asia/Barnaul" "Asia/Beirut" "Asia/Bishkek" "Asia/Brunei" "Asia/Calcutta" "Asia/Chita" "Asia/Choibalsan" "Asia/Chongqing" "Asia/Chungking" "Asia/Colombo" "Asia/Dacca" "Asia/Damascus" "Asia/Dhaka" "Asia/Dili" "Asia/Dubai" "Asia/Dushanbe" "Asia/Famagusta" "Asia/Gaza" "Asia/Harbin" "Asia/Hebron" "Asia/Ho_Chi_Minh" "Asia/Hong_Kong" "Asia/Hovd" "Asia/Irkutsk" "Asia/Istanbul" "Asia/Jakarta" "Asia/Jayapura" "Asia/Jerusalem" "Asia/Kabul" "Asia/Kamchatka" "Asia/Karachi" "Asia/Kashgar" "Asia/Kathmandu" "Asia/Katmandu" "Asia/Khandyga" "Asia/Kolkata" "Asia/Krasnoyarsk" "Asia/Kuala_Lumpur" "Asia/Kuching" "Asia/Kuwait" "Asia/Macao" "Asia/Macau" "Asia/Magadan" "Asia/Makassar" "Asia/Manila" "Asia/Muscat" "Asia/Nicosia" "Asia/Novokuznetsk" "Asia/Novosibirsk" "Asia/Omsk" "Asia/Oral" "Asia/Phnom_Penh" "Asia/Pontianak" "Asia/Pyongyang" "Asia/Qatar" "Asia/Qostanay" "Asia/Qyzylorda" "Asia/Rangoon" "Asia/Riyadh" "Asia/Saigon" "Asia/Sakhalin" "Asia/Samarkand" "Asia/Seoul" "Asia/Shanghai" "Asia/Singapore" "Asia/Srednekolymsk" "Asia/Taipei" "Asia/Tashkent" "Asia/Tbilisi" "Asia/Tehran" "Asia/Tel_Aviv" "Asia/Thimbu" "Asia/Thimphu" "Asia/Tokyo" "Asia/Tomsk" "Asia/Ujung_Pandang" "Asia/Ulaanbaatar" "Asia/Ulan_Bator" "Asia/Urumqi" "Asia/Ust-Nera" "Asia/Vientiane" "Asia/Vladivostok" "Asia/Yakutsk" "Asia/Yangon" "Asia/Yekaterinburg" "Asia/Yerevan" "Atlantic/Azores" "Atlantic/Bermuda" "Atlantic/Canary" "Atlantic/Cape_Verde" "Atlantic/Faeroe" "Atlantic/Faroe" "Atlantic/Jan_Mayen" "Atlantic/Madeira" "Atlantic/Reykjavik" "Atlantic/South_Georgia" "Atlantic/St_Helena" "Atlantic/Stanley" "Australia/ACT" "Australia/Adelaide" "Australia/Brisbane" "Australia/Broken_Hill" "Australia/Canberra" "Australia/Currie" "Australia/Darwin" "Australia/Eucla" "Australia/Hobart" "Australia/LHI" "Australia/Lindeman" "Australia/Lord_Howe" "Australia/Melbourne" "Australia/North" "Australia/NSW" "Australia/Perth" "Australia/Queensland" "Australia/South" "Australia/Sydney" "Australia/Tasmania" "Australia/Victoria" "Australia/West" "Australia/Yancowinna" "Brazil/Acre" "Brazil/DeNoronha" "Brazil/East" "Brazil/West" "Canada/Atlantic" "Canada/Central" "Canada/Eastern" "Canada/Mountain" "Canada/Newfoundland" "Canada/Pacific" "Canada/Saskatchewan" "Canada/Yukon" "Chile/Continental" "Chile/EasterIsland" "Cuba" "Egypt" "Eire" "Etc/GMT" "Etc/GMT+0" "Etc/GMT+1" "Etc/GMT+10" "Etc/GMT+11" "Etc/GMT+12" "Etc/GMT+2" "Etc/GMT+3" "Etc/GMT+4" "Etc/GMT+5" "Etc/GMT+6" "Etc/GMT+7" "Etc/GMT+8" "Etc/GMT+9" "Etc/GMT-0" "Etc/GMT-1" "Etc/GMT-10" "Etc/GMT-11" "Etc/GMT-12" "Etc/GMT-13" "Etc/GMT-14" "Etc/GMT-2" "Etc/GMT-3" "Etc/GMT-4" "Etc/GMT-5" "Etc/GMT-6" "Etc/GMT-7" "Etc/GMT-8" "Etc/GMT-9" "Etc/GMT0" "Etc/Greenwich" "Etc/UCT" "Etc/Universal" "Etc/UTC" "Etc/Zulu" "Europe/Amsterdam" "Europe/Andorra" "Europe/Astrakhan" "Europe/Athens" "Europe/Belfast" "Europe/Belgrade" "Europe/Berlin" "Europe/Bratislava" "Europe/Brussels" "Europe/Bucharest" "Europe/Budapest" "Europe/Busingen" "Europe/Chisinau" "Europe/Copenhagen" "Europe/Dublin" "Europe/Gibraltar" "Europe/Guernsey" "Europe/Helsinki" "Europe/Isle_of_Man" "Europe/Istanbul" "Europe/Jersey" "Europe/Kaliningrad" "Europe/Kiev" "Europe/Kirov" "Europe/Lisbon" "Europe/Ljubljana" "Europe/London" "Europe/Luxembourg" "Europe/Madrid" "Europe/Malta" "Europe/Mariehamn" "Europe/Minsk" "Europe/Monaco" "Europe/Moscow" "Europe/Nicosia" "Europe/Oslo" "Europe/Paris" "Europe/Podgorica" "Europe/Prague" "Europe/Riga" "Europe/Rome" "Europe/Samara" "Europe/San_Marino" "Europe/Sarajevo" "Europe/Saratov" "Europe/Simferopol" "Europe/Skopje" "Europe/Sofia" "Europe/Stockholm" "Europe/Tallinn" "Europe/Tirane" "Europe/Tiraspol" "Europe/Ulyanovsk" "Europe/Uzhgorod" "Europe/Vaduz" "Europe/Vatican" "Europe/Vienna" "Europe/Vilnius" "Europe/Volgograd" "Europe/Warsaw" "Europe/Zagreb" "Europe/Zaporozhye" "Europe/Zurich" "GB" "GB-Eire" "Hongkong" "Iceland" "Indian/Antananarivo" "Indian/Chagos" "Indian/Christmas" "Indian/Cocos" "Indian/Comoro" "Indian/Kerguelen" "Indian/Mahe" "Indian/Maldives" "Indian/Mauritius" "Indian/Mayotte" "Indian/Reunion" "Iran" "Israel" "Jamaica" "Japan" "Kwajalein" "Libya" "Mexico/BajaNorte" "Mexico/BajaSur" "Mexico/General" "Navajo" "NZ" "NZ-CHAT" "Pacific/Apia" "Pacific/Auckland" "Pacific/Bougainville" "Pacific/Chatham" "Pacific/Chuuk" "Pacific/Easter" "Pacific/Efate" "Pacific/Enderbury" "Pacific/Fakaofo" "Pacific/Fiji" "Pacific/Funafuti" "Pacific/Galapagos" "Pacific/Gambier" "Pacific/Guadalcanal" "Pacific/Guam" "Pacific/Honolulu" "Pacific/Johnston" "Pacific/Kanton" "Pacific/Kiritimati" "Pacific/Kosrae" "Pacific/Kwajalein" "Pacific/Majuro" "Pacific/Marquesas" "Pacific/Midway" "Pacific/Nauru" "Pacific/Niue" "Pacific/Norfolk" "Pacific/Noumea" "Pacific/Pago_Pago" "Pacific/Palau" "Pacific/Pitcairn" "Pacific/Pohnpei" "Pacific/Ponape" "Pacific/Port_Moresby" "Pacific/Rarotonga" "Pacific/Saipan" "Pacific/Samoa" "Pacific/Tahiti" "Pacific/Tarawa" "Pacific/Tongatapu" "Pacific/Truk" "Pacific/Wake" "Pacific/Wallis" "Pacific/Yap" "Poland" "Portugal" "PRC" "ROC" "Singapore" "US/Alaska" "US/Aleutian" "US/Arizona" "US/Central" "US/East-Indiana" "US/Eastern" "US/Hawaii" "US/Indiana-Starke" "US/Michigan" "US/Mountain" "US/Pacific" "US/Samoa"
titleCaseStyle string
Default: "ap"
Values: "ap" "chicago" "go" "firstupper" "none"
uglyURLs boolean

Enable/disable adding file extensions to urls https://gohugo.io/getting-started/configuration/#uglyurls

watch boolean

Enable/disable watching filesystem for changes and recreating as needed https://gohugo.io/getting-started/configuration/#watch

Default: false

Definitions

uniqueStringArray string[]
outputFormats Record<string, object>
cascade object
aliases string[]
uniqueItems=true
audio string[]
uniqueItems=true
draft boolean

Specify that the content is (not) the draft https://gohugo.io/content-management/front-matter#predefined

expiryDate string
minLength=1
headless boolean

Specify that the content is (not) the headless bundle https://gohugo.io/content-management/front-matter#predefined

images string[]
uniqueItems=true
isCJKLanguage boolean

Specify that the page language is (not) the CJK language https://gohugo.io/content-management/front-matter#predefined

keywords string[]
uniqueItems=true
lastmod string
minLength=1
linkTitle string
minLength=1
modified string
minLength=1
outputs Record<string, object>
params object
pubdate string
minLength=1
publishDate string
minLength=1
published string
minLength=1
resources object
3 nested properties
name string
Examples: ":counter"
minLength=1
title string
Examples: ":counter"
minLength=1
sitemap object
3 nested properties
changefreq string
Values: "" "always" "hourly" "daily" "weekly" "monthly" "yearly" "never"
priority number
One of: const: -1 const: -1, variant
series string[]
uniqueItems=true
summary string
minLength=1
target object
4 nested properties
environment string
Examples: "development", "staging", "production"
minLength=1
path string

The glob pattern matching the content path below /content https://gohugo.io/content-management/front-matter#front-matter-cascade

minLength=1
kind string
minLength=1
lang string

The glob pattern matching the page's language https://gohugo.io/content-management/front-matter#front-matter-cascade

minLength=1
translationKey string
minLength=1
unpublishdate string
minLength=1
videos string[]
uniqueItems=true
hugoVersion string
mounts object[]
permalinkDefinition string

A permalink

Examples:
  • ":year"
  • ":month"
  • ":monthname"
  • ":day"
  • ":weekday"
  • ":weekdayname"
  • ":yearday"
  • ":section"
  • ":sections"
  • ":title"
  • ":slug"
  • ":filename"
permalinkConfiguration permalinkDefinition | object
duration string | integer

Length of time expressed in seconds (s), minutes (m), and hours (h)

stringOrStringArray string | string[]
segmentIncludesExcludes object
kind string

A glob pattern matching the page kind https://gohugo.io/configuration/segments/#kind

Examples: "taxonomy", "term"
lang string

A glob pattern matching the page language https://gohugo.io/configuration/segments/#lang

Examples: "en", "de"
output string

A glob pattern matching the page output format https://gohugo.io/configuration/segments/#output

Examples: "html", "json"
path string

A glob pattern matching the page’s logical path https://gohugo.io/configuration/segments/#path

Examples: "/books", "books/**"