marked(1)

1marked(1)                          marked.js                         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] [--tables] [--sanitize] [--smart-lists] [--lang-pre‐
12       fix <prefix>] [--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 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       -t, --tokens
39              Output a token stream instead of html.
40
41       --pedantic
42              Conform  to  obscure  parts  of markdown.pl as much as possible.
43              Don't fix original markdown bugs.
44
45       --gfm  Enable github flavored markdown.
46
47       --breaks
48              Enable GFM line breaks. Only works with the gfm option.
49
50       --tables
51              Enable GFM tables. Only works with the gfm option.
52
53       --sanitize
54              Sanitize output. Ignore any HTML input.
55
56       --smart-lists
57              Use smarter list behavior than the original markdown.
58
59       --lang-prefix [prefix]
60              Set the prefix for code block classes.
61
62       --no-sanitize, -no-etc...
63              The inverse of any of the marked options above.
64
65       --silent
66              Silence error output.
67
68       -h, --help
69              Display help information.
70
71

CONFIGURATION

73       For configuring and running programmatically.
74
75       Example
76
77           require('marked')('*foo*', { gfm: true });
78
79

BUGS

81       Please report any bugs to https://github.com/chjj/marked.
82
83

LICENSE

85       Copyright (c) 2011-2014, Christopher Jeffrey (MIT License).
86
87