carbon-now-dir

0.9.1 • Public • Published

Open Source Love styled with prettier PRs Welcome License: MIT Maintenance

carbon-now-dir wraps around carbon-now-cli to generate beautiful images of the source code in the specified directory, matched by the specific wildcard.

Installation

npx

You can invoke carbon-now-dir directly by simply using npx

npx carbon-now-dir

npm

npm install -g carbon-now-dir

yarn

yarn global add carbon-now-dir

Usage

Most of the options available in carbon-now-cli are available in carbon-now-dir too.

You can invoke carbon-now-dir --help, which will show:

Generate beautiful images of your code in files in the specified directory.

Usage
  $ carbon-now-dir <directory> -w "*.js"
Options
  -l, --location       Image save location, default: cwd
  -p, --preset         Use a saved preset
  -h, --headless       Use only non-experimental Puppeteer features
  -w, --wildcard       Use a wildcard for matching files in the directory
  --config             Use a different, local config (read-only)

NOTE: The wildcard flag is required!

Presets

You can reuse presets created in carbon-now-cli by simply passing the -p or --preset flag with the preset name.

Assuming you have a preset called my-preset, and you want to capture all JavaScript files in the examples directory, you would write:

carbon-now-dir examples -w "*.js" -p my-preset

More

for more in-depth documentation, you can visit the repository for carbon-now-cli.

License

MIT © Mark Molnar

Package Sidebar

Install

npm i carbon-now-dir

Weekly Downloads

2

Version

0.9.1

License

MIT

Unpacked Size

6.48 kB

Total Files

5

Last publish

Collaborators

  • molnarmark