From ea043a2674faa7e2b310e66bf9ae8e4b98be5859 Mon Sep 17 00:00:00 2001 From: Dillon Date: Thu, 26 May 2022 02:07:52 +0800 Subject: [PATCH] chore(docs): update docs for utterances and giscus comment --- README.md | 3 ++- README.zh-cn.md | 7 ++++--- config.toml | 4 ++-- exampleSite/config.toml | 4 ++-- exampleSite/content/about/index.en.md | 5 +++-- exampleSite/content/about/index.zh-cn.md | 9 ++++---- .../theme-documentation-basics/index.en.md | 21 ++++++++++++++++++- .../theme-documentation-basics/index.zh-cn.md | 21 ++++++++++++++++++- layouts/partials/comment.html | 4 ++-- 9 files changed, 60 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index dd6bda51..436c9dd2 100644 --- a/README.md +++ b/README.md @@ -92,7 +92,8 @@ I hope you will LoveIt ❤️! * **Facebook comments** system supported by [Facebook](https://developers.facebook.com/docs/plugins/comments/) * **Telegram comments** system supported by [Telegram Comments](https://comments.app/) * **Commento** comment system supported by [Commento](https://commento.io/) -* **Utterances** comment system supported by [Utterances](https://utteranc.es/) +* **utterances** comment system supported by [utterances](https://utteranc.es/) +* **giscus** comment system supported by [giscus](https://giscus.app/) ### Extended Features diff --git a/README.zh-cn.md b/README.zh-cn.md index c136724c..7968de8e 100644 --- a/README.zh-cn.md +++ b/README.zh-cn.md @@ -84,10 +84,11 @@ * 支持 **[Disqus](https://disqus.com)** 评论系统 * 支持 **[Gitalk](https://github.com/gitalk/gitalk)** 评论系统 * 支持 **[Valine](https://valine.js.org/)** 评论系统 -* 支持 **[Facebook](https://developers.facebook.com/docs/plugins/comments/) 评论**系统 -* 支持 **[Telegram comments](https://comments.app/) 评论**系统 +* 支持 **[Facebook comments](https://developers.facebook.com/docs/plugins/comments/)** 评论系统 +* 支持 **[Telegram comments](https://comments.app/)** 评论系统 * 支持 **[Commento](https://commento.io/)** 评论系统 -* 支持 **[Utterances](https://utteranc.es/)** 评论系统 +* 支持 **[utterances](https://utteranc.es/)** 评论系统 +* 支持 **[giscus](https://giscus.app/)** 评论系统 ### 扩展功能 diff --git a/config.toml b/config.toml index e7b2d0c7..8a19fb11 100644 --- a/config.toml +++ b/config.toml @@ -462,8 +462,8 @@ # Commento comment 评论系统设置 (https://commento.io/) [params.page.comment.commento] enable = false - # Utterances comment config (https://utteranc.es/) - # Utterances comment 评论系统设置 (https://utteranc.es/) + # utterances comment config (https://utteranc.es/) + # utterances comment 评论系统设置 (https://utteranc.es/) [params.page.comment.utterances] enable = false # owner/repo diff --git a/exampleSite/config.toml b/exampleSite/config.toml index 83d7c147..e4e36f0c 100644 --- a/exampleSite/config.toml +++ b/exampleSite/config.toml @@ -544,8 +544,8 @@ enableEmoji = true # Commento comment 评论系统设置 (https://commento.io/) [params.page.comment.commento] enable = false - # Utterances comment config (https://utteranc.es/) - # Utterances comment 评论系统设置 (https://utteranc.es/) + # utterances comment config (https://utteranc.es/) + # utterances comment 评论系统设置 (https://utteranc.es/) [params.page.comment.utterances] enable = false # owner/repo diff --git a/exampleSite/content/about/index.en.md b/exampleSite/content/about/index.en.md index 0c257b9f..7469bc35 100644 --- a/exampleSite/content/about/index.en.md +++ b/exampleSite/content/about/index.en.md @@ -33,7 +33,7 @@ math: * :(fab fa-searchengin fa-fw): Optimized SEO performance with a correct **SEO SCHEMA** based on JSON-LD * :(fab fa-google fa-fw): **[Google Analytics](https://analytics.google.com/analytics)** supported * :(far fa-chart-bar fa-fw): **[Fathom Analytics](https://usefathom.com/)** supported -* :(far fa-chart-column fa-fw): **[Plausible Analytics](https://plausible.io/)** supported +* :(fas fa-chart-column fa-fw): **[Plausible Analytics](https://plausible.io/)** supported * :(fas fa-sitemap fa-fw): Search engine **verification** supported (Google, Bind, Yandex and Baidu) * :(fas fa-tachometer-alt fa-fw): **CDN** for third-party libraries supported * :(fas fa-cloud-download-alt fa-fw): Automatically converted images with **Lazy Load** by [lazysizes](https://github.com/aFarkas/lazysizes) @@ -60,7 +60,8 @@ math: * :(far fa-comments fa-fw): **Facebook comments** system supported by [Facebook](https://developers.facebook.com/docs/plugins/comments/) * :(fas fa-comment fa-fw): **Telegram comments** system supported by [Comments](https://comments.app/) * :(fas fa-comment-dots fa-fw): **Commento** comment system supported by [Commento](https://commento.io/) -* :(fas fa-comment-alt fa-fw): **Utterances** comment system supported by [Utterances](https://utteranc.es/) +* :(fas fa-comment-alt fa-fw): **utterances** comment system supported by [utterances](https://utteranc.es/) +* :(fas fa-comments fa-fw): **giscus** comment system supported by [giscus](https://giscus.app/) #### Extended Features diff --git a/exampleSite/content/about/index.zh-cn.md b/exampleSite/content/about/index.zh-cn.md index 7fcd409a..bcfa2852 100644 --- a/exampleSite/content/about/index.zh-cn.md +++ b/exampleSite/content/about/index.zh-cn.md @@ -33,7 +33,7 @@ math: * :(fab fa-searchengin fa-fw): 使用基于 JSON-LD 格式 的 **SEO SCHEMA** 文件进行 SEO 优化 * :(fab fa-google fa-fw): 支持 **[Google Analytics](https://analytics.google.com/analytics)** * :(far fa-chart-bar fa-fw): 支持 **[Fathom Analytics](https://usefathom.com/)** -* :(far fa-chart-column fa-fw): 支持 **[Plausible Analytics](https://plausible.io/)** +* :(fas fa-chart-column fa-fw): 支持 **[Plausible Analytics](https://plausible.io/)** * :(fas fa-sitemap fa-fw): 支持搜索引擎的**网站验证** (Google, Bind, Yandex and Baidu) * :(fas fa-tachometer-alt fa-fw): 支持所有第三方库的 **CDN** * :(fas fa-cloud-download-alt fa-fw): 基于 [lazysizes](https://github.com/aFarkas/lazysizes) 自动转换图片为**懒加载** @@ -57,10 +57,11 @@ math: * :(far fa-comment fa-fw): 支持 **[Disqus](https://disqus.com)** 评论系统 * :(far fa-comment-dots fa-fw): 支持 **[Gitalk](https://github.com/gitalk/gitalk)** 评论系统 * :(far fa-comment-alt fa-fw): 支持 **[Valine](https://valine.js.org/)** 评论系统 -* :(far fa-comments fa-fw): 支持 **[Facebook](https://developers.facebook.com/docs/plugins/comments/) 评论**系统 -* :(fas fa-comment fa-fw): 支持 **[Telegram comments](https://comments.app/) 评论**系统 +* :(far fa-comments fa-fw): 支持 **[Facebook comments](https://developers.facebook.com/docs/plugins/comments/)** 评论系统 +* :(fas fa-comment fa-fw): 支持 **[Telegram comments](https://comments.app/)** 评论系统 * :(fas fa-comment-dots fa-fw): 支持 **[Commento](https://commento.io/)** 评论系统 -* :(far fa-comment-alt fa-fw): 支持 **[Utterances](https://utteranc.es/)** 评论系统 +* :(far fa-comment-alt fa-fw): 支持 **[utterances](https://utteranc.es/)** 评论系统 +* :(fas fa-comments fa-fw): 支持 **[giscus](https://giscus.app/)** 评论系统 #### 扩展功能 diff --git a/exampleSite/content/posts/theme-documentation-basics/index.en.md b/exampleSite/content/posts/theme-documentation-basics/index.en.md index a4b543b6..c30c0d37 100644 --- a/exampleSite/content/posts/theme-documentation-basics/index.en.md +++ b/exampleSite/content/posts/theme-documentation-basics/index.en.md @@ -524,6 +524,7 @@ Please open the code block below to view the complete sample configuration :(far avatar = "mp" meta= "" pageSize = 10 + # automatically adapt the current theme i18n configuration when empty lang = "" visitor = true recordIP = true @@ -542,6 +543,7 @@ Please open the code block below to view the complete sample configuration :(far width = "100%" numPosts = 10 appId = "" + # automatically adapt the current theme i18n configuration when empty languageCode = "" # {{< version 0.2.0 >}} {{< link "https://comments.app/" "Telegram comments" >}} config [params.page.comment.telegram] @@ -556,7 +558,7 @@ Please open the code block below to view the complete sample configuration :(far # {{< version 0.2.0 >}} {{< link "https://commento.io/" "Commento" >}} comment config [params.page.comment.commento] enable = false - # {{< version 0.2.5 >}} {{< link "https://utteranc.es/" "Utterances" >}} comment config + # {{< version 0.2.5 >}} {{< link "https://utteranc.es/" "utterances" >}} comment config [params.page.comment.utterances] enable = false # owner/repo @@ -565,6 +567,23 @@ Please open the code block below to view the complete sample configuration :(far label = "" lightTheme = "github-light" darkTheme = "github-dark" + # giscus comment config (https://giscus.app/) + [params.page.comment.giscus] + # You can refer to the official documentation of giscus to use the following configuration. + enable = false + repo = "" + repoId = "" + category = "Announcements" + categoryId = "" + # automatically adapt the current theme i18n configuration when empty + lang = "" + mapping = "pathname" + reactionsEnabled = "1" + emitMetadata = "0" + inputPosition = "bottom" + lazyLoading = false + lightTheme = "light" + darkTheme = "dark" # {{< version 0.2.7 >}} Third-party library config [params.page.library] [params.page.library.css] diff --git a/exampleSite/content/posts/theme-documentation-basics/index.zh-cn.md b/exampleSite/content/posts/theme-documentation-basics/index.zh-cn.md index 22d25cf1..189bc57f 100644 --- a/exampleSite/content/posts/theme-documentation-basics/index.zh-cn.md +++ b/exampleSite/content/posts/theme-documentation-basics/index.zh-cn.md @@ -526,6 +526,7 @@ hugo avatar = "mp" meta= "" pageSize = 10 + # 为空时自动适配当前主题 i18n 配置 lang = "" visitor = true recordIP = true @@ -544,6 +545,7 @@ hugo width = "100%" numPosts = 10 appId = "" + # 为空时自动适配当前主题 i18n 配置 languageCode = "zh_CN" # {{< version 0.2.0 >}} {{< link "https://comments.app/" "Telegram Comments" >}} 评论系统设置 [params.page.comment.telegram] @@ -558,7 +560,7 @@ hugo # {{< version 0.2.0 >}} {{< link "https://commento.io/" "Commento" >}} 评论系统设置 [params.page.comment.commento] enable = false - # {{< version 0.2.5 >}} {{< link "https://utteranc.es/" "Utterances" >}} 评论系统设置 + # {{< version 0.2.5 >}} {{< link "https://utteranc.es/" "utterances" >}} 评论系统设置 [params.page.comment.utterances] enable = false # owner/repo @@ -567,6 +569,23 @@ hugo label = "" lightTheme = "github-light" darkTheme = "github-dark" + # giscus comment 评论系统设置 (https://giscus.app/zh-CN) + [params.page.comment.giscus] + # 你可以参考官方文档来使用下列配置 + enable = false + repo = "" + repoId = "" + category = "Announcements" + categoryId = "" + # 为空时自动适配当前主题 i18n 配置 + lang = "" + mapping = "pathname" + reactionsEnabled = "1" + emitMetadata = "0" + inputPosition = "bottom" + lazyLoading = false + lightTheme = "light" + darkTheme = "dark" # {{< version 0.2.7 >}} 第三方库配置 [params.page.library] [params.page.library.css] diff --git a/layouts/partials/comment.html b/layouts/partials/comment.html index 0518c89d..2a52864e 100644 --- a/layouts/partials/comment.html +++ b/layouts/partials/comment.html @@ -112,7 +112,7 @@ {{- end -}} - {{- /* Utterances Comment System */ -}} + {{- /* utterances Comment System */ -}} {{- $utterances := $comment.utterances | default dict -}} {{- if $utterances.enable -}}
@@ -122,7 +122,7 @@ {{- $commentConfig = $utterances.lightTheme | default "github-light" | dict "lightTheme" | dict "utterances" | merge $commentConfig -}} {{- $commentConfig = $utterances.darkTheme | default "github-dark" | dict "darkTheme" | dict "utterances" | merge $commentConfig -}} {{- end -}}