Code Monkey home page Code Monkey logo

mdrss's Introduction

📝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!

mdrss's People

Contributors

timokats avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.