#主题选项

本文列出 Lichtung 主题在 hugo.toml [params] 下的所有配置项。

各参数对应页面的哪个区域?参见布局图示

##站点信息

toml
[params]
subtitle = '林中空地'                # 副标题,显示在顶栏标题下方
description = 'Lichtung Hugo 主题示例站点,展示功能'       # 站点描述,显示在侧边栏
author = { name = 'Demo', email = 'demo@example.com' }
StartDate = '2023/06/23'                # 建站日期,侧边栏显示"已运行 X 天"
参数说明
subtitle顶栏标题下方的副标题
description侧边栏站点描述
author作者信息(name + email)
StartDate建站日期,格式 YYYY/MM/DD

##通用选项

参数默认值说明
DateFormat'2006/01/02'日期显示格式(Go 时间格式)
ShowContentinRSStrueRSS 中是否包含全文(false = 仅摘要)
commenttrue全局评论开关,单篇可覆盖
mathfalse全局 MathJax 开关,单篇可覆盖
LastChangeLink''Git 提交历史链接前缀(如 GitHub commit URL)
footer''页脚自定义文本
copyrightnc-sa默认 CC 协议后缀,单篇可覆盖

##侧边栏组件

每个组件独立开关:

参数说明
ShowSiteSearch搜索框(Fuse.js 全文搜索)
SearchPlaceHolder搜索框占位文字
ShowTaxonomyTree分类树
ShowFileTree文件树(content/ 目录结构),可设置文件树起点
ShowSiteNav侧边栏导航(menus.side
ShowSiteInfo站点信息面板
ShowSiteCountWords信息面板中的全站字数/篇数统计
ShowSiteCountTerms信息面板中的全站分类统计
ShowSiteLink外部链接列表

侧边栏本身可通过顶栏 ≡ 按钮整体切换显示/隐藏。

##章节页面列表选项

控制首页、章节页、标签页的文章列表。列表由两个独立选项控制:ListStyle(如何组织)与 ItemStyle(每项如何渲染)。

参数说明可选值
ListStyle列表组织方式'list', 'date', 'split'
ItemStyle每项渲染样式'card', 'simple'
ListLimit每页文章数上限数字或空(不限)
ShowList是否显示列表true, false
ShowSubSection是否显示子栏目true, false

ListStyle

效果
list平铺列表,逐条渲染所有文章
date按年月分组(归档风格),年份侧边栏导航
split分页显示,底部分页导航

ItemStyle(对所有 ListStyle 生效):

效果
card文章卡片,显示标题、日期、标签等 meta 信息
simple极简条目——只有标题链接、日期、摘要

date 样式的子选项:

参数说明
ShowCountWordsPerYear每年标题旁显示字数和篇数
ShowCountWordsPerMonth每月标题旁显示字数和篇数
ShowPostsPerYear每年标题旁显示篇数
ShowPostsPerMonth每月标题旁显示篇数

列表样式展示

##文章选项

参数默认值说明
ShowToctrue文章右侧目录(TOC)
ShowRelPosttrue相关文章推荐
HugoRelPosttrue使用 Hugo 内置相关内容引擎
HugoRelPostLimit10相关文章数量上限
ShowForwardLinktrue显示出链(本文链接到哪些页面)
ShowBackLinktrue显示入链(哪些页面链接到本文)
SearchContenttrue正文是否被搜索索引

出入链工作原理见 出入链功能演示

##首页选项

参数默认值说明
ShowAllPagesInHomefalsefalse = 仅显示 mainSections 中的文章
toml
mainSections = ['posts']   # 首页只显示 posts 栏目的文章

##归档页选项

参数默认值说明
ShowAllPagesInArchivetruetrue = 显示所有文章(不限栏目)

##特殊页面选项

参数默认值说明
ShowHeatMaptruelayout: about 页面显示写作热力图
ShowFiltertruelayout: indexes 页面显示 taxonomy 筛选器

##评论系统

Lichtung 支持四种评论系统,通过顶栏 radio 按钮切换。每个系统有独立开关和配置。

系统开关参数说明
CWDcwd自部署轻量评论系统
Walinewaline基于 LeanCloud 的评论系统
Twikootwikoo腾讯云/Zeabur 部署的评论系统
Giscusgiscus基于 GitHub Discussions
toml
# Waline
waline = true
walineserver = 'https://your-server.example.com'

# Twikoo
twikoo = true
twikooenvId = 'your-env-id'
twikoojs = 'https://cdn.jsdelivr.net/npm/twikoo@latest/dist/twikoo.all.min.js'

# Giscus
giscus = true
gcsdata = {
  repo = "user/repo",
  repoid = "R_kgDOxxx",
  category = "General",
  categoryid = "DIC_kwxxx",
  mapping = "title",
  position = "top",
  lang = "zh-CN"
}

##搜索

参数默认值说明
fuseOpts{ limit = 5, threshold = 0.1 }Fuse.js 搜索配置
PostPerTermLimit5分类页每 term 最多展示文章数

详见搜索功能索引与筛选

##外部链接与社交

toml
# 侧边栏链接列表(需 ShowSiteLink = true)
[[params.links]]
name = '文档'
url = 'https://docs.example.com'
description = '技术文档'

# 社交图标(显示在侧边栏底部)
[[params.social]]
name = 'github'
url = 'https://github.com/username'
icon = 'github'

[[params.social]]
name = 'rss'
url = '/index.xml'
icon = 'rss'

icon 可用值:github, bilibili, codeberg, gitlab, bitbucket, hugo, rss, mail 等(定义在 data/icons.yaml)。

自定义 CSS、图标和页脚见自定义与扩展

##Markdown 渲染选项

toml
[markup]
  [markup.tableOfContents]
  endLevel = 5              # 目录显示到第几级标题
  startLevel = 2            # 目录从第几级开始

  [markup.goldmark]
    [markup.goldmark.extensions]
    definitionList = true
    table = true
    taskList = true

    [markup.goldmark.extensions.extras]
    [markup.goldmark.extensions.extras.delete]
    enable = true           # ~~删除文本~~
    [markup.goldmark.extensions.extras.insert]
    enable = true           # ++插入文本++
    [markup.goldmark.extensions.extras.mark]
    enable = true           # ==标记文本==
    [markup.goldmark.extensions.extras.subscript]
    enable = true           # ~下标~
    [markup.goldmark.extensions.extras.superscript]
    enable = true           # ^上标^

    [markup.goldmark.extensions.passthrough]
    enable = true           # MathJax 数学公式
    [markup.goldmark.extensions.passthrough.delimiters]
    block = [['\[', '\]'], ['$$', '$$']]
    inline = [['\(', '\)']]

    [markup.goldmark.parser.attribute]
    block = true            # 块级属性 {#id .class}
    title = true            # 行内属性

    [markup.goldmark.renderer]
    unsafe = true           # 允许 HTML(主题必须)

渲染效果见 Markdown 功能展示

##Front Matter 参考

Lichtung 专有的 front matter 字段——所有字段可在单篇文章中覆盖全局设置:

字段类型说明
layoutstring布局模板(about, archive, indexes, home
summarystring文章摘要,显示在列表和 meta 中
weightint置顶权重,越大越靠前
statusstring文章状态标记(如 wip, done
aibool标记为 AI 生成内容,不计入字数统计
passwordstring密码保护(客户端弹窗)
mathbool启用 MathJax
commentbool是否显示评论
ShowTocbool是否显示目录
ShowRelPostbool是否显示相关文章
ShowForwardLinkbool是否显示出链
ShowBackLinkbool是否显示入链
ShowSiteSearchbool是否显示侧边栏搜索框
ShowTaxonomyTreebool是否显示侧边栏 taxonomy 树
ShowFileTreebool是否显示侧边栏文件树
ShowSiteNavbool是否显示侧边栏菜单
ShowSiteInfobool是否显示侧边栏站点信息
ShowSiteLinkbool是否显示侧边栏链接列表
ShowListbool是否在栏目列表中显示
ListStylestring列表组织方式(覆盖全局)
ItemStylestring每项渲染样式(覆盖全局)
ListLimitint列表上限(覆盖全局)
ShowSubSectionbool是否显示子栏目
HideInFileTreebool在侧边栏文件树中隐藏此页面
FileTreeRootstring文件树的根节点
rssbool是否包含在 RSS 中
SearchContentbool是否包含在搜索索引中
ShowContentinRSSboolRSS 是否包含全文
copyrightstring文章版权协议(覆盖全局)
CountWordsbool是否计入全站字数统计

实际用法见 选项示例