md2man 1.6.0 → 1.6.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/VERSION.markdown +10 -0
- data/bin/md2man +1 -1
- data/bin/md2man-html +1 -1
- data/bin/md2man-rake +1 -1
- data/lib/md2man/rakefile/style.css +0 -18
- data/lib/md2man/version.rb +1 -1
- data/man/index.html +2 -2
- data/man/{README.html → man0/README.html} +4 -4
- data/man/{README.markdown → man0/README.markdown} +0 -0
- data/man/{VERSION.html → man0/VERSION.html} +15 -7
- data/man/{VERSION.markdown → man0/VERSION.markdown} +10 -0
- data/man/man1/md2man-html.1 +1 -1
- data/man/man1/md2man-html.1.html +2 -2
- data/man/man1/md2man-rake.1 +1 -1
- data/man/man1/md2man-rake.1.html +2 -2
- data/man/man1/md2man.1 +1 -1
- data/man/man1/md2man.1.html +2 -2
- data/man/style.css +0 -18
- metadata +8 -8
data/VERSION.markdown
CHANGED
data/bin/md2man
CHANGED
data/bin/md2man-html
CHANGED
data/bin/md2man-rake
CHANGED
|
@@ -19,24 +19,6 @@
|
|
|
19
19
|
|
|
20
20
|
@media screen {
|
|
21
21
|
body {
|
|
22
|
-
column-count: auto;
|
|
23
|
-
-moz-column-count: auto;
|
|
24
|
-
-webkit-column-count: auto;
|
|
25
|
-
|
|
26
|
-
column-width: 78ex;
|
|
27
|
-
-moz-column-width: 78ex;
|
|
28
|
-
-webkit-column-width: 78ex;
|
|
29
|
-
|
|
30
|
-
column-gap: none;
|
|
31
|
-
-moz-column-gap: none;
|
|
32
|
-
-webkit-column-gap: none;
|
|
33
|
-
|
|
34
|
-
column-rule: thin solid Gainsboro;
|
|
35
|
-
-moz-column-rule: thin solid Gainsboro;
|
|
36
|
-
-webkit-column-rule: thin solid Gainsboro;
|
|
37
|
-
}
|
|
38
|
-
|
|
39
|
-
.manpage {
|
|
40
22
|
font-family: monospace;
|
|
41
23
|
max-width: 78ex;
|
|
42
24
|
margin: auto;
|
data/lib/md2man/version.rb
CHANGED
data/man/index.html
CHANGED
|
@@ -2,10 +2,10 @@
|
|
|
2
2
|
<html>
|
|
3
3
|
<head>
|
|
4
4
|
<meta charset="utf-8" />
|
|
5
|
-
<meta name="generator" content="md2man 1.6.
|
|
5
|
+
<meta name="generator" content="md2man 1.6.1 https://github.com/sunaku/md2man" />
|
|
6
6
|
<title>man/index</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="container-fluid"><h2 id="
|
|
10
|
+
<body><div class="container-fluid"><h2 id="man0">man0</h2><dl class="dl-horizontal"><dt><a href="man0/README.html">README</a></dt><dd></dd></dl><dl class="dl-horizontal"><dt><a href="man0/VERSION.html">VERSION</a></dt><dd></dd></dl><h2 id="man1">man1</h2><dl class="dl-horizontal"><dt><a href="man1/md2man-html.1.html">md2man-html(1)</a></dt><dd>convert md2man(1) flavored markdown(7) into HTML</dd></dl><dl class="dl-horizontal"><dt><a href="man1/md2man-rake.1.html">md2man-rake(1)</a></dt><dd>run rake(1) tasks from md2man(1)</dd></dl><dl class="dl-horizontal"><dt><a href="man1/md2man.1.html">md2man(1)</a></dt><dd>convert markdown(7) into roff(7)</dd></dl></div></body>
|
|
11
11
|
</html>
|
|
@@ -2,12 +2,12 @@
|
|
|
2
2
|
<html>
|
|
3
3
|
<head>
|
|
4
4
|
<meta charset="utf-8" />
|
|
5
|
-
<meta name="generator" content="md2man 1.6.
|
|
5
|
+
<meta name="generator" content="md2man 1.6.1 https://github.com/sunaku/md2man" />
|
|
6
6
|
<title>README</title>
|
|
7
|
-
<link rel="stylesheet" href="style.css"/>
|
|
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#
|
|
10
|
+
<body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man0">man0</a>/README</span></div></div><div class="container-fluid"><div class="manpage"><h1 id="md2man-markdown-to-manpage">md2man - markdown to manpage</h1><p>md2man is a Ruby library and command-line program that converts <a href="http://daringfireball.net/projects/markdown/">Markdown</a>
|
|
11
11
|
documents into UNIX manual pages (both <a href="http://troff.org">roff</a> and HTML) using <a href="https://github.com/vmg/redcarpet">Redcarpet</a>.</p><h2 id="Features">Features</h2>
|
|
12
12
|
<ul>
|
|
13
13
|
<li><p>Formats tagged and indented paragraphs (see "document format" below).</p></li>
|
|
@@ -17,7 +17,7 @@ documents into UNIX manual pages (both <a href="http://troff.org">roff</a> and H
|
|
|
17
17
|
</ul>
|
|
18
18
|
<h3 id="Demonstration">Demonstration</h3><p>Try converting <a href="https://raw.github.com/sunaku/md2man/master/EXAMPLE.markdown">this example Markdown file</a> into a UNIX manual page:</p><pre><code>md2man EXAMPLE.markdown > EXAMPLE.1
|
|
19
19
|
man -l EXAMPLE.1
|
|
20
|
-
</code></pre><p><img src="https://raw.github.com/sunaku/md2man/master/EXAMPLE.png" alt="Obligatory screenshot of <a class="manpage-reference">md2man(1)</a> in action!"></p><h3 id="Limitations">Limitations</h3><p>At present, md2man does not translate the following <a href="https://github.com/vmg/redcarpet">Redcarpet</a> node types:</p>
|
|
20
|
+
</code></pre><p><img src="https://raw.github.com/sunaku/md2man/master/EXAMPLE.png" alt="Obligatory screenshot of <a class="manpage-reference" href="../man1/md2man.1.html">md2man(1)</a> in action!"></p><h3 id="Limitations">Limitations</h3><p>At present, md2man does not translate the following <a href="https://github.com/vmg/redcarpet">Redcarpet</a> node types:</p>
|
|
21
21
|
<ul>
|
|
22
22
|
<li><code>block_html</code></li>
|
|
23
23
|
<li><code>strikethrough</code></li>
|
|
File without changes
|
|
@@ -2,14 +2,22 @@
|
|
|
2
2
|
<html>
|
|
3
3
|
<head>
|
|
4
4
|
<meta charset="utf-8" />
|
|
5
|
-
<meta name="generator" content="md2man 1.6.
|
|
5
|
+
<meta name="generator" content="md2man 1.6.1 https://github.com/sunaku/md2man" />
|
|
6
6
|
<title>VERSION</title>
|
|
7
|
-
<link rel="stylesheet" href="style.css"/>
|
|
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#
|
|
10
|
+
<body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man0">man0</a>/VERSION</span></div></div><div class="container-fluid"><div class="manpage"><h2 id="Version-1-6-1-2013-05-04">Version 1.6.1 (2013-05-04)</h2><p>Patch:</p>
|
|
11
11
|
<ul>
|
|
12
|
-
<li
|
|
12
|
+
<li>Replace multi-column CSS with single centered body.</li>
|
|
13
|
+
</ul>
|
|
14
|
+
<p>Other:</p>
|
|
15
|
+
<ul>
|
|
16
|
+
<li>Fix manpage xrefs in README and VERSION documents.</li>
|
|
17
|
+
</ul>
|
|
18
|
+
<h2 id="Version-1-6-0-2013-03-10">Version 1.6.0 (2013-03-10)</h2><p>Minor:</p>
|
|
19
|
+
<ul>
|
|
20
|
+
<li><p>Added an <a class="manpage-reference" href="../man1/md2man-rake.1.html">md2man-rake(1)</a> executable that lets you run md2man's <a class="manpage-reference">rake(1)</a>
|
|
13
21
|
tasks <em>directly</em> from the command line: without the need for a "Rakefile"
|
|
14
22
|
in your working directory that loads the <code>md2man/rakefile</code> library.</p></li>
|
|
15
23
|
<li><p>In web pages generated by the <code>md2man:web</code> Rake task:</p>
|
|
@@ -72,14 +80,14 @@ The documentation has been corrected and the option remains disabled.</p></li>
|
|
|
72
80
|
</ul>
|
|
73
81
|
<p>Other:</p>
|
|
74
82
|
<ul>
|
|
75
|
-
<li><p>README: add <a class="manpage-reference">md2man-html(1)</a> and Md2Man::HTML usage</p></li>
|
|
83
|
+
<li><p>README: add <a class="manpage-reference" href="../man1/md2man-html.1.html">md2man-html(1)</a> and Md2Man::HTML usage</p></li>
|
|
76
84
|
<li><p>LICENSE: use GitHub profile URLs instead of e-mail</p></li>
|
|
77
85
|
</ul>
|
|
78
86
|
<h2 id="Version-1-4-0-2012-10-14">Version 1.4.0 (2012-10-14)</h2><p>Minor:</p>
|
|
79
87
|
<ul>
|
|
80
88
|
<li><p>roff: emit non-first H1 headings as H2 headings</p></li>
|
|
81
89
|
<li><p>html: add <code>Md2Man::HTML::Engine</code> class for HTML manual page generation</p></li>
|
|
82
|
-
<li><p>html: add <a class="manpage-reference">md2man-html(1)</a> bin script for command line access to the above</p></li>
|
|
90
|
+
<li><p>html: add <a class="manpage-reference" href="../man1/md2man-html.1.html">md2man-html(1)</a> bin script for command line access to the above</p></li>
|
|
83
91
|
<li><p>html: add ID attributes on all headings for easy permalinking</p></li>
|
|
84
92
|
<li><p>rake: add <code>md2man/rakefile</code> to process markdown files in man/</p><p>This library provides a <code>rake md2man</code> task that builds UNIX and HTML
|
|
85
93
|
manual pages from Markdown files (with ".markdown", ".mkd", or ".md"
|
|
@@ -175,7 +183,7 @@ bold styling. All that matters is that the subsequent lines are indented.</p></
|
|
|
175
183
|
</ul>
|
|
176
184
|
<p>Minor:</p>
|
|
177
185
|
<ul>
|
|
178
|
-
<li><p>Added <a class="manpage-reference">md2man(1)</a> executable for command-line usage.</p></li>
|
|
186
|
+
<li><p>Added <a class="manpage-reference" href="../man1/md2man.1.html">md2man(1)</a> executable for command-line usage.</p></li>
|
|
179
187
|
<li><p>Added support for all HTML 4.0 and XHTML 1.0 entities.</p></li>
|
|
180
188
|
<li><p>Added support for tables, horizontal rules, and more.</p></li>
|
|
181
189
|
<li><p>Added <code>Md2Man::Roff</code> mixin for advanced Redcarpet2 usage.</p></li>
|
data/man/man1/md2man-html.1
CHANGED
data/man/man1/md2man-html.1.html
CHANGED
|
@@ -2,12 +2,12 @@
|
|
|
2
2
|
<html>
|
|
3
3
|
<head>
|
|
4
4
|
<meta charset="utf-8" />
|
|
5
|
-
<meta name="generator" content="md2man 1.6.
|
|
5
|
+
<meta name="generator" content="md2man 1.6.1 https://github.com/sunaku/md2man" />
|
|
6
6
|
<title>md2man-html(1) — convert md2man(1) 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"><div class="manpage"><h1 id="MD2MAN-HTML-1-2013-
|
|
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"><div class="manpage"><h1 id="MD2MAN-HTML-1-2013-05-04-1-6-1">MD2MAN-HTML 1 2013-05-04 1.6.1</h1><h2 id="NAME">NAME</h2><p>md2man-html - convert <a class="manpage-reference" href="../man1/md2man.1.html">md2man(1)</a> flavored <a class="manpage-reference">markdown(7)</a> into HTML</p><h2 id="SYNOPSIS">SYNOPSIS</h2><p><code>md2man-html</code> [<em>OPTION</em>]... [<em>FILE</em>]</p><h2 id="DESCRIPTION">DESCRIPTION</h2><p>This program converts the <a class="manpage-reference">markdown(7)</a> input from the given <em>FILE</em> into HTML
|
|
11
11
|
and then prints the result to stdout. stdin is read if <em>FILE</em> is not given.</p><h3 id="Document-format">Document format</h3><p>See <a class="manpage-reference" href="../man1/md2man.1.html">md2man(1)</a> for details about the document format and Markdown extensions.</p><h3 id="Cross-linking">Cross linking</h3><p>References to other manual pages are converted into hyperlinks that have
|
|
12
12
|
class="manpage-reference" and href="../man${section}/${page}.${section}.html"
|
|
13
13
|
attributes.</p><p>For example, the <a class="manpage-reference">markdown(7)</a> reference would be converted into HTML as:</p><pre><code><a class="manpage-reference" href="../man7/markdown.7.html">markdown(7)</a>
|
data/man/man1/md2man-rake.1
CHANGED
data/man/man1/md2man-rake.1.html
CHANGED
|
@@ -2,12 +2,12 @@
|
|
|
2
2
|
<html>
|
|
3
3
|
<head>
|
|
4
4
|
<meta charset="utf-8" />
|
|
5
|
-
<meta name="generator" content="md2man 1.6.
|
|
5
|
+
<meta name="generator" content="md2man 1.6.1 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"><div class="manpage"><h1 id="MD2MAN-RAKE-1-2013-
|
|
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"><div class="manpage"><h1 id="MD2MAN-RAKE-1-2013-05-04-1-6-1">MD2MAN-RAKE 1 2013-05-04 1.6.1</h1><h2 id="NAME">NAME</h2><p>md2man-rake - run <a class="manpage-reference">rake(1)</a> tasks from <a class="manpage-reference" href="../man1/md2man.1.html">md2man(1)</a></p><h2 id="SYNOPSIS">SYNOPSIS</h2><p><code>md2man-rake</code> [<em>OPTION</em>]... [<em>TASK</em>]...</p><h2 id="DESCRIPTION">DESCRIPTION</h2><p>This program lets you run <a class="manpage-reference">rake(1)</a> tasks provided by <a class="manpage-reference" href="../man1/md2man.1.html">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><p>If no <em>TASK</em> is specified, then the <code>md2man</code> task is run by default.</p><h2 id="TASKS">TASKS</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
|
|
13
13
|
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
|
data/man/man1/md2man.1
CHANGED
data/man/man1/md2man.1.html
CHANGED
|
@@ -2,12 +2,12 @@
|
|
|
2
2
|
<html>
|
|
3
3
|
<head>
|
|
4
4
|
<meta charset="utf-8" />
|
|
5
|
-
<meta name="generator" content="md2man 1.6.
|
|
5
|
+
<meta name="generator" content="md2man 1.6.1 https://github.com/sunaku/md2man" />
|
|
6
6
|
<title>md2man(1) — convert 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.1</span></div></div><div class="container-fluid"><div class="manpage"><h1 id="MD2MAN-1-2013-
|
|
10
|
+
<body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man1">man1</a>/md2man.1</span></div></div><div class="container-fluid"><div class="manpage"><h1 id="MD2MAN-1-2013-05-04-1-6-1">MD2MAN 1 2013-05-04 1.6.1</h1><h2 id="NAME">NAME</h2><p>md2man - convert <a class="manpage-reference">markdown(7)</a> into <a class="manpage-reference">roff(7)</a></p><h2 id="SYNOPSIS">SYNOPSIS</h2><p><code>md2man</code> [<em>OPTION</em>]... [<em>FILE</em>]</p><h2 id="DESCRIPTION">DESCRIPTION</h2><p><a href="https://github.com/sunaku/md2man">md2man</a> converts <a class="manpage-reference">markdown(7)</a> input from the given <em>FILE</em> into <a class="manpage-reference">roff(7)</a> using
|
|
11
11
|
<a href="https://github.com/vmg/redcarpet">Redcarpet</a> and then prints the result to the standard output stream. If
|
|
12
12
|
<em>FILE</em> is not given, then the standard input stream is read in its place.</p><h3 id="Document-format">Document format</h3><p>md2man extends <a class="manpage-reference">markdown(7)</a> syntax in the following ways, as provisioned in the
|
|
13
13
|
<code>Md2Man::Document</code> module and defined in its derivative <code>Md2Man::Roff</code> module:</p>
|
data/man/style.css
CHANGED
|
@@ -19,24 +19,6 @@
|
|
|
19
19
|
|
|
20
20
|
@media screen {
|
|
21
21
|
body {
|
|
22
|
-
column-count: auto;
|
|
23
|
-
-moz-column-count: auto;
|
|
24
|
-
-webkit-column-count: auto;
|
|
25
|
-
|
|
26
|
-
column-width: 78ex;
|
|
27
|
-
-moz-column-width: 78ex;
|
|
28
|
-
-webkit-column-width: 78ex;
|
|
29
|
-
|
|
30
|
-
column-gap: none;
|
|
31
|
-
-moz-column-gap: none;
|
|
32
|
-
-webkit-column-gap: none;
|
|
33
|
-
|
|
34
|
-
column-rule: thin solid Gainsboro;
|
|
35
|
-
-moz-column-rule: thin solid Gainsboro;
|
|
36
|
-
-webkit-column-rule: thin solid Gainsboro;
|
|
37
|
-
}
|
|
38
|
-
|
|
39
|
-
.manpage {
|
|
40
22
|
font-family: monospace;
|
|
41
23
|
max-width: 78ex;
|
|
42
24
|
margin: auto;
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: md2man
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 1.6.
|
|
4
|
+
version: 1.6.1
|
|
5
5
|
prerelease:
|
|
6
6
|
platform: ruby
|
|
7
7
|
authors:
|
|
@@ -9,7 +9,7 @@ authors:
|
|
|
9
9
|
autorequire:
|
|
10
10
|
bindir: bin
|
|
11
11
|
cert_chain: []
|
|
12
|
-
date: 2013-
|
|
12
|
+
date: 2013-05-05 00:00:00.000000000 Z
|
|
13
13
|
dependencies:
|
|
14
14
|
- !ruby/object:Gem::Dependency
|
|
15
15
|
name: binman
|
|
@@ -105,8 +105,8 @@ files:
|
|
|
105
105
|
- lib/md2man/rakefile/style.css
|
|
106
106
|
- lib/md2man/roff.rb
|
|
107
107
|
- lib/md2man/version.rb
|
|
108
|
-
- man/README.markdown
|
|
109
|
-
- man/VERSION.markdown
|
|
108
|
+
- man/man0/README.markdown
|
|
109
|
+
- man/man0/VERSION.markdown
|
|
110
110
|
- md2man.gemspec
|
|
111
111
|
- test/md2man/html_test.rb
|
|
112
112
|
- test/md2man/roff_test.rb
|
|
@@ -115,11 +115,11 @@ files:
|
|
|
115
115
|
- man/man1/md2man.1
|
|
116
116
|
- man/man1/md2man-rake.1
|
|
117
117
|
- man/index.html
|
|
118
|
-
- man/VERSION.html
|
|
118
|
+
- man/man0/VERSION.html
|
|
119
|
+
- man/man0/README.html
|
|
119
120
|
- man/man1/md2man-rake.1.html
|
|
120
121
|
- man/man1/md2man-html.1.html
|
|
121
122
|
- man/man1/md2man.1.html
|
|
122
|
-
- man/README.html
|
|
123
123
|
- man/style.css
|
|
124
124
|
homepage: http://github.com/sunaku/md2man
|
|
125
125
|
licenses: []
|
|
@@ -141,10 +141,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
141
141
|
version: '0'
|
|
142
142
|
segments:
|
|
143
143
|
- 0
|
|
144
|
-
hash: -
|
|
144
|
+
hash: -1519806717842147435
|
|
145
145
|
requirements: []
|
|
146
146
|
rubyforge_project:
|
|
147
|
-
rubygems_version: 1.8.
|
|
147
|
+
rubygems_version: 1.8.25
|
|
148
148
|
signing_key:
|
|
149
149
|
specification_version: 3
|
|
150
150
|
summary: markdown to manpage
|