md2image
v0.1.0
Published
markdown to image
Downloads
7
Readme
md2img
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 => '[email protected]'
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
- Fork it on GitHub!
- Clone the fork to your own machine.
- Checkout your feature branch:
git checkout -b my-awesome-feature
- Commit your changes to your own branch:
git commit -am 'Add some feature'
- Push your work back up to your fork:
git push -u origin my-awesome-feature
- 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