Init

config/_default/hugo.yaml

@@ -0,0 +1,69 @@
+baseURL: https://theme.hbstack.dev/
+title: HB Starter Theme Template
+# Copyright, the {year} is the placeholder of this year.
+copyright: "Copyright © 2022-{year} [Hugo Modules](https://hugomods.com/) and [HB Framework](https://hbstack.dev/). All Rights Reserved."
+defaultContentLanguage: en
+defaultContentLanguageInSubdir: true # disable this to remove the default language code from URL, i.e. /en/docs -> /docs.
+enableRobotsTXT: true
+timeout: 120s # images processing takes a long time, it's recommended to commit the resources folder for improve the build performance.
+enableEmoji: true
+
+title_sections: true # when false, remove the sections from the title.
+title_sections_depth: 0 # the depth of sections on the title.
+title_sections_depth_dir: end # when start, the depth is counting from the root sections.
+
+permalinks:
+  blog: /blog/:year/:month/:title
+
+outputs:
+  home:
+    - HTML
+    - Offline        # required by PWA module for displaying the offline pages.
+    - RSS
+    - SearchIndex    # required by search module.
+    - WebAppManifest # required by PWA module to make your site installable.
+
+taxonomies:
+  authors: authors       # multiple authors.
+  tags: tags
+  categories: categories
+  series: series
+
+build:
+  writeStats: true # required by PurgeCSS.
+
+markup:
+  goldmark:
+    renderer:
+      unsafe: true
+  highlight:
+    noClasses: false
+    lineNos: true
+    lineNumbersInTable: false
+
+# see https://gohugo.io/content-management/related/#configure-related-content
+related:
+  includeNewer: true
+  indices:
+  - name: keywords
+    weight: 100
+  - name: tags
+    weight: 80
+  - name: categories
+    weight: 60
+  - name: series
+    weight: 60
+  - name: authors
+    weight: 10
+  - name: date
+    weight: 10
+  threshold: 10 # for testing, increase it to suit your case.
+  toLower: false
+
+security:
+  funcs:
+    getenv:
+      - ^HUGO
+      - CI$
+      - PWD
+

config/_default/languages.yaml

@@ -0,0 +1,8 @@
+en:
+  languageName: English
+  weight: 1
+
+zh-hans:
+  languageName: 简体中文
+  title: HB 博客主题模板
+  weight: 2

config/_default/menus.en.yaml

@@ -0,0 +1,74 @@
+main:
+  - name: Support
+    identifier: support
+    weight: 100
+    url: https://github.com/hbstack
+    params:
+      header: The HB support community.
+      icon:
+        vendor: font-awesome-solid
+        name: headset
+
+  - name: Documentations
+    parent: support
+    url: https://hbstack.dev/
+    weight: 1
+    params:
+      icon:
+        vendor: bs
+        name: book
+        className: text-primary
+      description: The documentations.
+
+  - name: GitHub
+    parent: support
+    url: https://github.com/hbstack
+    weight: 11
+    params:
+      icon:
+        vendor: fab
+        name: github
+      description: The code repository.
+
+  - name: Discussion
+    parent: support
+    url: https://github.com/orgs/hbstack/discussions
+    weight: 12
+    params:
+      icon:
+        vendor: font-awesome-regular
+        name: comments
+        color: green
+      description: Ask questions and share your ideas.
+
+  - name: Bug Report
+    parent: support
+    url: https://github.com/orgs/hbstack/discussions/new?category=issues-and-bugs
+    weight: 13
+    params:
+      icon:
+        vendor: font-awesome-solid
+        name: bug
+        color: red
+      description: Tell us about a bug or issue.
+
+  - name: Feature Request
+    parent: support
+    url: https://github.com/orgs/hbstack/discussions/new?category=ideas
+    weight: 14
+    params:
+      icon:
+        vendor: font-awesome-regular
+        name: lightbulb
+        color: orange
+      description: Suggest new or updated features.
+  
+  - name: Mastodon
+    parent: support
+    url: https://techhub.social/@hbstack
+    weight: 16
+    params:
+      icon:
+        vendor: simple
+        name: mastodon
+      description: Follow us on Mastodon to get latest updates.

config/_default/menus.zh-hans.yaml

