feat(giscus): standardize configuration, support i18n and add lazyLoading config

assets/js/theme.js

@@ -865,6 +865,43 @@ var Theme = /*#__PURE__*/function () {
 
           this.switchThemeEventSet.add(this._utterancesOnSwitchTheme);
         }
+
+        if (this.config.comment.giscus) {
+          var giscusConfig = this.config.comment.giscus;
+          var giscusScript = document.createElement('script');
+          giscusScript.src = 'https://giscus.app/client.js';
+          giscusScript.type = 'text/javascript';
+          giscusScript.setAttribute('data-repo', giscusConfig.repo);
+          giscusScript.setAttribute('data-repo-id', giscusConfig.repoId);
+          giscusScript.setAttribute('data-category', giscusConfig.category);
+          giscusScript.setAttribute('data-category-id', giscusConfig.categoryId);
+          giscusScript.setAttribute('data-lang', giscusConfig.lang);
+          giscusScript.setAttribute('data-mapping', giscusConfig.mapping);
+          giscusScript.setAttribute('data-reactions-enabled', giscusConfig.reactionsEnabled);
+          giscusScript.setAttribute('data-emit-metadata', giscusConfig.emitMetadata);
+          giscusScript.setAttribute('data-input-position', giscusConfig.inputPosition);
+          if (giscusConfig.lazyLoading) giscusScript.setAttribute('data-loading', 'lazy');
+          giscusScript.setAttribute('data-theme', this.isDark ? giscusConfig.darkTheme : giscusConfig.lightTheme);
+          giscusScript.crossOrigin = 'anonymous';
+          giscusScript.async = true;
+          document.getElementById('giscus').appendChild(giscusScript);
+
+          this._giscusOnSwitchTheme = this._giscusOnSwitchTheme || function () {
+            var message = {
+              setConfig: {
+                theme: _this11.isDark ? giscusConfig.darkTheme : giscusConfig.lightTheme,
+                reactionsEnabled: false
+              }
+            };
+            var iframe = document.querySelector('iframe.giscus-frame');
+            if (!iframe) return;
+            iframe.contentWindow.postMessage({
+              giscus: message
+            }, 'https://giscus.app');
+          };
+
+          this.switchThemeEventSet.add(this._giscusOnSwitchTheme);
+        }
       }
     }
   }, {

config.toml

@@ -418,6 +418,8 @@
         avatar = "mp"
         meta= ""
         pageSize = 10
+        # automatically adapt the current theme i18n configuration when empty
+        # 为空时自动适配当前主题 i18n 配置
         lang = ""
         visitor = true
         recordIP = true
@@ -442,6 +444,8 @@
         width = "100%"
         numPosts = 10
         appId = ""
+        # automatically adapt the current theme i18n configuration when empty
+        # 为空时自动适配当前主题 i18n 配置
         languageCode = ""
       # Telegram comments config (https://comments.app/)
       # Telegram comments 评论系统设置 (https://comments.app/)
@@ -468,25 +472,26 @@
         label = ""
         lightTheme = "github-light"
         darkTheme = "github-dark"
+      # giscus comment config (https://giscus.app/)
+      # giscus comment 评论系统设置 (https://giscus.app/zh-CN)
       [params.page.comment.giscus]
-        # To enable giscus, the github discussions based comment section,
+        # You can refer to the official documentation of giscus to use the following configuration.
-        # Follow the steps described to enable giscus and get the values
+        # 你可以参考官方文档来使用下列配置
-        # needed to populate the below information.
-        # https://www.joelnitta.com/posts/2021-11-24_using-giscus/
         enable = false
-        category = "Announcements" # Announcements, Comments
+        repo = ""
-        lang = "en" # 保持 en, 只需要控制每篇文章的 url 不一样即可
+        repoId = ""
-        repo = "" # Entering repo will enable giscus
+        category = "Announcements"
-        repo_id = "" # query by GraphQL API, https://docs.github.com/en/graphql/overview/explorer
+        categoryId = ""
-        category_id = "" # query by GraphQL API, https://docs.github.com/en/graphql/overview/explorer
+        # automatically adapt the current theme i18n configuration when empty
+        # 为空时自动适配当前主题 i18n 配置
+        lang = ""
         mapping = "pathname"
-        reactions_enabled = "0"
+        reactionsEnabled = "1"
-        emit_metadata = "0"
+        emitMetadata = "0"
-        input_position = "top"
+        inputPosition = "bottom"
-        lightTheme = "light" # github theme
+        lazyLoading = false
-        darkTheme = "dark" # github theme
+        lightTheme = "light"
-        crossorigin = "anonymous"
+        darkTheme = "dark"
-        label = "Comment" # Label applied to issue by utteranc.es bot
     # Third-party library config
     # 第三方库配置
     [params.page.library]

exampleSite/config.toml

@@ -500,6 +500,8 @@ enableEmoji = true
         avatar = "mp"
         meta= ""
         pageSize = 10
+        # automatically adapt the current theme i18n configuration when empty
+        # 为空时自动适配当前主题 i18n 配置
         lang = ""
         visitor = true
         recordIP = true
@@ -524,6 +526,8 @@ enableEmoji = true
         width = "100%"
         numPosts = 10
         appId = ""
+        # automatically adapt the current theme i18n configuration when empty
+        # 为空时自动适配当前主题 i18n 配置
         languageCode = ""
       # Telegram comments config (https://comments.app/)
       # Telegram comments 评论系统设置 (https://comments.app/)
@@ -550,25 +554,26 @@ enableEmoji = true
         label = ""
         lightTheme = "github-light"
         darkTheme = "github-dark"
+      # giscus comment config (https://giscus.app/)
+      # giscus comment 评论系统设置 (https://giscus.app/zh-CN)
       [params.page.comment.giscus]
-        # To enable giscus, the github discussions based comment section,
+        # You can refer to the official documentation of giscus to use the following configuration.
-        # Follow the steps described to enable giscus and get the values
+        # 你可以参考官方文档来使用下列配置
-        # needed to populate the below information.
+        enable = false
-        # https://www.joelnitta.com/posts/2021-11-24_using-giscus/
+        repo = ""
-        # enable = true
+        repoId = ""
-        category = "Announcements" # Announcements, Comments
+        category = "Announcements"
-        lang = "en" # 保持 en, 只需要控制每篇文章的 url 不一样即可
+        categoryId = ""
-        repo = "" # Entering repo will enable giscus
+        # automatically adapt the current theme i18n configuration when empty
-        repo_id = "" # query by GraphQL API, https://docs.github.com/en/graphql/overview/explorer
+        # 为空时自动适配当前主题 i18n 配置
-        category_id = "" # query by GraphQL API, https://docs.github.com/en/graphql/overview/explorer
+        lang = ""
         mapping = "pathname"
-        reactions_enabled = "0"
+        reactionsEnabled = "1"
-        emit_metadata = "0"
+        emitMetadata = "0"
-        input_position = "top"
+        inputPosition = "bottom"
-        lightTheme = "light" # github theme
+        lazyLoading = false
-        darkTheme = "dark" # github theme
+        lightTheme = "light"
-        crossorigin = "anonymous"
+        darkTheme = "dark"
-        label = "Comment" # Label applied to issue by utteranc.es bot
     # Third-party library config
     # 第三方库配置
     [params.page.library]

i18n/ar.toml

@@ -51,13 +51,16 @@ other = "يعمل الموقع بنظام {{ .Hugo }} | التصميم مقدم
 
 # === partials/comment.html ===
 [valineLang]
-other = "ar"
+other = "en"
 
 [valinePlaceholder]
 other = "تعليقك..."
 
 [facebookLanguageCode]
 other = "ar_AR"
+
+[giscusLang]
+other = "en"
 # === partials/comment.html ===
 
 # === partials/assets.html ===

i18n/ca.toml

@@ -52,13 +52,16 @@ other = "Impulsat per {{ .Hugo }} | Tema - {{ .Theme }}"
 
 # === partials/comment.html ===
 [valineLang]
-other = "ca"
+other = "en"
 
 [valinePlaceholder]
 other = "El teu comentari ..."
 
 [facebookLanguageCode]
 other = "ca_ES"
+
+[giscusLang]
+other = "en"
 # === partials/comment.html ===
 
 # === partials/assets.html ===

i18n/de.toml

@@ -59,6 +59,9 @@ other = "Ihr Kommentar ..."
 
 [facebookLanguageCode]
 other = "de_DE"
+
+[giscusLang]
+other = "de"
 # === partials/comment.html ===
 
 # === partials/assets.html ===

i18n/en.toml

@@ -58,6 +58,9 @@ other = "Your comment ..."
 
 [facebookLanguageCode]
 other = "en_US"
+
+[giscusLang]
+other = "en"
 # === partials/comment.html ===
 
 # === partials/assets.html ===

i18n/es.toml

@@ -59,6 +59,9 @@ other = "Tu comentario ..."
 
 [facebookLanguageCode]
 other = "es_MX"
+
+[giscusLang]
+other = "es"
 # === partials/comment.html ===
 
 # === partials/assets.html ===

i18n/fr.toml

@@ -59,6 +59,9 @@ other = "Votre commentaire ..."
 
 [facebookLanguageCode]
 other = "fr"
+
+[giscusLang]
+other = "fr"
 # === partials/comment.html ===
 
 # === partials/assets.html ===

i18n/id.toml

@@ -59,6 +59,9 @@ other = "Komentar Anda ..."
 
 [facebookLanguageCode]
 other = "id_ID"
+
+[giscusLang]
+other = "id"
 # === partials/comment.html ===
 
 # === partials/assets.html ===

i18n/it.toml

@@ -59,6 +59,9 @@ other = "Il tuo commento ..."
 
 [facebookLanguageCode]
 other = "it"
+
+[giscusLang]
+other = "it"
 # === partials/comment.html ===
 
 # === partials/assets.html ===

i18n/pl.toml

@@ -59,6 +59,9 @@ other = "Twój komentarz ..."
 
 [facebookLanguageCode]
 other = "pl"
+
+[giscusLang]
+other = "pl"
 # === partials/comment.html ===
 
 # === partials/assets.html ===

i18n/pt-BR.toml

@@ -59,6 +59,9 @@ other = "O seu comentário ..."
 
 [facebookLanguageCode]
 other = "pt_BR"
+
+[giscusLang]
+other = "en"
 # === partials/comment.html ===
 
 # === partials/assets.html ===

i18n/ro.toml

@@ -59,6 +59,9 @@ other = "Comentariul dvs ..."
 
 [facebookLanguageCode]
 other = "ro_RO"
+
+[giscusLang]
+other = "ro"
 # === partials/comment.html ===
 
 # === partials/assets.html ===

i18n/ru.toml

@@ -59,6 +59,9 @@ other = "Ваш комментарий ..."
 
 [facebookLanguageCode]
 other = "ru_RU"
+
+[giscusLang]
+other = "ru"
 # === partials/comment.html ===
 
 # === partials/assets.html ===

i18n/sr.toml

@@ -52,13 +52,16 @@ other = "Покреће {{ .Hugo }} | Тема - {{ .Theme }}"
 
 # === partials/comment.html ===
 [valineLang]
-other = "sr"
+other = "en"
 
 [valinePlaceholder]
 other = "Ваш коментар ..."
 
 [facebookLanguageCode]
 other = "sr_RS"
+
+[giscusLang]
+other = "en"
 # === partials/comment.html ===
 
 # === partials/assets.html ===

i18n/te.toml

@@ -52,13 +52,16 @@ other = "{{ .Hugo }} ద్వారా ఆధారితం | నేపథ్
 # === partials/comment.html ===
 [valineLang]
 # not supported
-other = "te"
+other = "en"
 
 [valinePlaceholder]
 other = "మీ వాఖ్యనం ..."
 
 [facebookLanguageCode]
 other = "te_IN"
+
+[giscusLang]
+other = "en"
 # === partials/comment.html ===
 
 # === partials/assets.html ===

i18n/th.toml

@@ -52,13 +52,16 @@ other = "เว็บนี้สร้างโดย {{ .Hugo }} | ธีม -
 
 # === partials/comment.html ===
 [valineLang]
-other = "th"
+other = "en"
 
 [valinePlaceholder]
 other = "ความคิดเห็นของคุณ ..."
 
 [facebookLanguageCode]
 other = "th_TH"
+
+[giscusLang]
+other = "en"
 # === partials/comment.html ===
 
 # === partials/assets.html ===

i18n/vi.toml

@@ -58,6 +58,9 @@ other = "Bình luận của bạn ..."
 
 [facebookLanguageCode]
 other = "vi"
+
+[giscusLang]
+other = "vi"
 # === partials/comment.html ===
 
 # === partials/assets.html ===

i18n/zh-CN.toml

@@ -52,13 +52,16 @@ other = "由 {{ .Hugo }} 强力驱动 | 主题 - {{ .Theme }}"
 
 # === partials/comment.html ===
 [valineLang]
-other = "zh-cn"
+other = "zh-CN"
 
 [valinePlaceholder]
 other = "你的评论 ..."
 
 [facebookLanguageCode]
 other = "zh_CN"
+
+[giscusLang]
+other = "zh-CN"
 # === partials/comment.html ===
 
 # === partials/assets.html ===

i18n/zh-TW.toml

@@ -52,7 +52,7 @@ other = "由 {{ .Hugo }} 強力驅動 | 主題 - {{ .Theme }}"
 
 # === partials/comment.html ===
 [valineLang]
-other = "zh-tw"
+other = "zh-TW"
 
 [valinePlaceholder]
 other = "你的評論 ..."

layouts/partials/comment.html

@@ -126,20 +126,20 @@
             </noscript>
         {{- end -}}
 
-        {{- /* Giscus Comment System */ -}}
+        {{- /* giscus Comment System */ -}}
         {{- $giscus := $comment.giscus | default dict -}}
         {{- if $giscus.enable -}}
             <div id="giscus" class="comment"></div>
-            {{- $commentConfig = $giscus.lang | default "en" | dict "lang" | dict "giscus" | merge $commentConfig -}}
             {{- $commentConfig = dict "repo" $giscus.repo | dict "giscus" | merge $commentConfig -}}
-            {{- $commentConfig = dict "repo_id" $giscus.repo_id | dict "giscus" | merge $commentConfig -}}
+            {{- $commentConfig = dict "repoId" $giscus.repoId | dict "giscus" | merge $commentConfig -}}
             {{- $commentConfig = dict "category" $giscus.category | dict "giscus" | merge $commentConfig -}}
-            {{- $commentConfig = dict "category_id" $giscus.category_id | dict "giscus" | merge $commentConfig -}}
+            {{- $commentConfig = dict "categoryId" $giscus.categoryId | dict "giscus" | merge $commentConfig -}}
+            {{- $commentConfig = $giscus.lang | default (T "valineLang") | dict "lang" | dict "giscus" | merge $commentConfig -}}
             {{- $commentConfig = $giscus.mapping | default "pathname" | dict "mapping" | dict "giscus" | merge $commentConfig -}}
-            {{- $commentConfig = $giscus.reactions_enabled | default "1" | dict "reactions_enabled" | dict "giscus" | merge $commentConfig -}}
+            {{- $commentConfig = $giscus.reactionsEnabled | default "1" | dict "reactionsEnabled" | dict "giscus" | merge $commentConfig -}}
-            {{- $commentConfig = $giscus.emit_metadata | default "0" | dict "emit_metadata" | dict "giscus" | merge $commentConfig -}}
+            {{- $commentConfig = $giscus.emitMetadata | default "0" | dict "emitMetadata" | dict "giscus" | merge $commentConfig -}}
-            {{- $commentConfig = $giscus.input_position | default "bottom" | dict "input_position" | dict "giscus" | merge $commentConfig -}}
+            {{- $commentConfig = $giscus.inputPosition | default "bottom" | dict "inputPosition" | dict "giscus" | merge $commentConfig -}}
-            {{- $commentConfig = $giscus.crossorigin | default "anonymous" | dict "crossorigin" | dict "giscus" | merge $commentConfig -}}
+            {{- $commentConfig = $giscus.lazyLoading | default false | dict "lazyLoading" | dict "giscus" | merge $commentConfig -}}
             {{- $commentConfig = $giscus.lightTheme | default "github-light" | dict "lightTheme" | dict "giscus" | merge $commentConfig -}}
             {{- $commentConfig = $giscus.darkTheme | default "github-dark" | dict "darkTheme" | dict "giscus" | merge $commentConfig -}}
             <noscript>

src/js/theme.js

@@ -649,29 +649,26 @@ class Theme {
             if (this.config.comment.giscus) {
                 const giscusConfig = this.config.comment.giscus;
                 const giscusScript = document.createElement('script');
-                let dataTheme = this.isDark ? giscusConfig.darkTheme : giscusConfig.lightTheme
                 giscusScript.src = 'https://giscus.app/client.js';
                 giscusScript.type = 'text/javascript';
                 giscusScript.setAttribute('data-repo', giscusConfig.repo);
-                giscusScript.setAttribute('data-repo-id', giscusConfig.repo_id);
+                giscusScript.setAttribute('data-repo-id', giscusConfig.repoId);
                 giscusScript.setAttribute('data-category', giscusConfig.category);
-                giscusScript.setAttribute('data-category-id', giscusConfig.category_id);
+                giscusScript.setAttribute('data-category-id', giscusConfig.categoryId);
-                giscusScript.setAttribute('data-mapping', giscusConfig.mapping);
-                giscusScript.setAttribute('data-reactions-enabled', giscusConfig.reactions_enabled);
-                giscusScript.setAttribute('data-emit-metadata', giscusConfig.emit_metadata);
-                giscusScript.setAttribute('data-input-position', giscusConfig.input_position);
                 giscusScript.setAttribute('data-lang', giscusConfig.lang);
-                if (giscusConfig.label) giscusScript.setAttribute('label', giscusConfig.label);
+                giscusScript.setAttribute('data-mapping', giscusConfig.mapping);
-                giscusScript.setAttribute('data-theme', dataTheme);
+                giscusScript.setAttribute('data-reactions-enabled', giscusConfig.reactionsEnabled);
+                giscusScript.setAttribute('data-emit-metadata', giscusConfig.emitMetadata);
+                giscusScript.setAttribute('data-input-position', giscusConfig.inputPosition);
+                if (giscusConfig.lazyLoading) giscusScript.setAttribute('data-loading', 'lazy');
+                giscusScript.setAttribute('data-theme', this.isDark ? giscusConfig.darkTheme : giscusConfig.lightTheme);
                 giscusScript.crossOrigin = 'anonymous';
                 giscusScript.async = true;
                 document.getElementById('giscus').appendChild(giscusScript);
                 this._giscusOnSwitchTheme = this._giscusOnSwitchTheme || (() => {
-                    dataTheme = this.isDark ? giscusConfig.darkTheme : giscusConfig.lightTheme
                     const message = {
                         setConfig: {
-                            // theme: 'https://giscus.app/themes/custom_example.css',
+                            theme: this.isDark ? giscusConfig.darkTheme : giscusConfig.lightTheme,
-                            theme: dataTheme,
                             reactionsEnabled: false,
                         }
                     };