1
Fork 0
ActivityStreams for Hugo
This repository has been archived on 2020-06-23. You can view files and clone it, but cannot push or open issues or pull requests.
Go to file
Jan-Lukas Else 0c383d3265 Update 2020-06-23 20:50:19 +02:00
layouts/_default Update 2020-06-23 20:50:19 +02:00
LICENSE Add README.md and LICENSE 2020-02-10 18:12:09 +01:00
README.md Move repo to my own git 2020-04-26 14:38:01 +02:00
config.yaml Init 2020-02-10 17:48:50 +01:00
go.mod Move repo to my own git 2020-04-26 14:38:01 +02:00

README.md

AcitivtyStreams support for Hugo

This is a Hugo module, you can use in Hugo, to generate ActivityStreams representations of posts.

How to use

You can use this module by adding it to your Hugo config (example of a YAML Hugo configuration file):

module:
  imports:
   # other imports ...
   # The hugo-activitystreams module:
   - path: git.jlel.se/jlelse/hugo-activitystreams

You also need to specify the custom output format activity for the kinds index and page. When you add a custom output format, you need to make sure to also include the default ones.

outputs:
  home:
    - "html" # Default
    - "rss" # Default
    - "activity"
  page:
    - "html" # Default
    - "activity"

And finally (if you want to use use your website as an ActivityPub actor - middleware to do that with Hugo is coming soon...), you need to configure two params: inbox with the ActivityPub inbox URL and publickeypem with the PEM format of the public key of the key you use to sign activities.

params:
  # Your other params...
  # ActivityPub params
  activitypub:
    inbox: https://blog.example/activitypub/de/inbox
    publickeypem: -----BEGIN PUBLIC KEY-----...

Note

By default the ActivityPub actor has the IRI of the language-based homepage. Example:

  • Domain: jlelse.blog (a Hugo blog with two configured languages, default language "en")

License

This project is MIT licensed. See the license here.