配置

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

站点配置

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

名称 类型 默认值 说明
title String - 站点标题
baseURL String - 站点 URL
copyright String - 站点版权。{year} 占位符会被替换为当前年份。
defaultContentLanguage String en
defaultContentLanguageInSubdir Boolean false
paginate Integer 10
paginatePath String page
enableRobotsTXT Boolean true
disqusShortname String - Disqus shortname。
googleAnalytics String - Google Analytics.
social Object - 社交链接
author Object - 作者小部件

请参阅 All Configuration Settings

站点参数

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

名称 类型 默认值 说明
Page
mainSections Array ["posts"] 主要的 sections
titleCase Boolean false 标题首字母是否大写
titleSeparator String - 标题分隔符
comment Boolean true 是否开启评论
toc Boolean true 是否开启目录
tocWordCount Integer 280 仅当文章的字数超过此值时,才会显示目录。
breadcrumb Boolean true 是否开启面包屑导航
dateFormat String Jan 2, 2006 日期格式。 查阅 Hugo Date and Time Templating Reference 以获取详细信息。
poweredBy Boolean true 是否显示技术支持。
readingTime Boolean true 是否显示阅读时间
postDate Boolean true 是否显示发表日期
math Boolean false 是否开启 math
diagram Boolean false 是否开启 diagram
logo String/Boolean images/logo.webp Logo。设置为 false 以禁用 Logo。
brand String - Brand
description String - 站点描述
keywords String - 站点关键词
color String - 颜色风格, lightdark 或者 dynamic(默认)。
palette String - 默认配色,清理 Cookie 后生效。
palettes Array ALL 可选配色,如需禁用此选项,可将其设为空值 []
featuredPostCount Integer/Boolean 5 精选文章数,false 则隐藏。
recentPostCount Integer/Boolean 5 最近文章数,false 则隐藏。
relatedPostCount Integer/Boolean 5 相关文章数,false 则隐藏。
categoryCount Integer/Boolean 10 分类数,false 则隐藏。
tagCount Integer/Boolean 10 标签数,false 则隐藏。
seriesCount Integer/Boolean 10 专栏数,false 则隐藏。
taxonomyPaginate Integer 10
taxonomyPostCount Integer 3 分类的列表文章数,false 则隐藏。
countTaxonomyPosts Boolean false 显示分类的文章总数。
sidebarTaxonomies Array ["series", "categories", "tags"] 侧边栏的分类。
fullWidth Boolean false 是否全宽
fixedHeader Boolean true 是否固定头部
reward Object - 打赏小部件 ,又称 Buy Me a Coffee 小部件。
share Object - 分享按钮
share.addThis String - AddThis pubid
fontSize Object 字体大小 注释或删除此参数可以禁用字体大小切换器。
fontSize.small String .9rem 小字体
fontSize.extraSmall String .8rem 更小的字体
fontSize.large String 1.1rem 大字体
fontSize.extraLarge String 1.2rem 更大的字体
socialShare Boolean true 启用/禁用内置的分享按钮
searchBar Boolean true 启用/禁用搜索栏
Archive
archive Object - 归档
search Object - 搜索
Webmaster Site Verification
siteVerification Object -
siteVerification.google String - Google
siteVerification.bing String - Bing
siteVerification.baidu String - 百度
siteVerification.baiduUnion String - 百度联盟
siteVerification.so String - 360
siteVerification.sogou String - 搜狗
siteVerification.shenma String - 神马
Analytics
analytics Object - Analytics.
analytics.baidu String - 百度统计
Others
googleAdsense String - Google Adsense。
customCSS Array - 自定义 CSS, 主要用于导入外部。 请查阅自定义资源
customJS Array - 自定义 JS, 主要用于导入外部 JS。 请查阅自定义资源
utterances Object - Utterances 配置。
Creative Commons License
creativeCommons Object -
creativeCommons.by Boolean true 署名
creativeCommons.nc Boolean true 非商业
creativeCommons.nd Boolean true 禁止演绎
creativeCommons.sa Boolean true 相同方式共享
Code Block
codeBlock Object -
codeBlock.maxLines Integer 7
codeBlock.lineNos Boolean true true/false 表示默认情况下显示/隐藏行号。
Post
post Object -
post.excerpt String Summary 可选项:description
post.excerptMaxLength Integer 320
post.copyright Boolean true 是否在每个帖子上显示版权部分
post.plainifyExcerpt Boolean true false 则格式化摘要为 HTML。
viewer Boolean true 图片查看器
pwa Object - 渐进式 web 应用
Meta Tag
metaRobots String - 空字符串表示禁用。
contact Object - 联系表单
pinnedPost Boolean true 开启/禁用文章置顶。
pinnedPostCount Integer 1 置顶的文章数量。

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

页面参数

页面参数位于 Front Matter

名称 类型 默认值 说明
Page
description String - 页面描述
keywords Array - 页面关键词
comment Boolean true 是否开启评论,如果评论已被全局关闭,该参数无效
toc Boolean true 是否开启目录,如果目录已被全局关闭,该参数无效
math Boolean false 是否开启 math
diagram Boolean false 是否开启 diagram
reward Boolean true 是否开启打赏
breadcrumb Boolean true 是否开启面包屑导航
readingTime Boolean true 是否显示阅读时间
postDate Boolean true 是否显示发表日期
copyright Boolean true 是否显示版权部分
Creative Commons License
creativeCommons Object -
creativeCommons.by Boolean true 署名
creativeCommons.nc Boolean true 非商业
creativeCommons.nd Boolean true 禁止演绎
creativeCommons.sa Boolean true 相同方式共享
Meta Tag
metaRobots String - 空字符串表示禁用。
pinned Boolean false 置顶文章。

版权

评论