Skip to content
Browse files

Version 1.2.0

  • Loading branch information...
1 parent 7638203 commit 821fb9756e679a3f43b9fb26c33d9bc13b20ed9d Suraj N. Kurapati committed Feb 6, 2012
Showing with 43 additions and 21 deletions.
  1. +16 −0 HISTORY.markdown
  2. +10 −7 README.markdown
  3. +15 −12 bin/md2man
  4. +1 −1 lib/md2man/version.rb
  5. +1 −1 md2man.gemspec
View
16 HISTORY.markdown
@@ -1,3 +1,19 @@
+## Version 1.2.0 (2012-02-06)
+
+Minor:
+
+ * The `Md2Man::Document` module now handles paragraph() nodes and dispatches
+ their content accordingly to hook methods for indented, tagged, and normal
+ paragraphs. A Redcarpet markdown parser need only include that module and
+ implement those hook methods in order to benefit from md2man's extensions
+ to markdown syntax programmatically.
+
+Other:
+
+ * README: mention features; revise markdown; cleanup.
+
+ * LICENSE: @tanoku created initial Manpage renderer.
+
## Version 1.1.0 (2012-02-02)
Minor:
View
17 README.markdown
@@ -1,7 +1,7 @@
# md2man - markdown to manpage
md2man is a Ruby library and command-line program that converts [Markdown]
-documents into UNIX man pages (really [Roff] documents) using [Redcarpet].
+documents into UNIX manual pages (really [Roff] documents) using [Redcarpet].
## Features
@@ -15,7 +15,7 @@ documents into UNIX man pages (really [Roff] documents) using [Redcarpet].
### Demonstration
-Try converting [this example Markdown file][example] into a UNIX man page:
+Try converting [this example Markdown file][example] into a UNIX manual page:
md2man EXAMPLE.markdown > EXAMPLE.1
man EXAMPLE.1
@@ -52,7 +52,7 @@ It issues a warning when it encounters these instead. Patches are welcome!
md2man --help
-### In your Ruby scripts
+### Inside a Ruby script
Use the default renderer:
@@ -90,10 +90,8 @@ Mix-in your own renderer:
### Document format
-md2man applies 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.
+md2man extends [Markdown] syntax in the following ways, as provisioned in the
+`Md2Man::Document` module and defined in its derivative `Md2Man::Roff` module:
* Paragraphs whose lines are all uniformly indented by two spaces are
considered to be "indented paragraphs". They are unindented accordingly
@@ -103,6 +101,11 @@ md2man applies the following additional semantics to its [Markdown] input:
indented by two spaces are considered to be a "tagged paragraphs". They
are unindented accordingly before emission as `.TP` in the [Roff] output.
+md2man extends [Markdown] semantics in the following ways:
+
+ * There can be at most one top-level heading (H1). It is emitted as `.TH`
+ in the [Roff] output, defining the UNIX manual page's header and footer.
+
## License
Released under the ISC license. See the LICENSE file for details.
View
27 bin/md2man
@@ -1,7 +1,7 @@
#!/usr/bin/env ruby
=begin =======================================================================
-# MD2MAN 1 "2012-02-02" "1.1.0"
+# MD2MAN 1 2012-02-06 1.2.0
## NAME
@@ -19,10 +19,8 @@ md2man - convert markdown(7) into roff(7)
### Document format
-The following additional semantics are applied to the markdown(7) input:
-
- * 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.
+md2man extends markdown(7) syntax in the following ways, as provisioned in the
+`Md2Man::Document` module and defined in its derivative `Md2Man::Roff` module:
* Paragraphs whose lines are all uniformly indented by two spaces are
considered to be "indented paragraphs". They are unindented accordingly
@@ -32,16 +30,21 @@ The following additional semantics are applied to the markdown(7) input:
indented by two spaces are considered to be a "tagged paragraphs". They
are unindented accordingly before emission as `.TP` in the roff(7) output.
+md2man extends markdown(7) semantics in the following ways:
+
+ * There can be at most one top-level heading (H1). It is emitted as `.TH`
+ in the roff(7) output to define the UNIX manual page's header and footer.
+
### Markdown extensions
-The following [Redcarpet] extensions for markdown(7) are enabled:
+The following [Redcarpet] extensions are enabled while processing markdown(7):
-* tables
-* autolink
-* superscript
-* strikethrough
-* no_intra_emphasis
-* fenced_code_blocks
+ * tables
+ * autolink
+ * superscript
+ * strikethrough
+ * no_intra_emphasis
+ * fenced_code_blocks
## OPTIONS
View
2 lib/md2man/version.rb
@@ -1,3 +1,3 @@
module Md2Man
- VERSION = "1.1.0"
+ VERSION = "1.2.0"
end
View
2 md2man.gemspec
@@ -9,7 +9,7 @@ Gem::Specification.new do |s|
s.email = File.read('LICENSE').scan(/Copyright \d+ (.+) <(.+?)>/).transpose
s.homepage = 'http://github.com/sunaku/md2man'
s.summary = 'markdown to manpage'
- s.description = 'Converts markdown documents into UNIX man pages (roff).'
+ s.description = 'Converts markdown documents into UNIX manual pages.'
s.files = `git ls-files`.split("\n") + Dir['man/**/*']
s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")

0 comments on commit 821fb97

Please sign in to comment.
Something went wrong with that request. Please try again.