md2man 5.0.3 → 5.1.0

data/man/man5/md2man.5.markdown

@@ -1,22 +1,23 @@
-# MD2MAN 5                        2016-02-21                            5.0.3
+# MD2MAN 5                        2016-02-28                            5.1.0
 
 ## NAME
 
-md2man - UNIX manual page flavoring for the markdown(7) file format
+md2man - UNIX manual page flavoring for [Markdown]
 
 ## DESCRIPTION
 
-[md2man] makes the markdown(7) file format friendly for writing UNIX manual
+md2man makes the [Markdown] format more friendly for writing UNIX manual
 pages by extending its syntax, semantics, and assumed processing extensions.
 
 ### Syntax
 
-md2man extends markdown(7) syntax by distinguishing three kinds of paragraphs.
+md2man extends [Markdown] syntax by recognizing three kinds of paragraphs,
+analogous to the underlying `.PP`, `.TP`, and `.IP` directives in roff(7).
 
 #### Normal paragraphs
 
 Paragraphs whose lines are all indented by exactly zero or one additional
-spaces are considered to be "normal paragraphs".  For example:
+space are considered "normal paragraphs", analogous to `.PP` in roff(7):
 
     This is a normal paragraph.
 
@@ -35,8 +36,8 @@ spaces are considered to be "normal paragraphs".  For example:
 #### Tagged paragraphs
 
 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 "tagged paragraphs".  For example:
+whose subsequent lines are all uniformly indented by exactly two additional
+spaces are considered "tagged paragraphs", analogous to `.TP` in roff(7):
 
     This is a
       tagged
@@ -45,7 +46,7 @@ are considered to be "tagged paragraphs".  For example:
 #### Indented paragraphs
 
 Paragraphs whose lines are all uniformly indented by exactly two additional
-spaces are considered to be "indented paragraphs".  For example:
+spaces are considered "indented paragraphs", analogous to `.IP` in roff(7):
 
       This is an
       indented
@@ -53,7 +54,7 @@ spaces are considered to be "indented paragraphs".  For example:
 
 ### Semantics
 
-md2man extends markdown(7) semantics by treating top-level headings specially.
+md2man extends [Markdown] semantics by treating top-level headings specially.
 
 #### Top-level headings
 
@@ -81,7 +82,7 @@ Any subsequent top-level headings are treated as second-level `<h2>` headings.
 
 ### Extensions
 
-md2man enables the following [Redcarpet] extensions while reading markdown(7):
+md2man enables the following [Redcarpet] extensions while reading [Markdown]:
 
   * tables
   * autolink
@@ -184,7 +185,6 @@ http://www.schweikhardt.net/man_page_howto.html)
 
 ## SEE ALSO
 
-markdown(7), man-pages(7), md2man-roff(1), md2man-html(1), md2man-rake(1)
+[Markdown], man-pages(7), roff(7), md2man-roff(1), md2man-html(1)
 
-[md2man]: https://github.com/sunaku/md2man
-[Redcarpet]: https://github.com/vmg/redcarpet
+[Markdown]: http://daringfireball.net/projects/markdown/syntax

data/man/style.css

@@ -86,3 +86,212 @@
     content: none;
   }
 }
