marked(1)

1marked(1)                   General Commands Manual                  marked(1)
2
3
4

NAME

6       marked - a javascript markdown parser
7
8

SYNOPSIS

10       marked  [-o  <output>]  [-i  <input>]  [--help] [--tokens] [--pedantic]
11       [--gfm] [--breaks] [--sanitize]  [--smart-lists]  [--lang-prefix  <pre‐
12       fix>] [--no-etc...] [--silent] [filename]
13
14

DESCRIPTION

16       marked  is a full-featured javascript markdown parser, built for speed.
17       It also includes multiple GFM features.
18
19

EXAMPLES

21       cat in.md | marked > out.html
22
23       echo "hello *world*" | marked
24
25       marked -o out.html -i in.md --gfm
26
27       marked --output="hello world.html" -i in.md --no-breaks
28
29

OPTIONS

31       -o, --output [output]
32              Specify file output. If none is specified, write to stdout.
33
34       -i, --input [input]
35              Specify file input, otherwise use last argument as  input  file.
36              If no input file is specified, read from stdin.
37
38       --test Makes sure the test(s) pass.
39
40              --glob [file] Specify which test to use.
41
42              --fix Fixes tests.
43
44              --bench Benchmarks the test(s).
45
46              --time Times The test(s).
47
48              --minified Runs test file(s) as minified.
49
50              --stop Stop process if a test fails.
51
52       -t, --tokens
53              Output a token stream instead of html.
54
55       --pedantic
56              Conform  to  obscure  parts  of markdown.pl as much as possible.
57              Don't fix original markdown bugs.
58
59       --gfm  Enable github flavored markdown.
60
61       --breaks
62              Enable GFM line breaks. Only works with the gfm option.
63
64       --sanitize
65              Sanitize output. Ignore any HTML input.
66
67       --smart-lists
68              Use smarter list behavior than the original markdown.
69
70       --lang-prefix [prefix]
71              Set the prefix for code block classes.
72
73       --mangle
74              Mangle email addresses.
75
76       --no-sanitize, -no-etc...
77              The inverse of any of the marked options above.
78
79       --silent
80              Silence error output.
81
82       -h, --help
83              Display help information.
84
85

CONFIGURATION

87       For configuring and running programmatically.
88
89       Example
90
91           require('marked')('*foo*', { gfm: true });
92
93

BUGS

95       Please report any bugs to https://github.com/markedjs/marked.
96
97

LICENSE

99       Copyright (c) 2011-2014, Christopher Jeffrey (MIT License).
100
101