2025-07-10 09:41:17 +08:00
|
|
|
.ds q \N'34'
|
|
|
|
|
.TH marked 1
|
|
|
|
|
|
|
|
|
|
.SH NAME
|
|
|
|
|
marked \- a javascript markdown parser
|
|
|
|
|
|
2025-07-10 08:52:41 +08:00
|
|
|
.SH SYNOPSIS
|
2025-07-10 09:41:17 +08:00
|
|
|
.B marked
|
|
|
|
|
[\-o \fI<output>\fP] [\-i \fI<input>\fP] [\-s \fI<string>\fP] [\-\-help]
|
|
|
|
|
[\-\-tokens] [\-\-pedantic] [\-\-gfm]
|
|
|
|
|
[\-\-breaks] [\-\-sanitize]
|
|
|
|
|
[\-\-smart\-lists] [\-\-lang\-prefix \fI<prefix>\fP]
|
|
|
|
|
[\-\-no\-etc...] [\-\-silent] [\fIfilename\fP]
|
|
|
|
|
|
2025-07-10 08:52:41 +08:00
|
|
|
.SH DESCRIPTION
|
2025-07-10 09:41:17 +08:00
|
|
|
.B marked
|
|
|
|
|
is a full-featured javascript markdown parser, built for speed.
|
|
|
|
|
It also includes multiple GFM features.
|
|
|
|
|
|
2025-07-10 08:52:41 +08:00
|
|
|
.SH EXAMPLES
|
2025-07-10 09:41:17 +08:00
|
|
|
.TP
|
|
|
|
|
cat in.md | marked > out.html
|
|
|
|
|
.TP
|
2025-07-10 08:52:41 +08:00
|
|
|
echo "hello *world*" | marked
|
2025-07-10 09:41:17 +08:00
|
|
|
.TP
|
|
|
|
|
marked \-o out.html \-i in.md \-\-gfm
|
|
|
|
|
.TP
|
|
|
|
|
marked \-\-output="hello world.html" \-i in.md \-\-no-breaks
|
2025-07-10 08:52:41 +08:00
|
|
|
|
2025-07-10 09:41:17 +08:00
|
|
|
.SH OPTIONS
|
|
|
|
|
.TP
|
|
|
|
|
.BI \-o,\ \-\-output\ [\fIoutput\fP]
|
|
|
|
|
Specify file output. If none is specified, write to stdout.
|
|
|
|
|
.TP
|
|
|
|
|
.BI \-i,\ \-\-input\ [\fIinput\fP]
|
|
|
|
|
Specify file input, otherwise use last argument as input file.
|
|
|
|
|
If no input file is specified, read from stdin.
|
|
|
|
|
.TP
|
|
|
|
|
.BI \-s,\ \-\-string\ [\fIstring\fP]
|
|
|
|
|
Specify string input instead of a file.
|
|
|
|
|
.TP
|
|
|
|
|
.BI \-t,\ \-\-tokens
|
|
|
|
|
Output a token stream instead of html.
|
|
|
|
|
.TP
|
|
|
|
|
.BI \-\-pedantic
|
|
|
|
|
Conform to obscure parts of markdown.pl as much as possible.
|
|
|
|
|
Don't fix original markdown bugs.
|
|
|
|
|
.TP
|
|
|
|
|
.BI \-\-gfm
|
|
|
|
|
Enable github flavored markdown.
|
|
|
|
|
.TP
|
|
|
|
|
.BI \-\-breaks
|
|
|
|
|
Enable GFM line breaks. Only works with the gfm option.
|
|
|
|
|
.TP
|
|
|
|
|
.BI \-\-sanitize
|
|
|
|
|
Sanitize output. Ignore any HTML input.
|
|
|
|
|
.TP
|
|
|
|
|
.BI \-\-smart\-lists
|
|
|
|
|
Use smarter list behavior than the original markdown.
|
|
|
|
|
.TP
|
|
|
|
|
.BI \-\-lang\-prefix\ [\fIprefix\fP]
|
|
|
|
|
Set the prefix for code block classes.
|
|
|
|
|
.TP
|
|
|
|
|
.BI \-\-mangle
|
|
|
|
|
Mangle email addresses.
|
|
|
|
|
.TP
|
|
|
|
|
.BI \-\-no\-sanitize,\ \-no-etc...
|
|
|
|
|
The inverse of any of the marked options above.
|
|
|
|
|
.TP
|
|
|
|
|
.BI \-\-silent
|
|
|
|
|
Silence error output.
|
|
|
|
|
.TP
|
|
|
|
|
.BI \-h,\ \-\-help
|
|
|
|
|
Display help information.
|
2025-07-10 08:52:41 +08:00
|
|
|
|
|
|
|
|
.SH CONFIGURATION
|
2025-07-10 09:41:17 +08:00
|
|
|
For configuring and running programmatically.
|
|
|
|
|
|
|
|
|
|
.B Example
|
|
|
|
|
|
|
|
|
|
import { marked } from 'marked';
|
|
|
|
|
marked('*foo*', { gfm: true });
|
|
|
|
|
|
2025-07-10 08:52:41 +08:00
|
|
|
.SH BUGS
|
2025-07-10 09:41:17 +08:00
|
|
|
Please report any bugs to https://github.com/markedjs/marked.
|
|
|
|
|
|
2025-07-10 08:52:41 +08:00
|
|
|
.SH LICENSE
|
2025-07-10 09:41:17 +08:00
|
|
|
Copyright (c) 2011-2014, Christopher Jeffrey (MIT License).
|
2025-07-10 08:52:41 +08:00
|
|
|
|
2025-07-10 09:41:17 +08:00
|
|
|
.SH "SEE ALSO"
|
|
|
|
|
.BR markdown(1),
|
|
|
|
|
.BR node.js(1)
|
