Relearn - 全局配置
Relearn全局配置
[params]
additionalContentLanguage = ['en']
alwaysopen = ''
breadcrumbSeparator = '>'
collapsibleMenu = true
customMathJaxURL = ''
customMermaidURL = ''
customOpenapiURL = ''
description = 'Documentation for Hugo Relearn Theme'
disableAssetsBusting = false
disableBreadcrumb = false
disableExplicitIndexURLs = false
disableGeneratorVersion = false
disableHoverBlockCopyToClipBoard = false
disableInlineCopyToClipBoard = true
disableLandingPageButton = true
disableLanguageSwitchingButton = false
disableMathJax = true
disableMermaid = true
disableNextPrev = false
disableOpenapi = true
disableRandomIds = false
disableRootBreadcrumb = true
disableSearch = false
disableSearchHiddenPages = false
disableSeoHiddenPages = true
disableShortcutsTitle = false
disableTagHiddenPages = false
disableTermBreadcrumbs = false
disableToc = false
editURL = 'https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/${FilePath}'
externalLinkTarget = '_blank'
highlightWrap = true
images = ['images/hero.png']
mathJaxInitialize = '{}'
mermaidInitialize = '{ "securityLevel": "loose" }'
mermaidZoom = true
ordersectionsby = 'weight'
showVisitedLinks = true
themeVariantModifier = ''
titleSeparator = '::'
[params.author]
name = 'Sören Weber'
[params.image]
errorlevel = 'warning'
[params.imageEffects]
border = true
lazy = true
lightbox = true
shadow = false
[params.link]
errorlevel = 'warning'
[params.social]
facebook_admin = ''
twitter = ''
[[params.themeVariant]]
auto = []
identifier = 'relearn-auto'
name = 'Relearn Light/Dark'
[[params.themeVariant]]
identifier = 'relearn-light'
[[params.themeVariant]]
identifier = 'relearn-dark'
[[params.themeVariant]]
identifier = 'relearn-bright'
[[params.themeVariant]]
auto = ['zen-light', 'zen-dark']
identifier = 'zen-auto'
name = 'Zen Light/Dark'
[[params.themeVariant]]
identifier = 'zen-light'
[[params.themeVariant]]
identifier = 'zen-dark'
[[params.themeVariant]]
identifier = 'neon'
[[params.themeVariant]]
identifier = 'learn'
[[params.themeVariant]]
identifier = 'blue'
[[params.themeVariant]]
identifier = 'green'
[[params.themeVariant]]
identifier = 'red'使用翻译引擎翻译结果如下:
[params]
# 多语言内容。
# 默认值:未设置
# 如果您的页面包含除主要语言之外的其他语言,请在此处添加所有这些辅助语言。
# 这将创建一个具有对您网站使用的所有语言的支持的搜索索引。
# 例如,如果您正在西班牙语中编写,并且网页上有很多源代码,通常使用英文术语。
additionalContentLanguage = ['zh-cn','zh-tw']
# 子菜单的初始展开状态。
# 默认值:未设置
# 这控制是否在菜单中展开子菜单。如果未设置,则第一个菜单级别设置为false,所有其他级别设置为true。
# 这可以在页面的前端元数据中重写。
# 如果显示的页面有子菜单,无论此选项如何,它们都将始终展开显示。
alwaysopen = ''
# 面包屑分隔符。
# 默认值:">"
# 更改顶部面包屑区域以及搜索结果和术语页面中使用的面包屑分隔符。
breadcrumbSeparator = '>'
# 显示子菜单的展开器。
# 默认值:false
# 如果设置为true,则侧边栏中的子菜单将以可折叠的树形视图显示,并在条目前设置可点击的展开器。
# 这可以在页面的前端元数据中重写。
collapsibleMenu = true
# 外部 MathJax 库的 URL。
# 默认值:未设置
# 指定 MathJax 库的远程位置。默认情况下将使用提供的版本。
# 这可以在页面的前端元数据中覆盖。
# "https://unpkg.com/mathjax/es5/tex-mml-chtml.js"
customMathJaxURL = 'https://unpkg.com/mathjax/es5/tex-mml-chtml.js'
# 外部 Mermaid 库的 URL。
# 默认值:未设置
# 指定 Mermaid 库的远程位置。默认情况下将使用提供的版本。
# 这可以在页面的前端元数据中覆盖。
# "https://unpkg.com/mermaid/dist/mermaid.min.js"
customMermaidURL = 'https://unpkg.com/mermaid/dist/mermaid.min.js'
# 外部 OpenAPI 库的 URL。
# 默认值:未设置
# 指定 OpenAPI 库的远程位置。默认情况下将使用提供的版本。
# 这可以在页面的前端元数据中覆盖。
# "https://unpkg.com/swagger-ui-dist/swagger-ui-bundle.js"
customOpenapiURL = 'https://unpkg.com/swagger-ui-dist/swagger-ui-bundle.js'
# 网站的描述。
# 默认值:未设置
# 用于生成 HTML meta 标签、opengraph 协议和 Twitter 卡片的社交媒体元信息。
# 这可以在页面的前端元数据中重写。
description = 'OriginStar WEB'
# 避免构建时新的资产 URL。
# 默认值:false
# 默认情况下,JavaScript 文件和 CSS 文件在每次重建时都会获得唯一的 ID。
# 这确保用户始终拥有最新版本,而不是浏览器缓存中的一些过期副本。
# 无论如何,在某些情况下关闭此功能可能是有益的。例如,如果您运行 Hugo 的开发服务器。
# 一些代理也不喜欢这种优化。
disableAssetsBusting = false
# 隐藏面包屑导航。
# 默认值:false
# 如果隐藏了面包屑导航,仍然会显示顶部栏中显示的页面标题。
disableBreadcrumb = false
# 以 Hugo 方式生成链接 URL。
# 默认值:false
# 如果设置为 true,则主题的行为类似于标准的 Hugo 安装,并且不会在 prettyURLs 中追加 index.html。作为一个权衡,您的构建项目将无法从文件系统中提供。
disableExplicitIndexURLs = false
# 避免生成器 meta 标签。
# 默认值:false
# 如果要禁用 Hugo 和主题在 HTML head 中生成的 generator meta 标签,将其设置为 true。
# 在这种情况下,还请不要忘记设置 Hugo 的 disableHugoGeneratorInject=true。
# 否则,Hugo 将在您的首页上生成一个 meta 标签。
disableGeneratorVersion = true
# 始终显示代码块的复制到剪贴板。
# 默认值:false
# 主题仅在您悬停在代码块上时才显示复制到剪贴板按钮。设置为true以禁用悬停效果,并始终显示按钮。
disableHoverBlockCopyToClipBoard = false
# 隐藏内联代码的复制到剪贴板。
# 默认值:false
# 这将从您的内联代码中删除复制到剪贴板按钮。
disableInlineCopyToClipBoard = true
# 隐藏主页入口。
# 默认值:false
# 如果显示,主页按钮将出现在搜索栏和主菜单下方。
# 它链接到当前语言的主页。
disableLandingPageButton = true
# 隐藏语言切换器。
# 默认值:false
# 如果配置了多个语言,将在菜单底部显示语言切换器。
# 此选项允许您显式关闭此行为。
disableLanguageSwitchingButton = false
# 仅在需要时加载 MathJax。
# 默认值:true
# 如果找到一个 Math shortcode,选项将被忽略,并且无论如何都会加载 MathJax。该选项仍然在您使用脚本设置图形时很有用。在这种情况下,没有 shortcode 或 codefence 参与,库不会默认加载。在这种情况下,您可以在页面的前端元数据中设置 `disableMathJax=false` 来强制加载库。
# 这可以在页面的前端元数据中覆盖
disableMathJax = true
# 仅在需要时加载 Mermaid。
# 默认值:true
# 如果找到 Mermaid shortcode 或 codefence,则该选项将被忽略,并且无论如何都会加载 Mermaid。该选项仍然在您使用脚本设置图形时很有用。在这种情况下,没有 shortcode 或 codefence 参与,库不会默认加载。在这种情况下,您可以在页面的前端元数据中设置 `disableMermaid=false` 来强制加载库。
# 这可以在页面的前端元数据中覆盖。
disableMermaid = true
# 隐藏下一个和上一个导航按钮。
# 默认值:false
# 如果隐藏导航按钮,键盘快捷键也会被禁用。
disableNextPrev = false
# 仅在需要时加载 OpenAPI。
# 默认值:true
# 如果找到一个 OpenAPI shortcode,则该选项将被忽略,并且无论如何都会加载 OpenAPI。该选项仍然在您使用脚本设置图形时很有用。在这种情况下,没有 shortcode 或 codefence 参与,库不会默认加载。在这种情况下,您可以在页面的前端元数据中设置 `disableOpenapi=false` 来强制加载库。
# 这可以在页面的前端元数据中覆盖。
disableOpenapi = true
# 避免唯一 ID。
# 默认值:false
# 在各种情况下,主题生成非稳定的唯一 ID,用于 HTML 片段链接。
# 例如,当测试输出是否发生变化时,这可能是不希望的。
# 如果禁用了随机 ID 生成,主题可能不再正确工作。
disableRandomIds = false
# 隐藏根面包屑。
# 默认值:false
# 根面包屑通常是您站点的首页。因为通过点击标志始终可以访问它,所以您可能希望通过将其从面包屑中移除来减少杂乱。
disableRootBreadcrumb = true
# 隐藏搜索框。
# 默认值:false
# 如果搜索框被禁用,则搜索功能也会被禁用。
# 这也会导致键盘快捷键被禁用,并且专用的搜索页面不会被链接,尽管它可能已经配置。
disableSearch = false
# 从搜索中隐藏隐藏页面。
# 默认值:false
# 从搜索框和专用搜索页面的建议中隐藏隐藏页面。
disableSearchHiddenPages = false
# 对网络爬虫隐藏隐藏页面。
# 默认值:false
# 避免隐藏页面显示在站点地图和 Google(等等)上,否则它们可能会被搜索引擎索引。
disableSeoHiddenPages = true
# 隐藏快捷菜单上方的标题。
# 默认值:false
# 标题的标题可以在您的 i18n 文件中重写。查看 Hugo 文档如何做到这一点。
disableShortcutsTitle = false
# 对分类标签隐藏隐藏页面。
# 默认值:false
# 隐藏页面不会显示在分类和术语页面上。如果这会将术语计数器减少为零,则将创建一个空但未链接的术语页面。
disableTagHiddenPages = false
# 隐藏术语页面包屑。
# 默认值:false
# 如果您有很多术语,则术语页面上的面包屑可能会让您感到杂乱,因此这是关闭术语页面上的面包屑的选项。然后仅在术语页面上显示页面标题。
disableTermBreadcrumbs = false
# 隐藏目录按钮。
# 默认值:false
# 如果目录按钮被隐藏,键盘快捷键也会被禁用。
# 这可以在页面的前端元数据中重写。
disableToc = false
# 编辑页面的 URL 前缀。
# 默认值:未设置
# 如果设置了,将在顶部栏显示编辑按钮。如果隐藏了按钮,
# 也会禁用键盘快捷键。该值可以包含`${FilePath}`宏,
# 它将被您显示的页面的文件路径替换。
# 如果在值中没有`${FilePath}`,则该值被视为`${FilePath}`附加到末尾的值。
# 这可以在页面的前端元数据中重写。如果要让人们有机会为您的内容创建合并请求,
# 这是有用的。
editURL = ''
# 如何打开外部链接。
# 默认值:"_blank"
# 对于外部链接,您可以定义它们在浏览器中如何打开。所有 HTML `a` 元素的 `target` 属性的值都被允许。默认值会在一个单独的浏览器标签中打开外部链接。如果您希望在同一个标签中打开这些链接,请使用 "_self"。
externalLinkTarget = '_blank'
# 代码块的换行。
# 默认值:true
# 默认情况下,如果代码块的行太长而无法在屏幕上显示,则代码块的行会环绕。如果您不喜欢这种行为,则可以在此处重新配置它。
# 请注意,在打印模式下,行始终会环绕,而不管此选项如何设置。
# 这可以在页面的前端元数据中重写,也可以作为参数给出给单个代码块。
highlightWrap = true
# 网站的社交媒体图片。
# 默认值:未设置
# 用于为 opengraph 协议和 Twitter 卡片生成社交媒体元信息。
# 这可以在页面的前端元数据中重写。
images = ['']
# MathJax 的初始化选项。
# 默认值:未设置
# 一个 JSON 值。请参阅 MathJax 文档以获取可能的参数。
# 这可以在页面的前端元数据中覆盖。
mathJaxInitialize = '{}'
# Mermaid 的初始化选项。
# 默认值:未设置
# 一个 JSON 值。请参阅 Mermaid 文档以获取可能的参数。
# 这可以在页面的前端元数据中覆盖。
mermaidInitialize = '{ "securityLevel": "loose" }'
# 使图表可平移和缩放。
# 默认值:false
# 对于庞大的图表,使其可缩放可能很有帮助。可缩放的图表配有一个重置缩放的按钮。
# 这可以在页面的前端元数据中覆盖,也可以作为参数给予单个图表。
mermaidZoom = true
# 主菜单子菜单的顺序。
# 默认值:"weight"
# 子菜单可以按"weight"、"title"、"linktitle"、"modifieddate"、"expirydate"、"publishdate"、"date"、"length"或"default"(遵循 Hugo 的默认排序顺序)排序。
# 这可以在页面的前端元数据中重写。
ordersectionsby = 'linktitle'
# 显示主菜单已访问页面的复选标记。
# 默认值:false
# 这也会导致在菜单的底部显示"清除历史记录"条目以删除所有复选标记。
# 如果重新生成站点,则会删除所有复选标记,因为ID不稳定。
showVisitedLinks = true
# 变体文件的文件名后缀。
# 默认值:未设置
# 主题在构建过程中修改变体样式表,并尝试以相同的文件名存储它们。
# 在某些安装中观察到,由于权限问题,Hugo 无法覆盖这些文件。
# 如果您遇到此问题,可以首先尝试为 Hugo 设置 `--noChmod` 选项。
# 如果这仍然没有帮助,您可以将此选项设置为例如 ".gen"。
themeVariantModifier = ''
# 标题分隔符。
# 默认值:"::"
# 更改在将页面标题与站点标题连接时使用的标题分隔符。这在主题中一致使用。
titleSeparator = '::'
# 网站的作者。
# 默认值:未设置
# 这将用于 HTML meta 标签、opengraph 协议和 Twitter 卡片。
# 如果您想发布此信息,还可以设置 `author.email`。
[params.author]
name = 'OriginStar'
[params.image]
errorlevel = ''
[params.imageEffects]
border = true
lazy = true
lightbox = true
shadow = false
[params.link]
errorlevel = 'warning'
[params.social]
facebook_admin = ''
twitter = ''
[[params.themeVariant]]
identifier = 'dream'
name = 'Dream'
[[params.themeVariant]]
auto = []
identifier = 'relearn-auto'
name = 'Relearn Light/Dark'
[[params.themeVariant]]
identifier = 'relearn-light'
[[params.themeVariant]]
identifier = 'relearn-dark'
[[params.themeVariant]]
identifier = 'relearn-bright'
[[params.themeVariant]]
auto = ['zen-light', 'zen-dark']
identifier = 'zen-auto'
name = 'Zen Light/Dark'
[[params.themeVariant]]
identifier = 'zen-light'
[[params.themeVariant]]
identifier = 'zen-dark'
[[params.themeVariant]]
identifier = 'neon'
[[params.themeVariant]]
identifier = 'learn'
[[params.themeVariant]]
identifier = 'blue'
[[params.themeVariant]]
identifier = 'green'
[[params.themeVariant]]
identifier = 'red'
[outputs]
# 在首页添加 JSON 以支持 Lunr 搜索;这是必需的设置
# 用于搜索功能
# 将 PRINT 添加到主页、部分和页面以激活打印整个的功能
# 章节
home = ["html", "rss", "print", "search", "searchpage"]
section = ["html", "rss", "print"]
page = ["html", "rss", "print"]
[markup]
[markup.highlight]
# 如果代码换行,表格布局中的行号将会移位,因此最好使用内联;此外,从视觉上看,这两种布局具有相同的外观和行为
lineNumbersInTable = true
# 预装的变体带有自己修改过的 chroma 语法高亮样式,这些样式被导入到 theme-relearn-light.css、theme-relearn-dark.css 等中;
# 如果您想要使用预定义的样式:
# - 删除 `noClasses` 或将 `noClasses = true`
# - 将 `style` 设置为预定义的样式名称
noClasses = true
#简码使用语法荧光笔呈现您的代码,详情参阅:https://gohugo.io/functions/highlight/
style = "gruvbox"
[markup.goldmark.renderer]
unsafe = true
[languages]
[languages.zh-cn]
title = "Welcome"
weight = 1
languageName = "简体中文"
[languages.zh-tw]
title = "Welcome"
weight = 2
languageName = "繁体中文"
[[menu.shortcuts]]
name = "<i class='fas fa-info-circle'></i> About"
url = "/about"
weight = 10
[[menu.shortcuts]]
name = "<i class='fas fa-star'></i> Relearn Theme"
identifier = "hugo_theme_relearn"
url = "https://github.com/McShelby/hugo-theme-relearn"
weight = 20
[[menu.shortcuts]]
name = "<i class='fas fa-fw fa-bookmark'></i> Hugo Documentation"
identifier = "hugodoc"
url = "https://gohugo.io/"
weight = 30
[[menu.shortcuts]]
name = "<i class='fas fa-fw fa-tags'></i> Tags"
url = "/tags"
weight = 40
[[menu.shortcuts]]
name = "<i class='fas fa-list'></i> Categories"
url = "/categories"
weight = 50