md2man 4.0.1 → 5.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.markdown +92 -56
- data/VERSION.markdown +13 -0
- data/bin/md2man-html +9 -9
- data/bin/md2man-rake +1 -1
- data/bin/md2man-roff +1 -1
- data/lib/md2man/html.rb +1 -1
- data/lib/md2man/version.rb +1 -1
- data/man/index.html +1 -1
- data/man/man0/README.html +14 -14
- data/man/man0/VERSION.html +54 -44
- data/man/man1/md2man-html.1 +9 -9
- data/man/man1/md2man-html.1.html +14 -14
- data/man/man1/md2man-rake.1 +1 -1
- data/man/man1/md2man-rake.1.html +4 -4
- data/man/man1/md2man-roff.1 +1 -1
- data/man/man1/md2man-roff.1.html +4 -4
- data/man/man5/md2man.5 +1 -1
- data/man/man5/md2man.5.html +9 -9
- data/man/man5/md2man.5.markdown +1 -1
- data/md2man.gemspec +1 -1
- data/test/md2man/html_test.rb +12 -12
- metadata +4 -4
data/man/man1/md2man-html.1
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
.TH MD2MAN\-HTML 1 2016\-02\-
|
|
1
|
+
.TH MD2MAN\-HTML 1 2016\-02\-13 5.0.1
|
|
2
2
|
.SH NAME
|
|
3
3
|
.PP
|
|
4
4
|
md2man\-html \- convert
|
|
@@ -46,8 +46,8 @@ For example, a heading labeled \fB\fCVer<s>iON 3(2</s>!4)))\fR would be emitted
|
|
|
46
46
|
.PP
|
|
47
47
|
.RS
|
|
48
48
|
.nf
|
|
49
|
-
<h2 id="ver\-ion\-3\-2\-4"
|
|
50
|
-
class="md2man\-permalink" title="permalink"></a
|
|
49
|
+
<h2 id="ver\-ion\-3\-2\-4">Ver<s>iON 3(2</s>!4)))<a name="ver\-ion\-3\-2\-4"
|
|
50
|
+
href="#ver\-ion\-3\-2\-4" class="md2man\-permalink" title="permalink"></a></h2>
|
|
51
51
|
.fi
|
|
52
52
|
.RE
|
|
53
53
|
.PP
|
|
@@ -55,12 +55,12 @@ For example, multiple headings labeled \fB\fCHello, world!\fR would be emitted a
|
|
|
55
55
|
.PP
|
|
56
56
|
.RS
|
|
57
57
|
.nf
|
|
58
|
-
<h2 id="hello\-world"
|
|
59
|
-
class="md2man\-permalink" title="permalink"></a
|
|
60
|
-
<h2 id="hello\-world\-1"
|
|
61
|
-
class="md2man\-permalink" title="permalink"></a
|
|
62
|
-
<h2 id="hello\-world\-2"
|
|
63
|
-
class="md2man\-permalink" title="permalink"></a
|
|
58
|
+
<h2 id="hello\-world">Hello, world!<a name="hello\-world"
|
|
59
|
+
href="#hello\-world" class="md2man\-permalink" title="permalink"></a></h2>
|
|
60
|
+
<h2 id="hello\-world\-1">Hello, world!<a name="hello\-world\-1"
|
|
61
|
+
href="#hello\-world\-1" class="md2man\-permalink" title="permalink"></a></h2>
|
|
62
|
+
<h2 id="hello\-world\-2">Hello, world!<a name="hello\-world\-2"
|
|
63
|
+
href="#hello\-world\-2" class="md2man\-permalink" title="permalink"></a></h2>
|
|
64
64
|
.fi
|
|
65
65
|
.RE
|
|
66
66
|
.SS Cross references
|
data/man/man1/md2man-html.1.html
CHANGED
|
@@ -2,37 +2,37 @@
|
|
|
2
2
|
<html>
|
|
3
3
|
<head>
|
|
4
4
|
<meta charset="utf-8" />
|
|
5
|
-
<meta name="generator" content="md2man
|
|
5
|
+
<meta name="generator" content="md2man 5.0.0 https://github.com/sunaku/md2man" />
|
|
6
6
|
<title>md2man-html(1) — convert md2man(5) flavored markdown(7) into HTML</title>
|
|
7
7
|
<link rel="stylesheet" href="../style.css"/>
|
|
8
8
|
<!--[if lt IE 9]><script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script><![endif]-->
|
|
9
9
|
</head>
|
|
10
|
-
<body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man1">man1</a>/md2man-html.1</span></div></div><div class="container-fluid"><h1 id="md2man-html-1-2016-02-
|
|
10
|
+
<body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man1">man1</a>/md2man-html.1</span></div></div><div class="container-fluid"><h1 id="md2man-html-1-2016-02-13-5-0-1"><span class="md2man-title">MD2MAN-HTML</span> <span class="md2man-section">1</span> <span class="md2man-date">2016-02-13</span> <span class="md2man-source">5.0.1</span><a name="md2man-html-1-2016-02-13-5-0-1" href="#md2man-html-1-2016-02-13-5-0-1" class="md2man-permalink" title="permalink"></a></h1><h2 id="name">NAME<a name="name" href="#name" class="md2man-permalink" title="permalink"></a></h2><p>md2man-html - convert <a class="md2man-reference" href="../man5/md2man.5.html">md2man(5)</a> flavored <a class="md2man-reference">markdown(7)</a> into HTML</p><h2 id="synopsis">SYNOPSIS<a name="synopsis" href="#synopsis" class="md2man-permalink" title="permalink"></a></h2><p><code>md2man-html</code> [<em>OPTION</em>]... [<em>FILE</em>]</p><h2 id="description">DESCRIPTION<a name="description" href="#description" class="md2man-permalink" title="permalink"></a></h2><p>This program converts <a class="md2man-reference" href="../man5/md2man.5.html">md2man(5)</a> flavored <a class="md2man-reference">markdown(7)</a> input from the given
|
|
11
11
|
<em>FILE</em> into HTML and then prints the result to the standard output stream.
|
|
12
|
-
If <em>FILE</em> is not given, then the standard input stream is read in its place.</p><h3 id="top-level-headings"
|
|
12
|
+
If <em>FILE</em> is not given, then the standard input stream is read in its place.</p><h3 id="top-level-headings">Top-level headings<a name="top-level-headings" href="#top-level-headings" class="md2man-permalink" title="permalink"></a></h3><p>Each component of the <code>.TH</code> directive in <a class="md2man-reference">roff(7)</a>, described under "Top-level
|
|
13
13
|
headings" in <a class="md2man-reference" href="../man5/md2man.5.html">md2man(5)</a>, is wrapped in stylable <code><span></code> elements as follows:</p><pre><code><span class="md2man-title">...</span>
|
|
14
14
|
<span class="md2man-section">...</span>
|
|
15
15
|
<span class="md2man-date">...</span>
|
|
16
16
|
<span class="md2man-source">...</span>
|
|
17
17
|
<span class="md2man-manual">...</span>
|
|
18
18
|
</code></pre>
|
|
19
|
-
<h3 id="heading-permalinks"
|
|
19
|
+
<h3 id="heading-permalinks">Heading permalinks<a name="heading-permalinks" href="#heading-permalinks" class="md2man-permalink" title="permalink"></a></h3><p>Self-referencing hyperlinks (for permanent linking) are added to headings by
|
|
20
20
|
converting their labels into URI fragments that are unique (using a counter),
|
|
21
|
-
lowercase, and squeezed and stripped of HTML tags and non-word characters.</p><p>For example, a heading labeled <code>Ver<s>iON 3(2</s>!4)))</code> would be emitted as:</p><pre><code><h2 id="ver-ion-3-2-4">
|
|
22
|
-
class="md2man-permalink" title="permalink"></a>
|
|
21
|
+
lowercase, and squeezed and stripped of HTML tags and non-word characters.</p><p>For example, a heading labeled <code>Ver<s>iON 3(2</s>!4)))</code> would be emitted as:</p><pre><code><h2 id="ver-ion-3-2-4">Ver<s>iON 3(2</s>!4)))<a name="ver-ion-3-2-4"
|
|
22
|
+
href="#ver-ion-3-2-4" class="md2man-permalink" title="permalink"></a></h2>
|
|
23
23
|
</code></pre>
|
|
24
|
-
<p>For example, multiple headings labeled <code>Hello, world!</code> would be emitted as:</p><pre><code><h2 id="hello-world">
|
|
25
|
-
class="md2man-permalink" title="permalink"></a>
|
|
24
|
+
<p>For example, multiple headings labeled <code>Hello, world!</code> would be emitted as:</p><pre><code><h2 id="hello-world">Hello, world!<a name="hello-world"
|
|
25
|
+
href="#hello-world" class="md2man-permalink" title="permalink"></a></h2>
|
|
26
26
|
|
|
27
|
-
<h2 id="hello-world-1">
|
|
28
|
-
class="md2man-permalink" title="permalink"></a>
|
|
27
|
+
<h2 id="hello-world-1">Hello, world!<a name="hello-world-1"
|
|
28
|
+
href="#hello-world-1" class="md2man-permalink" title="permalink"></a></h2>
|
|
29
29
|
|
|
30
|
-
<h2 id="hello-world-2">
|
|
31
|
-
class="md2man-permalink" title="permalink"></a>
|
|
30
|
+
<h2 id="hello-world-2">Hello, world!<a name="hello-world-2"
|
|
31
|
+
href="#hello-world-2" class="md2man-permalink" title="permalink"></a></h2>
|
|
32
32
|
</code></pre>
|
|
33
|
-
<h3 id="cross-references"
|
|
33
|
+
<h3 id="cross-references">Cross references<a name="cross-references" href="#cross-references" class="md2man-permalink" title="permalink"></a></h3><p>Cross references to manual pages are emitted as HTML hyperlinks that have
|
|
34
34
|
<code>class="md2man-reference"</code> and <code>href="../man$SECTION/$PAGE.$SECTION.html"</code>
|
|
35
35
|
attributes.</p><p>For example, the <code>printf(3)</code> cross reference would be emitted as this HTML:</p><pre><code><a class="md2man-reference" href="../man3/printf.3.html">printf(3)</a>
|
|
36
36
|
</code></pre>
|
|
37
|
-
<h2 id="options"
|
|
37
|
+
<h2 id="options">OPTIONS<a name="options" href="#options" class="md2man-permalink" title="permalink"></a></h2><dl><dt><code>-h</code>, <code>--help</code></dt><dd>Show this help manual.</dd></dl><h2 id="see-also">SEE ALSO<a name="see-also" href="#see-also" class="md2man-permalink" title="permalink"></a></h2><p><a class="md2man-reference" href="../man1/md2man-roff.1.html">md2man-roff(1)</a>, <a class="md2man-reference" href="../man1/md2man-rake.1.html">md2man-rake(1)</a>, <a class="md2man-reference" href="../man5/md2man.5.html">md2man(5)</a></p></div></body>
|
|
38
38
|
</html>
|
data/man/man1/md2man-rake.1
CHANGED
data/man/man1/md2man-rake.1.html
CHANGED
|
@@ -2,15 +2,15 @@
|
|
|
2
2
|
<html>
|
|
3
3
|
<head>
|
|
4
4
|
<meta charset="utf-8" />
|
|
5
|
-
<meta name="generator" content="md2man
|
|
5
|
+
<meta name="generator" content="md2man 5.0.0 https://github.com/sunaku/md2man" />
|
|
6
6
|
<title>md2man-rake(1) — run rake(1) tasks from md2man(1)</title>
|
|
7
7
|
<link rel="stylesheet" href="../style.css"/>
|
|
8
8
|
<!--[if lt IE 9]><script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script><![endif]-->
|
|
9
9
|
</head>
|
|
10
|
-
<body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man1">man1</a>/md2man-rake.1</span></div></div><div class="container-fluid"><h1 id="md2man-rake-1-2016-02-
|
|
10
|
+
<body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man1">man1</a>/md2man-rake.1</span></div></div><div class="container-fluid"><h1 id="md2man-rake-1-2016-02-13-5-0-1"><span class="md2man-title">MD2MAN-RAKE</span> <span class="md2man-section">1</span> <span class="md2man-date">2016-02-13</span> <span class="md2man-source">5.0.1</span><a name="md2man-rake-1-2016-02-13-5-0-1" href="#md2man-rake-1-2016-02-13-5-0-1" class="md2man-permalink" title="permalink"></a></h1><h2 id="name">NAME<a name="name" href="#name" class="md2man-permalink" title="permalink"></a></h2><p>md2man-rake - run <a class="md2man-reference">rake(1)</a> tasks from <a class="md2man-reference">md2man(1)</a></p><h2 id="synopsis">SYNOPSIS<a name="synopsis" href="#synopsis" class="md2man-permalink" title="permalink"></a></h2><p><code>md2man-rake</code> [<em>OPTION</em>]... [<em>TASK</em>]...</p><h2 id="description">DESCRIPTION<a name="description" href="#description" class="md2man-permalink" title="permalink"></a></h2><p>This program lets you run <a class="md2man-reference">rake(1)</a> tasks provided by <a class="md2man-reference">md2man(1)</a> without having
|
|
11
11
|
to create a special file named <code>Rakefile</code> that contains the following snippet:</p><pre><code>require 'md2man/rakefile'
|
|
12
12
|
</code></pre>
|
|
13
|
-
<p>If no <em>TASK</em> is specified, then the <code>md2man</code> task is run by default.</p><h2 id="tasks"
|
|
13
|
+
<p>If no <em>TASK</em> is specified, then the <code>md2man</code> task is run by default.</p><h2 id="tasks">TASKS<a name="tasks" href="#tasks" class="md2man-permalink" title="permalink"></a></h2><dl><dt><code>md2man</code></dt><dd>Runs the <code>md2man:man</code> and <code>md2man:web</code> tasks, in that order.</dd></dl><dl><dt><code>md2man:man</code></dt><dd>Builds UNIX manual pages from <code>*.markdown</code>, <code>*.mkd</code>, and <code>*.md</code> files
|
|
14
14
|
found in or beneath the <code>man/</code> subdirectory in your working directory.</dd></dl><dl><dt><code>md2man:web</code></dt><dd>Builds HTML manual pages from <code>*.markdown</code>, <code>*.mkd</code>, and <code>*.md</code> files
|
|
15
|
-
found in or beneath the <code>man/</code> subdirectory in your working directory.</dd></dl><h2 id="options"
|
|
15
|
+
found in or beneath the <code>man/</code> subdirectory in your working directory.</dd></dl><h2 id="options">OPTIONS<a name="options" href="#options" class="md2man-permalink" title="permalink"></a></h2><dl><dt><code>-h</code>, <code>--help</code></dt><dd>Show this help manual.</dd></dl><p>Run <code>rake --help</code> to see more options.</p><h2 id="see-also">SEE ALSO<a name="see-also" href="#see-also" class="md2man-permalink" title="permalink"></a></h2><p><a class="md2man-reference">rake(1)</a>, <a class="md2man-reference" href="../man1/md2man-roff.1.html">md2man-roff(1)</a>, <a class="md2man-reference" href="../man1/md2man-html.1.html">md2man-html(1)</a>, <a class="md2man-reference" href="../man5/md2man.5.html">md2man(5)</a></p></div></body>
|
|
16
16
|
</html>
|
data/man/man1/md2man-roff.1
CHANGED
data/man/man1/md2man-roff.1.html
CHANGED
|
@@ -2,14 +2,14 @@
|
|
|
2
2
|
<html>
|
|
3
3
|
<head>
|
|
4
4
|
<meta charset="utf-8" />
|
|
5
|
-
<meta name="generator" content="md2man
|
|
5
|
+
<meta name="generator" content="md2man 5.0.0 https://github.com/sunaku/md2man" />
|
|
6
6
|
<title>md2man-roff(1) — convert md2man(5) flavored markdown(7) into roff(7)</title>
|
|
7
7
|
<link rel="stylesheet" href="../style.css"/>
|
|
8
8
|
<!--[if lt IE 9]><script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script><![endif]-->
|
|
9
9
|
</head>
|
|
10
|
-
<body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man1">man1</a>/md2man-roff.1</span></div></div><div class="container-fluid"><h1 id="md2man-roff-1-2016-02-
|
|
10
|
+
<body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man1">man1</a>/md2man-roff.1</span></div></div><div class="container-fluid"><h1 id="md2man-roff-1-2016-02-13-5-0-1"><span class="md2man-title">MD2MAN-ROFF</span> <span class="md2man-section">1</span> <span class="md2man-date">2016-02-13</span> <span class="md2man-source">5.0.1</span><a name="md2man-roff-1-2016-02-13-5-0-1" href="#md2man-roff-1-2016-02-13-5-0-1" class="md2man-permalink" title="permalink"></a></h1><h2 id="name">NAME<a name="name" href="#name" class="md2man-permalink" title="permalink"></a></h2><p>md2man-roff - convert <a class="md2man-reference" href="../man5/md2man.5.html">md2man(5)</a> flavored <a class="md2man-reference">markdown(7)</a> into <a class="md2man-reference">roff(7)</a></p><h2 id="synopsis">SYNOPSIS<a name="synopsis" href="#synopsis" class="md2man-permalink" title="permalink"></a></h2><p><code>md2man-roff</code> [<em>OPTION</em>]... [<em>FILE</em>]</p><h2 id="description">DESCRIPTION<a name="description" href="#description" class="md2man-permalink" title="permalink"></a></h2><p>This program converts <a class="md2man-reference" href="../man5/md2man.5.html">md2man(5)</a> flavored <a class="md2man-reference">markdown(7)</a> input from the given
|
|
11
11
|
<em>FILE</em> into <a class="md2man-reference">roff(7)</a> and then prints the result to the standard output stream.
|
|
12
|
-
If <em>FILE</em> is not given, then the standard input stream is read in its place.</p><h3 id="limitations"
|
|
12
|
+
If <em>FILE</em> is not given, then the standard input stream is read in its place.</p><h3 id="limitations">Limitations<a name="limitations" href="#limitations" class="md2man-permalink" title="permalink"></a></h3><p>This program does not convert the following <a href="https://github.com/vmg/redcarpet">Redcarpet</a> nodes into <a class="md2man-reference">roff(7)</a>:</p>
|
|
13
13
|
<ul>
|
|
14
14
|
<li><code>block_html</code></li>
|
|
15
15
|
<li><code>strikethrough</code></li>
|
|
@@ -17,5 +17,5 @@ If <em>FILE</em> is not given, then the standard input stream is read in its pla
|
|
|
17
17
|
<li><code>image</code></li>
|
|
18
18
|
<li><code>raw_html</code></li>
|
|
19
19
|
</ul>
|
|
20
|
-
<p>It issues a warning when it encounters these instead. Patches are welcome!</p><h2 id="options"
|
|
20
|
+
<p>It issues a warning when it encounters these instead. Patches are welcome!</p><h2 id="options">OPTIONS<a name="options" href="#options" class="md2man-permalink" title="permalink"></a></h2><dl><dt><code>-h</code>, <code>--help</code></dt><dd>Show this help manual.</dd></dl><h2 id="see-also">SEE ALSO<a name="see-also" href="#see-also" class="md2man-permalink" title="permalink"></a></h2><p><a class="md2man-reference" href="../man1/md2man-html.1.html">md2man-html(1)</a>, <a class="md2man-reference" href="../man1/md2man-rake.1.html">md2man-rake(1)</a>, <a class="md2man-reference" href="../man5/md2man.5.html">md2man(5)</a></p></div></body>
|
|
21
21
|
</html>
|
data/man/man5/md2man.5
CHANGED
data/man/man5/md2man.5.html
CHANGED
|
@@ -2,13 +2,13 @@
|
|
|
2
2
|
<html>
|
|
3
3
|
<head>
|
|
4
4
|
<meta charset="utf-8" />
|
|
5
|
-
<meta name="generator" content="md2man
|
|
5
|
+
<meta name="generator" content="md2man 5.0.0 https://github.com/sunaku/md2man" />
|
|
6
6
|
<title>md2man(5) — manual page flavoring for the markdown(7) file format</title>
|
|
7
7
|
<link rel="stylesheet" href="../style.css"/>
|
|
8
8
|
<!--[if lt IE 9]><script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script><![endif]-->
|
|
9
9
|
</head>
|
|
10
|
-
<body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man5">man5</a>/md2man.5</span></div></div><div class="container-fluid"><h1 id="md2man-5-2016-02-
|
|
11
|
-
pages by extending its syntax, semantics, and assumed processing extensions.</p><h3 id="syntax"
|
|
10
|
+
<body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man5">man5</a>/md2man.5</span></div></div><div class="container-fluid"><h1 id="md2man-5-2016-02-13-5-0-1"><span class="md2man-title">MD2MAN</span> <span class="md2man-section">5</span> <span class="md2man-date">2016-02-13</span> <span class="md2man-source">5.0.1</span><a name="md2man-5-2016-02-13-5-0-1" href="#md2man-5-2016-02-13-5-0-1" class="md2man-permalink" title="permalink"></a></h1><h2 id="name">NAME<a name="name" href="#name" class="md2man-permalink" title="permalink"></a></h2><p>md2man - manual page flavoring for the <a class="md2man-reference">markdown(7)</a> file format</p><h2 id="description">DESCRIPTION<a name="description" href="#description" class="md2man-permalink" title="permalink"></a></h2><p><a href="https://github.com/sunaku/md2man">md2man</a> makes the <a class="md2man-reference">markdown(7)</a> file format friendly for writing UNIX manual
|
|
11
|
+
pages by extending its syntax, semantics, and assumed processing extensions.</p><h3 id="syntax">Syntax<a name="syntax" href="#syntax" class="md2man-permalink" title="permalink"></a></h3><p>md2man extends <a class="md2man-reference">markdown(7)</a> syntax by defining three kinds of paragraphs.</p><pre><code>This is a
|
|
12
12
|
normal
|
|
13
13
|
paragraph.
|
|
14
14
|
|
|
@@ -25,7 +25,7 @@ This
|
|
|
25
25
|
normal
|
|
26
26
|
paragraph.
|
|
27
27
|
</code></pre>
|
|
28
|
-
<h4 id="normal-paragraphs"
|
|
28
|
+
<h4 id="normal-paragraphs">Normal paragraphs<a name="normal-paragraphs" href="#normal-paragraphs" class="md2man-permalink" title="permalink"></a></h4><p>Paragraphs whose lines are all indented by exactly zero or one additional
|
|
29
29
|
spaces are considered to be "normal paragraphs". For example:</p><pre><code>This is a
|
|
30
30
|
normal
|
|
31
31
|
paragraph.
|
|
@@ -35,24 +35,24 @@ This
|
|
|
35
35
|
normal
|
|
36
36
|
paragraph.
|
|
37
37
|
</code></pre>
|
|
38
|
-
<h4 id="tagged-paragraphs"
|
|
38
|
+
<h4 id="tagged-paragraphs">Tagged paragraphs<a name="tagged-paragraphs" href="#tagged-paragraphs" class="md2man-permalink" title="permalink"></a></h4><p>Paragraphs whose first line is indented by less than two additional spaces and
|
|
39
39
|
whose subsequent lines are uniformly indented by exactly two additional spaces
|
|
40
40
|
are considered to be "tagged paragraphs". For example:</p><pre><code>This is a
|
|
41
41
|
tagged
|
|
42
42
|
paragraph.
|
|
43
43
|
</code></pre>
|
|
44
|
-
<h4 id="indented-paragraphs"
|
|
44
|
+
<h4 id="indented-paragraphs">Indented paragraphs<a name="indented-paragraphs" href="#indented-paragraphs" class="md2man-permalink" title="permalink"></a></h4><p>Paragraphs whose lines are all uniformly indented by exactly two additional
|
|
45
45
|
spaces are considered to be "indented paragraphs". For example:</p><pre><code> This is an
|
|
46
46
|
indented
|
|
47
47
|
paragraph.
|
|
48
48
|
</code></pre>
|
|
49
|
-
<h3 id="semantics"
|
|
49
|
+
<h3 id="semantics">Semantics<a name="semantics" href="#semantics" class="md2man-permalink" title="permalink"></a></h3><p>md2man extends <a class="md2man-reference">markdown(7)</a> semantics by treating top-level headings specially.</p><h4 id="top-level-headings">Top-level headings<a name="top-level-headings" href="#top-level-headings" class="md2man-permalink" title="permalink"></a></h4><p>The first top-level <code><h1></code> heading found in the input is considered to be the
|
|
50
50
|
<code>.TH</code> directive in <a class="md2man-reference">roff(7)</a>, as described under "Title line" in <a class="md2man-reference">man-pages(7)</a>:</p>
|
|
51
51
|
<blockquote>
|
|
52
52
|
<pre><code>.TH title section date source manual
|
|
53
53
|
</code></pre>
|
|
54
54
|
<dl><dt>title</dt><dd>The title of the man page, written in all caps (e.g., <code>MAN-PAGES</code>).</dd></dl><dl><dt>section</dt><dd>The section number in which the man page should be placed (e.g., <code>7</code>).</dd></dl><dl><dt>date</dt><dd>The date of the last revision, written in the form YYYY-MM-DD.</dd></dl><dl><dt>source</dt><dd>The source of the command, function, or system call (e.g., <code>Linux</code>).</dd></dl><dl><dt>manual</dt><dd>The title of the manual (e.g., <code>Linux Programmer's Manual</code>).</dd></dl></blockquote>
|
|
55
|
-
<p>Any subsequent top-level headings are treated as second-level <code><h2></code> headings.</p><h3 id="extensions"
|
|
55
|
+
<p>Any subsequent top-level headings are treated as second-level <code><h2></code> headings.</p><h3 id="extensions">Extensions<a name="extensions" href="#extensions" class="md2man-permalink" title="permalink"></a></h3><p>md2man enables the following <a href="https://github.com/vmg/redcarpet">Redcarpet</a> extensions while reading <a class="md2man-reference">markdown(7)</a>:</p>
|
|
56
56
|
<ul>
|
|
57
57
|
<li>tables</li>
|
|
58
58
|
<li>autolink</li>
|
|
@@ -60,5 +60,5 @@ spaces are considered to be "indented paragraphs". For example:</p><p
|
|
|
60
60
|
<li>strikethrough</li>
|
|
61
61
|
<li>fenced_code_blocks</li>
|
|
62
62
|
</ul>
|
|
63
|
-
<h2 id="see-also"
|
|
63
|
+
<h2 id="see-also">SEE ALSO<a name="see-also" href="#see-also" class="md2man-permalink" title="permalink"></a></h2><p><a class="md2man-reference">markdown(7)</a>, <a class="md2man-reference">man-pages(7)</a>, <a class="md2man-reference" href="../man1/md2man-roff.1.html">md2man-roff(1)</a>, <a class="md2man-reference" href="../man1/md2man-html.1.html">md2man-html(1)</a>, <a class="md2man-reference" href="../man1/md2man-rake.1.html">md2man-rake(1)</a></p></div></body>
|
|
64
64
|
</html>
|
data/man/man5/md2man.5.markdown
CHANGED
data/md2man.gemspec
CHANGED
|
@@ -21,7 +21,7 @@ Gem::Specification.new do |s|
|
|
|
21
21
|
s.files += Dir['man/**/*.{html,css,js}'] # HTML man pages
|
|
22
22
|
|
|
23
23
|
s.required_ruby_version = '>= 1.9.1'
|
|
24
|
-
s.add_runtime_dependency 'binman', '~>
|
|
24
|
+
s.add_runtime_dependency 'binman', '~> 5.0'
|
|
25
25
|
s.add_runtime_dependency 'redcarpet', '~> 3.0'
|
|
26
26
|
s.add_development_dependency 'minitest', '~> 5.0'
|
|
27
27
|
s.add_development_dependency 'rake', '~> 10.1'
|
data/test/md2man/html_test.rb
CHANGED
|
@@ -144,15 +144,15 @@ describe 'html engine' do
|
|
|
144
144
|
|### bar **BAZ**
|
|
145
145
|
|#### -bar--BAZ---
|
|
146
146
|
INPUT
|
|
147
|
-
<h1 id="foo-bar"><
|
|
148
|
-
<h2 id="bar-baz"
|
|
149
|
-
<h3 id="baz-qux"
|
|
150
|
-
<h4 id="qux-moz"
|
|
151
|
-
<h5 id="m-oz-end"
|
|
152
|
-
<h1 id="bar-baz-1"
|
|
153
|
-
<h2 id="bar-baz-2"><a name="bar-baz-2" href="#bar-baz-2" class="md2man-permalink" title="permalink"></a
|
|
154
|
-
<h3 id="bar-baz-3"><a name="bar-baz-3" href="#bar-baz-3" class="md2man-permalink" title="permalink"></a
|
|
155
|
-
<h4 id="bar-baz-4"
|
|
147
|
+
<h1 id="foo-bar"><span class=\"md2man-title\">foo</span> <span class=\"md2man-section\"><em>BAR</em></span><a name="foo-bar" href="#foo-bar" class="md2man-permalink" title="permalink"></a></h1>\
|
|
148
|
+
<h2 id="bar-baz">bar BAZ<a name="bar-baz" href="#bar-baz" class="md2man-permalink" title="permalink"></a></h2>\
|
|
149
|
+
<h3 id="baz-qux">--BAZ-QUX--<a name="baz-qux" href="#baz-qux" class="md2man-permalink" title="permalink"></a></h3>\
|
|
150
|
+
<h4 id="qux-moz">qux (MOZ)<a name="qux-moz" href="#qux-moz" class="md2man-permalink" title="permalink"></a></h4>\
|
|
151
|
+
<h5 id="m-oz-end">{m}oz END<a name="m-oz-end" href="#m-oz-end" class="md2man-permalink" title="permalink"></a></h5>\
|
|
152
|
+
<h1 id="bar-baz-1">bar BAZ<a name="bar-baz-1" href="#bar-baz-1" class="md2man-permalink" title="permalink"></a></h1>\
|
|
153
|
+
<h2 id="bar-baz-2">bar <em>BAZ</em><a name="bar-baz-2" href="#bar-baz-2" class="md2man-permalink" title="permalink"></a></h2>\
|
|
154
|
+
<h3 id="bar-baz-3">bar <strong>BAZ</strong><a name="bar-baz-3" href="#bar-baz-3" class="md2man-permalink" title="permalink"></a></h3>\
|
|
155
|
+
<h4 id="bar-baz-4">-bar--BAZ---<a name="bar-baz-4" href="#bar-baz-4" class="md2man-permalink" title="permalink"></a></h4>
|
|
156
156
|
OUTPUT
|
|
157
157
|
end
|
|
158
158
|
|
|
@@ -164,7 +164,7 @@ describe 'html engine' do
|
|
|
164
164
|
|
|
|
165
165
|
|here is another paragraph containing is-a-reference(3) yet again
|
|
166
166
|
INPUT
|
|
167
|
-
<h2 id="here-is-a-reference-3-to-another-man-page"
|
|
167
|
+
<h2 id="here-is-a-reference-3-to-another-man-page">here <a class="md2man-reference" href="../man3/is-a-reference.3.html">is-a-reference(3)</a> to another man page<a name="here-is-a-reference-3-to-another-man-page" href="#here-is-a-reference-3-to-another-man-page" class="md2man-permalink" title="permalink"></a></h2>\
|
|
168
168
|
<p>here is a paragraph containing <a class="md2man-reference" href="../man3/is-a-reference.3.html">is-a-reference(3)</a> again</p>\
|
|
169
169
|
<p>here is another paragraph containing <a class="md2man-reference" href="../man3/is-a-reference.3.html">is-a-reference(3)</a> yet again</p>
|
|
170
170
|
OUTPUT
|
|
@@ -181,12 +181,12 @@ describe 'html engine' do
|
|
|
181
181
|
|
|
|
182
182
|
|### `PIPES_GET_LAST(CHAIN)`
|
|
183
183
|
INPUT
|
|
184
|
-
|<h3 id="macros"
|
|
184
|
+
|<h3 id="macros">Macros<a name="macros" href="#macros" class="md2man-permalink" title="permalink"></a></h3><pre><code>#define PIPES_GET_LAST(CHAIN)
|
|
185
185
|
|#define PIPES_GET_IN(CHAIN)
|
|
186
186
|
|#define PIPES_GET_OUT(CHAIN)
|
|
187
187
|
|#define PIPES_GET_ERR(CHAIN)
|
|
188
188
|
|</code></pre>
|
|
189
|
-
|<h3 id="pipes_get_last-chain"><a name="pipes_get_last-chain" href="#pipes_get_last-chain" class="md2man-permalink" title="permalink"></a
|
|
189
|
+
|<h3 id="pipes_get_last-chain"><code>PIPES_GET_LAST(CHAIN)</code><a name="pipes_get_last-chain" href="#pipes_get_last-chain" class="md2man-permalink" title="permalink"></a></h3>
|
|
190
190
|
OUTPUT
|
|
191
191
|
end
|
|
192
192
|
end
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: md2man
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version:
|
|
4
|
+
version: 5.0.1
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Suraj N. Kurapati
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2016-02-
|
|
11
|
+
date: 2016-02-13 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: binman
|
|
@@ -16,14 +16,14 @@ dependencies:
|
|
|
16
16
|
requirements:
|
|
17
17
|
- - "~>"
|
|
18
18
|
- !ruby/object:Gem::Version
|
|
19
|
-
version: '
|
|
19
|
+
version: '5.0'
|
|
20
20
|
type: :runtime
|
|
21
21
|
prerelease: false
|
|
22
22
|
version_requirements: !ruby/object:Gem::Requirement
|
|
23
23
|
requirements:
|
|
24
24
|
- - "~>"
|
|
25
25
|
- !ruby/object:Gem::Version
|
|
26
|
-
version: '
|
|
26
|
+
version: '5.0'
|
|
27
27
|
- !ruby/object:Gem::Dependency
|
|
28
28
|
name: redcarpet
|
|
29
29
|
requirement: !ruby/object:Gem::Requirement
|