mder v3.0.4

mder

Node.js markdown renderer.

Installing

npm install mder

Usage

const mder = require('mder');

API

.render(markdown: string, options: object): string | buffer

mder.render('# Mder', {
  theme: 'github',      // markdown theme: none/github/vue/segmentfault (default: github)
  stretch: false,       // rendered page with stretching (default: false)
  type: 'html',         // rendered type: html/pdf/png/jpeg (default: html)
  outfile: 'mder.html', // outfile name (default: '')
});

CLI

npm install mder -g

$ mder -h

Usage: mder [command] [options]

Markdown Renderer

Options:
  -v, --version                              output the version number
  -h, --help                                 output usage information

Commands:
  render [options] <markdownFile> [outfile]  render markdown
  config [operate] [key] [value]             default configuration
  register                                   register Mder into the operating system's menu
  unregister                                 unregister Mder from the operating system's menu

Examples:
$ mder 

$ mder render -h

Usage: render [options] <markdownFile> [outfile]

render markdown to html/pdf/png/jpeg

Options:
  -t, --theme <theme>  markdown theme: none/github/vue/segmentfault
  -s, --stretch        rendered page with stretching
  -h, --help           output usage information

Examples:
$ mder render README.md README.html -t github -s
$ mder README.md
$ mder README.md README.html -t segmentfault -s
$ mder README.md README.pdf -t none
$ mder README.md README.png -t vue
$ mder README.md README.jpeg

$ mder config -h

Usage: config [operate: set/get/delete/reset] [key] [value]

default configuration

Options:
  -h, --help  output usage information

Examples:
$ mder config
$ mder config set type pdf
$ mder config get type
$ mder config reset
$ mder config delete theme

$ mder register -h

Usage: register [options]

register Mder into the operating system's menu

Options:
  -h, --help  output usage information

Examples:
$ mder register

$ mder unregister -h

Usage: unregister [options]

unregister Mder from the operating system's menu

Options:
  -h, --help  output usage information

Examples:
$ mder unregister