https://github.com/TimoKats/mdrss Skip to content Navigation Menu Toggle navigation Sign in * Product + Actions Automate any workflow + Packages Host and manage packages + Security Find and fix vulnerabilities + Codespaces Instant dev environments + GitHub Copilot Write better code with AI + Code review Manage code changes + Issues Plan and track work + Discussions Collaborate outside of code Explore + All features + Documentation + GitHub Skills + Blog * Solutions By size + Enterprise + Teams + Startups By industry + Healthcare + Financial services + Manufacturing By use case + CI/CD & Automation + DevOps + DevSecOps * Resources Topics + AI + DevOps + Security + Software Development + View all Explore + Learning Pathways + White papers, Ebooks, Webinars + Customer Stories + Partners * Open Source + GitHub Sponsors Fund open source developers + The ReadME Project GitHub community articles Repositories + Topics + Trending + Collections * Enterprise + Enterprise platform AI-powered developer platform Available add-ons + Advanced Security Enterprise-grade security features + GitHub Copilot Enterprise-grade AI features + Premium Support Enterprise-grade 24/7 support * Pricing Search or jump to... Search code, repositories, users, issues, pull requests... Search [ ] Clear Search syntax tips Provide feedback We read every piece of feedback, and take your input very seriously. [ ] [ ] Include my email address so I can be contacted Cancel Submit feedback Saved searches Use saved searches to filter your results more quickly Name [ ] Query [ ] To see all available qualifiers, see our documentation. Cancel Create saved search Sign in Sign up Reseting focus You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session. Dismiss alert {{ message }} TimoKats / mdrss Public * Notifications You must be signed in to change notification settings * Fork 3 * Star 67 Convert markdown files to RSS feed using GO. License GPL-3.0 license 67 stars 3 forks Branches Tags Activity Star Notifications You must be signed in to change notification settings * Code * Issues 1 * Pull requests 1 * Discussions * Actions * Projects 0 * Security * Insights Additional navigation options * Code * Issues * Pull requests * Discussions * Actions * Projects * Security * Insights TimoKats/mdrss This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository. main BranchesTags Go to file Code Folders and files Name Name Last commit Last commit message date Latest commit History 25 Commits .github/workflows .github/ workflows lib lib test test .gitignore .gitignore LICENSE LICENSE README.md README.md go.mod go.mod mdrss.go mdrss.go mdrss_test.go mdrss_test.go View all files Repository files navigation * README * GPL-3.0 license 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. As a result, you don't have to write articles on your website first and have them be read by an RSS reader. Moreover, MDRSS automatically takes care of publication dates, categories (next update), formatting, etc. Getting started You can install the binary using go install github.com/TimoKats/ mdrss@latest (make sure your GOPATH is set correctly!). After this you can add your configuration in ~/.mdrss/config.json. This is a JSON file with a number of settings. You can use this template to setup your configuration { "Author": "Timo Kats", "Description": "Timo's 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 } 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. Publishing the RSS file You can submit your RSS file to a public website, or put it somewhere easily available on a public drive, apache server, etc. Note, there is a chance I will make a function for this on my website so that people who can't host RSS feeds themselves can still publish their feeds. Please let me know if you're interested in such a service. TODO List of features that are on the planning. Feel free to send suggestions here. * Display source code from markdown more correctly. * For non textual RSS readers: render images. * Ordered and unordered lists(!) Why RSS? * No ads/trackers/cookies. * No distractions when reading (it's just text). * Many great RSS readers available (newsboat!) that can create custom feeds. * Doesn't require a strong internet connection. * Amazing scene of personal blogs! About Convert markdown files to RSS feed using GO. Resources Readme License GPL-3.0 license Activity Stars 67 stars Watchers 2 watching Forks 3 forks Report repository Releases 5 Another hotfix for unordered lists Latest Aug 15, 2024 + 4 releases Packages 0 No packages published Languages * Go 100.0% Footer (c) 2024 GitHub, Inc. Footer navigation * Terms * Privacy * Security * Status * Docs * Contact * Manage cookies * Do not share my personal information You can't perform that action at this time.