https://github.com/alekzonder/mrk

simple markdown server
https://github.com/alekzonder/mrk

markdown server

Last synced: 3 months ago
JSON representation

simple markdown server

• Host: GitHub
• URL: https://github.com/alekzonder/mrk
• Owner: alekzonder
• License: mit
• Created: 2017-01-30T03:22:00.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2023-01-22T07:17:26.000Z (almost 2 years ago)
• Last Synced: 2024-10-11T20:11:22.616Z (3 months ago)
• Topics: markdown, server
• Language: JavaScript
• Homepage:
• Size: 419 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# mrk

[![NPM](https://nodei.co/npm/mrk.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/mrk/)

simple markdown server

can render and upload your docs to webdav

powered with [markdown-it](https://github.com/markdown-it/markdown-it)

styles from [github-markdown-css](https://github.com/sindresorhus/github-markdown-css)

highlight code with [highlight.js](https://highlightjs.org/)

![img](docs/screenshot.png)

# install

```

npm install -g mrk@latest

```

# usage

## start

alias: s

- start markdown server on 3334 port for all network interfaces

- watch all .md files in current work directory

- recompile .md on change

open in browser http://localhost:3334

```

mrk

# OR

mrk start

# OR

mrk s

```

## render [work dir]

alias: r

render all .md files in current work directory to ./www_md directory

### options

`--footer ` - set your custom footer with analytics or js

`--raw` - render without header and footer

## clean

alias: c

clean all rendered files

## upload 

alias: up

upload rendered files to webdav

```

mrk upload http://example.com/docs/

```

# LICENSE

MIT