diff options
| author | BuildTools <unconfigured@null.spigotmc.org> | 2017-10-02 08:47:01 +0200 |
|---|---|---|
| committer | BuildTools <unconfigured@null.spigotmc.org> | 2017-10-02 08:47:01 +0200 |
| commit | b0f6a6b2ab4e7eb3f1d59161106e1f4cee39fc37 (patch) | |
| tree | a37f865edc63a372c6e14cd20e7ad7dafddd3d48 | |
| parent | bugfix (diff) | |
readme
| -rw-r--r-- | README.md | 13 |
1 files changed, 13 insertions, 0 deletions
@@ -1 +1,14 @@ # markdown-viewer + +markdown-viewer is a Node.js application which display markdown files from the specified directory (md by default, can also be a symlink). Files are converted into HTTP pages with github style. + +## To run +``` +git clone https://github.com/Titely/markdown-viewer.git +cd markdown-viewer +``` +Here you will need to create the `md` directory or link where will be stored your .md files. Then: +``` +npm install +npm start +``` |