marked.1.txt 2.1 KB

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