Markdown Worm is a simple GoLang file server for storing & sharing Markdown notes. It's useful for you and your teammates to share technical documents and thoughts. One can easily write a markdown doc and upload it to mdworm by a FTP client. You can see the content of Markdown file as a rendered html on your web browser.
- download mdworm binary release and place its folder under a path which can be accessed by FTP client.
- start mdworm by
$./mdworm -p <port>, also make sure that port is allowed by firewall
- put some markdown files (or new folders) under
- open your browser and visit
Changes since v1.0.1
The first version of mdworm is written in PHP, which is pretty slow and old fashioned, so at
v2.0.0, it was rewritten by GoLang. Plus mdworm can now recognize folders under
Plus plus this time windows is not supported.
1. Show File & Folders under
golang-markdown will convert md to HTML2.
Highlight.js highlights your code3.
The new md parser has a weird feature, which requires you to add a space between
title and its surrounding hash tags, for example
#title# won't be parsed correctly, you
# title # instead
Mac & Linux
Download & Unzip
cd /to/dir/ # For Mac wget https://github.com/bclicn/MarkdownWorm/releases/download/2.0.0/mdworm-2.0.0-darwin-bin.tar.gz tar zxvf mdworm-2.0.0-darwin.tar.gz # For Linux https://github.com/bclicn/MarkdownWorm/releases/download/2.0.0/mdworm-2.0.0-linux-bin.tar.gz tar zxvf mdworm-2.0.0-linux.tar.gz
cd mdworm-2.0.0-* ./mdworm
Open your browser and type
You can also point out the port by
-p, code theme by
-t, like bellow, A full list of highlights themes can be found under
# listen on port 6666 ./mdworm -p 6666 # change highlight theme to darcula ./mdworm -t darcula # listen on port 6666 & change highlight theme to darcula ./mdworm -p 6666 -t darcula
If you want to (usually will) run in daemon mode, just add
&at the end
Beichen Li 2016-11-1