mirror of https://github.com/arnaucube/md-live-server.git synced 2026-06-17 04:51:48 +02:00

No description

Go 99.6%
Shell 0.4%

Find a file

arnaucube be5da520ed add flag to set port		2026-06-03 22:25:57 +02:00
.gitignore	update go version & fix go/x/sys dependancy for darwin compilation. add compile.sh and rm binary to upload it as release.	2023-08-04 11:38:49 +02:00
compile.sh	update go version & fix go/x/sys dependancy for darwin compilation. add compile.sh and rm binary to upload it as release.	2023-08-04 11:38:49 +02:00
css.go	add github css style	2024-02-02 08:52:59 +01:00
go.mod	add github css style	2024-02-02 08:52:59 +01:00
go.sum	update go version & fix go/x/sys dependancy for darwin compilation. add compile.sh and rm binary to upload it as release.	2023-08-04 11:38:49 +02:00
LICENSE	Initial commit	2019-05-07 21:06:30 +02:00
main.go	add flag to set port	2026-06-03 22:25:57 +02:00
README.md	add github css style	2024-02-02 08:52:59 +01:00
screenshot00.png	Add LaTex support	2021-05-28 12:01:52 +02:00
templates.go	add github css style	2024-02-02 08:52:59 +01:00
test.md	add github css style	2024-02-02 08:52:59 +01:00
utils.go	add github css style	2024-02-02 08:52:59 +01:00

README.md

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

server rendering .md files
live reload when .md file changes
directory files list on / endpoint
LaTex support
mermaidjs
graphviz