https://github.com/TimoKats/mdrss

Convert markdown files to RSS feed using GO.
https://github.com/TimoKats/mdrss

go markdown rss

Last synced: 1 day ago
JSON representation

Convert markdown files to RSS feed using GO.

• Host: GitHub
• URL: https://github.com/TimoKats/mdrss
• Owner: TimoKats
• License: gpl-3.0
• Created: 2024-07-07T12:17:21.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2025-04-21T05:07:06.000Z (4 days ago)
• Last Synced: 2025-04-21T06:28:26.946Z (4 days ago)
• Topics: go, markdown, rss
• Language: Go
• Homepage:
• Size: 83 KB
• Stars: 115
• Watchers: 2
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • Funding: .github/FUNDING.yml
  • License: license

Awesome Lists containing this project

README

        
# 📝MDRSS

[![Go Report](https://goreportcard.com/badge/github.com/TimoKats/mdrss)](https://goreportcard.com/badge/github.com/TimoKats/mdrss)

[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)

[![GitHub tag](https://img.shields.io/github/tag/TimoKats/mdrss?include_prereleases=&sort=semver&color=blue)](https://github.com/TimoKats/mdrss/releases/)

MDRSS is a markdown to RSS converter written in GO. With this tool, you can write articles in a local folder and have them automatically formatted to an RSS compliamdrss XML file. Moreover, MDRSS automatically takes care of publication dates, categories, formatting, etc.

## Getting started

You can install the binary using `go install github.com/TimoKats/mdrss@latest`. After this you can add your configuration in `~/.mdrss` or you can specify your own config path like so: `mdrss --config other/path/to/config update`.

```ini

Author=Timo

Description=Timo weblog

InputFolder=/path/to/articles/ ; This will comdrssain your markdown files

OutputFile=/path/to/webserver/index.xml

Link=index.xml ; can be anything, might be deprecated

```

## Publication

In your input folder, you can add an article by creating a .md file. Note, if your filename is prefixed with `draft-` it will not be included in the RSS file.  

Finally, you can type `mdrss ls` to view the articles ready for publishing and `mdrss update` to create the RSS feed. Note, the title of the RSS articles are based on markdown headers. E.g. format the first line of the markdown articles as so: `# this is a title`.

## Docs

Note, topics are added based on subfolders in your input folder. For example, if your input folder is `articles/`, then `articles/tech` will contain the markdown files for tech related articles.

  

    

      Field

      Description

    

  

  

    

      Author

      Name of the RSS feed author.

    

    

      Description

      Description of the RSS feed.

    

    

      InputFolder

      Folder containing the markdown files. Add subfolders to enable the usage of topics.

    

    

      OutputFile

      Set this to write all articles to *one* XML file.

    

    

      OutputFolder

      Set this to write RSS topics to seperate XML files in one folder. File names will be based on topics. 

    

    

      Link

      A bit redundant, but you can set this to the page hosting the RSS feed.