src2img-cli
v2.0.1
Published
Converts source code to high quality images.
Downloads
16
Maintainers
Readme
Install
$ npm i src2img-cli
Install
$ npm i src2img-cli -g
If you encounter permission errors run the following instead:
$ sudo npm i src2img-cli -g --unsafe-perm=true --allow-root
The permission errors are related to puppeteer. See this issue.
Usage
Display the help information:
$ src2img
Output:
Usage: src2img [options] [command]
Options:
-h, --help display help for command
Commands:
render [options] <filenames...> converts source code to high quality images
presets lists saved presets
open opens the presets file
help [command] display help for command
Display the render help information:
$ src2img help render
Output:
Usage: src2img render [options] <filenames...>
converts source code to high quality images
Options:
-o, --out <dir> specifies an output directory (default: ".")
-t, --type <type> specifies an output file type (png or jpeg)
(default: "png")
-n, --port <number> specifies a port number (default: 8888)
-p, --preset <name> uses a preset
-h, --help display help for command
Simple rendering example:
$ src2img render myfile.js
Follow the prompts as they pop up and feel free to save a preset! You can reuse
a saved preset using the -p
or --preset
flag as shown above.
Note that the best way to increase the resolution of the rendered image is to choose a high font size in the prompts.
Some rendered code:
Related
Contributing
Stars are always welcome!
For bugs and feature requests, please create an issue.