md2man 1.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in redman.gemspec
+gemspec

data/HISTORY.markdown

@@ -0,0 +1,36 @@
+------------------------------------------------------------------------------
+Version 1.0.1 (2011-12-06)
+------------------------------------------------------------------------------
+
+Breaking changes:
+
+* Renamed the project from "redcarpet-manpage" to "md2man".
+
+  * `RedcarpetManpage::Renderer` is now `Md2Man::Engine`.
+
+  * `RedcarpetManpage::RENDERER` is now `Md2Man::ENGINE`.
+
+* Tagged paragraphs no longer require the first line to begin with italic or
+  bold styling.  All that matters is that the subsequent lines are indented.
+
+External changes:
+
+* Added md2man(1) executable for command-line usage.
+
+* Added support for all HTML 4.0 and XHTML 1.0 entities.
+
+* Added support for tables, horizontal rules, and more.
+
+* Added `Md2Man::Roff` mixin for advanced Redcarpet2 usage.
+
+* Improved README with some new and revised documentation.
+
+Internal changes:
+
+* Rewrote entire Markdown to Roff conversion from scratch while doing TDD.
+
+------------------------------------------------------------------------------
+Version 0.0.1 (2011-10-13)
+------------------------------------------------------------------------------
+
+* First release! Happy birthday! Woohoo! :-)

data/LICENSE

@@ -0,0 +1,15 @@
+(the ISC license)
+
+Copyright 2011 Suraj N. Kurapati <sunaku@gmail.com>
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

data/README.markdown

@@ -0,0 +1,106 @@
+md2man - write UNIX man pages in Markdown
+==============================================================================
+
+md2man is a Ruby library and command-line program that converts [Markdown]
+documents into UNIX man pages (really [Roff] documents) using [Redcarpet2].
+
+[Roff]: http://troff.org
+[Markdown]: http://daringfireball.net/projects/markdown/
+[Redcarpet2]: https://github.com/tanoku/redcarpet
+
+------------------------------------------------------------------------------
+Installation
+------------------------------------------------------------------------------
+
+As a Ruby gem:
+
+    gem install md2man
+
+As a Git clone:
+
+    git clone git://github.com/sunaku/md2man
+    cd md2man
+    bundle install
+
+------------------------------------------------------------------------------
+Command Usage
+------------------------------------------------------------------------------
+
+Read the manual page:
+
+    md2man --help
+
+------------------------------------------------------------------------------
+Library Usage
+------------------------------------------------------------------------------
+
+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)
+
+Define your own renderer:
+
+    require 'md2man'
+
+    class YourManpageRenderer < Md2Man::Engine
+      # ... your stuff here ...
+    end
+
+    engine = Redcarpet::Markdown.new(YourManpageRenderer, your_options_hash)
+    your_roff_output = engine.render(your_markdown_input)
+
+Mix-in your own renderer:
+
+    require 'md2man'
+
+    class YourManpageRenderer < Redcarpet::Render::Base
+      include Md2Man::Roff
+      # ... your stuff here ...
+    end
+
+    engine = Redcarpet::Markdown.new(YourManpageRenderer, your_options_hash)
+    your_roff_output = engine.render(your_markdown_input)
+
+------------------------------------------------------------------------------
+Document Format
+------------------------------------------------------------------------------
+
+md2man attaches the following additional semantics to its [Markdown] input:
+
+  * There can be at most one top-level heading (H1).  It is emitted as `.TH`
+    in the [Roff] output, specifying the UNIX man page's header and footer.
+
+  * 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.
+
+  * 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.
+
+------------------------------------------------------------------------------
+Limitations
+------------------------------------------------------------------------------
+
+At present, md2man does not translate the following [Redcarpet2] node types:
+
+  * `block_html`
+  * `strikethrough`
+  * `superscript`
+  * `image`
+  * `raw_html`
+
+It issues a warning when it encounters these instead.  Patches are welcome!
+
+------------------------------------------------------------------------------
+License
+------------------------------------------------------------------------------
+
+Released under the ISC license.  See the LICENSE file for details.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/md2man

@@ -0,0 +1,70 @@
+#!/usr/bin/env ruby
+=begin
+
+MD2MAN 1 "2011-12-06" "1.0.1"
+=============================
+
+NAME
+----
+
+md2man - convert markdown(7) into roff(7)
+
+SYNOPSIS
+--------
+
+`md2man` [*OPTION*]... [*FILE*]
+
+DESCRIPTION
+-----------
+
+[md2man] converts markdown(7) input from the given *FILE* into roff(7) using
+[Redcarpet2] 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.
+
+### Document Format
+
+The following additional semantics are attached to markdown(7):
+
+  * There can be at most one top-level heading (H1).  It is emitted as `.TH`
+    in the roff(7) output, specifying the UNIX man page's header and footer.
+
+  * 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(7) 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(7) output.
+
+### Markdown Extensions
+
+The following [Redcarpet2] extensions for markdown(7) are enabled:
+
+* tables
+* autolink
+* superscript
+* strikethrough
+* no_intra_emphasis
+* fenced_code_blocks
+
+OPTIONS
+-------
+
+`-h`, `--help`
+  Display this help manual using man(1).
+
+SEE ALSO
+--------
+
+markdown(7), roff(7)
+
+[md2man]: https://github.com/sunaku/md2man
+[Redcarpet2]: https://github.com/tanoku/redcarpet
+
+=end =========================================================================
+
+require 'binman'
+BinMan.help
+
+require 'md2man'
+puts Md2Man::ENGINE.render(ARGF.read)

data/lib/md2man/engine.rb

@@ -0,0 +1,18 @@
+require 'redcarpet'
+require 'md2man/roff'
+
+module Md2Man
+  class Engine < Redcarpet::Render::Base
+    include Roff
+  end
+
+  ENGINE = Redcarpet::Markdown.new(
+    Md2Man::Engine,
+    :tables => true,
+    :autolink => true,
+    :superscript => true,
+    :strikethrough => true,
+    :no_intra_emphasis => true,
+    :fenced_code_blocks => true
+  )
+end