md2man 5.0.3 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fed108c801a748ce17e7b401494b90ff77b3a18a
-  data.tar.gz: 7bb491d3120e92aa877f537683634d5ef53b350b
+  metadata.gz: e2b43ab0002aa28599a544ae6b69821c1beb5c0c
+  data.tar.gz: 1f648fe79e0cad50810c1b4c6d2dca2d6dd438c8
 SHA512:
-  metadata.gz: dd28d0dfad989ae8ac9d476f7a8a24ab61d08b90fa1efca4dea2f38ee111dccbd5341d25ab586335206f7156944521d1e8057501a569922e10eebad6ef898cbb
-  data.tar.gz: 6507bcc13ae9c1ff181423648c15867884e85e99a34c8d22be52f31f055287afbbead53413688a3e5d2ed146cb787f3729621d3172a4b32b21653e33e00eebfb
+  metadata.gz: f9d194ed93f611e4e65fcb19c510aa1d8f434cd9bb48120a8d0e14e79fbfebf00e3e092b5dc53e4d2e1a7190599f9006c6de9dc525ae598a5bd81bdaf5db9d08
+  data.tar.gz: b4c861ff0edd218ada2239e764283ed443114fb7ac0a1e8c6cb6e44f85eca86c2e78fd4de16b1d1a0fbff4841500f6942db3f4e0732fd22404b686ebc05f320c

data/README.markdown

@@ -5,7 +5,7 @@
 # md2man - markdown to manpage
 
 md2man is a Ruby library and a set of command-line programs that convert
-[Markdown] into UNIX manual pages (both [roff] and HTML) using [Redcarpet].
+[Markdown] into UNIX manpages as well as HTML webpages using [Redcarpet].
 
 ## Features
 
@@ -188,7 +188,7 @@ engine = Redcarpet::Markdown.new(YourManpageRenderer, your_options_hash)
 your_html_output = engine.render(your_markdown_input)
 ```
 
-### Building man pages
+### Building manpages
 
 #### At the command line
 
@@ -203,8 +203,8 @@ md2man-rake --help
 Add this snippet to your gemspec file:
 
 ```ruby