@@ -0,0 +1,74 @@
+main:
+  - name: 支持
+    identifier: support
+    weight: 100
+    url: https://github.com/hbstack
+    params:
+      header: HB 支持社区。
+      icon:
+        vendor: font-awesome-solid
+        name: headset
+
+  - name: 文档
+    identifier: support-docs
+    parent: support
+    url: https://hbstack.dev/
+    weight: 1
+    params:
+      icon:
+        vendor: bs
+        name: book
+      description: 使用文档。
+
+  - name: GitHub
+    parent: support
+    url: https://github.com/hbstack
+    weight: 2
+    params:
+      icon:
+        vendor: fab
+        name: github
+      description: 代码仓库。
+
+  - name: 讨论
+    parent: support
+    url: https://github.com/hbstack/discussions
+    weight: 3
+    params:
+      icon:
+        vendor: font-awesome-regular
+        name: comments
+        color: green
+      description: 提问题和分享你的想法。
+
+  - name: Bug 反馈
+    parent: support
+    url: https://github.com/hbstack/issues/new
+    weight: 4
+    params:
+      icon:
+        vendor: font-awesome-solid
+        name: bug
+        color: red
+      description: 向我们反馈一个错误或问题。
+
+  - name: 功能提议
+    parent: support
+    url: https://github.com/hbstack/issues/new
+    weight: 5
+    params:
+      icon:
+        vendor: font-awesome-regular
+        name: lightbulb
+        color: orange
+      description: 建议新的或需要改进的功能。
+  
+  - name: Mastodon
+    parent: support
+    url: https://techhub.social/@hbstack
+    weight: 6
+    params:
+      icon:
+        vendor: simple
+        name: mastodon
+      description: 关注我们以获取最近消息。

config/_default/module.yaml

@@ -0,0 +1,62 @@
+# For some regions can not access the proxy.golang.org, i.e. China.
+# See https://hugomods.com/en/blog/2023/04/go-and-hugo-proxy-servers/ for all available proxy servers.
+# proxy: https://goproxy.cn,direct
+
+# The order of module is very important, precedence from top to bottom.
+imports:
+  # gallery modules.
+  - path: github.com/hbstack/gallery
+  - path: github.com/hbstack/gallery/modules/breadcrumb
+
+  # syntax highlighting, see https://hbstack.dev/en/docs/modules/syntax-highlighting/.
+  # - path: github.com/hbstack/syntax-highlighting/styles/github-dark
+
+  # icons modules
+  - path: github.com/hugomods/icons/vendors/font-awesome
+  # - path: github.com/hugomods/icons/vendors/mdi
+  # - path: github.com/hugomods/icons/vendors/simple-icons
+  # - path: github.com/hugomods/icons/vendors/tabler
+  # - path: github.com/hugomods/icons/vendors/feather
+
+  # header themes
+  # - path: github.com/hbstack/header/themes/pills
+  # - path: github.com/hbstack/header/themes/tabs
+  # - path: github.com/hbstack/header/themes/classic
+
+  # blog sidebar
+  - path: github.com/hbstack/blog/modules/sidebar/profile
+  - path: github.com/hbstack/blog/modules/sidebar/posts
+  - path: github.com/hbstack/blog/modules/sidebar/taxonomies
+
+  # blog comments engine
+  - path: github.com/hbstack/blog/modules/giscus
+  # - path: github.com/hbstack/blog/modules/disqus
+  # - path: github.com/hbstack/blog/modules/utterances
+
+  # blog table of contents scrollspy
+  - path: github.com/hbstack/blog/modules/toc-scrollspy
+
+  # blog content panel
+  - path: github.com/hbstack/blog/modules/content-panel
+
+  # docs comments engine
+  - path: github.com/hbstack/docs/modules/giscus
+  # - path: github.com/hbstack/docs/modules/utterances
+  # - path: github.com/hbstack/docs/modules/disqus
+
+  # docs table of contents scrollspy
+  - path: github.com/hbstack/docs/modules/toc-scrollspy
+
+  # docs content panel
+  - path: github.com/hbstack/docs/modules/content-panel
+
+  # other modules
+  # - path: github.com/hugomods/google-analytics
+  # - path: github.com/hugomods/google-adsense
+
+  # recommended modules
+  # check which modules were imported by recommended module by "hugo mod graph | grep recommended".
+  # see also https://hbstack.dev/en/docs/modules/meta/.
+  # to remove unused modules, you need to replace the recommended module with modules your need.
+  # see also https://hbstack.dev/en/2023/10/replace-meta-modules/.
+  - path: github.com/hbstack/meta/recommended

config/_default/params.yaml

