search

mmistakes / minimal-mistakes

:triangular_ruler: Jekyll theme for building a personal site, blog, project documentation, or portfolio.
https://mmistakes.github.io/minimal-mistakes/
MIT License
12.22k stars 25.3k forks source link

Use GitHub Issues for Blog Comments #1719

Closed quanengineering closed 6 years ago

quanengineering commented 6 years ago

I want to use GitHub issues to store comments. I know it has some limitation, such as

but I still prefer it over Disqus, Facebook, Google.

mmistakes commented 6 years ago

Not likely to add support for this for all of the reasons you've stated, but that shouldn't stop you from doing it in your repo.

The theme has support for "custom comments". You'd set the following in your _config.yml file:

comments:
  provider: custom

And then you'd need to edit this _includes/comments.html and _includes/comments-providers/custom.html to suit your needs.

nadaa commented 6 years ago

I tried to add "custom" and "staticman_v2", but the boxes didn't appear!. What shall I do?

mmistakes commented 6 years ago

@nadaa Verify you're building Jekyll in production mode as described in the documentation.

Note: Comments are disabled by default in development. To enable when testing/building locally be sure to set JEKYLL_ENV=production to force the environment to production.

And that you have comments: true added to the post's front matter along with all the required Staticman configs in _config.yml. If you're missing something they won't show as a few variables are required.

nadaa commented 6 years ago

@mmistakes I tried what you suggested, but it is not working?

mmistakes commented 6 years ago

@nadaa Looks like you didn't add anything for repository... it's required for Staticman to work.

repository  : # GitHub username/repo-name e.g. "mmistakes/minimal-mistakes"
comments:
  provider  : "staticman_v2"
staticman:
  branch    : "master"
nadaa commented 6 years ago

@mmistakes, it works now, thank you :+1: I got another issue when submitting the comment, where else I need to update? "Sorry, there was an error with your submission. Please make sure all required fields have been completed and try again."

mmistakes commented 6 years ago

@nadaa Please open another issue specific to your Staticman problem as it's off topic. This issue is about using GitHub issues as a way to add comments to a Jekyll site.

Thank you.

stale[bot] commented 6 years ago

This issue has been automatically marked as stale because it has not had recent activity.

If this is a bug and you can still reproduce this error on the master branch, please reply with any additional information you have about it in order to keep the issue open.

If this is a feature request, please consider whether it can be accomplished in another way. If it cannot, please elaborate on why it is core to this project and why you feel more than 80% of users would find this beneficial.

This issue will automatically be closed in 7 days if no further activity occurs. Thank you for all your contributions.