Hugo 所有设置

设置

archetypeDir

(string) 原型 的指定目录。默认值是 archetypes。For a more flexible approach to configuring this directory, consult the section on module mounts.

assetDir

(string) 全局资源 的指定目录。默认值是 assets。For a more flexible approach to configuring this directory, consult the section on module mounts.

baseURL

(string) 您发布的站点的绝对 URL，包括协议、主机、路径和尾部斜杠。

build

请参阅 配置构建。

buildDrafts

(bool) 构建站点时是否包含草稿内容。默认值是 false。

buildExpired

(bool) 构建站点时是否包含过期内容。默认值是 false。

buildFuture

(bool) 构建站点时是否包含未来内容。默认值是 false。

cacheDir

(string) 指定的缓存目录。请参阅 详情。

caches

请参阅 配置文件缓存。

canonifyURLs

(bool) 在启用此功能之前请参阅 详情。默认值是 false。

capitalizeListTitles

(bool) 是否自动大写列表标题。适用于栏目、分类法和术语页面。默认值是 true。使用 titleCaseStyle 设置来配置大写规则。

cascade

请参阅 配置级联。

cleanDestinationDir

(bool) 构建站点时是否从 publishDir 中删除在 staticDir 中不存在的文件。如果 staticDir 不存在，此设置将不生效。请注意，.gitignore 和 .gitattributes 文件以及名为 .git 的目录始终保留在 publishDir 中。默认值是 false。

contentDir

(string) 内容文件的指定目录。默认值是 content。For a more flexible approach to configuring this directory, consult the section on module mounts.

copyright

(string) 站点的版权声明，通常显示在页脚中。

dataDir

(string) 数据文件的指定目录。默认值是 data。For a more flexible approach to configuring this directory, consult the section on module mounts.

defaultContentLanguage

(string) 项目的默认内容语言，符合 RFC 5646 中描述的语法。此值必须与定义的 语言键 之一匹配。默认值是 en。

defaultContentLanguageInSubdir

(bool) 是否将默认内容语言发布到与 defaultContentLanguage 匹配的子目录。默认值是 false。

defaultContentRole

New in v0.153.0

(string) 项目的默认内容 角色。默认值是 guest。

defaultContentRoleInSubdir

New in v0.153.0

(bool) 是否将默认内容 角色 发布到与 defaultContentRole 匹配的子目录。默认值是 false。

defaultContentVersion

New in v0.153.0

(string) 项目的默认内容版本。默认值是 v1.0.0。

defaultContentVersionInSubdir

New in v0.153.0

(bool) 是否将默认内容版本发布到与 defaultContentVersion 匹配的子目录。默认值是 false。

defaultOutputFormat

(string) 站点的默认输出格式。如果未指定，将使用定义的顺序（按权重，然后按字母顺序）中的第一个可用格式。

deployment

请参阅 配置部署。

disableAliases

(bool) 是否为 aliases front matter 字段中定义的每个路径禁用 HTML 重定向文件的生成。当为 true 时，Hugo 将不会为 客户端重定向 创建物理文件，但别名数据仍可通过 Page 对象上的 Aliases 方法访问。默认值是 false。

disableDefaultLanguageRedirect

New in v0.140.0

(bool) 是否禁用默认内容语言的别名重定向生成。当 defaultContentLanguageInSubdir 为 true 时，此设置可防止根目录重定向到语言子目录。相反，当 defaultContentLanguageInSubdir 为 false 时，此设置可防止语言子目录重定向到根目录。这被更通用的 disableDefaultSiteRedirect 设置所取代。默认值是 false。

disableDefaultSiteRedirect

New in v0.154.5

(bool) 是否禁用到 默认站点 的别名重定向生成。当 defaultContentLanguageInSubdir、defaultContentRoleInSubdir 或 defaultContentVersionInSubdir 为 true 时，这可防止根目录重定向到默认站点的子目录。相反，当这些为 false 时，这可防止子目录重定向回根目录。默认站点是具有默认内容语言、版本和角色的站点。默认值是 false。

disableHugoGeneratorInject

(bool) 是否禁用将 <meta name="generator"> 标签注入到首页。默认值是 false。

disableKinds

([]string) 构建过程中要禁用的页面 类型 切片，可以是 404、home、page、robotstxt、rss、section、sitemap、taxonomy 或 term。

disableLanguages

([]string) 表示构建过程中要禁用的语言的语言键切片。虽然这是可行的，但请考虑使用每个语言下的 disabled 键。

disableLiveReload

(bool) 是否禁用浏览器窗口的自动实时重载。默认值是 false。

