schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
hugo.json
notAlternative
Include/exclude this format in an AlternativeOutputFormats format listing https://gohugo.io/templates/output-formats/#configure-output-formats
{"type": "boolean", "default": false}
hugo.json
permalinkable
Enable/disable .Permalink and .RelPermalink return the rendering output format https://gohugo.io/templates/output-formats/#configure-output-formats
{"type": "boolean", "default": false}
hugo.json
weight
The weight https://gohugo.io/templates/output-formats/#configure-output-formats
{"type": "integer"}
hugo.json
aliases
The aliases https://gohugo.io/content-management/front-matter#predefined
{}
hugo.json
audio
The audio https://gohugo.io/content-management/front-matter#predefined
{}
hugo.json
date
The datetime https://gohugo.io/content-management/front-matter#predefined
{"type": "string", "minLength": 1}
hugo.json
description
The description https://gohugo.io/content-management/front-matter#predefined
{"type": "string"}
hugo.json
draft
Specify that the content is (not) the draft https://gohugo.io/content-management/front-matter#predefined
{"type": "boolean"}
hugo.json
expiryDate
The expire date https://gohugo.io/content-management/front-matter#predefined
{"type": "string", "minLength": 1}
hugo.json
headless
Specify that the content is (not) the headless bundle https://gohugo.io/content-management/front-matter#predefined
{"type": "boolean"}
hugo.json
images
The images https://gohugo.io/content-management/front-matter#predefined
{}
hugo.json
isCJKLanguage
Specify that the page language is (not) the CJK language https://gohugo.io/content-management/front-matter#predefined
{"type": "boolean"}
hugo.json
keywords
The keywords https://gohugo.io/content-management/front-matter#predefined
{}
hugo.json
layout
The layout https://gohugo.io/content-management/front-matter#predefined
{"type": "string", "minLength": 1}
hugo.json
lastmod
The last modification time https://gohugo.io/content-management/front-matter#predefined
{"type": "string", "minLength": 1}
hugo.json
linkTitle
The link title https://gohugo.io/content-management/front-matter#predefined
{"type": "string", "minLength": 1}
hugo.json
markup
ERROR: type should be string, got "\nhttps://gohugo.io/content-management/front-matter#predefined"
{"type": "string", "enum": ["rst", "md"]}
hugo.json
outputs
The output format options https://gohugo.io/content-management/front-matter#predefined
{}
hugo.json
publishDate
The publish date https://gohugo.io/content-management/front-matter#predefined
{"type": "string", "minLength": 1}
hugo.json
resources
The resource options https://gohugo.io/content-management/front-matter#predefined
{"type": "object", "properties": {"name": {"type": "string", "minLength": 1, "examples": [":counter"]}, "params": {"type": "object", "patternProperties": {".": {}}}}, "additionalProperties": false}
hugo.json
name
The value for `Name` https://gohugo.io/content-management/page-resources/#page-resources-metadata
{"type": "string", "minLength": 1, "examples": [":counter"]}
hugo.json
title
The value for `Title` https://gohugo.io/content-management/page-resources/#page-resources-metadata
{"type": "string", "minLength": 1, "examples": [":counter"]}
hugo.json
params
The param options https://gohugo.io/content-management/page-resources/#page-resources-metadata
{"type": "object", "patternProperties": {".": {}}}
hugo.json
.
The param https://gohugo.io/content-management/page-resources/#page-resources-metadata
{}
hugo.json
series
The series https://gohugo.io/content-management/front-matter#predefined
{}
hugo.json
slug
The slug https://gohugo.io/content-management/front-matter#predefined
{"type": "string", "minLength": 1}
hugo.json
summary
The summary https://gohugo.io/content-management/front-matter#predefined
{"type": "string", "minLength": 1}
hugo.json
title
The title https://gohugo.io/content-management/front-matter#predefined
{"type": "string", "minLength": 1}
hugo.json
type
The type https://gohugo.io/content-management/front-matter#predefined
{"type": "string", "minLength": 1}
hugo.json
url
The url https://gohugo.io/content-management/front-matter#predefined
{"type": "string", "minLength": 1}
hugo.json
videos
The videos https://gohugo.io/content-management/front-matter#predefined
{}
hugo.json
weight
The weight https://gohugo.io/content-management/front-matter#predefined
{"type": "integer"}
hugo.json
^(?!aliases|audio|date|description|draft|expiryDate|headless|images|isCJKLanguage|keywords|layout|lastmod|linkTitle|markup|outputs|publishDate|resources|series|slug|summary|title|type|url|videos|weight)$
The front matter default https://gohugo.io/content-management/front-matter#front-matter-cascade
{}
hugo.json
archetypeDir
The directory to store archetype files https://gohugo.io/getting-started/configuration/#archetypedir
{"type": "string", "default": "archetypes", "minLength": 1}
hugo.json
assetDir
The directory to store asset files https://gohugo.io/getting-started/configuration/#assetdir
{"type": "string", "default": "assets", "minLength": 1}
hugo.json
baseURL
The hostname and the path to the root https://gohugo.io/getting-started/configuration/#baseurl
{"type": "string", "minLength": 1}
hugo.json
build
The build options https://gohugo.io/getting-started/configuration/#configure-build
{"type": "object", "properties": {"useResourceCacheWhen": {"type": "string", "default": "fallback", "enum": ["never", "always", "fallback"]}, "writeStats": {"type": "boolean", "default": false}, "noJSConfigInAssets": {"type": "boolean", "default": false}}, "additionalProperties": false}
hugo.json
useResourceCacheWhen
The time when to use the cached resources in `/resources/_gen` for `PostCSS` and `ToCSS` https://gohugo.io/getting-started/configuration/#configure-build
{"type": "string", "default": "fallback", "enum": ["never", "always", "fallback"]}
hugo.json
writeStats
Enable/disable `hugo_stats.json` writing to the root project directory https://gohugo.io/getting-started/configuration/#configure-build
{"type": "boolean", "default": false}
hugo.json
noJSConfigInAssets
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
{"type": "boolean", "default": false}
hugo.json
buildDrafts
Include/exclude the drafts when building https://gohugo.io/getting-started/configuration/#builddrafts-false
{"type": "boolean", "default": false}
hugo.json
buildExpired
Include/exclude the content already expired https://gohugo.io/getting-started/configuration/#buildexpired
{"type": "boolean", "default": false}
hugo.json
buildFuture
Include/exclude the content with `publishDate` in the future https://gohugo.io/getting-started/configuration/#buildfuture
{"type": "boolean", "default": false}
hugo.json
caches
The cache options https://gohugo.io/getting-started/configuration/#configure-file-caches
{"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":...
hugo.json
.
Cache entry
{"type": "object", "properties": {"maxAge": {"default": -1, "examples": ["0", "10s", "10m", "10h"], "oneOf": [{"type": "integer", "minimum": -1}, {"type": "string", "pattern": "^-?\\d+[smh]?$"}]}, "dir": {"type": "string", "examples": [":cacheDir", ":project", ":resourceDir", ":resourceDir/_gen", ":cacheDir/:project", ...
hugo.json
maxAge
The duration before the cache entry will be evicted https://gohugo.io/getting-started/configuration/#the-keywords-explained
{"default": -1, "examples": ["0", "10s", "10m", "10h"], "oneOf": [{"type": "integer", "minimum": -1}, {"type": "string", "pattern": "^-?\\d+[smh]?$"}]}
hugo.json
dir
The absolute path to store cache files https://gohugo.io/getting-started/configuration/#the-keywords-explained
{"type": "string", "examples": [":cacheDir", ":project", ":resourceDir", ":resourceDir/_gen", ":cacheDir/:project", ":cacheDir/modules"], "minLength": 1}
hugo.json
cascade
The front matter options https://gohugo.io/content-management/front-matter#front-matter-cascade
{"oneOf": [{"type": "object"}, {"type": "array", "items": {"type": "object", "required": ["_target"], "allOf": [{"properties": {"_target": {"type": "object", "properties": {"path": {"type": "string", "minLength": 1}, "kind": {"type": "string", "minLength": 1}, "lang": {"type": "string", "minLength": 1}}, "additionalPro...
hugo.json
_target
The front matter default https://gohugo.io/content-management/front-matter#front-matter-cascade
{"type": "object", "properties": {"path": {"type": "string", "minLength": 1}, "kind": {"type": "string", "minLength": 1}, "lang": {"type": "string", "minLength": 1}}, "additionalProperties": false}
hugo.json
path
The glob pattern matching the content path below /content https://gohugo.io/content-management/front-matter#front-matter-cascade
{"type": "string", "minLength": 1}
hugo.json
kind
The glob pattern matching the page's kind https://gohugo.io/content-management/front-matter#front-matter-cascade
{"type": "string", "minLength": 1}
hugo.json
lang
The glob pattern matching the page's language https://gohugo.io/content-management/front-matter#front-matter-cascade
{"type": "string", "minLength": 1}
hugo.json
canonifyURLs
Enable/disable relative URLs to absolute conversion https://gohugo.io/getting-started/configuration/#canonifyurls
{"type": "boolean", "default": false}
hugo.json
contentDir
The directory where content files are stored https://gohugo.io/getting-started/configuration/#contentdir
{"type": "string", "default": "content", "minLength": 1}
hugo.json
copyright
The copyright notice for your site https://gohugo.io/getting-started/configuration/#copyright
{"type": "string", "default": ""}
hugo.json
dataDir
The directory where data files are stored https://gohugo.io/getting-started/configuration/#datadir
{"type": "string", "default": "data", "minLength": 1}
hugo.json
defaultContentLanguage
The default content language for the content without language indicator https://gohugo.io/getting-started/configuration/#defaultcontentlanguage
{"type": "string", "default": "en", "minLength": 1}
hugo.json
defaultContentLanguageInSubdir
Enable/disable rendering the default content language in subdir https://gohugo.io/getting-started/configuration/#defaultcontentlanguageinsubdir
{"type": "boolean", "default": false}
hugo.json
disableAliases
Enable/disable generation of the alias redirects https://gohugo.io/getting-started/configuration/#disablealiases
{"type": "boolean", "default": false}
hugo.json
disableHugoGeneratorInject
Enable/disable injecting a generator meta tag in the HTML head on the home page only https://gohugo.io/getting-started/configuration/#disablehugogeneratorinject
{"type": "boolean", "default": false}
hugo.json
disableKinds
Disabled kinds of pages https://gohugo.io/getting-started/configuration/#disablekinds
{"type": "array", "uniqueItems": true, "items": {"type": "string", "enum": ["page", "home", "section", "taxonomy", "term", "RSS", "sitemap", "robotsTXT", "404"]}}
hugo.json
disableLiveReload
Enable/disable automatic live reloading of browser window https://gohugo.io/getting-started/configuration/#disablelivereload
{"type": "boolean", "default": false}
hugo.json
disablePathToLower
Enable/disable the url/path to lowercase conversion https://gohugo.io/getting-started/configuration/#disablepathtolower
{"type": "boolean", "default": false}
hugo.json
enableEmoji
Enable/disable Emoji emoticons support for page content https://gohugo.io/getting-started/configuration/#enableemoji
{"type": "boolean", "default": false}
hugo.json
enableGitInfo
Enable/disable .GitInfo object for each page https://gohugo.io/getting-started/configuration/#enablegitinfo
{"type": "boolean", "default": false}
hugo.json
enableInlineShortcodes
Enable/disable inline shortcode support https://gohugo.io/getting-started/configuration/#enableinlineshortcodes
{"type": "boolean", "default": false}
hugo.json
enableMissingTranslationPlaceholders
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
{"type": "boolean", "default": false}
hugo.json
enableRobotsTXT
Enable/disable generation of robots.txt file https://gohugo.io/getting-started/configuration/#enablerobotstxt
{"type": "boolean", "default": false}
hugo.json
frontmatter
The front matter options https://gohugo.io/getting-started/configuration/#configure-front-matter
{"type": "object", "default": {"date": ["date", "publishDate", "lastmod"], "expiryDate": ["expiryDate"], "lastmod": [":git", "lastmod", "date", "publishDate"], "publishDate": ["publishDate", "date"]}, "properties": {"date": {"type": "array", "uniqueItems": true, "items": {"type": "string", "enum": ["date", "publishDate...
hugo.json
date
ERROR: type should be string, got "\nhttps://gohugo.io/getting-started/configuration/#configure-front-matter"
{"type": "array", "uniqueItems": true, "items": {"type": "string", "enum": ["date", "publishDate", "lastmod", ":default", ":filename", ":git", "modified", "pubdate"]}}
hugo.json
expiryDate
ERROR: type should be string, got "\nhttps://gohugo.io/getting-started/configuration/#configure-front-matter"
{"type": "array", "uniqueItems": true, "items": {"type": "string", "enum": ["expiryDate", "unpublishdate"]}}
hugo.json
lastmod
ERROR: type should be string, got "\nhttps://gohugo.io/getting-started/configuration/#configure-front-matter"
{"type": "array", "uniqueItems": true, "items": {"type": "string", "enum": [":git", "lastmod", "date", "publishDate", ":fileModTime", "modified", "pubdate"]}}
hugo.json
publishDate
ERROR: type should be string, got "\nhttps://gohugo.io/getting-started/configuration/#configure-front-matter"
{"type": "array", "uniqueItems": true, "items": {"type": "string", "enum": ["publishDate", "date", "pubdate"]}}
hugo.json
footnoteAnchorPrefix
The prefix for footnote anchors https://gohugo.io/getting-started/configuration/#footnoteanchorprefix
{"type": "string", "default": ""}
hugo.json
footnoteReturnLinkContents
The text to display for footnote return links https://gohugo.io/getting-started/configuration/#footnotereturnlinkcontents
{"type": "string", "default": ""}
hugo.json
googleAnalytics
The Google Analytics tracking ID https://gohugo.io/getting-started/configuration/#googleanalytics
{"type": "string", "default": "", "pattern": "(UA-\\d{6}-\\d)|(G-\\w+)"}
hugo.json
hasCJKLanguage
Enable/disable auto-detecting Chinese/Japanese/Korean Languages in the content https://gohugo.io/getting-started/configuration/#hascjklanguage
{"type": "boolean", "default": false}
hugo.json
imaging
The image processing options https://gohugo.io/getting-started/configuration/#imaging
{"type": "object", "default": {"resampleFilter": "Box", "quality": 75, "hint": "photo", "anchor": "Smart", "bgColor": "#ffffff", "exif": {"includeFields": "", "excludeFields": "", "disableDate": false, "disableLatLong": false}}, "properties": {"resampleFilter": {"type": "string", "default": "Box", "enum": ["NearestNeig...
hugo.json
resampleFilter
The default resample filter https://gohugo.io/content-management/image-processing/#resampling-filter
{"type": "string", "default": "Box", "enum": ["NearestNeighbor", "Box", "Linear", "Hermite", "MitchellNetravali", "CatmullRom", "BSpline", "Gaussian", "Lanczos", "Hann", "Hamming", "Blackman", "Bartlett", "Welch", "Cosine"]}
hugo.json
quality
The default quality https://gohugo.io/content-management/image-processing/#image-processing-config
{"type": "integer", "default": 75, "minimum": 0, "maximum": 100}
hugo.json
hint
The default hint about what type of image https://gohugo.io/content-management/image-processing/#image-processing-config
{"type": "string", "default": "photo", "enum": ["picture", "photo", "drawing", "icon", "text"]}
hugo.json
anchor
The anchor used when cropping pictures with either .Fill or .Crop https://gohugo.io/content-management/image-processing/#image-processing-config
{"type": "string", "default": "Smart", "enum": ["Smart", "TopLeft", "Top", "TopRight", "Left", "Center", "Right", "BottomLeft", "Bottom", "BottomRight"]}
hugo.json
bgColor
The default background color https://gohugo.io/content-management/image-processing/#image-processing-config
{"type": "string", "default": "#ffffff", "pattern": "^#(\\d|[ABCDEFabcdef]){6}$"}
hugo.json
exif
Exif options https://gohugo.io/content-management/image-processing/#image-processing-config
{"type": "object", "properties": {"includeFields": {"type": "string", "default": ""}, "excludeFields": {"type": "string", "default": ""}, "disableDate": {"type": "boolean", "default": false}, "disableLatLong": {"type": "boolean", "default": false}}, "additionalProperties": false}
hugo.json
includeFields
The regexp matching the included fields https://gohugo.io/content-management/image-processing/#image-processing-config
{"type": "string", "default": ""}
hugo.json
excludeFields
The regexp matching the excluded fields https://gohugo.io/content-management/image-processing/#image-processing-config
{"type": "string", "default": ""}
hugo.json
disableDate
Enable/disable extracting the 'photo taken' date/time into .Date https://gohugo.io/content-management/image-processing/#image-processing-config
{"type": "boolean", "default": false}
hugo.json
disableLatLong
Enable/disable extracting the 'photo taken where' into .Long and .Lat https://gohugo.io/content-management/image-processing/#image-processing-config
{"type": "boolean", "default": false}
hugo.json
languageCode
The language tag as defined by RFC 5646 https://gohugo.io/getting-started/configuration/#languagecode
{"type": "string", "default": ""}
hugo.json
languages
The language options https://gohugo.io/content-management/multilingual/#configure-languages
{"type": "object", "default": {}, "patternProperties": {".": {"type": "object"}}}
hugo.json
.
Tha language options
{"type": "object"}
hugo.json
disableLanguages
The disabled languages https://gohugo.io/content-management/multilingual/#disable-a-language
{}
hugo.json
markup
The markdown options https://gohugo.io/getting-started/configuration-markup
{"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":...
hugo.json
asciidocExt
AsciidocExt options https://docs.asciidoctor.org/asciidoctor/latest/cli/man1/asciidoctor/#processing-information
{"type": "object", "properties": {"attributes": {"type": "object", "default": {}, "patternProperties": {".": {"type": "string"}}}, "backend": {"type": "string", "default": "html5", "enum": ["html5", "docbook5", "manpage", "html"]}, "extensions": {"type": "array", "default": [], "uniqueItems": true, "items": {"type": "s...
hugo.json
attributes
The document attributes https://docs.asciidoctor.org/asciidoctor/latest/cli/man1/asciidoctor/#document-settings
{"type": "object", "default": {}, "patternProperties": {".": {"type": "string"}}}
hugo.json
backend
The backend output file format https://docs.asciidoctor.org/asciidoctor/latest/cli/man1/asciidoctor/#document-settings
{"type": "string", "default": "html5", "enum": ["html5", "docbook5", "manpage", "html"]}
hugo.json
extensions
ERROR: type should be string, got "\nhttps://gohugo.io/getting-started/configuration-markup#configure-markup"
{"type": "array", "default": [], "uniqueItems": true, "items": {"type": "string", "minLength": 1}}
hugo.json
failureLevel
The minimum logging level https://docs.asciidoctor.org/asciidoctor/latest/cli/man1/asciidoctor/#processing-information
{"type": "string", "default": "fatal"}
hugo.json
noHeaderOrFooter
ERROR: type should be string, got "\nhttps://gohugo.io/getting-started/configuration-markup#configure-markup"
{"type": "boolean", "default": true}
hugo.json
preserveTOC
ERROR: type should be string, got "\nhttps://gohugo.io/getting-started/configuration-markup#configure-markup"
{"type": "boolean", "default": false}