Skip to content
Converts source code to high quality images.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.gitignore
.npmignore
LICENSE
README.md
example.png
index.js
package-lock.json
package.json

README.md

src2img CLI

NPM version JavaScript Style Guide

Converts source code to high quality images.

Install

Install with npm:

$ 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 --help

Output:

Usage: index [options] [command]

  Options:

    -V, --version                    output the version number
    -h, --help                       output usage information

  Commands:

    render [options] <filenames...>  converts source code to high quality images
    presets                          lists saved presets
    open                             opens the presets file

Display the render help information:

$ src2img render --help

Output:

Usage: 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           output usage information

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:

example

Related

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Running Tests

Install dev dependencies:

$ npm i -d && npm test

Author

Tomer Aberbach

License

Copyright © 2018 Tomer Aberbach Released under the MIT license.

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.