forked from mmarkdown/mmark
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mmark.1
83 lines (83 loc) · 1.73 KB
/
mmark.1
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
.\" Automatically generated by Pandoc 1.17.2
.\"
.TH "MMARK" "1" "August 2018" "" ""
.hy
.SH NAME
.PP
mmark \[en] generate XML or HTML from mmark markdown
.SH SYNOPSIS
.PP
\f[B]mmark\f[] [\f[B]OPTIONS\f[]] [\f[I]FILE...\f[]]
.SH DESCRIPTION
.PP
\f[B]Mmark\f[] is a powerful markdown processor written in Go, geared
towards writing IETF documents.
It is, however, \f[I]also\f[] suited for writing complete books and
other technical documentation.
.PP
Mmark provides an advanced markdown dialect that processes file(s) to
produce internet\-drafts in XML RFC
7991 (https://tools.ietf.org/html/rfc7991) format.
Mmark can produce xml2rfc (aforementioned RFC 7991), RFC 7749 (xml2rfc
version 2) and HTML5 output.
.PP
The syntax is detailed at <https://mmark.nl/syntax>.
.SH OPTIONS
.TP
.B \f[B]\-2\f[]
generate RFC 7749 XML
.RS
.RE
.TP
.B \f[B]\-ast\f[]
print abstract syntax tree and exit
.RS
.RE
.TP
.B \f[B]\-css string\f[]
link to a CSS stylesheet (only used with \-html)
.RS
.RE
.TP
.B \f[B]\-fragment\f[]
don\[aq]t create a full document
.RS
.RE
.TP
.B \f[B]\-head string\f[]
link to HTML to be included in head (only used with \-html)
.RS
.RE
.TP
.B \f[B]\-html\f[]
create HTML output
.RS
.RE
.TP
.B \f[B]\-unsafe\f[]
allow includes from anywhere in the filesystem, otherwise they are only
allowed \f[I]under\f[] the current document.
.RS
.RE
.TP
.B \f[B]\-index\f[]
generate an index at the end of the document (default true)
.RS
.RE
.TP
.B \f[B]\-bibliography\f[]
generate a bibliographtysection after the back matter (default true),
this needs a \f[C]{{backmatter}}\f[] in the document.
.RS
.RE
.TP
.B \f[B]\-version\f[]
show mmark\[aq]s version
.RS
.RE
.SH ALSO SEE
.PP
RFC 7991 and RFC 7749.
The main site for Mmark is <https://mmark.nl>
.SH AUTHORS
Mmark Authors.