marked 0.2.6 → 0.2.10
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +1 -1
- package/Makefile +3 -0
- package/README.md +244 -51
- package/bin/marked +108 -48
- package/component.json +10 -0
- package/lib/marked.js +628 -244
- package/man/marked.1 +53 -14
- package/package.json +9 -4
package/man/marked.1
CHANGED
|
@@ -1,21 +1,38 @@
|
|
|
1
1
|
.ds q \N'34'
|
|
2
|
-
.TH marked 1
|
|
2
|
+
.TH marked 1 "2013-01-05" "v0.2.7" "marked.js"
|
|
3
|
+
|
|
3
4
|
.SH NAME
|
|
4
5
|
marked \- a javascript markdown parser
|
|
6
|
+
|
|
5
7
|
.SH SYNOPSIS
|
|
6
|
-
.
|
|
7
|
-
|
|
8
|
-
|
|
8
|
+
.B marked
|
|
9
|
+
[\-o \fI<output>\fP] [\-i \fI<input>\fP] [\-\-help]
|
|
10
|
+
[\-\-tokens] [\-\-pedantic] [\-\-gfm]
|
|
11
|
+
[\-\-breaks] [\-\-tables] [\-\-sanitize]
|
|
12
|
+
[\-\-smart\-lists] [\-\-lang\-prefix \fI<prefix>\fP]
|
|
13
|
+
[\-\-no\-etc...] [\-\-silent] [\fIfilename\fP]
|
|
14
|
+
|
|
9
15
|
.SH DESCRIPTION
|
|
10
16
|
.B marked
|
|
11
17
|
is a full-featured javascript markdown parser, built for speed. It also includes
|
|
12
18
|
multiple GFM features.
|
|
19
|
+
|
|
20
|
+
.SH EXAMPLES
|
|
21
|
+
.TP
|
|
22
|
+
cat in.md | marked > out.html
|
|
23
|
+
.TP
|
|
24
|
+
echo "hello *world*" | marked
|
|
25
|
+
.TP
|
|
26
|
+
marked -o out.html in.md --gfm
|
|
27
|
+
.TP
|
|
28
|
+
marked --output="hello world.html" -i in.md --no-breaks
|
|
29
|
+
|
|
13
30
|
.SH OPTIONS
|
|
14
31
|
.TP
|
|
15
|
-
.BI \-o,\ \-\-output\ [
|
|
32
|
+
.BI \-o,\ \-\-output\ [\fIoutput\fP]
|
|
16
33
|
Specify file output. If none is specified, write to stdout.
|
|
17
34
|
.TP
|
|
18
|
-
.BI \-i,\ \-\-input\ [
|
|
35
|
+
.BI \-i,\ \-\-input\ [\fIinput\fP]
|
|
19
36
|
Specify file input, otherwise use last argument as input file. If no input file
|
|
20
37
|
is specified, read from stdin.
|
|
21
38
|
.TP
|
|
@@ -29,21 +46,43 @@ markdown bugs.
|
|
|
29
46
|
.BI \-\-gfm
|
|
30
47
|
Enable github flavored markdown.
|
|
31
48
|
.TP
|
|
49
|
+
.BI \-\-breaks
|
|
50
|
+
Enable GFM line breaks. Only works with the gfm option.
|
|
51
|
+
.TP
|
|
52
|
+
.BI \-\-tables
|
|
53
|
+
Enable GFM tables. Only works with the gfm option.
|
|
54
|
+
.TP
|
|
32
55
|
.BI \-\-sanitize
|
|
33
56
|
Sanitize output. Ignore any HTML input.
|
|
34
57
|
.TP
|
|
35
|
-
.BI \-
|
|
36
|
-
|
|
37
|
-
.SH EXAMPLES
|
|
58
|
+
.BI \-\-smart\-lists
|
|
59
|
+
Use smarter list behavior than the original markdown.
|
|
38
60
|
.TP
|
|
39
|
-
|
|
61
|
+
.BI \-\-lang\-prefix\ [\fIprefix\fP]
|
|
62
|
+
Set the prefix for code block classes.
|
|
40
63
|
.TP
|
|
41
|
-
|
|
64
|
+
.BI \-\-no\-sanitize,\ \-no-etc...
|
|
65
|
+
The inverse of any of the marked options above.
|
|
42
66
|
.TP
|
|
43
|
-
|
|
67
|
+
.BI \-\-silent
|
|
68
|
+
Silence error output.
|
|
44
69
|
.TP
|
|
45
|
-
|
|
70
|
+
.BI \-h,\ \-\-help
|
|
71
|
+
Display help information.
|
|
72
|
+
|
|
73
|
+
.SH CONFIGURATION
|
|
74
|
+
For configuring and running programmatically.
|
|
75
|
+
|
|
76
|
+
.B Example
|
|
77
|
+
|
|
78
|
+
require('marked')('*foo*', { gfm: true });
|
|
79
|
+
|
|
46
80
|
.SH BUGS
|
|
47
81
|
Please report any bugs to https://github.com/chjj/marked.
|
|
82
|
+
|
|
48
83
|
.SH LICENSE
|
|
49
|
-
Copyright (c) 2011-
|
|
84
|
+
Copyright (c) 2011-2013, Christopher Jeffrey (MIT License).
|
|
85
|
+
|
|
86
|
+
.SH "SEE ALSO"
|
|
87
|
+
.BR markdown(1),
|
|
88
|
+
.BR node.js(1)
|
package/package.json
CHANGED
|
@@ -2,15 +2,20 @@
|
|
|
2
2
|
"name": "marked",
|
|
3
3
|
"description": "A markdown parser built for speed",
|
|
4
4
|
"author": "Christopher Jeffrey",
|
|
5
|
-
"version": "0.2.
|
|
5
|
+
"version": "0.2.10",
|
|
6
6
|
"main": "./lib/marked.js",
|
|
7
7
|
"bin": "./bin/marked",
|
|
8
8
|
"man": "./man/marked.1",
|
|
9
|
-
"preferGlobal":
|
|
9
|
+
"preferGlobal": true,
|
|
10
10
|
"repository": "git://github.com/chjj/marked.git",
|
|
11
11
|
"homepage": "https://github.com/chjj/marked",
|
|
12
12
|
"bugs": { "url": "http://github.com/chjj/marked/issues" },
|
|
13
|
-
"keywords": [
|
|
14
|
-
"tags": [
|
|
13
|
+
"keywords": ["markdown", "markup", "html"],
|
|
14
|
+
"tags": ["markdown", "markup", "html"],
|
|
15
|
+
"devDependencies": {
|
|
16
|
+
"markdown": "*",
|
|
17
|
+
"showdown": "*",
|
|
18
|
+
"robotskirt": "*"
|
|
19
|
+
},
|
|
15
20
|
"scripts": { "test": "node test", "bench": "node test --bench" }
|
|
16
21
|
}
|