.TH "MARKED\-MAN" "1" "April 2024" "1.3.6"
.SH "NAME"
\fBmarked-man\fR \- markdown to roff
.SH SYNOPSIS
.RS 2
.nf
marked\-man README\.md > doc/foo\.1
# works too with stdin
cat README\.md | marked\-man \-\-version 1\.0 | man /dev/stdin
.fi
.RE
.P
See also 
.UR https://marked.js.org/
.I marked documentation
.UE .
.SH DESCRIPTION
.P
\fBmarked\-man\fP wraps \fBmarked\fP to extend it with groff output support in order to
.br
create Unix manual pages for use with \fBman\fP\|\.
.P
It follows the \fBronn\fP markdown level\-1 header format:
.br
# name(section) \-\- short description
.P
which populates the \fIHEADER\fR section, and the \fINAME\fR section (if none is already written) of the manpage\.
.SH OPTIONS
.P
\fBmarked\-man\fP is a \fBmarked\fP CLI extension, meaning options can be passed directly to marked\.
.P
The \fB\-\-breaks\fP option, which retains intra\-paragraph line breaks, is now true by default\. Use \fB\-\-no\-breaks\fP to disable it\.
.P
\fBmarked\-man\fP adds some options to \fBmarked\fP\|'s existing options, to be able to override the header/footer of generated man pages\.

.RS 1
.IP \(bu 2
\fB\-\-name <name>\fP
.br
Optional, overrides \fBname\fP in ronn header\.
.IP \(bu 2
\fB\-\-section <section>\fP
.br
Optional, overrides \fBsection\fP in ronn header\. Defaults to 1\.
.IP \(bu 2
\fB\-\-description <description>\fP
.br
Optional, overrides \fBdescription\fP in ronn header\.
.IP \(bu 2
\fB\-\-version <version>\fP
.br
The version shown in the manpage footer\.
.br
Optional, when omitted, defaults to the target node module version, or empty\.
.IP \(bu 2
\fB\-\-manual <manual>\fP
.br
The manual\-group name shown in the manpage header\.
.br
Optional, when omitted, man displays a value matching the section\.
.IP \(bu 2
\fB\-\-date <date>\fP
.br
The date shown in the manpage header\.
.br
Optional, defaults to now\.
.br
Must be acceptable to \fBnew Date(string or timestamp)\fP\|\.
.br
Honors \fBSOURCE_DATE_EPOCH\fP environment variable for reproducible builds\.

.RE
.SH INSTALLATION
.P
See your node package manager manual\.\.\.
.P
For example:
.RS 2
.nf
npx marked\-man simple\.md
.fi
.RE
.SH EXAMPLE
.P
To view this README as a man page, run something like the following:
.RS 2
.nf
marked\-man README\.md | man /dev/stdin
.fi
.RE
.SH AS MARKED EXTENSION
.RS 2
.nf
import markedMan from 'marked\-man';
import marked from 'marked';

marked\.use(markedMan);
.fi
.RE
.SH SEE ALSO
.P
.UR https://github.com/rtomayko/ronn
.I Ronn
.UE

.br
.UR https://github.com/apjanke/ronn-ng
.I Ronn-NG
.UE

.br
.UR https://man.cx/groff_man(7)
.I groff
.UE
.SH REPORTING BUGS
.P
See 
.UR https://github.com/kapouer/marked-man
.I marked-man repository
.UE .