man/man0/README.html in md2man-1.6.2 vs man/man0/README.html in md2man-2.0.0
- old
+ new
@@ -1,111 +1,126 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
- <meta name="generator" content="md2man 1.6.2 https://github.com/sunaku/md2man" />
+ <meta name="generator" content="md2man 2.0.0 https://github.com/sunaku/md2man" />
<title>README</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="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man0">man0</a>/README</span></div></div><div class="container-fluid"><div class="manpage"><h1 id="md2man-markdown-to-manpage">md2man - markdown to manpage</h1><p>md2man is a Ruby library and command-line program that converts <a href="http://daringfireball.net/projects/markdown/">Markdown</a>
-documents 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</h2>
+<body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man0">man0</a>/README</span></div></div><div class="container-fluid"><h1 id="md2man-markdown-to-manpage">md2man - markdown to manpage</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</h2>
<ul>
<li><p>Formats tagged and indented paragraphs (see "document format" below).</p></li>
<li><p>Translates all HTML4 and XHTML1 entities into native <a href="http://troff.org">roff</a> equivalents.</p></li>
<li><p>Supports markdown extensions such as <a href="http://michelf.com/projects/php-markdown/extra/#table">PHP Markdown Extra tables</a>.</p></li>
-<li><p>Usable from the command line as a filter in a UNIX pipeline.</p></li>
+<li><p>Usable from the command line as a filter in a UNIX command pipeline.</p></li>
</ul>
-<h3 id="Demonstration">Demonstration</h3><p>Try converting <a href="https://raw.github.com/sunaku/md2man/master/EXAMPLE.markdown">this example Markdown file</a> into a UNIX manual page:</p><pre><code>md2man EXAMPLE.markdown > EXAMPLE.1
+<h3 id="Demonstration">Demonstration</h3><p>Try converting <a href="https://raw.github.com/sunaku/md2man/master/EXAMPLE.markdown">this example Markdown file</a> into a UNIX manual page:</p>
+<pre><code>md2man-roff EXAMPLE.markdown > EXAMPLE.1
man -l EXAMPLE.1
-</code></pre><p><img src="https://raw.github.com/sunaku/md2man/master/EXAMPLE.png" alt="Obligatory screenshot of <a class="manpage-reference" href="../man1/md2man.1.html">md2man(1)</a> in action!"></p><h3 id="Limitations">Limitations</h3><p>At present, md2man does not translate the following <a href="https://github.com/vmg/redcarpet">Redcarpet</a> node types:</p>
-<ul>
-<li><code>block_html</code></li>
-<li><code>strikethrough</code></li>
-<li><code>superscript</code></li>
-<li><code>image</code></li>
-<li><code>raw_html</code></li>
-</ul>
-<p>It issues a warning when it encounters these instead. Patches are welcome!</p><h2 id="Installation">Installation</h2><pre><code>gem install md2man
-</code></pre><h3 id="Development">Development</h3><pre><code>git clone git://github.com/sunaku/md2man
+</code></pre>
+<p><img src="https://raw.github.com/sunaku/md2man/master/EXAMPLE.png" alt="Obligatory screenshot of md2man(1) in action!"></p><p>Also try converting <a href="https://raw.github.com/sunaku/md2man/master/EXAMPLE.markdown">that example Markdown file</a> into a web page:</p>
+<pre><code>md2man-html EXAMPLE.markdown > EXAMPLE.html
+open EXAMPLE.html
+</code></pre>
+<h2 id="Installation">Installation</h2>
+<pre><code>gem install md2man
+</code></pre>
+<h3 id="Development">Development</h3>
+<pre><code>git clone git://github.com/sunaku/md2man
cd md2man
bundle install
-bundle exec md2man --help # run it directly
-bundle exec rake --tasks # packaging tasks
-</code></pre><h2 id="Usage">Usage</h2><h3 id="Document-format">Document format</h3><p>md2man extends <a href="http://daringfireball.net/projects/markdown/">Markdown</a> syntax in the following ways, as provisioned in the
-<code>Md2Man::Document</code> module and defined in its derivative <code>Md2Man::Roff</code> module:</p>
-<ul>
-<li><p>Paragraphs whose lines are all uniformly indented by two spaces are
-considered to be "indented paragraphs". They are unindented accordingly
-before emission as <code>.IP</code> in the <a href="http://troff.org">roff</a> output.</p></li>
-<li><p>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 <code>.TP</code> in the <a href="http://troff.org">roff</a> output.</p></li>
-</ul>
-<p>md2man extends <a href="http://daringfireball.net/projects/markdown/">Markdown</a> semantics in the following ways:</p>
-<ul>
-<li>The first top-level heading (H1) found in the document is emitted as <code>.TH</code>
-in the <a class="manpage-reference">roff(7)</a> output to define the UNIX manual page's header and footer.
-Any subsequent top-level headings (H1) are treated as second-level (H2).</li>
-</ul>
-<h3 id="For-roff-output">For <a href="http://troff.org">roff</a> output</h3><h4 id="At-the-command-line">At the command line</h4><pre><code>md2man --help
-</code></pre><h4 id="Inside-a-Ruby-script">Inside a Ruby script</h4><p>Use the default renderer:</p><pre><code>require 'md2man'
+bundle exec rake --tasks # packaging tasks
+bundle exec md2man-roff --help # run it directly
+bundle exec md2man-html --help # run it directly
+</code></pre>
+<h2 id="Usage">Usage</h2><h3 id="For-roff-output">For <a href="http://troff.org">roff</a> output</h3><h4 id="At-the-command-line">At the command line</h4><p>See <a class="md2man-xref" href="../man1/md2man-roff.1.html">md2man-roff(1)</a> manual:</p>
+<pre><code>md2man-roff --help
+</code></pre>
+<h4 id="Inside-a-Ruby-script">Inside a Ruby script</h4><p>Use the default renderer:</p>
+<pre><code>require 'md2man/roff/engine'
-your_roff_output = Md2Man::ENGINE.render(your_markdown_input)
-</code></pre><p>Build your own renderer:</p><pre><code>require 'md2man'
+your_roff_output = Md2Man::Roff::<a class="md2man-xref">ENGINE.render(your_markdown_input)</a>
+</code></pre>
+<p>Build your own renderer:</p>
+<pre><code>require 'md2man/roff/engine'
-engine = Redcarpet::Markdown.new(Md2Man::Engine, your_options_hash)
-your_roff_output = engine.render(your_markdown_input)
-</code></pre><p>Define your own renderer:</p><pre><code>require 'md2man'
+engine = Redcarpet::Markdown.new(Md2Man::Roff::Engine, your_options_hash)
+your_roff_output = <a class="md2man-xref">engine.render(your_markdown_input)</a>
+</code></pre>
+<p>Define your own renderer:</p>
+<pre><code>require 'md2man/roff/engine'
-class YourManpageRenderer < Md2Man::Engine
+class YourManpageRenderer < Md2Man::Roff::Engine
# ... your stuff here ...
end
engine = Redcarpet::Markdown.new(YourManpageRenderer, your_options_hash)
-your_roff_output = engine.render(your_markdown_input)
-</code></pre><p>Mix-in your own renderer:</p><pre><code>require 'md2man'
+your_roff_output = <a class="md2man-xref">engine.render(your_markdown_input)</a>
+</code></pre>
+<p>Mix-in your own renderer:</p>
+<pre><code>require 'md2man/roff'
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)
-</code></pre><h3 id="For-HTML-output">For HTML output</h3><h4 id="At-the-command-line">At the command line</h4><pre><code>md2man-html --help
-</code></pre><h4 id="Inside-a-Ruby-script">Inside a Ruby script</h4><p>Use the default renderer:</p><pre><code>require 'md2man/html/engine'
+your_roff_output = <a class="md2man-xref">engine.render(your_markdown_input)</a>
+</code></pre>
+<h3 id="For-HTML-output">For HTML output</h3><h4 id="At-the-command-line">At the command line</h4><p>See <a class="md2man-xref" href="../man1/md2man-html.1.html">md2man-html(1)</a> manual:</p>
+<pre><code>md2man-html --help
+</code></pre>
+<h4 id="Inside-a-Ruby-script">Inside a Ruby script</h4><p>Use the default renderer:</p>
+<pre><code>require 'md2man/html/engine'
-your_html_output = Md2Man::HTML::ENGINE.render(your_markdown_input)
-</code></pre><p>Build your own renderer:</p><pre><code>require 'md2man/html/engine'
+your_html_output = Md2Man::HTML::<a class="md2man-xref">ENGINE.render(your_markdown_input)</a>
+</code></pre>
+<p>Build your own renderer:</p>
+<pre><code>require 'md2man/html/engine'
engine = Redcarpet::Markdown.new(Md2Man::HTML::Engine, your_options_hash)
-your_html_output = engine.render(your_markdown_input)
-</code></pre><p>Define your own renderer:</p><pre><code>require 'md2man/html/engine'
+your_html_output = <a class="md2man-xref">engine.render(your_markdown_input)</a>
+</code></pre>
+<p>Define your own renderer:</p>
+<pre><code>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)
-</code></pre><p>Mix-in your own renderer:</p><pre><code>require 'md2man/html'
+your_html_output = <a class="md2man-xref">engine.render(your_markdown_input)</a>
+</code></pre>
+<p>Mix-in your own renderer:</p>
+<pre><code>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)
-</code></pre><h3 id="Building-man-pages">Building man pages</h3><h4 id="At-the-command-line">At the command line</h4><pre><code>md2man-rake --help
-</code></pre><h4 id="Inside-a-Ruby-script">Inside a Ruby script</h4><p>Add this snippet to your gemspec file:</p><pre><code>s.files += Dir['man/man?/*.?'] # UNIX man pages
-s.files += Dir['man/**/*.{html,css,js}'] # HTML man pages
-s.add_development_dependency 'md2man', '~> 1.4'
-</code></pre><p>Add this line to your Rakefile:</p><pre><code>require 'md2man/rakefile'
-</code></pre><p>You now have a <code>rake md2man</code> task that builds manual pages from Markdown files
+your_html_output = <a class="md2man-xref">engine.render(your_markdown_input)</a>
+</code></pre>
+<h3 id="Building-man-pages">Building man pages</h3><h4 id="At-the-command-line">At the command line</h4><p>See <a class="md2man-xref" href="../man1/md2man-rake.1.html">md2man-rake(1)</a> manual:</p>
+<pre><code>md2man-rake --help
+</code></pre>
+<h4 id="Inside-a-Ruby-script">Inside a Ruby script</h4><p>Add this snippet to your gemspec file:</p>
+<pre><code>s.files += Dir['man/man?/*.?'] # UNIX man pages
+s.files += Dir['man/**/*.{html,css,js}'] # HTML man pages
+s.add_development_dependency 'md2man', '~> 1.4'
+</code></pre>
+<p>Add this line to your Rakefile:</p>
+<pre><code>require 'md2man/rakefile'
+</code></pre>
+<p>You now have a <code>rake md2man</code> task that builds manual pages from Markdown files
(with ".markdown", ".mkd", or ".md" 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'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:</p><pre><code>bundle exec rake build
+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/
-</code></pre><h2 id="License">License</h2><p>Released under the ISC license. See the LICENSE file for details.</p></div></div></body>
+</code></pre>
+<h2 id="License">License</h2><p>Released under the ISC license. See the LICENSE file for details.</p></div></body>
</html>