August 18th, 2024

Convert Markdown files to RSS feed

MDRSS is a Go-based tool that converts markdown articles into RSS XML files, allowing local management and publication. It supports easy installation, configuration, and future enhancements for improved usability.

Read original articleLink Icon
Convert Markdown files to RSS feed

MDRSS is a markdown to RSS converter developed in Go, enabling users to write articles in markdown format locally and convert them into an RSS-compliant XML file. This tool allows for local article management without the need for prior website publication. To get started, users can install the binary via the command `go install github.com/TimoKats/mdrss@latest`, ensuring their GOPATH is correctly set. Configuration requires creating a JSON file at `~/.mdrss/config.json`, specifying details such as author name, description, input folder for markdown files, output file location, and link. Articles can be added by placing markdown files in the designated input folder, with files prefixed by `draft-` excluded from the RSS feed. Users can list articles ready for publishing with the command `mdrss ls` and generate the RSS feed using `mdrss update`, where the article titles are derived from the first markdown header. The generated RSS file can be hosted on a public server, and the author is considering offering a hosting service for users unable to do so. Future enhancements include improved source code display, image rendering, and support for lists. The benefits of using RSS include an ad-free experience, compatibility with various readers, and support for personal blogs.

- MDRSS converts markdown articles to RSS XML files.

- Installation and configuration are straightforward with provided commands.

- Articles prefixed with `draft-` are excluded from the RSS feed.

- Future features aim to enhance usability and presentation.

- RSS offers a distraction-free reading experience without ads or trackers.

Link Icon 8 comments
By @xrd - 4 months
I assume this is just a bunch of markdown files you want to convert to RSS? I'm struggling to think of why you would want an RSS feed for a bunch of markdown files that were not part of a blog already? Svekyll (my svelte derivative of Jekyll) generates RSS as well. It isn't that simple, there are lots of validations that can break readers; this has taken quite a few bug fixes to get right:

https://extrastatic.dev/svekyll/svekyll-cli/-/merge_requests...

FWIW: I wrote a post using Svekyll about AI embeddings which has a view source button at the bottom. If you click that, you can download a full svekyll blog and add the RSS code to the _config.yml and then just "npm i && npm run build" to see it generate the RSS for that complex post. Then, look at it in your feed reader to see how it escapes the HTML, code blocks, images, etc.

https://webiphany.com/2024-04-29-distance-sean-shawn

By @mro_name - 4 months
The "Why RSS" doesn't mention why instead of RFC4287 Atom.
By @kokada - 4 months
I do something similar to my blog, I even wrote an article about it (that is out-of-date, but the idea is the same): https://kokada.capivaras.dev/blog/using-github-as-a-bad-blog....

Basically I write the posts in Markdown, commit them to the repository and it automatically generates a RSS feed and a index in the repository (inside the README.md file), and also publishes the blog posts to https://kokada.capivaras.dev/, that is where the blog actually lives.

By @oliverkwebb - 4 months
> As a result, you don't have to write articles on your website first and have them be read by an RSS reader.

I don't see how this is a problem, for proper preview, the markdown will have to get compiled into HTML/text anyway.

Most SSG's do this, but this can also be done with a good enough markdown compiler (cough lowdown) and a for loop. Without restricting your markdown formatting to a subset of the features of 2 markdown compilers

By @hactually - 4 months
I've got a WIP markdown to blog project Im working on. I just want to dump MD in a folder and have it create a static site. Could I use this project to generate an RSS and have that added to the final static folder?
By @kitd - 4 months
Very nice and simple idea!

One question: how are the articles linked in the RSS file? Are they relative to that file and/or assumed to be in the same folder?

By @treetalker - 4 months
Very cool. Big ups for RSS.

Does not currently support ordered or unordered lists.