md2man 1.5.1 → 1.6.0
Sign up to get free protection for your applications and to get access to all the features.
- data/README.markdown +28 -21
- data/VERSION.markdown +24 -0
- data/bin/md2man +2 -2
- data/bin/md2man-html +1 -1
- data/bin/md2man-rake +58 -0
- data/lib/md2man/rakefile/style.css +74 -0
- data/lib/md2man/rakefile.rb +11 -63
- data/lib/md2man/version.rb +1 -1
- data/man/README.html +111 -0
- data/man/README.markdown +195 -0
- data/man/VERSION.html +189 -0
- data/man/VERSION.markdown +262 -0
- data/man/index.html +11 -0
- data/man/man1/md2man-html.1 +1 -1
- data/man/man1/md2man-html.1.html +15 -0
- data/man/man1/md2man-rake.1 +49 -0
- data/man/man1/md2man-rake.1.html +15 -0
- data/man/man1/md2man.1 +3 -2
- data/man/man1/md2man.1.html +37 -0
- data/man/style.css +74 -0
- data/md2man.gemspec +4 -1
- metadata +16 -3
data/man/VERSION.html
ADDED
|
@@ -0,0 +1,189 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8" />
|
|
5
|
+
<meta name="generator" content="md2man 1.6.0 https://github.com/sunaku/md2man" />
|
|
6
|
+
<title>VERSION</title>
|
|
7
|
+
<link rel="stylesheet" href="style.css"/>
|
|
8
|
+
<!--[if lt IE 9]><script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script><![endif]-->
|
|
9
|
+
</head>
|
|
10
|
+
<body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="index.html#man">man</a>/VERSION</span></div></div><div class="container-fluid"><div class="manpage"><h2 id="Version-1-6-0-2013-03-10">Version 1.6.0 (2013-03-10)</h2><p>Minor:</p>
|
|
11
|
+
<ul>
|
|
12
|
+
<li><p>Added an <a class="manpage-reference">md2man-rake(1)</a> executable that lets you run md2man's <a class="manpage-reference">rake(1)</a>
|
|
13
|
+
tasks <em>directly</em> from the command line: without the need for a "Rakefile"
|
|
14
|
+
in your working directory that loads the <code>md2man/rakefile</code> library.</p></li>
|
|
15
|
+
<li><p>In web pages generated by the <code>md2man:web</code> Rake task:</p>
|
|
16
|
+
<ul>
|
|
17
|
+
<li>extract CSS into a separate <code>man/style.css</code> file</li>
|
|
18
|
+
<li>center manpage on screen & auto-split into columns</li>
|
|
19
|
+
</ul></li>
|
|
20
|
+
</ul>
|
|
21
|
+
<p>Patch:</p>
|
|
22
|
+
<ul>
|
|
23
|
+
<li><p>In web pages generated by the <code>md2man:web</code> Rake task:</p>
|
|
24
|
+
<ul>
|
|
25
|
+
<li>don't rely on being emitted into a <code>man/</code> directory</li>
|
|
26
|
+
</ul></li>
|
|
27
|
+
</ul>
|
|
28
|
+
<p>Other:</p>
|
|
29
|
+
<ul>
|
|
30
|
+
<li>add README and VERSION to generated HTML man pages</li>
|
|
31
|
+
</ul>
|
|
32
|
+
<h2 id="Version-1-5-1-2013-03-06">Version 1.5.1 (2013-03-06)</h2><p>Patch:</p>
|
|
33
|
+
<ul>
|
|
34
|
+
<li><p>All this time, this project's documentation stated that Redcarpet's
|
|
35
|
+
<code>no_intra_emphasis</code> option was enabled, but in reality, it was not.
|
|
36
|
+
The documentation has been corrected and the option remains disabled.</p></li>
|
|
37
|
+
<li><p>In web pages generated by the <code>md2man:web</code> Rake task:</p>
|
|
38
|
+
<ul>
|
|
39
|
+
<li>deactivate cross references to external manual pages</li>
|
|
40
|
+
<li>don't assume that NAME section contains a tagline</li>
|
|
41
|
+
<li>sort man/ subdirectories in the HTML index page</li>
|
|
42
|
+
<li>fix link to index page from webs directly in man/</li>
|
|
43
|
+
<li>add generator META tag to HTML output template</li>
|
|
44
|
+
<li>only apply special styling to the first H1 child</li>
|
|
45
|
+
<li>parse title from first paragraph containing hyphen</li>
|
|
46
|
+
</ul></li>
|
|
47
|
+
</ul>
|
|
48
|
+
<p>Other:</p>
|
|
49
|
+
<ul>
|
|
50
|
+
<li><p>rename HISTORY to VERSION so it sorts after README</p></li>
|
|
51
|
+
<li><p>tests should exercise engines with default options</p></li>
|
|
52
|
+
</ul>
|
|
53
|
+
<h2 id="Version-1-5-0-2013-02-24">Version 1.5.0 (2013-02-24)</h2><p>Minor:</p>
|
|
54
|
+
<ul>
|
|
55
|
+
<li><p>The <code>md2man:web</code> task from <code>md2man/rakefile</code> now:</p>
|
|
56
|
+
<ul>
|
|
57
|
+
<li>emits valid HTML5 with helpful HTML page titles</li>
|
|
58
|
+
<li>uses Twitter Bootstrap styling for HTML man pages</li>
|
|
59
|
+
<li>emits only ONE index page for all HTML man pages</li>
|
|
60
|
+
</ul></li>
|
|
61
|
+
</ul>
|
|
62
|
+
<p>Other:</p>
|
|
63
|
+
<ul>
|
|
64
|
+
<li><p>README: better organize the subsections of "Usage"</p></li>
|
|
65
|
+
<li><p>include md2man rake tasks in developer's rakefile</p></li>
|
|
66
|
+
</ul>
|
|
67
|
+
<h2 id="Version-1-4-1-2013-02-23">Version 1.4.1 (2013-02-23)</h2><p>Patch:</p>
|
|
68
|
+
<ul>
|
|
69
|
+
<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>
|
|
70
|
+
<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>
|
|
71
|
+
<li><p>GH-8: Redcarpet requires Ruby 1.9 and so must we</p><p><a href="https://github.com/sunaku/md2man/issues/8#issuecomment-9509240">https://github.com/sunaku/md2man/issues/8#issuecomment-9509240</a></p><p>Thanks to Postmodern for raising this issue.</p></li>
|
|
72
|
+
</ul>
|
|
73
|
+
<p>Other:</p>
|
|
74
|
+
<ul>
|
|
75
|
+
<li><p>README: add <a class="manpage-reference">md2man-html(1)</a> and Md2Man::HTML usage</p></li>
|
|
76
|
+
<li><p>LICENSE: use GitHub profile URLs instead of e-mail</p></li>
|
|
77
|
+
</ul>
|
|
78
|
+
<h2 id="Version-1-4-0-2012-10-14">Version 1.4.0 (2012-10-14)</h2><p>Minor:</p>
|
|
79
|
+
<ul>
|
|
80
|
+
<li><p>roff: emit non-first H1 headings as H2 headings</p></li>
|
|
81
|
+
<li><p>html: add <code>Md2Man::HTML::Engine</code> class for HTML manual page generation</p></li>
|
|
82
|
+
<li><p>html: add <a class="manpage-reference">md2man-html(1)</a> bin script for command line access to the above</p></li>
|
|
83
|
+
<li><p>html: add ID attributes on all headings for easy permalinking</p></li>
|
|
84
|
+
<li><p>rake: add <code>md2man/rakefile</code> to process markdown files in man/</p><p>This library provides a <code>rake md2man</code> task that builds UNIX and HTML
|
|
85
|
+
manual pages from Markdown files (with ".markdown", ".mkd", or ".md"
|
|
86
|
+
extension) inside your <code>man/man*/</code> directories. It also provides
|
|
87
|
+
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
|
|
88
|
+
your manual pages for packaging into a gem. See the README for details.</p></li>
|
|
89
|
+
</ul>
|
|
90
|
+
<h2 id="Version-1-3-2-2012-10-13">Version 1.3.2 (2012-10-13)</h2><p>Patch:</p>
|
|
91
|
+
<ul>
|
|
92
|
+
<li><p>roff: escape backslashes inside codespan nodes too</p></li>
|
|
93
|
+
<li><p>roff: escape backslashes inside block_code nodes</p></li>
|
|
94
|
+
</ul>
|
|
95
|
+
<h2 id="Version-1-3-1-2012-10-09">Version 1.3.1 (2012-10-09)</h2><p>Patch:</p>
|
|
96
|
+
<ul>
|
|
97
|
+
<li><p>roff: do not render references inside code blocks.</p></li>
|
|
98
|
+
<li><p>roff: do not render references inside code spans.</p></li>
|
|
99
|
+
<li><p>roff: fix single-line indented paragraph detection.</p></li>
|
|
100
|
+
<li><p>roff: also indent block_code just like block_quote.</p></li>
|
|
101
|
+
<li><p>roff: add paragraph above block_quote for spacing.</p></li>
|
|
102
|
+
<li><p>roff: render code blocks as paragraphs for spacing.</p><p>Otherwise there's not enough space between the previous paragraph and
|
|
103
|
+
the code block: it appears on the next line and appears ugly in <a class="manpage-reference">man(1)</a>.</p></li>
|
|
104
|
+
<li><p>document: make reference regexp match more manpages.</p></li>
|
|
105
|
+
</ul>
|
|
106
|
+
<p>Other:</p>
|
|
107
|
+
<ul>
|
|
108
|
+
<li><p>document: stronger digest encoding using NUL bytes.</p></li>
|
|
109
|
+
<li><p>document: super() can't reach Redcarpet's renderer classes.
|
|
110
|
+
See <a href="https://github.com/vmg/redcarpet/issues/51">https://github.com/vmg/redcarpet/issues/51</a> for details.</p></li>
|
|
111
|
+
</ul>
|
|
112
|
+
<h2 id="Version-1-3-0-2012-09-27">Version 1.3.0 (2012-09-27)</h2><p>Minor:</p>
|
|
113
|
+
<ul>
|
|
114
|
+
<li>Intra-word emphasis is now enabled <em>by default</em> in <code>Md2Man::ENGINE</code>.
|
|
115
|
+
To not be affected by this change, you may still construct your own
|
|
116
|
+
Redcarpet::Markdown engine with your own set of processing options.</li>
|
|
117
|
+
</ul>
|
|
118
|
+
<h2 id="Version-1-2-1-2012-07-05">Version 1.2.1 (2012-07-05)</h2><p>Patch:</p>
|
|
119
|
+
<ul>
|
|
120
|
+
<li>GH-4: ruby 1.8.7 lacks negative lookbehind regexps.
|
|
121
|
+
Thanks to Postmodern for reporting this issue.</li>
|
|
122
|
+
</ul>
|
|
123
|
+
<p>Other:</p>
|
|
124
|
+
<ul>
|
|
125
|
+
<li>GH-1: use <code>~></code> for gem version constraints.
|
|
126
|
+
See <a href="http://docs.rubygems.org/read/chapter/16">http://docs.rubygems.org/read/chapter/16</a>
|
|
127
|
+
Thanks to Postmodern for this contribution.</li>
|
|
128
|
+
</ul>
|
|
129
|
+
<h2 id="Version-1-2-0-2012-02-06">Version 1.2.0 (2012-02-06)</h2><p>Minor:</p>
|
|
130
|
+
<ul>
|
|
131
|
+
<li>The <code>Md2Man::Document</code> module now handles paragraph() nodes and dispatches
|
|
132
|
+
their content accordingly to hook methods for indented, tagged, and normal
|
|
133
|
+
paragraphs. A Redcarpet markdown parser need only include that module and
|
|
134
|
+
implement those hook methods in order to benefit from md2man's extensions
|
|
135
|
+
to markdown syntax programmatically.</li>
|
|
136
|
+
</ul>
|
|
137
|
+
<p>Other:</p>
|
|
138
|
+
<ul>
|
|
139
|
+
<li><p>README: mention features; revise markdown; cleanup.</p></li>
|
|
140
|
+
<li><p>LICENSE: @tanoku created initial Manpage renderer.</p></li>
|
|
141
|
+
</ul>
|
|
142
|
+
<h2 id="Version-1-1-0-2012-02-02">Version 1.1.0 (2012-02-02)</h2><p>Minor:</p>
|
|
143
|
+
<ul>
|
|
144
|
+
<li>Add <code>Md2Man::Document</code> module for programmatic processing of
|
|
145
|
+
cross-references to other UNIX manual pages within Redcarpet.</li>
|
|
146
|
+
</ul>
|
|
147
|
+
<p>Other:</p>
|
|
148
|
+
<ul>
|
|
149
|
+
<li><p>README: not all systems support <code>man -l</code> option.</p></li>
|
|
150
|
+
<li><p>gemspec: upgrade to redcarpet 2.1.0.</p></li>
|
|
151
|
+
<li><p>bundler suggests moving all dev deps into gemspec.</p></li>
|
|
152
|
+
<li><p>README: fix installation commands for development.</p></li>
|
|
153
|
+
<li><p>README: simplify project slogan to be more memorable.</p></li>
|
|
154
|
+
</ul>
|
|
155
|
+
<h2 id="Version-1-0-2-2012-01-09">Version 1.0.2 (2012-01-09)</h2><p>Patch:</p>
|
|
156
|
+
<ul>
|
|
157
|
+
<li><p>Blockquote's leading paragraph regexp was not anchored.</p></li>
|
|
158
|
+
<li><p>Freezing internal constants prevents monkey patching.</p></li>
|
|
159
|
+
</ul>
|
|
160
|
+
<p>Other:</p>
|
|
161
|
+
<ul>
|
|
162
|
+
<li><p>Upgraded to Binman 3 for better interoperability with Bundler.</p></li>
|
|
163
|
+
<li><p>Added example input file from the Linux Man Page Howto.</p></li>
|
|
164
|
+
<li><p>Forgot to change project slogan in the gem package.</p></li>
|
|
165
|
+
</ul>
|
|
166
|
+
<h2 id="Version-1-0-1-2011-12-06">Version 1.0.1 (2011-12-06)</h2><p>Major:</p>
|
|
167
|
+
<ul>
|
|
168
|
+
<li><p>Renamed the project from "redcarpet-manpage" to "md2man".</p>
|
|
169
|
+
<ul>
|
|
170
|
+
<li><code>RedcarpetManpage::Renderer</code> is now <code>Md2Man::Engine</code>.</li>
|
|
171
|
+
<li><code>RedcarpetManpage::RENDERER</code> is now <code>Md2Man::ENGINE</code>.</li>
|
|
172
|
+
</ul></li>
|
|
173
|
+
<li><p>Tagged paragraphs no longer require the first line to begin with italic or
|
|
174
|
+
bold styling. All that matters is that the subsequent lines are indented.</p></li>
|
|
175
|
+
</ul>
|
|
176
|
+
<p>Minor:</p>
|
|
177
|
+
<ul>
|
|
178
|
+
<li><p>Added <a class="manpage-reference">md2man(1)</a> executable for command-line usage.</p></li>
|
|
179
|
+
<li><p>Added support for all HTML 4.0 and XHTML 1.0 entities.</p></li>
|
|
180
|
+
<li><p>Added support for tables, horizontal rules, and more.</p></li>
|
|
181
|
+
<li><p>Added <code>Md2Man::Roff</code> mixin for advanced Redcarpet2 usage.</p></li>
|
|
182
|
+
<li><p>Improved README with some new and revised documentation.</p></li>
|
|
183
|
+
</ul>
|
|
184
|
+
<p>Other:</p>
|
|
185
|
+
<ul>
|
|
186
|
+
<li>Rewrote entire Markdown to Roff conversion from scratch while doing TDD.</li>
|
|
187
|
+
</ul>
|
|
188
|
+
<h2 id="Version-0-0-1-2011-10-13">Version 0.0.1 (2011-10-13)</h2><p>First release! Happy birthday! Woohoo! :-)</p></div></div></body>
|
|
189
|
+
</html>
|
|
@@ -0,0 +1,262 @@
|
|
|
1
|
+
## Version 1.6.0 (2013-03-10)
|
|
2
|
+
|
|
3
|
+
Minor:
|
|
4
|
+
|
|
5
|
+
* Added an md2man-rake(1) executable that lets you run md2man's rake(1)
|
|
6
|
+
tasks _directly_ from the command line: without the need for a "Rakefile"
|
|
7
|
+
in your working directory that loads the `md2man/rakefile` library.
|
|
8
|
+
|
|
9
|
+
* In web pages generated by the `md2man:web` Rake task:
|
|
10
|
+
|
|
11
|
+
* extract CSS into a separate `man/style.css` file
|
|
12
|
+
|
|
13
|
+
* center manpage on screen & auto-split into columns
|
|
14
|
+
|
|
15
|
+
Patch:
|
|
16
|
+
|
|
17
|
+
* In web pages generated by the `md2man:web` Rake task:
|
|
18
|
+
|
|
19
|
+
* don't rely on being emitted into a `man/` directory
|
|
20
|
+
|
|
21
|
+
Other:
|
|
22
|
+
|
|
23
|
+
* add README and VERSION to generated HTML man pages
|
|
24
|
+
|
|
25
|
+
## Version 1.5.1 (2013-03-06)
|
|
26
|
+
|
|
27
|
+
Patch:
|
|
28
|
+
|
|
29
|
+
* All this time, this project's documentation stated that Redcarpet's
|
|
30
|
+
`no_intra_emphasis` option was enabled, but in reality, it was not.
|
|
31
|
+
The documentation has been corrected and the option remains disabled.
|
|
32
|
+
|
|
33
|
+
* In web pages generated by the `md2man:web` Rake task:
|
|
34
|
+
|
|
35
|
+
* deactivate cross references to external manual pages
|
|
36
|
+
|
|
37
|
+
* don't assume that NAME section contains a tagline
|
|
38
|
+
|
|
39
|
+
* sort man/ subdirectories in the HTML index page
|
|
40
|
+
|
|
41
|
+
* fix link to index page from webs directly in man/
|
|
42
|
+
|
|
43
|
+
* add generator META tag to HTML output template
|
|
44
|
+
|
|
45
|
+
* only apply special styling to the first H1 child
|
|
46
|
+
|
|
47
|
+
* parse title from first paragraph containing hyphen
|
|
48
|
+
|
|
49
|
+
Other:
|
|
50
|
+
|
|
51
|
+
* rename HISTORY to VERSION so it sorts after README
|
|
52
|
+
|
|
53
|
+
* tests should exercise engines with default options
|
|
54
|
+
|
|
55
|
+
## Version 1.5.0 (2013-02-24)
|
|
56
|
+
|
|
57
|
+
Minor:
|
|
58
|
+
|
|
59
|
+
* The `md2man:web` task from `md2man/rakefile` now:
|
|
60
|
+
|
|
61
|
+
* emits valid HTML5 with helpful HTML page titles
|
|
62
|
+
|
|
63
|
+
* uses Twitter Bootstrap styling for HTML man pages
|
|
64
|
+
|
|
65
|
+
* emits only ONE index page for all HTML man pages
|
|
66
|
+
|
|
67
|
+
Other:
|
|
68
|
+
|
|
69
|
+
* README: better organize the subsections of "Usage"
|
|
70
|
+
|
|
71
|
+
* include md2man rake tasks in developer's rakefile
|
|
72
|
+
|
|
73
|
+
## Version 1.4.1 (2013-02-23)
|
|
74
|
+
|
|
75
|
+
Patch:
|
|
76
|
+
|
|
77
|
+
* rakefile: arbitrary directory structure under man/
|
|
78
|
+
|
|
79
|
+
https://github.com/sunaku/md2man/pull/3#issuecomment-9429077
|
|
80
|
+
|
|
81
|
+
Thanks to Postmodern for raising this issue.
|
|
82
|
+
|
|
83
|
+
* hook into 'build' task only if using Bundler tasks
|
|
84
|
+
|
|
85
|
+
https://github.com/sunaku/md2man/pull/7#issuecomment-9467621
|
|
86
|
+
|
|
87
|
+
Thanks to Postmodern for raising this issue.
|
|
88
|
+
|
|
89
|
+
* GH-8: Redcarpet requires Ruby 1.9 and so must we
|
|
90
|
+
|
|
91
|
+
https://github.com/sunaku/md2man/issues/8#issuecomment-9509240
|
|
92
|
+
|
|
93
|
+
Thanks to Postmodern for raising this issue.
|
|
94
|
+
|
|
95
|
+
Other:
|
|
96
|
+
|
|
97
|
+
* README: add md2man-html(1) and Md2Man::HTML usage
|
|
98
|
+
|
|
99
|
+
* LICENSE: use GitHub profile URLs instead of e-mail
|
|
100
|
+
|
|
101
|
+
## Version 1.4.0 (2012-10-14)
|
|
102
|
+
|
|
103
|
+
Minor:
|
|
104
|
+
|
|
105
|
+
* roff: emit non-first H1 headings as H2 headings
|
|
106
|
+
|
|
107
|
+
* html: add `Md2Man::HTML::Engine` class for HTML manual page generation
|
|
108
|
+
|
|
109
|
+
* html: add md2man-html(1) bin script for command line access to the above
|
|
110
|
+
|
|
111
|
+
* html: add ID attributes on all headings for easy permalinking
|
|
112
|
+
|
|
113
|
+
* rake: add `md2man/rakefile` to process markdown files in man/
|
|
114
|
+
|
|
115
|
+
This library provides a `rake md2man` task that builds UNIX and HTML
|
|
116
|
+
manual pages from Markdown files (with ".markdown", ".mkd", or ".md"
|
|
117
|
+
extension) inside your `man/man*/` directories. It also provides
|
|
118
|
+
sub-tasks to build *only* UNIX or HTML manual pages separately.
|
|
119
|
+
|
|
120
|
+
It also hooks into Bundler's gem packaging tasks to automatically build
|
|
121
|
+
your manual pages for packaging into a gem. See the README for details.
|
|
122
|
+
|
|
123
|
+
## Version 1.3.2 (2012-10-13)
|
|
124
|
+
|
|
125
|
+
Patch:
|
|
126
|
+
|
|
127
|
+
* roff: escape backslashes inside codespan nodes too
|
|
128
|
+
|
|
129
|
+
* roff: escape backslashes inside block\_code nodes
|
|
130
|
+
|
|
131
|
+
## Version 1.3.1 (2012-10-09)
|
|
132
|
+
|
|
133
|
+
Patch:
|
|
134
|
+
|
|
135
|
+
* roff: do not render references inside code blocks.
|
|
136
|
+
|
|
137
|
+
* roff: do not render references inside code spans.
|
|
138
|
+
|
|
139
|
+
* roff: fix single-line indented paragraph detection.
|
|
140
|
+
|
|
141
|
+
* roff: also indent block\_code just like block\_quote.
|
|
142
|
+
|
|
143
|
+
* roff: add paragraph above block\_quote for spacing.
|
|
144
|
+
|
|
145
|
+
* roff: render code blocks as paragraphs for spacing.
|
|
146
|
+
|
|
147
|
+
Otherwise there's not enough space between the previous paragraph and
|
|
148
|
+
the code block: it appears on the next line and appears ugly in man(1).
|
|
149
|
+
|
|
150
|
+
* document: make reference regexp match more manpages.
|
|
151
|
+
|
|
152
|
+
Other:
|
|
153
|
+
|
|
154
|
+
* document: stronger digest encoding using NUL bytes.
|
|
155
|
+
|
|
156
|
+
* document: super() can't reach Redcarpet's renderer classes.
|
|
157
|
+
See https://github.com/vmg/redcarpet/issues/51 for details.
|
|
158
|
+
|
|
159
|
+
## Version 1.3.0 (2012-09-27)
|
|
160
|
+
|
|
161
|
+
Minor:
|
|
162
|
+
|
|
163
|
+
* Intra-word emphasis is now enabled *by default* in `Md2Man::ENGINE`.
|
|
164
|
+
To not be affected by this change, you may still construct your own
|
|
165
|
+
Redcarpet::Markdown engine with your own set of processing options.
|
|
166
|
+
|
|
167
|
+
## Version 1.2.1 (2012-07-05)
|
|
168
|
+
|
|
169
|
+
Patch:
|
|
170
|
+
|
|
171
|
+
* GH-4: ruby 1.8.7 lacks negative lookbehind regexps.
|
|
172
|
+
Thanks to Postmodern for reporting this issue.
|
|
173
|
+
|
|
174
|
+
Other:
|
|
175
|
+
|
|
176
|
+
* GH-1: use `~>` for gem version constraints.
|
|
177
|
+
See http://docs.rubygems.org/read/chapter/16
|
|
178
|
+
Thanks to Postmodern for this contribution.
|
|
179
|
+
|
|
180
|
+
## Version 1.2.0 (2012-02-06)
|
|
181
|
+
|
|
182
|
+
Minor:
|
|
183
|
+
|
|
184
|
+
* The `Md2Man::Document` module now handles paragraph() nodes and dispatches
|
|
185
|
+
their content accordingly to hook methods for indented, tagged, and normal
|
|
186
|
+
paragraphs. A Redcarpet markdown parser need only include that module and
|
|
187
|
+
implement those hook methods in order to benefit from md2man's extensions
|
|
188
|
+
to markdown syntax programmatically.
|
|
189
|
+
|
|
190
|
+
Other:
|
|
191
|
+
|
|
192
|
+
* README: mention features; revise markdown; cleanup.
|
|
193
|
+
|
|
194
|
+
* LICENSE: @tanoku created initial Manpage renderer.
|
|
195
|
+
|
|
196
|
+
## Version 1.1.0 (2012-02-02)
|
|
197
|
+
|
|
198
|
+
Minor:
|
|
199
|
+
|
|
200
|
+
* Add `Md2Man::Document` module for programmatic processing of
|
|
201
|
+
cross-references to other UNIX manual pages within Redcarpet.
|
|
202
|
+
|
|
203
|
+
Other:
|
|
204
|
+
|
|
205
|
+
* README: not all systems support `man -l` option.
|
|
206
|
+
|
|
207
|
+
* gemspec: upgrade to redcarpet 2.1.0.
|
|
208
|
+
|
|
209
|
+
* bundler suggests moving all dev deps into gemspec.
|
|
210
|
+
|
|
211
|
+
* README: fix installation commands for development.
|
|
212
|
+
|
|
213
|
+
* README: simplify project slogan to be more memorable.
|
|
214
|
+
|
|
215
|
+
## Version 1.0.2 (2012-01-09)
|
|
216
|
+
|
|
217
|
+
Patch:
|
|
218
|
+
|
|
219
|
+
* Blockquote's leading paragraph regexp was not anchored.
|
|
220
|
+
|
|
221
|
+
* Freezing internal constants prevents monkey patching.
|
|
222
|
+
|
|
223
|
+
Other:
|
|
224
|
+
|
|
225
|
+
* Upgraded to Binman 3 for better interoperability with Bundler.
|
|
226
|
+
|
|
227
|
+
* Added example input file from the Linux Man Page Howto.
|
|
228
|
+
|
|
229
|
+
* Forgot to change project slogan in the gem package.
|
|
230
|
+
|
|
231
|
+
## Version 1.0.1 (2011-12-06)
|
|
232
|
+
|
|
233
|
+
Major:
|
|
234
|
+
|
|
235
|
+
* Renamed the project from "redcarpet-manpage" to "md2man".
|
|
236
|
+
|
|
237
|
+
* `RedcarpetManpage::Renderer` is now `Md2Man::Engine`.
|
|
238
|
+
|
|
239
|
+
* `RedcarpetManpage::RENDERER` is now `Md2Man::ENGINE`.
|
|
240
|
+
|
|
241
|
+
* Tagged paragraphs no longer require the first line to begin with italic or
|
|
242
|
+
bold styling. All that matters is that the subsequent lines are indented.
|
|
243
|
+
|
|
244
|
+
Minor:
|
|
245
|
+
|
|
246
|
+
* Added md2man(1) executable for command-line usage.
|
|
247
|
+
|
|
248
|
+
* Added support for all HTML 4.0 and XHTML 1.0 entities.
|
|
249
|
+
|
|
250
|
+
* Added support for tables, horizontal rules, and more.
|
|
251
|
+
|
|
252
|
+
* Added `Md2Man::Roff` mixin for advanced Redcarpet2 usage.
|
|
253
|
+
|
|
254
|
+
* Improved README with some new and revised documentation.
|
|
255
|
+
|
|
256
|
+
Other:
|
|
257
|
+
|
|
258
|
+
* Rewrote entire Markdown to Roff conversion from scratch while doing TDD.
|
|
259
|
+
|
|
260
|
+
## Version 0.0.1 (2011-10-13)
|
|
261
|
+
|
|
262
|
+
First release! Happy birthday! Woohoo! :-)
|
data/man/index.html
ADDED
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8" />
|
|
5
|
+
<meta name="generator" content="md2man 1.6.0 https://github.com/sunaku/md2man" />
|
|
6
|
+
<title>man/index</title>
|
|
7
|
+
<link rel="stylesheet" href="style.css"/>
|
|
8
|
+
<!--[if lt IE 9]><script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script><![endif]-->
|
|
9
|
+
</head>
|
|
10
|
+
<body><div class="container-fluid"><h2 id="man">man</h2><dl class="dl-horizontal"><dt><a href="README.html">README</a></dt><dd></dd></dl><dl class="dl-horizontal"><dt><a href="VERSION.html">VERSION</a></dt><dd></dd></dl><h2 id="man1">man1</h2><dl class="dl-horizontal"><dt><a href="man1/md2man-html.1.html">md2man-html(1)</a></dt><dd>convert md2man(1) flavored markdown(7) into HTML</dd></dl><dl class="dl-horizontal"><dt><a href="man1/md2man-rake.1.html">md2man-rake(1)</a></dt><dd>run rake(1) tasks from md2man(1)</dd></dl><dl class="dl-horizontal"><dt><a href="man1/md2man.1.html">md2man(1)</a></dt><dd>convert markdown(7) into roff(7)</dd></dl></div></body>
|
|
11
|
+
</html>
|
data/man/man1/md2man-html.1
CHANGED
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8" />
|
|
5
|
+
<meta name="generator" content="md2man 1.6.0 https://github.com/sunaku/md2man" />
|
|
6
|
+
<title>md2man-html(1) — convert md2man(1) flavored markdown(7) into HTML</title>
|
|
7
|
+
<link rel="stylesheet" href="../style.css"/>
|
|
8
|
+
<!--[if lt IE 9]><script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script><![endif]-->
|
|
9
|
+
</head>
|
|
10
|
+
<body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man1">man1</a>/md2man-html.1</span></div></div><div class="container-fluid"><div class="manpage"><h1 id="MD2MAN-HTML-1-2013-03-10-1-6-0">MD2MAN-HTML 1 2013-03-10 1.6.0</h1><h2 id="NAME">NAME</h2><p>md2man-html - convert <a class="manpage-reference" href="../man1/md2man.1.html">md2man(1)</a> flavored <a class="manpage-reference">markdown(7)</a> into HTML</p><h2 id="SYNOPSIS">SYNOPSIS</h2><p><code>md2man-html</code> [<em>OPTION</em>]... [<em>FILE</em>]</p><h2 id="DESCRIPTION">DESCRIPTION</h2><p>This program converts the <a class="manpage-reference">markdown(7)</a> input from the given <em>FILE</em> into HTML
|
|
11
|
+
and then prints the result to stdout. stdin is read if <em>FILE</em> is not given.</p><h3 id="Document-format">Document format</h3><p>See <a class="manpage-reference" href="../man1/md2man.1.html">md2man(1)</a> for details about the document format and Markdown extensions.</p><h3 id="Cross-linking">Cross linking</h3><p>References to other manual pages are converted into hyperlinks that have
|
|
12
|
+
class="manpage-reference" and href="../man${section}/${page}.${section}.html"
|
|
13
|
+
attributes.</p><p>For example, the <a class="manpage-reference">markdown(7)</a> reference would be converted into HTML as:</p><pre><code><a class="manpage-reference" href="../man7/markdown.7.html">markdown(7)</a>
|
|
14
|
+
</code></pre><h2 id="OPTIONS">OPTIONS</h2><dl><dt><code>-h</code>, <code>--help</code></dt><dd>Show this help manual.</dd></dl><h2 id="SEE-ALSO">SEE ALSO</h2><p><a class="manpage-reference" href="../man1/md2man.1.html">md2man(1)</a></p></div></div></body>
|
|
15
|
+
</html>
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
.TH MD2MAN\-RAKE 1 2013\-03\-10 1.6.0
|
|
2
|
+
.SH NAME
|
|
3
|
+
.PP
|
|
4
|
+
md2man\-rake \- run
|
|
5
|
+
.BR rake (1)
|
|
6
|
+
tasks from
|
|
7
|
+
.BR md2man (1)
|
|
8
|
+
.SH SYNOPSIS
|
|
9
|
+
.PP
|
|
10
|
+
\fB\fCmd2man-rake\fR [\fIOPTION\fP]... [\fITASK\fP]...
|
|
11
|
+
.SH DESCRIPTION
|
|
12
|
+
.PP
|
|
13
|
+
This program lets you run
|
|
14
|
+
.BR rake (1)
|
|
15
|
+
tasks provided by
|
|
16
|
+
.BR md2man (1)
|
|
17
|
+
without having
|
|
18
|
+
to create a special file named \fB\fCRakefile\fR that contains the following snippet:
|
|
19
|
+
.PP
|
|
20
|
+
.RS
|
|
21
|
+
.nf
|
|
22
|
+
require 'md2man/rakefile'
|
|
23
|
+
.fi
|
|
24
|
+
.RE
|
|
25
|
+
.PP
|
|
26
|
+
If no \fITASK\fP is specified, then the \fB\fCmd2man\fR task is run by default.
|
|
27
|
+
.SH TASKS
|
|
28
|
+
.TP
|
|
29
|
+
\fB\fCmd2man\fR
|
|
30
|
+
Runs the \fB\fCmd2man:man\fR and \fB\fCmd2man:web\fR tasks, in that order.
|
|
31
|
+
.TP
|
|
32
|
+
\fB\fCmd2man:man\fR
|
|
33
|
+
Builds UNIX manual pages from \fB\fC*.markdown\fR, \fB\fC*.mkd\fR, and \fB\fC*.md\fR files
|
|
34
|
+
found in or beneath the \fB\fCman/\fR subdirectory in your working directory.
|
|
35
|
+
.TP
|
|
36
|
+
\fB\fCmd2man:web\fR
|
|
37
|
+
Builds HTML manual pages from \fB\fC*.markdown\fR, \fB\fC*.mkd\fR, and \fB\fC*.md\fR files
|
|
38
|
+
found in or beneath the \fB\fCman/\fR subdirectory in your working directory.
|
|
39
|
+
.SH OPTIONS
|
|
40
|
+
.TP
|
|
41
|
+
\fB\fC-h\fR, \fB\fC--help\fR
|
|
42
|
+
Show this help manual.
|
|
43
|
+
.PP
|
|
44
|
+
Run \fB\fCrake --help\fR to see more options.
|
|
45
|
+
.SH SEE ALSO
|
|
46
|
+
.PP
|
|
47
|
+
.BR rake (1),
|
|
48
|
+
.BR md2man (1),
|
|
49
|
+
.BR markdown (7)
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8" />
|
|
5
|
+
<meta name="generator" content="md2man 1.6.0 https://github.com/sunaku/md2man" />
|
|
6
|
+
<title>md2man-rake(1) — run rake(1) tasks from md2man(1)</title>
|
|
7
|
+
<link rel="stylesheet" href="../style.css"/>
|
|
8
|
+
<!--[if lt IE 9]><script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script><![endif]-->
|
|
9
|
+
</head>
|
|
10
|
+
<body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man1">man1</a>/md2man-rake.1</span></div></div><div class="container-fluid"><div class="manpage"><h1 id="MD2MAN-RAKE-1-2013-03-10-1-6-0">MD2MAN-RAKE 1 2013-03-10 1.6.0</h1><h2 id="NAME">NAME</h2><p>md2man-rake - run <a class="manpage-reference">rake(1)</a> tasks from <a class="manpage-reference" href="../man1/md2man.1.html">md2man(1)</a></p><h2 id="SYNOPSIS">SYNOPSIS</h2><p><code>md2man-rake</code> [<em>OPTION</em>]... [<em>TASK</em>]...</p><h2 id="DESCRIPTION">DESCRIPTION</h2><p>This program lets you run <a class="manpage-reference">rake(1)</a> tasks provided by <a class="manpage-reference" href="../man1/md2man.1.html">md2man(1)</a> without having
|
|
11
|
+
to create a special file named <code>Rakefile</code> that contains the following snippet:</p><pre><code>require 'md2man/rakefile'
|
|
12
|
+
</code></pre><p>If no <em>TASK</em> is specified, then the <code>md2man</code> task is run by default.</p><h2 id="TASKS">TASKS</h2><dl><dt><code>md2man</code></dt><dd>Runs the <code>md2man:man</code> and <code>md2man:web</code> tasks, in that order.</dd></dl><dl><dt><code>md2man:man</code></dt><dd>Builds UNIX manual pages from <code>*.markdown</code>, <code>*.mkd</code>, and <code>*.md</code> files
|
|
13
|
+
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
|
|
14
|
+
found in or beneath the <code>man/</code> subdirectory in your working directory.</dd></dl><h2 id="OPTIONS">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">SEE ALSO</h2><p><a class="manpage-reference">rake(1)</a>, <a class="manpage-reference" href="../man1/md2man.1.html">md2man(1)</a>, <a class="manpage-reference">markdown(7)</a></p></div></div></body>
|
|
15
|
+
</html>
|
data/man/man1/md2man.1
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
.TH MD2MAN 1 2013\-03\-
|
|
1
|
+
.TH MD2MAN 1 2013\-03\-10 1.6.0
|
|
2
2
|
.SH NAME
|
|
3
3
|
.PP
|
|
4
4
|
md2man \- convert
|
|
@@ -80,4 +80,5 @@ fenced_code_blocks
|
|
|
80
80
|
Show this help manual.
|
|
81
81
|
.SH SEE ALSO
|
|
82
82
|
.PP
|
|
83
|
-
.BR md2man-html (1)
|
|
83
|
+
.BR md2man-html (1),
|
|
84
|
+
.BR md2man-rake (1)
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8" />
|
|
5
|
+
<meta name="generator" content="md2man 1.6.0 https://github.com/sunaku/md2man" />
|
|
6
|
+
<title>md2man(1) — convert markdown(7) into roff(7)</title>
|
|
7
|
+
<link rel="stylesheet" href="../style.css"/>
|
|
8
|
+
<!--[if lt IE 9]><script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script><![endif]-->
|
|
9
|
+
</head>
|
|
10
|
+
<body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man1">man1</a>/md2man.1</span></div></div><div class="container-fluid"><div class="manpage"><h1 id="MD2MAN-1-2013-03-10-1-6-0">MD2MAN 1 2013-03-10 1.6.0</h1><h2 id="NAME">NAME</h2><p>md2man - convert <a class="manpage-reference">markdown(7)</a> into <a class="manpage-reference">roff(7)</a></p><h2 id="SYNOPSIS">SYNOPSIS</h2><p><code>md2man</code> [<em>OPTION</em>]... [<em>FILE</em>]</p><h2 id="DESCRIPTION">DESCRIPTION</h2><p><a href="https://github.com/sunaku/md2man">md2man</a> converts <a class="manpage-reference">markdown(7)</a> input from the given <em>FILE</em> into <a class="manpage-reference">roff(7)</a> using
|
|
11
|
+
<a href="https://github.com/vmg/redcarpet">Redcarpet</a> and then prints the result to the standard output stream. If
|
|
12
|
+
<em>FILE</em> is not given, then the standard input stream is read in its place.</p><h3 id="Document-format">Document format</h3><p>md2man extends <a class="manpage-reference">markdown(7)</a> syntax in the following ways, as provisioned in the
|
|
13
|
+
<code>Md2Man::Document</code> module and defined in its derivative <code>Md2Man::Roff</code> module:</p>
|
|
14
|
+
<ul>
|
|
15
|
+
<li><p>Paragraphs whose lines are all uniformly indented by two spaces are
|
|
16
|
+
considered to be "indented paragraphs". They are unindented accordingly
|
|
17
|
+
before emission as <code>.IP</code> in the <a class="manpage-reference">roff(7)</a> output.</p></li>
|
|
18
|
+
<li><p>Paragraphs whose subsequent lines (all except the first) are uniformly
|
|
19
|
+
indented by two spaces are considered to be a "tagged paragraphs". They
|
|
20
|
+
are unindented accordingly before emission as <code>.TP</code> in the <a class="manpage-reference">roff(7)</a> output.</p></li>
|
|
21
|
+
</ul>
|
|
22
|
+
<p>md2man extends <a class="manpage-reference">markdown(7)</a> semantics in the following ways:</p>
|
|
23
|
+
<ul>
|
|
24
|
+
<li>The first top-level heading (H1) found in the document is emitted as <code>.TH</code>
|
|
25
|
+
in the <a class="manpage-reference">roff(7)</a> output to define the UNIX manual page's header and footer.
|
|
26
|
+
Any subsequent top-level headings (H1) are treated as second-level (H2).</li>
|
|
27
|
+
</ul>
|
|
28
|
+
<h3 id="Markdown-extensions">Markdown extensions</h3><p>The following <a href="https://github.com/vmg/redcarpet">Redcarpet</a> extensions are enabled while processing <a class="manpage-reference">markdown(7)</a>:</p>
|
|
29
|
+
<ul>
|
|
30
|
+
<li>tables</li>
|
|
31
|
+
<li>autolink</li>
|
|
32
|
+
<li>superscript</li>
|
|
33
|
+
<li>strikethrough</li>
|
|
34
|
+
<li>fenced_code_blocks</li>
|
|
35
|
+
</ul>
|
|
36
|
+
<h2 id="OPTIONS">OPTIONS</h2><dl><dt><code>-h</code>, <code>--help</code></dt><dd>Show this help manual.</dd></dl><h2 id="SEE-ALSO">SEE ALSO</h2><p><a class="manpage-reference" href="../man1/md2man-html.1.html">md2man-html(1)</a>, <a class="manpage-reference" href="../man1/md2man-rake.1.html">md2man-rake(1)</a></p></div></div></body>
|
|
37
|
+
</html>
|