From 55400d7d952cd4d7d264fbc2161111517ce5bab3 Mon Sep 17 00:00:00 2001 From: Jimmy Cai Date: Sun, 10 Sep 2023 15:42:43 +0200 Subject: [PATCH] refactor: simplify exampleSite configuration files and switch to YAML Include only overridden values. --- config/_default/params.yaml | 5 + exampleSite/config/_default/config.toml | 20 ---- exampleSite/config/_default/config.yaml | 16 +++ exampleSite/config/_default/languages.toml | 16 --- exampleSite/config/_default/languages.yaml | 14 +++ exampleSite/config/_default/markup.toml | 18 --- exampleSite/config/_default/markup.yaml | 15 +++ exampleSite/config/_default/menu.toml | 20 ---- exampleSite/config/_default/menu.yaml | 15 +++ exampleSite/config/_default/params.toml | 110 ------------------ exampleSite/config/_default/params.yaml | 37 ++++++ .../{permalinks.toml => permalinks.yaml} | 4 +- exampleSite/config/_default/related.toml | 12 -- exampleSite/config/_default/related.yaml | 9 ++ 14 files changed, 113 insertions(+), 198 deletions(-) delete mode 100644 exampleSite/config/_default/config.toml create mode 100644 exampleSite/config/_default/config.yaml delete mode 100644 exampleSite/config/_default/languages.toml create mode 100644 exampleSite/config/_default/languages.yaml delete mode 100644 exampleSite/config/_default/markup.toml create mode 100644 exampleSite/config/_default/markup.yaml delete mode 100644 exampleSite/config/_default/menu.toml create mode 100644 exampleSite/config/_default/menu.yaml delete mode 100644 exampleSite/config/_default/params.toml create mode 100644 exampleSite/config/_default/params.yaml rename exampleSite/config/_default/{permalinks.toml => permalinks.yaml} (55%) delete mode 100644 exampleSite/config/_default/related.toml create mode 100644 exampleSite/config/_default/related.yaml diff --git a/config/_default/params.yaml b/config/_default/params.yaml index 95642c0..ca5407e 100644 --- a/config/_default/params.yaml +++ b/config/_default/params.yaml @@ -10,6 +10,9 @@ featuredImageField: image # Output full content to RSS feed rssFullContent: true +# Path to favicon, relative to assets folder +favicon: + footer: # Year when site was first published since: @@ -23,6 +26,8 @@ dateFormat: lastUpdated: "Jan 02, 2006 15:04 MST" sidebar: + emoji: + subtitle: compact: false avatar: enabled: true diff --git a/exampleSite/config/_default/config.toml b/exampleSite/config/_default/config.toml deleted file mode 100644 index 548975a..0000000 --- a/exampleSite/config/_default/config.toml +++ /dev/null @@ -1,20 +0,0 @@ -# Change baseurl before deploy -baseurl = "https://demo.stack.jimmycai.com" -languageCode = "en-us" -paginate = 5 -title = "Hugo Theme Stack Starter" -theme = "hugo-theme-stack" - -# Theme i18n support -# Available values: ar, bn, ca, de, el, en, es, fr, hu, id, it, ja, ko, nl, pt-br, th, uk, zh-cn, zh-hk, zh-tw -DefaultContentLanguage = "en" - -# Set hasCJKLanguage to true if DefaultContentLanguage is in [zh-cn ja ko] -# This will make .Summary and .WordCount behave correctly for CJK languages. -hasCJKLanguage = false - -# Change it to your Disqus shortname before using -disqusShortname = "hugo-theme-stack" - -# GA Tracking ID -googleAnalytics = "" diff --git a/exampleSite/config/_default/config.yaml b/exampleSite/config/_default/config.yaml new file mode 100644 index 0000000..6b8ec47 --- /dev/null +++ b/exampleSite/config/_default/config.yaml @@ -0,0 +1,16 @@ +baseurl: https://demo.stack.jimmycai.com +languageCode: en-us +paginate: 5 +title: Hugo Theme Stack Starter +theme: hugo-theme-stack + +DefaultContentLanguage: en + +# Set hasCJKLanguage to true if DefaultContentLanguage is in [zh-cn ja ko] +# This will make .Summary and .WordCount behave correctly for CJK languages. +hasCJKLanguage: false + +disqusShortname: hugo-theme-stack + +# GA Tracking ID +googleAnalytics: "" diff --git a/exampleSite/config/_default/languages.toml b/exampleSite/config/_default/languages.toml deleted file mode 100644 index ad80c20..0000000 --- a/exampleSite/config/_default/languages.toml +++ /dev/null @@ -1,16 +0,0 @@ -# Enable multilanguage site support -[en] -languageName = "English" -title = "Hugo Theme Stack Example Site" -weight = 1 - -[zh-cn] -languageName = "中文" -title = "Hugo 主题 Stack 演示站点" -weight = 2 - -[ar] -languageName = "عربي" -languagedirection = "rtl" -title = "موقع تجريبي" -weight = 3 diff --git a/exampleSite/config/_default/languages.yaml b/exampleSite/config/_default/languages.yaml new file mode 100644 index 0000000..2ba2caa --- /dev/null +++ b/exampleSite/config/_default/languages.yaml @@ -0,0 +1,14 @@ +# Enable multilanguage site support +en: + languageName: English + title: Hugo Theme Stack Example Site + weight: 1 +zh-cn: + languageName: 中文 + title: Hugo 主题 Stack 演示站点 + weight: 2 +ar: + languageName: عربي + languagedirection: rtl + title: موقع تجريبي + weight: 3 diff --git a/exampleSite/config/_default/markup.toml b/exampleSite/config/_default/markup.toml deleted file mode 100644 index 591ce9e..0000000 --- a/exampleSite/config/_default/markup.toml +++ /dev/null @@ -1,18 +0,0 @@ -# Markdown renderer configuration -[goldmark.renderer] -# Set it to true if you have HTML content inside Markdown -unsafe = false - -[tableOfContents] -endLevel = 4 -ordered = true -startLevel = 2 - -[highlight] -noClasses = false -codeFences = true -guessSyntax = true -lineNoStart = 1 -lineNos = true -lineNumbersInTable = true -tabWidth = 4 diff --git a/exampleSite/config/_default/markup.yaml b/exampleSite/config/_default/markup.yaml new file mode 100644 index 0000000..a7496f5 --- /dev/null +++ b/exampleSite/config/_default/markup.yaml @@ -0,0 +1,15 @@ +goldmark: + renderer: + unsafe: false # Allow HTML in markdown +tableOfContents: + endLevel: 4 + ordered: true + startLevel: 2 +highlight: + noClasses: false + codeFences: true + guessSyntax: true + lineNoStart: 1 + lineNos: true + lineNumbersInTable: true + tabWidth: 4 diff --git a/exampleSite/config/_default/menu.toml b/exampleSite/config/_default/menu.toml deleted file mode 100644 index e01b4f7..0000000 --- a/exampleSite/config/_default/menu.toml +++ /dev/null @@ -1,20 +0,0 @@ -### Custom menu -### See https://docs.stack.jimmycai.com/configuration/custom-menu.html -### To remove about, archive and search page menu item, remove `menu` field from their FrontMatter -main = [] - -[[social]] -identifier = "github" -name = "GitHub" -url = "https://github.com/CaiJimmy/hugo-theme-stack" - -[social.params] -icon = "brand-github" - -[[social]] -identifier = "twitter" -name = "Twitter" -url = "https://twitter.com" - -[social.params] -icon = "brand-twitter" diff --git a/exampleSite/config/_default/menu.yaml b/exampleSite/config/_default/menu.yaml new file mode 100644 index 0000000..4cfd6c3 --- /dev/null +++ b/exampleSite/config/_default/menu.yaml @@ -0,0 +1,15 @@ +### Custom menu +### See https://docs.stack.jimmycai.com/configuration/custom-menu.html +### To remove about, archive and search page menu item, remove `menu` field from their FrontMatter +main: [] +social: + - identifier: github + name: GitHub + url: https://github.com/CaiJimmy/hugo-theme-stack + params: + icon: brand-github + - identifier: twitter + name: Twitter + url: https://twitter.com + params: + icon: brand-twitter diff --git a/exampleSite/config/_default/params.toml b/exampleSite/config/_default/params.toml deleted file mode 100644 index ef3afa0..0000000 --- a/exampleSite/config/_default/params.toml +++ /dev/null @@ -1,110 +0,0 @@ -mainSections = ["post"] -featuredImageField = "image" -rssFullContent = true -favicon = "img/favicon.png" - -[footer] -since = 2020 - -[dateFormat] -published = "Jan 02, 2006" -lastUpdated = "Jan 02, 2006 15:04 MST" - -[sidebar] -emoji = "🍥" -subtitle = "Lorem ipsum dolor sit amet, consectetur adipiscing elit." - -[sidebar.avatar] -enabled = true -local = true -src = "img/logo.jpg" - -[article] -math = false -toc = true -readingTime = true - -[article.license] -enabled = true -default = "Licensed under CC BY-NC-SA 4.0" - -[comments] -enabled = true -provider = "disqus" - -[comments.disqusjs] - -[comments.utterances] -issueTerm = "pathname" - -[comments.remark42] - -[comments.vssue] -autoCreateIssue = false - -[comments.waline] -emoji = ["https://unpkg.com/@waline/emojis@1.0.1/weibo"] -requiredMeta = ["name", "email", "url"] - -[comments.waline.locale] -admin = "Admin" - -[comments.twikoo] - -[comments.cactus] -defaultHomeserverUrl = "https://matrix.cactus.chat:8448" -serverName = "cactus.chat" -siteName = "" - -[comments.giscus] -reactionsEnabled = 1 -emitMetadata = 0 - -[comments.gitalk] - -[comments.cusdis] - -[[widgets.homepage]] -type = "search" - -[[widgets.homepage]] -type = "archives" - -[widgets.homepage.params] -limit = 5 - -[[widgets.homepage]] -type = "taxonomy" - -[widgets.homepage.params] -limit = 10 -type = "tags" -icon = "tag" - -[[widgets.homepage]] -type = "taxonomy" - -[widgets.homepage.params] -limit = 10 -type = "categories" -icon = "categories" - -[[widgets.page]] -type = "toc" - -[opengraph.twitter] -card = "summary_large_image" - -[defaultImage.opengraph] -enabled = false -local = false - -[colorScheme] -toggle = true -default = "auto" - -[imageProcessing.cover] -enabled = true - -[imageProcessing.content] -enabled = true \ No newline at end of file diff --git a/exampleSite/config/_default/params.yaml b/exampleSite/config/_default/params.yaml new file mode 100644 index 0000000..c4963a3 --- /dev/null +++ b/exampleSite/config/_default/params.yaml @@ -0,0 +1,37 @@ +# This params.yaml overrides the theme's default params.yaml. +# A full list of available params with their default values can be found in the theme's config/_default/params.yaml file. +favicon: img/favicon.png + +footer: + since: 2020 + +sidebar: + emoji: 🍥 + subtitle: Lorem ipsum dolor sit amet, consectetur adipiscing elit. + avatar: + enabled: true + local: true + src: img/logo.jpg + +comments: + enabled: true + provider: disqus + +widgets: + homepage: + - type: search + - type: archives + params: + limit: 5 + - type: taxonomy + params: + limit: 10 + type: tags + icon: tag + - type: taxonomy + params: + limit: 10 + type: categories + icon: categories + page: + - type: toc diff --git a/exampleSite/config/_default/permalinks.toml b/exampleSite/config/_default/permalinks.yaml similarity index 55% rename from exampleSite/config/_default/permalinks.toml rename to exampleSite/config/_default/permalinks.yaml index 2499a7e..23cf733 100644 --- a/exampleSite/config/_default/permalinks.toml +++ b/exampleSite/config/_default/permalinks.yaml @@ -1,3 +1,3 @@ # Permalinks format of each content section -post = "/p/:slug/" -page = "/:slug/" \ No newline at end of file +post: /p/:slug/ +page: /:slug/ \ No newline at end of file diff --git a/exampleSite/config/_default/related.toml b/exampleSite/config/_default/related.toml deleted file mode 100644 index be52654..0000000 --- a/exampleSite/config/_default/related.toml +++ /dev/null @@ -1,12 +0,0 @@ -# Related contents configuration -includeNewer = true -threshold = 60 -toLower = false - -[[indices]] -name = "tags" -weight = 100 - -[[indices]] -name = "categories" -weight = 200 \ No newline at end of file diff --git a/exampleSite/config/_default/related.yaml b/exampleSite/config/_default/related.yaml new file mode 100644 index 0000000..269e46a --- /dev/null +++ b/exampleSite/config/_default/related.yaml @@ -0,0 +1,9 @@ +# Related contents configuration +includeNewer: true +threshold: 60 +toLower: false +indices: + - name: tags + weight: 100 + - name: categories + weight: 200