marked.1 2.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091
  1. .ds q \N'34'
  2. .TH marked 1 "2014-01-31" "v0.3.1" "marked.js"
  3. .SH NAME
  4. marked \- a javascript markdown parser
  5. .SH SYNOPSIS
  6. .B marked
  7. [\-o \fI<output>\fP] [\-i \fI<input>\fP] [\-\-help]
  8. [\-\-tokens] [\-\-pedantic] [\-\-gfm]
  9. [\-\-breaks] [\-\-tables] [\-\-sanitize]
  10. [\-\-smart\-lists] [\-\-lang\-prefix \fI<prefix>\fP]
  11. [\-\-no\-etc...] [\-\-silent] [\fIfilename\fP]
  12. .SH DESCRIPTION
  13. .B marked
  14. is a full-featured javascript markdown parser, built for speed. It also includes
  15. multiple GFM features.
  16. .SH EXAMPLES
  17. .TP
  18. cat in.md | marked > out.html
  19. .TP
  20. echo "hello *world*" | marked
  21. .TP
  22. marked \-o out.html \-i in.md \-\-gfm
  23. .TP
  24. marked \-\-output="hello world.html" \-i in.md \-\-no-breaks
  25. .SH OPTIONS
  26. .TP
  27. .BI \-o,\ \-\-output\ [\fIoutput\fP]
  28. Specify file output. If none is specified, write to stdout.
  29. .TP
  30. .BI \-i,\ \-\-input\ [\fIinput\fP]
  31. Specify file input, otherwise use last argument as input file. If no input file
  32. is specified, read from stdin.
  33. .TP
  34. .BI \-t,\ \-\-tokens
  35. Output a token stream instead of html.
  36. .TP
  37. .BI \-\-pedantic
  38. Conform to obscure parts of markdown.pl as much as possible. Don't fix original
  39. markdown bugs.
  40. .TP
  41. .BI \-\-gfm
  42. Enable github flavored markdown.
  43. .TP
  44. .BI \-\-breaks
  45. Enable GFM line breaks. Only works with the gfm option.
  46. .TP
  47. .BI \-\-tables
  48. Enable GFM tables. Only works with the gfm option.
  49. .TP
  50. .BI \-\-sanitize
  51. Sanitize output. Ignore any HTML input.
  52. .TP
  53. .BI \-\-smart\-lists
  54. Use smarter list behavior than the original markdown.
  55. .TP
  56. .BI \-\-lang\-prefix\ [\fIprefix\fP]
  57. Set the prefix for code block classes.
  58. .TP
  59. .BI \-\-mangle
  60. Mangle email addresses.
  61. .TP
  62. .BI \-\-no\-sanitize,\ \-no-etc...
  63. The inverse of any of the marked options above.
  64. .TP
  65. .BI \-\-silent
  66. Silence error output.
  67. .TP
  68. .BI \-h,\ \-\-help
  69. Display help information.
  70. .SH CONFIGURATION
  71. For configuring and running programmatically.
  72. .B Example
  73. require('marked')('*foo*', { gfm: true });
  74. .SH BUGS
  75. Please report any bugs to https://github.com/markedjs/marked.
  76. .SH LICENSE
  77. Copyright (c) 2011-2014, Christopher Jeffrey (MIT License).
  78. .SH "SEE ALSO"
  79. .BR markdown(1),
  80. .BR node.js(1)