disablePathToLower

(bool) 是否禁用页面 URL 转换为小写。默认值是 false。

enableEmoji

(bool) 是否允许在 Markdown 中使用 emoji。默认值是 false。

enableGitInfo

(bool) 对于在 Git 版本控制下的站点，是否为每个页面启用 GitInfo 对象。使用 默认 front matter 配置 时，Page 对象上的 Lastmod 方法将返回 Git 作者日期。默认值是 false。

enableMissingTranslationPlaceholders

(bool) 是否在缺少翻译时显示占位符而不是默认值或空字符串。默认值是 false。

enableRobotsTXT

(bool) 是否启用生成 robots.txt 文件。默认值是 false。

environment

(string) 构建环境。运行 hugo 时默认值是 production，运行 hugo server 时默认值是 development。

frontmatter

请参阅 配置 front matter。

hasCJKLanguage

(bool) 是否自动检测内容中的 CJK 语言。影响 WordCount 和 FuzzyWordCount 方法返回的值。默认值是 false。

HTTPCache

请参阅 配置 HTTP 缓存。

i18nDir

(string) 翻译表的指定目录。默认值是 i18n。For a more flexible approach to configuring this directory, consult the section on module mounts.

ignoreCache

(bool) 是否忽略缓存目录。默认值是 false。

ignoreFiles

([]string) 用于从构建中排除特定文件的 正则表达式 切片。这些表达式与绝对文件路径匹配，并适用于 content、data 和 i18n 目录中的文件。有关更高级的文件排除选项，请参阅 模块挂载 部分。

ignoreLogs

([]string) 与您希望抑制的警告和错误对应的消息标识符切片。请参阅 erroridf 和 warnidf。

ignoreVendorPaths

(string) 匹配要从 _vendor 目录中排除的模块路径的 glob 模式。

imaging

请参阅 配置成像。

languageCode

(string) 站点的语言标签，符合 RFC 5646 中描述的语法。此值不影响翻译或本地化。Hugo 使用此值填充：

• 嵌入式 RSS 模板 中的 language 元素
• 嵌入式别名模板 中 html 元素的 lang 属性
• 嵌入式 Open Graph 模板 中的 og:locale meta 元素

当存在于配置根目录时，如果存在一个或多个语言键，则忽略此值。请为每个语言键单独指定此值。

languages

请参阅 配置语言。

layoutDir

(string) 模板的指定目录。默认值是 layouts。For a more flexible approach to configuring this directory, consult the section on module mounts.

mainSections

(string 或 []string) 站点的主要栏目。如果设置，Site 对象上的 MainSections 方法将返回给定的栏目，否则返回具有最多页面的栏目。

markup

请参阅 配置 markup。

mediaTypes

请参阅 配置媒体类型。

menus

请参阅 配置菜单。

minify

请参阅 配置最小化。

module

请参阅 配置模块。

newContentEditor

(string) 创建新内容时使用的编辑器。

noBuildLock

(bool) 是否禁用创建 .hugo_build.lock 文件。默认值是 false。

noChmod

(bool) 是否禁用同步文件权限模式。默认值是 false。

noTimes

(bool) 是否禁用同步文件修改时间。默认值是 false。

outputFormats

请参阅 配置输出格式。

outputs

请参阅 配置输出。

page

请参阅 配置页面。

pagination

请参阅 配置分页。

panicOnWarning

(bool) 是否在第一个 WARNING 时 panic。默认值是 false。

params

请参阅 配置参数。

permalinks

请参阅 配置固定链接。

pluralizeListTitles

(bool) 是否自动复数化列表标题。适用于栏目页面。默认值是 true。

printI18nWarnings

(bool) 是否记录每个缺失翻译的 WARNING。默认值是 false。

printPathWarnings

(bool) 当 Hugo 将两个或多个文件发布到同一路径时是否记录 WARNING。默认值是 false。

printUnusedTemplates

(bool) 是否记录每个未使用模板的 WARNING。默认值是 false。

privacy

请参阅 配置隐私。

publishDir

(string) 发布站点的指定目录。默认值是 public。

refLinksErrorLevel

(string) 当 ref 和 relref 函数、方法和短代码无法解析对页面的引用时要使用的日志错误级别。可以是 ERROR 或 WARNING。任何 ERROR 都将导致构建失败。默认值是 ERROR。

refLinksNotFoundURL

(string) 当 ref 和 relref 函数、方法和短代码无法解析对页面的引用时要返回的 URL。

related

请参阅 配置相关内容。

relativeURLs

(bool) 在启用此功能之前请参阅 详情。默认值是 false。

