mirror of
https://github.com/arnaucube/md-live-server.git
synced 2026-02-07 11:56:39 +01:00
server rendering markdown with live reload on file update working
This commit is contained in:
19
README.md
Normal file
19
README.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# md-live-server
|
||||
Server that renders markdown files and live updates the page each time that the file is updated.
|
||||
|
||||

|
||||
|
||||
## Usage
|
||||
Put 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:
|
||||
```
|
||||
> md-live-server
|
||||
```
|
||||
And then go to the browser at `http://127.0.0.1:8080`
|
||||
|
||||
## Features
|
||||
- [x] server rendering .md files
|
||||
- [x] live reload when .md file changes
|
||||
- [x] directory files list on `/` endpoint
|
||||
- [ ] on error return error page, instead of panic server
|
||||
- [ ] graphviz
|
||||
- [ ] colour `<code>` with syntax highlighting
|
||||
Reference in New Issue
Block a user