mirror of https://github.com/lukechilds/node.git
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
50 lines
1.1 KiB
50 lines
1.1 KiB
13 years ago
|
.ds q \N'34'
|
||
|
|
.TH marked 1
|
||
|
|
.SH NAME
|
||
|
|
marked \- a javascript markdown parser
|
||
|
|
.SH SYNOPSIS
|
||
|
|
.nf
|
||
|
|
.B marked [\-o output] [\-i input] [\-th]
|
||
|
|
.fi
|
||
|
|
.SH DESCRIPTION
|
||
|
|
.B marked
|
||
|
|
is a full-featured javascript markdown parser, built for speed. It also includes
|
||
|
|
multiple GFM features.
|
||
|
|
.SH OPTIONS
|
||
|
|
.TP
|
||
|
|
.BI \-o,\ \-\-output\ [output]
|
||
|
|
Specify file output. If none is specified, write to stdout.
|
||
|
|
.TP
|
||
|
|
.BI \-i,\ \-\-input\ [input]
|
||
|
|
Specify file input, otherwise use last argument as input file. If no input file
|
||
|
|
is specified, read from stdin.
|
||
|
|
.TP
|
||
|
|
.BI \-t,\ \-\-tokens
|
||
|
|
Output a token stream instead of html.
|
||
|
|
.TP
|
||
|
|
.BI \-\-pedantic
|
||
|
|
Conform to obscure parts of markdown.pl as much as possible. Don't fix original
|
||
|
|
markdown bugs.
|
||
|
|
.TP
|
||
|
|
.BI \-\-gfm
|
||
|
|
Enable github flavored markdown.
|
||
|
|
.TP
|
||
|
|
.BI \-\-sanitize
|
||
|
|
Sanitize output. Ignore any HTML input.
|
||
|
|
.TP
|
||
|
|
.BI \-h,\ \-\-help
|
||
|
|
Display help information.
|
||
|
|
.SH EXAMPLES
|
||
|
|
.TP
|
||
|
|
cat in.md | marked > out.html
|
||
|
|
.TP
|
||
|
|
echo "hello *world*" | marked
|
||
|
|
.TP
|
||
|
|
marked -o out.html in.md
|
||
|
|
.TP
|
||
|
|
marked --output="hello world.html" -i in.md
|
||
|
|
.SH BUGS
|
||
|
|
Please report any bugs to https://github.com/chjj/marked.
|
||
|
|
.SH LICENSE
|
||
|
|
Copyright (c) 2011-2012, Christopher Jeffrey (MIT License)
|