feat: add comments partial #44

rickvanprim · 2023-05-09T17:28:53Z

What problem does this PR solve?

Lack of support for a comments section at the bottom of posts.

Is this PR adding a new feature?

Introduces a comments.html partial that is included at the bottom of single.html and defaults to using the builtin Disqus template if .Site.DisqusShortname is set.

Is this PR related to any issue or discussion?

Closes #32

PR Checklist

I have verified that the code works as described/as intended.
This change adds a social icon which has a permissive license to use it.
This change does not include any external library/resources.
This change does not include any unrelated scripts (e.g. bash and python scripts).
I have enabled maintainer edits for this PR.

netlify · 2023-05-09T17:29:01Z

✅ Deploy Preview for hugo-blog-awesome ready!

Name	Link
🔨 Latest commit	`12cda7f`
🔍 Latest deploy log	https://app.netlify.com/sites/hugo-blog-awesome/deploys/645b1542fff2d800081981ec
😎 Deploy Preview	https://deploy-preview-44--hugo-blog-awesome.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

hugo-sid · 2023-05-09T17:36:52Z

Thanks for the PR, @rickvanprim.

Your contribution is greatly appreciated.

Can you post some screenshots of the blog pages, after successful Discuss integration?

rickvanprim · 2023-05-09T17:49:32Z

Enabled:

Disabled (builtin Disqus template disables when address is localhost/127.0.0.1):

hugo-sid · 2023-05-09T18:03:54Z

Thanks for the screenshots. The feature looks great.

It's time to add some documentation for this feature.
Could you please add some sample configuration in config.toml file? Also request you to include a small comment about the feature.

For example you can add something like this to config.toml:

#DisqusShortname = ABCDXYZ # provide discuss shortname & uncomment this line to enable discuss on blog post pages

hugo-sid · 2023-05-09T18:07:18Z

How come the Discuss background matches the theme background color? Did you configure it somewhere?

rickvanprim · 2023-05-09T23:56:36Z

Added some documentation as requested.

Regarding the theming, I haven't done anything. It seems to be largely automatic, except that it breaks when you toggle light/dark until the page refreshes.

After toggling to light:

After refreshing:

Thoughts?

hugo-sid · 2023-05-10T01:58:21Z

Hi James,

Added some documentation as requested.

Thanks. Can you push the change/commit? As of now, I only see the commit that you created 8 hours ago 44c0436 .

Regarding the theming, I haven't done anything. It seems to be largely automatic, except that it breaks when you toggle light/dark until the page refreshes.
Thoughts?

Thanks for the details. I have to find out how to fix this. We can address it later (not in this PR). Let's consider this an an enhancement.
Your PR does a great job of adding support for comments.

github-actions · 2023-05-10T02:48:34Z

This pull request has conflicts with the base branch, please resolve those so that we can review the pull request.

github-actions · 2023-05-10T02:50:06Z

Conflicts have been resolved! 🎉 A maintainer will soon review the pull request.

hugo-sid

Hi James. I have requested a change regarding CHANGELOG.md. Please see the comments below.

I will merge this PR shortly after this is resolved.

hugo-sid · 2023-05-10T03:04:32Z

README.md

+### Comments
+
+To enable Disqus comments, set `disqusShortname` in your site's `config.toml`.
+
+To use another comments system, provide your own `comments.html` partial in `layouts\partials\comments.html`.
+


Great! Thanks for adding documentation in README.md file.

hugo-sid · 2023-05-10T03:06:13Z

exampleSite/config.toml

@@ -10,13 +10,16 @@ theme = "hugo-blog-awesome"
 defaultContentLanguage = "en-gb"

 # To enable Google Analytics 4 (gtag.js) provide G-MEASUREMENT_ID below.
-# To disable  Google Analytics, simply leave the field empty or remove the next line
+# To disable Google Analytics, simply leave the field empty or remove the next line


You really have an 'eye for details' 😃.
Thanks for the fix.

hugo-sid · 2023-05-10T03:27:55Z

exampleSite/config.toml

+# To enable Disqus comments, provide Disqus Shortname below.
+# To disable Disqus comments, simply leave the field empty or remove the next line
+disqusShortname = ''
+


Thanks for the simple, no-brainer comments/docs.

I just copy-pasted your Google Analytics one 😉

hugo-sid · 2023-05-10T03:45:09Z

CHANGELOG.md

This changelong is auto generated. I have setup a GitHub action workflow which:

