arnaucube
arnaucube/md-live-serverPublic Self-hosted repository
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![screenshot00](https://raw.githubusercontent.com/arnaucube/md-live-server/master/screenshot00.png 'screenshot00')
 5*(Current visual style is more similar to GitHub's style)*
 6
 7## Usage
 8Put 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:
 9```
10> md-live-server
11```
12And then go to the browser at `http://127.0.0.1:8080`
13
14**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:
15
16```
17set backupcopy=yes
18```
19
20## Features
21- [x] server rendering .md files
22- [x] live reload when .md file changes
23- [x] directory files list on `/` endpoint
24- [x] LaTex support
25- [x] mermaidjs
26- [ ] graphviz