This is the documentation for the unsupported version 1.0. Please consider upgrading your code to the latest stable version

Command Line

Markdown can be converted at the command line using the ./bin/commonmark script.

Usage

./bin/commonmark [OPTIONS] [FILE]

• -h, --help: Shows help and usage information
• --enable-em: Disable <em> parsing by setting to 0; enable with 1 (default: 1)
• --enable-strong: Disable <strong> parsing by setting to 0; enable with 1 (default: 1)
• --use-asterisk: Disable parsing of * for emphasis by setting to 0; enable with 1 (default: 1)
• --use-underscore: Disable parsing of _ for emphasis by setting to 0; enable with 1 (default: 1)

If no file is given, input will be read from STDIN.

Output will be written to STDOUT.

Examples

Converting a file named document.md

./bin/commonmark document.md

Converting a file and saving its output

./bin/commonmark document.md > output.html

Converting from STDIN

echo -e '# Hello World!' | ./bin/commonmark

Converting from STDIN and saving the output

echo -e '# Hello World!' | ./bin/commonmark > output.html

Edit this page