-s.files += Dir['man/man?/*.?']            # UNIX man pages
-s.files += Dir['man/**/*.{html,css,js}']  # HTML man pages
+s.files += Dir['man/man?/*.?']         # UNIX manpages
+s.files += Dir['man/**/*.{html,css}']  # HTML manpages
 s.add_development_dependency 'md2man', '~> 5.0'
 ```
 
@@ -231,6 +231,6 @@ gem spec pkg/*.gem | fgrep man/
 Released under the ISC license.  See the LICENSE file for details.
 
 [roff]: http://troff.org
-[Markdown]: http://daringfireball.net/projects/markdown/
 [Redcarpet]: https://github.com/vmg/redcarpet
+[Markdown]: http://daringfireball.net/projects/markdown/
 [tables]: http://michelf.com/projects/php-markdown/extra/#table

data/VERSION.markdown

@@ -1,3 +1,27 @@
+## Version 5.1.0 (2016-02-28)
+
+### Minor:
+
+  * md2man-html(1): add syntax highlighting to fenced code blocks.
+
+  * md2man-rake(1): add directory name to README and "man/index" title.
+
+    Fallback to adding directory name for standalone titles, such as "README"
+    and "man/index", so that users know what project those manuals belong to.
+
+  * md2man-rake(1): allow running task names without namespace.
+
+    You can now run `md2man-rake man` instead of `md2man-rake md2man:man`,
+    and similarly `md2man-rake web` instead of `md2man-rake md2man:web`.
+
+### Patch:
+
+  * Clarify optionalness of PATTERN in `--help` option.
+
+  * md2man(5): paragraph types reflect .PP, .TP, .IP.
+
+  * Link to Markdown website instead of markdown(7).
+
 ## Version 5.0.3 (2016-02-21)
 
 This release fixes a crash, fixes roff bugs, improves CSS styling for HTML

data/bin/md2man-html

@@ -1,11 +1,11 @@
 #!/usr/bin/env ruby
 =begin =======================================================================
 
-# MD2MAN-HTML 1                   2016-02-21                            5.0.3
+# MD2MAN-HTML 1                   2016-02-28                            5.1.0
 
 ## NAME
 
-md2man-html - convert md2man(5) flavored markdown(7) into HTML
+md2man-html - convert md2man(5) flavored [Markdown] text into HTML
 
 ## SYNOPSIS
 
@@ -13,7 +13,7 @@ md2man-html - convert md2man(5) flavored markdown(7) into HTML
 
 ## DESCRIPTION
 
-This program converts md2man(5) flavored markdown(7) input from the given
+This program converts the md2man(5) flavored [Markdown] text 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.
 
@@ -22,11 +22,13 @@ If *FILE* is not given, then the standard input stream is read in its place.
 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>
+```html
+<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>
+```
 
 ### Heading permalinks
 
@@ -36,19 +38,23 @@ lowercase, and squeezed and stripped of HTML tags and non-word characters.
 
 For example, a heading labeled `Ver<s>iON 3(2</s>!4)))` would be emitted as:
 
-    <h2 id="ver-ion-3-2-4">Ver<s>iON 3(2</s>!4)))<a name="ver-ion-3-2-4"
-    href="#ver-ion-3-2-4" class="md2man-permalink" title="permalink"></a></h2>
+```html
+<h2 id="ver-ion-3-2-4">Ver<s>iON 3(2</s>!4)))<a name="ver-ion-3-2-4"
+href="#ver-ion-3-2-4" class="md2man-permalink" title="permalink"></a></h2>
+```
 
 For example, multiple headings labeled `Hello, world!` would be emitted as:
 
-    <h2 id="hello-world">Hello, world!<a name="hello-world"
-    href="#hello-world" class="md2man-permalink" title="permalink"></a></h2>
+```html
+<h2 id="hello-world">Hello, world!<a name="hello-world"
+href="#hello-world" class="md2man-permalink" title="permalink"></a></h2>
 
-    <h2 id="hello-world-1">Hello, world!<a name="hello-world-1"
-    href="#hello-world-1" class="md2man-permalink" title="permalink"></a></h2>
+<h2 id="hello-world-1">Hello, world!<a name="hello-world-1"
+href="#hello-world-1" class="md2man-permalink" title="permalink"></a></h2>
 
