README.md

📻 feed.nvim

feed.nvim is a web feed reader in Neovim.

Warning

This project is young, expect breaking changes, and for now there's a nasty bug if you are on neovim stable #125, recommend to use nightly or wait for the coming release of 0.11

other than that usage should be fun and smooth, go ahead and enjoy!

🌟 Features

• 🌲 Fast and reliable rss/atom/json feed feed parsing, powered by tree-sitter
• 📝 View entries as beautiful markdown powered by pandoc
• 🏪 Lua database with no extra dependency
• 📚 Powerful entry searching by date, tag, feed, regex, and full text
• 📂 OPML support to import and export all your feeds and podcasts
• 🧡 RSShub integration to discover and track everything
• Github integration to subscribe to the new commits/release of your favorite repo/plugin
• 📶 HTMX + libuv powered minimal web interface
• WIP 📡 support for popular feed sync services like Tiny Tiny RSS and Fresh RSS

🚀 Installation

Requirements

• Neovim 0.10+
• curl
• pandoc
• tree-sitter-xml
• tree-sitter-html

Optional Dependencies

• For feed greping:
  • rg
• For interactive feed searching:
  • snacks.picker
  • mini.pick
  • fzf-lua
  • telescope.nvim
• For markdown rendering:
  • render-markdown
  • markview.nvim
• For image rendering:
  • snacks.nvim

Basic Installation

For rocks.nvim:

:Rocks install feed.nvim

For lazy.nvim:

return {
   "neo451/feed.nvim",
   cmd = "Feed",
   ---@module 'feed'
   ---@type feed.config
   opts = {},
}

Further Steps

• Run :checkhealth feed to see your installation status
• Read documentation or :h feed.txt
• To troubleshoot without conflict from other plugins or you config, copy minimal.lua locally, and run nvim --clean -u minimal.lua

❤️ Related Projects

• elfeed
• nvim-rss
• vnews
• lua-feedparser