Feedle

unlisted

by AlexMason

An RSS feed manager that integrates directly into your notes.

Updated 1mo agoMIT
View on GitHub

Feedle for Obsidian

Feedle is an innovative RSS feed manager plugin designed specifically for Obsidian.md users who want to seamlessly integrate news feeds into their notes. With Feedle, staying updated with your favorite websites and incorporating valuable insights into your notes has never been easier. Simply insert a Feedle code block with a URL, and let Feedle enrich your notes with the latest content.

feed-ui.png

Why did you create Feedle?

I wanted a drop in RSS solution that just worked, without complicated menus, setup and navigation. This design decision will lead to a more conservative feature set, it offers an intuitive text-based RSS feed experience that integrates nicely into obsidian. I look to strike an ideal balance between functionality and configurability.

Features

  • Easy RSS Integration: Add RSS feeds directly into your Obsidian notes with a simple code block.
  • Automatic Pagination: Effortlessly browse through feed entries with built-in pagination.
  • Read / Unread Tracking: Read articles are tracked. Rediscover stuff you've previously found important or interesting.
  • Favorites: Mark entries as favorites for quick access and reference, enhancing your note-taking workflow.
  • Save Articles: Automatically retrieve article content and ingest it into obsidian for easy viewing and note enrichment.
  • Youtube Video Support: Detect if the entry is from a youtube channel, and display the video embedded in the note when saved.

Installation

Via BRAT (Recommended)

BRAT (Beta Reviewers Auto-update Tool) is the easiest way to install Feedle before it is available in the community plugin directory.

  1. Install the BRAT plugin from the Obsidian community plugins directory.
  2. Enable BRAT in your plugins list.
  3. Open the BRAT settings and click Add Beta Plugin.
  4. Enter the repository URL: https://github.com/AlexMason/feedle
  5. Click Add Plugin and then enable Feedle from your installed plugins list.

BRAT will also automatically notify you when updates are available.

Manual Installation

  1. Download main.js, manifest.json, and styles.css from the latest release.
  2. Create a folder called feedle in your vault's .obsidian/plugins/ directory.
  3. Copy the three downloaded files into that folder.
  4. Open Obsidian, go to Settings > Community Plugins, disable Safe Mode, and enable Feedle.

Usage

Getting Started

To start using Feedle, insert a code block into your note and specify the RSS feed URL as follows:

feed-basic.png

Feedle will automatically fetch and display the feed entries within your note.

Tags & Aggregated Feeds

Feedle has support for aggregated feeds, which are powered by the use of tags. Add a tags property to your feedle block and populate it with one or more comma-separated tags.

feed-tags.png

You can then create an aggregated feed combining feeds based into an single aggregated view by setting the type property in the feedle block to agg-feed.

feed-aggfeed.png

Folder notes

Feedle integrates well with LostPaul's Folder notes plugin. Their is no direct dependency, Feedle is just designed to work this way. If Feedle snippet is in a note, and the note's parent folder has the same name as the Feedle note, Feedle will add new notes to the current folder. Otherwise Feedle will create a new folder with the same name as the Feedle Note in the same directory as the Feedle note.

Contributing

We welcome contributions and suggestions to make Feedle even better! If you're interested in contributing, please follow these steps:

  1. Fork the repository on GitHub.
  2. Clone your fork to your local machine.
  3. Create a new branch for your feature or fix.
  4. Make your changes and test them thoroughly.
  5. Commit your changes with a clear and descriptive message.
  6. Push your changes to your fork on GitHub.
  7. Submit a Pull Request (PR) to the main repository.

We use a simple PR management strategy to ensure that contributions are reviewed and integrated efficiently. Please provide as much information as possible about your changes, including how they improve Feedle or fix an issue.

Dependencies

Feedle relies on @extractus packages for parsing RSS feed data, Obsidian API's for interacting with editor content, and uses React and Tailwind CSS for rendering custom views.

Roadmap

I plan to continue to iterate on Feedle until I am happy with it's functionality and it works reliably.

  • Settings menu
  • Cache length
  • Configure template (with optional templater integrations)
  • Saved note prefix/suffix/format

License

Feedle is open-source software licensed under the MIT License. See the LICENSE file for more details.

Acknowledgments

Thanks to the Obsidian.md community for their invaluable support and to all contributors of Feedle for making this project possible.


Feedle is not officially affiliated with Obsidian.md.

For plugin developers

Search results and similarity scores are powered by semantic analysis of your plugin's README. If your plugin isn't appearing for searches you'd expect, try updating your README to clearly describe your plugin's purpose, features, and use cases.