https://github.com/yplog/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.
https://github.com/yplog/asmarss
astro-component astrojs mastodon rss withastro
Last synced: about 1 year ago
JSON representation
A package that enables tracking the most recent posts of a Mastodon account and rendering them as an RSS feed in a Astro Component.
- Host: GitHub
- URL: https://github.com/yplog/asmarss
- Owner: yplog
- License: mit
- Created: 2023-11-03T21:15:44.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-11T16:27:07.000Z (over 1 year ago)
- Last Synced: 2025-03-26T05:33:20.709Z (over 1 year ago)
- Topics: astro-component, astrojs, mastodon, rss, withastro
- Language: Astro
- Homepage: https://www.npmjs.com/package/asmarss
- Size: 256 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# asmarss
[](https://badge.fury.io/js/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:
```bash
npm i 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:
```css
.global-text-color {
color: #000;
}
.global-font-size {
font-size: 1.5rem;
}
```
In your Astro file:
```html
---
import Asmarss from 'asmarss';
---
```
ClassList is an object that contains the classes you want to add to the component, the default value is:
```ts
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](https://github.com/rbren/rss-parser#readme) - A small library for turning RSS XML feeds into JavaScript objects.