Merge branch 'master' into show-related

Signed-off-by: Tekki <[email protected]>

.github/workflows/test.yml

@@ -9,12 +9,12 @@ jobs:
       matrix:
         hugo-version:
           - 'latest'
-          - '0.95.0'
+          - '0.128.0'
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
 
       - name: Setup Hugo
-        uses: peaceiris/actions-hugo@v2
+        uses: peaceiris/actions-hugo@v3
         with:
           hugo-version: ${{ matrix.hugo-version }}
           extended: true

CONTRIBUTING.md

@@ -10,7 +10,7 @@ and are **greatly appreciated**!
 
 When contributing, especially for the first time, consider starting by
 [creating an issue](https://github.com/chipzoller/hugo-clarity/issues/new/choose)
-so you can get feedback from the maintainers and avoid unncessary work.
+so you can get feedback from the maintainers and avoid unnecessary work.
 
 **Note:** Hugo Clarity has a [code of conduct](CODE_OF_CONDUCT.md).
 Please follow it in all your interactions with the project.

README.md

@@ -258,6 +258,7 @@ These options set global values that some pages or all pages in the site use by
 | showRelatedInSidebar       | boolean                     | no                  |
 | footerLogo                 | string                      | N/A                 |
 | enableSearch               | boolean                     | N/A                 |
+| blogDir                    | string                      | no                  |
 
 ### Page Parameters
 
@@ -295,6 +296,7 @@ These options can be set from a page [frontmatter](https://gohugo.io/content-man
 | sidebar              | boolean            | N/A              |
 | singleColumn         | boolean            | N/A              |
 | showRelatedInArticle | boolean            | N/A              |
+| noindex              | boolean            | N/A              |
 
 ### Modify Menus
 
@@ -709,7 +711,7 @@ customJS = ["js/custom.js"] # Include custom JS files
 
 ### Notices
 
-This theme includes functionality to display some "hightlight blocks" - called "notices" using a shortcode.
+This theme includes functionality to display some "highlight blocks" - called "notices" using a shortcode.
 
 For example, see the shortcode markup below will render as a notice:
 
@@ -814,16 +816,28 @@ You can override these setting from each post individually. For example, you may
 
 #### Utterances Commenting Support
 
- If you wish use [Utterances](https://github.com/utterance/utterances) comments on your site, you'll need to perform the following:
+If you wish use [Utterances](https://github.com/utterance/utterances) comments on your site, you'll need to perform the following:
 
  * Ensure you have a GitHub public repository, which you've granted permissions to the [Utterances GitHub App](https://github.com/apps/utterances).
  * Comment out the line for `disqusShortname = ""` in the `/config/_default/config.toml` file.
  * Set `comments = true` in the `/config/_default/params.toml` file.
  * Configure the utterances parameters in the `/config/_default/params.toml` file.
+ * Optionally, you can choose a label that will be assigned to all issues created by Utterances. The label must exist in your Github repository, as Utterances cannot attach labels that do not exist. Configure `utterancesLabel` parameter in `/config/_default/params.toml` file, after you have added a label to your Github repository Issues labels. Labels are case sensitive and support Emoji in label names. ✨💬✨
 
- Utterances is loaded in the `comments.html` partial by referring to the `utterances.html` partial.   Since `single.html` layout loads comments if comments are enabled, you must ensure *both* the `comments` and `utterances` parameters are configured.
+Utterances is loaded in the `comments.html` partial by referring to the `utterances.html` partial.   Since `single.html` layout loads comments if comments are enabled, you must ensure *both* the `comments` and `utterances` parameters are configured.
 
+#### Giscus Commenting Support
 
+If you wish to use [giscus](https://giscus.app/) comments on your site, you'll need to perform the following:
+
+ * Ensure your repository is [public](https://docs.github.com/en/github/administering-a-repository/managing-repository-settings/setting-repository-visibility#making-a-repository-public), otherwise visitors will not be able to view the discussion.
+ * The [giscus app](https://github.com/apps/giscus) is installed, otherwise visitors will not be able to comment and react.
+ * The Discussions feature is turned on by [enabling it for your repository](https://docs.github.com/en/github/administering-a-repository/managing-repository-settings/enabling-or-disabling-github-discussions-for-a-repository).
+ * Comment out the line for `disqusShortname = ""` in the `/config/_default/config.toml` file.
+ * Set `comments = true` in the `/config/_default/params.toml` file.
+ * Configure the giscus parameters in the `/config/_default/params.toml` file.
+
+Giscus is loaded in the `comments.html` partial by referring to the `giscus.html` partial.   Since `single.html` layout loads comments if comments are enabled, you must ensure *both* the `comments` and `giscus` parameters are configured.
 
 
 ### Math notation
@@ -842,13 +856,13 @@ mkdir -p layouts/partials && cp themes/clarity/layouts/partials/math.html layout
 Then add the corresponding line as its [README](https://github.com/KaTeX/KaTeX/tree/master/contrib/mhchem) suggested (without the `+` sign):
 
 ```diff
-<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/katex@0.12.0/dist/katex.min.css" integrity="sha384-AfEj0r4/OFrOo5t7NnNe46zW/tFgW6x/bCJG8FqQCEo3+Aro6EYUG4+cU+KJWu/X" crossorigin="anonymous">
+<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/katex@0.16.11/dist/katex.min.css" integrity="sha384-AfEj0r4/OFrOo5t7NnNe46zW/tFgW6x/bCJG8FqQCEo3+Aro6EYUG4+cU+KJWu/X" crossorigin="anonymous">
 
-<script defer src="https://cdn.jsdelivr.net/npm/katex@0.12.0/dist/katex.min.js" integrity="sha384-g7c+Jr9ZivxKLnZTDUhnkOnsh30B4H0rpLUpJ4jAIKs4fnJI+sEnkvrMWph2EDg4" crossorigin="anonymous"></script>
+<script defer src="https://cdn.jsdelivr.net/npm/katex@0.16.11/dist/katex.min.js" integrity="sha384-nB0miv6/jRmo5UMMR1wu3Gz6NLsoTkbqJghGIsx//Rlm+ZU03BU6SQNC66uf4l5+" crossorigin="anonymous"></script>
 
-+ <script defer src="https://cdn.jsdelivr.net/npm/katex@0.12.0/dist/contrib/mhchem.min.js" integrity="sha384-5gCAXJ0ZgozlShOzzT0OWArn7yCPGWVIvgo+BAd8NUKbCmulrJiQuCVR9cHlPHeG" crossorigin="anonymous"></script>
++ <script defer src="https://cdn.jsdelivr.net/npm/katex@0.16.11/dist/contrib/mhchem.min.js" integrity="sha384-ifpG+NlgMq0kvOSGqGQxW1mJKpjjMDmZdpKGq3tbvD3WPhyshCEEYClriK/wRVU0" crossorigin="anonymous"></script>
 
-<script defer src="https://cdn.jsdelivr.net/npm/katex@0.12.0/dist/contrib/auto-render.min.js" integrity="sha384-mll67QQFJfxn0IYznZYonOWZ644AWYC+Pt2cHqMaRhXVrursRwvLnLaebdGIlYNa" crossorigin="anonymous"
+<script defer src="https://cdn.jsdelivr.net/npm/katex@0.16.11/dist/contrib/auto-render.min.js" integrity="sha384-43gviWU0YVjaDtb/GhzOouOXtZMP/7XUzwPTstBeZFe/+rCMvRwr4yROQP43s0Xk" crossorigin="anonymous"
   onload="renderMathInElement(document.body);"></script>
 ```
 

assets/sass/_variables.sass

@@ -110,7 +110,9 @@ html
         img
           background: none
         svg
-          fill: #fafafa
+          fill: #fafafa 
+        &:not(svg)
+          filter: invert(0.87)
       .sidebar
         &_inner
           &::before

assets/sass/main.sass

@@ -4,7 +4,7 @@ $imagesPath: '{{ printf "../%s" (default "images/" .Site.Params.imagesDir) }}'
 $iconsPath: '{{ printf "../%s" (default "icons/" .Site.Params.iconsDir) }}'
 @import 'variables'
 @import 'override'
-// include static fonts only when they're not overriden
+// include static fonts only when they're not overridden
 {{- if ne .Site.Params.customFonts true }}
 @import 'fonts'
 {{- end }}

exampleSite/.gitignore

@@ -0,0 +1,3 @@
+public/
+resources/
+.hugo_build.lock

exampleSite/README.md

@@ -19,5 +19,5 @@ hugo server -t YOURTHEME
 - A section called `/post/` with sample markdown content
 - A headless bundle called `homepage` that you may want to use for single page applications. You can find instructions about headless bundles over [here](https://gohugo.io/content-management/page-bundles/#headless-bundle)
 - An `about.md` that is intended to provide the `/about/` page for a theme demo
-6. If you intend to build a theme that does not fit in the content structure provided in this repository, then you are still more than welcome to submit it for review at the [Hugo Themes](https://github.com/gohugoio/hugoThemes/issues) respository
+6. If you intend to build a theme that does not fit in the content structure provided in this repository, then you are still more than welcome to submit it for review at the [Hugo Themes](https://github.com/gohugoio/hugoThemes/issues) repository
 

exampleSite/config/_default/config.toml → exampleSite/config/_default/hugo.toml

@@ -4,7 +4,7 @@ baseurl = "https://example.com/"  # Include trailing slash
 # title = "Clarity"  # Edit directly from config/_default/languages.toml # alternatively, uncomment this and remove `title` entry from the aforemention file.
 copyright = "Copyright © 2008–2018, Steve Francia and the Hugo Authors; all rights reserved."
 # canonifyurls = true
-paginate = 10
+
 theme = "hugo-clarity"
 disqusShortname = ""
 
@@ -22,3 +22,6 @@ series = "series"
 
 [outputs]
 home = ["HTML", "RSS", "JSON"]
+
+[pagination]
+  pagerSize = 10

exampleSite/config/_default/params.toml

@@ -79,7 +79,7 @@ mobileNavigation = "left" # if you prefer right change to 'right'
 
 # some site owners want to decide how they would like their sites to be introduced users. These settings give you as a site owner to decide how the user will view your site for the first time.
 
-# please note that you cannot enforce both modes at the same time. i.e by enforcing one mode, you priotise it over the other (by setting it to true). enforceDarkMode will be commented out
+# please note that you cannot enforce both modes at the same time. i.e by enforcing one mode, you prioritise it over the other (by setting it to true). enforceDarkMode will be commented out
 
 # please also not that mode toggle UI will remain in place. That way, if a user prefers darkmode, they can have their way.
 
@@ -102,12 +102,28 @@ languageMenuName = "🌐"
 # Enable or disable comments globally. Default to true.
 # comments = false
 
+# Activate meta ld+json for blog
+blogDir = "post"
+
 # Enable or disable Utterances (https://github.com/utterance/utterances) Github Issue-Based Commenting
-# utterances = true  #Run the utterances script in the single.html layout to load https://utteranc.es comments
+# utterances = true  # Run the utterances script in the single.html layout to load https://utteranc.es comments
 # utterancesRepo = "GHUsername/Repository.Name" # Utterances is enabled when this param is set
+# utterancesLabel = "blog comments ✨💬✨" # The label needs to be manually added to your Github repository issues before configuring here
 # utterancesTheme = "github-light" # Default: github-dark
 # utterancesIssueTerm = "pathname" # Default: pathname
 
+# Enable or disable Giscus comments globally. Default to false.
+# giscus = true
+# giscusRepo = "GHUsername/Repository.Name" # Giscus is enabled when this param is set
+# giscusRepoId = "RepositoryID" # Required for Giscus to work
+# giscusCategory = "Blog"
+# giscusCategoryId = "CategoryID" # Required for Giscus to work
+# giscusMapping = "pathname" # Default: pathname
+# giscusReactionsEnabled = "1" # Default: 1 = true
+# giscusTheme = "dark_protanopia" # Default: dark_dimmed
+# giscusLang = "en" # Default: en
+
+
 # Maximum number of recent posts. (default: 8)
 # numberOfRecentPosts = 8
 
@@ -124,7 +140,7 @@ languageMenuName = "🌐"
 # dateFormat = "2006-01-02" # Default to "Jan 2, 2006".
 # customFonts = false # toggle to true if you want to use custom fonts only.
 
-# The year when ths website was created, this value is used in the copyright
+# The year when this website was created, this value is used in the copyright
 # notice of the footer.
 # since = 2016
 
@@ -141,8 +157,8 @@ name = "Jane Doe"
 [plausible_analytics]
 enable = false # to enable plausible analytics set to true.
 websiteDomain = "example.com" # domain name of your website, most cases same as your base url
-# plausibleDomain = "plausible.io" # default is set to plausible.io, only required if plausible is selfhosted
-# scritpName = "plausible" # default is set to plausible, only required if using a custome name for script
+# plausibleDomain = "plausible.io" # default is set to plausible.io, only required if plausible is self hosted
+# scriptName = "plausible" # default is set to plausible, only required if using a custom name for script
 
 [matomo_analytics]
 enable = false # To enable matomo analytics change to `true`.

exampleSite/content/about.md

@@ -20,6 +20,6 @@ Hugo is ideal for blogs, corporate websites, creative portfolios, online magazin
 
 Hugo is for people who want to hand code their own website without worrying about setting up complicated runtimes, dependencies and databases.
 
-Websites built with Hugo are extremelly fast, secure and can be deployed anywhere including, AWS, GitHub Pages, Heroku, Netlify and any other hosting provider.
+Websites built with Hugo are extremely fast, secure and can be deployed anywhere including, AWS, GitHub Pages, Heroku, Netlify and any other hosting provider.
 
 Learn more and contribute on [GitHub](https://github.com/gohugoio).

exampleSite/content/about.pt.md

@@ -23,6 +23,6 @@ Hugo is ideal for blogs, corporate websites, creative portfolios, online magazin
 
 Hugo is for people who want to hand code their own website without worrying about setting up complicated runtimes, dependencies and databases.
 
-Websites built with Hugo are extremelly fast, secure and can be deployed anywhere including, AWS, GitHub Pages, Heroku, Netlify and any other hosting provider.
+Websites built with Hugo are extremely fast, secure and can be deployed anywhere including, AWS, GitHub Pages, Heroku, Netlify and any other hosting provider.
 
 Learn more and contribute on [GitHub](https://github.com/gohugoio).