md2man 2.0.4 → 2.1.0
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.
- checksums.yaml +4 -4
- data/VERSION.markdown +12 -0
- data/bin/md2man-html +12 -1
- data/bin/md2man-rake +1 -1
- data/bin/md2man-roff +1 -1
- data/lib/md2man/html.rb +27 -1
- data/lib/md2man/rakefile/style.css +14 -0
- data/lib/md2man/version.rb +1 -1
- data/man/index.html +1 -1
- data/man/man0/README.html +13 -13
- data/man/man0/VERSION.html +31 -22
- data/man/man0/VERSION.markdown +12 -0
- data/man/man1/md2man-html.1 +19 -1
- data/man/man1/md2man-html.1.html +12 -4
- 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 +30 -4
- data/man/man5/md2man.5.html +14 -10
- data/man/man5/md2man.5.markdown +23 -5
- data/man/style.css +14 -0
- data/test/md2man/html_test.rb +5 -5
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 6d0f7375401869b8c75b984a10b03931ba66b389
|
4
|
+
data.tar.gz: ccefdceb0a7b2b71c37ed418e22dbe2e11d2d92b
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 520e506c97403142377ae2329ea34197246595dabe5872fdb9fc3dc50fd498718e7188823326a907c9d770943c8424f9780df221edaa1dd726933656b40cf7bf
|
7
|
+
data.tar.gz: 3afb8e18c990e677a071ece093b78c4ecdc301d779f2b7b2150d3e0d01255c7906743bd605dcd9c1ea0d4f1de718cd4887404ccdf0d303f778d5bc8e08b471cb
|
data/VERSION.markdown
CHANGED
@@ -1,3 +1,15 @@
|
|
1
|
+
## Version 2.1.0 (2014-05-04)
|
2
|
+
|
3
|
+
### Minor:
|
4
|
+
|
5
|
+
* md2man-html(1): add anchors & permalinks to headings.
|
6
|
+
|
7
|
+
* GH-15: wrap `.TH` components in stylable HTML spans.
|
8
|
+
|
9
|
+
### Other:
|
10
|
+
|
11
|
+
* GH-15: paraphrase man-pages(7) description of `.TH`.
|
12
|
+
|
1
13
|
## Version 2.0.4 (2014-04-26)
|
2
14
|
|
3
15
|
### Patch:
|
data/bin/md2man-html
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
#!/usr/bin/env ruby
|
2
2
|
=begin =======================================================================
|
3
3
|
|
4
|
-
# MD2MAN-HTML 1 2014-04
|
4
|
+
# MD2MAN-HTML 1 2014-05-04 2.1.0
|
5
5
|
|
6
6
|
## NAME
|
7
7
|
|
@@ -17,6 +17,17 @@ This program converts md2man(5) flavored markdown(7) input from the given
|
|
17
17
|
*FILE* into HTML and then prints the result to the standard output stream.
|
18
18
|
If *FILE* is not given, then the standard input stream is read in its place.
|
19
19
|
|
20
|
+
### Top-level headings
|
21
|
+
|
22
|
+
Each component of the `.TH` directive in roff(7), described under "Top-level
|
23
|
+
headings" in md2man(5), is wrapped in stylable `<span>` elements as follows:
|
24
|
+
|
25
|
+
<span class="md2man-title">...</span>
|
26
|
+
<span class="md2man-section">...</span>
|
27
|
+
<span class="md2man-date">...</span>
|
28
|
+
<span class="md2man-source">...</span>
|
29
|
+
<span class="md2man-manual">...</span>
|
30
|
+
|
20
31
|
### Cross references
|
21
32
|
|
22
33
|
Cross references to manual pages are emitted as HTML hyperlinks that have
|
data/bin/md2man-rake
CHANGED
data/bin/md2man-roff
CHANGED
data/lib/md2man/html.rb
CHANGED
@@ -1,10 +1,20 @@
|
|
1
1
|
require 'cgi'
|
2
|
+
require 'shellwords'
|
2
3
|
require 'md2man/document'
|
3
4
|
|
4
5
|
module Md2Man::HTML
|
5
6
|
|
6
7
|
include Md2Man::Document
|
7
8
|
|
9
|
+
#---------------------------------------------------------------------------
|
10
|
+
# document-level processing
|
11
|
+
#---------------------------------------------------------------------------
|
12
|
+
|
13
|
+
def preprocess document
|
14
|
+
@h1_seen = false
|
15
|
+
super
|
16
|
+
end
|
17
|
+
|
8
18
|
#---------------------------------------------------------------------------
|
9
19
|
# block-level processing
|
10
20
|
#---------------------------------------------------------------------------
|
@@ -22,10 +32,26 @@ module Md2Man::HTML
|
|
22
32
|
"<dl><dd>#{text}</dd></dl>"
|
23
33
|
end
|
24
34
|
|
35
|
+
# see "Title line" in man-pages(7) or "Top-level headings" in md2man(5)
|
36
|
+
HEADER_PARTS = %w[ title section date source manual ].freeze
|
37
|
+
|
25
38
|
def header text, level, _=nil
|
39
|
+
if level == 1 and not @h1_seen
|
40
|
+
@h1_seen = true
|
41
|
+
text = HEADER_PARTS.zip(Shellwords.split(text)).map do |part, value|
|
42
|
+
%{<span class="md2man-#{part}">#{value}</span>} if value
|
43
|
+
end.compact.join(' ')
|
44
|
+
end
|
45
|
+
|
26
46
|
id = text.gsub(/<.+?>/, '-'). # strip all HTML tags
|
27
47
|
gsub(/\W+/, '-').gsub(/^-|-$/, '') # fold non-word chars
|
28
|
-
|
48
|
+
[
|
49
|
+
%{<h#{level} id="#{id}">},
|
50
|
+
text,
|
51
|
+
%{<a name="#{id}" href="##{id}" class="md2man-permalink">},
|
52
|
+
'</a>',
|
53
|
+
"</h#{level}>",
|
54
|
+
].join
|
29
55
|
end
|
30
56
|
|
31
57
|
#---------------------------------------------------------------------------
|
@@ -31,6 +31,20 @@
|
|
31
31
|
font-size: smaller;
|
32
32
|
text-align: right;
|
33
33
|
}
|
34
|
+
|
35
|
+
h1:first-child > a.md2man-permalink {
|
36
|
+
display: none;
|
37
|
+
}
|
38
|
+
|
39
|
+
a.md2man-permalink:after {
|
40
|
+
padding-left: 0.25em;
|
41
|
+
content: '\2665'; /* ♥ */
|
42
|
+
opacity: 0.125;
|
43
|
+
}
|
44
|
+
|
45
|
+
a.md2man-permalink:hover:after {
|
46
|
+
opacity: initial;
|
47
|
+
}
|
34
48
|
}
|
35
49
|
|
36
50
|
@media print {
|
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 2.0
|
5
|
+
<meta name="generator" content="md2man 2.1.0 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]-->
|
data/man/man0/README.html
CHANGED
@@ -2,20 +2,20 @@
|
|
2
2
|
<html>
|
3
3
|
<head>
|
4
4
|
<meta charset="utf-8" />
|
5
|
-
<meta name="generator" content="md2man 2.0
|
5
|
+
<meta name="generator" content="md2man 2.1.0 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]-->
|
9
9
|
</head>
|
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"><h1 id="md2man-markdown-to-manpage">md2man - markdown to manpage</h1><p>md2man is a Ruby library and a set of command-line programs that convert
|
11
|
-
<a href="http://daringfireball.net/projects/markdown/">Markdown</a> 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
|
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"><h1 id="md2man-markdown-to-manpage"><span class="md2man-title">md2man</span> <span class="md2man-section">-</span> <span class="md2man-date">markdown</span> <span class="md2man-source">to</span> <span class="md2man-manual">manpage</span><a name="md2man-markdown-to-manpage" href="#md2man-markdown-to-manpage" class="md2man-permalink"></a></h1><p>md2man is a Ruby library and a set of command-line programs that convert
|
11
|
+
<a href="http://daringfireball.net/projects/markdown/">Markdown</a> 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<a name="Features" href="#Features" class="md2man-permalink"></a></h2>
|
12
12
|
<ul>
|
13
13
|
<li><p>Formats tagged and indented paragraphs (see "document format" below).</p></li>
|
14
14
|
<li><p>Translates all HTML4 and XHTML1 entities into native <a href="http://troff.org">roff</a> equivalents.</p></li>
|
15
15
|
<li><p>Supports markdown extensions such as <a href="http://michelf.com/projects/php-markdown/extra/#table">PHP Markdown Extra tables</a>.</p></li>
|
16
16
|
<li><p>Usable from the command line as a filter in a UNIX command pipeline.</p></li>
|
17
17
|
</ul>
|
18
|
-
<h3 id="Demonstration">Demonstration
|
18
|
+
<h3 id="Demonstration">Demonstration<a name="Demonstration" href="#Demonstration" class="md2man-permalink"></a></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>
|
19
19
|
<pre><code>md2man-roff EXAMPLE.markdown > EXAMPLE.1
|
20
20
|
man -l EXAMPLE.1
|
21
21
|
</code></pre>
|
@@ -23,10 +23,10 @@ man -l EXAMPLE.1
|
|
23
23
|
<pre><code>md2man-html EXAMPLE.markdown > EXAMPLE.html
|
24
24
|
open EXAMPLE.html
|
25
25
|
</code></pre>
|
26
|
-
<h2 id="Installation">Installation
|
26
|
+
<h2 id="Installation">Installation<a name="Installation" href="#Installation" class="md2man-permalink"></a></h2>
|
27
27
|
<pre><code>gem install md2man
|
28
28
|
</code></pre>
|
29
|
-
<h3 id="Development">Development
|
29
|
+
<h3 id="Development">Development<a name="Development" href="#Development" class="md2man-permalink"></a></h3>
|
30
30
|
<pre><code>git clone git://github.com/sunaku/md2man
|
31
31
|
cd md2man
|
32
32
|
bundle install
|
@@ -34,10 +34,10 @@ bundle exec rake --tasks # packaging tasks
|
|
34
34
|
bundle exec md2man-roff --help # run it directly
|
35
35
|
bundle exec md2man-html --help # run it directly
|
36
36
|
</code></pre>
|
37
|
-
<h2 id="Usage">Usage
|
37
|
+
<h2 id="Usage">Usage<a name="Usage" href="#Usage" class="md2man-permalink"></a></h2><h3 id="For-roff-output">For <a href="http://troff.org">roff</a> output<a name="For-roff-output" href="#For-roff-output" class="md2man-permalink"></a></h3><h4 id="At-the-command-line">At the command line<a name="At-the-command-line" href="#At-the-command-line" class="md2man-permalink"></a></h4><p>See <a class="md2man-xref" href="../man1/md2man-roff.1.html">md2man-roff(1)</a> manual:</p>
|
38
38
|
<pre><code>md2man-roff --help
|
39
39
|
</code></pre>
|
40
|
-
<h4 id="Inside-a-Ruby-script">Inside a Ruby script
|
40
|
+
<h4 id="Inside-a-Ruby-script">Inside a Ruby script<a name="Inside-a-Ruby-script" href="#Inside-a-Ruby-script" class="md2man-permalink"></a></h4><p>Use the default renderer:</p>
|
41
41
|
<pre><code>require 'md2man/roff/engine'
|
42
42
|
|
43
43
|
your_roff_output = Md2Man::Roff::<a class="md2man-xref">ENGINE.render(your_markdown_input)</a>
|
@@ -69,10 +69,10 @@ end
|
|
69
69
|
engine = Redcarpet::Markdown.new(YourManpageRenderer, your_options_hash)
|
70
70
|
your_roff_output = <a class="md2man-xref">engine.render(your_markdown_input)</a>
|
71
71
|
</code></pre>
|
72
|
-
<h3 id="For-HTML-output">For HTML output
|
72
|
+
<h3 id="For-HTML-output">For HTML output<a name="For-HTML-output" href="#For-HTML-output" class="md2man-permalink"></a></h3><h4 id="At-the-command-line">At the command line<a name="At-the-command-line" href="#At-the-command-line" class="md2man-permalink"></a></h4><p>See <a class="md2man-xref" href="../man1/md2man-html.1.html">md2man-html(1)</a> manual:</p>
|
73
73
|
<pre><code>md2man-html --help
|
74
74
|
</code></pre>
|
75
|
-
<h4 id="Inside-a-Ruby-script">Inside a Ruby script
|
75
|
+
<h4 id="Inside-a-Ruby-script">Inside a Ruby script<a name="Inside-a-Ruby-script" href="#Inside-a-Ruby-script" class="md2man-permalink"></a></h4><p>Use the default renderer:</p>
|
76
76
|
<pre><code>require 'md2man/html/engine'
|
77
77
|
|
78
78
|
your_html_output = Md2Man::HTML::<a class="md2man-xref">ENGINE.render(your_markdown_input)</a>
|
@@ -104,10 +104,10 @@ end
|
|
104
104
|
engine = Redcarpet::Markdown.new(YourManpageRenderer, your_options_hash)
|
105
105
|
your_html_output = <a class="md2man-xref">engine.render(your_markdown_input)</a>
|
106
106
|
</code></pre>
|
107
|
-
<h3 id="Building-man-pages">Building man pages
|
107
|
+
<h3 id="Building-man-pages">Building man pages<a name="Building-man-pages" href="#Building-man-pages" class="md2man-permalink"></a></h3><h4 id="At-the-command-line">At the command line<a name="At-the-command-line" href="#At-the-command-line" class="md2man-permalink"></a></h4><p>See <a class="md2man-xref" href="../man1/md2man-rake.1.html">md2man-rake(1)</a> manual:</p>
|
108
108
|
<pre><code>md2man-rake --help
|
109
109
|
</code></pre>
|
110
|
-
<h4 id="Inside-a-Ruby-script">Inside a Ruby script
|
110
|
+
<h4 id="Inside-a-Ruby-script">Inside a Ruby script<a name="Inside-a-Ruby-script" href="#Inside-a-Ruby-script" class="md2man-permalink"></a></h4><p>Add this snippet to your gemspec file:</p>
|
111
111
|
<pre><code>s.files += Dir['man/man?/*.?'] # UNIX man pages
|
112
112
|
s.files += Dir['man/**/*.{html,css,js}'] # HTML man pages
|
113
113
|
s.add_development_dependency 'md2man', '~> 2.0'
|
@@ -122,5 +122,5 @@ tasks and ensures that your manual pages are built for packaging into a gem:</p>
|
|
122
122
|
<pre><code>bundle exec rake build
|
123
123
|
gem spec pkg/*.gem | fgrep man/
|
124
124
|
</code></pre>
|
125
|
-
<h2 id="License">License
|
125
|
+
<h2 id="License">License<a name="License" href="#License" class="md2man-permalink"></a></h2><p>Released under the ISC license. See the LICENSE file for details.</p></div></body>
|
126
126
|
</html>
|
data/man/man0/VERSION.html
CHANGED
@@ -2,12 +2,21 @@
|
|
2
2
|
<html>
|
3
3
|
<head>
|
4
4
|
<meta charset="utf-8" />
|
5
|
-
<meta name="generator" content="md2man 2.0
|
5
|
+
<meta name="generator" content="md2man 2.1.0 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-2-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-2-1-0-2014-05-04">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"></a></h2><h3 id="Minor">Minor:<a name="Minor" href="#Minor" class="md2man-permalink"></a></h3>
|
11
|
+
<ul>
|
12
|
+
<li><p><a class="md2man-xref" href="../man1/md2man-html.1.html">md2man-html(1)</a>: add anchors & permalinks to headings.</p></li>
|
13
|
+
<li><p>GH-15: wrap <code>.TH</code> components in stylable HTML spans.</p></li>
|
14
|
+
</ul>
|
15
|
+
<h3 id="Other">Other:<a name="Other" href="#Other" class="md2man-permalink"></a></h3>
|
16
|
+
<ul>
|
17
|
+
<li>GH-15: paraphrase <a class="md2man-xref">man-pages(7)</a> description of <code>.TH</code>.</li>
|
18
|
+
</ul>
|
19
|
+
<h2 id="Version-2-0-4-2014-04-26">Version 2.0.4 (2014-04-26)<a name="Version-2-0-4-2014-04-26" href="#Version-2-0-4-2014-04-26" class="md2man-permalink"></a></h2><h3 id="Patch">Patch:<a name="Patch" href="#Patch" class="md2man-permalink"></a></h3>
|
11
20
|
<ul>
|
12
21
|
<li><p>GH-16: Redcarpet 3.1 added a third parameter to its <code>header()</code> method.
|
13
22
|
This raised an ArgumentError on "wrong number of arguments (3 for 2)".</p><p>Thanks to zimbatm for contributing this patch.</p></li>
|
@@ -15,11 +24,11 @@ This raised an ArgumentError on "wrong number of arguments (3 for 2)".
|
|
15
24
|
This fixes a bug where lines beginning with periods or single quotes
|
16
25
|
did not appear when <a class="md2man-xref" href="../man1/md2man-roff.1.html">md2man-roff(1)</a> output was rendered using <a class="md2man-xref">man(1)</a>.</p><p>Thanks to zimbatm for reporting this bug and suggesting how to fix it.</p></li>
|
17
26
|
</ul>
|
18
|
-
<h2 id="Version-2-0-3-2014-01-16">Version 2.0.3 (2014-01-16)
|
27
|
+
<h2 id="Version-2-0-3-2014-01-16">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"></a></h2><h3 id="Patch">Patch:<a name="Patch" href="#Patch" class="md2man-permalink"></a></h3>
|
19
28
|
<ul>
|
20
29
|
<li><p>Use CSS3 <code>-ch</code> suffix for accurate 80-character width in HTML output.</p><p><a href="http://www.w3.org/TR/css3-values/#font-relative-lengths">http://www.w3.org/TR/css3-values/#font-relative-lengths</a></p></li>
|
21
30
|
</ul>
|
22
|
-
<h2 id="Version-2-0-2-2013-09-08">Version 2.0.2 (2013-09-08)
|
31
|
+
<h2 id="Version-2-0-2-2013-09-08">Version 2.0.2 (2013-09-08)<a name="Version-2-0-2-2013-09-08" href="#Version-2-0-2-2013-09-08" class="md2man-permalink"></a></h2><p>Patch:</p>
|
23
32
|
<ul>
|
24
33
|
<li><p>GH-14: escape single quotes at beginning of lines</p><p>See the "CONTROL CHARACTERS" section in the <a class="md2man-xref">groff(7)</a> manual for details.</p><p>Thanks to Nick Fagerlund for reporting this bug.</p></li>
|
25
34
|
<li><p>escape periods at line beginnings with & escape</p></li>
|
@@ -31,7 +40,7 @@ did not appear when <a class="md2man-xref" href="../man1/md2man-roff.1.html">md2
|
|
31
40
|
<ul>
|
32
41
|
<li>switch from double-quoted strings to single quotes</li>
|
33
42
|
</ul>
|
34
|
-
<h2 id="Version-2-0-1-2013-08-29">Version 2.0.1 (2013-08-29)
|
43
|
+
<h2 id="Version-2-0-1-2013-08-29">Version 2.0.1 (2013-08-29)<a name="Version-2-0-1-2013-08-29" href="#Version-2-0-1-2013-08-29" class="md2man-permalink"></a></h2><p>Patch:</p>
|
35
44
|
<ul>
|
36
45
|
<li><p>Use a proper CDN to access Bootstrap 2.3.2 styling in HTML output.</p></li>
|
37
46
|
<li><p>Ensure that man/ directory exists for the <code>md2man:web</code> Rake task.</p></li>
|
@@ -42,7 +51,7 @@ did not appear when <a class="md2man-xref" href="../man1/md2man-roff.1.html">md2
|
|
42
51
|
<li><p>Upgrade dependent gems by running <code>bundle update</code>.</p></li>
|
43
52
|
<li><p>minitest 4.7.5 provides spec library via autorun.</p></li>
|
44
53
|
</ul>
|
45
|
-
<h2 id="Version-2-0-0-2013-05-05">Version 2.0.0 (2013-05-05)
|
54
|
+
<h2 id="Version-2-0-0-2013-05-05">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"></a></h2><p>This release renames md2man executables and libraries to highlight the fact
|
46
55
|
that md2man provides two processing pathways: one for Roff and one for HTML.</p><p>Major:</p>
|
47
56
|
<ul>
|
48
57
|
<li><p>Rename <a class="md2man-xref">md2man(1)</a> executable to <a class="md2man-xref" href="../man1/md2man-roff.1.html">md2man-roff(1)</a>.</p></li>
|
@@ -74,13 +83,13 @@ the output document</li>
|
|
74
83
|
<ul>
|
75
84
|
<li>Add <a class="md2man-xref" href="../man5/md2man.5.html">md2man(5)</a> manual page detailing md2man's markdown file format.</li>
|
76
85
|
</ul>
|
77
|
-
<h2 id="Version-1-6-2-2013-05-05">Version 1.6.2 (2013-05-05)
|
86
|
+
<h2 id="Version-1-6-2-2013-05-05">Version 1.6.2 (2013-05-05)<a name="Version-1-6-2-2013-05-05" href="#Version-1-6-2-2013-05-05" class="md2man-permalink"></a></h2><p>Patch:</p>
|
78
87
|
<ul>
|
79
88
|
<li><p>Fix "uninitialized constant Md2Man::VERSION" error in <code>md2man/rakefile</code>.</p></li>
|
80
89
|
<li><p>HTML manual page CSS: justify the lines of text just like <a class="md2man-xref">man(1)</a> does.</p></li>
|
81
90
|
<li><p>HTML manual page CSS: resize body to allot 78ex width for manpage text.</p></li>
|
82
91
|
</ul>
|
83
|
-
<h2 id="Version-1-6-1-2013-05-04">Version 1.6.1 (2013-05-04)
|
92
|
+
<h2 id="Version-1-6-1-2013-05-04">Version 1.6.1 (2013-05-04)<a name="Version-1-6-1-2013-05-04" href="#Version-1-6-1-2013-05-04" class="md2man-permalink"></a></h2><p>Patch:</p>
|
84
93
|
<ul>
|
85
94
|
<li>Replace multi-column CSS with single centered body.</li>
|
86
95
|
</ul>
|
@@ -88,7 +97,7 @@ the output document</li>
|
|
88
97
|
<ul>
|
89
98
|
<li>Fix manpage xrefs in README and VERSION documents.</li>
|
90
99
|
</ul>
|
91
|
-
<h2 id="Version-1-6-0-2013-03-10">Version 1.6.0 (2013-03-10)
|
100
|
+
<h2 id="Version-1-6-0-2013-03-10">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"></a></h2><p>Minor:</p>
|
92
101
|
<ul>
|
93
102
|
<li><p>Added an <a class="md2man-xref" href="../man1/md2man-rake.1.html">md2man-rake(1)</a> executable that lets you run md2man's <a class="md2man-xref">rake(1)</a>
|
94
103
|
tasks <em>directly</em> from the command line: without the need for a "Rakefile"
|
@@ -110,7 +119,7 @@ in your working directory that loads the <code>md2man/rakefile</code> library.</
|
|
110
119
|
<ul>
|
111
120
|
<li>add README and VERSION to generated HTML man pages</li>
|
112
121
|
</ul>
|
113
|
-
<h2 id="Version-1-5-1-2013-03-06">Version 1.5.1 (2013-03-06)
|
122
|
+
<h2 id="Version-1-5-1-2013-03-06">Version 1.5.1 (2013-03-06)<a name="Version-1-5-1-2013-03-06" href="#Version-1-5-1-2013-03-06" class="md2man-permalink"></a></h2><p>Patch:</p>
|
114
123
|
<ul>
|
115
124
|
<li><p>All this time, this project's documentation stated that Redcarpet's
|
116
125
|
<code>no_intra_emphasis</code> option was enabled, but in reality, it was not.
|
@@ -131,7 +140,7 @@ The documentation has been corrected and the option remains disabled.</p></li>
|
|
131
140
|
<li><p>rename HISTORY to VERSION so it sorts after README</p></li>
|
132
141
|
<li><p>tests should exercise engines with default options</p></li>
|
133
142
|
</ul>
|
134
|
-
<h2 id="Version-1-5-0-2013-02-24">Version 1.5.0 (2013-02-24)
|
143
|
+
<h2 id="Version-1-5-0-2013-02-24">Version 1.5.0 (2013-02-24)<a name="Version-1-5-0-2013-02-24" href="#Version-1-5-0-2013-02-24" class="md2man-permalink"></a></h2><p>Minor:</p>
|
135
144
|
<ul>
|
136
145
|
<li><p>The <code>md2man:web</code> task from <code>md2man/rakefile</code> now:</p>
|
137
146
|
<ul>
|
@@ -145,7 +154,7 @@ The documentation has been corrected and the option remains disabled.</p></li>
|
|
145
154
|
<li><p>README: better organize the subsections of "Usage"</p></li>
|
146
155
|
<li><p>include md2man rake tasks in developer's rakefile</p></li>
|
147
156
|
</ul>
|
148
|
-
<h2 id="Version-1-4-1-2013-02-23">Version 1.4.1 (2013-02-23)
|
157
|
+
<h2 id="Version-1-4-1-2013-02-23">Version 1.4.1 (2013-02-23)<a name="Version-1-4-1-2013-02-23" href="#Version-1-4-1-2013-02-23" class="md2man-permalink"></a></h2><p>Patch:</p>
|
149
158
|
<ul>
|
150
159
|
<li><p>rakefile: arbitrary directory structure under man/</p><p><a href="https://github.com/sunaku/md2man/pull/3#issuecomment-9429077">https://github.com/sunaku/md2man/pull/3#issuecomment-9429077</a></p><p>Thanks to Postmodern for raising this issue.</p></li>
|
151
160
|
<li><p>hook into 'build' task only if using Bundler tasks</p><p><a href="https://github.com/sunaku/md2man/pull/7#issuecomment-9467621">https://github.com/sunaku/md2man/pull/7#issuecomment-9467621</a></p><p>Thanks to Postmodern for raising this issue.</p></li>
|
@@ -156,7 +165,7 @@ The documentation has been corrected and the option remains disabled.</p></li>
|
|
156
165
|
<li><p>README: add <a class="md2man-xref" href="../man1/md2man-html.1.html">md2man-html(1)</a> and Md2Man::HTML usage</p></li>
|
157
166
|
<li><p>LICENSE: use GitHub profile URLs instead of e-mail</p></li>
|
158
167
|
</ul>
|
159
|
-
<h2 id="Version-1-4-0-2012-10-14">Version 1.4.0 (2012-10-14)
|
168
|
+
<h2 id="Version-1-4-0-2012-10-14">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"></a></h2><p>Minor:</p>
|
160
169
|
<ul>
|
161
170
|
<li><p>roff: emit non-first H1 headings as H2 headings</p></li>
|
162
171
|
<li><p>html: add <code>Md2Man::HTML::Engine</code> class for HTML manual page generation</p></li>
|
@@ -168,12 +177,12 @@ extension) inside your <code>man/man*/</code> directories. It also provides
|
|
168
177
|
sub-tasks to build <em>only</em> UNIX or HTML manual pages separately.</p><p>It also hooks into Bundler's gem packaging tasks to automatically build
|
169
178
|
your manual pages for packaging into a gem. See the README for details.</p></li>
|
170
179
|
</ul>
|
171
|
-
<h2 id="Version-1-3-2-2012-10-13">Version 1.3.2 (2012-10-13)
|
180
|
+
<h2 id="Version-1-3-2-2012-10-13">Version 1.3.2 (2012-10-13)<a name="Version-1-3-2-2012-10-13" href="#Version-1-3-2-2012-10-13" class="md2man-permalink"></a></h2><p>Patch:</p>
|
172
181
|
<ul>
|
173
182
|
<li><p>roff: escape backslashes inside codespan nodes too</p></li>
|
174
183
|
<li><p>roff: escape backslashes inside block_code nodes</p></li>
|
175
184
|
</ul>
|
176
|
-
<h2 id="Version-1-3-1-2012-10-09">Version 1.3.1 (2012-10-09)
|
185
|
+
<h2 id="Version-1-3-1-2012-10-09">Version 1.3.1 (2012-10-09)<a name="Version-1-3-1-2012-10-09" href="#Version-1-3-1-2012-10-09" class="md2man-permalink"></a></h2><p>Patch:</p>
|
177
186
|
<ul>
|
178
187
|
<li><p>roff: do not render references inside code blocks.</p></li>
|
179
188
|
<li><p>roff: do not render references inside code spans.</p></li>
|
@@ -190,13 +199,13 @@ the code block: it appears on the next line and appears ugly in <a class="md2man
|
|
190
199
|
<li><p>document: super() can't reach Redcarpet's renderer classes.
|
191
200
|
See <a href="https://github.com/vmg/redcarpet/issues/51">https://github.com/vmg/redcarpet/issues/51</a> for details.</p></li>
|
192
201
|
</ul>
|
193
|
-
<h2 id="Version-1-3-0-2012-09-27">Version 1.3.0 (2012-09-27)
|
202
|
+
<h2 id="Version-1-3-0-2012-09-27">Version 1.3.0 (2012-09-27)<a name="Version-1-3-0-2012-09-27" href="#Version-1-3-0-2012-09-27" class="md2man-permalink"></a></h2><p>Minor:</p>
|
194
203
|
<ul>
|
195
204
|
<li>Intra-word emphasis is now enabled <em>by default</em> in <code>Md2Man::ENGINE</code>.
|
196
205
|
To not be affected by this change, you may still construct your own
|
197
206
|
Redcarpet::Markdown engine with your own set of processing options.</li>
|
198
207
|
</ul>
|
199
|
-
<h2 id="Version-1-2-1-2012-07-05">Version 1.2.1 (2012-07-05)
|
208
|
+
<h2 id="Version-1-2-1-2012-07-05">Version 1.2.1 (2012-07-05)<a name="Version-1-2-1-2012-07-05" href="#Version-1-2-1-2012-07-05" class="md2man-permalink"></a></h2><p>Patch:</p>
|
200
209
|
<ul>
|
201
210
|
<li>GH-4: ruby 1.8.7 lacks negative lookbehind regexps.
|
202
211
|
Thanks to Postmodern for reporting this issue.</li>
|
@@ -207,7 +216,7 @@ Thanks to Postmodern for reporting this issue.</li>
|
|
207
216
|
See <a href="http://docs.rubygems.org/read/chapter/16">http://docs.rubygems.org/read/chapter/16</a>
|
208
217
|
Thanks to Postmodern for this contribution.</li>
|
209
218
|
</ul>
|
210
|
-
<h2 id="Version-1-2-0-2012-02-06">Version 1.2.0 (2012-02-06)
|
219
|
+
<h2 id="Version-1-2-0-2012-02-06">Version 1.2.0 (2012-02-06)<a name="Version-1-2-0-2012-02-06" href="#Version-1-2-0-2012-02-06" class="md2man-permalink"></a></h2><p>Minor:</p>
|
211
220
|
<ul>
|
212
221
|
<li>The <code>Md2Man::Document</code> module now handles paragraph() nodes and dispatches
|
213
222
|
their content accordingly to hook methods for indented, tagged, and normal
|
@@ -220,7 +229,7 @@ to markdown syntax programmatically.</li>
|
|
220
229
|
<li><p>README: mention features; revise markdown; cleanup.</p></li>
|
221
230
|
<li><p>LICENSE: @tanoku created initial Manpage renderer.</p></li>
|
222
231
|
</ul>
|
223
|
-
<h2 id="Version-1-1-0-2012-02-02">Version 1.1.0 (2012-02-02)
|
232
|
+
<h2 id="Version-1-1-0-2012-02-02">Version 1.1.0 (2012-02-02)<a name="Version-1-1-0-2012-02-02" href="#Version-1-1-0-2012-02-02" class="md2man-permalink"></a></h2><p>Minor:</p>
|
224
233
|
<ul>
|
225
234
|
<li>Add <code>Md2Man::Document</code> module for programmatic processing of
|
226
235
|
cross-references to other UNIX manual pages within Redcarpet.</li>
|
@@ -233,7 +242,7 @@ cross-references to other UNIX manual pages within Redcarpet.</li>
|
|
233
242
|
<li><p>README: fix installation commands for development.</p></li>
|
234
243
|
<li><p>README: simplify project slogan to be more memorable.</p></li>
|
235
244
|
</ul>
|
236
|
-
<h2 id="Version-1-0-2-2012-01-09">Version 1.0.2 (2012-01-09)
|
245
|
+
<h2 id="Version-1-0-2-2012-01-09">Version 1.0.2 (2012-01-09)<a name="Version-1-0-2-2012-01-09" href="#Version-1-0-2-2012-01-09" class="md2man-permalink"></a></h2><p>Patch:</p>
|
237
246
|
<ul>
|
238
247
|
<li><p>Blockquote's leading paragraph regexp was not anchored.</p></li>
|
239
248
|
<li><p>Freezing internal constants prevents monkey patching.</p></li>
|
@@ -244,7 +253,7 @@ cross-references to other UNIX manual pages within Redcarpet.</li>
|
|
244
253
|
<li><p>Added example input file from the Linux Man Page Howto.</p></li>
|
245
254
|
<li><p>Forgot to change project slogan in the gem package.</p></li>
|
246
255
|
</ul>
|
247
|
-
<h2 id="Version-1-0-1-2011-12-06">Version 1.0.1 (2011-12-06)
|
256
|
+
<h2 id="Version-1-0-1-2011-12-06">Version 1.0.1 (2011-12-06)<a name="Version-1-0-1-2011-12-06" href="#Version-1-0-1-2011-12-06" class="md2man-permalink"></a></h2><p>Major:</p>
|
248
257
|
<ul>
|
249
258
|
<li><p>Renamed the project from "redcarpet-manpage" to "md2man".</p>
|
250
259
|
<ul>
|
@@ -266,5 +275,5 @@ bold styling. All that matters is that the subsequent lines are indented.</p></
|
|
266
275
|
<ul>
|
267
276
|
<li>Rewrote entire Markdown to Roff conversion from scratch while doing TDD.</li>
|
268
277
|
</ul>
|
269
|
-
<h2 id="Version-0-0-1-2011-10-13">Version 0.0.1 (2011-10-13)
|
278
|
+
<h2 id="Version-0-0-1-2011-10-13">Version 0.0.1 (2011-10-13)<a name="Version-0-0-1-2011-10-13" href="#Version-0-0-1-2011-10-13" class="md2man-permalink"></a></h2><p>First release! Happy birthday! Woohoo! :-)</p></div></body>
|
270
279
|
</html>
|
data/man/man0/VERSION.markdown
CHANGED
@@ -1,3 +1,15 @@
|
|
1
|
+
## Version 2.1.0 (2014-05-04)
|
2
|
+
|
3
|
+
### Minor:
|
4
|
+
|
5
|
+
* md2man-html(1): add anchors & permalinks to headings.
|
6
|
+
|
7
|
+
* GH-15: wrap `.TH` components in stylable HTML spans.
|
8
|
+
|
9
|
+
### Other:
|
10
|
+
|
11
|
+
* GH-15: paraphrase man-pages(7) description of `.TH`.
|
12
|
+
|
1
13
|
## Version 2.0.4 (2014-04-26)
|
2
14
|
|
3
15
|
### Patch:
|
data/man/man1/md2man-html.1
CHANGED
@@ -1,4 +1,4 @@
|
|
1
|
-
.TH MD2MAN\-HTML 1 2014\-04
|
1
|
+
.TH MD2MAN\-HTML 1 2014\-05\-04 2.1.0
|
2
2
|
.SH NAME
|
3
3
|
.PP
|
4
4
|
md2man\-html \- convert
|
@@ -18,6 +18,24 @@ flavored
|
|
18
18
|
input from the given
|
19
19
|
\fIFILE\fP into HTML and then prints the result to the standard output stream.
|
20
20
|
If \fIFILE\fP is not given, then the standard input stream is read in its place.
|
21
|
+
.SS Top\-level headings
|
22
|
+
.PP
|
23
|
+
Each component of the \fB\fC\&.TH\fR directive in
|
24
|
+
.BR roff (7),
|
25
|
+
described under "Top\-level
|
26
|
+
headings" in
|
27
|
+
.BR md2man (5),
|
28
|
+
is wrapped in stylable \fB\fC<span>\fR elements as follows:
|
29
|
+
.PP
|
30
|
+
.RS
|
31
|
+
.nf
|
32
|
+
<span class="md2man\-title">...</span>
|
33
|
+
<span class="md2man\-section">...</span>
|
34
|
+
<span class="md2man\-date">...</span>
|
35
|
+
<span class="md2man\-source">...</span>
|
36
|
+
<span class="md2man\-manual">...</span>
|
37
|
+
.fi
|
38
|
+
.RE
|
21
39
|
.SS Cross references
|
22
40
|
.PP
|
23
41
|
Cross references to manual pages are emitted as HTML hyperlinks that have
|
data/man/man1/md2man-html.1.html
CHANGED
@@ -2,17 +2,25 @@
|
|
2
2
|
<html>
|
3
3
|
<head>
|
4
4
|
<meta charset="utf-8" />
|
5
|
-
<meta name="generator" content="md2man 2.0
|
5
|
+
<meta name="generator" content="md2man 2.1.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-2014-04-
|
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-2014-05-04-2-1-0"><span class="md2man-title">MD2MAN-HTML</span> <span class="md2man-section">1</span> <span class="md2man-date">2014-05-04</span> <span class="md2man-source">2.1.0</span><a name="MD2MAN-HTML-1-2014-05-04-2-1-0" href="#MD2MAN-HTML-1-2014-05-04-2-1-0" class="md2man-permalink"></a></h1><h2 id="NAME">NAME<a name="NAME" href="#NAME" class="md2man-permalink"></a></h2><p>md2man-html - convert <a class="md2man-xref" href="../man5/md2man.5.html">md2man(5)</a> flavored <a class="md2man-xref">markdown(7)</a> into HTML</p><h2 id="SYNOPSIS">SYNOPSIS<a name="SYNOPSIS" href="#SYNOPSIS" class="md2man-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"></a></h2><p>This program converts <a class="md2man-xref" href="../man5/md2man.5.html">md2man(5)</a> flavored <a class="md2man-xref">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="
|
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"></a></h3><p>Each component of the <code>.TH</code> directive in <a class="md2man-xref">roff(7)</a>, described under "Top-level
|
13
|
+
headings" in <a class="md2man-xref" href="../man5/md2man.5.html">md2man(5)</a>, is wrapped in stylable <code><span></code> elements as follows:</p>
|
14
|
+
<pre><code><span class="md2man-title">...</span>
|
15
|
+
<span class="md2man-section">...</span>
|
16
|
+
<span class="md2man-date">...</span>
|
17
|
+
<span class="md2man-source">...</span>
|
18
|
+
<span class="md2man-manual">...</span>
|
19
|
+
</code></pre>
|
20
|
+
<h3 id="Cross-references">Cross references<a name="Cross-references" href="#Cross-references" class="md2man-permalink"></a></h3><p>Cross references to manual pages are emitted as HTML hyperlinks that have
|
13
21
|
<code>class="md2man-xref"</code> and <code>href="../man$SECTION/$PAGE.$SECTION.html"</code>
|
14
22
|
attributes.</p><p>For example, the <code><a class="md2man-xref">printf(3)</a></code> cross reference would be emitted as this HTML:</p>
|
15
23
|
<pre><code><a class="md2man-xref" href="../man3/printf.3.html"><a class="md2man-xref">printf(3)</a></a>
|
16
24
|
</code></pre>
|
17
|
-
<h2 id="OPTIONS">OPTIONS
|
25
|
+
<h2 id="OPTIONS">OPTIONS<a name="OPTIONS" href="#OPTIONS" class="md2man-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"></a></h2><p><a class="md2man-xref" href="../man1/md2man-roff.1.html">md2man-roff(1)</a>, <a class="md2man-xref" href="../man1/md2man-rake.1.html">md2man-rake(1)</a>, <a class="md2man-xref" href="../man5/md2man.5.html">md2man(5)</a></p></div></body>
|
18
26
|
</html>
|
data/man/man1/md2man-rake.1
CHANGED
data/man/man1/md2man-rake.1.html
CHANGED
@@ -2,16 +2,16 @@
|
|
2
2
|
<html>
|
3
3
|
<head>
|
4
4
|
<meta charset="utf-8" />
|
5
|
-
<meta name="generator" content="md2man 2.0
|
5
|
+
<meta name="generator" content="md2man 2.1.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-2014-04-
|
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-2014-05-04-2-1-0"><span class="md2man-title">MD2MAN-RAKE</span> <span class="md2man-section">1</span> <span class="md2man-date">2014-05-04</span> <span class="md2man-source">2.1.0</span><a name="MD2MAN-RAKE-1-2014-05-04-2-1-0" href="#MD2MAN-RAKE-1-2014-05-04-2-1-0" class="md2man-permalink"></a></h1><h2 id="NAME">NAME<a name="NAME" href="#NAME" class="md2man-permalink"></a></h2><p>md2man-rake - run <a class="md2man-xref">rake(1)</a> tasks from <a class="md2man-xref">md2man(1)</a></p><h2 id="SYNOPSIS">SYNOPSIS<a name="SYNOPSIS" href="#SYNOPSIS" class="md2man-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"></a></h2><p>This program lets you run <a class="md2man-xref">rake(1)</a> tasks provided by <a class="md2man-xref">md2man(1)</a> without having
|
11
11
|
to create a special file named <code>Rakefile</code> that contains the following snippet:</p>
|
12
12
|
<pre><code>require 'md2man/rakefile'
|
13
13
|
</code></pre>
|
14
|
-
<p>If no <em>TASK</em> is specified, then the <code>md2man</code> task is run by default.</p><h2 id="TASKS">TASKS
|
14
|
+
<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"></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
|
15
15
|
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
|
16
|
-
found in or beneath the <code>man/</code> subdirectory in your working directory.</dd></dl><h2 id="OPTIONS">OPTIONS
|
16
|
+
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"></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"></a></h2><p><a class="md2man-xref">rake(1)</a>, <a class="md2man-xref" href="../man1/md2man-roff.1.html">md2man-roff(1)</a>, <a class="md2man-xref" href="../man1/md2man-html.1.html">md2man-html(1)</a>, <a class="md2man-xref" href="../man5/md2man.5.html">md2man(5)</a></p></div></body>
|
17
17
|
</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 2.0
|
5
|
+
<meta name="generator" content="md2man 2.1.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-2014-04-
|
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-2014-05-04-2-1-0"><span class="md2man-title">MD2MAN-ROFF</span> <span class="md2man-section">1</span> <span class="md2man-date">2014-05-04</span> <span class="md2man-source">2.1.0</span><a name="MD2MAN-ROFF-1-2014-05-04-2-1-0" href="#MD2MAN-ROFF-1-2014-05-04-2-1-0" class="md2man-permalink"></a></h1><h2 id="NAME">NAME<a name="NAME" href="#NAME" class="md2man-permalink"></a></h2><p>md2man-roff - convert <a class="md2man-xref" href="../man5/md2man.5.html">md2man(5)</a> flavored <a class="md2man-xref">markdown(7)</a> into <a class="md2man-xref">roff(7)</a></p><h2 id="SYNOPSIS">SYNOPSIS<a name="SYNOPSIS" href="#SYNOPSIS" class="md2man-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"></a></h2><p>This program converts <a class="md2man-xref" href="../man5/md2man.5.html">md2man(5)</a> flavored <a class="md2man-xref">markdown(7)</a> input from the given
|
11
11
|
<em>FILE</em> into <a class="md2man-xref">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">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"></a></h3><p>This program does not convert the following <a href="https://github.com/vmg/redcarpet">Redcarpet</a> nodes into <a class="md2man-xref">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">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"></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"></a></h2><p><a class="md2man-xref" href="../man1/md2man-html.1.html">md2man-html(1)</a>, <a class="md2man-xref" href="../man1/md2man-rake.1.html">md2man-rake(1)</a>, <a class="md2man-xref" href="../man5/md2man.5.html">md2man(5)</a></p></div></body>
|
21
21
|
</html>
|
data/man/man5/md2man.5
CHANGED
@@ -1,4 +1,4 @@
|
|
1
|
-
.TH MD2MAN 5 2014\-04
|
1
|
+
.TH MD2MAN 5 2014\-05\-04 2.1.0
|
2
2
|
.SH NAME
|
3
3
|
.PP
|
4
4
|
md2man \- manual page flavoring for the
|
@@ -84,11 +84,36 @@ md2man extends
|
|
84
84
|
semantics by treating top\-level headings specially.
|
85
85
|
.SS Top\-level headings
|
86
86
|
.PP
|
87
|
-
The first top\-level heading
|
87
|
+
The first top\-level \fB\fC<h1>\fR heading found in the input is considered to be the
|
88
88
|
\fB\fC\&.TH\fR directive in
|
89
89
|
.BR roff (7),
|
90
|
-
|
91
|
-
|
90
|
+
as described under "Title line" in
|
91
|
+
.BR man-pages (7):
|
92
|
+
.PP
|
93
|
+
.RS
|
94
|
+
.RS
|
95
|
+
.nf
|
96
|
+
\&.TH title section date source manual
|
97
|
+
.fi
|
98
|
+
.RE
|
99
|
+
.TP
|
100
|
+
title
|
101
|
+
The title of the man page, written in all caps (e.g., \fB\fCMAN\-PAGES\fR).
|
102
|
+
.TP
|
103
|
+
section
|
104
|
+
The section number in which the man page should be placed (e.g., \fB\fC7\fR).
|
105
|
+
.TP
|
106
|
+
date
|
107
|
+
The date of the last revision, written in the form YYYY\-MM\-DD.
|
108
|
+
.TP
|
109
|
+
source
|
110
|
+
The source of the command, function, or system call (e.g., \fB\fCLinux\fR).
|
111
|
+
.TP
|
112
|
+
manual
|
113
|
+
The title of the manual (e.g., \fB\fCLinux Programmer's Manual\fR).
|
114
|
+
.RE
|
115
|
+
.PP
|
116
|
+
Any subsequent top\-level headings are treated as second\-level \fB\fC<h2>\fR headings.
|
92
117
|
.SS Extensions
|
93
118
|
.PP
|
94
119
|
md2man enables the following Redcarpet
|
@@ -111,6 +136,7 @@ fenced_code_blocks
|
|
111
136
|
.SH SEE ALSO
|
112
137
|
.PP
|
113
138
|
.BR markdown (7),
|
139
|
+
.BR man-pages (7),
|
114
140
|
.BR md2man-roff (1),
|
115
141
|
.BR md2man-html (1),
|
116
142
|
.BR md2man-rake (1)
|
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 2.0
|
5
|
+
<meta name="generator" content="md2man 2.1.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-2014-04-
|
11
|
-
pages by extending its syntax, semantics, and assumed processing extensions.</p><h3 id="Syntax">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-2014-05-04-2-1-0"><span class="md2man-title">MD2MAN</span> <span class="md2man-section">5</span> <span class="md2man-date">2014-05-04</span> <span class="md2man-source">2.1.0</span><a name="MD2MAN-5-2014-05-04-2-1-0" href="#MD2MAN-5-2014-05-04-2-1-0" class="md2man-permalink"></a></h1><h2 id="NAME">NAME<a name="NAME" href="#NAME" class="md2man-permalink"></a></h2><p>md2man - manual page flavoring for the <a class="md2man-xref">markdown(7)</a> file format</p><h2 id="DESCRIPTION">DESCRIPTION<a name="DESCRIPTION" href="#DESCRIPTION" class="md2man-permalink"></a></h2><p><a href="https://github.com/sunaku/md2man">md2man</a> makes the <a class="md2man-xref">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"></a></h3><p>md2man extends <a class="md2man-xref">markdown(7)</a> syntax by defining three kinds of paragraphs.</p>
|
12
12
|
<pre><code>This is a
|
13
13
|
normal
|
14
14
|
paragraph.
|
@@ -26,7 +26,7 @@ This
|
|
26
26
|
normal
|
27
27
|
paragraph.
|
28
28
|
</code></pre>
|
29
|
-
<h4 id="Normal-paragraphs">Normal paragraphs
|
29
|
+
<h4 id="Normal-paragraphs">Normal paragraphs<a name="Normal-paragraphs" href="#Normal-paragraphs" class="md2man-permalink"></a></h4><p>Paragraphs whose lines are all indented by exactly zero or one additional
|
30
30
|
spaces are considered to be "normal paragraphs". For example:</p>
|
31
31
|
<pre><code>This is a
|
32
32
|
normal
|
@@ -37,22 +37,26 @@ This
|
|
37
37
|
normal
|
38
38
|
paragraph.
|
39
39
|
</code></pre>
|
40
|
-
<h4 id="Tagged-paragraphs">Tagged paragraphs
|
40
|
+
<h4 id="Tagged-paragraphs">Tagged paragraphs<a name="Tagged-paragraphs" href="#Tagged-paragraphs" class="md2man-permalink"></a></h4><p>Paragraphs whose first line is indented by less than two additional spaces and
|
41
41
|
whose subsequent lines are uniformly indented by exactly two additional spaces
|
42
42
|
are considered to be "tagged paragraphs". For example:</p>
|
43
43
|
<pre><code>This is a
|
44
44
|
tagged
|
45
45
|
paragraph.
|
46
46
|
</code></pre>
|
47
|
-
<h4 id="Indented-paragraphs">Indented paragraphs
|
47
|
+
<h4 id="Indented-paragraphs">Indented paragraphs<a name="Indented-paragraphs" href="#Indented-paragraphs" class="md2man-permalink"></a></h4><p>Paragraphs whose lines are all uniformly indented by exactly two additional
|
48
48
|
spaces are considered to be "indented paragraphs". For example:</p>
|
49
49
|
<pre><code> This is an
|
50
50
|
indented
|
51
51
|
paragraph.
|
52
52
|
</code></pre>
|
53
|
-
<h3 id="Semantics">Semantics
|
54
|
-
<code>.TH</code> directive in <a class="md2man-xref">roff(7)</a>,
|
55
|
-
|
53
|
+
<h3 id="Semantics">Semantics<a name="Semantics" href="#Semantics" class="md2man-permalink"></a></h3><p>md2man extends <a class="md2man-xref">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"></a></h4><p>The first top-level <code><h1></code> heading found in the input is considered to be the
|
54
|
+
<code>.TH</code> directive in <a class="md2man-xref">roff(7)</a>, as described under "Title line" in <a class="md2man-xref">man-pages(7)</a>:</p>
|
55
|
+
<blockquote>
|
56
|
+
<pre><code>.TH title section date source manual
|
57
|
+
</code></pre>
|
58
|
+
<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>
|
59
|
+
<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"></a></h3><p>md2man enables the following <a href="https://github.com/vmg/redcarpet">Redcarpet</a> extensions while reading <a class="md2man-xref">markdown(7)</a>:</p>
|
56
60
|
<ul>
|
57
61
|
<li>tables</li>
|
58
62
|
<li>autolink</li>
|
@@ -60,5 +64,5 @@ footer. Any subsequent top-level headings are treated as second-level (H2).</p>
|
|
60
64
|
<li>strikethrough</li>
|
61
65
|
<li>fenced_code_blocks</li>
|
62
66
|
</ul>
|
63
|
-
<h2 id="SEE-ALSO">SEE ALSO
|
67
|
+
<h2 id="SEE-ALSO">SEE ALSO<a name="SEE-ALSO" href="#SEE-ALSO" class="md2man-permalink"></a></h2><p><a class="md2man-xref">markdown(7)</a>, <a class="md2man-xref">man-pages(7)</a>, <a class="md2man-xref" href="../man1/md2man-roff.1.html">md2man-roff(1)</a>, <a class="md2man-xref" href="../man1/md2man-html.1.html">md2man-html(1)</a>, <a class="md2man-xref" href="../man1/md2man-rake.1.html">md2man-rake(1)</a></p></div></body>
|
64
68
|
</html>
|
data/man/man5/md2man.5.markdown
CHANGED
@@ -1,4 +1,4 @@
|
|
1
|
-
# MD2MAN 5 2014-04
|
1
|
+
# MD2MAN 5 2014-05-04 2.1.0
|
2
2
|
|
3
3
|
## NAME
|
4
4
|
|
@@ -69,9 +69,27 @@ md2man extends markdown(7) semantics by treating top-level headings specially.
|
|
69
69
|
|
70
70
|
#### Top-level headings
|
71
71
|
|
72
|
-
The first top-level heading
|
73
|
-
`.TH` directive in roff(7),
|
74
|
-
|
72
|
+
The first top-level `<h1>` heading found in the input is considered to be the
|
73
|
+
`.TH` directive in roff(7), as described under "Title line" in man-pages(7):
|
74
|
+
|
75
|
+
> .TH title section date source manual
|
76
|
+
>
|
77
|
+
> title
|
78
|
+
> The title of the man page, written in all caps (e.g., `MAN-PAGES`).
|
79
|
+
>
|
80
|
+
> section
|
81
|
+
> The section number in which the man page should be placed (e.g., `7`).
|
82
|
+
>
|
83
|
+
> date
|
84
|
+
> The date of the last revision, written in the form YYYY-MM-DD.
|
85
|
+
>
|
86
|
+
> source
|
87
|
+
> The source of the command, function, or system call (e.g., `Linux`).
|
88
|
+
>
|
89
|
+
> manual
|
90
|
+
> The title of the manual (e.g., `Linux Programmer's Manual`).
|
91
|
+
|
92
|
+
Any subsequent top-level headings are treated as second-level `<h2>` headings.
|
75
93
|
|
76
94
|
### Extensions
|
77
95
|
|
@@ -85,7 +103,7 @@ md2man enables the following [Redcarpet] extensions while reading markdown(7):
|
|
85
103
|
|
86
104
|
## SEE ALSO
|
87
105
|
|
88
|
-
markdown(7), md2man-roff(1), md2man-html(1), md2man-rake(1)
|
106
|
+
markdown(7), man-pages(7), md2man-roff(1), md2man-html(1), md2man-rake(1)
|
89
107
|
|
90
108
|
[md2man]: https://github.com/sunaku/md2man
|
91
109
|
[Redcarpet]: https://github.com/vmg/redcarpet
|
data/man/style.css
CHANGED
@@ -31,6 +31,20 @@
|
|
31
31
|
font-size: smaller;
|
32
32
|
text-align: right;
|
33
33
|
}
|
34
|
+
|
35
|
+
h1:first-child > a.md2man-permalink {
|
36
|
+
display: none;
|
37
|
+
}
|
38
|
+
|
39
|
+
a.md2man-permalink:after {
|
40
|
+
padding-left: 0.25em;
|
41
|
+
content: '\2665'; /* ♥ */
|
42
|
+
opacity: 0.125;
|
43
|
+
}
|
44
|
+
|
45
|
+
a.md2man-permalink:hover:after {
|
46
|
+
opacity: initial;
|
47
|
+
}
|
34
48
|
}
|
35
49
|
|
36
50
|
@media print {
|
data/test/md2man/html_test.rb
CHANGED
@@ -141,11 +141,11 @@ describe 'html engine' do
|
|
141
141
|
|#### qux (MOZ)
|
142
142
|
|##### {m}oz END
|
143
143
|
INPUT
|
144
|
-
<h1 id="foo-BAR">foo <em>BAR</em></h1>\
|
145
|
-
<h2 id="bar-BAZ">bar BAZ
|
146
|
-
<h3 id="BAZ-QUX">--BAZ-QUX
|
147
|
-
<h4 id="qux-MOZ">qux (MOZ)
|
148
|
-
<h5 id="m-oz-END">{m}oz END
|
144
|
+
<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"></a></h1>\
|
145
|
+
<h2 id="bar-BAZ">bar BAZ<a name="bar-BAZ" href="#bar-BAZ" class="md2man-permalink"></a></h2>\
|
146
|
+
<h3 id="BAZ-QUX">--BAZ-QUX--<a name="BAZ-QUX" href="#BAZ-QUX" class="md2man-permalink"></a></h3>\
|
147
|
+
<h4 id="qux-MOZ">qux (MOZ)<a name="qux-MOZ" href="#qux-MOZ" class="md2man-permalink"></a></h4>\
|
148
|
+
<h5 id="m-oz-END">{m}oz END<a name="m-oz-END" href="#m-oz-END" class="md2man-permalink"></a></h5>
|
149
149
|
OUTPUT
|
150
150
|
end
|
151
151
|
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: 2.0
|
4
|
+
version: 2.1.0
|
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: 2014-04
|
11
|
+
date: 2014-05-04 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: binman
|