Serves Markdown files over HTTP.
No magic, just serves static files out of a directory. If a file is a
file, it will render the Markdown into HTML. It will serve
index.html when a directory is requested if either exist.
I made this project because I wanted the easiest way to preview documentation
files that would be uploaded to Github. Many existing utilities change the file
name (e.g. request
test.html for the
test.md file) or are too hard to
setup. Note that this is probably not secure, it is not meant for
Install using NPM:
npm install servemd -g
servemd & # Starts the server on port 3000curl http://localhost:3000/ # Get the contents of the README.md file rendered
servemd -d ~/ # Serves files from specified directoryservemd -p 1234 # Listens on the specified portservemd -s mystyles.css # Link the specified CSS file to the HTMLservemd --help # Get more help
It currently does not do any syntax highlighting.