Skip to content
/ mdrss Public
forked from TimoKats/mdrss

Convert markdown files to RSS feed using GO.

License

Notifications You must be signed in to change notification settings

yonasBSD/mdrss

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

44 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

📝MDRSS

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 compliant 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.

Author=Timo
Description=Timo weblog
InputFolder=/path/to/articles/ ; This will contain 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.

About

Convert markdown files to RSS feed using GO.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Go 100.0%