Kagome

🏠 HOME 🗂️ POSTS 😈 ABOUT 🔗 LINK

config.toml配置

2021-06-09 11:32

  • doc
  • config

config配置文件中配置可参考Hugo官方文档: Configure Hugo

这里主要补充kagome中所需要的一些配置项:

kagome所需的配置项都在config.toml中的[params]中。

导航栏

导航栏的定义放在menu中,目前支持menu.main和menu.social两种。

menu.main是页面顶部的主要导航栏,而menu.social则是页面底部的常用社交地址。

Menu的相关属性可以查看Hugo官方文档:menus

在menu.social中,目前只添加了[github, twitter, instagram, weibo, zhihu]这几个社交地址的Icon,采用的是svg,如果你要添加更多的社交地址,主要在<theme>/layouts/partials/footer.html自定义更多的社交图标。

添加一个GITHUB社交地址:

[menu]
  [[menu.social]]
    # 唯一标识符
    identifier = "github"
    # 名称
    name = "github"
    # url地址
    url = "https://github.com/miiiku"
    # 权重 越小越靠前
    weight = 1

基本配置项:

key type describe example
keywords array 站点关键词 [“hugo”, “theme”]
description string 站点描述 一个新的站点
mainSections array 主要内容sections [“posts”]
beian string 备案信息 xxxxxx
toc_show_len number 指定内容长度以后出现目录widget 200

其中如果没有配置mainSections,那么则会默认获取posts下的文章,所以如果没有配置mainSections请确保在content/posts下有内容

widget

widget小部件相关配置项在[params]下的[params.widget]中:

其中author小部件数据来源与config.toml下的author,它需要name,description,avatar这三个字段,如:

[author]
  name = "Sukoshi"
  email = "guanquanhong@163.com"
  description = "梅花鹿的角叫鹿角"
  avatar = "https://s.gravatar.com/avatar/7b5a0b07a98895278cfa862b1f32ae8f?s=200&r=g&d=retro"

其中articles小部件内容是根据当前文章Front Matter中的categories来查找最新的文章。

如果当前文章没有categories或者没有相关文章,则会去查找tags的相关文章。

如果也没有相关数据最终会去找当前文章sections下的最新文章。

key type default describe
articles_count number 6 相关文章widget条目数
categories_count number 6 分类widget条目数
tags_count number 12 标签widget条目数

aplayer 音乐播放器

aplayer相关配置项在[params]下的[params.aplayer]中:

具体的配置项描述可以查阅aplayer官方文档 aplayer文档地址

目前支持的相关参数如下

key default describe
theme ‘#b7daff’ 主题色
autoplay false 音频自动播放
loop ‘all’ 音频循环播放, 可选值: ‘all’, ‘one’, ‘none’
mutex true 互斥,阻止多个播放器同时播放,当前播放器播放时暂停其他播放器

dplayer 音乐播放器

dplayer相关配置项在[params]下的[params.dplayer]中:

具体的配置项描述可以查阅dplayer官方文档 dplayer文档地址

目前支持的相关参数如下

key default describe
theme ‘#b7daff’ 主题色
autoplay false 视频自动播放
loop false 视频循环播放
mutex true 互斥,阻止多个播放器同时播放,当前播放器播放时暂停其他播放器

Front Matter 相关参数说明

2021-06-18 09:29

播放音频与视频,shortcode使用说明

2021-05-26 11:32

Sukoshi

Sukoshi

梅花鹿的角叫鹿角

Toc

  • 导航栏
  • 基本配置项:
  • widget
  • aplayer 音乐播放器
  • dplayer 音乐播放器

Related Posts

  • 如何丰富Banner信息
  • i18n多语言配置
  • Front Matter 相关参数说明
  • 播放音频与视频,shortcode使用说明
  • 插入公式,图片与Widget目录显示

Categories

  • doc 6
  • syntax 1
  • test 1
  • themes 1

Tags

hugo markdown config css emoji html i18n image math music privacy shortcodes
show all

© 2021 Sukoshi.

Powered by Hugo Theme - kagome

🌞 light 🌛 dark 🤖️ auto