📚 Converts markdown into UNIX manual pages
Major:
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.
Minor:
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.
Other:
Patch:
Blockquote's leading paragraph regexp was not anchored.
Freezing internal constants prevents monkey patching.
Other:
Upgraded to Binman 3 for better interoperability with Bundler.
Added example input file from the Linux Man Page Howto.
Forgot to change project slogan in the gem package.
Minor:
Md2Man::Document
module for programmatic processing of
cross-references to other UNIX manual pages within Redcarpet.Other:
README: not all systems support man -l
option.
gemspec: upgrade to redcarpet 2.1.0.
bundler suggests moving all dev deps into gemspec.
README: fix installation commands for development.
README: simplify project slogan to be more memorable.
Minor:
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.
Patch:
Other:
~>
for gem version constraints.
See http://docs.rubygems.org/read/chapter/16
Thanks to Postmodern for this contribution.Patch:
roff: do not render references inside code blocks.
roff: do not render references inside code spans.
roff: fix single-line indented paragraph detection.
roff: also indent block_code just like block_quote.
roff: add paragraph above block_quote for spacing.
roff: render code blocks as paragraphs for spacing.
Otherwise there's not enough space between the previous paragraph and the code block: it appears on the next line and appears ugly in man(1).
document: make reference regexp match more manpages.
Other:
document: stronger digest encoding using NUL bytes.
document: super() can't reach Redcarpet's renderer classes. See https://github.com/vmg/redcarpet/issues/51 for details.
Minor:
roff: emit non-first H1 headings as H2 headings
html: add Md2Man::HTML::Engine
class for HTML manual page generation
html: add md2man-html(1) bin script for command line access to the above
html: add ID attributes on all headings for easy permalinking
rake: add md2man/rakefile
to process markdown files in man/
This library provides a rake md2man
task that builds UNIX and HTML
manual pages from Markdown files (with ".markdown", ".mkd", or ".md"
extension) inside your man/man*/
directories. It also provides
sub-tasks to build only UNIX or HTML manual pages separately.
It also hooks into Bundler's gem packaging tasks to automatically build your manual pages for packaging into a gem. See the README for details.