-    <h2 id="hello-world-2">Hello, world!<a name="hello-world-2"
-    href="#hello-world-2" class="md2man-permalink" title="permalink"></a></h2>
+<h2 id="hello-world-2">Hello, world!<a name="hello-world-2"
+href="#hello-world-2" class="md2man-permalink" title="permalink"></a></h2>
+```
 
 ### Cross references
 
@@ -58,16 +64,20 @@ attributes.
 
 For example, the `printf(3)` cross reference would be emitted as this HTML:
 
-    <a class="md2man-reference" href="../man3/printf.3.html">printf(3)</a>
+```html
+<a class="md2man-reference" href="../man3/printf.3.html">printf(3)</a>
+```
 
 ## OPTIONS
 
 `-h` [*PATTERN*], `--help` [*PATTERN*]
-  Show this help manual and search for *PATTERN* regular expression therein.
+  Show this help manual and optionally search for *PATTERN* regular expression.
 
 ## SEE ALSO
 
-md2man-roff(1), md2man-rake(1), md2man(5)
+md2man-roff(1), md2man-rake(1), md2man(5), [Markdown]
+
+[Markdown]: http://daringfireball.net/projects/markdown/syntax
 
 =end =========================================================================
 

data/bin/md2man-rake

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 =begin =======================================================================
 
-# MD2MAN-RAKE 1                   2016-02-21                            5.0.3
+# MD2MAN-RAKE 1                   2016-02-28                            5.1.0
 
 ## NAME
 
@@ -25,20 +25,21 @@ If no *TASK* is specified, then the `md2man` task is run by default.
 `md2man`
   Runs the `md2man:man` and `md2man:web` tasks, in that order.
 
-`md2man:man`
+`md2man:man` or `man`
   Builds UNIX manual pages from `*.markdown`, `*.mkd`, and `*.md` files
   found in or beneath the `man/` subdirectory in your working directory.
 
-`md2man:web`
+`md2man:web` or `web`
   Builds HTML manual pages from `*.markdown`, `*.mkd`, and `*.md` files
   found in or beneath the `man/` subdirectory in your working directory.
 
 ## OPTIONS
 
 `-h` [*PATTERN*], `--help` [*PATTERN*]
-  Show this help manual and search for *PATTERN* regular expression therein.
+  Show this help manual and optionally search for *PATTERN* regular expression.
 
-Run `rake --help` to see more options.
+...
+  Anything else is passed to rake(1); run `rake --help` for documentation.
 
 ## SEE ALSO
 
@@ -54,5 +55,7 @@ Rake.application.init File.basename(__FILE__)
 
 require 'md2man/rakefile'
 task :default => :md2man
+task :man => 'md2man:man'
+task :web => 'md2man:web'
 
 Rake.application.top_level

data/bin/md2man-roff

@@ -1,11 +1,11 @@
 #!/usr/bin/env ruby
 =begin =======================================================================
 
-# MD2MAN-ROFF 1                   2016-02-21                            5.0.3
+# MD2MAN-ROFF 1                   2016-02-28                            5.1.0
 
 ## NAME
 
-md2man-roff - convert md2man(5) flavored markdown(7) into roff(7)
+md2man-roff - convert md2man(5) flavored [Markdown] text into roff(7)
 
 ## SYNOPSIS
 
@@ -13,7 +13,7 @@ md2man-roff - convert md2man(5) flavored markdown(7) into roff(7)
 
 ## DESCRIPTION
 
-This program converts md2man(5) flavored markdown(7) input from the given
+This program converts the md2man(5) flavored [Markdown] text from the given
 *FILE* into roff(7) 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.
 
@@ -32,13 +32,14 @@ It issues a warning when it encounters these instead.  Patches are welcome!
 ## OPTIONS
 
 `-h` [*PATTERN*], `--help` [*PATTERN*]
-  Show this help manual and search for *PATTERN* regular expression therein.
+  Show this help manual and optionally search for *PATTERN* regular expression.
 
 ## SEE ALSO
 
-md2man-html(1), md2man-rake(1), md2man(5)
+md2man-html(1), md2man-rake(1), md2man(5), [Markdown]
 
 [Redcarpet]: https://github.com/vmg/redcarpet
+[Markdown]: http://daringfireball.net/projects/markdown/syntax
 
 =end =========================================================================
 

data/lib/md2man/html.rb

@@ -63,8 +63,14 @@ module Md2Man::HTML
     ].join
   end
 
+  SYNTAX_HIGHLIGHTER = Class.new do
+    require 'rouge'
+    require 'rouge/plugins/redcarpet'
+    extend Rouge::Plugins::Redcarpet
+  end
+
   def block_code code, language
-    "<pre><code>#{CGI.escape_html super}</code></pre>\n"
+    SYNTAX_HIGHLIGHTER.block_code super, language
   end
 
   #---------------------------------------------------------------------------

data/lib/md2man/rakefile.rb

@@ -67,6 +67,12 @@ parse_manpage_info = lambda do |html_file_body|
   end
 end
 
+build_html_title = lambda do |title, info|
+  # fallback to adding directory name for standalone titles, such as "README"
+  # and "man/index", so that users know what project those manuals belong to
+  [title, info || Dir.pwd.pathmap('%n')].join(' — ')
+end
+
 directory 'man'
 
 file 'man/index.html' => ['man'] + webs do |t|
@@ -86,13 +92,19 @@ file 'man/index.html' => ['man'] + webs do |t|
   buffer << '</div>'
   content = buffer.join
 
-  title = t.name.pathmap('%X')
+  title = build_html_title.call(t.name.pathmap('%X'), nil)
   output = wrap_html_template.call(title, content, nil)
   File.open(t.name, 'w') {|f| f << output }
 end
 
 file 'man/style.css' => ['man', __FILE__.pathmap('%X/style.css')] do |t|
-  cp t.prerequisites.last, t.name if t.needed?
+  cp t.prerequisites.last, t.name
+
+  # add syntax highlighting theme
+  File.open(t.name, 'a') do |css|
+    require 'rouge'
+    css << Rouge::Themes::Github.render
+  end
 end
 
 mkds.zip(webs).each do |src, dst|
@@ -106,7 +118,7 @@ mkds.zip(webs).each do |src, dst|
 
     name = parse_manpage_name.call(dst)
     info = parse_manpage_info.call(output)
-    title = [name, info].compact.join(' &mdash; ')
+    title = build_html_title.call(name, info)
 
     subdir = dst.pathmap('%d').sub('man/', '')
     ascent = '../' * (dst.count('/') - 1)

data/lib/md2man/version.rb

@@ -1,3 +1,3 @@
 module Md2Man
-  VERSION = "5.0.3"
+  VERSION = "5.1.0"
 end

data/man/index.html

@@ -2,10 +2,10 @@
 <html>
 <head>
   <meta charset="utf-8" />
-  <meta name="generator" content="md2man 5.0.3 https://github.com/sunaku/md2man" />
-  <title>man/index</title>
+  <meta name="generator" content="md2man 5.1.0 https://github.com/sunaku/md2man" />
+  <title>man/index &mdash; md2man</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="container-fluid"><h2 id="man0">man0</h2><dl class="dl-horizontal"><dt><a href="man0/EXAMPLE.html">EXAMPLE</a></dt><dd>frobnicate the bar library</dd></dl><dl class="dl-horizontal"><dt><a href="man0/README.html">README</a></dt><dd></dd></dl><dl class="dl-horizontal"><dt><a href="man0/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(5) 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-roff.1.html">md2man-roff(1)</a></dt><dd>convert md2man(5) flavored markdown(7) into roff(7)</dd></dl><h2 id="man5">man5</h2><dl class="dl-horizontal"><dt><a href="man5/md2man.5.html">md2man(5)</a></dt><dd>UNIX manual page flavoring for the markdown(7) file format</dd></dl></div></body>
+<body><div class="container-fluid"><h2 id="man0">man0</h2><dl class="dl-horizontal"><dt><a href="man0/EXAMPLE.html">EXAMPLE</a></dt><dd>frobnicate the bar library</dd></dl><dl class="dl-horizontal"><dt><a href="man0/README.html">README</a></dt><dd></dd></dl><dl class="dl-horizontal"><dt><a href="man0/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(5) flavored Markdown text 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-roff.1.html">md2man-roff(1)</a></dt><dd>convert md2man(5) flavored Markdown text into roff(7)</dd></dl><h2 id="man5">man5</h2><dl class="dl-horizontal"><dt><a href="man5/md2man.5.html">md2man(5)</a></dt><dd>UNIX manual page flavoring for Markdown</dd></dl></div></body>
 </html>

data/man/man0/EXAMPLE.html

@@ -2,7 +2,7 @@
 <html>
 <head>
   <meta charset="utf-8" />
-  <meta name="generator" content="md2man 5.0.3 https://github.com/sunaku/md2man" />
+  <meta name="generator" content="md2man 5.1.0 https://github.com/sunaku/md2man" />
   <title>EXAMPLE &mdash; frobnicate the bar library</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,8 +2,8 @@
 <html>
 <head>
   <meta charset="utf-8" />
-  <meta name="generator" content="md2man 5.0.3 https://github.com/sunaku/md2man" />
-  <title>README</title>
+  <meta name="generator" content="md2man 5.1.0 https://github.com/sunaku/md2man" />
+  <title>README &mdash; md2man</title>
   <link rel="stylesheet" href="../style.css"/>
   <!--[if lt IE 9]><script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script><![endif]-->
 </head>
@@ -13,7 +13,7 @@
 <li>Bugs: <a href="https://github.com/sunaku/md2man/issues">https://github.com/sunaku/md2man/issues</a></li>
 </ul>
 <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
-<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" title="permalink"></a></h2>
+<a href="http://daringfireball.net/projects/markdown/">Markdown</a> into UNIX manpages as well as HTML webpages using <a href="https://github.com/vmg/redcarpet">Redcarpet</a>.</p><h2 id="features">Features<a name="features" href="#features" class="md2man-permalink" title="permalink"></a></h2>
 <ul>
 <li><p>Formats indented, tagged, and normal paragraphs: described in <a class="md2man-reference" href="../man5/md2man.5.html">md2man(5)</a>.</p></li>
 <li><p>Translates all HTML4 and XHTML1 entities into native <a href="http://troff.org">roff</a> equivalents.</p></li>
@@ -23,101 +23,101 @@
 <h3 id="examples">Examples<a name="examples" href="#examples" 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 href="https://github.com/sunaku/md2man/raw/gh-pages/man/man0/EXAMPLE">a UNIX manual page</a>:</p><pre><code>md2man-roff EXAMPLE.markdown &gt; EXAMPLE.1
+<a href="https://github.com/sunaku/md2man/raw/gh-pages/man/man0/EXAMPLE">a UNIX manual page</a>:</p><pre class="highlight shell"><code>md2man-roff EXAMPLE.markdown &gt; EXAMPLE.1
 </code></pre>
 <p>You can view <a href="https://github.com/sunaku/md2man/raw/gh-pages/man/man0/EXAMPLE">the resulting UNIX manual page</a> in your <a class="md2man-reference">man(1)</a>
-viewer:</p><pre><code>man -l EXAMPLE.1
+viewer:</p><pre class="highlight shell"><code>man -l EXAMPLE.1
 </code></pre>
 <p><img src="https://github.com/sunaku/md2man/raw/gh-pages/EXAMPLE.png" alt="screenshot"></p><p>Next, try converting
 <a href="https://raw.github.com/sunaku/md2man/master/EXAMPLE.markdown">the same example file</a>
 into
-<a href="https://sunaku.github.io/md2man/man/man0/EXAMPLE.html">a HTML web page</a>:</p><pre><code>md2man-html EXAMPLE.markdown &gt; EXAMPLE.html
+<a href="https://sunaku.github.io/md2man/man/man0/EXAMPLE.html">a HTML web page</a>:</p><pre class="highlight shell"><code>md2man-html EXAMPLE.markdown &gt; EXAMPLE.html
 </code></pre>
 <p>You can view <a href="https://sunaku.github.io/md2man/man/man0/EXAMPLE.html">the resulting HTML manual page</a> in your web
-browser:</p><pre><code>firefox EXAMPLE.html
+browser:</p><pre class="highlight shell"><code>firefox EXAMPLE.html
 </code></pre>
-<h2 id="installation">Installation<a name="installation" href="#installation" class="md2man-permalink" title="permalink"></a></h2><pre><code>gem install md2man
+<h2 id="installation">Installation<a name="installation" href="#installation" class="md2man-permalink" title="permalink"></a></h2><pre class="highlight shell"><code>gem install md2man
 </code></pre>
-<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
-cd md2man
+<h3 id="development">Development<a name="development" href="#development" class="md2man-permalink" title="permalink"></a></h3><pre class="highlight shell"><code>git clone https://github.com/sunaku/md2man
+<span class="nb">cd </span>md2man
 bundle install
-bundle exec rake --tasks        # packaging tasks
-bundle exec md2man-roff --help  # run it directly
-bundle exec md2man-html --help  # run it directly
+bundle <span class="nb">exec </span>rake --tasks        <span class="c"># packaging tasks</span>
+bundle <span class="nb">exec </span>md2man-roff --help  <span class="c"># run it directly</span>
+bundle <span class="nb">exec </span>md2man-html --help  <span class="c"># run it directly</span>
 </code></pre>
-<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
+<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 class="highlight shell"><code>md2man-roff --help
 </code></pre>
-<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 &#39;md2man/roff/engine&#39;
+<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 class="highlight ruby"><code><span class="nb">require</span> <span class="s1">'md2man/roff/engine'</span>
 
-your_roff_output = Md2Man::Roff::ENGINE.render(your_markdown_input)
+<span class="n">your_roff_output</span> <span class="o">=</span> <span class="no">Md2Man</span><span class="o">::</span><span class="no">Roff</span><span class="o">::</span><span class="no">ENGINE</span><span class="p">.</span><span class="nf">render</span><span class="p">(</span><span class="n">your_markdown_input</span><span class="p">)</span>
 </code></pre>
-<p>Build your own renderer:</p><pre><code>require &#39;md2man/roff/engine&#39;
+<p>Build your own renderer:</p><pre class="highlight ruby"><code><span class="nb">require</span> <span class="s1">'md2man/roff/engine'</span>
 
-engine = Redcarpet::Markdown.new(Md2Man::Roff::Engine, your_options_hash)
-your_roff_output = engine.render(your_markdown_input)
+<span class="n">engine</span> <span class="o">=</span> <span class="no">Redcarpet</span><span class="o">::</span><span class="no">Markdown</span><span class="p">.</span><span class="nf">new</span><span class="p">(</span><span class="no">Md2Man</span><span class="o">::</span><span class="no">Roff</span><span class="o">::</span><span class="no">Engine</span><span class="p">,</span> <span class="n">your_options_hash</span><span class="p">)</span>
+<span class="n">your_roff_output</span> <span class="o">=</span> <span class="n">engine</span><span class="p">.</span><span class="nf">render</span><span class="p">(</span><span class="n">your_markdown_input</span><span class="p">)</span>
 </code></pre>
-<p>Define your own renderer:</p><pre><code>require &#39;md2man/roff/engine&#39;
+<p>Define your own renderer:</p><pre class="highlight ruby"><code><span class="nb">require</span> <span class="s1">'md2man/roff/engine'</span>
 
-class YourManpageRenderer &lt; Md2Man::Roff::Engine
-  # ... your stuff here ...
-end
+<span class="k">class</span> <span class="nc">YourManpageRenderer</span> <span class="o">&lt;</span> <span class="no">Md2Man</span><span class="o">::</span><span class="no">Roff</span><span class="o">::</span><span class="no">Engine</span>
+  <span class="c1"># ... your stuff here ...</span>
+<span class="k">end</span>
 
-engine = Redcarpet::Markdown.new(YourManpageRenderer, your_options_hash)
-your_roff_output = engine.render(your_markdown_input)
+<span class="n">engine</span> <span class="o">=</span> <span class="no">Redcarpet</span><span class="o">::</span><span class="no">Markdown</span><span class="p">.</span><span class="nf">new</span><span class="p">(</span><span class="no">YourManpageRenderer</span><span class="p">,</span> <span class="n">your_options_hash</span><span class="p">)</span>
+<span class="n">your_roff_output</span> <span class="o">=</span> <span class="n">engine</span><span class="p">.</span><span class="nf">render</span><span class="p">(</span><span class="n">your_markdown_input</span><span class="p">)</span>
 </code></pre>
-<p>Mix-in your own renderer:</p><pre><code>require &#39;md2man/roff&#39;
+<p>Mix-in your own renderer:</p><pre class="highlight ruby"><code><span class="nb">require</span> <span class="s1">'md2man/roff'</span>
 
-class YourManpageRenderer &lt; Redcarpet::Render::Base
-  include Md2Man::Roff
-  # ... your stuff here ...
-end
+<span class="k">class</span> <span class="nc">YourManpageRenderer</span> <span class="o">&lt;</span> <span class="no">Redcarpet</span><span class="o">::</span><span class="no">Render</span><span class="o">::</span><span class="no">Base</span>
+  <span class="kp">include</span> <span class="no">Md2Man</span><span class="o">::</span><span class="no">Roff</span>
+  <span class="c1"># ... your stuff here ...</span>
+<span class="k">end</span>
 
-engine = Redcarpet::Markdown.new(YourManpageRenderer, your_options_hash)
-your_roff_output = engine.render(your_markdown_input)
+<span class="n">engine</span> <span class="o">=</span> <span class="no">Redcarpet</span><span class="o">::</span><span class="no">Markdown</span><span class="p">.</span><span class="nf">new</span><span class="p">(</span><span class="no">YourManpageRenderer</span><span class="p">,</span> <span class="n">your_options_hash</span><span class="p">)</span>
+<span class="n">your_roff_output</span> <span class="o">=</span> <span class="n">engine</span><span class="p">.</span><span class="nf">render</span><span class="p">(</span><span class="n">your_markdown_input</span><span class="p">)</span>
 </code></pre>
-<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
+<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 class="highlight shell"><code>md2man-html --help
 </code></pre>
-<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 &#39;md2man/html/engine&#39;
+<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 class="highlight ruby"><code><span class="nb">require</span> <span class="s1">'md2man/html/engine'</span>
 
-your_html_output = Md2Man::HTML::ENGINE.render(your_markdown_input)
+<span class="n">your_html_output</span> <span class="o">=</span> <span class="no">Md2Man</span><span class="o">::</span><span class="no">HTML</span><span class="o">::</span><span class="no">ENGINE</span><span class="p">.</span><span class="nf">render</span><span class="p">(</span><span class="n">your_markdown_input</span><span class="p">)</span>
 </code></pre>
-<p>Build your own renderer:</p><pre><code>require &#39;md2man/html/engine&#39;
+<p>Build your own renderer:</p><pre class="highlight ruby"><code><span class="nb">require</span> <span class="s1">'md2man/html/engine'</span>
 
-engine = Redcarpet::Markdown.new(Md2Man::HTML::Engine, your_options_hash)
-your_html_output = engine.render(your_markdown_input)
+<span class="n">engine</span> <span class="o">=</span> <span class="no">Redcarpet</span><span class="o">::</span><span class="no">Markdown</span><span class="p">.</span><span class="nf">new</span><span class="p">(</span><span class="no">Md2Man</span><span class="o">::</span><span class="no">HTML</span><span class="o">::</span><span class="no">Engine</span><span class="p">,</span> <span class="n">your_options_hash</span><span class="p">)</span>
+<span class="n">your_html_output</span> <span class="o">=</span> <span class="n">engine</span><span class="p">.</span><span class="nf">render</span><span class="p">(</span><span class="n">your_markdown_input</span><span class="p">)</span>
 </code></pre>
-<p>Define your own renderer:</p><pre><code>require &#39;md2man/html/engine&#39;
+<p>Define your own renderer:</p><pre class="highlight ruby"><code><span class="nb">require</span> <span class="s1">'md2man/html/engine'</span>
 
-class YourManpageRenderer &lt; Md2Man::HTML::Engine
-  # ... your stuff here ...
-end
+<span class="k">class</span> <span class="nc">YourManpageRenderer</span> <span class="o">&lt;</span> <span class="no">Md2Man</span><span class="o">::</span><span class="no">HTML</span><span class="o">::</span><span class="no">Engine</span>
+  <span class="c1"># ... your stuff here ...</span>
+<span class="k">end</span>
 
-engine = Redcarpet::Markdown.new(YourManpageRenderer, your_options_hash)
-your_html_output = engine.render(your_markdown_input)
+<span class="n">engine</span> <span class="o">=</span> <span class="no">Redcarpet</span><span class="o">::</span><span class="no">Markdown</span><span class="p">.</span><span class="nf">new</span><span class="p">(</span><span class="no">YourManpageRenderer</span><span class="p">,</span> <span class="n">your_options_hash</span><span class="p">)</span>
+<span class="n">your_html_output</span> <span class="o">=</span> <span class="n">engine</span><span class="p">.</span><span class="nf">render</span><span class="p">(</span><span class="n">your_markdown_input</span><span class="p">)</span>
 </code></pre>
-<p>Mix-in your own renderer:</p><pre><code>require &#39;md2man/html&#39;
+<p>Mix-in your own renderer:</p><pre class="highlight ruby"><code><span class="nb">require</span> <span class="s1">'md2man/html'</span>
 
-class YourManpageRenderer &lt; Redcarpet::Render::Base
-  include Md2Man::HTML
-  # ... your stuff here ...
-end
+<span class="k">class</span> <span class="nc">YourManpageRenderer</span> <span class="o">&lt;</span> <span class="no">Redcarpet</span><span class="o">::</span><span class="no">Render</span><span class="o">::</span><span class="no">Base</span>
+  <span class="kp">include</span> <span class="no">Md2Man</span><span class="o">::</span><span class="no">HTML</span>
+  <span class="c1"># ... your stuff here ...</span>
+<span class="k">end</span>
 
-engine = Redcarpet::Markdown.new(YourManpageRenderer, your_options_hash)
-your_html_output = engine.render(your_markdown_input)
+<span class="n">engine</span> <span class="o">=</span> <span class="no">Redcarpet</span><span class="o">::</span><span class="no">Markdown</span><span class="p">.</span><span class="nf">new</span><span class="p">(</span><span class="no">YourManpageRenderer</span><span class="p">,</span> <span class="n">your_options_hash</span><span class="p">)</span>
+<span class="n">your_html_output</span> <span class="o">=</span> <span class="n">engine</span><span class="p">.</span><span class="nf">render</span><span class="p">(</span><span class="n">your_markdown_input</span><span class="p">)</span>
 </code></pre>
-<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
+<h3 id="building-manpages">Building manpages<a name="building-manpages" href="#building-manpages" 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 class="highlight shell"><code>md2man-rake --help
 </code></pre>
-<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[&#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; 5.0&#39;
+<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 class="highlight ruby"><code><span class="n">s</span><span class="p">.</span><span class="nf">files</span> <span class="o">+=</span> <span class="no">Dir</span><span class="p">[</span><span class="s1">'man/man?/*.?'</span><span class="p">]</span>         <span class="c1"># UNIX manpages</span>
+<span class="n">s</span><span class="p">.</span><span class="nf">files</span> <span class="o">+=</span> <span class="no">Dir</span><span class="p">[</span><span class="s1">'man/**/*.{html,css}'</span><span class="p">]</span>  <span class="c1"># HTML manpages</span>
+<span class="n">s</span><span class="p">.</span><span class="nf">add_development_dependency</span> <span class="s1">'md2man'</span><span class="p">,</span> <span class="s1">'~&gt; 5.0'</span>
 </code></pre>
-<p>Add this line to your Rakefile:</p><pre><code>require &#39;md2man/rakefile&#39;
+<p>Add this line to your Rakefile:</p><pre class="highlight ruby"><code><span class="nb">require</span> <span class="s1">'md2man/rakefile'</span>
 </code></pre>
 <p>You now have a <code>rake md2man</code> task that builds manual pages from Markdown files
 (with &quot;.markdown&quot;, &quot;.mkd&quot;, or &quot;.md&quot; extension) inside <code>man/man*/</code> directories.
 There are also sub-tasks to build manual pages individually as <a href="http://troff.org">roff</a> or HTML.</p><p>If you&#39;re using Bundler, this task also hooks into Bundler&#39;s gem packaging
-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/
+tasks and ensures that your manual pages are built for packaging into a gem:</p><pre class="highlight ruby"><code><span class="n">bundle</span> <span class="nb">exec</span> <span class="n">rake</span> <span class="n">build</span>
+<span class="n">gem</span> <span class="n">spec</span> <span class="n">pkg</span><span class="o">/*</span><span class="p">.</span><span class="nf">gem</span> <span class="o">|</span> <span class="n">fgrep</span> <span class="n">man</span><span class="o">/</span>
 </code></pre>
 <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>
 </html>