UNPKG

2.15 kBPlain TextView Raw
1marked(1) marked.js marked(1)
2
3
4
5NAME
6 marked - a javascript markdown parser
7
8
9SYNOPSIS
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
15DESCRIPTION
16 marked is a full-featured javascript markdown parser, built for speed.
17 It also includes multiple GFM features.
18
19
20EXAMPLES
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
30OPTIONS
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 --mangle
63 Mangle email addresses.
64
65 --no-sanitize, -no-etc...
66 The inverse of any of the marked options above.
67
68 --silent
69 Silence error output.
70
71 -h, --help
72 Display help information.
73
74
75CONFIGURATION
76 For configuring and running programmatically.
77
78 Example
79
80 require('marked')('*foo*', { gfm: true });
81
82
83BUGS
84 Please report any bugs to https://github.com/markedjs/marked.
85
86
87LICENSE
88 Copyright (c) 2011-2014, Christopher Jeffrey (MIT License).
89
90
91SEE ALSO
92 markdown(1), node.js(1)
93
94
95
96v0.3.1 2014-01-31 marked(1)