aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: e3470f10a688984a818b54b0d2067c3e3436355b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
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
```