📝 Docs: update config documentations

This commit is contained in:
Cell
2022-05-19 10:31:02 +08:00
parent a067d7bcd0
commit d95541029c
2 changed files with 30 additions and 16 deletions
@@ -269,9 +269,9 @@ Please open the code block below to view the complete sample configuration :(fa-
# Header config
[params.header]
# desktop header mode ("sticky", "normal", "auto")
# {{< version 0.2.13 changed >}} desktop header mode ("sticky", "normal", "auto")
desktopMode = "sticky"
# mobile header mode ("sticky", "normal", "auto")
# {{< version 0.2.13 changed >}} mobile header mode ("sticky", "normal", "auto")
mobileMode = "auto"
# {{< version 0.2.0 >}} Header title config
[params.header.title]
@@ -285,6 +285,12 @@ Please open the code block below to view the complete sample configuration :(fa-
post = ""
# {{< version 0.2.5 >}} whether to use typeit animation for title name
typeit = false
# {{< version 0.2.12 >}} Header subtitle config
[params.header.subtitle]
# subtitle name
name = ""
# whether to use typeit animation for subtitle name
typeit = false
# Footer config
[params.footer]
@@ -303,6 +309,8 @@ Please open the code block below to view the complete sample configuration :(fa-
siteTime = '' # e.g. '2019-02-03T19:30:34+08:00'
# {{< version 0.2.14 >}} whether to show total word count of site content
wordCount = true
# {{< version 0.2.12 >}} Public network security only in China (HTML format is supported)
gov = ""
# ICP info only in China (HTML format is supported)
icp = ""
# license info (HTML format is supported)
@@ -556,7 +564,7 @@ Please open the code block below to view the complete sample configuration :(fa-
Skype = false
Trello = false
Mix = false
# {{< version 0.2.13 changed >}} Comment config
# {{< version 0.2.14 changed >}} Comment config
[params.page.comment]
enable = false
# {{< version 0.2.13 >}} {{< link "https://artalk.js.org/" Artalk >}} comment config (https://artalk.js.org/)
@@ -572,15 +580,13 @@ Please open the code block below to view the complete sample configuration :(fa-
maxNesting = 3
# It take effect when `params.page.lightgallery` is enabled
lightgallery = false
# {{< link "https://disqus.com/" Disqus >}} comment config (https://disqus.com)
# {{< version 0.1.1 >}} {{< link "https://disqus.com/" Disqus >}} comment config (https://disqus.com)
[params.page.comment.disqus]
# {{< version 0.1.1 >}}
enable = false
# Disqus shortname to use Disqus in posts
shortname = ""
# {{< link "https://github.com/gitalk/gitalk" Gitalk >}} comment config (https://github.com/gitalk/gitalk)
# {{< version 0.1.1 >}} {{< link "https://github.com/gitalk/gitalk" Gitalk >}} comment config (https://github.com/gitalk/gitalk)
[params.page.comment.gitalk]
# {{< version 0.1.1 >}}
enable = false
owner = ""
repo = ""
@@ -708,6 +714,11 @@ Please open the code block below to view the complete sample configuration :(fa-
# cursor duration after typing finishing (measured in milliseconds, "-1" means unlimited)
duration = -1
# {{< version 0.2.12 >}} PanguJS config
[params.pangu]
# For Chinese writing
enable = false
# {{< version 0.2.12 >}} Watermark config
# Detail config see https://github.com/Lruihao/watermark#readme
[params.watermark]
@@ -730,7 +741,7 @@ Please open the code block below to view the complete sample configuration :(fa-
rotate = 15
# watermark's fontSize. unit: rem
fontSize = 0.85
# watermark's fontFamily
# {{< version 0.2.13 >}} watermark's fontFamily
fontFamily = 'inherit'
# {{< version 0.2.12 >}} Busuanzi count
@@ -271,9 +271,9 @@ hugo
# 页面头部导航栏配置
[params.header]
# 桌面端导航栏模式 ("sticky", "normal", "auto")
# {{< version 0.2.13 changed >}} 桌面端导航栏模式 ("sticky", "normal", "auto")
desktopMode = "sticky"
# 移动端导航栏模式 ("sticky", "normal", "auto")
# {{< version 0.2.13 changed >}} 移动端导航栏模式 ("sticky", "normal", "auto")
mobileMode = "auto"
# {{< version 0.2.0 >}} 页面头部导航栏标题配置
[params.header.title]
@@ -566,7 +566,7 @@ hugo
Skype = false
Trello = false
Mix = false
# {{< version 0.2.13 changed >}} 评论系统设置
# {{< version 0.2.14 changed >}} 评论系统设置
[params.page.comment]
enable = false
# {{< version 0.2.13 >}} {{< link "https://artalk.js.org/" Artalk >}} 评论系统设置 (https://artalk.js.org/)
@@ -582,15 +582,13 @@ hugo
maxNesting = 3
# 当 `params.page.lightgallery` 启用时生效
lightgallery = false
# {{< link "https://disqus.com/" Disqus >}} 评论系统设置 (https://disqus.com)
# {{< version 0.1.1 >}} {{< link "https://disqus.com/" Disqus >}} 评论系统设置 (https://disqus.com)
[params.page.comment.disqus]
# {{< version 0.1.1 >}}
enable = false
# Disqus 的 shortname,用来在文章中启用 Disqus 评论系统
shortname = ""
# {{< link "https://github.com/gitalk/gitalk" Gitalk >}} 评论系统设置 (https://github.com/gitalk/gitalk)
# {{< version 0.1.1 >}} {{< link "https://github.com/gitalk/gitalk" Gitalk >}} 评论系统设置 (https://github.com/gitalk/gitalk)
[params.page.comment.gitalk]
# {{< version 0.1.1 >}}
enable = false
owner = ""
repo = ""
@@ -718,6 +716,11 @@ hugo
# 打字结束之后光标的持续时间(单位是毫秒,"-1" 代表无限大)
duration = -1
# {{< version 0.2.12 >}} 盘古之白配置
[params.pangu]
# 适用于中文写作用户
enable = false
# {{< version 0.2.12 >}} 水印配置
# 详细参数见 https://github.com/Lruihao/watermark#readme
[params.watermark]
@@ -740,7 +743,7 @@ hugo
rotate = 15
# 水印字体大小,单位:rem
fontSize = 0.85
# 水印字体
# {{< version 0.2.13 >}} 水印字体
fontFamily = 'inherit'
# {{< version 0.2.12 >}} 不蒜子统计