📚 Converts markdown into UNIX manual pages
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
Minor:
The md2man:web task from md2man/rakefile now:
emits valid HTML5 with helpful HTML page titles
uses Twitter Bootstrap styling for HTML man pages
emits only ONE index page for all HTML man pages
Other:
README: better organize the subsections of "Usage"
include md2man rake tasks in developer's rakefile
Patch:
All this time, this project's documentation stated that Redcarpet's
no_intra_emphasis option was enabled, but in reality, it was not.
The documentation has been corrected and the option remains disabled.
In web pages generated by the md2man:web Rake task:
deactivate cross references to external manual pages
don't assume that NAME section contains a tagline
sort man/ subdirectories in the HTML index page
fix link to index page from webs directly in man/
add generator META tag to HTML output template
only apply special styling to the first H1 child
parse title from first paragraph containing hyphen
Other:
rename HISTORY to VERSION so it sorts after README
tests should exercise engines with default options
Minor:
Added an md2man-rake(1) executable that lets you run md2man's rake(1)
tasks directly from the command line: without the need for a "Rakefile"
in your working directory that loads the md2man/rakefile library.
In web pages generated by the md2man:web Rake task:
extract CSS into a separate man/style.css file
center manpage on screen & auto-split into columns
Patch:
In web pages generated by the md2man:web Rake task:
man/ directoryOther:
This release renames md2man executables and libraries to highlight the fact that md2man provides two processing pathways: one for Roff and one for HTML.
Major:
Rename md2man(1) executable to md2man-roff(1).
Rename Md2Man::Engine to Md2Man::Roff::Engine.
Rename "manpage-reference" CSS class to "md2man-xref" in HTML output.
The Md2Man::Document#reference() method now takes only two parameters:
input_match - MatchData object for the reference in Markdown input
containing the following named capture groups:
:page - name of the manual page
:section - section number of the manual page
output_match - MatchData object for the reference in output document
containing the following named capture groups:
:addendum - non-space characters immediately after the reference in
the output documentPatch:
Other:
Patch:
Use a proper CDN to access Bootstrap 2.3.2 styling in HTML output.
Ensure that man/ directory exists for the md2man:web Rake task.
Specify license in gemspec file to fix warning when building gem.
Thanks to Bastien Dejean for contributing this patch.
Other:
Upgrade dependent gems by running bundle update.
minitest 4.7.5 provides spec library via autorun.
Patch:
GH-14: escape single quotes at beginning of lines
See the "CONTROL CHARACTERS" section in the groff(7) manual for details.
Thanks to Nick Fagerlund for reporting this bug.
escape periods at line beginnings with & escape
escape text line backslashes as "\e" per groff(7)
better documentation for escaping in normal_text()
it's better to escape backslashes as [rs] than \e
See "Single-Character Escapes" section in groff(7).
Other: