https://github.com/arnaucube/md-live-server
Server that renders markdown files and live updates the page each time that the file is updated
https://github.com/arnaucube/md-live-server
Last synced: 3 months ago
JSON representation
Server that renders markdown files and live updates the page each time that the file is updated
- Host: GitHub
- URL: https://github.com/arnaucube/md-live-server
- Owner: arnaucube
- License: gpl-3.0
- Created: 2019-05-07T19:06:30.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-02-02T07:54:34.000Z (over 1 year ago)
- Last Synced: 2025-03-26T21:38:21.362Z (4 months ago)
- Language: Go
- Size: 29.1 MB
- Stars: 9
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# md-live-server
Server that renders markdown files and live updates the page each time that the file is updated.
*(Current visual style is more similar to GitHub's style)*
## 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`
**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:
```
set backupcopy=yes
```
## Features
- [x] server rendering .md files
- [x] live reload when .md file changes
- [x] directory files list on `/` endpoint
- [x] LaTex support
- [x] mermaidjs
- [ ] graphviz