Skip to content

Latest commit

 

History

History
33 lines (22 loc) · 1.44 KB

README.md

File metadata and controls

33 lines (22 loc) · 1.44 KB

This is a separate RSS feed meant to be used with better_feediverse, but should also work with other social media publishers.

Installation

While this project only adds a single XML file to your site it is deployed as a theme. Hugo supports multiple themes at once, which are merged, making handling of this project very easy.

Add the repository to your themes directory, either by git clone, git submodule add or just extract the zip file into your themes folder.

# use only one of these, whatever suits your setup
git clone https://github.com/schneidr/hugo-mastofeed.git themes/mastofeed
git submodule add https://github.com/schneidr/hugo-mastofeed.git themes/mastofeed

Add to your Hugo config.toml:

# add "mastofeed" as another theme
theme = [ "my-theme", "mastofeed" ]

[outputs]
  # just add "Mastofeed", example:
  home = ["HTML", "RSS", "JSON", "Mastofeed"]

[outputFormats]
  [outputFormats.Mastofeed]
    baseName = 'mastofeed'
    isPlainText = true
    mediaType = 'application/rss+xml'

After building the site the feed will be available under https://example.org/mastofeed.xml.

The feed accepts two new fields in the frontmatter of posts and pages:

  • mastotext: Used as description if available, fallback to the description field
  • mastotags: is added as separate tags to the items, is used by feediverse to generate hashtags