@@ -0,0 +1,124 @@
+description: The starter theme template of HB (Hugo Bootstrap) Framework.
+
+hb:
+  # override SASS variables, please replace the dash with underline, e.g. `list-group-color` should be `list_group_color`.
+  # styles:
+  #   primary: '#6610f2'
+  
+  # js_bundle_name: main # the JS bundle name.
+  # css_bundle_name: main # the CSS bundle name.
+  
+  full_width: false # when true, the layout takes full width globally.
+
+  header:
+    brand: HB # the brand name, leave it empty to use site's title.
+    logo_bg: '#712cf9' # logo background color, used by logo with transparent background.
+    # see https://hbstack.dev/en/docs/modules/socials/.
+    socials:
+      github: hbstack
+      # twitter: razonyang
+      rss: true
+      mastodon: https://techhub.social/@hbstack
+  footer:
+    # see https://hbstack.dev/en/docs/modules/socials/.
+    socials:
+      _color: true # when false, remove the color of social icons.
+      github: hbstack
+      twitter: razonyang
+      rss: true
+      mastodon: https://techhub.social/@hbstack
+  terms:
+    # the paginate for categories, tags, series list pages.
+    paginate: 12
+  blog:
+    sidebar:
+      profile:
+        # title: Profile title other than site title.
+        # description: Profile description other than site description.
+        company: COMPANY
+        location: Earth
+        socials:
+          github: hbstack
+          mastodon: https://techhub.social/@hbstack
+          rss: true
+      posts:
+        recent_count: 5 # the number of recent posts.
+        featured_count: 5 # the number of featured posts.
+      taxonomies:
+        count: true # whether to show the number of posts associated to the item.
+        limit: 10 # the maximum number of the item.
+    paginate: 12 # paginate.
+    post_thumbnail_placeholder: HB THEME # the text of thumbnail placeholder, default to site title.
+    # post_thumbnail: false # whether to show the thumbnails.
+    # post_date_format: ":date_long" # see https://gohugo.io/functions/dateformat/#datetime-formatting-layouts.
+    home: # homepage settings.
+      # taxonomies: false # remove the taxonomies stat from the homepage.
+      featured_posts: 5 # the number of the featured posts.
+      main_sections: # leave it empty to include all regular pages.
+        - docs
+        - blog
+        - tutorials
+    giscus:
+      repo: hbstack/theme
+      repo_id: R_kgDOJP3qtA
+      category_id: DIC_kwDOJP3qtM4CVavM
+  docs:
+    giscus:
+      repo: hbstack/theme
+      repo_id: R_kgDOJP3qtA
+      category_id: DIC_kwDOJP3qtM4CVavM
+  content_panel:
+    repo:
+      service: github # github or gitlab.
+      repo: hbstack/theme
+      branch: main
+      # subpath: exampleSite
+  # gallery:
+  #   thumbnail_size: "x640"
+
+seo:
+  favicons: # see https://hugomods.com/en/docs/seo/#favicons-module
+    icon: images/logo.png # use logo as favicon.
+
+# PWA settings, see https://hugomods.com/en/docs/pwa/#site-parameters.
+pwa:
+  debug: false
+  manifest:
+    background_color: '#712cf9'
+    theme_color: '#712cf9'
+    short_name: 'HB Theme'
+
+# see https://hugomods.com/search/configurations/.
+search:
+  stall_threshold: 300
+  min_match_char_length: 2
+  case_sensitive: false
+  # shortcut_search: ["/"]
+
+mermaid:
+  # replace it with other CDNs or self-hosted URLs.
+  js_url: https://cdn.jsdelivr.net/npm/mermaid@latest/dist/mermaid.esm.min.mjs
+
+hugopress:
+  modules:
+    hb-custom:
+      hooks:
+        # see layouts/partials/hugopress/modules/hb-custom/hooks/head-end.html.
+        head-end:
+          cacheable: true
+        # see layouts/partials/hugopress/modules/hb-custom/hooks/body-end.html.
+        body-end:
+          cacheable: true
+        # see layouts/partials/hugopress/modules/hb-custom/hooks/hb-blog-sidebar.html.
+        hb-blog-sidebar:
+          cacheable: true
+          weight: 1
+    # change the order of sidebar modules.
+    hb-blog-sidebar-taxonomies:
+      hooks:
+        hb-blog-sidebar:
+          weight: 3
+    hb-blog-sidebar-posts:
+      hooks:
+        hb-blog-sidebar:
+          weight: 2

config/development/params.yaml

@@ -0,0 +1,15 @@
+pwa:
+  caches:
+    font:
+      strategy: network-first
+    image:
+      strategy: network-first
+    script:
+      strategy: network-first
+    style:
+      strategy: network-first
+
+hugopress:
+  modules:
+    pwa:
+      disable: true

config/development/server.yaml

@@ -0,0 +1,4 @@
+redirects:
+  - from: /**
+    to: /404.html
+    status: 404

config/production/hugo.yaml

@@ -0,0 +1,4 @@
+# see https://hugomods.com/en/docs/google-analytics/.
+# googleAnalytics: 'G-XXXXXXXXXX' # Google Analytics, please make sure you've imported the Google Analytics module.
+
+# disqusShortname: XXXXXX # The Disqus shortname.

config/production/params.yaml

@@ -0,0 +1,2 @@
+# see https://hugomods.com/en/docs/google-adsense/.
+# google_adsense = 'ca-pub-XXXXXXXXXXXXXXXX' # Please make that the Google AdSense module was imported.