mirror of
https://github.com/ckelsoe/obsidian-rss-importer.git
synced 2026-07-22 07:48:56 +00:00
No description
ae8dbd073e
First stable release of the free and public-content importer. Bundles this cycle's import-window work (endless scroll, select-all, loaded and selected counts), custom-domain Substack detection via the feed generator marker, and a per-feed Re-detect button to upgrade a feed saved as generic in place. Importing full bodies of paid Substack posts is deferred to a later release. |
||
|---|---|---|
| .github | ||
| __tests__ | ||
| scripts | ||
| .editorconfig | ||
| .gitignore | ||
| .npmrc | ||
| add-feed-modal.ts | ||
| CHANGELOG.md | ||
| cleanup.ts | ||
| CONTRIBUTING.md | ||
| debug-logger.ts | ||
| dismiss-store.ts | ||
| duplicate-prompt-modal.ts | ||
| esbuild.config.mjs | ||
| eslint.config.mts | ||
| feed-picker-modal.ts | ||
| feed-resolver.ts | ||
| feed-source.ts | ||
| feed-xml.ts | ||
| fetch-pacer.ts | ||
| folder-suggest.ts | ||
| html-converter.ts | ||
| image-downloader.ts | ||
| import-modal.ts | ||
| import-runner.ts | ||
| jest.config.cjs | ||
| LICENSE | ||
| main.ts | ||
| manifest.json | ||
| media-downloader.ts | ||
| note-writer.ts | ||
| package-lock.json | ||
| package.json | ||
| paywall-detector.ts | ||
| PRIVACY.md | ||
| README.md | ||
| SECURITY.md | ||
| settings-tab.ts | ||
| settings.ts | ||
| source-common.ts | ||
| source-generic.ts | ||
| source-substack.ts | ||
| styles.css | ||
| tsconfig.json | ||
| turndown-plugin-gfm.d.ts | ||
| types.d.ts | ||
| ui-helpers.ts | ||
| vault-index.ts | ||
| version-bump.mjs | ||
| versions.json | ||
RSS Importer
Import articles and podcasts from RSS, Atom, and Substack feeds into your vault as Markdown notes, organized by source feed and deduplicated by note identity.
It is an importer, not a reader. It writes notes you own and then gets out of the way.
Warning
Early development, use at your own risk. RSS Importer is in active early development and is not yet production-ready. Features and note formats may still change, and bugs are possible. It writes (and, with the cleanup command, rewrites) notes in your vault, so keep backups and try it on a test vault first. Provided "as is", without warranty, under the MIT License. It is not yet in the Obsidian Community Plugins store — install via BRAT or manually (see below).
Requirements
- Obsidian v1.13.0 or newer.
- Desktop only (Windows, macOS, Linux). It is not available on mobile.
Features
- Multiple sources. Add any RSS, Atom, or podcast feed. Substack publications are first-class: paste an
@handle, a subdomain, a custom domain, or a post URL and the plugin resolves it to the right feed. - One folder per feed, never re-imports. Each feed imports into its own destination folder, and every note carries a stable identity in its frontmatter, so moving or renaming notes never causes duplicates on the next import. Reorganize into subfolders freely.
- Add-feed preview. Paste a feed and resolve it to preview the publication title, host, recent item titles, and source type before you commit.
- Three-state import window. Each item shows as imported, dismissed, or available, with checkboxes, live progress, and a result summary. Dismissing is reversible, and imported items update immediately.
- Archive backfill. For Substack feeds, a "Load older" control pages back through the publication's archive, well beyond the recent RSS window, fetching older posts on demand.
- Clean Markdown. Article HTML is converted to tidy Markdown (headings, lists, tables, code blocks with language, captions, footnotes), with Substack subscribe/app/share widgets stripped.
- Per-feed cleanup rules. Remove promotional clutter by link target (for example a "buy me a coffee" or subscribe block) or trim a trailing footer, applied on import and re-runnable over existing notes with the Clean up imported notes command. Matching is by link and structure, not wording, so rules keep working when the text changes.
- Images. Link to the original image URLs, or download images into your vault.
- Media. Download podcast/audio/video enclosures into a vault subfolder or to a folder outside the vault, per feed.
- Tidy tags. Feed tags are written to a
feed-tagsnote property by default so they do not flood the global tag pane, or to Obsidiantagsif you prefer. - Per-feed overrides. Most defaults (destination, note name, images, media, cleanup, tags) can be set globally and overridden per feed.
Usage
- Open Settings → RSS Importer → Feeds → Add feed. Paste a feed URL or Substack handle, click Resolve to preview, choose a destination folder, optionally add tags and cleanup rules, and save.
- Run the Import from a feed command (or the ribbon icon) to open the import window. Select items and import; for Substack, use Load older to reach archived posts. The summary reports what was created, skipped, or failed.
- Optionally run Clean up imported notes to re-apply a feed's cleanup rules to notes you already imported.
Installation
Not yet in the Obsidian Community Plugins store. For now, use BRAT or a manual install.
BRAT (recommended for now)
BRAT installs and updates pre-release plugins straight from GitHub.
- Install the BRAT plugin from Community Plugins.
- Open BRAT settings and click Add Beta Plugin.
- Enter:
https://github.com/ckelsoe/obsidian-rss-importer - Enable RSS Importer in Settings → Community plugins.
Manual installation
- Download
main.js,manifest.json, andstyles.cssfrom the latest release. - Create a folder named
rss-importerin your vault's.obsidian/plugins/directory. - Copy the downloaded files into this folder.
- Reload Obsidian, then enable RSS Importer in Settings → Community plugins.
From Obsidian Community Plugins
Once the plugin is accepted into the store, you will be able to find it under Settings → Community plugins → Browse by searching for RSS Importer.
Changelog
See CHANGELOG.md for release history.
Contributing
See CONTRIBUTING.md for setup, quality gates, and conventions.
License
MIT. See LICENSE.