+.highlight table td { padding: 5px; }
+.highlight table pre { margin: 0; }
+.highlight .cm {
+  color: #999988;
+  font-style: italic;
+}
+.highlight .cp {
+  color: #999999;
+  font-weight: bold;
+}
+.highlight .c1 {
+  color: #999988;
+  font-style: italic;
+}
+.highlight .cs {
+  color: #999999;
+  font-weight: bold;
+  font-style: italic;
+}
+.highlight .c, .highlight .cd {
+  color: #999988;
+  font-style: italic;
+}
+.highlight .err {
+  color: #a61717;
+  background-color: #e3d2d2;
+}
+.highlight .gd {
+  color: #000000;
+  background-color: #ffdddd;
+}
+.highlight .ge {
+  color: #000000;
+  font-style: italic;
+}
+.highlight .gr {
+  color: #aa0000;
+}
+.highlight .gh {
+  color: #999999;
+}
+.highlight .gi {
+  color: #000000;
+  background-color: #ddffdd;
+}
+.highlight .go {
+  color: #888888;
+}
+.highlight .gp {
+  color: #555555;
+}
+.highlight .gs {
+  font-weight: bold;
+}
+.highlight .gu {
+  color: #aaaaaa;
+}
+.highlight .gt {
+  color: #aa0000;
+}
+.highlight .kc {
+  color: #000000;
+  font-weight: bold;
+}
+.highlight .kd {
+  color: #000000;
+  font-weight: bold;
+}
+.highlight .kn {
+  color: #000000;
+  font-weight: bold;
+}
+.highlight .kp {
+  color: #000000;
+  font-weight: bold;
+}
+.highlight .kr {
+  color: #000000;
+  font-weight: bold;
+}
+.highlight .kt {
+  color: #445588;
+  font-weight: bold;
+}
+.highlight .k, .highlight .kv {
+  color: #000000;
+  font-weight: bold;
+}
+.highlight .mf {
+  color: #009999;
+}
+.highlight .mh {
+  color: #009999;
+}
+.highlight .il {
+  color: #009999;
+}
+.highlight .mi {
+  color: #009999;
+}
+.highlight .mo {
+  color: #009999;
+}
+.highlight .m, .highlight .mb, .highlight .mx {
+  color: #009999;
+}
+.highlight .sb {
+  color: #d14;
+}
+.highlight .sc {
+  color: #d14;
+}
+.highlight .sd {
+  color: #d14;
+}
+.highlight .s2 {
+  color: #d14;
+}
+.highlight .se {
+  color: #d14;
+}
+.highlight .sh {
+  color: #d14;
+}
+.highlight .si {
+  color: #d14;
+}
+.highlight .sx {
+  color: #d14;
+}
+.highlight .sr {
+  color: #009926;
+}
+.highlight .s1 {
+  color: #d14;
+}
+.highlight .ss {
+  color: #990073;
+}
+.highlight .s {
+  color: #d14;
+}
+.highlight .na {
+  color: #008080;
+}
+.highlight .bp {
+  color: #999999;
+}
+.highlight .nb {
+  color: #0086B3;
+}
+.highlight .nc {
+  color: #445588;
+  font-weight: bold;
+}
+.highlight .no {
+  color: #008080;
+}
+.highlight .nd {
+  color: #3c5d5d;
+  font-weight: bold;
+}
+.highlight .ni {
+  color: #800080;
+}
+.highlight .ne {
+  color: #990000;
+  font-weight: bold;
+}
+.highlight .nf {
+  color: #990000;
+  font-weight: bold;
+}
+.highlight .nl {
+  color: #990000;
+  font-weight: bold;
+}
+.highlight .nn {
+  color: #555555;
+}
+.highlight .nt {
+  color: #000080;
+}
+.highlight .vc {
+  color: #008080;
+}
+.highlight .vg {
+  color: #008080;
+}
+.highlight .vi {
+  color: #008080;
+}
+.highlight .nv {
+  color: #008080;
+}
+.highlight .ow {
+  color: #000000;
+  font-weight: bold;
+}
+.highlight .o {
+  color: #000000;
+  font-weight: bold;
+}
+.highlight .w {
+  color: #bbbbbb;
+}
+.highlight {
+  background-color: #f8f8f8;
+}

data/md2man.gemspec

@@ -8,21 +8,22 @@ Gem::Specification.new do |s|
   s.authors,
   s.email         = File.read('LICENSE').scan(/Copyright \d+ (.+) <(.+?)>/).transpose
   s.license       = 'ISC'
-  s.homepage      = 'http://github.com/sunaku/md2man'
+  s.homepage      = 'https://sunaku.github.io/md2man'
   s.summary       = 'markdown to manpage'
-  s.description   = 'Converts markdown documents into UNIX manual pages.'
+  s.description   = 'Converts markdown into UNIX manpages and HTML webpages.'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ['lib']
 
-  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.required_ruby_version = '>= 1.9.1'
   s.add_runtime_dependency 'binman', '~> 5.0'
   s.add_runtime_dependency 'redcarpet', '~> 3.0'
+  s.add_runtime_dependency 'rouge', '~> 1.0'
   s.add_development_dependency 'minitest', '~> 5.0'
   s.add_development_dependency 'rake', '~> 10.1'
 end

data/test/md2man/html_test.rb

@@ -57,7 +57,7 @@ describe 'html engine' do
       |
       |    <a class="md2man-reference" href="../man3/printf.3.html">printf(3)</a>
     INPUT
