md2man 1.4.0 → 1.4.1

data/HISTORY.markdown

@@ -1,3 +1,31 @@
+## Version 1.4.1 (2013-02-23)
+
+Patch:
+
+  * rakefile: arbitrary directory structure under man/
+
+    https://github.com/sunaku/md2man/pull/3#issuecomment-9429077
+
+    Thanks to Postmodern for raising this issue.
+
+  * hook into 'build' task only if using Bundler tasks
+
+    https://github.com/sunaku/md2man/pull/7#issuecomment-9467621
+
+    Thanks to Postmodern for raising this issue.
+
+  * GH-8: Redcarpet requires Ruby 1.9 and so must we
+
+    https://github.com/sunaku/md2man/issues/8#issuecomment-9509240
+
+    Thanks to Postmodern for raising this issue.
+
+Other:
+
+  * README: add md2man-html(1) and Md2Man::HTML usage
+
+  * LICENSE: use GitHub profile URLs instead of e-mail
+
 ## Version 1.4.0 (2012-10-14)
 
 Minor:

data/LICENSE

@@ -1,8 +1,8 @@
 (the ISC license)
 
-Copyright 2011 Suraj N. Kurapati <sunaku@gmail.com>
-Thanks to 2011 Vicent Marti <vicent@github.com>
-Thanks to 2012 Postmodern <postmodern.mod3@gmail.com>
+Copyright 2011 Suraj N. Kurapati <https://github.com/sunaku>
+Thanks to 2011 Vicent Marti <https://github.com/vmg>
+Thanks to 2012 Postmodern <https://github.com/postmodern>
 
 Permission to use, copy, modify, and/or distribute this software for any
 purpose with or without fee is hereby granted, provided that the above

data/README.markdown

@@ -1,13 +1,13 @@
 # md2man - markdown to manpage
 
 md2man is a Ruby library and command-line program that converts [Markdown]
-documents into UNIX manual pages (really [Roff] documents) using [Redcarpet].
+documents into UNIX manual pages (both [roff] and HTML) using [Redcarpet].
 
 ## Features
 
   * Formats tagged and indented paragraphs (see "document format" below).
 
-  * Translates all HTML4 and XHTML1 entities into native Roff equivalents.
+  * Translates all HTML4 and XHTML1 entities into native [roff] equivalents.
 
   * Supports markdown extensions such as [PHP Markdown Extra tables][tables].
 
@@ -47,7 +47,7 @@ It issues a warning when it encounters these instead.  Patches are welcome!
     bundle exec md2man --help  # run it directly
     bundle exec rake -T        # packaging tasks
 
-## Usage
+## Usage (for [roff] output)
 
 ### At the command line
 
@@ -58,11 +58,13 @@ It issues a warning when it encounters these instead.  Patches are welcome!
 Use the default renderer:
 
     require 'md2man'
+
     your_roff_output = Md2Man::ENGINE.render(your_markdown_input)
 
 Build your own renderer:
 
     require 'md2man'
+
     engine = Redcarpet::Markdown.new(Md2Man::Engine, your_options_hash)
     your_roff_output = engine.render(your_markdown_input)
 
@@ -89,6 +91,50 @@ Mix-in your own renderer:
     engine = Redcarpet::Markdown.new(YourManpageRenderer, your_options_hash)
     your_roff_output = engine.render(your_markdown_input)
 
+## Usage (for HTML output)
+
+### At the command line
+
+    md2man-html --help
+
+### Inside a Ruby script
+
+Use the default renderer:
+
+    require 'md2man/html/engine'
+
+    your_html_output = Md2Man::HTML::ENGINE.render(your_markdown_input)
+
+Build your own renderer:
+
+    require 'md2man/html/engine'
+
+    engine = Redcarpet::Markdown.new(Md2Man::HTML::Engine, your_options_hash)
+    your_html_output = engine.render(your_markdown_input)
+
+Define your own renderer:
+
+    require 'md2man/html/engine'
+
+    class YourManpageRenderer < Md2Man::HTML::Engine
+      # ... your stuff here ...
+    end
+
+    engine = Redcarpet::Markdown.new(YourManpageRenderer, your_options_hash)
+    your_html_output = engine.render(your_markdown_input)
+
+Mix-in your own renderer:
+
+    require 'md2man/html'
+
+    class YourManpageRenderer < Redcarpet::Render::Base
+      include Md2Man::HTML
+      # ... your stuff here ...
+    end
+
+    engine = Redcarpet::Markdown.new(YourManpageRenderer, your_options_hash)
+    your_html_output = engine.render(your_markdown_input)
+
 ### Document format
 
 md2man extends [Markdown] syntax in the following ways, as provisioned in the
