Contributing to Marp CLI

Thank you for taking the time to read how to contribute to Marp CLI! This is the guideline for contributing to Marp CLI.

We are following the contributing guideline of Marp team projects. You have to read this before starting work.

Development

# Build (Bundle and minify)
yarn build

# Watch (Bundle only)
yarn watch

Use ./marp-cli.js instead of marp command.

./marp-cli.js --help

Standalone binaries created by pkg will output to ./bin directory.

# Build & create standalone binaries
yarn build:standalone

./bin/marp-cli-linux --help

If you have any trouble with Marp CLI, --debug (-d) option will help you to find the cause of the problem.

marp --debug=true slide.md

# Show debug log about marp-cli:browser, except marp-cli:browser:finder
marp --debug "marp-cli:browser*,-marp-cli:browser:finder" slide.md

You can use DEBUG environment variable to enable debug log filter too: DEBUG="marp-cli:browser*,-marp-cli:browser:finder"

marp --debug=all slide.md

It is equivalent to DEBUG="*" marp slide.md.

Note

--debug (-d) option is available only for CLI interface. If you are using API, you have to use DEBUG environment variable instead.