... visits
本篇文档是对 hugo.toml 中主要参数的说明。
网站Head部分是指网站的 <head> 标签中，包括 <title>、<meta> 需要配置的信息。
网站标题是指打开网站时在浏览器标签页看到的名字
title = 'Seven的个人网站'
[Params]
description = "Seven Demo"
[Params.app]
...
# 是否配置 favicon
noFavicon = false
# 使用的现代SVG favicon，用于替换旧式的.png和.ico文件
svgFavicon = "/favicon.svg"
iconColor = "#ffffff"
themeColor = "#ffffff"
favicon 相关文件需要放在 static 目录下
favicon 相关文件可以到 RealFaviconGenerator 网站直接生成
只需要配置name和url，weight表示排序权重，weight越小越靠前，pre参数暂时不支持
[menu]
...
[[menu.main]]
name = "Posts"
pre = ""
url = "/posts/"
weight = 30
子菜单需要配置参数 parent, 表示父菜单的名称。如 ② 所示
如果导航栏中有多个子菜单，且子菜单中的名字跟其他子菜单的名字重复，需要配置 identifier 参数来区分，如 ① 所示
[menu]
...
[[menu.main]]
name = "Releases"
pre = "releases"
weight = 50
[[menu.main]]
identifier = "v1.0.0" # ①
name = 'v1.0.0'
url = ''
parent = 'Releases' # ②
weight = 1
[[menu.main]]
name = 'v0.1.13'
url = ''
parent = 'Releases'
weight = 2
主题支持一键配置分类菜单按钮添加到导航栏中
[Params]
...
# 是否忽略分类菜单
omitCategoryOnMenu = false
categoryName = "Category"
网站的Logo支持直接是文字形式及图片形式
主题更加推荐使用图片形式的 Logo
[Params.logo]
...
text = "Seven"
logo 的图片需要存放在static目录下，建议使用 svg 格式和 png 格式的图片。
同时为了在 dark 模式下更好的显示效果，建议单独配置一个 dark 版本的
logo 图片的高度和宽度支持自定义，默认高度为 56px，宽度为 130px，且高度不能超过 56px
[Params.logo]
img = "/images/logo.svg"
img_dark = "/images/logo-footer.svg"
# max height not greater than 56 (px). default: 56 (px)
customLogoHeight = '56'
customLogoWidth = '120'
目前只支持 Algolia 搜索。如果不想启用搜索功能，可以关闭，配置参数为：
[Params]
...
enableSearch = false
[Params.algolia]
...
app_id = "your algolia app id"
api_key = "your algolia api key"
index = "your algolia index name"
snippet_attr = "description"
highlight_attr = "title"
snippet_attr 和 highlight_attr 配置 Algolia 搜索结果中显示的内容属性。具体可以参考
snippet
和
highlight
。
[Params.algolia]
type = ["posts", "doc"]
vars = ["title", "description", "permalink"]
params = ["tags"]
...
type参数: 表示你想站点的什么内容允许上传到 Algolia。在站点的 content 目录下，你创建的目录名就是 type，比如，你创建的目录名为 post，那么type就是 post。具体值可以参考
Hugo content typesvars参数：是 Hugo 中文章的变量，表明你文章的哪部分允许上传到 Algolia。具体值可参考
Hugo page variablesparams参数：是 Hugo 的 Front matter 变量，作用类似于vars参数。具体值可参考
Hugo front matter在 Algolia 中显示这样：
主题支持直接生成 ndjson 格式的文件。
因主题推荐使用Algolia CLI工具上传文件到 Algolia。但Algolia CLI需要使用到 ndjson 格式文件，而不是 JSON 格式文件。
在站点根目录下执行以下命令：
hugo
然后在public目录下找到algolia.ndjson文件，将其上传到 Algolia。
algolia objects import 'your_index_name' -F ./public/algolia.ndjson -p 'your_prifile_name'
具体可以参考 Algolia CLI 官方文档 。
关于 Hugo 如何生成 ndjson 文件的说明，可以参考文章
在Hugo中如何直接输出ndjson格式文件并上传到Algolia
。
目前仅支持 Disqus 评论和 Waline 评论。
如果不想要评论功能，可以在主题的配置文件中关闭评论功能。
enableComments = false
disqusShortname = "your-disqus-shortname"
具体可以参考 Hugo Disqus 文档 。
[Params.waline]
...
serverURL = "your-waline-server-url"
lang = "en"
reaction = true
search = true
comment = true
...
使用 Waline 需要部署才可以使用，具体如何部署请参考 Waline 文档 。
Waline 提供了页面浏览量统计功能。
[Params.waline]
...
serverURL = "your-waline-server-url"
...
pageview = true
如果不想要使用 Waline 评论功能，但想使用 Waline 的浏览量统计功能，可以将 alonePageview 设置为 true：
[Params.waline]
alonePageview = true
serverURL = "your-waline-server-url"
...
pageview = true
具体可以参考 Waline pageview 文档 。
默认情况下，首页会显示IsPage=true且最近的4篇文章。如果需要自定义首页文章的内容，可以配置 showContentTypes 参数。
目前仅支持显示作者、发表日期、更新日期、文章字数、阅读时间、文章的 Hero 图和文章的目录。
[Params.articleMeta]
enableAuthor = false
disableDate = false
disableModifiedDate = false
disableCountWords = false
disableReadTime = false
disableHero = false
disableToc = false
[Params]
...
showCodeCopyButton = true
...
目前仅支持邮箱、Github、Facebook、X（原Twitter）和微信。
[Params.society]
...
[Params.society.email]
enable = true
url = "your-email-url"
[Params.society.github]
enable = true
url = "your-github-url"
[Params.society.facebook]
enable = true
url = "your-facebook-url"
[Params.society.x] # old twitter
enable = true
url = "your-x-url"
[Params.society.wechat]
enable = true
OrcodeUrl = ["微信二维码图片地址1", "微信二维码图片地址2"]
社交关系支持二维码的形式，比如个人微信二维码和公众号二维码。
主题支持的社交关系是有限的，但主题支持自定义添加社交关系。
[Params.society]
customSocial = "your_custom_social.html"
自定义的社交关系需要编写代码，并放置在layouts/partials/目录中。
可以参考Demo中代码，文件目录为 layouts/partials/extra_social.html。
如果主题一些样式不满足你的需求，可以通过自定义样式来满足。
[Params.head]
customCSS = "css/your_custom.css"
自定义的样式文件需要放在项目的assets目录中，不能放在static目录上。可以参考Demo的assets/css/custom.css。
