marked.1 (2274B)
1 .ds q \N'34' 2 .TH marked 1 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] [\-\-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. 18 It also includes 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 \-i 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. 37 If no input file is specified, read from stdin. 38 .TP 39 .BI \-\-test 40 Makes sure the test(s) pass. 41 .RS 42 .PP 43 .B \-\-glob [\fIfile\fP] 44 Specify which test to use. 45 .PP 46 .B \-\-fix 47 Fixes tests. 48 .PP 49 .B \-\-bench 50 Benchmarks the test(s). 51 .PP 52 .B \-\-time 53 Times The test(s). 54 .PP 55 .B \-\-minified 56 Runs test file(s) as minified. 57 .PP 58 .B \-\-stop 59 Stop process if a test fails. 60 .RE 61 .TP 62 .BI \-t,\ \-\-tokens 63 Output a token stream instead of html. 64 .TP 65 .BI \-\-pedantic 66 Conform to obscure parts of markdown.pl as much as possible. 67 Don't fix original markdown bugs. 68 .TP 69 .BI \-\-gfm 70 Enable github flavored markdown. 71 .TP 72 .BI \-\-breaks 73 Enable GFM line breaks. Only works with the gfm option. 74 .TP 75 .BI \-\-sanitize 76 Sanitize output. Ignore any HTML input. 77 .TP 78 .BI \-\-smart\-lists 79 Use smarter list behavior than the original markdown. 80 .TP 81 .BI \-\-lang\-prefix\ [\fIprefix\fP] 82 Set the prefix for code block classes. 83 .TP 84 .BI \-\-mangle 85 Mangle email addresses. 86 .TP 87 .BI \-\-no\-sanitize,\ \-no-etc... 88 The inverse of any of the marked options above. 89 .TP 90 .BI \-\-silent 91 Silence error output. 92 .TP 93 .BI \-h,\ \-\-help 94 Display help information. 95 96 .SH CONFIGURATION 97 For configuring and running programmatically. 98 99 .B Example 100 101 require('marked')('*foo*', { gfm: true }); 102 103 .SH BUGS 104 Please report any bugs to https://github.com/markedjs/marked. 105 106 .SH LICENSE 107 Copyright (c) 2011-2014, Christopher Jeffrey (MIT License). 108 109 .SH "SEE ALSO" 110 .BR markdown(1), 111 .BR node.js(1)