md2man 2.0.4 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3fc358158819e63351eafa2b2ff7681b60ccc9c9
-  data.tar.gz: c998f1f9e84ff9748f75a4258b7f2aead52ce6f2
+  metadata.gz: 6d0f7375401869b8c75b984a10b03931ba66b389
+  data.tar.gz: ccefdceb0a7b2b71c37ed418e22dbe2e11d2d92b
 SHA512:
-  metadata.gz: a648664ce6a6eae9ea93b521103834e180a0edd0c3d0db70158f109e6db8bf56689a292c5f0b8825d0ef52c096b162a9740192b61648622562a39c64c76e3d7b
-  data.tar.gz: e6528b94be7ad596f2ca6165daf4d6c30979de6b78d015026be9a1e4a3993a6e714807391e56d26f6c44ecf49c1e9d86bcf5bc20f1969fcfe75404903e182245
+  metadata.gz: 520e506c97403142377ae2329ea34197246595dabe5872fdb9fc3dc50fd498718e7188823326a907c9d770943c8424f9780df221edaa1dd726933656b40cf7bf
+  data.tar.gz: 3afb8e18c990e677a071ece093b78c4ecdc301d779f2b7b2150d3e0d01255c7906743bd605dcd9c1ea0d4f1de718cd4887404ccdf0d303f778d5bc8e08b471cb

data/VERSION.markdown

@@ -1,3 +1,15 @@
+## Version 2.1.0 (2014-05-04)
+
+### Minor:
+
+  * md2man-html(1): add anchors & permalinks to headings.
+
+  * GH-15: wrap `.TH` components in stylable HTML spans.
+
+### Other:
+
+  * GH-15: paraphrase man-pages(7) description of `.TH`.
+
 ## Version 2.0.4 (2014-04-26)
 
 ### Patch:

data/bin/md2man-html

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 =begin =======================================================================
 
-# MD2MAN-HTML 1 2014-04-26 2.0.4
+# MD2MAN-HTML 1 2014-05-04 2.1.0
 
 ## NAME
 
@@ -17,6 +17,17 @@ This program converts md2man(5) flavored markdown(7) input from the given
 *FILE* into HTML and then prints the result to the standard output stream.
 If *FILE* is not given, then the standard input stream is read in its place.
 
+### Top-level headings
+
+Each component of the `.TH` directive in roff(7), described under "Top-level
+headings" in md2man(5), is wrapped in stylable `<span>` elements as follows:
+
+    <span class="md2man-title">...</span>
+    <span class="md2man-section">...</span>
+    <span class="md2man-date">...</span>
+    <span class="md2man-source">...</span>
+    <span class="md2man-manual">...</span>
+
 ### Cross references
 
 Cross references to manual pages are emitted as HTML hyperlinks that have

data/bin/md2man-rake

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 =begin =======================================================================
 
-# MD2MAN-RAKE 1 2014-04-26 2.0.4
+# MD2MAN-RAKE 1 2014-05-04 2.1.0
 
 ## NAME
 

data/bin/md2man-roff

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 =begin =======================================================================
 
-# MD2MAN-ROFF 1 2014-04-26 2.0.4
+# MD2MAN-ROFF 1 2014-05-04 2.1.0
 
 ## NAME
 

data/lib/md2man/html.rb

@@ -1,10 +1,20 @@
 require 'cgi'
+require 'shellwords'
 require 'md2man/document'
 
 module Md2Man::HTML
 
   include Md2Man::Document
 
+  #---------------------------------------------------------------------------
+  # document-level processing
+  #---------------------------------------------------------------------------
+
+  def preprocess document
+    @h1_seen = false
+    super
+  end
+
   #---------------------------------------------------------------------------
   # block-level processing
   #---------------------------------------------------------------------------
@@ -22,10 +32,26 @@ module Md2Man::HTML
     "<dl><dd>#{text}</dd></dl>"
   end
 
+  # see "Title line" in man-pages(7) or "Top-level headings" in md2man(5)
+  HEADER_PARTS = %w[ title section date source manual ].freeze
+
   def header text, level, _=nil