removePathAccents

(bool) 是否从内容路径中的 复合字符 中移除 非间距标记。默认值是 false。

renderSegments

([]string) 要渲染的 段 切片。如果省略，将渲染所有段。此选项通常通过命令行标志设置，例如 hugo --renderSegments segment1,segment2。提供的段名称必须与 segments 配置中定义的对应。

resourceDir

(string) 缓存 资产管道 输出的指定目录。默认值是 resources。

roles

请参阅 配置角色。

security

请参阅 配置安全。

sectionPagesMenu

(string) 设置时，每个顶级栏目将添加到由提供值标识的菜单。请参阅 详情。

segments

请参阅 配置分段。

server

请参阅 配置服务器。

services

请参阅 配置服务。

sitemap

请参阅 配置站点地图。

staticDir

(string) 静态文件的指定目录。默认值是 static。For a more flexible approach to configuring this directory, consult the section on module mounts.

summaryLength

(int) 适用于 自动摘要，Page 对象上的 Summary 方法返回的最小字数。Summary 方法将返回在段落边界处截断的内容，最接近指定的 summaryLength，但至少为这个最小字数。默认值是 70。

taxonomies

请参阅 配置分类法。

templateMetrics

(bool) 是否将模板执行指标打印到控制台。默认值是 false。请参阅 详情。

templateMetricsHints

(bool) 是否将模板执行改进提示打印到控制台。适用于 templateMetrics 为 true 时。默认值是 false。请参阅 详情。

theme

(string 或 []string) 要使用的 主题。可以列出多个主题，优先级从左到右。请参阅 详情。

themesDir

(string) 主题的指定目录。默认值是 themes。

timeout

(string) 生成页面内容的超时，可以是 持续时间 或秒数。此超时可防止内容生成期间的无限递归。如果您的页面需要很长时间生成，例如由于广泛的图像处理或依赖远程内容，您可能需要增加此值。默认值是 60s。

timeZone

(string) 用于解析没有时区偏移的日期的时区，包括 front matter 日期字段和传递给 time.AsTime 和 time.Format 模板函数的值。有效值列表可能依赖于系统，但应包括 UTC、Local 和 IANA 时区数据库 中的任何位置。例如，America/Los_Angeles 和 Europe/Oslo 是有效的时区。

title

(string) 站点标题。

titleCaseStyle

(string) 当 Hugo 自动生成栏目标题或使用 strings.Title 函数时要遵循的大写规则。可以是 ap、chicago、go、firstupper 或 none。默认值是 ap。请参阅 详情。

uglyurls

请参阅 配置丑陋 URL。

versions

请参阅 配置版本。

缓存目录

Hugo 的文件缓存目录可通过 cacheDir 配置选项或 HUGO_CACHEDIR 环境变量进行配置。如果两者都未设置，Hugo 将按以下优先顺序使用：

1. 如果在 Netlify 上运行：/opt/build/cache/hugo_cache/。这意味着如果您在 Netlify 上运行构建，所有配置为 :cacheDir 的缓存将在下次构建时保存和恢复。对于其他 CI/CD 平台，请阅读它们的文档。有关 CircleCI 示例，请参阅 此配置。
2. 在 Go 的 os.UserCacheDir 函数定义的操作系统用户缓存目录下的 hugo_cache 目录中。在 Unix 系统上，根据 XDG 基本目录规范，如果 $XDG_CACHE_HOME 非空，则是 $XDG_CACHE_HOME，否则是 $HOME/.cache。在 MacOS 上，这是 $HOME/Library/Caches。在 Windows 上，这是 %LocalAppData%。在 Plan 9 上，这是 $home/lib/cache。
3. 在操作系统临时目录下的 hugo_cache_$USER 目录中。

要确定当前的 cacheDir：

hugo config | grep cachedir

标题大写样式

Hugo 的 titleCaseStyle 设置管理自动生成的栏目标题和 strings.Title 函数的大写。默认情况下，它遵循美联社风格手册中发布的大写规则。更改此设置以使用其他大写规则。

ap

使用 美联社风格手册 中发布的大写规则。这是默认值。

chicago

使用 芝加哥风格手册 中发布的大写规则。

go

大写每个单词的第一个字母。

firstupper

大写第一个单词的第一个字母。

none

禁用自动栏目标题的转换，并禁用 strings.Title 函数执行的转换。如果您希望根据需要手动大写栏目标题，并绕过主题对 strings.Title 函数的主观使用，这很有用。

本地化设置

某些配置设置（如菜单和自定义参数）可以针对每种语言单独定义。请参阅 配置语言。