marked/man/marked.1.txt

91 lines
2.6 KiB
Plaintext
Raw Normal View History

2019-03-10 05:24:28 +00:00
marked(1) marked.js marked(1)
2018-01-08 18:41:33 +00:00
NAME
marked - a javascript markdown parser
SYNOPSIS
2019-03-10 05:24:28 +00:00
marked [-o <output>] [-i <input>] [--help] [--tokens] [--pedantic] [--gfm] [--breaks] [--tables] [--sanitize] [--smart-lists]
[--lang-prefix <prefix>] [--no-etc...] [--silent] [filename]
2018-01-08 18:41:33 +00:00
DESCRIPTION
2019-03-10 05:24:28 +00:00
marked is a full-featured javascript markdown parser, built for speed. It also includes multiple GFM features.
2018-01-08 18:41:33 +00:00
EXAMPLES
cat in.md | marked > out.html
echo "hello *world*" | marked
2018-04-05 19:36:01 +00:00
marked -o out.html -i in.md --gfm
2018-01-08 18:41:33 +00:00
marked --output="hello world.html" -i in.md --no-breaks
OPTIONS
-o, --output [output]
2019-03-10 05:24:28 +00:00
Specify file output. If none is specified, write to stdout.
2018-01-08 18:41:33 +00:00
-i, --input [input]
2019-03-10 05:24:28 +00:00
Specify file input, otherwise use last argument as input file. If no input file is specified, read from stdin.
--test Makes sure test file(s) pass.
--glob [file] Specify test file to use.
--bench Benchmarks the test file(s).
--time Times The test file(s).
--Run Runs test file(s) as minified.
2018-01-08 18:41:33 +00:00
-t, --tokens
2019-03-10 05:24:28 +00:00
Output a token stream instead of html.
2018-01-08 18:41:33 +00:00
--pedantic
2019-03-10 05:24:28 +00:00
Conform to obscure parts of markdown.pl as much as possible. Don't fix original markdown bugs.
2018-01-08 18:41:33 +00:00
--gfm Enable github flavored markdown.
--breaks
2019-03-10 05:24:28 +00:00
Enable GFM line breaks. Only works with the gfm option.
2018-01-08 18:41:33 +00:00
--tables
2019-03-10 05:24:28 +00:00
Enable GFM tables. Only works with the gfm option.
2018-01-08 18:41:33 +00:00
--sanitize
2019-03-10 05:24:28 +00:00
Sanitize output. Ignore any HTML input.
2018-01-08 18:41:33 +00:00
--smart-lists
2019-03-10 05:24:28 +00:00
Use smarter list behavior than the original markdown.
2018-01-08 18:41:33 +00:00
--lang-prefix [prefix]
2019-03-10 05:24:28 +00:00
Set the prefix for code block classes.
2018-01-08 18:41:33 +00:00
--mangle
2019-03-10 05:24:28 +00:00
Mangle email addresses.
2018-01-08 18:41:33 +00:00
--no-sanitize, -no-etc...
2019-03-10 05:24:28 +00:00
The inverse of any of the marked options above.
2018-01-08 18:41:33 +00:00
--silent
2019-03-10 05:24:28 +00:00
Silence error output.
2018-01-08 18:41:33 +00:00
-h, --help
2019-03-10 05:24:28 +00:00
Display help information.
2018-01-08 18:41:33 +00:00
CONFIGURATION
For configuring and running programmatically.
Example
2019-03-10 05:24:28 +00:00
require('marked')('*foo*', { gfm: true });
2018-01-08 18:41:33 +00:00
BUGS
Please report any bugs to https://github.com/markedjs/marked.
2018-01-08 18:41:33 +00:00
LICENSE
Copyright (c) 2011-2014, Christopher Jeffrey (MIT License).
SEE ALSO
markdown(1), node.js(1)
2019-03-10 05:24:28 +00:00
v0.3.1 2014-01-31 marked(1)