+    if level == 1 and not @h1_seen
+      @h1_seen = true
+      text = HEADER_PARTS.zip(Shellwords.split(text)).map do |part, value|
+        %{<span class="md2man-#{part}">#{value}</span>} if value
+      end.compact.join(' ')
+    end
+
     id = text.gsub(/<.+?>/, '-').        # strip all HTML tags
       gsub(/\W+/, '-').gsub(/^-|-$/, '') # fold non-word chars
-    %{<h#{level} id="#{id}">#{text}</h#{level}>}
+    [
+      %{<h#{level} id="#{id}">},
+        text,
+        %{<a name="#{id}" href="##{id}" class="md2man-permalink">},
+        '</a>',
+      "</h#{level}>",
+    ].join
   end
 
   #---------------------------------------------------------------------------

data/lib/md2man/rakefile/style.css

@@ -31,6 +31,20 @@
     font-size: smaller;
     text-align: right;
   }
+
+  h1:first-child > a.md2man-permalink {
+    display: none;
+  }
+
+  a.md2man-permalink:after {
+    padding-left: 0.25em;
+    content: '\2665'; /* ♥ */
+    opacity: 0.125;
+  }
+
+  a.md2man-permalink:hover:after {
+    opacity: initial;
+  }
 }
 
 @media print {

data/lib/md2man/version.rb

@@ -1,3 +1,3 @@
 module Md2Man
-  VERSION = "2.0.4"
+  VERSION = "2.1.0"
 end

data/man/index.html

@@ -2,7 +2,7 @@
 <html>
 <head>
   <meta charset="utf-8" />
-  <meta name="generator" content="md2man 2.0.4 https://github.com/sunaku/md2man" />
+  <meta name="generator" content="md2man 2.1.0 https://github.com/sunaku/md2man" />
   <title>man/index</title>
   <link rel="stylesheet" href="style.css"/>
   <!--[if lt IE 9]><script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script><![endif]-->

data/man/man0/README.html

@@ -2,20 +2,20 @@
 <html>
 <head>
   <meta charset="utf-8" />
-  <meta name="generator" content="md2man 2.0.4 https://github.com/sunaku/md2man" />
+  <meta name="generator" content="md2man 2.1.0 https://github.com/sunaku/md2man" />
   <title>README</title>
   <link rel="stylesheet" href="../style.css"/>
   <!--[if lt IE 9]><script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script><![endif]-->
 </head>
-<body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man0">man0</a>/README</span></div></div><div class="container-fluid"><h1 id="md2man-markdown-to-manpage">md2man - markdown to manpage</h1><p>md2man is a Ruby library and a set of command-line programs that convert
-<a href="http://daringfireball.net/projects/markdown/">Markdown</a> into UNIX manual pages (both <a href="http://troff.org">roff</a> and HTML) using <a href="https://github.com/vmg/redcarpet">Redcarpet</a>.</p><h2 id="Features">Features</h2>
+<body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man0">man0</a>/README</span></div></div><div class="container-fluid"><h1 id="md2man-markdown-to-manpage"><span class="md2man-title">md2man</span> <span class="md2man-section">-</span> <span class="md2man-date">markdown</span> <span class="md2man-source">to</span> <span class="md2man-manual">manpage</span><a name="md2man-markdown-to-manpage" href="#md2man-markdown-to-manpage" class="md2man-permalink"></a></h1><p>md2man is a Ruby library and a set of command-line programs that convert
+<a href="http://daringfireball.net/projects/markdown/">Markdown</a> into UNIX manual pages (both <a href="http://troff.org">roff</a> and HTML) using <a href="https://github.com/vmg/redcarpet">Redcarpet</a>.</p><h2 id="Features">Features<a name="Features" href="#Features" class="md2man-permalink"></a></h2>
 <ul>
 <li><p>Formats tagged and indented paragraphs (see &quot;document format&quot; below).</p></li>
 <li><p>Translates all HTML4 and XHTML1 entities into native <a href="http://troff.org">roff</a> equivalents.</p></li>
 <li><p>Supports markdown extensions such as <a href="http://michelf.com/projects/php-markdown/extra/#table">PHP Markdown Extra tables</a>.</p></li>
 <li><p>Usable from the command line as a filter in a UNIX command pipeline.</p></li>
 </ul>
-<h3 id="Demonstration">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>
+<h3 id="Demonstration">Demonstration<a name="Demonstration" href="#Demonstration" class="md2man-permalink"></a></h3><p>Try converting <a href="https://raw.github.com/sunaku/md2man/master/EXAMPLE.markdown">this example Markdown file</a> into a UNIX manual page:</p>
 <pre><code>md2man-roff EXAMPLE.markdown &gt; EXAMPLE.1
 man -l EXAMPLE.1
 </code></pre>
@@ -23,10 +23,10 @@ man -l EXAMPLE.1
 <pre><code>md2man-html EXAMPLE.markdown &gt; EXAMPLE.html
 open EXAMPLE.html
 </code></pre>
-<h2 id="Installation">Installation</h2>
+<h2 id="Installation">Installation<a name="Installation" href="#Installation" class="md2man-permalink"></a></h2>
 <pre><code>gem install md2man
 </code></pre>
-<h3 id="Development">Development</h3>
+<h3 id="Development">Development<a name="Development" href="#Development" class="md2man-permalink"></a></h3>
 <pre><code>git clone git://github.com/sunaku/md2man
 cd md2man
 bundle install
@@ -34,10 +34,10 @@ bundle exec rake --tasks        # packaging tasks
 bundle exec md2man-roff --help  # run it directly
 bundle exec md2man-html --help  # run it directly
 </code></pre>
-<h2 id="Usage">Usage</h2><h3 id="For-roff-output">For <a href="http://troff.org">roff</a> output</h3><h4 id="At-the-command-line">At the command line</h4><p>See <a class="md2man-xref" href="../man1/md2man-roff.1.html">md2man-roff(1)</a> manual:</p>
+<h2 id="Usage">Usage<a name="Usage" href="#Usage" class="md2man-permalink"></a></h2><h3 id="For-roff-output">For <a href="http://troff.org">roff</a> output<a name="For-roff-output" href="#For-roff-output" class="md2man-permalink"></a></h3><h4 id="At-the-command-line">At the command line<a name="At-the-command-line" href="#At-the-command-line" class="md2man-permalink"></a></h4><p>See <a class="md2man-xref" href="../man1/md2man-roff.1.html">md2man-roff(1)</a> manual:</p>
 <pre><code>md2man-roff --help
 </code></pre>
-<h4 id="Inside-a-Ruby-script">Inside a Ruby script</h4><p>Use the default renderer:</p>
+<h4 id="Inside-a-Ruby-script">Inside a Ruby script<a name="Inside-a-Ruby-script" href="#Inside-a-Ruby-script" class="md2man-permalink"></a></h4><p>Use the default renderer:</p>
 <pre><code>require &#39;md2man/roff/engine&#39;
 
 your_roff_output = Md2Man::Roff::<a class="md2man-xref">ENGINE.render(your_markdown_input)</a>
@@ -69,10 +69,10 @@ end
 engine = Redcarpet::Markdown.new(YourManpageRenderer, your_options_hash)
 your_roff_output = <a class="md2man-xref">engine.render(your_markdown_input)</a>
 </code></pre>
-<h3 id="For-HTML-output">For HTML output</h3><h4 id="At-the-command-line">At the command line</h4><p>See <a class="md2man-xref" href="../man1/md2man-html.1.html">md2man-html(1)</a> manual:</p>
+<h3 id="For-HTML-output">For HTML output<a name="For-HTML-output" href="#For-HTML-output" class="md2man-permalink"></a></h3><h4 id="At-the-command-line">At the command line<a name="At-the-command-line" href="#At-the-command-line" class="md2man-permalink"></a></h4><p>See <a class="md2man-xref" href="../man1/md2man-html.1.html">md2man-html(1)</a> manual:</p>
 <pre><code>md2man-html --help
 </code></pre>
-<h4 id="Inside-a-Ruby-script">Inside a Ruby script</h4><p>Use the default renderer:</p>
+<h4 id="Inside-a-Ruby-script">Inside a Ruby script<a name="Inside-a-Ruby-script" href="#Inside-a-Ruby-script" class="md2man-permalink"></a></h4><p>Use the default renderer:</p>
 <pre><code>require &#39;md2man/html/engine&#39;
 
 your_html_output = Md2Man::HTML::<a class="md2man-xref">ENGINE.render(your_markdown_input)</a>
@@ -104,10 +104,10 @@ end
 engine = Redcarpet::Markdown.new(YourManpageRenderer, your_options_hash)
 your_html_output = <a class="md2man-xref">engine.render(your_markdown_input)</a>
 </code></pre>
-<h3 id="Building-man-pages">Building man pages</h3><h4 id="At-the-command-line">At the command line</h4><p>See <a class="md2man-xref" href="../man1/md2man-rake.1.html">md2man-rake(1)</a> manual:</p>
+<h3 id="Building-man-pages">Building man pages<a name="Building-man-pages" href="#Building-man-pages" class="md2man-permalink"></a></h3><h4 id="At-the-command-line">At the command line<a name="At-the-command-line" href="#At-the-command-line" class="md2man-permalink"></a></h4><p>See <a class="md2man-xref" href="../man1/md2man-rake.1.html">md2man-rake(1)</a> manual:</p>
 <pre><code>md2man-rake --help
 </code></pre>
-<h4 id="Inside-a-Ruby-script">Inside a Ruby script</h4><p>Add this snippet to your gemspec file:</p>
+<h4 id="Inside-a-Ruby-script">Inside a Ruby script<a name="Inside-a-Ruby-script" href="#Inside-a-Ruby-script" class="md2man-permalink"></a></h4><p>Add this snippet to your gemspec file:</p>
 <pre><code>s.files += Dir[&#39;man/man?/*.?&#39;]            # UNIX man pages
 s.files += Dir[&#39;man/**/*.{html,css,js}&#39;]  # HTML man pages
 s.add_development_dependency &#39;md2man&#39;, &#39;~&gt; 2.0&#39;
@@ -122,5 +122,5 @@ tasks and ensures that your manual pages are built for packaging into a gem:</p>
 <pre><code>bundle exec rake build
 gem spec pkg/*.gem | fgrep man/
 </code></pre>
-<h2 id="License">License</h2><p>Released under the ISC license.  See the LICENSE file for details.</p></div></body>
+<h2 id="License">License<a name="License" href="#License" class="md2man-permalink"></a></h2><p>Released under the ISC license.  See the LICENSE file for details.</p></div></body>
 </html>

data/man/man0/VERSION.html

@@ -2,12 +2,21 @@
 <html>
 <head>
   <meta charset="utf-8" />
-  <meta name="generator" content="md2man 2.0.4 https://github.com/sunaku/md2man" />
+  <meta name="generator" content="md2man 2.1.0 https://github.com/sunaku/md2man" />
   <title>VERSION</title>
   <link rel="stylesheet" href="../style.css"/>
   <!--[if lt IE 9]><script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script><![endif]-->
 </head>
-<body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man0">man0</a>/VERSION</span></div></div><div class="container-fluid"><h2 id="Version-2-0-4-2014-04-26">Version 2.0.4 (2014-04-26)</h2><h3 id="Patch">Patch:</h3>
+<body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man0">man0</a>/VERSION</span></div></div><div class="container-fluid"><h2 id="Version-2-1-0-2014-05-04">Version 2.1.0 (2014-05-04)<a name="Version-2-1-0-2014-05-04" href="#Version-2-1-0-2014-05-04" class="md2man-permalink"></a></h2><h3 id="Minor">Minor:<a name="Minor" href="#Minor" class="md2man-permalink"></a></h3>
+<ul>
+<li><p><a class="md2man-xref" href="../man1/md2man-html.1.html">md2man-html(1)</a>: add anchors &amp; permalinks to headings.</p></li>
+<li><p>GH-15: wrap <code>.TH</code> components in stylable HTML spans.</p></li>
+</ul>
+<h3 id="Other">Other:<a name="Other" href="#Other" class="md2man-permalink"></a></h3>
+<ul>
+<li>GH-15: paraphrase <a class="md2man-xref">man-pages(7)</a> description of <code>.TH</code>.</li>
+</ul>
+<h2 id="Version-2-0-4-2014-04-26">Version 2.0.4 (2014-04-26)<a name="Version-2-0-4-2014-04-26" href="#Version-2-0-4-2014-04-26" class="md2man-permalink"></a></h2><h3 id="Patch">Patch:<a name="Patch" href="#Patch" class="md2man-permalink"></a></h3>
 <ul>
 <li><p>GH-16: Redcarpet 3.1 added a third parameter to its <code>header()</code> method.
 This raised an ArgumentError on &quot;wrong number of arguments (3 for 2)&quot;.</p><p>Thanks to zimbatm for contributing this patch.</p></li>
@@ -15,11 +24,11 @@ This raised an ArgumentError on &quot;wrong number of arguments (3 for 2)&quot;.
 This fixes a bug where lines beginning with periods or single quotes
 did not appear when <a class="md2man-xref" href="../man1/md2man-roff.1.html">md2man-roff(1)</a> output was rendered using <a class="md2man-xref">man(1)</a>.</p><p>Thanks to zimbatm for reporting this bug and suggesting how to fix it.</p></li>
 </ul>
-<h2 id="Version-2-0-3-2014-01-16">Version 2.0.3 (2014-01-16)</h2><h3 id="Patch">Patch:</h3>
+<h2 id="Version-2-0-3-2014-01-16">Version 2.0.3 (2014-01-16)<a name="Version-2-0-3-2014-01-16" href="#Version-2-0-3-2014-01-16" class="md2man-permalink"></a></h2><h3 id="Patch">Patch:<a name="Patch" href="#Patch" class="md2man-permalink"></a></h3>
 <ul>
 <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>
 </ul>
-<h2 id="Version-2-0-2-2013-09-08">Version 2.0.2 (2013-09-08)</h2><p>Patch:</p>
+<h2 id="Version-2-0-2-2013-09-08">Version 2.0.2 (2013-09-08)<a name="Version-2-0-2-2013-09-08" href="#Version-2-0-2-2013-09-08" class="md2man-permalink"></a></h2><p>Patch:</p>
 <ul>
 <li><p>GH-14: escape single quotes at beginning of lines</p><p>See the &quot;CONTROL CHARACTERS&quot; section in the <a class="md2man-xref">groff(7)</a> manual for details.</p><p>Thanks to Nick Fagerlund for reporting this bug.</p></li>
 <li><p>escape periods at line beginnings with &amp; escape</p></li>
@@ -31,7 +40,7 @@ did not appear when <a class="md2man-xref" href="../man1/md2man-roff.1.html">md2
 <ul>
 <li>switch from double-quoted strings to single quotes</li>
 </ul>
-<h2 id="Version-2-0-1-2013-08-29">Version 2.0.1 (2013-08-29)</h2><p>Patch:</p>
+<h2 id="Version-2-0-1-2013-08-29">Version 2.0.1 (2013-08-29)<a name="Version-2-0-1-2013-08-29" href="#Version-2-0-1-2013-08-29" class="md2man-permalink"></a></h2><p>Patch:</p>
 <ul>
 <li><p>Use a proper CDN to access Bootstrap 2.3.2 styling in HTML output.</p></li>
 <li><p>Ensure that man/ directory exists for the <code>md2man:web</code> Rake task.</p></li>
@@ -42,7 +51,7 @@ did not appear when <a class="md2man-xref" href="../man1/md2man-roff.1.html">md2
 <li><p>Upgrade dependent gems by running <code>bundle update</code>.</p></li>
 <li><p>minitest 4.7.5 provides spec library via autorun.</p></li>
 </ul>
-<h2 id="Version-2-0-0-2013-05-05">Version 2.0.0 (2013-05-05)</h2><p>This release renames md2man executables and libraries to highlight the fact
+<h2 id="Version-2-0-0-2013-05-05">Version 2.0.0 (2013-05-05)<a name="Version-2-0-0-2013-05-05" href="#Version-2-0-0-2013-05-05" class="md2man-permalink"></a></h2><p>This release renames md2man executables and libraries to highlight the fact
 that md2man provides two processing pathways: one for Roff and one for HTML.</p><p>Major:</p>
 <ul>
 <li><p>Rename <a class="md2man-xref">md2man(1)</a> executable to <a class="md2man-xref" href="../man1/md2man-roff.1.html">md2man-roff(1)</a>.</p></li>
@@ -74,13 +83,13 @@ the output document</li>
 <ul>
 <li>Add <a class="md2man-xref" href="../man5/md2man.5.html">md2man(5)</a> manual page detailing md2man&#39;s markdown file format.</li>
 </ul>
-<h2 id="Version-1-6-2-2013-05-05">Version 1.6.2 (2013-05-05)</h2><p>Patch:</p>
+<h2 id="Version-1-6-2-2013-05-05">Version 1.6.2 (2013-05-05)<a name="Version-1-6-2-2013-05-05" href="#Version-1-6-2-2013-05-05" class="md2man-permalink"></a></h2><p>Patch:</p>
 <ul>
 <li><p>Fix &quot;uninitialized constant Md2Man::VERSION&quot; error in <code>md2man/rakefile</code>.</p></li>
 <li><p>HTML manual page CSS: justify the lines of text just like <a class="md2man-xref">man(1)</a> does.</p></li>
 <li><p>HTML manual page CSS: resize body to allot 78ex width for manpage text.</p></li>
 </ul>
-<h2 id="Version-1-6-1-2013-05-04">Version 1.6.1 (2013-05-04)</h2><p>Patch:</p>
+<h2 id="Version-1-6-1-2013-05-04">Version 1.6.1 (2013-05-04)<a name="Version-1-6-1-2013-05-04" href="#Version-1-6-1-2013-05-04" class="md2man-permalink"></a></h2><p>Patch:</p>
 <ul>
 <li>Replace multi-column CSS with single centered body.</li>
 </ul>
@@ -88,7 +97,7 @@ the output document</li>
 <ul>
 <li>Fix manpage xrefs in README and VERSION documents.</li>
 </ul>
-<h2 id="Version-1-6-0-2013-03-10">Version 1.6.0 (2013-03-10)</h2><p>Minor:</p>
+<h2 id="Version-1-6-0-2013-03-10">Version 1.6.0 (2013-03-10)<a name="Version-1-6-0-2013-03-10" href="#Version-1-6-0-2013-03-10" class="md2man-permalink"></a></h2><p>Minor:</p>
 <ul>
 <li><p>Added an <a class="md2man-xref" href="../man1/md2man-rake.1.html">md2man-rake(1)</a> executable that lets you run md2man&#39;s <a class="md2man-xref">rake(1)</a>
 tasks <em>directly</em> from the command line: without the need for a &quot;Rakefile&quot;
@@ -110,7 +119,7 @@ in your working directory that loads the <code>md2man/rakefile</code> library.</
 <ul>
 <li>add README and VERSION to generated HTML man pages</li>
 </ul>
-<h2 id="Version-1-5-1-2013-03-06">Version 1.5.1 (2013-03-06)</h2><p>Patch:</p>
+<h2 id="Version-1-5-1-2013-03-06">Version 1.5.1 (2013-03-06)<a name="Version-1-5-1-2013-03-06" href="#Version-1-5-1-2013-03-06" class="md2man-permalink"></a></h2><p>Patch:</p>
 <ul>
 <li><p>All this time, this project&#39;s documentation stated that Redcarpet&#39;s
 <code>no_intra_emphasis</code> option was enabled, but in reality, it was not.
@@ -131,7 +140,7 @@ The documentation has been corrected and the option remains disabled.</p></li>
 <li><p>rename HISTORY to VERSION so it sorts after README</p></li>
 <li><p>tests should exercise engines with default options</p></li>
 </ul>
-<h2 id="Version-1-5-0-2013-02-24">Version 1.5.0 (2013-02-24)</h2><p>Minor:</p>
+<h2 id="Version-1-5-0-2013-02-24">Version 1.5.0 (2013-02-24)<a name="Version-1-5-0-2013-02-24" href="#Version-1-5-0-2013-02-24" class="md2man-permalink"></a></h2><p>Minor:</p>
 <ul>
 <li><p>The <code>md2man:web</code> task from <code>md2man/rakefile</code> now:</p>
 <ul>
@@ -145,7 +154,7 @@ The documentation has been corrected and the option remains disabled.</p></li>
 <li><p>README: better organize the subsections of &quot;Usage&quot;</p></li>
 <li><p>include md2man rake tasks in developer&#39;s rakefile</p></li>
 </ul>
-<h2 id="Version-1-4-1-2013-02-23">Version 1.4.1 (2013-02-23)</h2><p>Patch:</p>
+<h2 id="Version-1-4-1-2013-02-23">Version 1.4.1 (2013-02-23)<a name="Version-1-4-1-2013-02-23" href="#Version-1-4-1-2013-02-23" class="md2man-permalink"></a></h2><p>Patch:</p>
 <ul>
 <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>
 <li><p>hook into &#39;build&#39; task only if using Bundler tasks</p><p><a href="https://github.com/sunaku/md2man/pull/7#issuecomment-9467621">https://github.com/sunaku/md2man/pull/7#issuecomment-9467621</a></p><p>Thanks to Postmodern for raising this issue.</p></li>
@@ -156,7 +165,7 @@ The documentation has been corrected and the option remains disabled.</p></li>
 <li><p>README: add <a class="md2man-xref" href="../man1/md2man-html.1.html">md2man-html(1)</a> and Md2Man::HTML usage</p></li>
 <li><p>LICENSE: use GitHub profile URLs instead of e-mail</p></li>
 </ul>
-<h2 id="Version-1-4-0-2012-10-14">Version 1.4.0 (2012-10-14)</h2><p>Minor:</p>
+<h2 id="Version-1-4-0-2012-10-14">Version 1.4.0 (2012-10-14)<a name="Version-1-4-0-2012-10-14" href="#Version-1-4-0-2012-10-14" class="md2man-permalink"></a></h2><p>Minor:</p>
 <ul>
 <li><p>roff: emit non-first H1 headings as H2 headings</p></li>
 <li><p>html: add <code>Md2Man::HTML::Engine</code> class for HTML manual page generation</p></li>
@@ -168,12 +177,12 @@ extension) inside your <code>man/man*/</code> directories.  It also provides
 sub-tasks to build <em>only</em> UNIX or HTML manual pages separately.</p><p>It also hooks into Bundler&#39;s gem packaging tasks to automatically build
 your manual pages for packaging into a gem.  See the README for details.</p></li>
 </ul>
-<h2 id="Version-1-3-2-2012-10-13">Version 1.3.2 (2012-10-13)</h2><p>Patch:</p>
+<h2 id="Version-1-3-2-2012-10-13">Version 1.3.2 (2012-10-13)<a name="Version-1-3-2-2012-10-13" href="#Version-1-3-2-2012-10-13" class="md2man-permalink"></a></h2><p>Patch:</p>
 <ul>
 <li><p>roff: escape backslashes inside codespan nodes too</p></li>
 <li><p>roff: escape backslashes inside block_code nodes</p></li>
 </ul>
-<h2 id="Version-1-3-1-2012-10-09">Version 1.3.1 (2012-10-09)</h2><p>Patch:</p>
+<h2 id="Version-1-3-1-2012-10-09">Version 1.3.1 (2012-10-09)<a name="Version-1-3-1-2012-10-09" href="#Version-1-3-1-2012-10-09" class="md2man-permalink"></a></h2><p>Patch:</p>
 <ul>
 <li><p>roff: do not render references inside code blocks.</p></li>
 <li><p>roff: do not render references inside code spans.</p></li>
@@ -190,13 +199,13 @@ the code block: it appears on the next line and appears ugly in <a class="md2man
 <li><p>document: super() can&#39;t reach Redcarpet&#39;s renderer classes.
 See <a href="https://github.com/vmg/redcarpet/issues/51">https://github.com/vmg/redcarpet/issues/51</a> for details.</p></li>
 </ul>
-<h2 id="Version-1-3-0-2012-09-27">Version 1.3.0 (2012-09-27)</h2><p>Minor:</p>
+<h2 id="Version-1-3-0-2012-09-27">Version 1.3.0 (2012-09-27)<a name="Version-1-3-0-2012-09-27" href="#Version-1-3-0-2012-09-27" class="md2man-permalink"></a></h2><p>Minor:</p>
 <ul>
 <li>Intra-word emphasis is now enabled <em>by default</em> in <code>Md2Man::ENGINE</code>.
 To not be affected by this change, you may still construct your own
 Redcarpet::Markdown engine with your own set of processing options.</li>
 </ul>
-<h2 id="Version-1-2-1-2012-07-05">Version 1.2.1 (2012-07-05)</h2><p>Patch:</p>
+<h2 id="Version-1-2-1-2012-07-05">Version 1.2.1 (2012-07-05)<a name="Version-1-2-1-2012-07-05" href="#Version-1-2-1-2012-07-05" class="md2man-permalink"></a></h2><p>Patch:</p>
 <ul>
 <li>GH-4: ruby 1.8.7 lacks negative lookbehind regexps.
 Thanks to Postmodern for reporting this issue.</li>
@@ -207,7 +216,7 @@ Thanks to Postmodern for reporting this issue.</li>
 See <a href="http://docs.rubygems.org/read/chapter/16">http://docs.rubygems.org/read/chapter/16</a>
 Thanks to Postmodern for this contribution.</li>
 </ul>
-<h2 id="Version-1-2-0-2012-02-06">Version 1.2.0 (2012-02-06)</h2><p>Minor:</p>
+<h2 id="Version-1-2-0-2012-02-06">Version 1.2.0 (2012-02-06)<a name="Version-1-2-0-2012-02-06" href="#Version-1-2-0-2012-02-06" class="md2man-permalink"></a></h2><p>Minor:</p>
 <ul>
 <li>The <code>Md2Man::Document</code> module now handles paragraph() nodes and dispatches
 their content accordingly to hook methods for indented, tagged, and normal
@@ -220,7 +229,7 @@ to markdown syntax programmatically.</li>
 <li><p>README: mention features; revise markdown; cleanup.</p></li>
 <li><p>LICENSE: @tanoku created initial Manpage renderer.</p></li>
 </ul>
-<h2 id="Version-1-1-0-2012-02-02">Version 1.1.0 (2012-02-02)</h2><p>Minor:</p>
+<h2 id="Version-1-1-0-2012-02-02">Version 1.1.0 (2012-02-02)<a name="Version-1-1-0-2012-02-02" href="#Version-1-1-0-2012-02-02" class="md2man-permalink"></a></h2><p>Minor:</p>
 <ul>
 <li>Add <code>Md2Man::Document</code> module for programmatic processing of
 cross-references to other UNIX manual pages within Redcarpet.</li>
@@ -233,7 +242,7 @@ cross-references to other UNIX manual pages within Redcarpet.</li>
 <li><p>README: fix installation commands for development.</p></li>
 <li><p>README: simplify project slogan to be more memorable.</p></li>
 </ul>
-<h2 id="Version-1-0-2-2012-01-09">Version 1.0.2 (2012-01-09)</h2><p>Patch:</p>
+<h2 id="Version-1-0-2-2012-01-09">Version 1.0.2 (2012-01-09)<a name="Version-1-0-2-2012-01-09" href="#Version-1-0-2-2012-01-09" class="md2man-permalink"></a></h2><p>Patch:</p>
 <ul>
 <li><p>Blockquote&#39;s leading paragraph regexp was not anchored.</p></li>
 <li><p>Freezing internal constants prevents monkey patching.</p></li>
@@ -244,7 +253,7 @@ cross-references to other UNIX manual pages within Redcarpet.</li>
 <li><p>Added example input file from the Linux Man Page Howto.</p></li>
 <li><p>Forgot to change project slogan in the gem package.</p></li>
 </ul>
-<h2 id="Version-1-0-1-2011-12-06">Version 1.0.1 (2011-12-06)</h2><p>Major:</p>
+<h2 id="Version-1-0-1-2011-12-06">Version 1.0.1 (2011-12-06)<a name="Version-1-0-1-2011-12-06" href="#Version-1-0-1-2011-12-06" class="md2man-permalink"></a></h2><p>Major:</p>
 <ul>
 <li><p>Renamed the project from &quot;redcarpet-manpage&quot; to &quot;md2man&quot;.</p>
 <ul>
@@ -266,5 +275,5 @@ bold styling.  All that matters is that the subsequent lines are indented.</p></
 <ul>
 <li>Rewrote entire Markdown to Roff conversion from scratch while doing TDD.</li>
 </ul>
-<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></body>
+<h2 id="Version-0-0-1-2011-10-13">Version 0.0.1 (2011-10-13)<a name="Version-0-0-1-2011-10-13" href="#Version-0-0-1-2011-10-13" class="md2man-permalink"></a></h2><p>First release! Happy birthday! Woohoo! :-)</p></div></body>
 </html>

data/man/man0/VERSION.markdown

@@ -1,3 +1,15 @@
+## Version 2.1.0 (2014-05-04)
+
+### Minor:
+
+  * md2man-html(1): add anchors & permalinks to headings.
+
+  * GH-15: wrap `.TH` components in stylable HTML spans.
+
+### Other:
+
+  * GH-15: paraphrase man-pages(7) description of `.TH`.
+
 ## Version 2.0.4 (2014-04-26)
 
 ### Patch:

data/man/man1/md2man-html.1

@@ -1,4 +1,4 @@
-.TH MD2MAN\-HTML 1 2014\-04\-26 2.0.4
+.TH MD2MAN\-HTML 1 2014\-05\-04 2.1.0
 .SH NAME
 .PP
 md2man\-html \- convert 
@@ -18,6 +18,24 @@ flavored
 input from the given
 \fIFILE\fP into HTML and then prints the result to the standard output stream.
 If \fIFILE\fP is not given, then the standard input stream is read in its place.
+.SS Top\-level headings
+.PP
+Each component of the \fB\fC\&.TH\fR directive in 
+.BR roff (7), 
+described under "Top\-level
+headings" in 
+.BR md2man (5), 
+is wrapped in stylable \fB\fC<span>\fR elements as follows:
+.PP
+.RS
+.nf
+<span class="md2man\-title">...</span>
+<span class="md2man\-section">...</span>
+<span class="md2man\-date">...</span>
+<span class="md2man\-source">...</span>
+<span class="md2man\-manual">...</span>
+.fi
+.RE
 .SS Cross references
 .PP
 Cross references to manual pages are emitted as HTML hyperlinks that have

data/man/man1/md2man-html.1.html

@@ -2,17 +2,25 @@
 <html>
 <head>
   <meta charset="utf-8" />
-  <meta name="generator" content="md2man 2.0.4 https://github.com/sunaku/md2man" />
+  <meta name="generator" content="md2man 2.1.0 https://github.com/sunaku/md2man" />
   <title>md2man-html(1) &mdash; convert md2man(5) flavored markdown(7) into HTML</title>
   <link rel="stylesheet" href="../style.css"/>
   <!--[if lt IE 9]><script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script><![endif]-->
 </head>
-<body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man1">man1</a>/md2man-html.1</span></div></div><div class="container-fluid"><h1 id="MD2MAN-HTML-1-2014-04-26-2-0-4">MD2MAN-HTML 1 2014-04-26 2.0.4</h1><h2 id="NAME">NAME</h2><p>md2man-html - convert <a class="md2man-xref" href="../man5/md2man.5.html">md2man(5)</a> flavored <a class="md2man-xref">markdown(7)</a> into HTML</p><h2 id="SYNOPSIS">SYNOPSIS</h2><p><code>md2man-html</code> [<em>OPTION</em>]... [<em>FILE</em>]</p><h2 id="DESCRIPTION">DESCRIPTION</h2><p>This program converts <a class="md2man-xref" href="../man5/md2man.5.html">md2man(5)</a> flavored <a class="md2man-xref">markdown(7)</a> input from the given
+<body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man1">man1</a>/md2man-html.1</span></div></div><div class="container-fluid"><h1 id="MD2MAN-HTML-1-2014-05-04-2-1-0"><span class="md2man-title">MD2MAN-HTML</span> <span class="md2man-section">1</span> <span class="md2man-date">2014-05-04</span> <span class="md2man-source">2.1.0</span><a name="MD2MAN-HTML-1-2014-05-04-2-1-0" href="#MD2MAN-HTML-1-2014-05-04-2-1-0" class="md2man-permalink"></a></h1><h2 id="NAME">NAME<a name="NAME" href="#NAME" class="md2man-permalink"></a></h2><p>md2man-html - convert <a class="md2man-xref" href="../man5/md2man.5.html">md2man(5)</a> flavored <a class="md2man-xref">markdown(7)</a> into HTML</p><h2 id="SYNOPSIS">SYNOPSIS<a name="SYNOPSIS" href="#SYNOPSIS" class="md2man-permalink"></a></h2><p><code>md2man-html</code> [<em>OPTION</em>]... [<em>FILE</em>]</p><h2 id="DESCRIPTION">DESCRIPTION<a name="DESCRIPTION" href="#DESCRIPTION" class="md2man-permalink"></a></h2><p>This program converts <a class="md2man-xref" href="../man5/md2man.5.html">md2man(5)</a> flavored <a class="md2man-xref">markdown(7)</a> input from the given
 <em>FILE</em> into HTML and then prints the result to the standard output stream.
-If <em>FILE</em> is not given, then the standard input stream is read in its place.</p><h3 id="Cross-references">Cross references</h3><p>Cross references to manual pages are emitted as HTML hyperlinks that have
+If <em>FILE</em> is not given, then the standard input stream is read in its place.</p><h3 id="Top-level-headings">Top-level headings<a name="Top-level-headings" href="#Top-level-headings" class="md2man-permalink"></a></h3><p>Each component of the <code>.TH</code> directive in <a class="md2man-xref">roff(7)</a>, described under &quot;Top-level
+headings&quot; in <a class="md2man-xref" href="../man5/md2man.5.html">md2man(5)</a>, is wrapped in stylable <code>&lt;span&gt;</code> elements as follows:</p>
+<pre><code>&lt;span class=&quot;md2man-title&quot;&gt;...&lt;/span&gt;
+&lt;span class=&quot;md2man-section&quot;&gt;...&lt;/span&gt;
+&lt;span class=&quot;md2man-date&quot;&gt;...&lt;/span&gt;
+&lt;span class=&quot;md2man-source&quot;&gt;...&lt;/span&gt;
+&lt;span class=&quot;md2man-manual&quot;&gt;...&lt;/span&gt;
+</code></pre>
+<h3 id="Cross-references">Cross references<a name="Cross-references" href="#Cross-references" class="md2man-permalink"></a></h3><p>Cross references to manual pages are emitted as HTML hyperlinks that have
 <code>class=&quot;md2man-xref&quot;</code> and <code>href=&quot;../man$SECTION/$PAGE.$SECTION.html&quot;</code>
 attributes.</p><p>For example, the <code><a class="md2man-xref">printf(3)</a></code> cross reference would be emitted as this HTML:</p>
 <pre><code>&lt;a class=&quot;md2man-xref&quot; href=&quot;../man3/printf.3.html&quot;&gt;<a class="md2man-xref">printf(3)</a>&lt;/a&gt;
 </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="md2man-xref" href="../man1/md2man-roff.1.html">md2man-roff(1)</a>, <a class="md2man-xref" href="../man1/md2man-rake.1.html">md2man-rake(1)</a>, <a class="md2man-xref" href="../man5/md2man.5.html">md2man(5)</a></p></div></body>
+<h2 id="OPTIONS">OPTIONS<a name="OPTIONS" href="#OPTIONS" class="md2man-permalink"></a></h2><dl><dt><code>-h</code>, <code>--help</code></dt><dd>Show this help manual.</dd></dl><h2 id="SEE-ALSO">SEE ALSO<a name="SEE-ALSO" href="#SEE-ALSO" class="md2man-permalink"></a></h2><p><a class="md2man-xref" href="../man1/md2man-roff.1.html">md2man-roff(1)</a>, <a class="md2man-xref" href="../man1/md2man-rake.1.html">md2man-rake(1)</a>, <a class="md2man-xref" href="../man5/md2man.5.html">md2man(5)</a></p></div></body>
 </html>

data/man/man1/md2man-rake.1

@@ -1,4 +1,4 @@
-.TH MD2MAN\-RAKE 1 2014\-04\-26 2.0.4
+.TH MD2MAN\-RAKE 1 2014\-05\-04 2.1.0
 .SH NAME
 .PP
 md2man\-rake \- run 

data/man/man1/md2man-rake.1.html

@@ -2,16 +2,16 @@
 <html>
 <head>
   <meta charset="utf-8" />
-  <meta name="generator" content="md2man 2.0.4 https://github.com/sunaku/md2man" />
+  <meta name="generator" content="md2man 2.1.0 https://github.com/sunaku/md2man" />
   <title>md2man-rake(1) &mdash; run rake(1) tasks from md2man(1)</title>
   <link rel="stylesheet" href="../style.css"/>
   <!--[if lt IE 9]><script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script><![endif]-->
 </head>
-<body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man1">man1</a>/md2man-rake.1</span></div></div><div class="container-fluid"><h1 id="MD2MAN-RAKE-1-2014-04-26-2-0-4">MD2MAN-RAKE 1 2014-04-26 2.0.4</h1><h2 id="NAME">NAME</h2><p>md2man-rake - run <a class="md2man-xref">rake(1)</a> tasks from <a class="md2man-xref">md2man(1)</a></p><h2 id="SYNOPSIS">SYNOPSIS</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="md2man-xref">rake(1)</a> tasks provided by <a class="md2man-xref">md2man(1)</a> without having
+<body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man1">man1</a>/md2man-rake.1</span></div></div><div class="container-fluid"><h1 id="MD2MAN-RAKE-1-2014-05-04-2-1-0"><span class="md2man-title">MD2MAN-RAKE</span> <span class="md2man-section">1</span> <span class="md2man-date">2014-05-04</span> <span class="md2man-source">2.1.0</span><a name="MD2MAN-RAKE-1-2014-05-04-2-1-0" href="#MD2MAN-RAKE-1-2014-05-04-2-1-0" class="md2man-permalink"></a></h1><h2 id="NAME">NAME<a name="NAME" href="#NAME" class="md2man-permalink"></a></h2><p>md2man-rake - run <a class="md2man-xref">rake(1)</a> tasks from <a class="md2man-xref">md2man(1)</a></p><h2 id="SYNOPSIS">SYNOPSIS<a name="SYNOPSIS" href="#SYNOPSIS" class="md2man-permalink"></a></h2><p><code>md2man-rake</code> [<em>OPTION</em>]... [<em>TASK</em>]...</p><h2 id="DESCRIPTION">DESCRIPTION<a name="DESCRIPTION" href="#DESCRIPTION" class="md2man-permalink"></a></h2><p>This program lets you run <a class="md2man-xref">rake(1)</a> tasks provided by <a class="md2man-xref">md2man(1)</a> without having
 to create a special file named <code>Rakefile</code> that contains the following snippet:</p>
 <pre><code>require &#39;md2man/rakefile&#39;
 </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
+<p>If no <em>TASK</em> is specified, then the <code>md2man</code> task is run by default.</p><h2 id="TASKS">TASKS<a name="TASKS" href="#TASKS" class="md2man-permalink"></a></h2><dl><dt><code>md2man</code></dt><dd>Runs the <code>md2man:man</code> and <code>md2man:web</code> tasks, in that order.</dd></dl><dl><dt><code>md2man:man</code></dt><dd>Builds UNIX manual pages from <code>*.markdown</code>, <code>*.mkd</code>, and <code>*.md</code> files
 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
-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="md2man-xref">rake(1)</a>, <a class="md2man-xref" href="../man1/md2man-roff.1.html">md2man-roff(1)</a>, <a class="md2man-xref" href="../man1/md2man-html.1.html">md2man-html(1)</a>, <a class="md2man-xref" href="../man5/md2man.5.html">md2man(5)</a></p></div></body>
+found in or beneath the <code>man/</code> subdirectory in your working directory.</dd></dl><h2 id="OPTIONS">OPTIONS<a name="OPTIONS" href="#OPTIONS" class="md2man-permalink"></a></h2><dl><dt><code>-h</code>, <code>--help</code></dt><dd>Show this help manual.</dd></dl><p>Run <code>rake --help</code> to see more options.</p><h2 id="SEE-ALSO">SEE ALSO<a name="SEE-ALSO" href="#SEE-ALSO" class="md2man-permalink"></a></h2><p><a class="md2man-xref">rake(1)</a>, <a class="md2man-xref" href="../man1/md2man-roff.1.html">md2man-roff(1)</a>, <a class="md2man-xref" href="../man1/md2man-html.1.html">md2man-html(1)</a>, <a class="md2man-xref" href="../man5/md2man.5.html">md2man(5)</a></p></div></body>
 </html>

data/man/man1/md2man-roff.1

@@ -1,4 +1,4 @@
-.TH MD2MAN\-ROFF 1 2014\-04\-26 2.0.4
+.TH MD2MAN\-ROFF 1 2014\-05\-04 2.1.0
 .SH NAME
 .PP
 md2man\-roff \- convert 

data/man/man1/md2man-roff.1.html

@@ -2,14 +2,14 @@
 <html>
 <head>
   <meta charset="utf-8" />
-  <meta name="generator" content="md2man 2.0.4 https://github.com/sunaku/md2man" />
+  <meta name="generator" content="md2man 2.1.0 https://github.com/sunaku/md2man" />
   <title>md2man-roff(1) &mdash; convert md2man(5) flavored markdown(7) into roff(7)</title>
   <link rel="stylesheet" href="../style.css"/>
   <!--[if lt IE 9]><script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script><![endif]-->
 </head>
-<body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man1">man1</a>/md2man-roff.1</span></div></div><div class="container-fluid"><h1 id="MD2MAN-ROFF-1-2014-04-26-2-0-4">MD2MAN-ROFF 1 2014-04-26 2.0.4</h1><h2 id="NAME">NAME</h2><p>md2man-roff - convert <a class="md2man-xref" href="../man5/md2man.5.html">md2man(5)</a> flavored <a class="md2man-xref">markdown(7)</a> into <a class="md2man-xref">roff(7)</a></p><h2 id="SYNOPSIS">SYNOPSIS</h2><p><code>md2man-roff</code> [<em>OPTION</em>]... [<em>FILE</em>]</p><h2 id="DESCRIPTION">DESCRIPTION</h2><p>This program converts <a class="md2man-xref" href="../man5/md2man.5.html">md2man(5)</a> flavored <a class="md2man-xref">markdown(7)</a> input from the given
+<body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man1">man1</a>/md2man-roff.1</span></div></div><div class="container-fluid"><h1 id="MD2MAN-ROFF-1-2014-05-04-2-1-0"><span class="md2man-title">MD2MAN-ROFF</span> <span class="md2man-section">1</span> <span class="md2man-date">2014-05-04</span> <span class="md2man-source">2.1.0</span><a name="MD2MAN-ROFF-1-2014-05-04-2-1-0" href="#MD2MAN-ROFF-1-2014-05-04-2-1-0" class="md2man-permalink"></a></h1><h2 id="NAME">NAME<a name="NAME" href="#NAME" class="md2man-permalink"></a></h2><p>md2man-roff - convert <a class="md2man-xref" href="../man5/md2man.5.html">md2man(5)</a> flavored <a class="md2man-xref">markdown(7)</a> into <a class="md2man-xref">roff(7)</a></p><h2 id="SYNOPSIS">SYNOPSIS<a name="SYNOPSIS" href="#SYNOPSIS" class="md2man-permalink"></a></h2><p><code>md2man-roff</code> [<em>OPTION</em>]... [<em>FILE</em>]</p><h2 id="DESCRIPTION">DESCRIPTION<a name="DESCRIPTION" href="#DESCRIPTION" class="md2man-permalink"></a></h2><p>This program converts <a class="md2man-xref" href="../man5/md2man.5.html">md2man(5)</a> flavored <a class="md2man-xref">markdown(7)</a> input from the given
 <em>FILE</em> into <a class="md2man-xref">roff(7)</a> and then prints the result to the standard output stream.
-If <em>FILE</em> is not given, then the standard input stream is read in its place.</p><h3 id="Limitations">Limitations</h3><p>This program does not convert the following <a href="https://github.com/vmg/redcarpet">Redcarpet</a> nodes into <a class="md2man-xref">roff(7)</a>:</p>
+If <em>FILE</em> is not given, then the standard input stream is read in its place.</p><h3 id="Limitations">Limitations<a name="Limitations" href="#Limitations" class="md2man-permalink"></a></h3><p>This program does not convert the following <a href="https://github.com/vmg/redcarpet">Redcarpet</a> nodes into <a class="md2man-xref">roff(7)</a>:</p>
 <ul>
 <li><code>block_html</code></li>
 <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
 <li><code>image</code></li>
 <li><code>raw_html</code></li>
 </ul>
-<p>It issues a warning when it encounters these instead.  Patches are welcome!</p><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="md2man-xref" href="../man1/md2man-html.1.html">md2man-html(1)</a>, <a class="md2man-xref" href="../man1/md2man-rake.1.html">md2man-rake(1)</a>, <a class="md2man-xref" href="../man5/md2man.5.html">md2man(5)</a></p></div></body>
+<p>It issues a warning when it encounters these instead.  Patches are welcome!</p><h2 id="OPTIONS">OPTIONS<a name="OPTIONS" href="#OPTIONS" class="md2man-permalink"></a></h2><dl><dt><code>-h</code>, <code>--help</code></dt><dd>Show this help manual.</dd></dl><h2 id="SEE-ALSO">SEE ALSO<a name="SEE-ALSO" href="#SEE-ALSO" class="md2man-permalink"></a></h2><p><a class="md2man-xref" href="../man1/md2man-html.1.html">md2man-html(1)</a>, <a class="md2man-xref" href="../man1/md2man-rake.1.html">md2man-rake(1)</a>, <a class="md2man-xref" href="../man5/md2man.5.html">md2man(5)</a></p></div></body>
 </html>

data/man/man5/md2man.5

@@ -1,4 +1,4 @@
-.TH MD2MAN 5 2014\-04\-26 2.0.4
+.TH MD2MAN 5 2014\-05\-04 2.1.0
 .SH NAME
 .PP
 md2man \- manual page flavoring for the 
@@ -84,11 +84,36 @@ md2man extends
 semantics by treating top\-level headings specially.
 .SS Top\-level headings
 .PP
-The first top\-level heading (H1) found in the input is considered to be the
+The first top\-level \fB\fC<h1>\fR heading found in the input is considered to be the
 \fB\fC\&.TH\fR directive in 
 .BR roff (7), 
-which defines the UNIX manual page's header and
-footer.  Any subsequent top\-level headings are treated as second\-level (H2).
+as described under "Title line" in 
+.BR man-pages (7):
+.PP
+.RS
+.RS
+.nf
+\&.TH title section date source manual
+.fi
+.RE
+.TP
+title
+The title of the man page, written in all caps (e.g., \fB\fCMAN\-PAGES\fR).
+.TP
+section
+The section number in which the man page should be placed (e.g., \fB\fC7\fR).
+.TP
+date
+The date of the last revision, written in the form YYYY\-MM\-DD.
+.TP
+source
+The source of the command, function, or system call (e.g., \fB\fCLinux\fR).
+.TP
+manual
+The title of the manual (e.g., \fB\fCLinux Programmer's Manual\fR).
+.RE
+.PP
+Any subsequent top\-level headings are treated as second\-level \fB\fC<h2>\fR headings.
 .SS Extensions
 .PP
 md2man enables the following Redcarpet
@@ -111,6 +136,7 @@ fenced_code_blocks
 .SH SEE ALSO
 .PP
 .BR markdown (7), 
+.BR man-pages (7), 
 .BR md2man-roff (1), 
 .BR md2man-html (1), 
 .BR md2man-rake (1)

data/man/man5/md2man.5.html

@@ -2,13 +2,13 @@
 <html>
 <head>
   <meta charset="utf-8" />
-  <meta name="generator" content="md2man 2.0.4 https://github.com/sunaku/md2man" />
+  <meta name="generator" content="md2man 2.1.0 https://github.com/sunaku/md2man" />
   <title>md2man(5) &mdash; manual page flavoring for the markdown(7) file format</title>
   <link rel="stylesheet" href="../style.css"/>
   <!--[if lt IE 9]><script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script><![endif]-->
 </head>
-<body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man5">man5</a>/md2man.5</span></div></div><div class="container-fluid"><h1 id="MD2MAN-5-2014-04-26-2-0-4">MD2MAN 5 2014-04-26 2.0.4</h1><h2 id="NAME">NAME</h2><p>md2man - manual page flavoring for the <a class="md2man-xref">markdown(7)</a> file format</p><h2 id="DESCRIPTION">DESCRIPTION</h2><p><a href="https://github.com/sunaku/md2man">md2man</a> makes the <a class="md2man-xref">markdown(7)</a> file format friendly for writing UNIX manual
-pages by extending its syntax, semantics, and assumed processing extensions.</p><h3 id="Syntax">Syntax</h3><p>md2man extends <a class="md2man-xref">markdown(7)</a> syntax by defining three kinds of paragraphs.</p>
+<body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man5">man5</a>/md2man.5</span></div></div><div class="container-fluid"><h1 id="MD2MAN-5-2014-05-04-2-1-0"><span class="md2man-title">MD2MAN</span> <span class="md2man-section">5</span> <span class="md2man-date">2014-05-04</span> <span class="md2man-source">2.1.0</span><a name="MD2MAN-5-2014-05-04-2-1-0" href="#MD2MAN-5-2014-05-04-2-1-0" class="md2man-permalink"></a></h1><h2 id="NAME">NAME<a name="NAME" href="#NAME" class="md2man-permalink"></a></h2><p>md2man - manual page flavoring for the <a class="md2man-xref">markdown(7)</a> file format</p><h2 id="DESCRIPTION">DESCRIPTION<a name="DESCRIPTION" href="#DESCRIPTION" class="md2man-permalink"></a></h2><p><a href="https://github.com/sunaku/md2man">md2man</a> makes the <a class="md2man-xref">markdown(7)</a> file format friendly for writing UNIX manual
+pages by extending its syntax, semantics, and assumed processing extensions.</p><h3 id="Syntax">Syntax<a name="Syntax" href="#Syntax" class="md2man-permalink"></a></h3><p>md2man extends <a class="md2man-xref">markdown(7)</a> syntax by defining three kinds of paragraphs.</p>
 <pre><code>This is a
 normal
 paragraph.
@@ -26,7 +26,7 @@ This
   normal
    paragraph.
 </code></pre>
-<h4 id="Normal-paragraphs">Normal paragraphs</h4><p>Paragraphs whose lines are all indented by exactly zero or one additional
+<h4 id="Normal-paragraphs">Normal paragraphs<a name="Normal-paragraphs" href="#Normal-paragraphs" class="md2man-permalink"></a></h4><p>Paragraphs whose lines are all indented by exactly zero or one additional
 spaces are considered to be &quot;normal paragraphs&quot;.  For example:</p>
 <pre><code>This is a
 normal
@@ -37,22 +37,26 @@ This
   normal
    paragraph.
 </code></pre>
-<h4 id="Tagged-paragraphs">Tagged paragraphs</h4><p>Paragraphs whose first line is indented by less than two additional spaces and
+<h4 id="Tagged-paragraphs">Tagged paragraphs<a name="Tagged-paragraphs" href="#Tagged-paragraphs" class="md2man-permalink"></a></h4><p>Paragraphs whose first line is indented by less than two additional spaces and
 whose subsequent lines are uniformly indented by exactly two additional spaces
 are considered to be &quot;tagged paragraphs&quot;.  For example:</p>
 <pre><code>This is a
   tagged
   paragraph.
 </code></pre>
-<h4 id="Indented-paragraphs">Indented paragraphs</h4><p>Paragraphs whose lines are all uniformly indented by exactly two additional
+<h4 id="Indented-paragraphs">Indented paragraphs<a name="Indented-paragraphs" href="#Indented-paragraphs" class="md2man-permalink"></a></h4><p>Paragraphs whose lines are all uniformly indented by exactly two additional
 spaces are considered to be &quot;indented paragraphs&quot;.  For example:</p>
 <pre><code>  This is an
   indented
   paragraph.
 </code></pre>
-<h3 id="Semantics">Semantics</h3><p>md2man extends <a class="md2man-xref">markdown(7)</a> semantics by treating top-level headings specially.</p><h4 id="Top-level-headings">Top-level headings</h4><p>The first top-level heading (H1) found in the input is considered to be the
-<code>.TH</code> directive in <a class="md2man-xref">roff(7)</a>, which defines the UNIX manual page&#39;s header and
-footer.  Any subsequent top-level headings are treated as second-level (H2).</p><h3 id="Extensions">Extensions</h3><p>md2man enables the following <a href="https://github.com/vmg/redcarpet">Redcarpet</a> extensions while reading <a class="md2man-xref">markdown(7)</a>:</p>
+<h3 id="Semantics">Semantics<a name="Semantics" href="#Semantics" class="md2man-permalink"></a></h3><p>md2man extends <a class="md2man-xref">markdown(7)</a> semantics by treating top-level headings specially.</p><h4 id="Top-level-headings">Top-level headings<a name="Top-level-headings" href="#Top-level-headings" class="md2man-permalink"></a></h4><p>The first top-level <code>&lt;h1&gt;</code> heading found in the input is considered to be the
+<code>.TH</code> directive in <a class="md2man-xref">roff(7)</a>, as described under &quot;Title line&quot; in <a class="md2man-xref">man-pages(7)</a>:</p>
+<blockquote>
+<pre><code>.TH title section date source manual
+</code></pre>
+<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&#39;s Manual</code>).</dd></dl></blockquote>
+<p>Any subsequent top-level headings are treated as second-level <code>&lt;h2&gt;</code> headings.</p><h3 id="Extensions">Extensions<a name="Extensions" href="#Extensions" class="md2man-permalink"></a></h3><p>md2man enables the following <a href="https://github.com/vmg/redcarpet">Redcarpet</a> extensions while reading <a class="md2man-xref">markdown(7)</a>:</p>
 <ul>
 <li>tables</li>
 <li>autolink</li>
@@ -60,5 +64,5 @@ footer.  Any subsequent top-level headings are treated as second-level (H2).</p>
 <li>strikethrough</li>
 <li>fenced_code_blocks</li>
 </ul>
-<h2 id="SEE-ALSO">SEE ALSO</h2><p><a class="md2man-xref">markdown(7)</a>, <a class="md2man-xref" href="../man1/md2man-roff.1.html">md2man-roff(1)</a>, <a class="md2man-xref" href="../man1/md2man-html.1.html">md2man-html(1)</a>, <a class="md2man-xref" href="../man1/md2man-rake.1.html">md2man-rake(1)</a></p></div></body>
+<h2 id="SEE-ALSO">SEE ALSO<a name="SEE-ALSO" href="#SEE-ALSO" class="md2man-permalink"></a></h2><p><a class="md2man-xref">markdown(7)</a>, <a class="md2man-xref">man-pages(7)</a>, <a class="md2man-xref" href="../man1/md2man-roff.1.html">md2man-roff(1)</a>, <a class="md2man-xref" href="../man1/md2man-html.1.html">md2man-html(1)</a>, <a class="md2man-xref" href="../man1/md2man-rake.1.html">md2man-rake(1)</a></p></div></body>
 </html>

data/man/man5/md2man.5.markdown

@@ -1,4 +1,4 @@
-# MD2MAN 5 2014-04-26 2.0.4
+# MD2MAN 5 2014-05-04 2.1.0
 
 ## NAME
 
@@ -69,9 +69,27 @@ md2man extends markdown(7) semantics by treating top-level headings specially.
 
 #### Top-level headings
 
-The first top-level heading (H1) found in the input is considered to be the
-`.TH` directive in roff(7), which defines the UNIX manual page's header and
-footer.  Any subsequent top-level headings are treated as second-level (H2).
+The first top-level `<h1>` heading found in the input is considered to be the
+`.TH` directive in roff(7), as described under "Title line" in man-pages(7):
+
+>     .TH title section date source manual
+>
+> title
+>   The title of the man page, written in all caps (e.g., `MAN-PAGES`).
+>
+> section
+>   The section number in which the man page should be placed (e.g., `7`).
+>
+> date
+>   The date of the last revision, written in the form YYYY-MM-DD.
+>
+> source
+>   The source of the command, function, or system call (e.g., `Linux`).
+>
+> manual
+>   The title of the manual (e.g., `Linux Programmer's Manual`).
+
+Any subsequent top-level headings are treated as second-level `<h2>` headings.
 
 ### Extensions
 
@@ -85,7 +103,7 @@ md2man enables the following [Redcarpet] extensions while reading markdown(7):
 
 ## SEE ALSO
 
-markdown(7), md2man-roff(1), md2man-html(1), md2man-rake(1)
+markdown(7), man-pages(7), md2man-roff(1), md2man-html(1), md2man-rake(1)
 
 [md2man]: https://github.com/sunaku/md2man
 [Redcarpet]: https://github.com/vmg/redcarpet

data/man/style.css

@@ -31,6 +31,20 @@
     font-size: smaller;
     text-align: right;
   }
+
+  h1:first-child > a.md2man-permalink {
+    display: none;
+  }
+
+  a.md2man-permalink:after {
+    padding-left: 0.25em;
+    content: '\2665'; /* ♥ */
+    opacity: 0.125;
+  }
+
+  a.md2man-permalink:hover:after {
+    opacity: initial;
+  }
 }
 
 @media print {

data/test/md2man/html_test.rb

@@ -141,11 +141,11 @@ describe 'html engine' do
       |#### qux (MOZ)
       |##### {m}oz END
     INPUT
-<h1 id="foo-BAR">foo <em>BAR</em></h1>\
-<h2 id="bar-BAZ">bar BAZ</h2>\
-<h3 id="BAZ-QUX">--BAZ-QUX--</h3>\
-<h4 id="qux-MOZ">qux (MOZ)</h4>\
-<h5 id="m-oz-END">{m}oz END</h5>
+<h1 id="foo-BAR"><span class=\"md2man-title\">foo</span> <span class=\"md2man-section\"><em>BAR</em></span><a name="foo-BAR" href="#foo-BAR" class="md2man-permalink"></a></h1>\
+<h2 id="bar-BAZ">bar BAZ<a name="bar-BAZ" href="#bar-BAZ" class="md2man-permalink"></a></h2>\
+<h3 id="BAZ-QUX">--BAZ-QUX--<a name="BAZ-QUX" href="#BAZ-QUX" class="md2man-permalink"></a></h3>\
+<h4 id="qux-MOZ">qux (MOZ)<a name="qux-MOZ" href="#qux-MOZ" class="md2man-permalink"></a></h4>\
+<h5 id="m-oz-END">{m}oz END<a name="m-oz-END" href="#m-oz-END" class="md2man-permalink"></a></h5>
     OUTPUT
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: md2man
 version: !ruby/object:Gem::Version
-  version: 2.0.4
+  version: 2.1.0
 platform: ruby
 authors:
 - Suraj N. Kurapati
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-27 00:00:00.000000000 Z
+date: 2014-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: binman