marked.1.txt (2478B)
1 marked(1) General Commands Manual marked(1) 2 3 NAME 4 marked - a javascript markdown parser 5 6 SYNOPSIS 7 marked [-o <output>] [-i <input>] [--help] [--tokens] [--pedantic] 8 [--gfm] [--breaks] [--sanitize] [--smart-lists] [--lang-prefix <pre- 9 fix>] [--no-etc...] [--silent] [filename] 10 11 12 DESCRIPTION 13 marked is a full-featured javascript markdown parser, built for speed. 14 It also includes multiple GFM features. 15 16 EXAMPLES 17 cat in.md | marked > out.html 18 19 echo "hello *world*" | marked 20 21 marked -o out.html -i in.md --gfm 22 23 marked --output="hello world.html" -i in.md --no-breaks 24 25 OPTIONS 26 -o, --output [output] 27 Specify file output. If none is specified, write to stdout. 28 29 -i, --input [input] 30 Specify file input, otherwise use last argument as input file. 31 If no input file is specified, read from stdin. 32 33 --test Makes sure the test(s) pass. 34 35 --glob [file] Specify which test to use. 36 37 --fix Fixes tests. 38 39 --bench Benchmarks the test(s). 40 41 --time Times The test(s). 42 43 --minified Runs test file(s) as minified. 44 45 --stop Stop process if a test fails. 46 47 -t, --tokens 48 Output a token stream instead of html. 49 50 --pedantic 51 Conform to obscure parts of markdown.pl as much as possible. 52 Don't fix original markdown bugs. 53 54 --gfm Enable github flavored markdown. 55 56 --breaks 57 Enable GFM line breaks. Only works with the gfm option. 58 59 --sanitize 60 Sanitize output. Ignore any HTML input. 61 62 --smart-lists 63 Use smarter list behavior than the original markdown. 64 65 --lang-prefix [prefix] 66 Set the prefix for code block classes. 67 68 --mangle 69 Mangle email addresses. 70 71 --no-sanitize, -no-etc... 72 The inverse of any of the marked options above. 73 74 --silent 75 Silence error output. 76 77 -h, --help 78 Display help information. 79 80 CONFIGURATION 81 For configuring and running programmatically. 82 83 Example 84 85 require('marked')('*foo*', { gfm: true }); 86 87 BUGS 88 Please report any bugs to https://github.com/markedjs/marked. 89 90 LICENSE 91 Copyright (c) 2011-2014, Christopher Jeffrey (MIT License). 92 93 SEE ALSO 94 markdown(1), node.js(1) 95 96 marked(1)