md2man 4.0.0 → 4.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/VERSION.markdown +10 -0
- data/bin/md2man-html +1 -1
- data/bin/md2man-rake +1 -1
- data/bin/md2man-roff +1 -1
- data/lib/md2man/rakefile/style.css +7 -2
- data/lib/md2man/version.rb +1 -1
- data/man/index.html +1 -1
- data/man/man0/EXAMPLE.png +1 -0
- data/man/man0/README.html +4 -4
- data/man/man0/README.markdown +1 -0
- data/man/man0/VERSION.html +23 -17
- data/man/man0/VERSION.markdown +1 -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-roff.1 +1 -1
- data/man/man1/md2man-roff.1.html +2 -2
- data/man/man5/md2man.5 +1 -1
- data/man/man5/md2man.5.html +3 -3
- data/man/man5/md2man.5.markdown +1 -1
- data/man/style.css +7 -2
- metadata +3 -3
- data/man/man0/EXAMPLE.png +0 -0
- data/man/man0/README.markdown +0 -180
- data/man/man0/VERSION.markdown +0 -489
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 4e608d1fa05ea7af010e4e0d4a985dff2727fde2
|
4
|
+
data.tar.gz: cb1284576cbc795c92b1dba97c8a07b2abb69727
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 5f9cf9d465dceba7e17d9722b2d0ce1b257ba25437185fdb832597403422000d851abd03404b3afe018cd6944775f6e7d8b08580f9dd7edd2b74f4f271d916da
|
7
|
+
data.tar.gz: b8d9edbbe164b36d8bbbebdd8246a3ce3386092d97a15c5bb19a3b6e577e2a91bcb6a42fbd17dd1f9755728fdd268f380536b32de2fe1412d3fecfea2b7e7770
|
data/VERSION.markdown
CHANGED
data/bin/md2man-html
CHANGED
data/bin/md2man-rake
CHANGED
data/bin/md2man-roff
CHANGED
@@ -40,15 +40,20 @@
|
|
40
40
|
float: left;
|
41
41
|
margin-left: -1em;
|
42
42
|
opacity: 0.25;
|
43
|
+
font-size: xx-large;
|
43
44
|
}
|
44
45
|
|
45
46
|
a.md2man-permalink:before {
|
46
|
-
content: '\
|
47
|
+
content: '\2605'; /* ★ */
|
47
48
|
}
|
48
49
|
|
49
50
|
a.md2man-permalink:hover,
|
50
51
|
*:target > a.md2man-permalink {
|
51
|
-
opacity:
|
52
|
+
opacity: inherit;
|
53
|
+
}
|
54
|
+
|
55
|
+
*:target > a.md2man-permalink {
|
56
|
+
color: red;
|
52
57
|
}
|
53
58
|
}
|
54
59
|
|
data/lib/md2man/version.rb
CHANGED
data/man/index.html
CHANGED
@@ -2,7 +2,7 @@
|
|
2
2
|
<html>
|
3
3
|
<head>
|
4
4
|
<meta charset="utf-8" />
|
5
|
-
<meta name="generator" content="md2man 4.0.
|
5
|
+
<meta name="generator" content="md2man 4.0.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]-->
|
@@ -0,0 +1 @@
|
|
1
|
+
../../EXAMPLE.png
|
data/man/man0/README.html
CHANGED
@@ -2,7 +2,7 @@
|
|
2
2
|
<html>
|
3
3
|
<head>
|
4
4
|
<meta charset="utf-8" />
|
5
|
-
<meta name="generator" content="md2man 4.0.
|
5
|
+
<meta name="generator" content="md2man 4.0.1 https://github.com/sunaku/md2man" />
|
6
6
|
<title>README</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]-->
|
@@ -37,7 +37,7 @@ bundle exec rake --tasks # packaging tasks
|
|
37
37
|
bundle exec md2man-roff --help # run it directly
|
38
38
|
bundle exec md2man-html --help # run it directly
|
39
39
|
</code></pre>
|
40
|
-
<h2 id="usage"><a name="usage" href="#usage" class="md2man-permalink" title="permalink"></a>Usage</h2><h3 id="for-roff-output"><a name="for-roff-output" href="#for-roff-output" class="md2man-permalink" title="permalink"></a>For <a href="http://troff.org">roff</a> output</h3><h4 id="at-the-command-line"><a name="at-the-command-line" href="#at-the-command-line" class="md2man-permalink" title="permalink"></a>At the command line</h4><p>See <a class="md2man-reference"
|
40
|
+
<h2 id="usage"><a name="usage" href="#usage" class="md2man-permalink" title="permalink"></a>Usage</h2><h3 id="for-roff-output"><a name="for-roff-output" href="#for-roff-output" class="md2man-permalink" title="permalink"></a>For <a href="http://troff.org">roff</a> output</h3><h4 id="at-the-command-line"><a name="at-the-command-line" href="#at-the-command-line" class="md2man-permalink" title="permalink"></a>At the command line</h4><p>See <a class="md2man-reference">md2man-roff(1)</a> manual:</p><pre><code>md2man-roff --help
|
41
41
|
</code></pre>
|
42
42
|
<h4 id="inside-a-ruby-script"><a name="inside-a-ruby-script" href="#inside-a-ruby-script" class="md2man-permalink" title="permalink"></a>Inside a Ruby script</h4><p>Use the default renderer:</p><pre><code>require 'md2man/roff/engine'
|
43
43
|
|
@@ -67,7 +67,7 @@ end
|
|
67
67
|
engine = Redcarpet::Markdown.new(YourManpageRenderer, your_options_hash)
|
68
68
|
your_roff_output = engine.render(your_markdown_input)
|
69
69
|
</code></pre>
|
70
|
-
<h3 id="for-html-output"><a name="for-html-output" href="#for-html-output" class="md2man-permalink" title="permalink"></a>For HTML output</h3><h4 id="at-the-command-line-1"><a name="at-the-command-line-1" href="#at-the-command-line-1" class="md2man-permalink" title="permalink"></a>At the command line</h4><p>See <a class="md2man-reference"
|
70
|
+
<h3 id="for-html-output"><a name="for-html-output" href="#for-html-output" class="md2man-permalink" title="permalink"></a>For HTML output</h3><h4 id="at-the-command-line-1"><a name="at-the-command-line-1" href="#at-the-command-line-1" class="md2man-permalink" title="permalink"></a>At the command line</h4><p>See <a class="md2man-reference">md2man-html(1)</a> manual:</p><pre><code>md2man-html --help
|
71
71
|
</code></pre>
|
72
72
|
<h4 id="inside-a-ruby-script-1"><a name="inside-a-ruby-script-1" href="#inside-a-ruby-script-1" class="md2man-permalink" title="permalink"></a>Inside a Ruby script</h4><p>Use the default renderer:</p><pre><code>require 'md2man/html/engine'
|
73
73
|
|
@@ -97,7 +97,7 @@ end
|
|
97
97
|
engine = Redcarpet::Markdown.new(YourManpageRenderer, your_options_hash)
|
98
98
|
your_html_output = engine.render(your_markdown_input)
|
99
99
|
</code></pre>
|
100
|
-
<h3 id="building-man-pages"><a name="building-man-pages" href="#building-man-pages" class="md2man-permalink" title="permalink"></a>Building man pages</h3><h4 id="at-the-command-line-2"><a name="at-the-command-line-2" href="#at-the-command-line-2" class="md2man-permalink" title="permalink"></a>At the command line</h4><p>See <a class="md2man-reference"
|
100
|
+
<h3 id="building-man-pages"><a name="building-man-pages" href="#building-man-pages" class="md2man-permalink" title="permalink"></a>Building man pages</h3><h4 id="at-the-command-line-2"><a name="at-the-command-line-2" href="#at-the-command-line-2" class="md2man-permalink" title="permalink"></a>At the command line</h4><p>See <a class="md2man-reference">md2man-rake(1)</a> manual:</p><pre><code>md2man-rake --help
|
101
101
|
</code></pre>
|
102
102
|
<h4 id="inside-a-ruby-script-2"><a name="inside-a-ruby-script-2" href="#inside-a-ruby-script-2" class="md2man-permalink" title="permalink"></a>Inside a Ruby script</h4><p>Add this snippet to your gemspec file:</p><pre><code>s.files += Dir['man/man?/*.?'] # UNIX man pages
|
103
103
|
s.files += Dir['man/**/*.{html,css,js}'] # HTML man pages
|
@@ -0,0 +1 @@
|
|
1
|
+
../../README.markdown
|
data/man/man0/VERSION.html
CHANGED
@@ -2,12 +2,18 @@
|
|
2
2
|
<html>
|
3
3
|
<head>
|
4
4
|
<meta charset="utf-8" />
|
5
|
-
<meta name="generator" content="md2man 4.0.
|
5
|
+
<meta name="generator" content="md2man 4.0.1 https://github.com/sunaku/md2man" />
|
6
6
|
<title>VERSION</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#man0">man0</a>/VERSION</span></div></div><div class="container-fluid"><h2 id="version-4-0-
|
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"><h2 id="version-4-0-1-2016-02-10"><a name="version-4-0-1-2016-02-10" href="#version-4-0-1-2016-02-10" class="md2man-permalink" title="permalink"></a>Version 4.0.1 (2016-02-10)</h2><h3 id="other"><a name="other" href="#other" class="md2man-permalink" title="permalink"></a>Other:</h3>
|
11
|
+
<ul>
|
12
|
+
<li><p>Make all permalinks appear in the same size.</p></li>
|
13
|
+
<li><p>Change permalink symbols from hearts to stars.</p></li>
|
14
|
+
<li><p>Indicate target heading with a red permalink.</p></li>
|
15
|
+
</ul>
|
16
|
+
<h2 id="version-4-0-0-2014-10-26"><a name="version-4-0-0-2014-10-26" href="#version-4-0-0-2014-10-26" class="md2man-permalink" title="permalink"></a>Version 4.0.0 (2014-10-26)</h2><h3 id="major"><a name="major" href="#major" class="md2man-permalink" title="permalink"></a>Major:</h3>
|
11
17
|
<ul>
|
12
18
|
<li><p>Cross references are no longer expanded inside code spans and code blocks.</p><p>Thanks to Mathias Panzenböck for reporting this issue in GH-19:
|
13
19
|
<a href="https://github.com/sunaku/md2man/issues/19">https://github.com/sunaku/md2man/issues/19</a></p></li>
|
@@ -33,17 +39,17 @@ GNU troff (groff) version 1.19.2
|
|
33
39
|
</code></pre>
|
34
40
|
<p>This patch drops those URL macros in favor of simpler angled brackets.</p><p>Thanks to Sorin Ionescu for reporting this issue in GH-13:
|
35
41
|
<a href="https://github.com/sunaku/md2man/issues/13">https://github.com/sunaku/md2man/issues/13</a></p></li>
|
36
|
-
<li><p><a class="md2man-reference"
|
42
|
+
<li><p><a class="md2man-reference">md2man-html(1)</a>: cross references were escaped in heading permalink IDs.</p></li>
|
37
43
|
</ul>
|
38
|
-
<h2 id="version-3-0-0-2014-06-22"><a name="version-3-0-0-2014-06-22" href="#version-3-0-0-2014-06-22" class="md2man-permalink" title="permalink"></a>Version 3.0.0 (2014-06-22)</h2><p>This release changes <a class="md2man-reference"
|
44
|
+
<h2 id="version-3-0-0-2014-06-22"><a name="version-3-0-0-2014-06-22" href="#version-3-0-0-2014-06-22" class="md2man-permalink" title="permalink"></a>Version 3.0.0 (2014-06-22)</h2><p>This release changes <a class="md2man-reference">md2man-html(1)</a> heading permalinks to follow GitHub style:
|
39
45
|
unique, lowercase, and squeezed and stripped of HTML tags and non-word chars.
|
40
46
|
In addition, it renames the <code>md2man-xref</code> CSS class to <code>md2man-reference</code>.</p><p>Please make sure to update any existing bookmarks and/or hyperlinks you may
|
41
47
|
have for jumping to specific locations in your HTML manuals after upgrading.</p><h3 id="major-1"><a name="major-1" href="#major-1" class="md2man-permalink" title="permalink"></a>Major:</h3>
|
42
48
|
<ul>
|
43
|
-
<li><p>Make permalink anchors on headings fully lowercase in <a class="md2man-reference"
|
44
|
-
<li><p>Put permalinks on left & indicate target permalink in <a class="md2man-reference"
|
45
|
-
<li><p>Make permalink anchors unique by appending a count in <a class="md2man-reference"
|
46
|
-
<li><p>Rename <code>md2man-xref</code> CSS class to <code>md2man-reference</code> in <a class="md2man-reference"
|
49
|
+
<li><p>Make permalink anchors on headings fully lowercase in <a class="md2man-reference">md2man-html(1)</a>.</p></li>
|
50
|
+
<li><p>Put permalinks on left & indicate target permalink in <a class="md2man-reference">md2man-html(1)</a>.</p></li>
|
51
|
+
<li><p>Make permalink anchors unique by appending a count in <a class="md2man-reference">md2man-html(1)</a>.</p></li>
|
52
|
+
<li><p>Rename <code>md2man-xref</code> CSS class to <code>md2man-reference</code> in <a class="md2man-reference">md2man-html(1)</a>.</p></li>
|
47
53
|
</ul>
|
48
54
|
<h2 id="version-2-1-1-2014-06-21"><a name="version-2-1-1-2014-06-21" href="#version-2-1-1-2014-06-21" class="md2man-permalink" title="permalink"></a>Version 2.1.1 (2014-06-21)</h2><h3 id="patch-2"><a name="patch-2" href="#patch-2" class="md2man-permalink" title="permalink"></a>Patch:</h3>
|
49
55
|
<ul>
|
@@ -51,17 +57,17 @@ have for jumping to specific locations in your HTML manuals after upgrading.</p>
|
|
51
57
|
See <a href="https://github.com/sunaku/readably/pull/3">https://github.com/sunaku/readably/pull/3</a> for the details.</p></li>
|
52
58
|
<li><p>Drop redundant nil check in <code>Md2Man::Roff::Engine.escape()</code>.</p></li>
|
53
59
|
</ul>
|
54
|
-
<h3 id="other"><a name="other" href="#other" class="md2man-permalink" title="permalink"></a>Other:</h3>
|
60
|
+
<h3 id="other-1"><a name="other-1" href="#other-1" class="md2man-permalink" title="permalink"></a>Other:</h3>
|
55
61
|
<ul>
|
56
62
|
<li><p>GitHub now supports relative links from the README.</p></li>
|
57
63
|
<li><p>README: add links to package, manuals, and GitHub.</p></li>
|
58
64
|
</ul>
|
59
65
|
<h2 id="version-2-1-0-2014-05-04"><a name="version-2-1-0-2014-05-04" href="#version-2-1-0-2014-05-04" class="md2man-permalink" title="permalink"></a>Version 2.1.0 (2014-05-04)</h2><h3 id="minor"><a name="minor" href="#minor" class="md2man-permalink" title="permalink"></a>Minor:</h3>
|
60
66
|
<ul>
|
61
|
-
<li><p><a class="md2man-reference"
|
67
|
+
<li><p><a class="md2man-reference">md2man-html(1)</a> now adds anchors and permalinks to all headings. This
|
62
68
|
makes it easy for readers to bookmark and share direct links to specific
|
63
69
|
sections of your HTML manual pages.</p></li>
|
64
|
-
<li><p><a class="md2man-reference"
|
70
|
+
<li><p><a class="md2man-reference">md2man-html(1)</a> now wraps individual components of the special <code>.TH</code>
|
65
71
|
top-level heading in HTML <code><span></code> elements with stylable CSS classes:</p><pre><code><span class="md2man-title">...</span>
|
66
72
|
<span class="md2man-section">...</span>
|
67
73
|
<span class="md2man-date">...</span>
|
@@ -70,7 +76,7 @@ top-level heading in HTML <code><span></code> elements with stylable CSS c
|
|
70
76
|
</code></pre>
|
71
77
|
<p>Thanks to Nick Fagerlund for requesting this feature in <a href="https://github.com/sunaku/md2man/issues/15">GH-15</a>.</p></li>
|
72
78
|
</ul>
|
73
|
-
<h3 id="other-
|
79
|
+
<h3 id="other-2"><a name="other-2" href="#other-2" class="md2man-permalink" title="permalink"></a>Other:</h3>
|
74
80
|
<ul>
|
75
81
|
<li><p><a class="md2man-reference" href="../man5/md2man.5.html">md2man(5)</a> now documents the special <code>.TH</code> format of top-level headings.</p><p>Thanks to Nick Fagerlund for requesting this documentation in <a href="https://github.com/sunaku/md2man/issues/15">GH-15</a>.</p></li>
|
76
82
|
</ul>
|
@@ -80,7 +86,7 @@ top-level heading in HTML <code><span></code> elements with stylable CSS c
|
|
80
86
|
This raised an ArgumentError on "wrong number of arguments (3 for 2)".</p><p>Thanks to zimbatm for contributing this patch.</p></li>
|
81
87
|
<li><p>GH-17 and GH-18: Escape periods, quotes, and hyphens in code blocks.
|
82
88
|
This fixes a bug where lines beginning with periods or single quotes
|
83
|
-
did not appear when <a class="md2man-reference"
|
89
|
+
did not appear when <a class="md2man-reference">md2man-roff(1)</a> output was rendered using <a class="md2man-reference">man(1)</a>.</p><p>Thanks to zimbatm for reporting this bug and suggesting how to fix it.</p></li>
|
84
90
|
</ul>
|
85
91
|
<h2 id="version-2-0-3-2014-01-16"><a name="version-2-0-3-2014-01-16" href="#version-2-0-3-2014-01-16" class="md2man-permalink" title="permalink"></a>Version 2.0.3 (2014-01-16)</h2><h3 id="patch-4"><a name="patch-4" href="#patch-4" class="md2man-permalink" title="permalink"></a>Patch:</h3>
|
86
92
|
<ul>
|
@@ -112,7 +118,7 @@ did not appear when <a class="md2man-reference" href="../man1/md2man-roff.1.html
|
|
112
118
|
<h2 id="version-2-0-0-2013-05-05"><a name="version-2-0-0-2013-05-05" href="#version-2-0-0-2013-05-05" class="md2man-permalink" title="permalink"></a>Version 2.0.0 (2013-05-05)</h2><p>This release renames md2man executables and libraries to highlight the fact
|
113
119
|
that md2man provides two processing pathways: one for Roff and one for HTML.</p><p>Major:</p>
|
114
120
|
<ul>
|
115
|
-
<li><p>Rename <a class="md2man-reference">md2man(1)</a> executable to <a class="md2man-reference"
|
121
|
+
<li><p>Rename <a class="md2man-reference">md2man(1)</a> executable to <a class="md2man-reference">md2man-roff(1)</a>.</p></li>
|
116
122
|
<li><p>Rename <code>Md2Man::Engine</code> to <code>Md2Man::Roff::Engine</code>.</p></li>
|
117
123
|
<li><p>Rename "manpage-reference" CSS class to "md2man-xref" in HTML output.</p></li>
|
118
124
|
<li><p>The <code>Md2Man::Document#reference()</code> method now takes only two parameters:</p>
|
@@ -157,7 +163,7 @@ the output document</li>
|
|
157
163
|
</ul>
|
158
164
|
<h2 id="version-1-6-0-2013-03-10"><a name="version-1-6-0-2013-03-10" href="#version-1-6-0-2013-03-10" class="md2man-permalink" title="permalink"></a>Version 1.6.0 (2013-03-10)</h2><p>Minor:</p>
|
159
165
|
<ul>
|
160
|
-
<li><p>Added an <a class="md2man-reference"
|
166
|
+
<li><p>Added an <a class="md2man-reference">md2man-rake(1)</a> executable that lets you run md2man's <a class="md2man-reference">rake(1)</a>
|
161
167
|
tasks <em>directly</em> from the command line: without the need for a "Rakefile"
|
162
168
|
in your working directory that loads the <code>md2man/rakefile</code> library.</p></li>
|
163
169
|
<li><p>In web pages generated by the <code>md2man:web</code> Rake task:</p>
|
@@ -220,14 +226,14 @@ The documentation has been corrected and the option remains disabled.</p></li>
|
|
220
226
|
</ul>
|
221
227
|
<p>Other:</p>
|
222
228
|
<ul>
|
223
|
-
<li><p>README: add <a class="md2man-reference"
|
229
|
+
<li><p>README: add <a class="md2man-reference">md2man-html(1)</a> and Md2Man::HTML usage</p></li>
|
224
230
|
<li><p>LICENSE: use GitHub profile URLs instead of e-mail</p></li>
|
225
231
|
</ul>
|
226
232
|
<h2 id="version-1-4-0-2012-10-14"><a name="version-1-4-0-2012-10-14" href="#version-1-4-0-2012-10-14" class="md2man-permalink" title="permalink"></a>Version 1.4.0 (2012-10-14)</h2><p>Minor:</p>
|
227
233
|
<ul>
|
228
234
|
<li><p>roff: emit non-first H1 headings as H2 headings</p></li>
|
229
235
|
<li><p>html: add <code>Md2Man::HTML::Engine</code> class for HTML manual page generation</p></li>
|
230
|
-
<li><p>html: add <a class="md2man-reference"
|
236
|
+
<li><p>html: add <a class="md2man-reference">md2man-html(1)</a> bin script for command line access to the above</p></li>
|
231
237
|
<li><p>html: add ID attributes on all headings for easy permalinking</p></li>
|
232
238
|
<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
|
233
239
|
manual pages from Markdown files (with ".markdown", ".mkd", or ".md"
|
@@ -0,0 +1 @@
|
|
1
|
+
../../VERSION.markdown
|
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 4.0.
|
5
|
+
<meta name="generator" content="md2man 4.0.1 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-
|
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-4-0-1"><a name="md2man-html-1-2016-02-10-4-0-1" href="#md2man-html-1-2016-02-10-4-0-1" class="md2man-permalink" title="permalink"></a><span class="md2man-title">MD2MAN-HTML</span> <span class="md2man-section">1</span> <span class="md2man-date">2016-02-10</span> <span class="md2man-source">4.0.1</span></h1><h2 id="name"><a name="name" href="#name" class="md2man-permalink" title="permalink"></a>NAME</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"><a name="synopsis" href="#synopsis" class="md2man-permalink" title="permalink"></a>SYNOPSIS</h2><p><code>md2man-html</code> [<em>OPTION</em>]... [<em>FILE</em>]</p><h2 id="description"><a name="description" href="#description" class="md2man-permalink" title="permalink"></a>DESCRIPTION</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
12
|
If <em>FILE</em> is not given, then the standard input stream is read in its place.</p><h3 id="top-level-headings"><a name="top-level-headings" href="#top-level-headings" class="md2man-permalink" title="permalink"></a>Top-level headings</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>
|
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 4.0.
|
5
|
+
<meta name="generator" content="md2man 4.0.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"><h1 id="md2man-rake-1-
|
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-4-0-1"><a name="md2man-rake-1-2016-02-10-4-0-1" href="#md2man-rake-1-2016-02-10-4-0-1" class="md2man-permalink" title="permalink"></a><span class="md2man-title">MD2MAN-RAKE</span> <span class="md2man-section">1</span> <span class="md2man-date">2016-02-10</span> <span class="md2man-source">4.0.1</span></h1><h2 id="name"><a name="name" href="#name" class="md2man-permalink" title="permalink"></a>NAME</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"><a name="synopsis" href="#synopsis" class="md2man-permalink" title="permalink"></a>SYNOPSIS</h2><p><code>md2man-rake</code> [<em>OPTION</em>]... [<em>TASK</em>]...</p><h2 id="description"><a name="description" href="#description" class="md2man-permalink" title="permalink"></a>DESCRIPTION</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
13
|
<p>If no <em>TASK</em> is specified, then the <code>md2man</code> task is run by default.</p><h2 id="tasks"><a name="tasks" href="#tasks" class="md2man-permalink" title="permalink"></a>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
|
data/man/man1/md2man-roff.1
CHANGED
data/man/man1/md2man-roff.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 4.0.
|
5
|
+
<meta name="generator" content="md2man 4.0.1 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-
|
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-4-0-1"><a name="md2man-roff-1-2016-02-10-4-0-1" href="#md2man-roff-1-2016-02-10-4-0-1" class="md2man-permalink" title="permalink"></a><span class="md2man-title">MD2MAN-ROFF</span> <span class="md2man-section">1</span> <span class="md2man-date">2016-02-10</span> <span class="md2man-source">4.0.1</span></h1><h2 id="name"><a name="name" href="#name" class="md2man-permalink" title="permalink"></a>NAME</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"><a name="synopsis" href="#synopsis" class="md2man-permalink" title="permalink"></a>SYNOPSIS</h2><p><code>md2man-roff</code> [<em>OPTION</em>]... [<em>FILE</em>]</p><h2 id="description"><a name="description" href="#description" class="md2man-permalink" title="permalink"></a>DESCRIPTION</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
12
|
If <em>FILE</em> is not given, then the standard input stream is read in its place.</p><h3 id="limitations"><a name="limitations" href="#limitations" class="md2man-permalink" title="permalink"></a>Limitations</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>
|
data/man/man5/md2man.5
CHANGED
data/man/man5/md2man.5.html
CHANGED
@@ -2,12 +2,12 @@
|
|
2
2
|
<html>
|
3
3
|
<head>
|
4
4
|
<meta charset="utf-8" />
|
5
|
-
<meta name="generator" content="md2man 4.0.
|
5
|
+
<meta name="generator" content="md2man 4.0.1 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-
|
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-10-4-0-1"><a name="md2man-5-2016-02-10-4-0-1" href="#md2man-5-2016-02-10-4-0-1" class="md2man-permalink" title="permalink"></a><span class="md2man-title">MD2MAN</span> <span class="md2man-section">5</span> <span class="md2man-date">2016-02-10</span> <span class="md2man-source">4.0.1</span></h1><h2 id="name"><a name="name" href="#name" class="md2man-permalink" title="permalink"></a>NAME</h2><p>md2man - manual page flavoring for the <a class="md2man-reference">markdown(7)</a> file format</p><h2 id="description"><a name="description" href="#description" class="md2man-permalink" title="permalink"></a>DESCRIPTION</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
11
|
pages by extending its syntax, semantics, and assumed processing extensions.</p><h3 id="syntax"><a name="syntax" href="#syntax" class="md2man-permalink" title="permalink"></a>Syntax</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.
|
@@ -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"><a name="see-also" href="#see-also" class="md2man-permalink" title="permalink"></a>SEE ALSO</h2><p><a class="md2man-reference">markdown(7)</a>, <a class="md2man-reference">man-pages(7)</a>, <a class="md2man-reference"
|
63
|
+
<h2 id="see-also"><a name="see-also" href="#see-also" class="md2man-permalink" title="permalink"></a>SEE ALSO</h2><p><a class="md2man-reference">markdown(7)</a>, <a class="md2man-reference">man-pages(7)</a>, <a class="md2man-reference">md2man-roff(1)</a>, <a class="md2man-reference">md2man-html(1)</a>, <a class="md2man-reference">md2man-rake(1)</a></p></div></body>
|
64
64
|
</html>
|
data/man/man5/md2man.5.markdown
CHANGED
data/man/style.css
CHANGED
@@ -40,15 +40,20 @@
|
|
40
40
|
float: left;
|
41
41
|
margin-left: -1em;
|
42
42
|
opacity: 0.25;
|
43
|
+
font-size: xx-large;
|
43
44
|
}
|
44
45
|
|
45
46
|
a.md2man-permalink:before {
|
46
|
-
content: '\
|
47
|
+
content: '\2605'; /* ★ */
|
47
48
|
}
|
48
49
|
|
49
50
|
a.md2man-permalink:hover,
|
50
51
|
*:target > a.md2man-permalink {
|
51
|
-
opacity:
|
52
|
+
opacity: inherit;
|
53
|
+
}
|
54
|
+
|
55
|
+
*:target > a.md2man-permalink {
|
56
|
+
color: red;
|
52
57
|
}
|
53
58
|
}
|
54
59
|
|
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.0.
|
4
|
+
version: 4.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:
|
11
|
+
date: 2016-02-11 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: binman
|
@@ -136,7 +136,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
136
136
|
version: '0'
|
137
137
|
requirements: []
|
138
138
|
rubyforge_project:
|
139
|
-
rubygems_version: 2.
|
139
|
+
rubygems_version: 2.5.1
|
140
140
|
signing_key:
|
141
141
|
specification_version: 4
|
142
142
|
summary: markdown to manpage
|
data/man/man0/EXAMPLE.png
DELETED
Binary file
|
data/man/man0/README.markdown
DELETED
@@ -1,180 +0,0 @@
|
|
1
|
-
# md2man - markdown to manpage
|
2
|
-
|
3
|
-
md2man is a Ruby library and a set of command-line programs that convert
|
4
|
-
[Markdown] into UNIX manual pages (both [roff] and HTML) using [Redcarpet].
|
5
|
-
|
6
|
-
* Manuals: <https://sunaku.github.io/md2man/man>
|
7
|
-
* Sources: <https://github.com/sunaku/md2man>
|
8
|
-
* Support: <https://github.com/sunaku/md2man/issues>
|
9
|
-
* Package: <https://rubygems.org/gems/md2man>
|
10
|
-
|
11
|
-
## Features
|
12
|
-
|
13
|
-
* Formats tagged and indented paragraphs (see "document format" below).
|
14
|
-
|
15
|
-
* Translates all HTML4 and XHTML1 entities into native [roff] equivalents.
|
16
|
-
|
17
|
-
* Supports markdown extensions such as [PHP Markdown Extra tables][tables].
|
18
|
-
|
19
|
-
* Usable from the command line as a filter in a UNIX command pipeline.
|
20
|
-
|
21
|
-
### Demonstration
|
22
|
-
|
23
|
-
Try converting [this example Markdown file][example] into a UNIX manual page:
|
24
|
-
|
25
|
-
md2man-roff EXAMPLE.markdown > EXAMPLE.1
|
26
|
-
man -l EXAMPLE.1
|
27
|
-
|
28
|
-
![Obligatory screenshot of md2man(1) in action!](EXAMPLE.png)
|
29
|
-
|
30
|
-
Also try converting [that example Markdown file][example] into a web page:
|
31
|
-
|
32
|
-
md2man-html EXAMPLE.markdown > EXAMPLE.html
|
33
|
-
open EXAMPLE.html
|
34
|
-
|
35
|
-
## Installation
|
36
|
-
|
37
|
-
gem install md2man
|
38
|
-
|
39
|
-
### Development
|
40
|
-
|
41
|
-
git clone git://github.com/sunaku/md2man
|
42
|
-
cd md2man
|
43
|
-
bundle install
|
44
|
-
bundle exec rake --tasks # packaging tasks
|
45
|
-
bundle exec md2man-roff --help # run it directly
|
46
|
-
bundle exec md2man-html --help # run it directly
|
47
|
-
|
48
|
-
## Usage
|
49
|
-
|
50
|
-
### For [roff] output
|
51
|
-
|
52
|
-
#### At the command line
|
53
|
-
|
54
|
-
See md2man-roff(1) manual:
|
55
|
-
|
56
|
-
md2man-roff --help
|
57
|
-
|
58
|
-
#### Inside a Ruby script
|
59
|
-
|
60
|
-
Use the default renderer:
|
61
|
-
|
62
|
-
require 'md2man/roff/engine'
|
63
|
-
|
64
|
-
your_roff_output = Md2Man::Roff::ENGINE.render(your_markdown_input)
|
65
|
-
|
66
|
-
Build your own renderer:
|
67
|
-
|
68
|
-
require 'md2man/roff/engine'
|
69
|
-
|
70
|
-
engine = Redcarpet::Markdown.new(Md2Man::Roff::Engine, your_options_hash)
|
71
|
-
your_roff_output = engine.render(your_markdown_input)
|
72
|
-
|
73
|
-
Define your own renderer:
|
74
|
-
|
75
|
-
require 'md2man/roff/engine'
|
76
|
-
|
77
|
-
class YourManpageRenderer < Md2Man::Roff::Engine
|
78
|
-
# ... your stuff here ...
|
79
|
-
end
|
80
|
-
|
81
|
-
engine = Redcarpet::Markdown.new(YourManpageRenderer, your_options_hash)
|
82
|
-
your_roff_output = engine.render(your_markdown_input)
|
83
|
-
|
84
|
-
Mix-in your own renderer:
|
85
|
-
|
86
|
-
require 'md2man/roff'
|
87
|
-
|
88
|
-
class YourManpageRenderer < Redcarpet::Render::Base
|
89
|
-
include Md2Man::Roff
|
90
|
-
# ... your stuff here ...
|
91
|
-
end
|
92
|
-
|
93
|
-
engine = Redcarpet::Markdown.new(YourManpageRenderer, your_options_hash)
|
94
|
-
your_roff_output = engine.render(your_markdown_input)
|
95
|
-
|
96
|
-
### For HTML output
|
97
|
-
|
98
|
-
#### At the command line
|
99
|
-
|
100
|
-
See md2man-html(1) manual:
|
101
|
-
|
102
|
-
md2man-html --help
|
103
|
-
|
104
|
-
#### Inside a Ruby script
|
105
|
-
|
106
|
-
Use the default renderer:
|
107
|
-
|
108
|
-
require 'md2man/html/engine'
|
109
|
-
|
110
|
-
your_html_output = Md2Man::HTML::ENGINE.render(your_markdown_input)
|
111
|
-
|
112
|
-
Build your own renderer:
|
113
|
-
|
114
|
-
require 'md2man/html/engine'
|
115
|
-
|
116
|
-
engine = Redcarpet::Markdown.new(Md2Man::HTML::Engine, your_options_hash)
|
117
|
-
your_html_output = engine.render(your_markdown_input)
|
118
|
-
|
119
|
-
Define your own renderer:
|
120
|
-
|
121
|
-
require 'md2man/html/engine'
|
122
|
-
|
123
|
-
class YourManpageRenderer < Md2Man::HTML::Engine
|
124
|
-
# ... your stuff here ...
|
125
|
-
end
|
126
|
-
|
127
|
-
engine = Redcarpet::Markdown.new(YourManpageRenderer, your_options_hash)
|
128
|
-
your_html_output = engine.render(your_markdown_input)
|
129
|
-
|
130
|
-
Mix-in your own renderer:
|
131
|
-
|
132
|
-
require 'md2man/html'
|
133
|
-
|
134
|
-
class YourManpageRenderer < Redcarpet::Render::Base
|
135
|
-
include Md2Man::HTML
|
136
|
-
# ... your stuff here ...
|
137
|
-
end
|
138
|
-
|
139
|
-
engine = Redcarpet::Markdown.new(YourManpageRenderer, your_options_hash)
|
140
|
-
your_html_output = engine.render(your_markdown_input)
|
141
|
-
|
142
|
-
### Building man pages
|
143
|
-
|
144
|
-
#### At the command line
|
145
|
-
|
146
|
-
See md2man-rake(1) manual:
|
147
|
-
|
148
|
-
md2man-rake --help
|
149
|
-
|
150
|
-
#### Inside a Ruby script
|
151
|
-
|
152
|
-
Add this snippet to your gemspec file:
|
153
|
-
|
154
|
-
s.files += Dir['man/man?/*.?'] # UNIX man pages
|
155
|
-
s.files += Dir['man/**/*.{html,css,js}'] # HTML man pages
|
156
|
-
s.add_development_dependency 'md2man', '~> 4.0'
|
157
|
-
|
158
|
-
Add this line to your Rakefile:
|
159
|
-
|
160
|
-
require 'md2man/rakefile'
|
161
|
-
|
162
|
-
You now have a `rake md2man` task that builds manual pages from Markdown files
|
163
|
-
(with ".markdown", ".mkd", or ".md" extension) inside `man/man*/` directories.
|
164
|
-
There are also sub-tasks to build manual pages individually as [roff] or HTML.
|
165
|
-
|
166
|
-
If you're using Bundler, this task also hooks into Bundler's gem packaging
|
167
|
-
tasks and ensures that your manual pages are built for packaging into a gem:
|
168
|
-
|
169
|
-
bundle exec rake build
|
170
|
-
gem spec pkg/*.gem | fgrep man/
|
171
|
-
|
172
|
-
## License
|
173
|
-
|
174
|
-
Released under the ISC license. See the LICENSE file for details.
|
175
|
-
|
176
|
-
[roff]: http://troff.org
|
177
|
-
[Markdown]: http://daringfireball.net/projects/markdown/
|
178
|
-
[Redcarpet]: https://github.com/vmg/redcarpet
|
179
|
-
[example]: https://raw.github.com/sunaku/md2man/master/EXAMPLE.markdown
|
180
|
-
[tables]: http://michelf.com/projects/php-markdown/extra/#table
|
data/man/man0/VERSION.markdown
DELETED
@@ -1,489 +0,0 @@
|
|
1
|
-
## Version 4.0.0 (2014-10-26)
|
2
|
-
|
3
|
-
### Major:
|
4
|
-
|
5
|
-
* Cross references are no longer expanded inside code spans and code blocks.
|
6
|
-
|
7
|
-
Thanks to Mathias Panzenböck for reporting this issue in GH-19:
|
8
|
-
https://github.com/sunaku/md2man/issues/19
|
9
|
-
|
10
|
-
* The `Md2Man::Document` module now defines the following methods. If you
|
11
|
-
redefine/override these methods in deriving classes, make sure that you
|
12
|
-
call `super()` therein to trigger these methods' original implementation!
|
13
|
-
|
14
|
-
* `Md2Man::Document#block_code(code, language)`
|
15
|
-
* `Md2Man::Document#codespan(code)`
|
16
|
-
|
17
|
-
## Version 3.0.2 (2014-10-26)
|
18
|
-
|
19
|
-
### Patch:
|
20
|
-
|
21
|
-
* Update bootstrap 2.3.2 CDN URL; previous one died.
|
22
|
-
|
23
|
-
## Version 3.0.1 (2014-07-16)
|
24
|
-
|
25
|
-
This release restores Mac OS X support and fixes a permalink generation bug.
|
26
|
-
|
27
|
-
### Patch:
|
28
|
-
|
29
|
-
* GH-13: man(1) on Mac OS X could not display URLs.
|
30
|
-
|
31
|
-
The version of groff on Mac OS X is too old: it lacks the an-ext.tmac
|
32
|
-
macro package that defines styles for email addresses and general URLs.
|
33
|
-
|
34
|
-
$ groff --version
|
35
|
-
...
|
36
|
-
GNU grops (groff) version 1.19.2
|
37
|
-
GNU troff (groff) version 1.19.2
|
38
|
-
|
39
|
-
This patch drops those URL macros in favor of simpler angled brackets.
|
40
|
-
|
41
|
-
Thanks to Sorin Ionescu for reporting this issue in GH-13:
|
42
|
-
https://github.com/sunaku/md2man/issues/13
|
43
|
-
|
44
|
-
* md2man-html(1): cross references were escaped in heading permalink IDs.
|
45
|
-
|
46
|
-
## Version 3.0.0 (2014-06-22)
|
47
|
-
|
48
|
-
This release changes md2man-html(1) heading permalinks to follow GitHub style:
|
49
|
-
unique, lowercase, and squeezed and stripped of HTML tags and non-word chars.
|
50
|
-
In addition, it renames the `md2man-xref` CSS class to `md2man-reference`.
|
51
|
-
|
52
|
-
Please make sure to update any existing bookmarks and/or hyperlinks you may
|
53
|
-
have for jumping to specific locations in your HTML manuals after upgrading.
|
54
|
-
|
55
|
-
### Major:
|
56
|
-
|
57
|
-
* Make permalink anchors on headings fully lowercase in md2man-html(1).
|
58
|
-
|
59
|
-
* Put permalinks on left & indicate target permalink in md2man-html(1).
|
60
|
-
|
61
|
-
* Make permalink anchors unique by appending a count in md2man-html(1).
|
62
|
-
|
63
|
-
* Rename `md2man-xref` CSS class to `md2man-reference` in md2man-html(1).
|
64
|
-
|
65
|
-
## Version 2.1.1 (2014-06-21)
|
66
|
-
|
67
|
-
### Patch:
|
68
|
-
|
69
|
-
* Bootstrap CSS failed to load for HTML manuals served under HTTPS.
|
70
|
-
See <https://github.com/sunaku/readably/pull/3> for the details.
|
71
|
-
|
72
|
-
* Drop redundant nil check in `Md2Man::Roff::Engine.escape()`.
|
73
|
-
|
74
|
-
### Other:
|
75
|
-
|
76
|
-
* GitHub now supports relative links from the README.
|
77
|
-
|
78
|
-
* README: add links to package, manuals, and GitHub.
|
79
|
-
|
80
|
-
## Version 2.1.0 (2014-05-04)
|
81
|
-
|
82
|
-
### Minor:
|
83
|
-
|
84
|
-
* md2man-html(1) now adds anchors and permalinks to all headings. This
|
85
|
-
makes it easy for readers to bookmark and share direct links to specific
|
86
|
-
sections of your HTML manual pages.
|
87
|
-
|
88
|
-
* md2man-html(1) now wraps individual components of the special `.TH`
|
89
|
-
top-level heading in HTML `<span>` elements with stylable CSS classes:
|
90
|
-
|
91
|
-
<span class="md2man-title">...</span>
|
92
|
-
<span class="md2man-section">...</span>
|
93
|
-
<span class="md2man-date">...</span>
|
94
|
-
<span class="md2man-source">...</span>
|
95
|
-
<span class="md2man-manual">...</span>
|
96
|
-
|
97
|
-
Thanks to Nick Fagerlund for requesting this feature in [GH-15](
|
98
|
-
https://github.com/sunaku/md2man/issues/15 ).
|
99
|
-
|
100
|
-
### Other:
|
101
|
-
|
102
|
-
* md2man(5) now documents the special `.TH` format of top-level headings.
|
103
|
-
|
104
|
-
Thanks to Nick Fagerlund for requesting this documentation in [GH-15](
|
105
|
-
https://github.com/sunaku/md2man/issues/15 ).
|
106
|
-
|
107
|
-
## Version 2.0.4 (2014-04-26)
|
108
|
-
|
109
|
-
### Patch:
|
110
|
-
|
111
|
-
* GH-16: Redcarpet 3.1 added a third parameter to its `header()` method.
|
112
|
-
This raised an ArgumentError on "wrong number of arguments (3 for 2)".
|
113
|
-
|
114
|
-
Thanks to zimbatm for contributing this patch.
|
115
|
-
|
116
|
-
* GH-17 and GH-18: Escape periods, quotes, and hyphens in code blocks.
|
117
|
-
This fixes a bug where lines beginning with periods or single quotes
|
118
|
-
did not appear when md2man-roff(1) output was rendered using man(1).
|
119
|
-
|
120
|
-
Thanks to zimbatm for reporting this bug and suggesting how to fix it.
|
121
|
-
|
122
|
-
## Version 2.0.3 (2014-01-16)
|
123
|
-
|
124
|
-
### Patch:
|
125
|
-
|
126
|
-
* Use CSS3 `-ch` suffix for accurate 80-character width in HTML output.
|
127
|
-
|
128
|
-
http://www.w3.org/TR/css3-values/#font-relative-lengths
|
129
|
-
|
130
|
-
## Version 2.0.2 (2013-09-08)
|
131
|
-
|
132
|
-
Patch:
|
133
|
-
|
134
|
-
* GH-14: escape single quotes at beginning of lines
|
135
|
-
|
136
|
-
See the "CONTROL CHARACTERS" section in the groff(7) manual for details.
|
137
|
-
|
138
|
-
Thanks to Nick Fagerlund for reporting this bug.
|
139
|
-
|
140
|
-
* escape periods at line beginnings with \& escape
|
141
|
-
|
142
|
-
* escape text line backslashes as "\e" per groff(7)
|
143
|
-
|
144
|
-
* better documentation for escaping in normal_text()
|
145
|
-
|
146
|
-
* it's better to escape backslashes as \[rs] than \e
|
147
|
-
|
148
|
-
See "Single-Character Escapes" section in groff(7).
|
149
|
-
|
150
|
-
Other:
|
151
|
-
|
152
|
-
* switch from double-quoted strings to single quotes
|
153
|
-
|
154
|
-
## Version 2.0.1 (2013-08-29)
|
155
|
-
|
156
|
-
Patch:
|
157
|
-
|
158
|
-
* Use a proper CDN to access Bootstrap 2.3.2 styling in HTML output.
|
159
|
-
|
160
|
-
* Ensure that man/ directory exists for the `md2man:web` Rake task.
|
161
|
-
|
162
|
-
* Specify license in gemspec file to fix warning when building gem.
|
163
|
-
|
164
|
-
Thanks to Bastien Dejean for contributing this patch.
|
165
|
-
|
166
|
-
Other:
|
167
|
-
|
168
|
-
* Upgrade dependent gems by running `bundle update`.
|
169
|
-
|
170
|
-
* minitest 4.7.5 provides spec library via autorun.
|
171
|
-
|
172
|
-
## Version 2.0.0 (2013-05-05)
|
173
|
-
|
174
|
-
This release renames md2man executables and libraries to highlight the fact
|
175
|
-
that md2man provides two processing pathways: one for Roff and one for HTML.
|
176
|
-
|
177
|
-
Major:
|
178
|
-
|
179
|
-
* Rename md2man(1) executable to md2man-roff(1).
|
180
|
-
|
181
|
-
* Rename `Md2Man::Engine` to `Md2Man::Roff::Engine`.
|
182
|
-
|
183
|
-
* Rename "manpage-reference" CSS class to "md2man-xref" in HTML output.
|
184
|
-
|
185
|
-
* The `Md2Man::Document#reference()` method now takes only two parameters:
|
186
|
-
|
187
|
-
* `input_match` - MatchData object for the reference in Markdown input
|
188
|
-
containing the following named capture groups:
|
189
|
-
|
190
|
-
* `:page` - name of the manual page
|
191
|
-
|
192
|
-
* `:section` - section number of the manual page
|
193
|
-
|
194
|
-
* `output_match` - MatchData object for the reference in output document
|
195
|
-
containing the following named capture groups:
|
196
|
-
|
197
|
-
* `:addendum` - non-space characters immediately after the reference in
|
198
|
-
the output document
|
199
|
-
|
200
|
-
Patch:
|
201
|
-
|
202
|
-
* Prevent cross-references from being expanded inside HTML tags.
|
203
|
-
|
204
|
-
Other:
|
205
|
-
|
206
|
-
* Add md2man(5) manual page detailing md2man's markdown file format.
|
207
|
-
|
208
|
-
## Version 1.6.2 (2013-05-05)
|
209
|
-
|
210
|
-
Patch:
|
211
|
-
|
212
|
-
* Fix "uninitialized constant Md2Man::VERSION" error in `md2man/rakefile`.
|
213
|
-
|
214
|
-
* HTML manual page CSS: justify the lines of text just like man(1) does.
|
215
|
-
|
216
|
-
* HTML manual page CSS: resize body to allot 78ex width for manpage text.
|
217
|
-
|
218
|
-
## Version 1.6.1 (2013-05-04)
|
219
|
-
|
220
|
-
Patch:
|
221
|
-
|
222
|
-
* Replace multi-column CSS with single centered body.
|
223
|
-
|
224
|
-
Other:
|
225
|
-
|
226
|
-
* Fix manpage xrefs in README and VERSION documents.
|
227
|
-
|
228
|
-
## Version 1.6.0 (2013-03-10)
|
229
|
-
|
230
|
-
Minor:
|
231
|
-
|
232
|
-
* Added an md2man-rake(1) executable that lets you run md2man's rake(1)
|
233
|
-
tasks _directly_ from the command line: without the need for a "Rakefile"
|
234
|
-
in your working directory that loads the `md2man/rakefile` library.
|
235
|
-
|
236
|
-
* In web pages generated by the `md2man:web` Rake task:
|
237
|
-
|
238
|
-
* extract CSS into a separate `man/style.css` file
|
239
|
-
|
240
|
-
* center manpage on screen & auto-split into columns
|
241
|
-
|
242
|
-
Patch:
|
243
|
-
|
244
|
-
* In web pages generated by the `md2man:web` Rake task:
|
245
|
-
|
246
|
-
* don't rely on being emitted into a `man/` directory
|
247
|
-
|
248
|
-
Other:
|
249
|
-
|
250
|
-
* add README and VERSION to generated HTML man pages
|
251
|
-
|
252
|
-
## Version 1.5.1 (2013-03-06)
|
253
|
-
|
254
|
-
Patch:
|
255
|
-
|
256
|
-
* All this time, this project's documentation stated that Redcarpet's
|
257
|
-
`no_intra_emphasis` option was enabled, but in reality, it was not.
|
258
|
-
The documentation has been corrected and the option remains disabled.
|
259
|
-
|
260
|
-
* In web pages generated by the `md2man:web` Rake task:
|
261
|
-
|
262
|
-
* deactivate cross references to external manual pages
|
263
|
-
|
264
|
-
* don't assume that NAME section contains a tagline
|
265
|
-
|
266
|
-
* sort man/ subdirectories in the HTML index page
|
267
|
-
|
268
|
-
* fix link to index page from webs directly in man/
|
269
|
-
|
270
|
-
* add generator META tag to HTML output template
|
271
|
-
|
272
|
-
* only apply special styling to the first H1 child
|
273
|
-
|
274
|
-
* parse title from first paragraph containing hyphen
|
275
|
-
|
276
|
-
Other:
|
277
|
-
|
278
|
-
* rename HISTORY to VERSION so it sorts after README
|
279
|
-
|
280
|
-
* tests should exercise engines with default options
|
281
|
-
|
282
|
-
## Version 1.5.0 (2013-02-24)
|
283
|
-
|
284
|
-
Minor:
|
285
|
-
|
286
|
-
* The `md2man:web` task from `md2man/rakefile` now:
|
287
|
-
|
288
|
-
* emits valid HTML5 with helpful HTML page titles
|
289
|
-
|
290
|
-
* uses Twitter Bootstrap styling for HTML man pages
|
291
|
-
|
292
|
-
* emits only ONE index page for all HTML man pages
|
293
|
-
|
294
|
-
Other:
|
295
|
-
|
296
|
-
* README: better organize the subsections of "Usage"
|
297
|
-
|
298
|
-
* include md2man rake tasks in developer's rakefile
|
299
|
-
|
300
|
-
## Version 1.4.1 (2013-02-23)
|
301
|
-
|
302
|
-
Patch:
|
303
|
-
|
304
|
-
* rakefile: arbitrary directory structure under man/
|
305
|
-
|
306
|
-
https://github.com/sunaku/md2man/pull/3#issuecomment-9429077
|
307
|
-
|
308
|
-
Thanks to Postmodern for raising this issue.
|
309
|
-
|
310
|
-
* hook into 'build' task only if using Bundler tasks
|
311
|
-
|
312
|
-
https://github.com/sunaku/md2man/pull/7#issuecomment-9467621
|
313
|
-
|
314
|
-
Thanks to Postmodern for raising this issue.
|
315
|
-
|
316
|
-
* GH-8: Redcarpet requires Ruby 1.9 and so must we
|
317
|
-
|
318
|
-
https://github.com/sunaku/md2man/issues/8#issuecomment-9509240
|
319
|
-
|
320
|
-
Thanks to Postmodern for raising this issue.
|
321
|
-
|
322
|
-
Other:
|
323
|
-
|
324
|
-
* README: add md2man-html(1) and Md2Man::HTML usage
|
325
|
-
|
326
|
-
* LICENSE: use GitHub profile URLs instead of e-mail
|
327
|
-
|
328
|
-
## Version 1.4.0 (2012-10-14)
|
329
|
-
|
330
|
-
Minor:
|
331
|
-
|
332
|
-
* roff: emit non-first H1 headings as H2 headings
|
333
|
-
|
334
|
-
* html: add `Md2Man::HTML::Engine` class for HTML manual page generation
|
335
|
-
|
336
|
-
* html: add md2man-html(1) bin script for command line access to the above
|
337
|
-
|
338
|
-
* html: add ID attributes on all headings for easy permalinking
|
339
|
-
|
340
|
-
* rake: add `md2man/rakefile` to process markdown files in man/
|
341
|
-
|
342
|
-
This library provides a `rake md2man` task that builds UNIX and HTML
|
343
|
-
manual pages from Markdown files (with ".markdown", ".mkd", or ".md"
|
344
|
-
extension) inside your `man/man*/` directories. It also provides
|
345
|
-
sub-tasks to build *only* UNIX or HTML manual pages separately.
|
346
|
-
|
347
|
-
It also hooks into Bundler's gem packaging tasks to automatically build
|
348
|
-
your manual pages for packaging into a gem. See the README for details.
|
349
|
-
|
350
|
-
## Version 1.3.2 (2012-10-13)
|
351
|
-
|
352
|
-
Patch:
|
353
|
-
|
354
|
-
* roff: escape backslashes inside codespan nodes too
|
355
|
-
|
356
|
-
* roff: escape backslashes inside block\_code nodes
|
357
|
-
|
358
|
-
## Version 1.3.1 (2012-10-09)
|
359
|
-
|
360
|
-
Patch:
|
361
|
-
|
362
|
-
* roff: do not render references inside code blocks.
|
363
|
-
|
364
|
-
* roff: do not render references inside code spans.
|
365
|
-
|
366
|
-
* roff: fix single-line indented paragraph detection.
|
367
|
-
|
368
|
-
* roff: also indent block\_code just like block\_quote.
|
369
|
-
|
370
|
-
* roff: add paragraph above block\_quote for spacing.
|
371
|
-
|
372
|
-
* roff: render code blocks as paragraphs for spacing.
|
373
|
-
|
374
|
-
Otherwise there's not enough space between the previous paragraph and
|
375
|
-
the code block: it appears on the next line and appears ugly in man(1).
|
376
|
-
|
377
|
-
* document: make reference regexp match more manpages.
|
378
|
-
|
379
|
-
Other:
|
380
|
-
|
381
|
-
* document: stronger digest encoding using NUL bytes.
|
382
|
-
|
383
|
-
* document: super() can't reach Redcarpet's renderer classes.
|
384
|
-
See https://github.com/vmg/redcarpet/issues/51 for details.
|
385
|
-
|
386
|
-
## Version 1.3.0 (2012-09-27)
|
387
|
-
|
388
|
-
Minor:
|
389
|
-
|
390
|
-
* Intra-word emphasis is now enabled *by default* in `Md2Man::ENGINE`.
|
391
|
-
To not be affected by this change, you may still construct your own
|
392
|
-
Redcarpet::Markdown engine with your own set of processing options.
|
393
|
-
|
394
|
-
## Version 1.2.1 (2012-07-05)
|
395
|
-
|
396
|
-
Patch:
|
397
|
-
|
398
|
-
* GH-4: ruby 1.8.7 lacks negative lookbehind regexps.
|
399
|
-
Thanks to Postmodern for reporting this issue.
|
400
|
-
|
401
|
-
Other:
|
402
|
-
|
403
|
-
* GH-1: use `~>` for gem version constraints.
|
404
|
-
See http://docs.rubygems.org/read/chapter/16
|
405
|
-
Thanks to Postmodern for this contribution.
|
406
|
-
|
407
|
-
## Version 1.2.0 (2012-02-06)
|
408
|
-
|
409
|
-
Minor:
|
410
|
-
|
411
|
-
* The `Md2Man::Document` module now handles paragraph() nodes and dispatches
|
412
|
-
their content accordingly to hook methods for indented, tagged, and normal
|
413
|
-
paragraphs. A Redcarpet markdown parser need only include that module and
|
414
|
-
implement those hook methods in order to benefit from md2man's extensions
|
415
|
-
to markdown syntax programmatically.
|
416
|
-
|
417
|
-
Other:
|
418
|
-
|
419
|
-
* README: mention features; revise markdown; cleanup.
|
420
|
-
|
421
|
-
* LICENSE: @tanoku created initial Manpage renderer.
|
422
|
-
|
423
|
-
## Version 1.1.0 (2012-02-02)
|
424
|
-
|
425
|
-
Minor:
|
426
|
-
|
427
|
-
* Add `Md2Man::Document` module for programmatic processing of
|
428
|
-
cross-references to other UNIX manual pages within Redcarpet.
|
429
|
-
|
430
|
-
Other:
|
431
|
-
|
432
|
-
* README: not all systems support `man -l` option.
|
433
|
-
|
434
|
-
* gemspec: upgrade to redcarpet 2.1.0.
|
435
|
-
|
436
|
-
* bundler suggests moving all dev deps into gemspec.
|
437
|
-
|
438
|
-
* README: fix installation commands for development.
|
439
|
-
|
440
|
-
* README: simplify project slogan to be more memorable.
|
441
|
-
|
442
|
-
## Version 1.0.2 (2012-01-09)
|
443
|
-
|
444
|
-
Patch:
|
445
|
-
|
446
|
-
* Blockquote's leading paragraph regexp was not anchored.
|
447
|
-
|
448
|
-
* Freezing internal constants prevents monkey patching.
|
449
|
-
|
450
|
-
Other:
|
451
|
-
|
452
|
-
* Upgraded to Binman 3 for better interoperability with Bundler.
|
453
|
-
|
454
|
-
* Added example input file from the Linux Man Page Howto.
|
455
|
-
|
456
|
-
* Forgot to change project slogan in the gem package.
|
457
|
-
|
458
|
-
## Version 1.0.1 (2011-12-06)
|
459
|
-
|
460
|
-
Major:
|
461
|
-
|
462
|
-
* Renamed the project from "redcarpet-manpage" to "md2man".
|
463
|
-
|
464
|
-
* `RedcarpetManpage::Renderer` is now `Md2Man::Engine`.
|
465
|
-
|
466
|
-
* `RedcarpetManpage::RENDERER` is now `Md2Man::ENGINE`.
|
467
|
-
|
468
|
-
* Tagged paragraphs no longer require the first line to begin with italic or
|
469
|
-
bold styling. All that matters is that the subsequent lines are indented.
|
470
|
-
|
471
|
-
Minor:
|
472
|
-
|
473
|
-
* Added md2man(1) executable for command-line usage.
|
474
|
-
|
475
|
-
* Added support for all HTML 4.0 and XHTML 1.0 entities.
|
476
|
-
|
477
|
-
* Added support for tables, horizontal rules, and more.
|
478
|
-
|
479
|
-
* Added `Md2Man::Roff` mixin for advanced Redcarpet2 usage.
|
480
|
-
|
481
|
-
* Improved README with some new and revised documentation.
|
482
|
-
|
483
|
-
Other:
|
484
|
-
|
485
|
-
* Rewrote entire Markdown to Roff conversion from scratch while doing TDD.
|
486
|
-
|
487
|
-
## Version 0.0.1 (2011-10-13)
|
488
|
-
|
489
|
-
First release! Happy birthday! Woohoo! :-)
|