如示例站点所示,我们使用 Configuration Directory 为了维护更简单的组织和特定于环境的设置,它在多语言站点上特别有用。

站点配置

站点配置文件默认为 config/_default/config.toml

名称类型默认值说明
titleString-站点标题
baseURLString-站点 URL
copyrightString-站点版权。{year} 占位符会被替换为当前年份。
defaultContentLanguageStringen
defaultContentLanguageInSubdirBooleanfalse
paginateInteger10
paginatePathStringpage
enableRobotsTXTBooleantrue
disqusShortnameString-Disqus shortname。
googleAnalyticsString-Google Analytics.
socialObject-社交链接
authorObject-作者小部件

请参阅 All Configuration Settings

站点参数

站点参数文件默认为 config/_default/params.toml

名称类型默认值说明
Page
mainSectionsArray["posts"]主要的 sections
titleCaseBooleanfalse标题首字母是否大写
titleSeparatorString-标题分隔符
backgroundImageArray[]背景图,如:['/images/bg.png'], ['/images/bg-light.png', '/images/bg-dark.png']
commentBooleantrue是否开启评论
tocBooleantrue是否开启目录
tocPositionStringsidebar可选值:sidebarcontent,仅作用于 post 布局。
tocWordCountInteger280仅当文章的字数超过此值时,才会显示目录。
breadcrumbBooleantrue是否开启面包屑导航
breadcrumbDividerString/面包屑导航分隔符
dateFormatStringJan 2, 2006日期格式。 查阅 Hugo Date and Time Templating Reference 以获取详细信息。
poweredByBooleantrue是否显示技术支持。
readingTimeBooleantrue是否显示阅读时间
postDateBooleantrue是否显示发表日期
mathBooleanfalse是否开启 math
diagramBooleanfalse是否开启 diagram
logoString/Booleanimages/logo.webpLogo。设置为 false 以禁用 Logo。
brandString-Brand
descriptionString-站点描述
keywordsString-站点关键词
colorString-颜色风格, lightdark 或者 dynamic(默认)。
paletteString-默认配色,清理 Cookie 后生效。
palettesArrayALL可选配色,如需禁用此选项,可将其设为空值 []
featuredPostCountInteger/Boolean5精选文章数,false 则隐藏。
recentPostCountInteger/Boolean5最近文章数,false 则隐藏。
relatedPostCountInteger/Boolean5相关文章数,false 则隐藏。
categoryCountInteger/Boolean10分类数,false 则隐藏。
tagCountInteger/Boolean10标签数,false 则隐藏。
seriesCountInteger/Boolean10专栏数,false 则隐藏。
taxonomyPaginateInteger10
taxonomyPostCountInteger3分类的列表文章数,false 则隐藏。
taxonomySortingMethodString-分类排序方式,默认以字母排序。可选值:popularity
countTaxonomyPostsBooleanfalse显示分类的文章总数。
sidebarTaxonomiesArray["series", "categories", "tags"]侧边栏的分类。
fullWidthBoolean/Objectfalse是否全宽
fullWidth.{section}Boolean-为特定的 section 定义全宽,如:posts, docs
fixedHeaderBooleantrue是否固定头部
rewardObject-打赏小部件 ,又称 Buy Me a Coffee 小部件。
shareObject-分享按钮
share.addThisString-AddThis pubid
fontSizeObject字体大小注释或删除此参数可以禁用字体大小切换器。
fontSize.smallString.9rem小字体
fontSize.extraSmallString.8rem更小的字体
fontSize.largeString1.1rem大字体
fontSize.extraLargeString1.2rem更大的字体
socialShareBooleantrue启用/禁用内置的分享按钮
searchBarBooleantrue启用/禁用搜索栏
Archive
archiveObject-归档
searchObject-搜索
Webmaster Site Verification
siteVerificationObject-
siteVerification.googleString-Google
siteVerification.bingString-Bing
siteVerification.baiduString-百度
siteVerification.baiduUnionString-百度联盟
siteVerification.soString-360
siteVerification.sogouString-搜狗
siteVerification.shenmaString-神马
Analytics
analyticsObject-Analytics.
analytics.baiduString-百度统计
Others
googleAdsenseString-Google Adsense。
customCSSArray-自定义 CSS, 主要用于导入外部。 请查阅自定义资源
customJSArray-自定义 JS, 主要用于导入外部 JS。 请查阅自定义资源
utterancesObject-Utterances 配置。
Creative Commons License
creativeCommonsObject-
creativeCommons.byBooleantrue署名
creativeCommons.ncBooleantrue非商业
creativeCommons.ndBooleantrue禁止演绎
creativeCommons.saBooleantrue相同方式共享
Code Block
codeBlockObject-
codeBlock.maxLinesInteger7
codeBlock.lineNosBooleantruetrue/false 表示默认情况下显示/隐藏行号。
Post
postObject-
post.excerptStringSummary可选项:description
post.excerptMaxLengthInteger320
post.copyrightBooleantrue是否在每个帖子上显示版权部分
post.plainifyExcerptBooleantruefalse 则格式化摘要为 HTML。
post.featuredImageBooleanfalse于内容上方显示 Featured 图片。
post.numberifyHeadingsBooleanfalse是否自动对标题进行编号。
post.numberifyHeadingsEndLevelNumber6自动编号的深度。
post.numberifyHeadingsSeparatorString-编号和标题之间的分隔符。
post.tocStyleTypeStringnone目录的 list-style-type CSS 属性。
viewerBooleantrue图片查看器
pwaObject-渐进式 web 应用
Sidebar
sidebarObject-
sidebar.fixedBooleanfalse固定默认侧边栏。
sidebar.archiveBooleantrue于侧边栏显示归档挂件。
Meta Tag
metaRobotsString-空字符串表示禁用。
contactObject-联系表单
pinnedPostBooleantrue开启/禁用文章置顶。
pinnedPostCountInteger1置顶的文章数量。
rssString/Booleantrue在社交链接中显示 RSS 链接。false 为不显示,home 则总是链接到主页。

除了 Google 站长工具外,其他搜索引擎站长工具无法与 hugo --minify 同时使用,这是因为它们无法识别优化后的元标签。

页面参数

页面参数位于 Front Matter

名称类型默认值说明
Page
descriptionString-页面描述
keywordsArray-页面关键词
commentBooleantrue是否开启评论,如果评论已被全局关闭,该参数无效
tocBooleantrue是否开启目录,如果目录已被全局关闭,该参数无效
mathBooleanfalse是否开启 math
diagramBooleanfalse是否开启 diagram
rewardBooleantrue是否开启打赏
breadcrumbBooleantrue是否开启面包屑导航
readingTimeBooleantrue是否显示阅读时间
postDateBooleantrue是否显示发表日期
copyrightBooleantrue是否显示版权部分
carouselBooleanfalse是否在 Carousel 显示
Creative Commons License
creativeCommonsObject-
creativeCommons.byBooleantrue署名
creativeCommons.ncBooleantrue非商业
creativeCommons.ndBooleantrue禁止演绎
creativeCommons.saBooleantrue相同方式共享
Meta Tag
metaRobotsString-空字符串表示禁用。
pinnedBooleanfalse置顶文章。
featuredPostCountInteger/Boolean5精选文章数,false 则隐藏。
recentPostCountInteger/Boolean5最近文章数,false 则隐藏。
relatedPostCountInteger/Boolean5相关文章数,false 则隐藏。