Obsidian Stats logoObsidian Stats

Local RSS

by onikun94
5
4
3
2
1
Score: 48/100
Install Code

Description

The Local RSS plugin lets you pull content from your favourite RSS feeds directly into your vault as markdown files. It supports managing multiple feeds, scheduled background updates, and customising how the articles are saved using templates with variables like title, author, image, and publication date. You can also define front matter and include tags for better organisation. The plugin ensures that each feed has its own configuration, making it easier to track and archive external reading material locally.

Reviews

No reviews yet.

Stats

42
stars
2,745
downloads
5
forks
204
days
55
days
59
days
36
total PRs
1
open PRs
0
closed PRs
35
merged PRs
16
total issues
3
open issues
13
closed issues
0
commits

Latest Version

0.2.1
2 months ago

Changelog

バージョン 0.2.1 のリリース

See all version on GitHub

README file from

Github

Local RSS

This plugin allows you to save articles from RSS feeds as local markdown files.

Features

  • Fetch articles from RSS feeds and save them as markdown files
  • Manage multiple RSS feeds
  • Automatic periodic updates
  • Customizable file names and content templates
  • Front matter and tag support

Usage

  1. Install and enable the plugin
  2. Configure the RSS folder in settings (default is "RSS")
  3. Click the "Add Feed" button to add a new feed
  4. Enter the feed name and URL (folder name is optional)
  5. Click the "Update Now" button to update the feed, or wait for automatic background updates

Commands

  • Update RSS feeds: Update all enabled RSS feeds
  • Add RSS feed: Add a new RSS feed

Template Variables

You can use the following variables in file name and content templates:

Basic Information
  • {{title}}: Article title
  • {{link}}: Original article URL
  • {{author}}: Article author name
  • {{content}}: Full article content (HTML)
Date & Time
  • {{publishedTime}}: Publication date and time (YYYY-MM-DD HH:mm:ss format)
  • {{savedTime}}: Date and time when the article was saved to your vault
Images
  • {{image}}: Article image URL (can be used in frontmatter or content)
Description
  • {{description}}: Full article description/summary
  • {{descriptionShort}}: First 50 characters of the description
Tags
  • {{#tags}}: Article categories formatted as hashtags (e.g., "#tech #news")
Example Template (Default)
---
title: {{title}}
link: {{link}}
author: {{author}}
publish_date: {{publishedTime}}
saved_date: {{savedTime}}
image: {{image}}
tags: {{#tags}}
---

![image](https://raw.githubusercontent.com/onikun94/obsidian-local-rss/HEAD/{{image}})

{{content}}
Advanced Examples

With description:

---
title: {{title}}
link: {{link}}
author: {{author}}
publish_date: {{publishedTime}}
saved_date: {{savedTime}}
image: {{image}}
description: {{descriptionShort}}
tags: {{#tags}}
---

![image](https://raw.githubusercontent.com/onikun94/obsidian-local-rss/HEAD/{{image}})

{{content}}

Note: The publish_date and saved_date frontmatter keys are used by the auto-delete feature to determine which articles to remove.

Development

  • Clone this repository
  • Install dependencies with npm i or yarn
  • Start development mode with npm run dev

License

MIT

Acknowledgments

This plugin is inspired by the implementation of joethei/obsidian-rss.

Sponsors