Add support for Fediverse comments #1457
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
How to add Fediverse comments
=============================
In a post where to allow Fediverse comments:
```yaml
comments:
fediverse:
url: https://example.com/@handle/123456789012345678
```
All replies to the Fediverse post will appear as comments.
Moderation
==========
By default, the moderation system is opt-out. All replies will be
published unless they are individually hidden.
To hide one specific Fediverse post:
```yaml
comments:
fediverse:
url: https://example.com/@handle/123456789012345678
hidden:
- https://example.com/@troll/123456789012345679
```
To switch to opt-in moderation, where only accepted posts are shown:
```yaml
comments:
fediverse:
url: https://example.com/@handle/123456789012345678
moderation: opt-in
shown:
- https://example.com/@friend/123456789012345680
```
The JavaScript for the comments is based on [yidhra's
work](https://yidhra.farm/tech/jekyll/2022/01/03/mastodon-comments-for-jekyll.html),
combined with [Daniel Pecos Martinez's
work](https://danielpecos.com/2022/12/25/mastodon-as-comment-system-for-your-static-blog/)
for the Hugo version, as pupularized by [Jan
Wildeboer](https://codeberg.org/jwildeboer/cayman-fedi). It also
includes changes by me.
|
|
@pierreprinetti this is great, looking forward to this getting merged! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
How to add Fediverse comments
In a post where to allow Fediverse comments:
All replies to the Fediverse post will appear as comments.
Moderation
By default, the moderation system is opt-out. All replies will be published unless they are individually hidden.
To hide one specific Fediverse post:
To switch to opt-in moderation, where only accepted posts are shown:
The JavaScript for the comments is based on yidhra's work, combined with Daniel Pecos Martinez's
work for the Hugo version, as pupularized by Jan
Wildeboer. It also includes changes by me.
What does this PR change? What problem does it solve?
This PR adds support for Fediverse comments. Any replies to the given Fediverse post will appear as comments under your Hugo article.
Was the change discussed in an issue or in the Discussions before?
No. This is code that I use on a PaperMod fork on my website and I am proposing it back upstream just in case maintainers are interested.
I am aware that this code can't be merged as-is as it currently fetches an external library from the Cloudflare CDN. If the maintainers are interested in the functionality, I am happy to vendor the library and make other required changes.
PR Checklist