node package manager
Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org ยป

mrk

mrk

bitHound Code bitHound Overall Score bitHound Dependencies

NPM

simple markdown server

can render and upload your docs to webdav

powered with markdown-it

styles from github-markdown-css

highlight code with highlight.js

img

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 <filepath> - 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