0.1.0 • Published 4 years ago

md2image v0.1.0

Weekly downloads
1
License
MIT
Repository
github
Last release
4 years ago

md2img

NPM Downloads NPM Version License Dependency Status devDependency Status Code Style

markdown to image

Installation

$ npm install md2img

# or yarn
$ yarn add md2img

Usage

const md2Img = require('md2img')
const result = md2Img('README.md', 'README.png')
// result => 'zce@zce.me'

API

md2Img(name, options)

name

  • Type: string
  • Details: name string

options

host
  • Type: string
  • Details: host string
  • Default: 'zce.me'

CLI Usage

$ yarn global add md2img

# or npm
$ npm install md2img -g
$ md2img --help

  Usage: md2img <input>

  Options:

    -V, --version  output the version number
    -H, --host     Email host
    -h, --help     output usage information

Contributing

  1. Fork it on GitHub!
  2. Clone the fork to your own machine.
  3. Checkout your feature branch: git checkout -b my-awesome-feature
  4. Commit your changes to your own branch: git commit -am 'Add some feature'
  5. Push your work back up to your fork: git push -u origin my-awesome-feature
  6. Submit a Pull Request so that we can review your changes.

NOTE: Be sure to merge the latest from "upstream" before making a pull request!

License

MIT © zyd