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: about 10 hours 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 (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-02-02T07:54:34.000Z (9 months ago)
• Last Synced: 2024-06-20T13:49:03.361Z (5 months ago)
• Language: Go
• Size: 29.1 MB
• Stars: 6
• Watchers: 3
• Forks: 2
• 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.

![screenshot00](https://raw.githubusercontent.com/arnaucube/md-live-server/master/screenshot00.png 'screenshot00')

*(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