{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://catalog.lintel.tools/schemas/schemastore/hugo/latest.json", "title": "Hugo static site generator config file schema", "x-lintel": { "source": "https://www.schemastore.org/hugo.json", "sourceSha256": "1ea36b80430f4106d34e5739ca83044db580b8e180a03e8232b19bfabdb1c352", "fileMatch": [ "hugo.toml", "hugo.json", "hugo.yaml" ], "parsers": [ "json", "toml", "yaml" ] }, "type": "object", "properties": { "archetypeDir": { "description": "The directory to store archetype files\n", "type": "string", "default": "archetypes", "minLength": 1 }, "assetDir": { "description": "The directory to store asset files\n", "type": "string", "default": "assets", "minLength": 1 }, "baseURL": { "description": "The hostname and the path to the root\n", "type": "string", "minLength": 1 }, "build": { "title": "build options", "description": "The build options\n", "type": "object", "properties": { "_merge": { "$ref": "#/$defs/mergeType" }, "useResourceCacheWhen": { "description": "The time when to use the cached resources in `/resources/_gen` for `PostCSS` and `ToCSS`\n", "type": "string", "default": "fallback", "enum": [ "never", "always", "fallback" ] }, "writeStats": { "description": "Enable/disable `hugo_stats.json` writing to the root project directory.\nAlthough still functional, the writeStats key will be deprecated in a future release.\n", "type": "boolean", "default": false, "deprecated": true }, "buildStats": { "title": "build stats", "description": "When enabled, creates a hugo_stats.json file in the root of your project.\n", "type": "object", "properties": { "enable": { "type": "boolean", "default": false }, "disableClasses": { "type": "boolean", "default": false }, "disableIDs": { "type": "boolean", "default": false }, "disableTags": { "type": "boolean", "default": false } } }, "noJSConfigInAssets": { "description": "Enable/disable `jsconfig.json` writing into your `/assets` folder with mapping of imports from running `js.Build`\n", "type": "boolean", "default": false }, "cachebusters": { "title": "Cache busters", "description": "Cache busters to support development using Tailwind 3.x's JIT compiler\n", "type": "array", "items": { "type": "object", "properties": { "source": { "type": "string" }, "target": { "type": "string" } }, "additionalProperties": false } } }, "additionalProperties": false }, "buildDrafts": { "description": "Include/exclude the drafts when building\n", "type": "boolean", "default": false }, "buildExpired": { "description": "Include/exclude the content already expired\n", "type": "boolean", "default": false }, "buildFuture": { "description": "Include/exclude the content with `publishDate` in the future\n", "type": "boolean", "default": false }, "cacheDir": { "description": "The directory where cached files are stored\n", "type": "string", "minLength": 1 }, "caches": { "title": "cache options", "description": "The cache options\n", "type": "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 } }, "properties": { "_merge": { "$ref": "#/$defs/mergeType" } }, "additionalProperties": { "description": "Cache entry", "type": "object", "properties": { "maxAge": { "description": "The duration before the cache entry will be evicted\n", "default": -1, "examples": [ "0", "10s", "10m", "10h" ], "oneOf": [ { "type": "integer", "minimum": -1 }, { "type": "string", "pattern": "^-?\\d+[smh]?$" } ] }, "dir": { "description": "The absolute path to store cache files\n", "type": "string", "examples": [ ":cacheDir", ":project", ":resourceDir", ":resourceDir/_gen", ":cacheDir/:project", ":cacheDir/modules" ], "minLength": 1 } }, "additionalProperties": false } }, "cascade": { "title": "front matter options", "description": "The front matter options\n", "oneOf": [ { "$ref": "#/$defs/cascade", "type": "object" }, { "type": "array", "items": { "$ref": "#/$defs/cascade", "type": "object" } } ] }, "canonifyURLs": { "description": "Enable/disable relative URLs to absolute conversion\n", "type": "boolean", "default": false }, "capitalizeListTitles": { "description": "Enable/disable the automatic capitalize of list titles\n", "type": "boolean", "default": true }, "cleanDestinationDir": { "description": "Enable/disable cleaning of the destination directory\n", "type": "boolean", "default": false }, "contentDir": { "description": "The directory where content files are stored\n", "type": "string", "default": "content", "minLength": 1 }, "copyright": { "description": "The copyright notice for your site\n", "type": "string", "default": "" }, "dataDir": { "description": "The directory where data files are stored\n", "type": "string", "default": "data", "minLength": 1 }, "defaultContentLanguage": { "description": "The default content language for the content without language indicator\n", "type": "string", "default": "en", "minLength": 1 }, "defaultContentLanguageInSubdir": { "description": "Enable/disable rendering the default content language in subdir\n", "type": "boolean", "default": false }, "defaultOutputFormat": { "description": "The default output format for the site\n", "type": "string", "minLength": 1 }, "disableAliases": { "description": "Enable/disable generation of the alias redirects\n", "type": "boolean", "default": false }, "disableDefaultLanguateRedirect": { "description": "Enable/disable generation of of the alias redirect to the default language when DefaultContentLanguageInSubdir is true\n", "type": "boolean", "default": false }, "disableHugoGeneratorInject": { "description": "Enable/disable injecting a generator meta tag in the HTML head on the home page only\n", "type": "boolean", "default": false }, "disableKinds": { "description": "Disabled kinds of pages\n", "type": "array", "uniqueItems": true, "items": { "type": "string", "enum": [ "page", "home", "section", "taxonomy", "term", "rss", "sitemap", "robotstxt", "404" ] } }, "disableLiveReload": { "description": "Enable/disable automatic live reloading of browser window\n", "type": "boolean", "default": false }, "disablePathToLower": { "description": "Enable/disable the url/path to lowercase conversion\n", "type": "boolean", "default": false }, "enableEmoji": { "description": "Enable/disable Emoji emoticons support for page content\n", "type": "boolean", "default": false }, "enableGitInfo": { "description": "Enable/disable .GitInfo object for each page\n", "type": "boolean", "default": false }, "enableInlineShortcodes": { "description": "Enable/disable inline shortcode support\n", "type": "boolean", "default": false }, "enableMissingTranslationPlaceholders": { "description": "Enable/disable placeholder substitution instead of the default value or an empty string if a translation is missing\n", "type": "boolean", "default": false }, "enableRobotsTXT": { "description": "Enable/disable generation of robots.txt file\n", "type": "boolean", "default": false }, "environment": { "description": "The build environment\n", "type": "string", "minLength": 1, "examples": [ "production", "development" ] }, "frontmatter": { "title": "front matter options", "description": "The front matter options\n", "type": "object", "default": { "date": [ "date", "publishdate", "lastmod" ], "expiryDate": [ "expirydate", "expiryDate" ], "lastmod": [ ":git", "lastmod", "date", "publishdate" ], "publishDate": [ "publishdate", "date" ] }, "properties": { "_merge": { "$ref": "#/$defs/mergeType" }, "date": { "description": "\n", "type": "array", "uniqueItems": true, "items": { "type": "string", "enum": [ ":default", ":fileModTime", ":filename", ":git", "date", "lastmod", "modified", "pubdate", "publishDate", "publishdate" ] } }, "expiryDate": { "description": "\n", "type": "array", "uniqueItems": true, "items": { "type": "string", "enum": [ ":default", "expirydate", "expiryDate", "unpublishdate", "unpublishDate" ] } }, "lastmod": { "description": "\n", "type": "array", "uniqueItems": true, "items": { "type": "string", "enum": [ ":default", ":fileModTime", ":filename", ":git", "date", "lastmod", "modified", "pubdate", "publishDate", "publishdate" ] } }, "publishDate": { "description": "\n", "type": "array", "uniqueItems": true, "items": { "type": "string", "enum": [ ":default", ":fileModTime", ":filename", ":git", "date", "lastmod", "modified", "pubdate", "publishDate", "publishdate" ] } } }, "additionalProperties": false }, "HTTPCache": { "$comment": "#TODO a lot", "description": "\n", "type": "object", "properties": { "cache": { "type": "object", "properties": { "for": { "type": "object", "properties": { "excludes": { "$comment": "The documentation is ambiguous, the type is stated to be a string, but all examples are of string arrays. The same issue exists with all HTTPCache includes and excludes", "$ref": "#/$defs/stringOrStringArray", "description": "List of glob patterns to exclude from caching\n" }, "includes": { "$ref": "#/$defs/stringOrStringArray", "description": "A list of glob patterns to cache\n" } } } } }, "polls": { "type": "array", "items": { "type": "object", "properties": { "disable": { "description": "Enable/disable polling for this configuration\n", "type": "boolean" }, "low": { "$ref": "#/$defs/duration", "description": "The minimum polling interval. This is used after a recent change and gradually increases towards polls.high\n" }, "high": { "$ref": "#/$defs/duration", "description": "The maximum polling interval. This is used when the resource is considered stable\n" }, "for": { "type": "object", "properties": { "excludes": { "$ref": "#/$defs/stringOrStringArray", "description": "A list of glob patterns to exclude from polling for this configuration\n" }, "includes": { "$ref": "#/$defs/stringOrStringArray", "description": "A list of glob patterns to include in polling for this configuration\n" } } } } } } } }, "i18nDir": { "description": "The designated directory for translation tables\n", "type": "string", "default": "i18n", "minLength": 1 }, "footnoteAnchorPrefix": { "description": "The prefix for footnote anchors\n", "type": "string", "default": "" }, "footnoteReturnLinkContents": { "description": "The text to display for footnote return links\n", "type": "string", "default": "" }, "googleAnalytics": { "description": "The Google Analytics tracking ID\n", "type": "string", "default": "", "pattern": "(UA-\\d{4,9}-\\d)|(G-\\w+)" }, "hasCJKLanguage": { "description": "Enable/disable auto-detecting Chinese/Japanese/Korean Languages in the content\n", "type": "boolean", "default": false }, "ignoreCache": { "description": "Enable/disable usage of the cache directory", "type": "boolean", "default": false }, "ignoreFiles": { "description": "Array of regular expression used to exclude files from a build\n", "type": "array", "items": { "type": "string", "minLength": 1 } }, "ignoreLogs": { "description": "Array of of message identifiers used to suppress warnings and errors\n", "type": "array", "items": { "type": "string", "minLength": 1 } }, "ignoreVendorPaths": { "description": "A glob pattern matching the module paths to exclude from the _vendor directory\n", "type": "string", "minLength": 1 }, "imaging": { "description": "The image processing options\n", "type": "object", "default": { "resampleFilter": "Box", "quality": 75, "hint": "photo", "anchor": "Smart", "bgColor": "#ffffff", "exif": { "includeFields": "", "excludeFields": "", "disableDate": false, "disableLatLong": false } }, "properties": { "_merge": { "$ref": "#/$defs/mergeType" }, "resampleFilter": { "description": "The default resample filter\n", "type": "string", "default": "Box", "enum": [ "NearestNeighbor", "Box", "Linear", "Hermite", "MitchellNetravali", "CatmullRom", "BSpline", "Gaussian", "Lanczos", "Hann", "Hamming", "Blackman", "Bartlett", "Welch", "Cosine" ] }, "quality": { "description": "The default quality\n", "type": "integer", "default": 75, "minimum": 0, "maximum": 100 }, "hint": { "description": "The default hint about what type of image\n", "type": "string", "default": "photo", "enum": [ "picture", "photo", "drawing", "icon", "text" ] }, "anchor": { "description": "The anchor used when cropping pictures with either .Fill or .Crop\n", "type": "string", "default": "Smart", "enum": [ "Smart", "TopLeft", "Top", "TopRight", "Left", "Center", "Right", "BottomLeft", "Bottom", "BottomRight" ] }, "bgColor": { "description": "The default background color\n", "type": "string", "default": "#ffffff", "pattern": "^#(\\d|[ABCDEFabcdef]){6}$" }, "exif": { "title": "Exif options", "description": "Exif options\n", "type": "object", "properties": { "includeFields": { "description": "The regexp matching the included fields\n", "type": "string", "default": "" }, "excludeFields": { "description": "The regexp matching the excluded fields\n", "type": "string", "default": "" }, "disableDate": { "description": "Enable/disable extracting the 'photo taken' date/time into .Date\n", "type": "boolean", "default": false }, "disableLatLong": { "description": "Enable/disable extracting the 'photo taken where' into .Long and .Lat\n", "type": "boolean", "default": false } }, "additionalProperties": false } }, "additionalProperties": false }, "languageCode": { "description": "The language tag as defined by RFC 5646\n", "type": "string", "default": "" }, "languages": { "title": "language options", "description": "The language options\n", "type": "object", "default": {}, "properties": { "_merge": { "$ref": "#/$defs/mergeType" } }, "additionalProperties": { "description": "The language options", "type": "object", "additionalProperties": true } }, "layoutDir": { "description": "The directory containing layout templates\n", "type": "string", "default": "layouts", "minLength": 1 }, "disableLanguages": { "$ref": "#/$defs/uniqueStringArray", "description": "The disabled languages\n" }, "mainSections": { "$ref": "#/$defs/stringOrStringArray", "description": "The main sections of a site. Used by the MainSections method\n" }, "markup": { "title": "markdown options", "description": "The markdown options\n", "type": "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 } }, "properties": { "_merge": { "$ref": "#/$defs/mergeType" }, "asciidocExt": { "title": "AsciidocExt options", "description": "AsciidocExt options\n", "type": "object", "properties": { "attributes": { "title": "document attributes", "description": "The document attributes\n", "type": "object", "default": {}, "additionalProperties": { "type": "string" } }, "backend": { "description": "The backend output file format\n", "type": "string", "default": "html5", "enum": [ "html5", "docbook5", "manpage", "html" ] }, "extensions": { "description": "\n", "type": "array", "default": [], "uniqueItems": true, "items": { "type": "string", "minLength": 1 } }, "failureLevel": { "description": "The minimum logging level\n", "type": "string", "default": "fatal" }, "noHeaderOrFooter": { "description": "\n", "type": "boolean", "default": true }, "preserveTOC": { "description": "\n", "type": "boolean", "default": false }, "safeMode": { "description": "The safe mode\n", "type": "string", "default": "unsafe", "enum": [ "unsafe", "safe", "server", "secure" ] }, "sectionNumbers": { "description": "Enable/disable section title's auto-numbering\n", "type": "boolean", "default": false }, "trace": { "description": "Include/exclude the backtrace information on errors\n", "type": "boolean", "default": false }, "verbose": { "description": "Enable/disable verbose error printing\n", "type": "boolean", "default": false }, "workingFolderCurrent": { "description": "\n", "type": "boolean", "default": false } }, "additionalProperties": false }, "blackfriday": { "title": "Blackfriday options", "description": "Blackfriday options\n", "type": "object", "properties": { "angledQuotes": { "description": "", "type": "boolean", "default": false }, "extensions": { "description": "", "type": [ "array", "null" ], "default": null, "uniqueItems": true, "items": { "type": "string", "minLength": 1 } }, "extensionsMask": { "description": "", "type": [ "string", "null" ], "default": null }, "footnoteAnchorPrefix": { "description": "", "type": "string", "default": "" }, "footnoteReturnLinkContents": { "description": "", "type": "string", "default": "" }, "fractions": { "description": "", "type": "boolean", "default": true }, "hrefTargetBlank": { "description": "", "type": "boolean", "default": false }, "latexDashes": { "description": "", "type": "boolean", "default": true }, "nofollowLinks": { "description": "", "type": "boolean", "default": false }, "noreferrerLinks": { "description": "", "type": "boolean", "default": false }, "plainIDAnchors": { "description": "", "type": "boolean", "default": true }, "skipHTML": { "description": "", "type": "boolean", "default": false }, "smartDashes": { "description": "", "type": "boolean", "default": true }, "smartypants": { "description": "", "type": "boolean", "default": true }, "smartypantsQuotesNBSP": { "description": "", "type": "boolean", "default": false }, "taskLists": { "description": "", "type": "boolean", "default": true } }, "additionalProperties": false }, "defaultMarkdownHandler": { "description": "The default markdown renderer\n", "type": "string", "default": "goldmark", "enum": [ "goldmark", "blackfriday" ] }, "goldmark": { "title": "Goldmark options", "description": "Goldmark options\n", "type": "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 } }, "properties": { "duplicateResourceFiles": { "description": "Enable/disable duplication of resources per language\n", "type": "boolean", "default": false }, "extensions": { "title": "extension options", "description": "The extension options\n", "type": "object", "default": { "definitionList": true, "footnote": true, "linkify": true, "linkifyProtocol": "https", "strikethrough": true, "table": true, "taskList": true, "typographer": true }, "properties": { "definitionList": { "description": "\n", "type": "boolean", "default": true }, "footnote": { "description": "\n", "type": "boolean", "default": true }, "linkify": { "description": "\n", "type": "boolean", "default": true }, "linkifyProtocol": { "description": "\n", "type": "string", "default": "https" }, "strikethrough": { "description": "\n", "type": "boolean", "default": true }, "table": { "description": "\n", "type": "boolean", "default": true }, "taskList": { "description": "\n", "type": "boolean", "default": true }, "cjk": { "description": "\n", "type": "object", "properties": { "enable": { "type": "boolean", "default": false }, "eastAsianLineBreaks": { "type": "boolean", "default": false }, "eastAsianLineBreaksStyle": { "type": "string", "default": "simple" }, "escapedSpace": { "type": "boolean", "default": false } } }, "passthrough": { "description": "\n", "type": "object", "properties": { "enable": { "type": "boolean", "default": false }, "delimiters": { "type": "object", "properties": { "block": { "description": "Array of pairs of open/closing block delimiters", "type": "array", "items": { "type": "array", "maxItems": 2, "minItems": 2, "items": { "type": "string", "minLength": 1 } } }, "inline": { "description": "Array of pairs of open/closing inline delimiters", "type": "array", "items": { "type": "array", "maxItems": 2, "minItems": 2, "items": { "type": "string", "minLength": 1 } } } } } } }, "typographer": { "description": "\n", "oneOf": [ { "type": "boolean", "default": true }, { "type": "object", "properties": { "disable": { "type": "boolean", "default": false }, "ellipsis": { "type": "string", "default": "…" }, "apostrophe": { "type": "string", "default": "’" }, "enDash": { "type": "string", "default": "–" }, "emDash": { "type": "string", "default": "—" }, "leftAngleQuote": { "type": "string", "default": "«" }, "leftDoubleQuote": { "type": "string", "default": "“" }, "leftSingleQuote": { "type": "string", "default": "‘" }, "rightAngleQuote": { "type": "string", "default": "»" }, "rightDoubleQuote": { "type": "string", "default": "”" }, "rightSingleQuote": { "type": "string", "default": "’" } } } ] }, "extras": { "description": "\n", "type": "object", "default": { "delete": { "enable": false }, "insert": { "enable": false }, "mark": { "enable": false }, "subscript": { "enable": false }, "superscript": { "enable": false } }, "properties": { "delete": { "description": "\n", "type": "object", "default": { "enable": false }, "properties": { "enable": { "description": "\n", "type": "boolean", "default": false } } }, "insert": { "description": "\n", "type": "object", "default": { "enable": false }, "properties": { "enable": { "description": "\n", "type": "boolean", "default": false } } }, "mark": { "description": "\n", "type": "object", "default": { "enable": false }, "properties": { "enable": { "description": "\n", "type": "boolean", "default": false } } }, "subscript": { "description": "\n", "type": "object", "default": { "enable": false }, "properties": { "enable": { "description": "\n", "type": "boolean", "default": false } } }, "superscript": { "description": "\n", "type": "object", "default": { "enable": false }, "properties": { "enable": { "description": "\n", "type": "boolean", "default": false } } } } } }, "additionalProperties": false }, "parser": { "title": "parser options", "description": "The parser options\n", "type": "object", "default": { "attribute": { "block": false, "title": true }, "autoHeadingID": true, "autoHeadingIDType": "github", "wrapStandAloneImageWithinParagraph": true }, "properties": { "attribute": { "description": "\n", "type": "object", "default": { "block": false, "title": true }, "properties": { "block": { "description": "\n", "type": "boolean", "default": false }, "title": { "description": "\n", "type": "boolean", "default": true } }, "additionalProperties": false }, "autoHeadingID": { "description": "\n", "type": "boolean", "default": true }, "autoHeadingIDType": { "description": "DEPRECATED. \n", "type": "string", "default": "github" }, "autoDefinitionTermID": { "description": "Enable/disable automatically adding id attributes to description list terms\n", "type": "boolean" }, "autoIDType": { "description": "The strategy used to automatically generate id attributes\n", "type": "string", "enum": [ "github", "github-ascii", "blackfriday" ], "default": "github" }, "wrapStandAloneImageWithinParagraph": { "description": "\n", "type": "boolean", "default": true } }, "additionalProperties": false }, "renderHooks": { "type": "object", "properties": { "image": { "type": "object", "properties": { "enableDefault": { "description": "DEPRECATED.\n", "type": "boolean" }, "useEmbedded": { "description": "When to use the embedded image render hook\n", "type": "string", "enum": [ "auto", "never", "always", "fallback" ] } } }, "link": { "type": "object", "properties": { "enableDefault": { "description": "DEPRECATED.\n", "type": "boolean" }, "useEmbedded": { "description": "When to use the embedded link render hook\n", "type": "string", "enum": [ "auto", "never", "always", "fallback" ] } } } } }, "renderer": { "title": "renderer options", "description": "The renderer options\n", "type": "object", "default": { "hardWraps": false, "unsafe": false, "xhtml": false }, "properties": { "hardWraps": { "description": "\n", "type": "boolean", "default": false }, "unsafe": { "description": "\n", "type": "boolean", "default": false }, "xhtml": { "description": "\n", "type": "boolean", "default": false } }, "additionalProperties": false } }, "additionalProperties": false }, "highlight": { "title": "highlighting options", "description": "The highlighting options\n", "type": "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 }, "properties": { "anchorLineNos": { "description": "Enable/disable anchors on line numbers\n", "type": "boolean", "default": false }, "codeFences": { "description": "\n", "type": "boolean", "default": true }, "guessSyntax": { "description": "\n", "type": "boolean", "default": false }, "hl_Lines": { "description": "The highlighted line number range\n", "default": "", "oneOf": [ { "type": "integer", "minimum": 1 }, { "type": "string", "pattern": "^\\d+( \\d+(-\\d+)?)*$" } ] }, "hl_inline": { "description": "Enable/disable rendering the highlighted code without a wrapping container\n", "type": "boolean", "default": false }, "lineAnchors": { "description": "The prefix for the anchors on line numbers\n", "type": "string", "default": "" }, "lineNoStart": { "description": "The first line\n", "type": "integer", "default": 1, "minimum": 1 }, "lineNos": { "description": "Enable/disable line numbers\n", "default": false, "oneOf": [ { "type": "boolean" }, { "type": "string", "enum": [ "table", "inline" ] } ] }, "lineNumbersInTable": { "description": "\n", "type": "boolean", "default": true }, "noClasses": { "description": "\n", "type": "boolean", "default": true }, "noHl": { "description": "DEPRECATED. \n", "type": "boolean", "default": false }, "style": { "description": "\n", "type": "string", "default": "monokai", "enum": [ "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" ] }, "tabWidth": { "description": "\n", "type": "integer", "default": 4, "minimum": 1 }, "wrapperClass": { "description": "The class or classes to use for the outermost element of the highlighted code\n", "type": "string", "default": "highlight" } }, "additionalProperties": false }, "tableOfContents": { "title": "table of contents options", "description": "The table of contents options\n", "type": "object", "default": { "endLevel": 3, "ordered": false, "startLevel": 2 }, "properties": { "startLevel": { "description": "The start heading level\n", "type": "integer", "default": 2 }, "endLevel": { "description": "The end heading level\n", "type": "integer", "default": 3 }, "ordered": { "description": "Enable/disable ordered list generation\n", "type": "boolean", "default": false } }, "additionalProperties": false } } }, "mediaTypes": { "title": "media type's options", "description": "The media type's options\n", "type": "object", "properties": { "_merge": { "$ref": "#/$defs/mergeType" }, "application/json": { "description": "\n", "type": "object", "properties": { "suffixes": { "description": "\n", "type": "array", "default": [ "json" ], "uniqueItems": true, "items": { "type": "string", "minLength": 1, "examples": [ "json" ] } } } }, "application/manifest+json": { "description": "\n", "type": "object", "properties": { "suffixes": { "description": "\n", "type": "array", "default": [ "webmanifest" ], "uniqueItems": true, "items": { "type": "string", "minLength": 1, "examples": [ "webmanifest" ] } } } }, "application/octet-stream": { "description": "\n", "type": "object", "properties": { "suffixes": { "description": "\n", "type": "array", "default": [ "webmanifest" ], "uniqueItems": true, "items": { "type": "string", "minLength": 1, "examples": [ "webmanifest" ] } } } }, "application/pdf": { "description": "\n", "type": "object", "properties": { "suffixes": { "description": "\n", "type": "array", "default": [ "pdf" ], "uniqueItems": true, "items": { "type": "string", "minLength": 1, "examples": [ "pdf" ] } } } }, "application/rss+xml": { "description": "\n", "type": "object", "properties": { "suffixes": { "description": "\n", "type": "array", "default": [ "xml", "rss" ], "uniqueItems": true, "items": { "type": "string", "minLength": 1, "examples": [ "xml", "rss" ] } } } }, "application/toml": { "description": "\n", "type": "object", "properties": { "suffixes": { "description": "\n", "type": "array", "default": [ "toml" ], "uniqueItems": true, "items": { "type": "string", "minLength": 1, "examples": [ "toml" ] } } } }, "application/wasm": { "description": "\n", "type": "object", "properties": { "suffix": { "description": "\n", "type": "array", "default": "wasm", "uniqueItems": true, "items": { "type": "string", "minLength": 1, "examples": [ "wasm" ] } } } }, "application/xml": { "description": "\n", "type": "object", "properties": { "suffixes": { "description": "\n", "type": "array", "default": [ "xml" ], "uniqueItems": true, "items": { "type": "string", "minLength": 1, "examples": [ "xml" ] } } } }, "application/yaml": { "description": "\n", "type": "object", "properties": { "suffixes": { "description": "\n", "type": "array", "default": [ "yaml", "yml" ], "uniqueItems": true, "items": { "type": "string", "minLength": 1, "examples": [ "yaml", "yml" ] } } } }, "font/otf": { "description": "\n", "type": "object", "properties": { "suffixes": { "description": "\n", "type": "array", "default": [ "otf" ], "uniqueItems": true, "items": { "type": "string", "minLength": 1, "examples": [ "otf" ] } } } }, "font/ttf": { "description": "\n", "type": "object", "properties": { "suffixes": { "description": "\n", "type": "array", "default": [ "ttf" ], "uniqueItems": true, "items": { "type": "string", "minLength": 1, "examples": [ "ttf" ] } } } }, "image/bmp": { "description": "\n", "type": "object", "properties": { "suffixes": { "description": "\n", "type": "array", "default": [ "bmp" ], "uniqueItems": true, "items": { "type": "string", "minLength": 1, "examples": [ "bmp" ] } } } }, "image/gif": { "description": "\n", "type": "object", "properties": { "suffixes": { "description": "\n", "type": "array", "default": [ "gif" ], "uniqueItems": true, "items": { "type": "string", "minLength": 1, "examples": [ "gif" ] } } } }, "image/jpeg": { "description": "\n", "type": "object", "properties": { "suffixes": { "description": "\n", "type": "array", "default": [ "jpg", "jpeg", "jpe", "jif", "jfif" ], "uniqueItems": true, "items": { "type": "string", "minLength": 1, "examples": [ "jpg", "jpeg", "jpe", "jif", "jfif" ] } } } }, "image/png": { "description": "\n", "type": "object", "properties": { "suffixes": { "description": "\n", "type": "array", "default": [ "png" ], "uniqueItems": true, "items": { "type": "string", "minLength": 1, "examples": [ "png" ] } } } }, "image/svg+xml": { "description": "\n", "type": "object", "properties": { "suffixes": { "description": "\n", "type": "array", "default": [ "svg" ], "uniqueItems": true, "items": { "type": "string", "minLength": 1, "examples": [ "svg" ] } } } }, "image/tiff": { "description": "\n", "type": "object", "properties": { "suffixes": { "description": "\n", "type": "array", "default": [ "tif", "tiff" ], "uniqueItems": true, "items": { "type": "string", "minLength": 1, "examples": [ "tif", "tiff" ] } } } }, "image/webp": { "description": "\n", "type": "object", "properties": { "suffixes": { "description": "\n", "type": "array", "default": [ "webp" ], "uniqueItems": true, "items": { "type": "string", "minLength": 1, "examples": [ "webp" ] } } } }, "text/calendar": { "description": "\n", "type": "object", "properties": { "suffixes": { "description": "\n", "type": "array", "default": [ "ics" ], "uniqueItems": true, "items": { "type": "string", "minLength": 1, "examples": [ "ics" ] } } } }, "text/css": { "description": "\n", "type": "object", "properties": { "suffixes": { "description": "\n", "type": "array", "default": [ "css" ], "uniqueItems": true, "items": { "type": "string", "minLength": 1, "examples": [ "css" ] } } } }, "text/csv": { "description": "\n", "type": "object", "properties": { "suffixes": { "description": "\n", "type": "array", "default": [ "csv" ], "uniqueItems": true, "items": { "type": "string", "minLength": 1, "examples": [ "csv" ] } } } }, "text/html": { "description": "\n", "type": "object", "properties": { "suffixes": { "description": "\n", "type": "array", "default": [ "html" ], "uniqueItems": true, "items": { "type": "string", "minLength": 1, "examples": [ "html" ] } } } }, "text/javascript": { "description": "\n", "type": "object", "properties": { "suffixes": { "description": "\n", "type": "array", "default": [ "js", "jsm", "mjs" ], "uniqueItems": true, "items": { "type": "string", "minLength": 1, "examples": [ "js", "jsm", "mjs" ] } } } }, "text/jsx": { "description": "\n", "type": "object", "properties": { "suffixes": { "description": "\n", "type": "array", "default": [ "jsx" ], "uniqueItems": true, "items": { "type": "string", "minLength": 1, "examples": [ "jsx" ] } } } }, "text/markdown": { "description": "\n", "type": "object", "properties": { "suffixes": { "description": "\n", "type": "array", "default": [ "md", "markdown" ], "uniqueItems": true, "items": { "type": "string", "minLength": 1, "examples": [ "md" ] } } } }, "text/plain": { "description": "\n", "type": "object", "properties": { "suffixes": { "description": "\n", "type": "array", "default": [ "txt" ], "uniqueItems": true, "items": { "type": "string", "minLength": 1, "examples": [ "txt" ] } } } }, "text/tsx": { "description": "\n", "type": "object", "properties": { "suffixes": { "description": "\n", "type": "array", "default": [ "tsx" ], "uniqueItems": true, "items": { "type": "string", "minLength": 1, "examples": [ "tsx" ] } } } }, "text/typescript": { "description": "\n", "type": "object", "properties": { "suffixes": { "description": "\n", "type": "array", "default": [ "ts" ], "uniqueItems": true, "items": { "type": "string", "minLength": 1, "examples": [ "ts" ] } } } }, "text/x-sass": { "description": "\n", "type": "object", "properties": { "suffixes": { "description": "\n", "type": "array", "default": [ "sass" ], "uniqueItems": true, "items": { "type": "string", "minLength": 1, "examples": [ "sass" ] } } } }, "text/x-scss": { "description": "\n", "type": "object", "properties": { "suffixes": { "description": "\n", "type": "array", "default": [ "scss" ], "uniqueItems": true, "items": { "type": "string", "minLength": 1, "examples": [ "scss" ] } } } }, "video/3gpp": { "description": "\n", "type": "object", "properties": { "suffixes": { "description": "\n", "type": "array", "default": [ "3gpp", "3gp" ], "uniqueItems": true, "items": { "type": "string", "minLength": 1, "examples": [ "3gpp", "3gp" ] } } } }, "video/mp4": { "description": "\n", "type": "object", "properties": { "suffixes": { "description": "\n", "type": "array", "default": [ "mp4" ], "uniqueItems": true, "items": { "type": "string", "minLength": 1, "examples": [ "mp4" ] } } } }, "video/mpeg": { "description": "\n", "type": "object", "properties": { "suffixes": { "description": "\n", "type": "array", "default": [ "mpg", "mpeg" ], "uniqueItems": true, "items": { "type": "string", "minLength": 1, "examples": [ "mpg", "mpeg" ] } } } }, "video/ogg": { "description": "\n", "type": "object", "properties": { "suffixes": { "description": "\n", "type": "array", "default": [ "ogv" ], "uniqueItems": true, "items": { "type": "string", "minLength": 1, "examples": [ "ogv" ] } } } }, "video/webm": { "description": "\n", "type": "object", "properties": { "suffixes": { "description": "\n", "type": "array", "default": [ "webm" ], "uniqueItems": true, "items": { "type": "string", "minLength": 1, "examples": [ "webm" ] } } } }, "video/x-msvideo": { "description": "\n", "type": "object", "properties": { "suffixes": { "description": "\n", "type": "array", "default": [ "avi" ], "uniqueItems": true, "items": { "type": "string", "minLength": 1, "examples": [ "avi" ] } } } } }, "additionalProperties": { "description": "\n", "type": "object", "properties": { "delimiter": { "description": "\n", "type": "string", "default": "." }, "suffixes": { "description": "\n", "type": "array", "items": { "type": "string" } } } } }, "menu": { "$comment": "Old name of menus. Exists for legacy reasons", "$ref": "#/properties/menus", "description": "DEPRECATED. Removed in latest versions use 'menus' instead" }, "menus": { "title": "media menu options", "description": "The menu options\n", "type": "object", "properties": { "_merge": { "$ref": "#/$defs/mergeType" } }, "additionalProperties": { "description": "The menu\n", "type": "array", "items": { "type": "object", "properties": { "identifier": { "description": "Required when two or more menu entries have the same name\n", "type": "string", "minLength": 1 }, "name": { "description": "The text to display when rendering the menu entry.\n", "type": "string", "minLength": 1 }, "parent": { "description": "Required for child entries in a nested menu.\n", "type": "string" }, "post": { "description": "\n", "type": "string" }, "pre": { "description": "\n", "type": "string" }, "title": { "description": "\n", "type": "string" }, "weight": { "description": "A non-zero integer indicating the entry's position relative the root of the menu, or to its parent for a child entry\n", "type": "integer" }, "pageRef": { "description": "Required for internal links.\n", "type": "string" }, "url": { "description": "Required for external links.\n", "type": "string" }, "params": { "description": "User-defined properties for the menu entry.\n", "type": "object" } }, "additionalProperties": false } } }, "minify": { "description": "\n", "type": "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 } } }, "properties": { "_merge": { "$ref": "#/$defs/mergeType" }, "disableCSS": { "description": "\n", "type": "boolean", "default": false }, "disableHTML": { "description": "\n", "type": "boolean", "default": false }, "disableJS": { "description": "\n", "type": "boolean", "default": false }, "disableJSON": { "description": "\n", "type": "boolean", "default": false }, "disableSVG": { "description": "\n", "type": "boolean", "default": false }, "disableXML": { "description": "\n", "type": "boolean", "default": false }, "minifyOutput": { "description": "\n", "type": "boolean", "default": false }, "tdewolff": { "description": "\n", "type": "object", "properties": { "css": { "description": "\n", "type": "object", "properties": { "keepCSS2": { "description": "\n", "type": "boolean", "default": true }, "precision": { "description": "\n", "type": "integer", "default": 0 } }, "additionalProperties": false }, "html": { "description": "\n", "type": "object", "properties": { "keepComments": { "description": "\n", "type": "boolean", "default": false }, "keepConditionalComments": { "description": "\n", "type": "boolean", "default": true }, "keepDefaultAttrVals": { "description": "\n", "type": "boolean", "default": true }, "keepDocumentTags": { "description": "\n", "type": "boolean", "default": true }, "keepEndTags": { "description": "\n", "type": "boolean", "default": true }, "keepQuotes": { "description": "\n", "type": "boolean", "default": false }, "keepWhitespace": { "description": "\n", "type": "boolean", "default": false } }, "additionalProperties": false }, "js": { "description": "\n", "type": "object", "properties": { "keepVarNames": { "description": "Keeps variable names as they are and omits shortening variable names.\n", "type": "boolean", "default": false }, "noNullishOperator": { "description": "\n", "type": "boolean", "default": false }, "precision": { "description": "Number of significant digits to preserve for numbers, 0 means no trimming.\n", "type": "integer", "default": 0 }, "version": { "description": "ECMAScript version to use for output, 0 is the latest.\n", "type": "integer" } }, "additionalProperties": false }, "json": { "description": "\n", "type": "object", "properties": { "keepNumbers": { "description": "\n", "type": "boolean", "default": false }, "precision": { "description": "\n", "type": "integer", "default": 0 } }, "additionalProperties": false }, "svg": { "description": "\n", "type": "object", "properties": { "precision": { "description": "\n", "type": "integer", "default": 0, "minimum": 0 }, "keepComments": { "type": "boolean" } }, "additionalProperties": false }, "xml": { "description": "\n", "type": "object", "properties": { "keepWhitespace": { "description": "\n", "type": "boolean", "default": false } }, "additionalProperties": false } }, "additionalProperties": false } }, "additionalProperties": false }, "module": { "description": "The module options\n", "type": "object", "default": { "noProxy": "none", "noVendor": "", "private": "*.*", "proxy": "direct", "replacements": "", "workspace": "" }, "properties": { "_merge": { "$ref": "#/$defs/mergeType" }, "noVendor": { "description": "The glob pattern matching the paths to skip when vendoring\n", "type": "string", "default": "" }, "vendorClosest": { "description": "Enable/disable picking the vendored module closest to the module using it\n", "type": "boolean", "default": "true" }, "proxy": { "description": "The proxy server to download the remote modules\n", "type": "string", "default": "direct" }, "noProxy": { "description": "The glob list of the matching paths that should not use the proxy configured above\n", "type": "string", "default": "none", "examples": [ "*.ext", "*.ext1,*.ext2" ], "pattern": "^[^,]+(,[^,]+)*$" }, "private": { "description": "The glob list of the matching paths that should be treated as private\n", "type": "string", "default": "*.*", "examples": [ "*.ext", "*.ext1,*.ext2" ], "pattern": "^[^,]+(,[^,]+)*$" }, "workspace": { "description": "The workspace file to use. This enables Go workspace mode.\n", "type": "string", "default": "off", "examples": [ "/my/hugo.work", "./hugo.work" ] }, "replacements": { "description": "The list of the module path to directory replacement mapping\n", "type": "string", "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": { "title": "version", "description": "The version\n", "type": "object", "properties": { "min": { "$ref": "#/$defs/hugoVersion", "description": "The minimum required version\n" }, "max": { "$ref": "#/$defs/hugoVersion", "description": "The maximum required version\n" }, "extended": { "description": "Enable/disable requiring the extended version\n", "type": "boolean" } }, "additionalProperties": false }, "imports": { "title": "import options", "description": "The import options\n", "type": "array", "items": { "type": "object", "required": [ "path" ], "properties": { "path": { "description": "The path\n", "type": "string", "minLength": 1 }, "ignoreConfig": { "description": "Use/ignore the configuration file\n", "type": "boolean" }, "ignoreImports": { "description": "Use/ignore the imports\n", "type": "boolean" }, "disable": { "description": "Enable/disable the module\n", "type": "boolean" }, "noMounts": { "description": "Enable/disable the folder mounting\n", "type": "boolean" }, "noVendor": { "description": "Enable/disable vendoring this import\n", "type": "boolean" }, "version": { "description": "Set import version\n", "type": "string" }, "mounts": { "$ref": "#/$defs/mounts", "title": "mount options", "description": "The mount options\n" } }, "additionalProperties": false } }, "mounts": { "$ref": "#/$defs/mounts", "title": "mount options", "description": "The mount options\n" } }, "additionalProperties": false }, "newContentEditor": { "description": "The content editor\n", "type": "string", "default": "" }, "noBuildLock": { "description": "Enable/disable creation of the .hugo_build.lock file\n", "type": "boolean", "default": false }, "noChmod": { "description": "Enable/disable syncing permission mode of files\n", "type": "boolean", "default": false }, "noTimes": { "description": "Enable/disable syncing modification time of files\n", "type": "boolean", "default": false }, "outputFormats": { "$ref": "#/$defs/outputFormats", "title": "output format options", "description": "The output format options\n" }, "outputs": { "description": "Enable/disable output formats per page kind\n", "type": "object", "properties": { "_merge": { "$ref": "#/$defs/mergeType" } }, "default": { "home": [ "html", "rss" ], "page": [ "html" ], "rss": [ "rss" ], "section": [ "html", "rss" ], "taxonomy": [ "html", "rss" ], "term": [ "html", "rss" ] }, "additionalProperties": { "type": "array", "items": { "type": "string", "minLength": 1 }, "default": [ "html", "rss" ] } }, "page": { "$comment": "I have been unable to decipher the documentation\nhttps://gohugo.io/configuration/page/", "description": "UNDOCUMENTED.", "type": "object" }, "paginate": { "$comment": "DEPRECATED. Use 'pagination.pagerSize' instead.", "description": "The default number of elements per page in pagination\n", "type": "integer", "default": 10 }, "paginatePath": { "$comment": "DEPRECATED. Use 'pagination.path' instead.", "description": "The path element used during pagination\n", "type": "string", "default": "page", "minLength": 1 }, "pagination": { "description": "Pagination settings\n", "type": "object", "properties": { "disableAliases": { "description": "Enable/disable alias generation for the first pager\n", "type": "boolean", "default": false }, "pagerSize": { "description": "The number of pages per pager\n", "type": "integer", "default": 10 }, "path": { "description": "The segment of each pager URL indicating that the target page is a pager\n", "type": "string", "default": "page" } } }, "panicOnWarning": { "description": "Whether to panic on the first WARNING\n", "type": "boolean", "default": false }, "params": { "description": "Custom site parameters\n", "type": "object", "additionalProperties": true }, "permalinks": { "title": "permalink options", "description": "The permalink options\n", "type": "object", "properties": { "_merge": { "$ref": "#/$defs/mergeType" }, "page": { "$ref": "#/$defs/permalinkConfiguration" }, "section": { "$ref": "#/$defs/permalinkConfiguration" }, "term": { "$ref": "#/$defs/permalinkConfiguration" } } }, "pluralizeListTitles": { "description": "Pluralize/leave titles in lists\n", "type": "boolean", "default": true }, "printI18nWarnings": { "description": "Enable/disable the logging WARNINGs for each missing translation\n", "type": "boolean", "default": false }, "printPathWarnings": { "description": "Enable/disable the logging of WARNINGs when publishing two or more files to the same path\n", "type": "boolean", "default": false }, "printUnusedTemplates": { "description": "Enable/disable the logging WARNINGs for each unused template\n", "type": "boolean", "default": false }, "privacy": { "description": "Privacy setting for embedded templates\n", "type": "object", "properties": { "dispus": { "description": "Disqus embedded template privacy settings", "type": "object", "properties": { "disable": { "type": "boolean", "default": false } } }, "googleAnalytics": { "description": "Google analytics embedded template privacy settings", "type": "object", "properties": { "disable": { "type": "boolean", "default": false }, "respectDoNotTrack": { "type": "boolean", "default": false } } }, "instagram": { "description": "Instagram embedded template privacy settings", "type": "object", "properties": { "disable": { "type": "boolean", "default": false }, "simple": { "type": "boolean", "default": false } } }, "twitter": { "description": "DEPRECATED. Do not use. Deprecated in v0.141.0. Use the x shortcode instead.", "type": "object", "properties": { "disable": { "type": "boolean", "default": false }, "enableDNT": { "type": "boolean", "default": false }, "simple": { "type": "boolean", "default": false } } }, "vimeo": { "description": "Vimeo embedded template privacy settings", "type": "object", "properties": { "disable": { "type": "boolean", "default": false }, "enableDNT": { "type": "boolean", "default": false }, "simple": { "type": "boolean", "default": false } } }, "x": { "description": "X embedded template privacy settings\n", "type": "object", "properties": { "disable": { "description": "Enable/disable the X shortcode\n", "type": "boolean", "default": false }, "enableDNT": { "description": "Whether to prevent X from using post and embedded page data for personalized suggestions and ads\n", "type": "boolean", "default": false }, "simple": { "description": "Enable/disable usage of javascript in X shortcode\n", "type": "boolean", "default": false } } }, "youtube": { "description": "Toutube embedded template privacy settings", "type": "object", "properties": { "disable": { "type": "boolean", "default": false }, "privacyEnhanced": { "type": "boolean", "default": false } } } } }, "publishDir": { "description": "The directory where Hugo writes the final static site\n", "type": "string", "default": "public", "minLength": 1 }, "related": { "title": "related content options", "description": "The related content options\n", "type": "object", "default": { "includeNewer": false, "indices": [ { "applyFilter": false, "cardinalityThreshold": 0, "name": "keywords", "pattern": "", "toLower": false, "type": "basic", "weight": 100 }, { "applyFilter": false, "cardinalityThreshold": 0, "name": "date", "pattern": "", "toLower": false, "type": "basic", "weight": 10 }, { "applyFilter": false, "cardinalityThreshold": 0, "name": "tags", "pattern": "", "toLower": false, "type": "basic", "weight": 80 } ], "threshold": 80, "toLower": false }, "properties": { "_merge": { "$ref": "#/$defs/mergeType" }, "threshold": { "description": "\n", "type": "integer", "default": 80, "minimum": 0, "maximum": 100 }, "includeNewer": { "description": "Include/exclude the pages newer than the current page\n", "type": "boolean", "default": false }, "toLower": { "description": "Enable/disable lowering the case keywords in both the indexes and the queries\n", "type": "boolean", "default": false }, "indices": { "title": "related content option's entry", "description": "The related content option's entry\n", "type": "array", "default": [ { "applyFilter": false, "cardinalityThreshold": 0, "name": "keywords", "pattern": "", "toLower": false, "type": "basic", "weight": 100 }, { "applyFilter": false, "cardinalityThreshold": 0, "name": "date", "pattern": "", "toLower": false, "type": "basic", "weight": 10 }, { "applyFilter": false, "cardinalityThreshold": 0, "name": "tags", "pattern": "", "toLower": false, "type": "basic", "weight": 80 } ], "items": { "type": "object", "properties": { "name": { "description": "The index name\n", "type": "string", "minLength": 1 }, "type": { "description": "The index type\n", "type": "string", "default": "basic", "enum": [ "basic", "fragments" ] }, "applyFilter": { "description": "Apply a type specific filter to the result of a search. This is currently only used for the fragments type\n", "type": "boolean", "default": false }, "weight": { "description": "The weight indicating how important this parameter is relative to the other parameters\n", "type": "integer" }, "cardinalityThreshold": { "description": "A percentage (0-100) used to remove common keywords from the index\n", "type": "integer", "default": 0, "minimum": 0, "maximum": 100 }, "pattern": { "description": "The date format\n", "type": "string" }, "toLower": { "description": "Enable/disable lowering the case keywords in both the indexes and the queries\n", "type": "boolean", "default": false } }, "additionalProperties": false } } }, "additionalProperties": false }, "relativeURLs": { "description": "Enable/disable making all relative URLs relative to content root\n", "type": "boolean", "default": false }, "refLinksErrorLevel": { "description": "The logging level for page links cannot be resolved\n", "type": "string", "default": "ERROR", "enum": [ "ERROR", "WARNING" ] }, "refLinksNotFoundURL": { "description": "The placeholder when a page reference cannot be found in `ref` or `relref`\n", "type": "string" }, "removePathAccents": { "description": "Remove/leave non-spacing marks from composite characters in content paths\n", "type": "boolean", "default": false }, "renderSegments": { "description": "Array of segments to render\n", "type": "array", "items": { "type": "string", "minLength": 1 } }, "resourceDir": { "description": "The designated directory for caching output from asset pipelines\n", "type": "string", "default": "resources", "minLength": 1 }, "rssLimit": { "description": "DEPRECATED. Use 'services.rss.limit' instead\n", "type": "integer", "default": -1, "minimum": -1 }, "sectionPagesMenu": { "description": "\n", "type": "string" }, "security": { "title": "security options", "description": "The security options\n", "type": "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": [ ".*" ] } }, "properties": { "_merge": { "$ref": "#/$defs/mergeType" }, "enableInlineShortcodes": { "description": "\n", "type": "boolean", "default": false }, "exec": { "description": "\n", "type": "object", "default": { "allow": [ "^dart-sass-embedded$", "^go$", "^npx$", "^postcss$" ], "osEnv": [ "(?i)^(PATH|PATHEXT|APPDATA|TMP|TEMP|TERM)$" ] }, "properties": { "allow": { "description": "\n", "type": "array", "default": [ "^dart-sass-embedded$", "^go$", "^npx$", "^postcss$" ], "uniqueItems": true, "items": { "type": "string", "minLength": 1 } }, "osEnv": { "description": "\n", "type": "array", "default": [ "(?i)^(PATH|PATHEXT|APPDATA|TMP|TEMP|TERM)$" ], "uniqueItems": true, "items": { "type": "string", "minLength": 1 } } }, "additionalProperties": false }, "funcs": { "description": "\n", "type": "object", "default": { "getenv": [ "^HUGO_" ] }, "properties": { "getenv": { "description": "\n", "type": "array", "default": [ "^HUGO_" ], "uniqueItems": true, "items": { "type": "string", "minLength": 1 } } }, "additionalProperties": false }, "http": { "description": "\n", "type": "object", "default": { "methods": [ "(?i)GET|POST" ], "urls": [ ".*" ] }, "properties": { "methods": { "description": "\n", "type": "array", "default": [ "(?i)GET|POST" ], "uniqueItems": true, "items": { "type": "string", "minLength": 1 } }, "urls": { "description": "\n", "type": "array", "default": [ ".*" ], "uniqueItems": true, "items": { "type": "string", "minLength": 1 } } }, "additionalProperties": false } }, "additionalProperties": false }, "segments": { "description": "Map of named segments. Used to build portions of the site independently\n", "type": "object", "additionalProperties": { "type": "object", "properties": { "excludes": { "description": "An array of glob matchers to exclude pages from the segment\n", "type": "array", "items": { "$ref": "#/$defs/segmentIncludesExcludes" } }, "includes": { "description": "An array of glob matchers to include pages from the segment\n", "type": "array", "items": { "$ref": "#/$defs/segmentIncludesExcludes" } } } } }, "server": { "description": "Configuration for builtin development server\n", "type": "object", "properties": { "redirects": { "description": "Array of redirects\n", "type": "array", "items": { "type": "object", "properties": { "force": { "description": "Enable/disable redirecting even if there is existing content in the path\n", "type": "boolean" }, "from": { "description": "A glob pattern matching the requested URL\n", "type": "string" }, "formHeaders": { "description": "Map of glob patterns to march against the request headers\n", "type": "object", "additionalProperties": { "description": "Glob pattern to match the headers", "type": "string" } }, "fromRe": { "description": "A regular expression used to match the requested URL\n", "type": "string" }, "status": { "description": "The HTTP status code to use for the redirect\n", "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "to": { "description": "The URL to forward the request to\n", "type": "string" } } } }, "headers": { "description": "Array of headers to add to every response\n", "type": "array", "items": { "type": "object", "properties": { "for": { "description": "Glob pattern to match against request URL path\n", "type": "string" }, "values": { "description": "Map of headers to add to the response", "type": "object", "additionalProperties": { "type": "string" } } } } } } }, "services": { "type": "object", "properties": { "disqus": { "type": "object", "properties": { "shortname": { "description": "\n", "type": "string" } } }, "googleAnalytics": { "type": "object", "properties": { "id": { "description": "\n", "type": "string" } } }, "instagram": { "type": "object", "properties": { "accessToken": { "description": "DEPRECATED. Do not use. Deprecated in v0.123.0\n", "type": "string" }, "disableInlineCSS": { "description": "DEPRECATED. Do not use. Deprecated in v0.123.0\n", "type": "boolean" } } }, "rss": { "type": "object", "properties": { "limit": { "description": "The maximum number of items to include in an RSS feed\n", "type": "integer", "minimum": -1, "default": -1 } } }, "twitter": { "description": "DEPRECATED. Do not use. Deprecated in v0.141.0. Use the x shortcode instead", "type": "object", "properties": { "disableInlineCSS": { "type": "boolean" } } }, "x": { "type": "object", "properties": { "disableInlineCSS": { "description": "\n", "type": "boolean", "default": false } } } } }, "sitemap": { "title": "sitemap options", "description": "The sitemap options\n", "type": "object", "default": { "changefreq": "", "disable": false, "filename": "sitemap.xml", "priority": -1 }, "properties": { "_merge": { "$ref": "#/$defs/mergeType" }, "changefreq": { "description": "\n", "type": "string", "default": "", "enum": [ "", "always", "hourly", "daily", "weekly", "monthly", "yearly", "never" ] }, "disable": { "description": "\n", "type": "boolean", "default": false }, "filename": { "description": "\n", "type": "string", "default": "sitemap.xml" }, "priority": { "description": "\n", "type": "number", "oneOf": [ { "const": -1 }, { "minimum": 0, "maximum": 1 } ], "default": -1 } }, "additionalProperties": false }, "staticDir": { "description": "The designated directory for static files\n", "type": "string", "default": "static", "minLength": 1 }, "summaryLength": { "description": "The length of text in words to show in a .Summary\n", "type": "integer", "default": 70, "minimum": 0 }, "taxonomies": { "title": "taxonomy options", "description": "The taxonomy options\n", "type": "object", "default": { "category": "categories", "tag": "tags" }, "properties": { "_merge": { "$ref": "#/$defs/mergeType" }, "tag": { "description": "The default taxonomy\n", "type": "string", "default": "tags", "minLength": 1 }, "category": { "description": "The default taxonomy\n", "type": "string", "default": "categories", "minLength": 1 } }, "patternProperties": { "^(?!tag|category)$": { "description": "The custom taxonomy\n", "type": "string", "minLength": 1 } } }, "templateMetrics": { "description": "Enable/disable printing template execution metrics to the console\n", "type": "boolean", "default": false }, "templateMetricsHints": { "description": "Enable/disable printing template execution improvement hints to the console\n", "type": "boolean", "default": false }, "theme": { "description": "Theme or Theme list\n", "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "themesDir": { "description": "The directory where themes are stored\n", "type": "string", "default": "themes", "minLength": 1 }, "timeout": { "description": "The timeout for generating page contents\n", "type": "string", "default": "30s", "pattern": "^\\d+s$" }, "timeZone": { "description": "The time zone\n", "type": "string", "enum": [ "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" ] }, "title": { "description": "The site title\n", "type": "string" }, "titleCaseStyle": { "description": "The title case style\n", "type": "string", "default": "ap", "enum": [ "ap", "chicago", "go", "firstupper", "none" ] }, "uglyURLs": { "description": "Enable/disable adding file extensions to urls\n", "type": "boolean" }, "watch": { "description": "Enable/disable watching filesystem for changes and recreating as needed\n", "type": "boolean", "default": false } }, "$comment": "https://gohugo.io/getting-started/configuration/", "$defs": { "uniqueStringArray": { "type": "array", "uniqueItems": true, "items": { "type": "string", "minLength": 1 } }, "outputFormats": { "type": "object", "additionalProperties": { "title": "output format options", "description": "The output format options\n", "type": "object", "properties": { "name": { "description": "The identifier\n", "type": "string", "minLength": 1 }, "mediaType": { "description": "The media type\n", "type": "string", "examples": [ "application/json", "application/manifest+json", "application/octet-stream", "application/pdf", "application/rss+xml", "application/toml", "application/wasm", "application/xml", "application/yaml", "font/otf", "font/ttf", "image/bmp", "image/gif", "image/jpeg", "image/png", "image/svg+xml", "image/tiff", "image/webp", "text/calendar", "text/css", "text/csv", "text/html", "text/javascript", "text/jsx", "text/markdown", "text/plain", "text/tsx", "text/typescript", "text/x-sass", "text/x-scss", "video/3gpp", "video/mp4", "video/mpeg", "video/ogg", "video/webm", "video/x-msvideo" ] }, "path": { "description": "The path\n", "type": "string", "minLength": 1 }, "baseName": { "description": "The base filename for the list filenames\n", "type": "string", "default": "index" }, "rel": { "description": "\n", "type": "string", "default": "alternate" }, "protocol": { "description": "The replacement for `` or `` in `baseURL`\n", "type": "string" }, "isPlainText": { "description": "Enable/disable Go's plain text templates parser for the templates\n", "type": "boolean", "default": false }, "isHTML": { "description": "\n", "type": "boolean", "default": false }, "noUgly": { "description": "Enable/disable adding file extensions to urls\n", "type": "boolean", "default": false }, "notAlternative": { "description": "Include/exclude this format in an AlternativeOutputFormats format listing\n", "type": "boolean", "default": false }, "permalinkable": { "description": "Enable/disable .Permalink and .RelPermalink return the rendering output format\n", "type": "boolean", "default": false }, "weight": { "description": "The weight\n", "type": "integer" } }, "additionalProperties": false } }, "cascade": { "type": "object", "properties": { "aliases": { "$ref": "#/$defs/uniqueStringArray", "description": "The aliases\n" }, "audio": { "$ref": "#/$defs/uniqueStringArray", "description": "The audio\n" }, "build": { "description": "\n", "type": "object", "properties": { "list": { "description": "\n", "type": "string", "enum": [ "always", "local", "never" ] }, "publishResources": { "description": "\n", "type": "boolean" }, "render": { "description": "\n", "type": "string", "enum": [ "always", "link", "never" ] } } }, "date": { "description": "The datetime\n", "type": "string", "minLength": 1 }, "description": { "description": "The description\n", "type": "string" }, "draft": { "description": "Specify that the content is (not) the draft\n", "type": "boolean" }, "expiryDate": { "description": "The expire date\n", "type": "string", "minLength": 1 }, "headless": { "description": "Specify that the content is (not) the headless bundle\n", "type": "boolean" }, "images": { "$ref": "#/$defs/uniqueStringArray", "description": "The images\n" }, "isCJKLanguage": { "description": "Specify that the page language is (not) the CJK language\n", "type": "boolean" }, "keywords": { "$ref": "#/$defs/uniqueStringArray", "description": "The keywords\n" }, "layout": { "description": "The layout\n", "type": "string", "minLength": 1 }, "lastmod": { "description": "The last modification time\n", "type": "string", "minLength": 1 }, "linkTitle": { "description": "The link title\n", "type": "string", "minLength": 1 }, "markup": { "description": "\n", "type": "string", "enum": [ "rst", "md" ] }, "menus": { "description": "\n", "oneOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "object", "additionalProperties": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" }, "params": { "type": "object", "additionalProperties": true }, "parent": { "type": "string" }, "post": { "type": "string" }, "pre": { "type": "string" }, "weight": { "type": "integer", "not": { "const": 0 } } } } } ] }, "modified": { "description": "The last modification time\n", "type": "string", "minLength": 1 }, "outputs": { "$ref": "#/$defs/outputFormats", "title": "output format options", "description": "The output format options\n" }, "params": { "type": "object", "additionalProperties": true }, "pubdate": { "description": "The publish date\n", "type": "string", "minLength": 1 }, "publishDate": { "description": "The publish date\n", "type": "string", "minLength": 1 }, "published": { "description": "The publish date\n", "type": "string", "minLength": 1 }, "resources": { "title": "resource options", "description": "The resource options\n", "type": "object", "properties": { "name": { "description": "The value for `Name`\n", "type": "string", "minLength": 1, "examples": [ ":counter" ] }, "title": { "description": "The value for `Title`\n", "type": "string", "minLength": 1, "examples": [ ":counter" ] }, "params": { "title": "param options", "description": "The param options\n", "type": "object", "additionalProperties": { "description": "The param\n" } } }, "additionalProperties": false }, "sitemap": { "type": "object", "properties": { "changefreq": { "description": "\n", "type": "string", "enum": [ "", "always", "hourly", "daily", "weekly", "monthly", "yearly", "never" ] }, "disable": { "description": "", "type": "boolean" }, "priority": { "type": "number", "oneOf": [ { "const": -1 }, { "minimum": 0, "maximum": 1 } ] } } }, "series": { "$ref": "#/$defs/uniqueStringArray", "description": "The series\n" }, "slug": { "description": "The slug\n", "type": "string", "minLength": 1 }, "summary": { "description": "The summary\n", "type": "string", "minLength": 1 }, "target": { "description": "The front matter default\n", "type": "object", "properties": { "environment": { "description": "", "type": "string", "minLength": 1, "examples": [ "development", "staging", "production" ] }, "path": { "description": "The glob pattern matching the content path below /content\n", "type": "string", "minLength": 1 }, "kind": { "description": "The glob pattern matching the page's kind\n", "type": "string", "minLength": 1 }, "lang": { "description": "The glob pattern matching the page's language\n", "type": "string", "minLength": 1 } }, "additionalProperties": false }, "title": { "description": "The title\n", "type": "string", "minLength": 1 }, "translationKey": { "type": "string", "minLength": 1 }, "type": { "description": "The type\n", "type": "string", "minLength": 1 }, "unpublishdate": { "description": "The expire date\n", "type": "string", "minLength": 1 }, "url": { "description": "The url\n", "type": "string", "minLength": 1 }, "videos": { "$ref": "#/$defs/uniqueStringArray", "description": "The videos\n" }, "weight": { "description": "The weight\n", "type": "integer" } }, "patternProperties": { "^(?!aliases|audio|build|date|description|draft|expiryDate|headless|images|isCJKLanguage|keywords|layout|lastmod|linkTitle|markup|menus|modified|outputs|params|pubdate|publishDate|published|resources|sitemap|series|slug|summary|target|title|translationKey|type|unpublishdate|url|videos|weight)$": { "description": "The front matter default\n" } } }, "hugoVersion": { "type": "string", "pattern": "^\\d+\\.\\d+\\.\\d+.*$" }, "mergeType": { "description": "Merge configuration from themes\n", "type": "string", "enum": [ "none", "shallow", "deep" ] }, "mounts": { "type": "array", "items": { "type": "object", "default": [ { "source": "content", "target": "content" }, { "source": "static", "target": "static" }, { "source": "layouts", "target": "layouts" }, { "source": "data", "target": "data" }, { "source": "assets", "target": "assets" }, { "source": "i18n", "target": "i18n" }, { "source": "archetypes", "target": "archetypes" } ], "required": [ "source", "target" ], "properties": { "source": { "description": "The source path\n", "type": "string", "minLength": 1 }, "target": { "description": "The target path\n", "type": "string", "minLength": 1 }, "disableWatch": { "description": "Whether to disable watching\n", "type": "boolean", "default": false }, "lang": { "description": "The language code\n", "type": "string", "minLength": 1 }, "includeFiles": { "description": "The included files\n", "oneOf": [ { "type": "string" }, { "type": "array", "uniqueItems": true, "items": { "type": "string" } } ] }, "excludeFiles": { "description": "The excluded files\n", "oneOf": [ { "type": "string" }, { "type": "array", "uniqueItems": true, "items": { "type": "string" } } ] } }, "additionalProperties": false } }, "permalinkDefinition": { "description": "A permalink", "type": "string", "examples": [ ":year", ":month", ":monthname", ":day", ":weekday", ":weekdayname", ":yearday", ":section", ":sections", ":title", ":slug", ":filename" ] }, "permalinkConfiguration": { "oneOf": [ { "$ref": "#/$defs/permalinkDefinition" }, { "type": "object", "additionalProperties": { "$ref": "#/$defs/permalinkDefinition" } } ] }, "duration": { "description": "Length of time expressed in seconds (s), minutes (m), and hours (h)", "oneOf": [ { "type": "string", "pattern": "^[0-9smh]*$", "minLength": 1 }, { "type": "integer", "const": 0 } ] }, "stringOrStringArray": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "array", "items": { "type": "string", "minLength": 1 } } ] }, "segmentIncludesExcludes": { "type": "object", "properties": { "kind": { "description": "A glob pattern matching the page kind\n", "type": "string", "examples": [ "taxonomy", "term" ] }, "lang": { "description": " A glob pattern matching the page language\n", "type": "string", "examples": [ "en", "de" ] }, "output": { "description": "A glob pattern matching the page output format\n", "type": "string", "examples": [ "html", "json" ] }, "path": { "description": "A glob pattern matching the page’s logical path\n", "type": "string", "examples": [ "/books", "books/**" ] } } } } }