md2man 4.0.1 → 5.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.markdown +92 -56
- data/VERSION.markdown +13 -0
- data/bin/md2man-html +9 -9
- data/bin/md2man-rake +1 -1
- data/bin/md2man-roff +1 -1
- data/lib/md2man/html.rb +1 -1
- data/lib/md2man/version.rb +1 -1
- data/man/index.html +1 -1
- data/man/man0/README.html +14 -14
- data/man/man0/VERSION.html +54 -44
- data/man/man1/md2man-html.1 +9 -9
- data/man/man1/md2man-html.1.html +14 -14
- data/man/man1/md2man-rake.1 +1 -1
- data/man/man1/md2man-rake.1.html +4 -4
- data/man/man1/md2man-roff.1 +1 -1
- data/man/man1/md2man-roff.1.html +4 -4
- data/man/man5/md2man.5 +1 -1
- data/man/man5/md2man.5.html +9 -9
- data/man/man5/md2man.5.markdown +1 -1
- data/md2man.gemspec +1 -1
- data/test/md2man/html_test.rb +12 -12
- metadata +4 -4
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 2bdb1fbb6e383e4152958f6bbb6a39c4297d69b5
|
|
4
|
+
data.tar.gz: 2363a55a81bb82af94e94c16818999d4259b26bf
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 71dd39157e1c68f8e69730d3dbe231c6f3ab3f8f38e4436cc777a99112584280e117e6964fa24f9d8ec7665f2e45475f9ff5311c6c2f4e4e44f6f82628914f69
|
|
7
|
+
data.tar.gz: bb0e2fe13cfdb086950dccf58b4c05700b4fd890f08d5567db11a707379b6992d1069c2b72dc2467e93051b7b99721a65df9d9406e215fe07e01b4cf8ad1c74c
|
data/README.markdown
CHANGED
|
@@ -22,28 +22,36 @@ md2man is a Ruby library and a set of command-line programs that convert
|
|
|
22
22
|
|
|
23
23
|
Try converting [this example Markdown file][example] into a UNIX manual page:
|
|
24
24
|
|
|
25
|
-
|
|
26
|
-
|
|
25
|
+
```sh
|
|
26
|
+
md2man-roff EXAMPLE.markdown > EXAMPLE.1
|
|
27
|
+
man -l EXAMPLE.1
|
|
28
|
+
```
|
|
27
29
|
|
|
28
30
|
|
|
29
31
|
|
|
30
32
|
Also try converting [that example Markdown file][example] into a web page:
|
|
31
33
|
|
|
32
|
-
|
|
33
|
-
|
|
34
|
+
```sh
|
|
35
|
+
md2man-html EXAMPLE.markdown > EXAMPLE.html
|
|
36
|
+
open EXAMPLE.html
|
|
37
|
+
```
|
|
34
38
|
|
|
35
39
|
## Installation
|
|
36
40
|
|
|
37
|
-
|
|
41
|
+
```sh
|
|
42
|
+
gem install md2man
|
|
43
|
+
```
|
|
38
44
|
|
|
39
45
|
### Development
|
|
40
46
|
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
+
```sh
|
|
48
|
+
git clone https://github.com/sunaku/md2man
|
|
49
|
+
cd md2man
|
|
50
|
+
bundle install
|
|
51
|
+
bundle exec rake --tasks # packaging tasks
|
|
52
|
+
bundle exec md2man-roff --help # run it directly
|
|
53
|
+
bundle exec md2man-html --help # run it directly
|
|
54
|
+
```
|
|
47
55
|
|
|
48
56
|
## Usage
|
|
49
57
|
|
|
@@ -53,45 +61,55 @@ Also try converting [that example Markdown file][example] into a web page:
|
|
|
53
61
|
|
|
54
62
|
See md2man-roff(1) manual:
|
|
55
63
|
|
|
56
|
-
|
|
64
|
+
```sh
|
|
65
|
+
md2man-roff --help
|
|
66
|
+
```
|
|
57
67
|
|
|
58
68
|
#### Inside a Ruby script
|
|
59
69
|
|
|
60
70
|
Use the default renderer:
|
|
61
71
|
|
|
62
|
-
|
|
72
|
+
```ruby
|
|
73
|
+
require 'md2man/roff/engine'
|
|
63
74
|
|
|
64
|
-
|
|
75
|
+
your_roff_output = Md2Man::Roff::ENGINE.render(your_markdown_input)
|
|
76
|
+
```
|
|
65
77
|
|
|
66
78
|
Build your own renderer:
|
|
67
79
|
|
|
68
|
-
|
|
80
|
+
```ruby
|
|
81
|
+
require 'md2man/roff/engine'
|
|
69
82
|
|
|
70
|
-
|
|
71
|
-
|
|
83
|
+
engine = Redcarpet::Markdown.new(Md2Man::Roff::Engine, your_options_hash)
|
|
84
|
+
your_roff_output = engine.render(your_markdown_input)
|
|
85
|
+
```
|
|
72
86
|
|
|
73
87
|
Define your own renderer:
|
|
74
88
|
|
|
75
|
-
|
|
89
|
+
```ruby
|
|
90
|
+
require 'md2man/roff/engine'
|
|
76
91
|
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
92
|
+
class YourManpageRenderer < Md2Man::Roff::Engine
|
|
93
|
+
# ... your stuff here ...
|
|
94
|
+
end
|
|
80
95
|
|
|
81
|
-
|
|
82
|
-
|
|
96
|
+
engine = Redcarpet::Markdown.new(YourManpageRenderer, your_options_hash)
|
|
97
|
+
your_roff_output = engine.render(your_markdown_input)
|
|
98
|
+
```
|
|
83
99
|
|
|
84
100
|
Mix-in your own renderer:
|
|
85
101
|
|
|
86
|
-
|
|
102
|
+
```ruby
|
|
103
|
+
require 'md2man/roff'
|
|
87
104
|
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
105
|
+
class YourManpageRenderer < Redcarpet::Render::Base
|
|
106
|
+
include Md2Man::Roff
|
|
107
|
+
# ... your stuff here ...
|
|
108
|
+
end
|
|
92
109
|
|
|
93
|
-
|
|
94
|
-
|
|
110
|
+
engine = Redcarpet::Markdown.new(YourManpageRenderer, your_options_hash)
|
|
111
|
+
your_roff_output = engine.render(your_markdown_input)
|
|
112
|
+
```
|
|
95
113
|
|
|
96
114
|
### For HTML output
|
|
97
115
|
|
|
@@ -99,45 +117,55 @@ Mix-in your own renderer:
|
|
|
99
117
|
|
|
100
118
|
See md2man-html(1) manual:
|
|
101
119
|
|
|
102
|
-
|
|
120
|
+
```sh
|
|
121
|
+
md2man-html --help
|
|
122
|
+
```
|
|
103
123
|
|
|
104
124
|
#### Inside a Ruby script
|
|
105
125
|
|
|
106
126
|
Use the default renderer:
|
|
107
127
|
|
|
108
|
-
|
|
128
|
+
```ruby
|
|
129
|
+
require 'md2man/html/engine'
|
|
109
130
|
|
|
110
|
-
|
|
131
|
+
your_html_output = Md2Man::HTML::ENGINE.render(your_markdown_input)
|
|
132
|
+
```
|
|
111
133
|
|
|
112
134
|
Build your own renderer:
|
|
113
135
|
|
|
114
|
-
|
|
136
|
+
```ruby
|
|
137
|
+
require 'md2man/html/engine'
|
|
115
138
|
|
|
116
|
-
|
|
117
|
-
|
|
139
|
+
engine = Redcarpet::Markdown.new(Md2Man::HTML::Engine, your_options_hash)
|
|
140
|
+
your_html_output = engine.render(your_markdown_input)
|
|
141
|
+
```
|
|
118
142
|
|
|
119
143
|
Define your own renderer:
|
|
120
144
|
|
|
121
|
-
|
|
145
|
+
```ruby
|
|
146
|
+
require 'md2man/html/engine'
|
|
122
147
|
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
148
|
+
class YourManpageRenderer < Md2Man::HTML::Engine
|
|
149
|
+
# ... your stuff here ...
|
|
150
|
+
end
|
|
126
151
|
|
|
127
|
-
|
|
128
|
-
|
|
152
|
+
engine = Redcarpet::Markdown.new(YourManpageRenderer, your_options_hash)
|
|
153
|
+
your_html_output = engine.render(your_markdown_input)
|
|
154
|
+
```
|
|
129
155
|
|
|
130
156
|
Mix-in your own renderer:
|
|
131
157
|
|
|
132
|
-
|
|
158
|
+
```ruby
|
|
159
|
+
require 'md2man/html'
|
|
133
160
|
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
161
|
+
class YourManpageRenderer < Redcarpet::Render::Base
|
|
162
|
+
include Md2Man::HTML
|
|
163
|
+
# ... your stuff here ...
|
|
164
|
+
end
|
|
138
165
|
|
|
139
|
-
|
|
140
|
-
|
|
166
|
+
engine = Redcarpet::Markdown.new(YourManpageRenderer, your_options_hash)
|
|
167
|
+
your_html_output = engine.render(your_markdown_input)
|
|
168
|
+
```
|
|
141
169
|
|
|
142
170
|
### Building man pages
|
|
143
171
|
|
|
@@ -145,19 +173,25 @@ Mix-in your own renderer:
|
|
|
145
173
|
|
|
146
174
|
See md2man-rake(1) manual:
|
|
147
175
|
|
|
148
|
-
|
|
176
|
+
```sh
|
|
177
|
+
md2man-rake --help
|
|
178
|
+
```
|
|
149
179
|
|
|
150
180
|
#### Inside a Ruby script
|
|
151
181
|
|
|
152
182
|
Add this snippet to your gemspec file:
|
|
153
183
|
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
184
|
+
```ruby
|
|
185
|
+
s.files += Dir['man/man?/*.?'] # UNIX man pages
|
|
186
|
+
s.files += Dir['man/**/*.{html,css,js}'] # HTML man pages
|
|
187
|
+
s.add_development_dependency 'md2man', '~> 5.0'
|
|
188
|
+
```
|
|
157
189
|
|
|
158
190
|
Add this line to your Rakefile:
|
|
159
191
|
|
|
160
|
-
|
|
192
|
+
```ruby
|
|
193
|
+
require 'md2man/rakefile'
|
|
194
|
+
```
|
|
161
195
|
|
|
162
196
|
You now have a `rake md2man` task that builds manual pages from Markdown files
|
|
163
197
|
(with ".markdown", ".mkd", or ".md" extension) inside `man/man*/` directories.
|
|
@@ -166,8 +200,10 @@ There are also sub-tasks to build manual pages individually as [roff] or HTML.
|
|
|
166
200
|
If you're using Bundler, this task also hooks into Bundler's gem packaging
|
|
167
201
|
tasks and ensures that your manual pages are built for packaging into a gem:
|
|
168
202
|
|
|
169
|
-
|
|
170
|
-
|
|
203
|
+
```ruby
|
|
204
|
+
bundle exec rake build
|
|
205
|
+
gem spec pkg/*.gem | fgrep man/
|
|
206
|
+
```
|
|
171
207
|
|
|
172
208
|
## License
|
|
173
209
|
|
data/VERSION.markdown
CHANGED
|
@@ -1,3 +1,16 @@
|
|
|
1
|
+
## Version 5.0.1 (2016-02-13)
|
|
2
|
+
|
|
3
|
+
### Major:
|
|
4
|
+
|
|
5
|
+
* `md2man-html` now puts permalinks _after_ heading text to avoid unsightly
|
|
6
|
+
gaps at the beginning of each heading in text-mode browsers like w3m(1).
|
|
7
|
+
|
|
8
|
+
* Upgrade to binman version 5.0.0, which is also a major version bump.
|
|
9
|
+
|
|
10
|
+
### Other:
|
|
11
|
+
|
|
12
|
+
* README: use fenced code blocks to get syntax highlighting on GitHub.
|
|
13
|
+
|
|
1
14
|
## Version 4.0.1 (2016-02-10)
|
|
2
15
|
|
|
3
16
|
### Other:
|
data/bin/md2man-html
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
#!/usr/bin/env ruby
|
|
2
2
|
=begin =======================================================================
|
|
3
3
|
|
|
4
|
-
# MD2MAN-HTML 1 2016-02-
|
|
4
|
+
# MD2MAN-HTML 1 2016-02-13 5.0.1
|
|
5
5
|
|
|
6
6
|
## NAME
|
|
7
7
|
|
|
@@ -36,19 +36,19 @@ lowercase, and squeezed and stripped of HTML tags and non-word characters.
|
|
|
36
36
|
|
|
37
37
|
For example, a heading labeled `Ver<s>iON 3(2</s>!4)))` would be emitted as:
|
|
38
38
|
|
|
39
|
-
<h2 id="ver-ion-3-2-4"
|
|
40
|
-
class="md2man-permalink" title="permalink"></a
|
|
39
|
+
<h2 id="ver-ion-3-2-4">Ver<s>iON 3(2</s>!4)))<a name="ver-ion-3-2-4"
|
|
40
|
+
href="#ver-ion-3-2-4" class="md2man-permalink" title="permalink"></a></h2>
|
|
41
41
|
|
|
42
42
|
For example, multiple headings labeled `Hello, world!` would be emitted as:
|
|
43
43
|
|
|
44
|
-
<h2 id="hello-world"
|
|
45
|
-
class="md2man-permalink" title="permalink"></a
|
|
44
|
+
<h2 id="hello-world">Hello, world!<a name="hello-world"
|
|
45
|
+
href="#hello-world" class="md2man-permalink" title="permalink"></a></h2>
|
|
46
46
|
|
|
47
|
-
<h2 id="hello-world-1"
|
|
48
|
-
class="md2man-permalink" title="permalink"></a
|
|
47
|
+
<h2 id="hello-world-1">Hello, world!<a name="hello-world-1"
|
|
48
|
+
href="#hello-world-1" class="md2man-permalink" title="permalink"></a></h2>
|
|
49
49
|
|
|
50
|
-
<h2 id="hello-world-2"
|
|
51
|
-
class="md2man-permalink" title="permalink"></a
|
|
50
|
+
<h2 id="hello-world-2">Hello, world!<a name="hello-world-2"
|
|
51
|
+
href="#hello-world-2" class="md2man-permalink" title="permalink"></a></h2>
|
|
52
52
|
|
|
53
53
|
### Cross references
|
|
54
54
|
|
data/bin/md2man-rake
CHANGED
data/bin/md2man-roff
CHANGED
data/lib/md2man/html.rb
CHANGED
|
@@ -56,8 +56,8 @@ module Md2Man::HTML
|
|
|
56
56
|
|
|
57
57
|
[
|
|
58
58
|
%{<h#{level} id="#{id}">},
|
|
59
|
-
%{<a name="#{id}" href="##{id}" class="md2man-permalink" title="permalink"></a>},
|
|
60
59
|
text,
|
|
60
|
+
%{<a name="#{id}" href="##{id}" class="md2man-permalink" title="permalink"></a>},
|
|
61
61
|
"</h#{level}>",
|
|
62
62
|
].join
|
|
63
63
|
end
|
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 5.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 5.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"><
|
|
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" title="permalink"></a></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>Manuals: <a href="https://sunaku.github.io/md2man/man">https://sunaku.github.io/md2man/man</a></li>
|
|
@@ -15,31 +15,31 @@
|
|
|
15
15
|
<li>Support: <a href="https://github.com/sunaku/md2man/issues">https://github.com/sunaku/md2man/issues</a></li>
|
|
16
16
|
<li>Package: <a href="https://rubygems.org/gems/md2man">https://rubygems.org/gems/md2man</a></li>
|
|
17
17
|
</ul>
|
|
18
|
-
<h2 id="features"
|
|
18
|
+
<h2 id="features">Features<a name="features" href="#features" class="md2man-permalink" title="permalink"></a></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="demonstration"
|
|
25
|
+
<h3 id="demonstration">Demonstration<a name="demonstration" href="#demonstration" class="md2man-permalink" title="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><pre><code>md2man-roff EXAMPLE.markdown > EXAMPLE.1
|
|
26
26
|
man -l EXAMPLE.1
|
|
27
27
|
</code></pre>
|
|
28
28
|
<p><img src="EXAMPLE.png" alt="Obligatory screenshot of md2man(1) in action!"></p><p>Also try converting <a href="https://raw.github.com/sunaku/md2man/master/EXAMPLE.markdown">that example Markdown file</a> into a web page:</p><pre><code>md2man-html EXAMPLE.markdown > EXAMPLE.html
|
|
29
29
|
open EXAMPLE.html
|
|
30
30
|
</code></pre>
|
|
31
|
-
<h2 id="installation"
|
|
31
|
+
<h2 id="installation">Installation<a name="installation" href="#installation" class="md2man-permalink" title="permalink"></a></h2><pre><code>gem install md2man
|
|
32
32
|
</code></pre>
|
|
33
|
-
<h3 id="development"
|
|
33
|
+
<h3 id="development">Development<a name="development" href="#development" class="md2man-permalink" title="permalink"></a></h3><pre><code>git clone https://github.com/sunaku/md2man
|
|
34
34
|
cd md2man
|
|
35
35
|
bundle install
|
|
36
36
|
bundle exec rake --tasks # packaging tasks
|
|
37
37
|
bundle exec md2man-roff --help # run it directly
|
|
38
38
|
bundle exec md2man-html --help # run it directly
|
|
39
39
|
</code></pre>
|
|
40
|
-
<h2 id="usage"
|
|
40
|
+
<h2 id="usage">Usage<a name="usage" href="#usage" class="md2man-permalink" title="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" title="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" title="permalink"></a></h4><p>See <a class="md2man-reference" href="../man1/md2man-roff.1.html">md2man-roff(1)</a> manual:</p><pre><code>md2man-roff --help
|
|
41
41
|
</code></pre>
|
|
42
|
-
<h4 id="inside-a-ruby-script"
|
|
42
|
+
<h4 id="inside-a-ruby-script">Inside a Ruby script<a name="inside-a-ruby-script" href="#inside-a-ruby-script" class="md2man-permalink" title="permalink"></a></h4><p>Use the default renderer:</p><pre><code>require 'md2man/roff/engine'
|
|
43
43
|
|
|
44
44
|
your_roff_output = Md2Man::Roff::ENGINE.render(your_markdown_input)
|
|
45
45
|
</code></pre>
|
|
@@ -67,9 +67,9 @@ end
|
|
|
67
67
|
engine = Redcarpet::Markdown.new(YourManpageRenderer, your_options_hash)
|
|
68
68
|
your_roff_output = engine.render(your_markdown_input)
|
|
69
69
|
</code></pre>
|
|
70
|
-
<h3 id="for-html-output"
|
|
70
|
+
<h3 id="for-html-output">For HTML output<a name="for-html-output" href="#for-html-output" class="md2man-permalink" title="permalink"></a></h3><h4 id="at-the-command-line-1">At the command line<a name="at-the-command-line-1" href="#at-the-command-line-1" class="md2man-permalink" title="permalink"></a></h4><p>See <a class="md2man-reference" href="../man1/md2man-html.1.html">md2man-html(1)</a> manual:</p><pre><code>md2man-html --help
|
|
71
71
|
</code></pre>
|
|
72
|
-
<h4 id="inside-a-ruby-script-1"
|
|
72
|
+
<h4 id="inside-a-ruby-script-1">Inside a Ruby script<a name="inside-a-ruby-script-1" href="#inside-a-ruby-script-1" class="md2man-permalink" title="permalink"></a></h4><p>Use the default renderer:</p><pre><code>require 'md2man/html/engine'
|
|
73
73
|
|
|
74
74
|
your_html_output = Md2Man::HTML::ENGINE.render(your_markdown_input)
|
|
75
75
|
</code></pre>
|
|
@@ -97,11 +97,11 @@ end
|
|
|
97
97
|
engine = Redcarpet::Markdown.new(YourManpageRenderer, your_options_hash)
|
|
98
98
|
your_html_output = engine.render(your_markdown_input)
|
|
99
99
|
</code></pre>
|
|
100
|
-
<h3 id="building-man-pages"
|
|
100
|
+
<h3 id="building-man-pages">Building man pages<a name="building-man-pages" href="#building-man-pages" class="md2man-permalink" title="permalink"></a></h3><h4 id="at-the-command-line-2">At the command line<a name="at-the-command-line-2" href="#at-the-command-line-2" class="md2man-permalink" title="permalink"></a></h4><p>See <a class="md2man-reference" href="../man1/md2man-rake.1.html">md2man-rake(1)</a> manual:</p><pre><code>md2man-rake --help
|
|
101
101
|
</code></pre>
|
|
102
|
-
<h4 id="inside-a-ruby-script-2"
|
|
102
|
+
<h4 id="inside-a-ruby-script-2">Inside a Ruby script<a name="inside-a-ruby-script-2" href="#inside-a-ruby-script-2" class="md2man-permalink" title="permalink"></a></h4><p>Add this snippet to your gemspec file:</p><pre><code>s.files += Dir['man/man?/*.?'] # UNIX man pages
|
|
103
103
|
s.files += Dir['man/**/*.{html,css,js}'] # HTML man pages
|
|
104
|
-
s.add_development_dependency 'md2man', '~>
|
|
104
|
+
s.add_development_dependency 'md2man', '~> 5.0'
|
|
105
105
|
</code></pre>
|
|
106
106
|
<p>Add this line to your Rakefile:</p><pre><code>require 'md2man/rakefile'
|
|
107
107
|
</code></pre>
|
|
@@ -111,5 +111,5 @@ There are also sub-tasks to build manual pages individually as <a href="http://t
|
|
|
111
111
|
tasks and ensures that your manual pages are built for packaging into a gem:</p><pre><code>bundle exec rake build
|
|
112
112
|
gem spec pkg/*.gem | fgrep man/
|
|
113
113
|
</code></pre>
|
|
114
|
-
<h2 id="license"
|
|
114
|
+
<h2 id="license">License<a name="license" href="#license" class="md2man-permalink" title="permalink"></a></h2><p>Released under the ISC license. See the LICENSE file for details.</p></div></body>
|
|
115
115
|
</html>
|
data/man/man0/VERSION.html
CHANGED
|
@@ -2,18 +2,28 @@
|
|
|
2
2
|
<html>
|
|
3
3
|
<head>
|
|
4
4
|
<meta charset="utf-8" />
|
|
5
|
-
<meta name="generator" content="md2man
|
|
5
|
+
<meta name="generator" content="md2man 5.0.0 https://github.com/sunaku/md2man" />
|
|
6
6
|
<title>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-
|
|
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-5-0-1-2016-02-13">Version 5.0.1 (2016-02-13)<a name="version-5-0-1-2016-02-13" href="#version-5-0-1-2016-02-13" class="md2man-permalink" title="permalink"></a></h2><h3 id="major">Major:<a name="major" href="#major" class="md2man-permalink" title="permalink"></a></h3>
|
|
11
|
+
<ul>
|
|
12
|
+
<li><p><code>md2man-html</code> now puts permalinks <em>after</em> heading text to avoid unsightly
|
|
13
|
+
gaps at the beginning of each heading in text-mode browsers like <a class="md2man-reference">w3m(1)</a>.</p></li>
|
|
14
|
+
<li><p>Upgrade to binman version 5.0.0, which is also a major version bump.</p></li>
|
|
15
|
+
</ul>
|
|
16
|
+
<h3 id="other">Other:<a name="other" href="#other" class="md2man-permalink" title="permalink"></a></h3>
|
|
17
|
+
<ul>
|
|
18
|
+
<li>README: use fenced code blocks to get syntax highlighting on GitHub.</li>
|
|
19
|
+
</ul>
|
|
20
|
+
<h2 id="version-4-0-1-2016-02-10">Version 4.0.1 (2016-02-10)<a name="version-4-0-1-2016-02-10" href="#version-4-0-1-2016-02-10" class="md2man-permalink" title="permalink"></a></h2><h3 id="other-1">Other:<a name="other-1" href="#other-1" class="md2man-permalink" title="permalink"></a></h3>
|
|
11
21
|
<ul>
|
|
12
22
|
<li><p>Make all permalinks appear in the same size.</p></li>
|
|
13
23
|
<li><p>Change permalink symbols from hearts to stars.</p></li>
|
|
14
24
|
<li><p>Indicate target heading with a red permalink.</p></li>
|
|
15
25
|
</ul>
|
|
16
|
-
<h2 id="version-4-0-0-2014-10-26"
|
|
26
|
+
<h2 id="version-4-0-0-2014-10-26">Version 4.0.0 (2014-10-26)<a name="version-4-0-0-2014-10-26" href="#version-4-0-0-2014-10-26" class="md2man-permalink" title="permalink"></a></h2><h3 id="major-1">Major:<a name="major-1" href="#major-1" class="md2man-permalink" title="permalink"></a></h3>
|
|
17
27
|
<ul>
|
|
18
28
|
<li><p>Cross references are no longer expanded inside code spans and code blocks.</p><p>Thanks to Mathias Panzenböck for reporting this issue in GH-19:
|
|
19
29
|
<a href="https://github.com/sunaku/md2man/issues/19">https://github.com/sunaku/md2man/issues/19</a></p></li>
|
|
@@ -25,11 +35,11 @@ call <code>super()</code> therein to trigger these methods' original impleme
|
|
|
25
35
|
<li><code>Md2Man::Document#codespan(code)</code></li>
|
|
26
36
|
</ul></li>
|
|
27
37
|
</ul>
|
|
28
|
-
<h2 id="version-3-0-2-2014-10-26"
|
|
38
|
+
<h2 id="version-3-0-2-2014-10-26">Version 3.0.2 (2014-10-26)<a name="version-3-0-2-2014-10-26" href="#version-3-0-2-2014-10-26" class="md2man-permalink" title="permalink"></a></h2><h3 id="patch">Patch:<a name="patch" href="#patch" class="md2man-permalink" title="permalink"></a></h3>
|
|
29
39
|
<ul>
|
|
30
40
|
<li>Update bootstrap 2.3.2 CDN URL; previous one died.</li>
|
|
31
41
|
</ul>
|
|
32
|
-
<h2 id="version-3-0-1-2014-07-16"
|
|
42
|
+
<h2 id="version-3-0-1-2014-07-16">Version 3.0.1 (2014-07-16)<a name="version-3-0-1-2014-07-16" href="#version-3-0-1-2014-07-16" class="md2man-permalink" title="permalink"></a></h2><p>This release restores Mac OS X support and fixes a permalink generation bug.</p><h3 id="patch-1">Patch:<a name="patch-1" href="#patch-1" class="md2man-permalink" title="permalink"></a></h3>
|
|
33
43
|
<ul>
|
|
34
44
|
<li><p>GH-13: <a class="md2man-reference">man(1)</a> on Mac OS X could not display URLs.</p><p>The version of groff on Mac OS X is too old: it lacks the an-ext.tmac
|
|
35
45
|
macro package that defines styles for email addresses and general URLs.</p><pre><code>$ groff --version
|
|
@@ -39,35 +49,35 @@ GNU troff (groff) version 1.19.2
|
|
|
39
49
|
</code></pre>
|
|
40
50
|
<p>This patch drops those URL macros in favor of simpler angled brackets.</p><p>Thanks to Sorin Ionescu for reporting this issue in GH-13:
|
|
41
51
|
<a href="https://github.com/sunaku/md2man/issues/13">https://github.com/sunaku/md2man/issues/13</a></p></li>
|
|
42
|
-
<li><p><a class="md2man-reference">md2man-html(1)</a>: cross references were escaped in heading permalink IDs.</p></li>
|
|
52
|
+
<li><p><a class="md2man-reference" href="../man1/md2man-html.1.html">md2man-html(1)</a>: cross references were escaped in heading permalink IDs.</p></li>
|
|
43
53
|
</ul>
|
|
44
|
-
<h2 id="version-3-0-0-2014-06-22"
|
|
54
|
+
<h2 id="version-3-0-0-2014-06-22">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></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:
|
|
45
55
|
unique, lowercase, and squeezed and stripped of HTML tags and non-word chars.
|
|
46
56
|
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
|
|
47
|
-
have for jumping to specific locations in your HTML manuals after upgrading.</p><h3 id="major-
|
|
57
|
+
have for jumping to specific locations in your HTML manuals after upgrading.</p><h3 id="major-2">Major:<a name="major-2" href="#major-2" class="md2man-permalink" title="permalink"></a></h3>
|
|
48
58
|
<ul>
|
|
49
|
-
<li><p>Make permalink anchors on headings fully lowercase in <a class="md2man-reference">md2man-html(1)</a>.</p></li>
|
|
50
|
-
<li><p>Put permalinks on left & indicate target permalink in <a class="md2man-reference">md2man-html(1)</a>.</p></li>
|
|
51
|
-
<li><p>Make permalink anchors unique by appending a count in <a class="md2man-reference">md2man-html(1)</a>.</p></li>
|
|
52
|
-
<li><p>Rename <code>md2man-xref</code> CSS class to <code>md2man-reference</code> in <a class="md2man-reference">md2man-html(1)</a>.</p></li>
|
|
59
|
+
<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>
|
|
60
|
+
<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>
|
|
61
|
+
<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>
|
|
62
|
+
<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>
|
|
53
63
|
</ul>
|
|
54
|
-
<h2 id="version-2-1-1-2014-06-21"
|
|
64
|
+
<h2 id="version-2-1-1-2014-06-21">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></h2><h3 id="patch-2">Patch:<a name="patch-2" href="#patch-2" class="md2man-permalink" title="permalink"></a></h3>
|
|
55
65
|
<ul>
|
|
56
66
|
<li><p>Bootstrap CSS failed to load for HTML manuals served under HTTPS.
|
|
57
67
|
See <a href="https://github.com/sunaku/readably/pull/3">https://github.com/sunaku/readably/pull/3</a> for the details.</p></li>
|
|
58
68
|
<li><p>Drop redundant nil check in <code>Md2Man::Roff::Engine.escape()</code>.</p></li>
|
|
59
69
|
</ul>
|
|
60
|
-
<h3 id="other-
|
|
70
|
+
<h3 id="other-2">Other:<a name="other-2" href="#other-2" class="md2man-permalink" title="permalink"></a></h3>
|
|
61
71
|
<ul>
|
|
62
72
|
<li><p>GitHub now supports relative links from the README.</p></li>
|
|
63
73
|
<li><p>README: add links to package, manuals, and GitHub.</p></li>
|
|
64
74
|
</ul>
|
|
65
|
-
<h2 id="version-2-1-0-2014-05-04"
|
|
75
|
+
<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" title="permalink"></a></h2><h3 id="minor">Minor:<a name="minor" href="#minor" class="md2man-permalink" title="permalink"></a></h3>
|
|
66
76
|
<ul>
|
|
67
|
-
<li><p><a class="md2man-reference">md2man-html(1)</a> now adds anchors and permalinks to all headings. This
|
|
77
|
+
<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
|
|
68
78
|
makes it easy for readers to bookmark and share direct links to specific
|
|
69
79
|
sections of your HTML manual pages.</p></li>
|
|
70
|
-
<li><p><a class="md2man-reference">md2man-html(1)</a> now wraps individual components of the special <code>.TH</code>
|
|
80
|
+
<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>
|
|
71
81
|
top-level heading in HTML <code><span></code> elements with stylable CSS classes:</p><pre><code><span class="md2man-title">...</span>
|
|
72
82
|
<span class="md2man-section">...</span>
|
|
73
83
|
<span class="md2man-date">...</span>
|
|
@@ -76,23 +86,23 @@ top-level heading in HTML <code><span></code> elements with stylable CSS c
|
|
|
76
86
|
</code></pre>
|
|
77
87
|
<p>Thanks to Nick Fagerlund for requesting this feature in <a href="https://github.com/sunaku/md2man/issues/15">GH-15</a>.</p></li>
|
|
78
88
|
</ul>
|
|
79
|
-
<h3 id="other-
|
|
89
|
+
<h3 id="other-3">Other:<a name="other-3" href="#other-3" class="md2man-permalink" title="permalink"></a></h3>
|
|
80
90
|
<ul>
|
|
81
91
|
<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>
|
|
82
92
|
</ul>
|
|
83
|
-
<h2 id="version-2-0-4-2014-04-26"
|
|
93
|
+
<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" title="permalink"></a></h2><h3 id="patch-3">Patch:<a name="patch-3" href="#patch-3" class="md2man-permalink" title="permalink"></a></h3>
|
|
84
94
|
<ul>
|
|
85
95
|
<li><p>GH-16: Redcarpet 3.1 added a third parameter to its <code>header()</code> method.
|
|
86
96
|
This raised an ArgumentError on "wrong number of arguments (3 for 2)".</p><p>Thanks to zimbatm for contributing this patch.</p></li>
|
|
87
97
|
<li><p>GH-17 and GH-18: Escape periods, quotes, and hyphens in code blocks.
|
|
88
98
|
This fixes a bug where lines beginning with periods or single quotes
|
|
89
|
-
did not appear when <a class="md2man-reference">md2man-roff(1)</a> output was rendered using <a class="md2man-reference">man(1)</a>.</p><p>Thanks to zimbatm for reporting this bug and suggesting how to fix it.</p></li>
|
|
99
|
+
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>
|
|
90
100
|
</ul>
|
|
91
|
-
<h2 id="version-2-0-3-2014-01-16"
|
|
101
|
+
<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" title="permalink"></a></h2><h3 id="patch-4">Patch:<a name="patch-4" href="#patch-4" class="md2man-permalink" title="permalink"></a></h3>
|
|
92
102
|
<ul>
|
|
93
103
|
<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>
|
|
94
104
|
</ul>
|
|
95
|
-
<h2 id="version-2-0-2-2013-09-08"
|
|
105
|
+
<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" title="permalink"></a></h2><p>Patch:</p>
|
|
96
106
|
<ul>
|
|
97
107
|
<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>
|
|
98
108
|
<li><p>escape periods at line beginnings with & escape</p></li>
|
|
@@ -104,7 +114,7 @@ did not appear when <a class="md2man-reference">md2man-roff(1)</a> output was re
|
|
|
104
114
|
<ul>
|
|
105
115
|
<li>switch from double-quoted strings to single quotes</li>
|
|
106
116
|
</ul>
|
|
107
|
-
<h2 id="version-2-0-1-2013-08-29"
|
|
117
|
+
<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" title="permalink"></a></h2><p>Patch:</p>
|
|
108
118
|
<ul>
|
|
109
119
|
<li><p>Use a proper CDN to access Bootstrap 2.3.2 styling in HTML output.</p></li>
|
|
110
120
|
<li><p>Ensure that man/ directory exists for the <code>md2man:web</code> Rake task.</p></li>
|
|
@@ -115,10 +125,10 @@ did not appear when <a class="md2man-reference">md2man-roff(1)</a> output was re
|
|
|
115
125
|
<li><p>Upgrade dependent gems by running <code>bundle update</code>.</p></li>
|
|
116
126
|
<li><p>minitest 4.7.5 provides spec library via autorun.</p></li>
|
|
117
127
|
</ul>
|
|
118
|
-
<h2 id="version-2-0-0-2013-05-05"
|
|
128
|
+
<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" title="permalink"></a></h2><p>This release renames md2man executables and libraries to highlight the fact
|
|
119
129
|
that md2man provides two processing pathways: one for Roff and one for HTML.</p><p>Major:</p>
|
|
120
130
|
<ul>
|
|
121
|
-
<li><p>Rename <a class="md2man-reference">md2man(1)</a> executable to <a class="md2man-reference">md2man-roff(1)</a>.</p></li>
|
|
131
|
+
<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>
|
|
122
132
|
<li><p>Rename <code>Md2Man::Engine</code> to <code>Md2Man::Roff::Engine</code>.</p></li>
|
|
123
133
|
<li><p>Rename "manpage-reference" CSS class to "md2man-xref" in HTML output.</p></li>
|
|
124
134
|
<li><p>The <code>Md2Man::Document#reference()</code> method now takes only two parameters:</p>
|
|
@@ -147,13 +157,13 @@ the output document</li>
|
|
|
147
157
|
<ul>
|
|
148
158
|
<li>Add <a class="md2man-reference" href="../man5/md2man.5.html">md2man(5)</a> manual page detailing md2man's markdown file format.</li>
|
|
149
159
|
</ul>
|
|
150
|
-
<h2 id="version-1-6-2-2013-05-05"
|
|
160
|
+
<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" title="permalink"></a></h2><p>Patch:</p>
|
|
151
161
|
<ul>
|
|
152
162
|
<li><p>Fix "uninitialized constant Md2Man::VERSION" error in <code>md2man/rakefile</code>.</p></li>
|
|
153
163
|
<li><p>HTML manual page CSS: justify the lines of text just like <a class="md2man-reference">man(1)</a> does.</p></li>
|
|
154
164
|
<li><p>HTML manual page CSS: resize body to allot 78ex width for manpage text.</p></li>
|
|
155
165
|
</ul>
|
|
156
|
-
<h2 id="version-1-6-1-2013-05-04"
|
|
166
|
+
<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" title="permalink"></a></h2><p>Patch:</p>
|
|
157
167
|
<ul>
|
|
158
168
|
<li>Replace multi-column CSS with single centered body.</li>
|
|
159
169
|
</ul>
|
|
@@ -161,9 +171,9 @@ the output document</li>
|
|
|
161
171
|
<ul>
|
|
162
172
|
<li>Fix manpage xrefs in README and VERSION documents.</li>
|
|
163
173
|
</ul>
|
|
164
|
-
<h2 id="version-1-6-0-2013-03-10"
|
|
174
|
+
<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" title="permalink"></a></h2><p>Minor:</p>
|
|
165
175
|
<ul>
|
|
166
|
-
<li><p>Added an <a class="md2man-reference">md2man-rake(1)</a> executable that lets you run md2man's <a class="md2man-reference">rake(1)</a>
|
|
176
|
+
<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>
|
|
167
177
|
tasks <em>directly</em> from the command line: without the need for a "Rakefile"
|
|
168
178
|
in your working directory that loads the <code>md2man/rakefile</code> library.</p></li>
|
|
169
179
|
<li><p>In web pages generated by the <code>md2man:web</code> Rake task:</p>
|
|
@@ -183,7 +193,7 @@ in your working directory that loads the <code>md2man/rakefile</code> library.</
|
|
|
183
193
|
<ul>
|
|
184
194
|
<li>add README and VERSION to generated HTML man pages</li>
|
|
185
195
|
</ul>
|
|
186
|
-
<h2 id="version-1-5-1-2013-03-06"
|
|
196
|
+
<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" title="permalink"></a></h2><p>Patch:</p>
|
|
187
197
|
<ul>
|
|
188
198
|
<li><p>All this time, this project's documentation stated that Redcarpet's
|
|
189
199
|
<code>no_intra_emphasis</code> option was enabled, but in reality, it was not.
|
|
@@ -204,7 +214,7 @@ The documentation has been corrected and the option remains disabled.</p></li>
|
|
|
204
214
|
<li><p>rename HISTORY to VERSION so it sorts after README</p></li>
|
|
205
215
|
<li><p>tests should exercise engines with default options</p></li>
|
|
206
216
|
</ul>
|
|
207
|
-
<h2 id="version-1-5-0-2013-02-24"
|
|
217
|
+
<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" title="permalink"></a></h2><p>Minor:</p>
|
|
208
218
|
<ul>
|
|
209
219
|
<li><p>The <code>md2man:web</code> task from <code>md2man/rakefile</code> now:</p>
|
|
210
220
|
<ul>
|
|
@@ -218,7 +228,7 @@ The documentation has been corrected and the option remains disabled.</p></li>
|
|
|
218
228
|
<li><p>README: better organize the subsections of "Usage"</p></li>
|
|
219
229
|
<li><p>include md2man rake tasks in developer's rakefile</p></li>
|
|
220
230
|
</ul>
|
|
221
|
-
<h2 id="version-1-4-1-2013-02-23"
|
|
231
|
+
<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" title="permalink"></a></h2><p>Patch:</p>
|
|
222
232
|
<ul>
|
|
223
233
|
<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>
|
|
224
234
|
<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>
|
|
@@ -226,14 +236,14 @@ The documentation has been corrected and the option remains disabled.</p></li>
|
|
|
226
236
|
</ul>
|
|
227
237
|
<p>Other:</p>
|
|
228
238
|
<ul>
|
|
229
|
-
<li><p>README: add <a class="md2man-reference">md2man-html(1)</a> and Md2Man::HTML usage</p></li>
|
|
239
|
+
<li><p>README: add <a class="md2man-reference" href="../man1/md2man-html.1.html">md2man-html(1)</a> and Md2Man::HTML usage</p></li>
|
|
230
240
|
<li><p>LICENSE: use GitHub profile URLs instead of e-mail</p></li>
|
|
231
241
|
</ul>
|
|
232
|
-
<h2 id="version-1-4-0-2012-10-14"
|
|
242
|
+
<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" title="permalink"></a></h2><p>Minor:</p>
|
|
233
243
|
<ul>
|
|
234
244
|
<li><p>roff: emit non-first H1 headings as H2 headings</p></li>
|
|
235
245
|
<li><p>html: add <code>Md2Man::HTML::Engine</code> class for HTML manual page generation</p></li>
|
|
236
|
-
<li><p>html: add <a class="md2man-reference">md2man-html(1)</a> bin script for command line access to the above</p></li>
|
|
246
|
+
<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>
|
|
237
247
|
<li><p>html: add ID attributes on all headings for easy permalinking</p></li>
|
|
238
248
|
<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
|
|
239
249
|
manual pages from Markdown files (with ".markdown", ".mkd", or ".md"
|
|
@@ -241,12 +251,12 @@ extension) inside your <code>man/man*/</code> directories. It also provides
|
|
|
241
251
|
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
|
|
242
252
|
your manual pages for packaging into a gem. See the README for details.</p></li>
|
|
243
253
|
</ul>
|
|
244
|
-
<h2 id="version-1-3-2-2012-10-13"
|
|
254
|
+
<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" title="permalink"></a></h2><p>Patch:</p>
|
|
245
255
|
<ul>
|
|
246
256
|
<li><p>roff: escape backslashes inside codespan nodes too</p></li>
|
|
247
257
|
<li><p>roff: escape backslashes inside block_code nodes</p></li>
|
|
248
258
|
</ul>
|
|
249
|
-
<h2 id="version-1-3-1-2012-10-09"
|
|
259
|
+
<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" title="permalink"></a></h2><p>Patch:</p>
|
|
250
260
|
<ul>
|
|
251
261
|
<li><p>roff: do not render references inside code blocks.</p></li>
|
|
252
262
|
<li><p>roff: do not render references inside code spans.</p></li>
|
|
@@ -263,13 +273,13 @@ the code block: it appears on the next line and appears ugly in <a class="md2man
|
|
|
263
273
|
<li><p>document: super() can't reach Redcarpet's renderer classes.
|
|
264
274
|
See <a href="https://github.com/vmg/redcarpet/issues/51">https://github.com/vmg/redcarpet/issues/51</a> for details.</p></li>
|
|
265
275
|
</ul>
|
|
266
|
-
<h2 id="version-1-3-0-2012-09-27"
|
|
276
|
+
<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" title="permalink"></a></h2><p>Minor:</p>
|
|
267
277
|
<ul>
|
|
268
278
|
<li>Intra-word emphasis is now enabled <em>by default</em> in <code>Md2Man::ENGINE</code>.
|
|
269
279
|
To not be affected by this change, you may still construct your own
|
|
270
280
|
Redcarpet::Markdown engine with your own set of processing options.</li>
|
|
271
281
|
</ul>
|
|
272
|
-
<h2 id="version-1-2-1-2012-07-05"
|
|
282
|
+
<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" title="permalink"></a></h2><p>Patch:</p>
|
|
273
283
|
<ul>
|
|
274
284
|
<li>GH-4: ruby 1.8.7 lacks negative lookbehind regexps.
|
|
275
285
|
Thanks to Postmodern for reporting this issue.</li>
|
|
@@ -280,7 +290,7 @@ Thanks to Postmodern for reporting this issue.</li>
|
|
|
280
290
|
See <a href="http://docs.rubygems.org/read/chapter/16">http://docs.rubygems.org/read/chapter/16</a>
|
|
281
291
|
Thanks to Postmodern for this contribution.</li>
|
|
282
292
|
</ul>
|
|
283
|
-
<h2 id="version-1-2-0-2012-02-06"
|
|
293
|
+
<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" title="permalink"></a></h2><p>Minor:</p>
|
|
284
294
|
<ul>
|
|
285
295
|
<li>The <code>Md2Man::Document</code> module now handles paragraph() nodes and dispatches
|
|
286
296
|
their content accordingly to hook methods for indented, tagged, and normal
|
|
@@ -293,7 +303,7 @@ to markdown syntax programmatically.</li>
|
|
|
293
303
|
<li><p>README: mention features; revise markdown; cleanup.</p></li>
|
|
294
304
|
<li><p>LICENSE: @tanoku created initial Manpage renderer.</p></li>
|
|
295
305
|
</ul>
|
|
296
|
-
<h2 id="version-1-1-0-2012-02-02"
|
|
306
|
+
<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" title="permalink"></a></h2><p>Minor:</p>
|
|
297
307
|
<ul>
|
|
298
308
|
<li>Add <code>Md2Man::Document</code> module for programmatic processing of
|
|
299
309
|
cross-references to other UNIX manual pages within Redcarpet.</li>
|
|
@@ -306,7 +316,7 @@ cross-references to other UNIX manual pages within Redcarpet.</li>
|
|
|
306
316
|
<li><p>README: fix installation commands for development.</p></li>
|
|
307
317
|
<li><p>README: simplify project slogan to be more memorable.</p></li>
|
|
308
318
|
</ul>
|
|
309
|
-
<h2 id="version-1-0-2-2012-01-09"
|
|
319
|
+
<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" title="permalink"></a></h2><p>Patch:</p>
|
|
310
320
|
<ul>
|
|
311
321
|
<li><p>Blockquote's leading paragraph regexp was not anchored.</p></li>
|
|
312
322
|
<li><p>Freezing internal constants prevents monkey patching.</p></li>
|
|
@@ -317,7 +327,7 @@ cross-references to other UNIX manual pages within Redcarpet.</li>
|
|
|
317
327
|
<li><p>Added example input file from the Linux Man Page Howto.</p></li>
|
|
318
328
|
<li><p>Forgot to change project slogan in the gem package.</p></li>
|
|
319
329
|
</ul>
|
|
320
|
-
<h2 id="version-1-0-1-2011-12-06"
|
|
330
|
+
<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" title="permalink"></a></h2><p>Major:</p>
|
|
321
331
|
<ul>
|
|
322
332
|
<li><p>Renamed the project from "redcarpet-manpage" to "md2man".</p>
|
|
323
333
|
<ul>
|
|
@@ -339,5 +349,5 @@ bold styling. All that matters is that the subsequent lines are indented.</p></
|
|
|
339
349
|
<ul>
|
|
340
350
|
<li>Rewrote entire Markdown to Roff conversion from scratch while doing TDD.</li>
|
|
341
351
|
</ul>
|
|
342
|
-
<h2 id="version-0-0-1-2011-10-13"
|
|
352
|
+
<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" title="permalink"></a></h2><p>First release! Happy birthday! Woohoo! :-)</p></div></body>
|
|
343
353
|
</html>
|