@@ -96,11 +142,11 @@ md2man extends [Markdown] syntax in the following ways, as provisioned in the
 
   * Paragraphs whose lines are all uniformly indented by two spaces are
     considered to be "indented paragraphs".  They are unindented accordingly
-    before emission as `.IP` in the [Roff] output.
+    before emission as `.IP` in the [roff] output.
 
   * Paragraphs whose subsequent lines (all except the first) are uniformly
     indented by two spaces are considered to be a "tagged paragraphs".  They
-    are unindented accordingly before emission as `.TP` in the [Roff] output.
+    are unindented accordingly before emission as `.TP` in the [roff] output.
 
 md2man extends [Markdown] semantics in the following ways:
 
@@ -121,7 +167,7 @@ Add the following line to your Rakefile:
 
 You now have a `rake md2man` task that builds manual pages from Markdown files
 (with ".markdown", ".mkd", or ".md" extension) inside `man/man*/` directories.
-There are also sub-tasks to build *only* UNIX or HTML manual pages separately.
+There are also sub-tasks to build manual pages individually as [roff] or HTML.
 
 If you're using Bundler, this task also hooks into Bundler's gem packaging
 tasks and ensures that your manual pages are built for packaging into a gem:
@@ -133,7 +179,7 @@ tasks and ensures that your manual pages are built for packaging into a gem:
 
 Released under the ISC license.  See the LICENSE file for details.
 
-[Roff]: http://troff.org
+[roff]: http://troff.org
 [Markdown]: http://daringfireball.net/projects/markdown/
 [Redcarpet]: https://github.com/vmg/redcarpet
 [example]: https://raw.github.com/sunaku/md2man/master/EXAMPLE.markdown

data/bin/md2man

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 =begin =======================================================================
 
-# MD2MAN 1 2012-10-14 1.4.0
+# MD2MAN 1 2013-02-23 1.4.1
 
 ## NAME
 

data/bin/md2man-html

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 =begin =======================================================================
 
-# MD2MAN-HTML 1 2012-10-14 1.4.0
+# MD2MAN-HTML 1 2013-02-23 1.4.1
 
 ## NAME
 

data/lib/md2man/rakefile.rb

@@ -1,14 +1,16 @@
 require 'rake'
 
 # build man pages before building ruby gem using bundler
-%w[build install release].each {|t| task t => :md2man }
+if defined? Bundler::GemHelper
+  %w[build install release].each {|t| task t => :md2man }
+end
 
 #-----------------------------------------------------------------------------
 desc 'Build manual pages from Markdown files in man/.'
 task :md2man => ['md2man:man', 'md2man:web']
 #-----------------------------------------------------------------------------
 
-mkds = FileList['man/man*/*.{markdown,mkd,md}']
+mkds = FileList['man/**/*.{markdown,mkd,md}']
 mans = mkds.pathmap('%X')
 webs = mans.pathmap('%p.html')
 

data/lib/md2man/version.rb

@@ -1,3 +1,3 @@
 module Md2Man
-  VERSION = "1.4.0"
+  VERSION = "1.4.1"
 end

data/man/man1/md2man-html.1

@@ -1,4 +1,4 @@
-.TH MD2MAN\-HTML 1 2012\-10\-14 1.4.0
+.TH MD2MAN\-HTML 1 2013\-02\-23 1.4.1
 .SH NAME
 .PP
 md2man\-html \- convert 

data/man/man1/md2man.1

@@ -1,4 +1,4 @@
-.TH MD2MAN 1 2012\-10\-14 1.4.0
+.TH MD2MAN 1 2013\-02\-23 1.4.1
 .SH NAME
 .PP
 md2man \- convert 

data/md2man.gemspec

@@ -16,6 +16,7 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ['lib']
 
+  s.required_ruby_version = '>= 1.9.1'
   s.add_runtime_dependency 'binman', '~> 3.0'
   s.add_runtime_dependency 'redcarpet', '~> 2.1'
   s.add_development_dependency 'minitest', '~> 4.0'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: md2man
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.4.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-14 00:00:00.000000000 Z
+date: 2013-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: binman
@@ -77,7 +77,7 @@ dependencies:
         version: 0.9.2.2
 description: Converts markdown documents into UNIX manual pages.
 email:
-- sunaku@gmail.com
+- https://github.com/sunaku
 executables:
 - md2man
 - md2man-html
@@ -119,10 +119,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: '0'
-      segments:
-      - 0
-      hash: -1838080913948275679
+      version: 1.9.1
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -131,7 +128,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1838080913948275679
+      hash: 2835073792924155153
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23