strawmelonjuice.com / chilp
Allows you to use Mastodon and Bluesky comments on your Lustre blog chilp.hexdocs.pm
lustre indieweb mastodon bluesky comments blog gleam
0
Fork 0

Configure Feed

Select the types of activity you want to include in your feed.

48 3 10

Clone this repository

https://tangled.org/strawmelonjuice.com/chilp https://tangled.org/did:plc:j5qjdenjwit2zaymkgyfar2r
git@knot.nuv.sh:strawmelonjuice.com/chilp git@knot.nuv.sh:did:plc:j5qjdenjwit2zaymkgyfar2r

For self-hosted knots, clone URLs may differ based on your setup.


Download tar.gz Download .zip
README.md

chilp#

Package Version Hex Docs

gleam add chilp@2

Usage#

Make sure to call chilp.register() in your main() function, and after that you can use chilp.widget() anywhere you want to place the comment widget! It'll take two labeled options, bluesky: and mastodon:, which take 'anchors' to the posts you want to load your comments from.

Do your Chilp widgets look a little bleak? See Styling Chilp!

Further documentation can be found at https://hexdocs.pm/chilp.

Usage without Lustre#

It is also possible to add a Chilp widget to your pages by just embedding the register function in your HTML! You will then no longer have access to the helper functions that normally help you construct the widget, as those rely on Lustre. A later version will likely have a workable library interface around this.

<head>
  ...
  <!-- or bundle.min.js -->
  <script
    type="module"
    src="https://cdn.jsdelivr.net/npm/@strawmelonjuice/chilp@latest/dist/bundle.js"
  ></script>
  ...
</head>
<body>
  ...
  <comment-widget
    bluesky-anchor="{a did}\{postid}"
    mastodon-anchor="{instance name}\{post id}"
  ></comment-widget>
  <!-- 
        An example would be:
        <comment-widget bluesky-anchor="did:plc:tydnkicz4pafvkt3jspzldn6\3mhwwbldyjc2o" mastodon-anchor="procial.tchncs.de\alf5j0fozrnl0002"></comment-widget>
    -->
  ...
</body>

Examples#

Commands#

Chilp's power is that it can rely on other backends to provide moderation, user verification, etc. However, sometimes you may want to create some custom behaviour for your site specifically. In that case, you should be able to add a comment to any offending comments to this end which Chilp recognises and processes. Chilp commands are prefixed like -chilp <command>.

  • hide: Commenting -chilp hide on a comment hides that particular comment and all it's children.
  • silence: Commenting -chilp silence on a comment shows that particular comment but hides all it's children.

Development#

cd examples/lustre_chilp_app
bun install
just run-example