feat(typeit): add some config for TypeIt (#314)

2020-05-04 13:20:01 +08:00
parent 8c706548c7
commit e4c71edddf
16 changed files with 126 additions and 74 deletions
--- a/exampleSite/config.toml
+++ b/exampleSite/config.toml
@@ -656,7 +656,7 @@ enableEmoji = true
      # 你可以在名称 (允许 HTML 格式) 之后添加其他信息, 例如图标
      post = ""
      # whether to use typeit animation for title name
-      # 是否为副标题显示打字机动画
+      # 是否为标题显示打字机动画
      typeit = false

  # Footer config
@@ -914,6 +914,22 @@ enableEmoji = true
        width = 800
        height = 600

+  # TypeIt config
+  # TypeIt 配置
+  [params.typeit]
+    # typing speed between each step (measured in milliseconds)
+    # 每一步的打字速度 (单位是毫秒)
+    speed = 100
+    # blinking speed of the cursor (measured in milliseconds)
+    # 光标的闪烁速度 (单位是毫秒)
+    cursorSpeed = 1000
+    # character used for the cursor (HTML format is supported)
+    # 光标的字符 (支持 HTML 格式)
+    cursorChar = "|"
+    # cursor duration after typing finishing (measured in milliseconds, "-1" means unlimited)
+    # 打字结束之后光标的持续时间 (单位是毫秒, "-1" 代表无限大)
+    duration = -1
+
  # Site verification code for Google/Bing/Yandex/Pinterest/Baidu
  # 网站验证代码，用于 Google/Bing/Yandex/Pinterest/Baidu
  [params.verification]
@@ -980,7 +996,7 @@ enableEmoji = true
    clipboardJS = ""
    # sharer.js@0.4.0 https://github.com/ellisonleao/sharer.js
    sharerJS = ""
-    # typeit@6.5.1 https://github.com/alexmacarthur/typeit
+    # typeit@7.0.4 https://github.com/alexmacarthur/typeit
    typeitJS = ""
    # katex@0.11.1 https://katex.org/
    katexCSS = ""
--- a/exampleSite/content/posts/theme-documentation-basics.en.md
+++ b/exampleSite/content/posts/theme-documentation-basics.en.md
@@ -254,7 +254,7 @@ Please open the code block below to view the complete sample configuration :(far
      pre = ""
      # you can add extra information after the name (HTML format is supported), such as icons
      post = ""
-      # whether to use typeit animation for title name
+      # {{< version 0.2.5 >}} whether to use typeit animation for title name
      typeit = false

  # Footer config
@@ -317,7 +317,8 @@ Please open the code block below to view the complete sample configuration :(far
      enable = true
      # special amount of posts in each home posts page
      paginate = 6
-      # {{< version 0.2.0 deleted >}} default behavior when you don't set "hiddenFromHomePage" in front matter
+      # {{< version 0.2.0 deleted >}} replaced with hiddenFromHomePage in params.page
+      # default behavior when you don't set "hiddenFromHomePage" in front matter
      defaultHiddenFromHomePage = false

  # Social config about the author
@@ -550,6 +551,17 @@ Please open the code block below to view the complete sample configuration :(far
        width = 800
        height = 600

+  # {{< version 0.2.5 >}} TypeIt config
+  [params.typeit]
+    # typing speed between each step (measured in milliseconds)
+    speed = 100
+    # blinking speed of the cursor (measured in milliseconds)
+    cursorSpeed = 1000
+    # character used for the cursor (HTML format is supported)
+    cursorChar = "|"
+    # cursor duration after typing finishing (measured in milliseconds, "-1" means unlimited)
+    duration = -1
+
  # Site verification code config for Google/Bing/Yandex/Pinterest/Baidu
  [params.verification]
    google = ""
@@ -610,7 +622,7 @@ Please open the code block below to view the complete sample configuration :(far
    clipboardJS = ""
    # {{< link "https://github.com/ellisonleao/sharer.js" "sharer.js" >}}@0.4.0
    sharerJS = ""
-    # {{< link "https://github.com/alexmacarthur/typeit" "typeit" >}}@6.5.1
+    # {{< link "https://github.com/alexmacarthur/typeit" "typeit" >}}@7.0.4
    typeitJS = ""
    # {{< link "https://github.com/KaTeX/KaTeX" "katex" >}}@0.11.1
    katexCSS = ""
--- a/exampleSite/content/posts/theme-documentation-basics.fr.md
+++ b/exampleSite/content/posts/theme-documentation-basics.fr.md
@@ -259,7 +259,7 @@ Please open the code block below to view the complete sample configuration :(far
      pre = ""
      # you can add extra information after the name (HTML format is supported), such as icons
      post = ""
-      # whether to use typeit animation for title name
+      # {{< version 0.2.5 >}} whether to use typeit animation for title name
      typeit = false

  # Footer config
@@ -322,7 +322,8 @@ Please open the code block below to view the complete sample configuration :(far
      enable = true
      # special amount of posts in each home posts page
      paginate = 6
-      # {{< version 0.2.0 deleted >}} default behavior when you don't set "hiddenFromHomePage" in front matter
+      # {{< version 0.2.0 deleted >}} replaced with hiddenFromHomePage in params.page
+      # default behavior when you don't set "hiddenFromHomePage" in front matter
      defaultHiddenFromHomePage = false

  # Social config about the author
@@ -555,6 +556,17 @@ Please open the code block below to view the complete sample configuration :(far
        width = 800
        height = 600

+  # {{< version 0.2.5 >}} TypeIt config
+  [params.typeit]
+    # typing speed between each step (measured in milliseconds)
+    speed = 100
+    # blinking speed of the cursor (measured in milliseconds)
+    cursorSpeed = 1000
+    # character used for the cursor (HTML format is supported)
+    cursorChar = "|"
+    # cursor duration after typing finishing (measured in milliseconds, "-1" means unlimited)
+    duration = -1
+
  # Site verification code config for Google/Bing/Yandex/Pinterest/Baidu
  [params.verification]
    google = ""
@@ -615,7 +627,7 @@ Please open the code block below to view the complete sample configuration :(far
    clipboardJS = ""
    # {{< link "https://github.com/ellisonleao/sharer.js" "sharer.js" >}}@0.4.0
    sharerJS = ""
-    # {{< link "https://github.com/alexmacarthur/typeit" "typeit" >}}@6.5.1
+    # {{< link "https://github.com/alexmacarthur/typeit" "typeit" >}}@7.0.4
    typeitJS = ""
    # {{< link "https://github.com/KaTeX/KaTeX" "katex" >}}@0.11.1
    katexCSS = ""
--- a/exampleSite/content/posts/theme-documentation-basics.zh-cn.md
+++ b/exampleSite/content/posts/theme-documentation-basics.zh-cn.md
@@ -257,7 +257,7 @@ hugo
      pre = ""
      # 你可以在名称 (允许 HTML 格式) 之后添加其他信息, 例如图标
      post = ""
-      # 是否为副标题显示打字机动画
+      # {{< version 0.2.5 >}} 是否为标题显示打字机动画
      typeit = false

  # 页面底部信息配置
@@ -320,7 +320,8 @@ hugo
      enable = true
      # 主页每页显示文章数量
      paginate = 6
-      # {{< version 0.2.0 deleted >}} 当你没有在文章前置参数中设置 "hiddenFromHomePage" 时的默认行为
+      # {{< version 0.2.0 deleted >}} 被 params.page 中的 hiddenFromHomePage 替代
+      # 当你没有在文章前置参数中设置 "hiddenFromHomePage" 时的默认行为
      defaultHiddenFromHomePage = false

  # 作者的社交信息设置
@@ -553,6 +554,17 @@ hugo
        width = 800
        height = 600

+  # {{< version 0.2.5 >}} TypeIt 配置
+  [params.typeit]
+    # 每一步的打字速度 (单位是毫秒)
+    speed = 100
+    # 光标的闪烁速度 (单位是毫秒)
+    cursorSpeed = 1000
+    # 光标的字符 (支持 HTML 格式)
+    cursorChar = "|"
+    # 打字结束之后光标的持续时间 (单位是毫秒, "-1" 代表无限大)
+    duration = -1
+
  # 网站验证代码，用于 Google/Bing/Yandex/Pinterest/Baidu
  [params.verification]
    google = ""
@@ -613,7 +625,7 @@ hugo
    clipboardJS = ""
    # {{< link "https://github.com/ellisonleao/sharer.js" "sharer.js" >}}@0.4.0
    sharerJS = ""
-    # {{< link "https://github.com/alexmacarthur/typeit" "typeit" >}}@6.5.1
+    # {{< link "https://github.com/alexmacarthur/typeit" "typeit" >}}@7.0.4
    typeitJS = ""
    # {{< link "https://github.com/KaTeX/KaTeX" "katex" >}}@0.11.1
    katexCSS = ""
@@ -1010,7 +1022,7 @@ defaultContentLanguage = "zh-cn"
 * `lunr`: 简单, 无需同步 `index.json`, 没有 `contentLength` 的限制, 但占用带宽大且性能低 (特别是中文需要一个较大的分词依赖库)
 * `algolia`: 高性能并且占用带宽低, 但需要同步 `index.json` 且有 `contentLength` 的限制

-{{< version 0.2.3 >}} 文章内容被 `h2` 和 `h3` HTML 标签切分来提供查询效果并且基本实现全文搜索.
+{{< version 0.2.3 >}} 文章内容被 `h2` 和 `h3` HTML 标签切分来提高查询效果并且基本实现全文搜索.
 `contentLength` 用来限制 `h2` 和 `h3` HTML 标签开头的内容部分的最大长度.
 {{< /admonition >}}