analyses the commits (from last release)

determines the version to bump (it's doable since this project uses conventional commit specification)

updates the changelog

creates a git tag corresponding to the version

Finally it creates a PR with the above changes. So, there is no manual editing required.

Can you please leave this file unchanged, so that we leave it to the CI to manage it?

This is not at all your mistake. I know that you did it with an intention to help me/the project 🙂.
I think I made a mistake in not mentioning it anywhere. Probably, I should have mentioned it in CONTRIBUTING.md.

All good. I wasn't sure how you were getting stable commit hashes in there, so I assumed it was post-PR 🙂

I wasn't sure how you were getting stable commit hashes in there, so I assumed it was post-PR

I see.

I have updated CONTRIBUTING.md.

Don't forget to star the repo, if you liked this theme.

Thanks.

sonarcloud · 2023-05-10T03:53:58Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.0% Duplication

hugo-sid

Thanks @rickvanprim, for adding Discuss comments feature to this theme.

I appreciate your contribution.

Have a good day. Happy blogging :)

github-actions bot added the size/s label May 9, 2023

github-actions bot added the conflicts This PR has conflicts which must be resolved before it can be reviewed. label May 10, 2023

github-actions bot added size/m and removed size/s conflicts This PR has conflicts which must be resolved before it can be reviewed. labels May 10, 2023

hugo-sid requested changes May 10, 2023

View reviewed changes

feat: add comments partial

12cda7f

hugo-sid approved these changes May 10, 2023

View reviewed changes

hugo-sid merged commit 685ebf6 into hugo-sid:main May 10, 2023

hugo-sid mentioned this pull request May 10, 2023

chore(main): release 1.2.0 #43

Merged

rickvanprim deleted the comments branch May 10, 2023 04:10

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add comments partial #44

feat: add comments partial #44

rickvanprim commented May 9, 2023

netlify bot commented May 9, 2023 •

edited

Loading

hugo-sid commented May 9, 2023 •

edited

Loading

rickvanprim commented May 9, 2023

hugo-sid commented May 9, 2023 •

edited

Loading

hugo-sid commented May 9, 2023

rickvanprim commented May 9, 2023

hugo-sid commented May 10, 2023 •

edited

Loading

github-actions bot commented May 10, 2023

github-actions bot commented May 10, 2023

hugo-sid left a comment

hugo-sid May 10, 2023

hugo-sid May 10, 2023

hugo-sid May 10, 2023

rickvanprim May 10, 2023

hugo-sid May 10, 2023 •

edited

Loading

rickvanprim May 10, 2023

hugo-sid May 10, 2023 •

edited

Loading

sonarcloud bot commented May 10, 2023

hugo-sid left a comment

feat: add comments partial #44

feat: add comments partial #44

Conversation

rickvanprim commented May 9, 2023

What problem does this PR solve?

Is this PR adding a new feature?

Is this PR related to any issue or discussion?

PR Checklist

netlify bot commented May 9, 2023 • edited Loading

✅ Deploy Preview for hugo-blog-awesome ready!

hugo-sid commented May 9, 2023 • edited Loading

rickvanprim commented May 9, 2023

hugo-sid commented May 9, 2023 • edited Loading

hugo-sid commented May 9, 2023

rickvanprim commented May 9, 2023

hugo-sid commented May 10, 2023 • edited Loading

github-actions bot commented May 10, 2023

github-actions bot commented May 10, 2023

hugo-sid left a comment

Choose a reason for hiding this comment

hugo-sid May 10, 2023

Choose a reason for hiding this comment

hugo-sid May 10, 2023

Choose a reason for hiding this comment

hugo-sid May 10, 2023

Choose a reason for hiding this comment

rickvanprim May 10, 2023

Choose a reason for hiding this comment

hugo-sid May 10, 2023 • edited Loading

Choose a reason for hiding this comment

rickvanprim May 10, 2023

Choose a reason for hiding this comment

hugo-sid May 10, 2023 • edited Loading

Choose a reason for hiding this comment

sonarcloud bot commented May 10, 2023

hugo-sid left a comment

Choose a reason for hiding this comment

netlify bot commented May 9, 2023 •

edited

Loading

hugo-sid commented May 9, 2023 •

edited

Loading

hugo-sid commented May 9, 2023 •

edited

Loading

hugo-sid commented May 10, 2023 •

edited

Loading

hugo-sid May 10, 2023 •

edited

Loading

hugo-sid May 10, 2023 •

edited

Loading