Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/andreasthinks/quarto-open-social-comments

a Quarto extension to add Mastodon powered comments to blogs and articles
https://github.com/andreasthinks/quarto-open-social-comments

blog comments fediverse mastodon quarto quarto-extension

Last synced: about 8 hours ago
JSON representation

a Quarto extension to add Mastodon powered comments to blogs and articles

Awesome Lists containing this project

README

        

# Open Social Comments for Quarto

This extension adds social media comments to your Quarto blog posts, supporting both Mastodon and Bluesky.

You can see (and leave a comment on) a [working example on my blog here](https://andreasthinks.me/posts/quarto_comments/open-social.html).

> **Note**: This extension was previously named "quarto-mastodon-comments". The repository has been renamed to better reflect its expanded functionality. The old installation command will continue to work thanks to GitHub's automatic redirects.

## Migration from quarto-mastodon-comments

If you previously used quarto-mastodon-comments, the simplest migration path is to install open-social-comments alongside it:

1. Keep your existing quarto-mastodon-comments installation to maintain compatibility with older posts
2. Install open-social-comments using the command below
3. For new posts, use the open-social-comments configuration format

This approach ensures your existing posts continue to work while allowing you to use the expanded features in new content.

## Installing

```bash
quarto install extension AndreasThinks/open-social-comments
```

> If you previously installed this extension as `quarto-mastodon-comments`, you don't need to make any changes. GitHub's redirects ensure that existing installations continue to work.

This will install the extension under the `_extensions` subdirectory.
If you're using version control, you will want to check in this directory.

## Using

### Mastodon Comments

1. Create a post about your content on Mastodon (for example, an announcement post)
2. Click on this post to obtain the relevant "toot id" from the URL
3. Add the following to your post's YAML header, replacing the values with your Mastodon details:

```yaml
filters:
- open-social-comments
mastodon_comments:
user: "AndreasThinks"
host: "fosstodon.org"
toot_id: "111995180253316042"
```

### Bluesky Comments

1. Create a post about your content on Bluesky
2. Copy the post's URL
3. Add the following to your post's YAML header:

```yaml
filters:
- open-social-comments
bluesky_comments:
post_uri: "https://bsky.app/profile/theradr.bsky.social/post/3knoaw5z4ek2v"
```

### Using Both

You can enable both Mastodon and Bluesky comments on the same post by including both configurations:

```yaml
filters:
- open-social-comments
mastodon_comments:
user: "AndreasThinks"
host: "fosstodon.org"
toot_id: "111995180253316042"
bluesky_comments:
post_uri: "https://bsky.app/profile/theradr.bsky.social/post/3knoaw5z4ek2v"
```

## Acknowledgements

This project builds upon and is inspired by the work of others:

- The Mastodon comments component is based on the [mastodon-comments webcomponent](https://github.com/dpecos/mastodon-comments) by dpecos
- The Bluesky comments implementation draws from [this webcomponent](https://gist.github.com/LoueeD/b7dec10b2ea56c825cbb0b3a514720ed) by LoueeD
- Icons are provided by [Font Awesome](https://fontawesome.com/) via their CDN

## License

This project is licensed under the GNU General Public License v3.0 - see the [LICENSE](LICENSE) file for details.