asmarss v0.1.0

asmarss

A package that enables tracking the most recent posts of a Mastodon account and rendering them as an RSS feed in a Astro Component.

Installation

In your Astro project, run:

npm install asmarss

Usage

Asmarss component take 3 props url, classList (optional), seperate (optional)

• url: the url of the Mastodon account you want to track
• classList: the class you want to add to the component
• seperate: if you want to seperate the posts in hr element, default value is false

For example css file:

.global-text-color {
  color: #000;
}

.global-font-size {
  font-size: 1.5rem;
}

In your Astro file:

---
import Asmarss from 'asmarss';
---

<Asmarss url={"https://mastodon-instance/@username.rss"}>

<Asmarss 
  url={"https://mastodon-instance/@username.rss"} 
  classList={{
    toot__content: "global-text-color global-font-size",
  }} 
  seperate={true} />

ClassList is an object that contains the classes you want to add to the component, the default value is:

type ClassList = {
  separator?: string; // the class of the hr element
  error_loading_feed?: string; // the class of the error message
  no_items_in_feed?: string; // the class of the no items message
  see_more?: string; // the class of the see more link
  toot?: string; // the class of the toot
  toot__header?: string; // the class of the toot header
  toot__header__date?: string; // the class of the toot date
  toot__content?: string; // the class of the toot content
  toot__footer?: string; // the class of the toot footer
  toot__footer__link?: string; // the class of the toot footer link
};

Contributing

If you would like to contribute to this project, please follow the steps below:

• Fork this project.
• Create a new branch: git checkout -b my-new-feature.
• Make changes and commit them: git commit -am 'Add some feature'.
• Push to the branch: git push origin my-new-feature.
• Create a new pull request (PR).

License

This project is licensed under the MIT License. Please refer to the license file for details.

Dependencies

• rss-parser - A small library for turning RSS XML feeds into JavaScript objects.