carl-md

1.1.0 • Public • Published

Carl

Carl, because Mark would be too obvious.

Carl is meant as a zero configuration Markdown to PDF converter. Uses Nightmare under the hood to convert the Markdown document to HTML before converting to PDF.

Installation

npm install -g carl-md

Usage

Carl - Convert Markdown to PDF

Usage: carl [options] <markdown-file-path>

Options:
  -h, --help          Output usage information
  -o, --output        Specify output file
  -g, --github        Render Markdown using Github flavoured CSS
  -s, --stylesheet    Path to custom CSS
  -d, --debug         Enable debug information

Docs: https://github.com/Briix/carl
Bugs: https://github.com/Briix/carl/issues

Although Carl does provide some basic options, it works out of the box without using any of the options.

License

MIT

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

Crafted with <3 by Simon Brix (@br11x).

Readme

Keywords

Package Sidebar

Install

npm i carl-md

Weekly Downloads

3

Version

1.1.0

License

MIT

Last publish

Collaborators

  • briix