| OLD | NEW |
| (Empty) |
| 1 .ds q \N'34' | |
| 2 .TH marked 1 "2014-01-31" "v0.3.1" "marked.js" | |
| 3 | |
| 4 .SH NAME | |
| 5 marked \- a javascript markdown parser | |
| 6 | |
| 7 .SH SYNOPSIS | |
| 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 | |
| 15 .SH DESCRIPTION | |
| 16 .B marked | |
| 17 is a full-featured javascript markdown parser, built for speed. It also includes | |
| 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 | |
| 30 .SH OPTIONS | |
| 31 .TP | |
| 32 .BI \-o,\ \-\-output\ [\fIoutput\fP] | |
| 33 Specify file output. If none is specified, write to stdout. | |
| 34 .TP | |
| 35 .BI \-i,\ \-\-input\ [\fIinput\fP] | |
| 36 Specify file input, otherwise use last argument as input file. If no input file | |
| 37 is specified, read from stdin. | |
| 38 .TP | |
| 39 .BI \-t,\ \-\-tokens | |
| 40 Output a token stream instead of html. | |
| 41 .TP | |
| 42 .BI \-\-pedantic | |
| 43 Conform to obscure parts of markdown.pl as much as possible. Don't fix original | |
| 44 markdown bugs. | |
| 45 .TP | |
| 46 .BI \-\-gfm | |
| 47 Enable github flavored markdown. | |
| 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 | |
| 55 .BI \-\-sanitize | |
| 56 Sanitize output. Ignore any HTML input. | |
| 57 .TP | |
| 58 .BI \-\-smart\-lists | |
| 59 Use smarter list behavior than the original markdown. | |
| 60 .TP | |
| 61 .BI \-\-lang\-prefix\ [\fIprefix\fP] | |
| 62 Set the prefix for code block classes. | |
| 63 .TP | |
| 64 .BI \-\-no\-sanitize,\ \-no-etc... | |
| 65 The inverse of any of the marked options above. | |
| 66 .TP | |
| 67 .BI \-\-silent | |
| 68 Silence error output. | |
| 69 .TP | |
| 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 | |
| 80 .SH BUGS | |
| 81 Please report any bugs to https://github.com/chjj/marked. | |
| 82 | |
| 83 .SH LICENSE | |
| 84 Copyright (c) 2011-2014, Christopher Jeffrey (MIT License). | |
| 85 | |
| 86 .SH "SEE ALSO" | |
| 87 .BR markdown(1), | |
| 88 .BR node.js(1) | |
| OLD | NEW |