Hugo 所有設置
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) 是否為aliasesfront 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:localemeta元素
當存在於配置根目錄時，如果存在一個或多個語言鍵，則忽略此值。請為每個語言鍵單獨指定此值。
- 嵌入式 RSS 模板 中的
- 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
- 請參閱 配置媒體類型。
- 請參閱 配置菜單。
- 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。 - 請參閱 配置相關內容。
- relativeURLs
- (
bool) 在啟用此功能之前請參閱 詳情。默認值是false。 - removePathAccents
- (
bool) 是否從內容路徑中的 復合字符 中移除 非間距標記。默認值是false。 - renderSegments
- (
[]string) 要渲染的 段 切片。如果省略，將渲染所有段。此選項通常通過命令行標志設置，例如hugo --renderSegments segment1,segment2。提供的段名稱必須與segments配置中定義的對應。 - resourceDir
- (
string) 緩存 資產管道 輸出的指定目錄。默認值是resources。 - roles
- 請參閱 配置角色。
- security
- 請參閱 配置安全。
- (
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 將按以下優先順序使用：
- 如果在 Netlify 上運行：
/opt/build/cache/hugo_cache/。這意味著如果您在 Netlify 上運行構建，所有配置為:cacheDir的緩存將在下次構建時保存和恢復。對於其他 CI/CD 平台，請閱讀它們的文檔。有關 CircleCI 示例，請參閱 此配置。 - 在 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。 - 在操作系統臨時目錄下的
hugo_cache_$USER目錄中。
要確定當前的 cacheDir：
hugo config | grep cachedir標題大寫樣式
Hugo 的 titleCaseStyle 設置管理自動生成的欄目標題和 strings.Title 函數的大寫。默認情況下，它遵循美聯社風格手冊中發布的大寫規則。更改此設置以使用其他大寫規則。
- ap
- 使用 美聯社風格手冊 中發布的大寫規則。這是默認值。
- chicago
- 使用 芝加哥風格手冊 中發布的大寫規則。
- go
- 大寫每個單詞的第一個字母。
- firstupper
- 大寫第一個單詞的第一個字母。
- none
- 禁用自動欄目標題的轉換，並禁用
strings.Title函數執行的轉換。如果您希望根據需要手動大寫欄目標題，並繞過主題對strings.Title函數的主觀使用，這很有用。
本地化設置
某些配置設置（如菜單和自定義參數）可以針對每種語言單獨定義。請參閱 配置語言。