-      |<p>For example, the <code>printf(3)</code> cross reference would be emitted as this HTML:</p><pre><code>&lt;a class=&quot;md2man-reference&quot; href=&quot;../man3/printf.3.html&quot;&gt;printf(3)&lt;/a&gt;
+      |<p>For example, the <code>printf(3)</code> cross reference would be emitted as this HTML:</p><pre class="highlight plaintext"><code>&lt;a class="md2man-reference" href="../man3/printf.3.html"&gt;printf(3)&lt;/a&gt;
       |</code></pre>
       |
     OUTPUT
@@ -85,7 +85,7 @@ describe 'html engine' do
       |    containing markdown(7),
       |    roff(7), and much more!
     INPUT
-      |<pre><code>this is a code block
+      |<pre class="highlight plaintext"><code>this is a code block
       |containing markdown(7),
       |roff(7), and much more!
       |</code></pre>
@@ -121,7 +121,7 @@ describe 'html engine' do
       |      \\__/\\____/_/ /_/|_\\
       |                 >>>------>
     INPUT
-      |<pre><code>_______      _______
+      |<pre class="highlight plaintext"><code>_______      _______
       | ___  /___________ /__
       |  _  __/ __ \\  __/ /_/
       |  / /_/ /_/ / / / ,\\
@@ -232,7 +232,7 @@ describe 'html engine' do
       |
       |### `PIPES_GET_LAST(CHAIN)`
     INPUT
-      |<h3 id="macros">Macros<a name="macros" href="#macros" class="md2man-permalink" title="permalink"></a></h3><pre><code>#define PIPES_GET_LAST(CHAIN)
+      |<h3 id="macros">Macros<a name="macros" href="#macros" class="md2man-permalink" title="permalink"></a></h3><pre class="highlight plaintext"><code>#define PIPES_GET_LAST(CHAIN)
       |#define PIPES_GET_IN(CHAIN)
       |#define PIPES_GET_OUT(CHAIN)
       |#define PIPES_GET_ERR(CHAIN)
@@ -260,4 +260,28 @@ describe 'html engine' do
       |<p><code>\n</code></p>
     OUTPUT
   end
+
+  it 'renders fenced code blocks' do
+    @markdown.render(heredoc(<<-INPUT)).must_equal(heredoc(<<-OUTPUT))
+      |```
+      | Array.new(123, "abc")
+      |```
+    INPUT
+      |<pre class="highlight plaintext"><code> Array.new(123, "abc")
+      |</code></pre>
+      |
+    OUTPUT
+  end
+
+  it 'renders fenced code blocks with syntax highlighting' do
+    @markdown.render(heredoc(<<-INPUT)).must_equal(heredoc(<<-OUTPUT))
+      |```ruby
+      | Array.new(123, "abc")
+      |```
+    INPUT
+      |<pre class="highlight ruby"><code> <span class="no">Array</span><span class="p">.</span><span class="nf">new</span><span class="p">(</span><span class="mi">123</span><span class="p">,</span> <span class="s2">"abc"</span><span class="p">)</span>
+      |</code></pre>
+      |
+    OUTPUT
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: md2man
 version: !ruby/object:Gem::Version
-  version: 5.0.3
+  version: 5.1.0
 platform: ruby
 authors:
 - Suraj N. Kurapati
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-21 00:00:00.000000000 Z
+date: 2016-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: binman
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rouge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -66,7 +80,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.1'
-description: Converts markdown documents into UNIX manual pages.
+description: Converts markdown into UNIX manpages and HTML webpages.
 email:
 - https://github.com/sunaku
 executables:
@@ -78,7 +92,6 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - EXAMPLE.markdown
-- EXAMPLE.png
 - Gemfile
 - LICENSE
 - README.markdown
@@ -99,7 +112,6 @@ files:
 - man/index.html
 - man/man0/EXAMPLE.html
 - man/man0/EXAMPLE.markdown
-- man/man0/EXAMPLE.png
 - man/man0/README.html
 - man/man0/README.markdown
 - man/man0/VERSION.html
@@ -118,7 +130,7 @@ files:
 - test/md2man/html_test.rb
 - test/md2man/roff_test.rb
 - test/test_helper.rb
-homepage: http://github.com/sunaku/md2man
+homepage: https://sunaku.github.io/md2man
 licenses:
 - ISC
 metadata: {}