md-live-server/README.md
README.mdRaw
1# md-live-server
2Server that renders markdown files and live updates the page each time that the file is updated.
3
4
5
6## Usage
7Put the binary file `md-live-server` in your `$PATH`, and then go to the directory where are the markdown files that want to live render, and just use:
8```
9> md-live-server
10```
11And then go to the browser at `http://127.0.0.1:8080`
12
13**Warning for vim / nvim users**: vim by default selects the writting strategy, and sometimes writes directly to the files and other times renames the old file and writes a new one. This is solved by adding this line to the `.vimrc` / `init.vim` file:
14
15```
16set backupcopy=yes
17```
18
19## Features
20- [x] server rendering .md files
21- [x] live reload when .md file changes
22- [x] directory files list on `/` endpoint
23- [x] LaTex support
24- [x] mermaidjs
25- [ ] graphviz
26- [ ] colour `<code>` with syntax highlighting