md2man 2.1.1 → 3.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/VERSION.markdown +19 -0
- data/bin/md2man-html +25 -3
- data/bin/md2man-rake +1 -1
- data/bin/md2man-roff +1 -1
- data/lib/md2man/html.rb +10 -5
- data/lib/md2man/rakefile/style.css +11 -6
- data/lib/md2man/rakefile.rb +1 -1
- data/lib/md2man/version.rb +1 -1
- data/man/index.html +1 -1
- data/man/man0/README.html +21 -21
- data/man/man0/VERSION.html +51 -41
- data/man/man0/VERSION.markdown +19 -0
- data/man/man1/md2man-html.1 +30 -3
- data/man/man1/md2man-html.1.html +25 -9
- 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 +5 -5
- data/man/man5/md2man.5 +1 -1
- data/man/man5/md2man.5.html +10 -10
- data/man/man5/md2man.5.markdown +1 -1
- data/man/style.css +11 -6
- data/test/md2man/html_test.rb +21 -13
- data/test/md2man/roff_test.rb +2 -2
- 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: ba2cb14fc6bc77e87921faf1be24560578383756
|
|
4
|
+
data.tar.gz: 61717778f8a1c0566b89e0a5d8cc773b67ad72c7
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 8dbcb51cc2c8c4db1bca6e71e38bfbd1cdd1c57cd2cae6c2cd68706b36381c39758ae2f6e5b272512c91853f1239fa992e956843304be0cf31db93dcb4ba52a2
|
|
7
|
+
data.tar.gz: 1654542cc6239ba4662a8ce8a83192860265e6d3f4e2af854bacd0e02404b6eef336b68691cd8ba5fd28bb405aa7e3540127fc0959af75faad5f2a71b3bab9d0
|
data/VERSION.markdown
CHANGED
|
@@ -1,3 +1,22 @@
|
|
|
1
|
+
## Version 3.0.0 (2014-06-22)
|
|
2
|
+
|
|
3
|
+
This release changes md2man-html(1) heading permalinks to follow GitHub style:
|
|
4
|
+
unique, lowercase, and squeezed and stripped of HTML tags and non-word chars.
|
|
5
|
+
In addition, it renames the `md2man-xref` CSS class to `md2man-reference`.
|
|
6
|
+
|
|
7
|
+
Please make sure to update any existing bookmarks and/or hyperlinks you may
|
|
8
|
+
have for jumping to specific locations in your HTML manuals after upgrading.
|
|
9
|
+
|
|
10
|
+
### Major:
|
|
11
|
+
|
|
12
|
+
* Make permalink anchors on headings fully lowercase in md2man-html(1).
|
|
13
|
+
|
|
14
|
+
* Put permalinks on left & indicate target permalink in md2man-html(1).
|
|
15
|
+
|
|
16
|
+
* Make permalink anchors unique by appending a count in md2man-html(1).
|
|
17
|
+
|
|
18
|
+
* Rename `md2man-xref` CSS class to `md2man-reference` in md2man-html(1).
|
|
19
|
+
|
|
1
20
|
## Version 2.1.1 (2014-06-21)
|
|
2
21
|
|
|
3
22
|
### 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-06-
|
|
4
|
+
# MD2MAN-HTML 1 2014-06-22 3.0.0
|
|
5
5
|
|
|
6
6
|
## NAME
|
|
7
7
|
|
|
@@ -28,15 +28,37 @@ headings" in md2man(5), is wrapped in stylable `<span>` elements as follows:
|
|
|
28
28
|
<span class="md2man-source">...</span>
|
|
29
29
|
<span class="md2man-manual">...</span>
|
|
30
30
|
|
|
31
|
+
### Heading permalinks
|
|
32
|
+
|
|
33
|
+
Self-referencing hyperlinks (for permanent linking) are added to headings by
|
|
34
|
+
converting their labels into URI fragments that are unique (using a counter),
|
|
35
|
+
lowercase, and squeezed and stripped of HTML tags and non-word characters.
|
|
36
|
+
|
|
37
|
+
For example, a heading labeled `Ver<s>iON 3(2</s>!4)))` would be emitted as:
|
|
38
|
+
|
|
39
|
+
<h2 id="ver-ion-3-2-4"><a name="ver-ion-3-2-4" href="#ver-ion-3-2-4"
|
|
40
|
+
class="md2man-permalink" title="permalink"></a>Ver<s>iON 3(2</s>!4)))</h2>
|
|
41
|
+
|
|
42
|
+
For example, multiple headings labeled `Hello, world!` would be emitted as:
|
|
43
|
+
|
|
44
|
+
<h2 id="hello-world"><a name="hello-world" href="#hello-world"
|
|
45
|
+
class="md2man-permalink" title="permalink"></a>Hello, world!</h2>
|
|
46
|
+
|
|
47
|
+
<h2 id="hello-world-1"><a name="hello-world-1" href="#hello-world-1"
|
|
48
|
+
class="md2man-permalink" title="permalink"></a>Hello, world!</h2>
|
|
49
|
+
|
|
50
|
+
<h2 id="hello-world-2"><a name="hello-world-2" href="#hello-world-2"
|
|
51
|
+
class="md2man-permalink" title="permalink"></a>Hello, world!</h2>
|
|
52
|
+
|
|
31
53
|
### Cross references
|
|
32
54
|
|
|
33
55
|
Cross references to manual pages are emitted as HTML hyperlinks that have
|
|
34
|
-
`class="md2man-
|
|
56
|
+
`class="md2man-reference"` and `href="../man$SECTION/$PAGE.$SECTION.html"`
|
|
35
57
|
attributes.
|
|
36
58
|
|
|
37
59
|
For example, the `printf(3)` cross reference would be emitted as this HTML:
|
|
38
60
|
|
|
39
|
-
<a class="md2man-
|
|
61
|
+
<a class="md2man-reference" href="../man3/printf.3.html">printf(3)</a>
|
|
40
62
|
|
|
41
63
|
## OPTIONS
|
|
42
64
|
|
data/bin/md2man-rake
CHANGED
data/bin/md2man-roff
CHANGED
data/lib/md2man/html.rb
CHANGED
|
@@ -12,6 +12,7 @@ module Md2Man::HTML
|
|
|
12
12
|
|
|
13
13
|
def preprocess document
|
|
14
14
|
@h1_seen = false
|
|
15
|
+
@seen_count_by_id = Hash.new {|h,k| h[k] = 0 }
|
|
15
16
|
super
|
|
16
17
|
end
|
|
17
18
|
|
|
@@ -43,13 +44,17 @@ module Md2Man::HTML
|
|
|
43
44
|
end.compact.join(' ')
|
|
44
45
|
end
|
|
45
46
|
|
|
46
|
-
|
|
47
|
-
|
|
47
|
+
# strip all HTML tags, squeeze all non-word characters, and lowercase it
|
|
48
|
+
id = text.gsub(/<.+?>/, '-').gsub(/\W+/, '-').gsub(/^-|-$/, '').downcase
|
|
49
|
+
|
|
50
|
+
# make duplicate anchors unique by appending numerical suffixes to them
|
|
51
|
+
count = @seen_count_by_id[id] += 1
|
|
52
|
+
id += "-#{count - 1}" if count > 1
|
|
53
|
+
|
|
48
54
|
[
|
|
49
55
|
%{<h#{level} id="#{id}">},
|
|
56
|
+
%{<a name="#{id}" href="##{id}" class="md2man-permalink" title="permalink"></a>},
|
|
50
57
|
text,
|
|
51
|
-
%{<a name="#{id}" href="##{id}" class="md2man-permalink">},
|
|
52
|
-
'</a>',
|
|
53
58
|
"</h#{level}>",
|
|
54
59
|
].join
|
|
55
60
|
end
|
|
@@ -63,7 +68,7 @@ module Md2Man::HTML
|
|
|
63
68
|
input_match.to_s
|
|
64
69
|
else
|
|
65
70
|
url = reference_url(input_match[:page], input_match[:section])
|
|
66
|
-
%{<a class="md2man-
|
|
71
|
+
%{<a class="md2man-reference" href="#{url}">#{input_match}</a>}
|
|
67
72
|
end + output_match[:addendum].to_s
|
|
68
73
|
end
|
|
69
74
|
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
}
|
|
12
12
|
|
|
13
13
|
/* deactivate external manual page cross-references */
|
|
14
|
-
a.md2man-
|
|
14
|
+
a.md2man-reference:not([href]) {
|
|
15
15
|
color: inherit;
|
|
16
16
|
text-decoration: none;
|
|
17
17
|
}
|
|
@@ -36,14 +36,19 @@
|
|
|
36
36
|
display: none;
|
|
37
37
|
}
|
|
38
38
|
|
|
39
|
-
a.md2man-permalink
|
|
40
|
-
|
|
39
|
+
a.md2man-permalink {
|
|
40
|
+
float: left;
|
|
41
|
+
margin-left: -1em;
|
|
42
|
+
opacity: 0.25;
|
|
43
|
+
}
|
|
44
|
+
|
|
45
|
+
a.md2man-permalink:before {
|
|
41
46
|
content: '\2665'; /* ♥ */
|
|
42
|
-
opacity: 0.125;
|
|
43
47
|
}
|
|
44
48
|
|
|
45
|
-
a.md2man-permalink:hover
|
|
46
|
-
|
|
49
|
+
a.md2man-permalink:hover,
|
|
50
|
+
*:target > a.md2man-permalink {
|
|
51
|
+
opacity: initial
|
|
47
52
|
}
|
|
48
53
|
}
|
|
49
54
|
|
data/lib/md2man/rakefile.rb
CHANGED
|
@@ -97,7 +97,7 @@ mkds.zip(webs).each do |src, dst|
|
|
|
97
97
|
require 'md2man/html/engine'
|
|
98
98
|
output = Md2Man::HTML::ENGINE.render(input).
|
|
99
99
|
# deactivate external manual page cross-references
|
|
100
|
-
gsub(/(?<=<a class="md2man-
|
|
100
|
+
gsub(/(?<=<a class="md2man-reference") href="\.\.(.+?)"/) do
|
|
101
101
|
$& if webs.include? 'man' + $1
|
|
102
102
|
end
|
|
103
103
|
|
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
|
|
5
|
+
<meta name="generator" content="md2man 3.0.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,12 +2,12 @@
|
|
|
2
2
|
<html>
|
|
3
3
|
<head>
|
|
4
4
|
<meta charset="utf-8" />
|
|
5
|
-
<meta name="generator" content="md2man
|
|
5
|
+
<meta name="generator" content="md2man 3.0.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"><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
|
|
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"><a name="md2man-markdown-to-manpage" href="#md2man-markdown-to-manpage" class="md2man-permalink" title="permalink"></a><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></h1><p>md2man is a Ruby library and a set of command-line programs that convert
|
|
11
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>
|
|
12
12
|
<ul>
|
|
13
13
|
<li>Package: <a href="https://rubygems.org/gems/md2man">https://rubygems.org/gems/md2man</a></li>
|
|
@@ -15,14 +15,14 @@
|
|
|
15
15
|
<li>Sources: <a href="https://github.com/sunaku/md2man">https://github.com/sunaku/md2man</a></li>
|
|
16
16
|
<li>Support: <a href="https://github.com/sunaku/md2man/issues">https://github.com/sunaku/md2man/issues</a></li>
|
|
17
17
|
</ul>
|
|
18
|
-
<h2 id="
|
|
18
|
+
<h2 id="features"><a name="features" href="#features" class="md2man-permalink" title="permalink"></a>Features</h2>
|
|
19
19
|
<ul>
|
|
20
20
|
<li><p>Formats tagged and indented paragraphs (see "document format" below).</p></li>
|
|
21
21
|
<li><p>Translates all HTML4 and XHTML1 entities into native <a href="http://troff.org">roff</a> equivalents.</p></li>
|
|
22
22
|
<li><p>Supports markdown extensions such as <a href="http://michelf.com/projects/php-markdown/extra/#table">PHP Markdown Extra tables</a>.</p></li>
|
|
23
23
|
<li><p>Usable from the command line as a filter in a UNIX command pipeline.</p></li>
|
|
24
24
|
</ul>
|
|
25
|
-
<h3 id="
|
|
25
|
+
<h3 id="demonstration"><a name="demonstration" href="#demonstration" class="md2man-permalink" title="permalink"></a>Demonstration</h3><p>Try converting <a href="https://raw.github.com/sunaku/md2man/master/EXAMPLE.markdown">this example Markdown file</a> into a UNIX manual page:</p>
|
|
26
26
|
<pre><code>md2man-roff EXAMPLE.markdown > EXAMPLE.1
|
|
27
27
|
man -l EXAMPLE.1
|
|
28
28
|
</code></pre>
|
|
@@ -30,10 +30,10 @@ man -l EXAMPLE.1
|
|
|
30
30
|
<pre><code>md2man-html EXAMPLE.markdown > EXAMPLE.html
|
|
31
31
|
open EXAMPLE.html
|
|
32
32
|
</code></pre>
|
|
33
|
-
<h2 id="
|
|
33
|
+
<h2 id="installation"><a name="installation" href="#installation" class="md2man-permalink" title="permalink"></a>Installation</h2>
|
|
34
34
|
<pre><code>gem install md2man
|
|
35
35
|
</code></pre>
|
|
36
|
-
<h3 id="
|
|
36
|
+
<h3 id="development"><a name="development" href="#development" class="md2man-permalink" title="permalink"></a>Development</h3>
|
|
37
37
|
<pre><code>git clone git://github.com/sunaku/md2man
|
|
38
38
|
cd md2man
|
|
39
39
|
bundle install
|
|
@@ -41,19 +41,19 @@ bundle exec rake --tasks # packaging tasks
|
|
|
41
41
|
bundle exec md2man-roff --help # run it directly
|
|
42
42
|
bundle exec md2man-html --help # run it directly
|
|
43
43
|
</code></pre>
|
|
44
|
-
<h2 id="
|
|
44
|
+
<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" href="../man1/md2man-roff.1.html">md2man-roff(1)</a> manual:</p>
|
|
45
45
|
<pre><code>md2man-roff --help
|
|
46
46
|
</code></pre>
|
|
47
|
-
<h4 id="
|
|
47
|
+
<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>
|
|
48
48
|
<pre><code>require 'md2man/roff/engine'
|
|
49
49
|
|
|
50
|
-
your_roff_output = Md2Man::Roff::<a class="md2man-
|
|
50
|
+
your_roff_output = Md2Man::Roff::<a class="md2man-reference">ENGINE.render(your_markdown_input)</a>
|
|
51
51
|
</code></pre>
|
|
52
52
|
<p>Build your own renderer:</p>
|
|
53
53
|
<pre><code>require 'md2man/roff/engine'
|
|
54
54
|
|
|
55
55
|
engine = Redcarpet::Markdown.new(Md2Man::Roff::Engine, your_options_hash)
|
|
56
|
-
your_roff_output = <a class="md2man-
|
|
56
|
+
your_roff_output = <a class="md2man-reference">engine.render(your_markdown_input)</a>
|
|
57
57
|
</code></pre>
|
|
58
58
|
<p>Define your own renderer:</p>
|
|
59
59
|
<pre><code>require 'md2man/roff/engine'
|
|
@@ -63,7 +63,7 @@ class YourManpageRenderer < Md2Man::Roff::Engine
|
|
|
63
63
|
end
|
|
64
64
|
|
|
65
65
|
engine = Redcarpet::Markdown.new(YourManpageRenderer, your_options_hash)
|
|
66
|
-
your_roff_output = <a class="md2man-
|
|
66
|
+
your_roff_output = <a class="md2man-reference">engine.render(your_markdown_input)</a>
|
|
67
67
|
</code></pre>
|
|
68
68
|
<p>Mix-in your own renderer:</p>
|
|
69
69
|
<pre><code>require 'md2man/roff'
|
|
@@ -74,21 +74,21 @@ class YourManpageRenderer < Redcarpet::Render::Base
|
|
|
74
74
|
end
|
|
75
75
|
|
|
76
76
|
engine = Redcarpet::Markdown.new(YourManpageRenderer, your_options_hash)
|
|
77
|
-
your_roff_output = <a class="md2man-
|
|
77
|
+
your_roff_output = <a class="md2man-reference">engine.render(your_markdown_input)</a>
|
|
78
78
|
</code></pre>
|
|
79
|
-
<h3 id="
|
|
79
|
+
<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" href="../man1/md2man-html.1.html">md2man-html(1)</a> manual:</p>
|
|
80
80
|
<pre><code>md2man-html --help
|
|
81
81
|
</code></pre>
|
|
82
|
-
<h4 id="
|
|
82
|
+
<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>
|
|
83
83
|
<pre><code>require 'md2man/html/engine'
|
|
84
84
|
|
|
85
|
-
your_html_output = Md2Man::HTML::<a class="md2man-
|
|
85
|
+
your_html_output = Md2Man::HTML::<a class="md2man-reference">ENGINE.render(your_markdown_input)</a>
|
|
86
86
|
</code></pre>
|
|
87
87
|
<p>Build your own renderer:</p>
|
|
88
88
|
<pre><code>require 'md2man/html/engine'
|
|
89
89
|
|
|
90
90
|
engine = Redcarpet::Markdown.new(Md2Man::HTML::Engine, your_options_hash)
|
|
91
|
-
your_html_output = <a class="md2man-
|
|
91
|
+
your_html_output = <a class="md2man-reference">engine.render(your_markdown_input)</a>
|
|
92
92
|
</code></pre>
|
|
93
93
|
<p>Define your own renderer:</p>
|
|
94
94
|
<pre><code>require 'md2man/html/engine'
|
|
@@ -98,7 +98,7 @@ class YourManpageRenderer < Md2Man::HTML::Engine
|
|
|
98
98
|
end
|
|
99
99
|
|
|
100
100
|
engine = Redcarpet::Markdown.new(YourManpageRenderer, your_options_hash)
|
|
101
|
-
your_html_output = <a class="md2man-
|
|
101
|
+
your_html_output = <a class="md2man-reference">engine.render(your_markdown_input)</a>
|
|
102
102
|
</code></pre>
|
|
103
103
|
<p>Mix-in your own renderer:</p>
|
|
104
104
|
<pre><code>require 'md2man/html'
|
|
@@ -109,12 +109,12 @@ class YourManpageRenderer < Redcarpet::Render::Base
|
|
|
109
109
|
end
|
|
110
110
|
|
|
111
111
|
engine = Redcarpet::Markdown.new(YourManpageRenderer, your_options_hash)
|
|
112
|
-
your_html_output = <a class="md2man-
|
|
112
|
+
your_html_output = <a class="md2man-reference">engine.render(your_markdown_input)</a>
|
|
113
113
|
</code></pre>
|
|
114
|
-
<h3 id="
|
|
114
|
+
<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" href="../man1/md2man-rake.1.html">md2man-rake(1)</a> manual:</p>
|
|
115
115
|
<pre><code>md2man-rake --help
|
|
116
116
|
</code></pre>
|
|
117
|
-
<h4 id="
|
|
117
|
+
<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>
|
|
118
118
|
<pre><code>s.files += Dir['man/man?/*.?'] # UNIX man pages
|
|
119
119
|
s.files += Dir['man/**/*.{html,css,js}'] # HTML man pages
|
|
120
120
|
s.add_development_dependency 'md2man', '~> 2.0'
|
|
@@ -129,5 +129,5 @@ tasks and ensures that your manual pages are built for packaging into a gem:</p>
|
|
|
129
129
|
<pre><code>bundle exec rake build
|
|
130
130
|
gem spec pkg/*.gem | fgrep man/
|
|
131
131
|
</code></pre>
|
|
132
|
-
<h2 id="
|
|
132
|
+
<h2 id="license"><a name="license" href="#license" class="md2man-permalink" title="permalink"></a>License</h2><p>Released under the ISC license. See the LICENSE file for details.</p></div></body>
|
|
133
133
|
</html>
|
data/man/man0/VERSION.html
CHANGED
|
@@ -2,28 +2,38 @@
|
|
|
2
2
|
<html>
|
|
3
3
|
<head>
|
|
4
4
|
<meta charset="utf-8" />
|
|
5
|
-
<meta name="generator" content="md2man
|
|
5
|
+
<meta name="generator" content="md2man 3.0.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="
|
|
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-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" href="../man1/md2man-html.1.html">md2man-html(1)</a> heading permalinks to follow GitHub style:
|
|
11
|
+
unique, lowercase, and squeezed and stripped of HTML tags and non-word chars.
|
|
12
|
+
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
|
|
13
|
+
have for jumping to specific locations in your HTML manuals after upgrading.</p><h3 id="major"><a name="major" href="#major" class="md2man-permalink" title="permalink"></a>Major:</h3>
|
|
14
|
+
<ul>
|
|
15
|
+
<li><p>Make permalink anchors on headings fully lowercase in <a class="md2man-reference" href="../man1/md2man-html.1.html">md2man-html(1)</a>.</p></li>
|
|
16
|
+
<li><p>Put permalinks on left & indicate target permalink in <a class="md2man-reference" href="../man1/md2man-html.1.html">md2man-html(1)</a>.</p></li>
|
|
17
|
+
<li><p>Make permalink anchors unique by appending a count in <a class="md2man-reference" href="../man1/md2man-html.1.html">md2man-html(1)</a>.</p></li>
|
|
18
|
+
<li><p>Rename <code>md2man-xref</code> CSS class to <code>md2man-reference</code> in <a class="md2man-reference" href="../man1/md2man-html.1.html">md2man-html(1)</a>.</p></li>
|
|
19
|
+
</ul>
|
|
20
|
+
<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"><a name="patch" href="#patch" class="md2man-permalink" title="permalink"></a>Patch:</h3>
|
|
11
21
|
<ul>
|
|
12
22
|
<li><p>Bootstrap CSS failed to load for HTML manuals served under HTTPS.
|
|
13
23
|
See <a href="https://github.com/sunaku/readably/pull/3">https://github.com/sunaku/readably/pull/3</a> for the details.</p></li>
|
|
14
24
|
<li><p>Drop redundant nil check in <code>Md2Man::Roff::Engine.escape()</code>.</p></li>
|
|
15
25
|
</ul>
|
|
16
|
-
<h3 id="
|
|
26
|
+
<h3 id="other"><a name="other" href="#other" class="md2man-permalink" title="permalink"></a>Other:</h3>
|
|
17
27
|
<ul>
|
|
18
28
|
<li><p>GitHub now supports relative links from the README.</p></li>
|
|
19
29
|
<li><p>README: add links to package, manuals, and GitHub.</p></li>
|
|
20
30
|
</ul>
|
|
21
|
-
<h2 id="
|
|
31
|
+
<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>
|
|
22
32
|
<ul>
|
|
23
|
-
<li><p><a class="md2man-
|
|
33
|
+
<li><p><a class="md2man-reference" href="../man1/md2man-html.1.html">md2man-html(1)</a> now adds anchors and permalinks to all headings. This
|
|
24
34
|
makes it easy for readers to bookmark and share direct links to specific
|
|
25
35
|
sections of your HTML manual pages.</p></li>
|
|
26
|
-
<li><p><a class="md2man-
|
|
36
|
+
<li><p><a class="md2man-reference" href="../man1/md2man-html.1.html">md2man-html(1)</a> now wraps individual components of the special <code>.TH</code>
|
|
27
37
|
top-level heading in HTML <code><span></code> elements with stylable CSS classes:</p>
|
|
28
38
|
<pre><code><span class="md2man-title">...</span>
|
|
29
39
|
<span class="md2man-section">...</span>
|
|
@@ -33,35 +43,35 @@ top-level heading in HTML <code><span></code> elements with stylable CSS c
|
|
|
33
43
|
</code></pre>
|
|
34
44
|
<p>Thanks to Nick Fagerlund for requesting this feature in <a href="https://github.com/sunaku/md2man/issues/15">GH-15</a>.</p></li>
|
|
35
45
|
</ul>
|
|
36
|
-
<h3 id="
|
|
46
|
+
<h3 id="other-1"><a name="other-1" href="#other-1" class="md2man-permalink" title="permalink"></a>Other:</h3>
|
|
37
47
|
<ul>
|
|
38
|
-
<li><p><a class="md2man-
|
|
48
|
+
<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>
|
|
39
49
|
</ul>
|
|
40
|
-
<h2 id="
|
|
50
|
+
<h2 id="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" title="permalink"></a>Version 2.0.4 (2014-04-26)</h2><h3 id="patch-1"><a name="patch-1" href="#patch-1" class="md2man-permalink" title="permalink"></a>Patch:</h3>
|
|
41
51
|
<ul>
|
|
42
52
|
<li><p>GH-16: Redcarpet 3.1 added a third parameter to its <code>header()</code> method.
|
|
43
53
|
This raised an ArgumentError on "wrong number of arguments (3 for 2)".</p><p>Thanks to zimbatm for contributing this patch.</p></li>
|
|
44
54
|
<li><p>GH-17 and GH-18: Escape periods, quotes, and hyphens in code blocks.
|
|
45
55
|
This fixes a bug where lines beginning with periods or single quotes
|
|
46
|
-
did not appear when <a class="md2man-
|
|
56
|
+
did not appear when <a class="md2man-reference" href="../man1/md2man-roff.1.html">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>
|
|
47
57
|
</ul>
|
|
48
|
-
<h2 id="
|
|
58
|
+
<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-2"><a name="patch-2" href="#patch-2" class="md2man-permalink" title="permalink"></a>Patch:</h3>
|
|
49
59
|
<ul>
|
|
50
60
|
<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>
|
|
51
61
|
</ul>
|
|
52
|
-
<h2 id="
|
|
62
|
+
<h2 id="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" title="permalink"></a>Version 2.0.2 (2013-09-08)</h2><p>Patch:</p>
|
|
53
63
|
<ul>
|
|
54
|
-
<li><p>GH-14: escape single quotes at beginning of lines</p><p>See the "CONTROL CHARACTERS" section in the <a class="md2man-
|
|
64
|
+
<li><p>GH-14: escape single quotes at beginning of lines</p><p>See the "CONTROL CHARACTERS" section in the <a class="md2man-reference">groff(7)</a> manual for details.</p><p>Thanks to Nick Fagerlund for reporting this bug.</p></li>
|
|
55
65
|
<li><p>escape periods at line beginnings with & escape</p></li>
|
|
56
|
-
<li><p>escape text line backslashes as "\e" per <a class="md2man-
|
|
66
|
+
<li><p>escape text line backslashes as "\e" per <a class="md2man-reference">groff(7)</a></p></li>
|
|
57
67
|
<li><p>better documentation for escaping in normal_text()</p></li>
|
|
58
|
-
<li><p>it's better to escape backslashes as [rs] than \e</p><p>See "Single-Character Escapes" section in <a class="md2man-
|
|
68
|
+
<li><p>it's better to escape backslashes as [rs] than \e</p><p>See "Single-Character Escapes" section in <a class="md2man-reference">groff(7)</a>.</p></li>
|
|
59
69
|
</ul>
|
|
60
70
|
<p>Other:</p>
|
|
61
71
|
<ul>
|
|
62
72
|
<li>switch from double-quoted strings to single quotes</li>
|
|
63
73
|
</ul>
|
|
64
|
-
<h2 id="
|
|
74
|
+
<h2 id="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" title="permalink"></a>Version 2.0.1 (2013-08-29)</h2><p>Patch:</p>
|
|
65
75
|
<ul>
|
|
66
76
|
<li><p>Use a proper CDN to access Bootstrap 2.3.2 styling in HTML output.</p></li>
|
|
67
77
|
<li><p>Ensure that man/ directory exists for the <code>md2man:web</code> Rake task.</p></li>
|
|
@@ -72,10 +82,10 @@ did not appear when <a class="md2man-xref" href="../man1/md2man-roff.1.html">md2
|
|
|
72
82
|
<li><p>Upgrade dependent gems by running <code>bundle update</code>.</p></li>
|
|
73
83
|
<li><p>minitest 4.7.5 provides spec library via autorun.</p></li>
|
|
74
84
|
</ul>
|
|
75
|
-
<h2 id="
|
|
85
|
+
<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
|
|
76
86
|
that md2man provides two processing pathways: one for Roff and one for HTML.</p><p>Major:</p>
|
|
77
87
|
<ul>
|
|
78
|
-
<li><p>Rename <a class="md2man-
|
|
88
|
+
<li><p>Rename <a class="md2man-reference">md2man(1)</a> executable to <a class="md2man-reference" href="../man1/md2man-roff.1.html">md2man-roff(1)</a>.</p></li>
|
|
79
89
|
<li><p>Rename <code>Md2Man::Engine</code> to <code>Md2Man::Roff::Engine</code>.</p></li>
|
|
80
90
|
<li><p>Rename "manpage-reference" CSS class to "md2man-xref" in HTML output.</p></li>
|
|
81
91
|
<li><p>The <code>Md2Man::Document#reference()</code> method now takes only two parameters:</p>
|
|
@@ -102,15 +112,15 @@ the output document</li>
|
|
|
102
112
|
</ul>
|
|
103
113
|
<p>Other:</p>
|
|
104
114
|
<ul>
|
|
105
|
-
<li>Add <a class="md2man-
|
|
115
|
+
<li>Add <a class="md2man-reference" href="../man5/md2man.5.html">md2man(5)</a> manual page detailing md2man's markdown file format.</li>
|
|
106
116
|
</ul>
|
|
107
|
-
<h2 id="
|
|
117
|
+
<h2 id="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" title="permalink"></a>Version 1.6.2 (2013-05-05)</h2><p>Patch:</p>
|
|
108
118
|
<ul>
|
|
109
119
|
<li><p>Fix "uninitialized constant Md2Man::VERSION" error in <code>md2man/rakefile</code>.</p></li>
|
|
110
|
-
<li><p>HTML manual page CSS: justify the lines of text just like <a class="md2man-
|
|
120
|
+
<li><p>HTML manual page CSS: justify the lines of text just like <a class="md2man-reference">man(1)</a> does.</p></li>
|
|
111
121
|
<li><p>HTML manual page CSS: resize body to allot 78ex width for manpage text.</p></li>
|
|
112
122
|
</ul>
|
|
113
|
-
<h2 id="
|
|
123
|
+
<h2 id="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" title="permalink"></a>Version 1.6.1 (2013-05-04)</h2><p>Patch:</p>
|
|
114
124
|
<ul>
|
|
115
125
|
<li>Replace multi-column CSS with single centered body.</li>
|
|
116
126
|
</ul>
|
|
@@ -118,9 +128,9 @@ the output document</li>
|
|
|
118
128
|
<ul>
|
|
119
129
|
<li>Fix manpage xrefs in README and VERSION documents.</li>
|
|
120
130
|
</ul>
|
|
121
|
-
<h2 id="
|
|
131
|
+
<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>
|
|
122
132
|
<ul>
|
|
123
|
-
<li><p>Added an <a class="md2man-
|
|
133
|
+
<li><p>Added an <a class="md2man-reference" href="../man1/md2man-rake.1.html">md2man-rake(1)</a> executable that lets you run md2man's <a class="md2man-reference">rake(1)</a>
|
|
124
134
|
tasks <em>directly</em> from the command line: without the need for a "Rakefile"
|
|
125
135
|
in your working directory that loads the <code>md2man/rakefile</code> library.</p></li>
|
|
126
136
|
<li><p>In web pages generated by the <code>md2man:web</code> Rake task:</p>
|
|
@@ -140,7 +150,7 @@ in your working directory that loads the <code>md2man/rakefile</code> library.</
|
|
|
140
150
|
<ul>
|
|
141
151
|
<li>add README and VERSION to generated HTML man pages</li>
|
|
142
152
|
</ul>
|
|
143
|
-
<h2 id="
|
|
153
|
+
<h2 id="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" title="permalink"></a>Version 1.5.1 (2013-03-06)</h2><p>Patch:</p>
|
|
144
154
|
<ul>
|
|
145
155
|
<li><p>All this time, this project's documentation stated that Redcarpet's
|
|
146
156
|
<code>no_intra_emphasis</code> option was enabled, but in reality, it was not.
|
|
@@ -161,7 +171,7 @@ The documentation has been corrected and the option remains disabled.</p></li>
|
|
|
161
171
|
<li><p>rename HISTORY to VERSION so it sorts after README</p></li>
|
|
162
172
|
<li><p>tests should exercise engines with default options</p></li>
|
|
163
173
|
</ul>
|
|
164
|
-
<h2 id="
|
|
174
|
+
<h2 id="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" title="permalink"></a>Version 1.5.0 (2013-02-24)</h2><p>Minor:</p>
|
|
165
175
|
<ul>
|
|
166
176
|
<li><p>The <code>md2man:web</code> task from <code>md2man/rakefile</code> now:</p>
|
|
167
177
|
<ul>
|
|
@@ -175,7 +185,7 @@ The documentation has been corrected and the option remains disabled.</p></li>
|
|
|
175
185
|
<li><p>README: better organize the subsections of "Usage"</p></li>
|
|
176
186
|
<li><p>include md2man rake tasks in developer's rakefile</p></li>
|
|
177
187
|
</ul>
|
|
178
|
-
<h2 id="
|
|
188
|
+
<h2 id="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" title="permalink"></a>Version 1.4.1 (2013-02-23)</h2><p>Patch:</p>
|
|
179
189
|
<ul>
|
|
180
190
|
<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>
|
|
181
191
|
<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>
|
|
@@ -183,14 +193,14 @@ The documentation has been corrected and the option remains disabled.</p></li>
|
|
|
183
193
|
</ul>
|
|
184
194
|
<p>Other:</p>
|
|
185
195
|
<ul>
|
|
186
|
-
<li><p>README: add <a class="md2man-
|
|
196
|
+
<li><p>README: add <a class="md2man-reference" href="../man1/md2man-html.1.html">md2man-html(1)</a> and Md2Man::HTML usage</p></li>
|
|
187
197
|
<li><p>LICENSE: use GitHub profile URLs instead of e-mail</p></li>
|
|
188
198
|
</ul>
|
|
189
|
-
<h2 id="
|
|
199
|
+
<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>
|
|
190
200
|
<ul>
|
|
191
201
|
<li><p>roff: emit non-first H1 headings as H2 headings</p></li>
|
|
192
202
|
<li><p>html: add <code>Md2Man::HTML::Engine</code> class for HTML manual page generation</p></li>
|
|
193
|
-
<li><p>html: add <a class="md2man-
|
|
203
|
+
<li><p>html: add <a class="md2man-reference" href="../man1/md2man-html.1.html">md2man-html(1)</a> bin script for command line access to the above</p></li>
|
|
194
204
|
<li><p>html: add ID attributes on all headings for easy permalinking</p></li>
|
|
195
205
|
<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
|
|
196
206
|
manual pages from Markdown files (with ".markdown", ".mkd", or ".md"
|
|
@@ -198,12 +208,12 @@ extension) inside your <code>man/man*/</code> directories. It also provides
|
|
|
198
208
|
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
|
|
199
209
|
your manual pages for packaging into a gem. See the README for details.</p></li>
|
|
200
210
|
</ul>
|
|
201
|
-
<h2 id="
|
|
211
|
+
<h2 id="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" title="permalink"></a>Version 1.3.2 (2012-10-13)</h2><p>Patch:</p>
|
|
202
212
|
<ul>
|
|
203
213
|
<li><p>roff: escape backslashes inside codespan nodes too</p></li>
|
|
204
214
|
<li><p>roff: escape backslashes inside block_code nodes</p></li>
|
|
205
215
|
</ul>
|
|
206
|
-
<h2 id="
|
|
216
|
+
<h2 id="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" title="permalink"></a>Version 1.3.1 (2012-10-09)</h2><p>Patch:</p>
|
|
207
217
|
<ul>
|
|
208
218
|
<li><p>roff: do not render references inside code blocks.</p></li>
|
|
209
219
|
<li><p>roff: do not render references inside code spans.</p></li>
|
|
@@ -211,7 +221,7 @@ your manual pages for packaging into a gem. See the README for details.</p></li
|
|
|
211
221
|
<li><p>roff: also indent block_code just like block_quote.</p></li>
|
|
212
222
|
<li><p>roff: add paragraph above block_quote for spacing.</p></li>
|
|
213
223
|
<li><p>roff: render code blocks as paragraphs for spacing.</p><p>Otherwise there's not enough space between the previous paragraph and
|
|
214
|
-
the code block: it appears on the next line and appears ugly in <a class="md2man-
|
|
224
|
+
the code block: it appears on the next line and appears ugly in <a class="md2man-reference">man(1)</a>.</p></li>
|
|
215
225
|
<li><p>document: make reference regexp match more manpages.</p></li>
|
|
216
226
|
</ul>
|
|
217
227
|
<p>Other:</p>
|
|
@@ -220,13 +230,13 @@ the code block: it appears on the next line and appears ugly in <a class="md2man
|
|
|
220
230
|
<li><p>document: super() can't reach Redcarpet's renderer classes.
|
|
221
231
|
See <a href="https://github.com/vmg/redcarpet/issues/51">https://github.com/vmg/redcarpet/issues/51</a> for details.</p></li>
|
|
222
232
|
</ul>
|
|
223
|
-
<h2 id="
|
|
233
|
+
<h2 id="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" title="permalink"></a>Version 1.3.0 (2012-09-27)</h2><p>Minor:</p>
|
|
224
234
|
<ul>
|
|
225
235
|
<li>Intra-word emphasis is now enabled <em>by default</em> in <code>Md2Man::ENGINE</code>.
|
|
226
236
|
To not be affected by this change, you may still construct your own
|
|
227
237
|
Redcarpet::Markdown engine with your own set of processing options.</li>
|
|
228
238
|
</ul>
|
|
229
|
-
<h2 id="
|
|
239
|
+
<h2 id="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" title="permalink"></a>Version 1.2.1 (2012-07-05)</h2><p>Patch:</p>
|
|
230
240
|
<ul>
|
|
231
241
|
<li>GH-4: ruby 1.8.7 lacks negative lookbehind regexps.
|
|
232
242
|
Thanks to Postmodern for reporting this issue.</li>
|
|
@@ -237,7 +247,7 @@ Thanks to Postmodern for reporting this issue.</li>
|
|
|
237
247
|
See <a href="http://docs.rubygems.org/read/chapter/16">http://docs.rubygems.org/read/chapter/16</a>
|
|
238
248
|
Thanks to Postmodern for this contribution.</li>
|
|
239
249
|
</ul>
|
|
240
|
-
<h2 id="
|
|
250
|
+
<h2 id="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" title="permalink"></a>Version 1.2.0 (2012-02-06)</h2><p>Minor:</p>
|
|
241
251
|
<ul>
|
|
242
252
|
<li>The <code>Md2Man::Document</code> module now handles paragraph() nodes and dispatches
|
|
243
253
|
their content accordingly to hook methods for indented, tagged, and normal
|
|
@@ -250,7 +260,7 @@ to markdown syntax programmatically.</li>
|
|
|
250
260
|
<li><p>README: mention features; revise markdown; cleanup.</p></li>
|
|
251
261
|
<li><p>LICENSE: @tanoku created initial Manpage renderer.</p></li>
|
|
252
262
|
</ul>
|
|
253
|
-
<h2 id="
|
|
263
|
+
<h2 id="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" title="permalink"></a>Version 1.1.0 (2012-02-02)</h2><p>Minor:</p>
|
|
254
264
|
<ul>
|
|
255
265
|
<li>Add <code>Md2Man::Document</code> module for programmatic processing of
|
|
256
266
|
cross-references to other UNIX manual pages within Redcarpet.</li>
|
|
@@ -263,7 +273,7 @@ cross-references to other UNIX manual pages within Redcarpet.</li>
|
|
|
263
273
|
<li><p>README: fix installation commands for development.</p></li>
|
|
264
274
|
<li><p>README: simplify project slogan to be more memorable.</p></li>
|
|
265
275
|
</ul>
|
|
266
|
-
<h2 id="
|
|
276
|
+
<h2 id="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" title="permalink"></a>Version 1.0.2 (2012-01-09)</h2><p>Patch:</p>
|
|
267
277
|
<ul>
|
|
268
278
|
<li><p>Blockquote's leading paragraph regexp was not anchored.</p></li>
|
|
269
279
|
<li><p>Freezing internal constants prevents monkey patching.</p></li>
|
|
@@ -274,7 +284,7 @@ cross-references to other UNIX manual pages within Redcarpet.</li>
|
|
|
274
284
|
<li><p>Added example input file from the Linux Man Page Howto.</p></li>
|
|
275
285
|
<li><p>Forgot to change project slogan in the gem package.</p></li>
|
|
276
286
|
</ul>
|
|
277
|
-
<h2 id="
|
|
287
|
+
<h2 id="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" title="permalink"></a>Version 1.0.1 (2011-12-06)</h2><p>Major:</p>
|
|
278
288
|
<ul>
|
|
279
289
|
<li><p>Renamed the project from "redcarpet-manpage" to "md2man".</p>
|
|
280
290
|
<ul>
|
|
@@ -286,7 +296,7 @@ bold styling. All that matters is that the subsequent lines are indented.</p></
|
|
|
286
296
|
</ul>
|
|
287
297
|
<p>Minor:</p>
|
|
288
298
|
<ul>
|
|
289
|
-
<li><p>Added <a class="md2man-
|
|
299
|
+
<li><p>Added <a class="md2man-reference">md2man(1)</a> executable for command-line usage.</p></li>
|
|
290
300
|
<li><p>Added support for all HTML 4.0 and XHTML 1.0 entities.</p></li>
|
|
291
301
|
<li><p>Added support for tables, horizontal rules, and more.</p></li>
|
|
292
302
|
<li><p>Added <code>Md2Man::Roff</code> mixin for advanced Redcarpet2 usage.</p></li>
|
|
@@ -296,5 +306,5 @@ bold styling. All that matters is that the subsequent lines are indented.</p></
|
|
|
296
306
|
<ul>
|
|
297
307
|
<li>Rewrote entire Markdown to Roff conversion from scratch while doing TDD.</li>
|
|
298
308
|
</ul>
|
|
299
|
-
<h2 id="
|
|
309
|
+
<h2 id="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" title="permalink"></a>Version 0.0.1 (2011-10-13)</h2><p>First release! Happy birthday! Woohoo! :-)</p></div></body>
|
|
300
310
|
</html>
|
data/man/man0/VERSION.markdown
CHANGED
|
@@ -1,3 +1,22 @@
|
|
|
1
|
+
## Version 3.0.0 (2014-06-22)
|
|
2
|
+
|
|
3
|
+
This release changes md2man-html(1) heading permalinks to follow GitHub style:
|
|
4
|
+
unique, lowercase, and squeezed and stripped of HTML tags and non-word chars.
|
|
5
|
+
In addition, it renames the `md2man-xref` CSS class to `md2man-reference`.
|
|
6
|
+
|
|
7
|
+
Please make sure to update any existing bookmarks and/or hyperlinks you may
|
|
8
|
+
have for jumping to specific locations in your HTML manuals after upgrading.
|
|
9
|
+
|
|
10
|
+
### Major:
|
|
11
|
+
|
|
12
|
+
* Make permalink anchors on headings fully lowercase in md2man-html(1).
|
|
13
|
+
|
|
14
|
+
* Put permalinks on left & indicate target permalink in md2man-html(1).
|
|
15
|
+
|
|
16
|
+
* Make permalink anchors unique by appending a count in md2man-html(1).
|
|
17
|
+
|
|
18
|
+
* Rename `md2man-xref` CSS class to `md2man-reference` in md2man-html(1).
|
|
19
|
+
|
|
1
20
|
## Version 2.1.1 (2014-06-21)
|
|
2
21
|
|
|
3
22
|
### Patch:
|
data/man/man1/md2man-html.1
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
.TH MD2MAN\-HTML 1 2014\-06\-
|
|
1
|
+
.TH MD2MAN\-HTML 1 2014\-06\-22 3.0.0
|
|
2
2
|
.SH NAME
|
|
3
3
|
.PP
|
|
4
4
|
md2man\-html \- convert
|
|
@@ -36,10 +36,37 @@ is wrapped in stylable \fB\fC<span>\fR elements as follows:
|
|
|
36
36
|
<span class="md2man\-manual">...</span>
|
|
37
37
|
.fi
|
|
38
38
|
.RE
|
|
39
|
+
.SS Heading permalinks
|
|
40
|
+
.PP
|
|
41
|
+
Self\-referencing hyperlinks (for permanent linking) are added to headings by
|
|
42
|
+
converting their labels into URI fragments that are unique (using a counter),
|
|
43
|
+
lowercase, and squeezed and stripped of HTML tags and non\-word characters.
|
|
44
|
+
.PP
|
|
45
|
+
For example, a heading labeled \fB\fCVer<s>iON 3(2</s>!4)))\fR would be emitted as:
|
|
46
|
+
.PP
|
|
47
|
+
.RS
|
|
48
|
+
.nf
|
|
49
|
+
<h2 id="ver\-ion\-3\-2\-4"><a name="ver\-ion\-3\-2\-4" href="#ver\-ion\-3\-2\-4"
|
|
50
|
+
class="md2man\-permalink" title="permalink"></a>Ver<s>iON 3(2</s>!4)))</h2>
|
|
51
|
+
.fi
|
|
52
|
+
.RE
|
|
53
|
+
.PP
|
|
54
|
+
For example, multiple headings labeled \fB\fCHello, world!\fR would be emitted as:
|
|
55
|
+
.PP
|
|
56
|
+
.RS
|
|
57
|
+
.nf
|
|
58
|
+
<h2 id="hello\-world"><a name="hello\-world" href="#hello\-world"
|
|
59
|
+
class="md2man\-permalink" title="permalink"></a>Hello, world!</h2>
|
|
60
|
+
<h2 id="hello\-world\-1"><a name="hello\-world\-1" href="#hello\-world\-1"
|
|
61
|
+
class="md2man\-permalink" title="permalink"></a>Hello, world!</h2>
|
|
62
|
+
<h2 id="hello\-world\-2"><a name="hello\-world\-2" href="#hello\-world\-2"
|
|
63
|
+
class="md2man\-permalink" title="permalink"></a>Hello, world!</h2>
|
|
64
|
+
.fi
|
|
65
|
+
.RE
|
|
39
66
|
.SS Cross references
|
|
40
67
|
.PP
|
|
41
68
|
Cross references to manual pages are emitted as HTML hyperlinks that have
|
|
42
|
-
\fB\fCclass="md2man\-
|
|
69
|
+
\fB\fCclass="md2man\-reference"\fR and \fB\fChref="../man$SECTION/$PAGE.$SECTION.html"\fR
|
|
43
70
|
attributes.
|
|
44
71
|
.PP
|
|
45
72
|
For example, the \fB\fC
|
|
@@ -48,7 +75,7 @@ cross reference would be emitted as this HTML:
|
|
|
48
75
|
.PP
|
|
49
76
|
.RS
|
|
50
77
|
.nf
|
|
51
|
-
<a class="md2man\-
|
|
78
|
+
<a class="md2man\-reference" href="../man3/printf.3.html">
|
|
52
79
|
.BR printf (3)</a>
|
|
53
80
|
.fi
|
|
54
81
|
.RE
|
data/man/man1/md2man-html.1.html
CHANGED
|
@@ -2,25 +2,41 @@
|
|
|
2
2
|
<html>
|
|
3
3
|
<head>
|
|
4
4
|
<meta charset="utf-8" />
|
|
5
|
-
<meta name="generator" content="md2man
|
|
5
|
+
<meta name="generator" content="md2man 3.0.0 https://github.com/sunaku/md2man" />
|
|
6
6
|
<title>md2man-html(1) — convert md2man(5) flavored markdown(7) into HTML</title>
|
|
7
7
|
<link rel="stylesheet" href="../style.css"/>
|
|
8
8
|
<!--[if lt IE 9]><script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script><![endif]-->
|
|
9
9
|
</head>
|
|
10
|
-
<body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man1">man1</a>/md2man-html.1</span></div></div><div class="container-fluid"><h1 id="
|
|
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-06-22-3-0-0"><a name="md2man-html-1-2014-06-22-3-0-0" href="#md2man-html-1-2014-06-22-3-0-0" class="md2man-permalink" title="permalink"></a><span class="md2man-title">MD2MAN-HTML</span> <span class="md2man-section">1</span> <span class="md2man-date">2014-06-22</span> <span class="md2man-source">3.0.0</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
|
-
If <em>FILE</em> is not given, then the standard input stream is read in its place.</p><h3 id="
|
|
13
|
-
headings" in <a class="md2man-
|
|
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
|
+
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>
|
|
14
14
|
<pre><code><span class="md2man-title">...</span>
|
|
15
15
|
<span class="md2man-section">...</span>
|
|
16
16
|
<span class="md2man-date">...</span>
|
|
17
17
|
<span class="md2man-source">...</span>
|
|
18
18
|
<span class="md2man-manual">...</span>
|
|
19
19
|
</code></pre>
|
|
20
|
-
<h3 id="
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
<pre><code><
|
|
20
|
+
<h3 id="heading-permalinks"><a name="heading-permalinks" href="#heading-permalinks" class="md2man-permalink" title="permalink"></a>Heading permalinks</h3><p>Self-referencing hyperlinks (for permanent linking) are added to headings by
|
|
21
|
+
converting their labels into URI fragments that are unique (using a counter),
|
|
22
|
+
lowercase, and squeezed and stripped of HTML tags and non-word characters.</p><p>For example, a heading labeled <code>Ver<s>iON 3(2</s>!4)))</code> would be emitted as:</p>
|
|
23
|
+
<pre><code><h2 id="ver-ion-3-2-4"><a name="ver-ion-3-2-4" href="#ver-ion-3-2-4"
|
|
24
|
+
class="md2man-permalink" title="permalink"></a>Ver<s>iON 3(2</s>!4)))</h2>
|
|
24
25
|
</code></pre>
|
|
25
|
-
<
|
|
26
|
+
<p>For example, multiple headings labeled <code>Hello, world!</code> would be emitted as:</p>
|
|
27
|
+
<pre><code><h2 id="hello-world"><a name="hello-world" href="#hello-world"
|
|
28
|
+
class="md2man-permalink" title="permalink"></a>Hello, world!</h2>
|
|
29
|
+
|
|
30
|
+
<h2 id="hello-world-1"><a name="hello-world-1" href="#hello-world-1"
|
|
31
|
+
class="md2man-permalink" title="permalink"></a>Hello, world!</h2>
|
|
32
|
+
|
|
33
|
+
<h2 id="hello-world-2"><a name="hello-world-2" href="#hello-world-2"
|
|
34
|
+
class="md2man-permalink" title="permalink"></a>Hello, world!</h2>
|
|
35
|
+
</code></pre>
|
|
36
|
+
<h3 id="cross-references"><a name="cross-references" href="#cross-references" class="md2man-permalink" title="permalink"></a>Cross references</h3><p>Cross references to manual pages are emitted as HTML hyperlinks that have
|
|
37
|
+
<code>class="md2man-reference"</code> and <code>href="../man$SECTION/$PAGE.$SECTION.html"</code>
|
|
38
|
+
attributes.</p><p>For example, the <code><a class="md2man-reference">printf(3)</a></code> cross reference would be emitted as this HTML:</p>
|
|
39
|
+
<pre><code><a class="md2man-reference" href="../man3/printf.3.html"><a class="md2man-reference">printf(3)</a></a>
|
|
40
|
+
</code></pre>
|
|
41
|
+
<h2 id="options"><a name="options" href="#options" class="md2man-permalink" title="permalink"></a>OPTIONS</h2><dl><dt><code>-h</code>, <code>--help</code></dt><dd>Show this help manual.</dd></dl><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" href="../man1/md2man-roff.1.html">md2man-roff(1)</a>, <a class="md2man-reference" href="../man1/md2man-rake.1.html">md2man-rake(1)</a>, <a class="md2man-reference" href="../man5/md2man.5.html">md2man(5)</a></p></div></body>
|
|
26
42
|
</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
|
|
5
|
+
<meta name="generator" content="md2man 3.0.0 https://github.com/sunaku/md2man" />
|
|
6
6
|
<title>md2man-rake(1) — run rake(1) tasks from md2man(1)</title>
|
|
7
7
|
<link rel="stylesheet" href="../style.css"/>
|
|
8
8
|
<!--[if lt IE 9]><script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script><![endif]-->
|
|
9
9
|
</head>
|
|
10
|
-
<body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man1">man1</a>/md2man-rake.1</span></div></div><div class="container-fluid"><h1 id="
|
|
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-06-22-3-0-0"><a name="md2man-rake-1-2014-06-22-3-0-0" href="#md2man-rake-1-2014-06-22-3-0-0" class="md2man-permalink" title="permalink"></a><span class="md2man-title">MD2MAN-RAKE</span> <span class="md2man-section">1</span> <span class="md2man-date">2014-06-22</span> <span class="md2man-source">3.0.0</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>
|
|
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="
|
|
14
|
+
<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
|
|
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="
|
|
16
|
+
found in or beneath the <code>man/</code> subdirectory in your working directory.</dd></dl><h2 id="options"><a name="options" href="#options" class="md2man-permalink" title="permalink"></a>OPTIONS</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"><a name="see-also" href="#see-also" class="md2man-permalink" title="permalink"></a>SEE ALSO</h2><p><a class="md2man-reference">rake(1)</a>, <a class="md2man-reference" href="../man1/md2man-roff.1.html">md2man-roff(1)</a>, <a class="md2man-reference" href="../man1/md2man-html.1.html">md2man-html(1)</a>, <a class="md2man-reference" href="../man5/md2man.5.html">md2man(5)</a></p></div></body>
|
|
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
|
|
5
|
+
<meta name="generator" content="md2man 3.0.0 https://github.com/sunaku/md2man" />
|
|
6
6
|
<title>md2man-roff(1) — convert md2man(5) flavored markdown(7) into roff(7)</title>
|
|
7
7
|
<link rel="stylesheet" href="../style.css"/>
|
|
8
8
|
<!--[if lt IE 9]><script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script><![endif]-->
|
|
9
9
|
</head>
|
|
10
|
-
<body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man1">man1</a>/md2man-roff.1</span></div></div><div class="container-fluid"><h1 id="
|
|
11
|
-
<em>FILE</em> into <a class="md2man-
|
|
12
|
-
If <em>FILE</em> is not given, then the standard input stream is read in its place.</p><h3 id="
|
|
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-06-22-3-0-0"><a name="md2man-roff-1-2014-06-22-3-0-0" href="#md2man-roff-1-2014-06-22-3-0-0" class="md2man-permalink" title="permalink"></a><span class="md2man-title">MD2MAN-ROFF</span> <span class="md2man-section">1</span> <span class="md2man-date">2014-06-22</span> <span class="md2man-source">3.0.0</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
|
+
<em>FILE</em> into <a class="md2man-reference">roff(7)</a> and then prints the result to the standard output stream.
|
|
12
|
+
If <em>FILE</em> is not given, then the standard input stream is read in its place.</p><h3 id="limitations"><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>
|
|
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="
|
|
20
|
+
<p>It issues a warning when it encounters these instead. Patches are welcome!</p><h2 id="options"><a name="options" href="#options" class="md2man-permalink" title="permalink"></a>OPTIONS</h2><dl><dt><code>-h</code>, <code>--help</code></dt><dd>Show this help manual.</dd></dl><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" href="../man1/md2man-html.1.html">md2man-html(1)</a>, <a class="md2man-reference" href="../man1/md2man-rake.1.html">md2man-rake(1)</a>, <a class="md2man-reference" href="../man5/md2man.5.html">md2man(5)</a></p></div></body>
|
|
21
21
|
</html>
|
data/man/man5/md2man.5
CHANGED
data/man/man5/md2man.5.html
CHANGED
|
@@ -2,13 +2,13 @@
|
|
|
2
2
|
<html>
|
|
3
3
|
<head>
|
|
4
4
|
<meta charset="utf-8" />
|
|
5
|
-
<meta name="generator" content="md2man
|
|
5
|
+
<meta name="generator" content="md2man 3.0.0 https://github.com/sunaku/md2man" />
|
|
6
6
|
<title>md2man(5) — manual page flavoring for the markdown(7) file format</title>
|
|
7
7
|
<link rel="stylesheet" href="../style.css"/>
|
|
8
8
|
<!--[if lt IE 9]><script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script><![endif]-->
|
|
9
9
|
</head>
|
|
10
|
-
<body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man5">man5</a>/md2man.5</span></div></div><div class="container-fluid"><h1 id="
|
|
11
|
-
pages by extending its syntax, semantics, and assumed processing extensions.</p><h3 id="
|
|
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-06-22-3-0-0"><a name="md2man-5-2014-06-22-3-0-0" href="#md2man-5-2014-06-22-3-0-0" class="md2man-permalink" title="permalink"></a><span class="md2man-title">MD2MAN</span> <span class="md2man-section">5</span> <span class="md2man-date">2014-06-22</span> <span class="md2man-source">3.0.0</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
|
+
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>
|
|
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="
|
|
29
|
+
<h4 id="normal-paragraphs"><a name="normal-paragraphs" href="#normal-paragraphs" class="md2man-permalink" title="permalink"></a>Normal paragraphs</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,26 +37,26 @@ This
|
|
|
37
37
|
normal
|
|
38
38
|
paragraph.
|
|
39
39
|
</code></pre>
|
|
40
|
-
<h4 id="
|
|
40
|
+
<h4 id="tagged-paragraphs"><a name="tagged-paragraphs" href="#tagged-paragraphs" class="md2man-permalink" title="permalink"></a>Tagged paragraphs</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="
|
|
47
|
+
<h4 id="indented-paragraphs"><a name="indented-paragraphs" href="#indented-paragraphs" class="md2man-permalink" title="permalink"></a>Indented paragraphs</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="
|
|
54
|
-
<code>.TH</code> directive in <a class="md2man-
|
|
53
|
+
<h3 id="semantics"><a name="semantics" href="#semantics" class="md2man-permalink" title="permalink"></a>Semantics</h3><p>md2man extends <a class="md2man-reference">markdown(7)</a> semantics by treating top-level headings specially.</p><h4 id="top-level-headings"><a name="top-level-headings" href="#top-level-headings" class="md2man-permalink" title="permalink"></a>Top-level headings</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-reference">roff(7)</a>, as described under "Title line" in <a class="md2man-reference">man-pages(7)</a>:</p>
|
|
55
55
|
<blockquote>
|
|
56
56
|
<pre><code>.TH title section date source manual
|
|
57
57
|
</code></pre>
|
|
58
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="
|
|
59
|
+
<p>Any subsequent top-level headings are treated as second-level <code><h2></code> headings.</p><h3 id="extensions"><a name="extensions" href="#extensions" class="md2man-permalink" title="permalink"></a>Extensions</h3><p>md2man enables the following <a href="https://github.com/vmg/redcarpet">Redcarpet</a> extensions while reading <a class="md2man-reference">markdown(7)</a>:</p>
|
|
60
60
|
<ul>
|
|
61
61
|
<li>tables</li>
|
|
62
62
|
<li>autolink</li>
|
|
@@ -64,5 +64,5 @@ spaces are considered to be "indented paragraphs". For example:</p>
|
|
|
64
64
|
<li>strikethrough</li>
|
|
65
65
|
<li>fenced_code_blocks</li>
|
|
66
66
|
</ul>
|
|
67
|
-
<h2 id="
|
|
67
|
+
<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" href="../man1/md2man-roff.1.html">md2man-roff(1)</a>, <a class="md2man-reference" href="../man1/md2man-html.1.html">md2man-html(1)</a>, <a class="md2man-reference" href="../man1/md2man-rake.1.html">md2man-rake(1)</a></p></div></body>
|
|
68
68
|
</html>
|
data/man/man5/md2man.5.markdown
CHANGED
data/man/style.css
CHANGED
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
}
|
|
12
12
|
|
|
13
13
|
/* deactivate external manual page cross-references */
|
|
14
|
-
a.md2man-
|
|
14
|
+
a.md2man-reference:not([href]) {
|
|
15
15
|
color: inherit;
|
|
16
16
|
text-decoration: none;
|
|
17
17
|
}
|
|
@@ -36,14 +36,19 @@
|
|
|
36
36
|
display: none;
|
|
37
37
|
}
|
|
38
38
|
|
|
39
|
-
a.md2man-permalink
|
|
40
|
-
|
|
39
|
+
a.md2man-permalink {
|
|
40
|
+
float: left;
|
|
41
|
+
margin-left: -1em;
|
|
42
|
+
opacity: 0.25;
|
|
43
|
+
}
|
|
44
|
+
|
|
45
|
+
a.md2man-permalink:before {
|
|
41
46
|
content: '\2665'; /* ♥ */
|
|
42
|
-
opacity: 0.125;
|
|
43
47
|
}
|
|
44
48
|
|
|
45
|
-
a.md2man-permalink:hover
|
|
46
|
-
|
|
49
|
+
a.md2man-permalink:hover,
|
|
50
|
+
*:target > a.md2man-permalink {
|
|
51
|
+
opacity: initial
|
|
47
52
|
}
|
|
48
53
|
}
|
|
49
54
|
|
data/test/md2man/html_test.rb
CHANGED
|
@@ -55,10 +55,10 @@ describe 'html engine' do
|
|
|
55
55
|
@markdown.render(heredoc(<<-INPUT)).must_equal(heredoc(<<-OUTPUT))
|
|
56
56
|
|For example, the `printf(3)` cross reference would be emitted as this HTML:
|
|
57
57
|
|
|
|
58
|
-
| <a class="md2man-
|
|
58
|
+
| <a class="md2man-reference" href="../man3/printf.3.html">printf(3)</a>
|
|
59
59
|
INPUT
|
|
60
|
-
|<p>For example, the <code><a class="md2man-
|
|
61
|
-
|<pre><code><a class="md2man-
|
|
60
|
+
|<p>For example, the <code><a class="md2man-reference" href="../man3/printf.3.html">printf(3)</a></code> cross reference would be emitted as this HTML:</p>
|
|
61
|
+
|<pre><code><a class="md2man-reference" href="../man3/printf.3.html"><a class="md2man-reference" href="../man3/printf.3.html">printf(3)</a></a>
|
|
62
62
|
|</code></pre>
|
|
63
63
|
|
|
|
64
64
|
OUTPUT
|
|
@@ -68,7 +68,7 @@ describe 'html engine' do
|
|
|
68
68
|
@markdown.render(heredoc(<<-INPUT)).must_equal(heredoc(<<-OUTPUT))
|
|
69
69
|
|convert them from markdown(7) into roff(7), using
|
|
70
70
|
INPUT
|
|
71
|
-
|<p>convert them from <a class="md2man-
|
|
71
|
+
|<p>convert them from <a class="md2man-reference" href="../man7/markdown.7.html">markdown(7)</a> into <a class="md2man-reference" href="../man7/roff.7.html">roff(7)</a>, using</p>
|
|
72
72
|
OUTPUT
|
|
73
73
|
end
|
|
74
74
|
|
|
@@ -76,7 +76,7 @@ describe 'html engine' do
|
|
|
76
76
|
@markdown.render(heredoc(<<-INPUT)).must_equal(heredoc(<<-OUTPUT))
|
|
77
77
|
|markdown(1) into roff(2)
|
|
78
78
|
INPUT
|
|
79
|
-
|<p><a class="md2man-
|
|
79
|
+
|<p><a class="md2man-reference" href="../man1/markdown.1.html">markdown(1)</a> into <a class="md2man-reference" href="../man2/roff.2.html">roff(2)</a></p>
|
|
80
80
|
OUTPUT
|
|
81
81
|
end
|
|
82
82
|
|
|
@@ -87,8 +87,8 @@ describe 'html engine' do
|
|
|
87
87
|
| roff(7), and much more!
|
|
88
88
|
INPUT
|
|
89
89
|
|<pre><code>this is a code block
|
|
90
|
-
|containing <a class=\"md2man-
|
|
91
|
-
|<a class=\"md2man-
|
|
90
|
+
|containing <a class=\"md2man-reference\" href=\"../man7/markdown.7.html\">markdown(7)</a>,
|
|
91
|
+
|<a class=\"md2man-reference\" href=\"../man7/roff.7.html\">roff(7)</a>, and much more!
|
|
92
92
|
|</code></pre>
|
|
93
93
|
|
|
|
94
94
|
OUTPUT
|
|
@@ -98,7 +98,7 @@ describe 'html engine' do
|
|
|
98
98
|
@markdown.render(heredoc(<<-INPUT)).must_equal(heredoc(<<-OUTPUT))
|
|
99
99
|
|this is a code span `containing markdown(7), roff(7), and` much more!
|
|
100
100
|
INPUT
|
|
101
|
-
|<p>this is a code span <code>containing <a class="md2man-
|
|
101
|
+
|<p>this is a code span <code>containing <a class="md2man-reference" href="../man7/markdown.7.html">markdown(7)</a>, <a class="md2man-reference" href="../man7/roff.7.html">roff(7)</a>, and</code> much more!</p>
|
|
102
102
|
OUTPUT
|
|
103
103
|
end
|
|
104
104
|
|
|
@@ -140,12 +140,20 @@ describe 'html engine' do
|
|
|
140
140
|
|### --BAZ-QUX--
|
|
141
141
|
|#### qux (MOZ)
|
|
142
142
|
|##### {m}oz END
|
|
143
|
+
|# bar BAZ
|
|
144
|
+
|## bar *BAZ*
|
|
145
|
+
|### bar **BAZ**
|
|
146
|
+
|#### -bar--BAZ---
|
|
143
147
|
INPUT
|
|
144
|
-
<h1 id="foo-
|
|
145
|
-
<h2 id="bar-
|
|
146
|
-
<h3 id="
|
|
147
|
-
<h4 id="qux-
|
|
148
|
-
<h5 id="m-oz-
|
|
148
|
+
<h1 id="foo-bar"><a name="foo-bar" href="#foo-bar" class="md2man-permalink" title="permalink"></a><span class=\"md2man-title\">foo</span> <span class=\"md2man-section\"><em>BAR</em></span></h1>\
|
|
149
|
+
<h2 id="bar-baz"><a name="bar-baz" href="#bar-baz" class="md2man-permalink" title="permalink"></a>bar BAZ</h2>\
|
|
150
|
+
<h3 id="baz-qux"><a name="baz-qux" href="#baz-qux" class="md2man-permalink" title="permalink"></a>--BAZ-QUX--</h3>\
|
|
151
|
+
<h4 id="qux-moz"><a name="qux-moz" href="#qux-moz" class="md2man-permalink" title="permalink"></a>qux (MOZ)</h4>\
|
|
152
|
+
<h5 id="m-oz-end"><a name="m-oz-end" href="#m-oz-end" class="md2man-permalink" title="permalink"></a>{m}oz END</h5>\
|
|
153
|
+
<h1 id="bar-baz-1"><a name="bar-baz-1" href="#bar-baz-1" class="md2man-permalink" title="permalink"></a>bar BAZ</h1>\
|
|
154
|
+
<h2 id="bar-baz-2"><a name="bar-baz-2" href="#bar-baz-2" class="md2man-permalink" title="permalink"></a>bar <em>BAZ</em></h2>\
|
|
155
|
+
<h3 id="bar-baz-3"><a name="bar-baz-3" href="#bar-baz-3" class="md2man-permalink" title="permalink"></a>bar <strong>BAZ</strong></h3>\
|
|
156
|
+
<h4 id="bar-baz-4"><a name="bar-baz-4" href="#bar-baz-4" class="md2man-permalink" title="permalink"></a>-bar--BAZ---</h4>
|
|
149
157
|
OUTPUT
|
|
150
158
|
end
|
|
151
159
|
end
|
data/test/md2man/roff_test.rb
CHANGED
|
@@ -852,7 +852,7 @@ describe 'roff engine' do
|
|
|
852
852
|
@markdown.render(heredoc(<<-INPUT)).must_equal(heredoc(<<-OUTPUT))
|
|
853
853
|
|For example, the `printf(3)` cross reference would be emitted as this HTML:
|
|
854
854
|
|
|
|
855
|
-
| <a class="md2man-
|
|
855
|
+
| <a class="md2man-reference" href="../man3/printf.3.html">printf(3)</a>
|
|
856
856
|
INPUT
|
|
857
857
|
|.PP
|
|
858
858
|
|For example, the \\fB\\fC
|
|
@@ -861,7 +861,7 @@ describe 'roff engine' do
|
|
|
861
861
|
|.PP
|
|
862
862
|
|.RS
|
|
863
863
|
|.nf
|
|
864
|
-
|<a class="md2man\\-
|
|
864
|
+
|<a class="md2man\\-reference" href="../man3/printf.3.html">
|
|
865
865
|
|.BR printf (3)</a>
|
|
866
866
|
|.fi
|
|
867
867
|
|.RE
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: md2man
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version:
|
|
4
|
+
version: 3.0.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-06-
|
|
11
|
+
date: 2014-06-23 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: binman
|