Releases: sunaku/md2man
v2.1.1
Version 2.1.1 (2014-06-21)
Patch:
-
Bootstrap CSS failed to load for HTML manuals served under HTTPS.
See sunaku/readably#3 for the details. -
Drop redundant nil check in
Md2Man::Roff::Engine.escape()
.
Other:
-
GitHub now supports relative links from the README.
-
README: add links to package, manuals, and GitHub.
v2.1.0
Version 2.1.0 (2014-05-04)
Minor:
-
md2man-html(1) now adds anchors and permalinks to all headings. This
makes it easy for readers to bookmark and share direct links to specific
sections of your HTML manual pages. -
md2man-html(1) now wraps individual components of the special
.TH
top-level heading in HTML<span>
elements with stylable CSS classes:<span class="md2man-title">...</span> <span class="md2man-section">...</span> <span class="md2man-date">...</span> <span class="md2man-source">...</span> <span class="md2man-manual">...</span>
Thanks to Nick Fagerlund for requesting this feature in GH-15.
Other:
-
md2man(5) now documents the special
.TH
format of top-level headings.Thanks to Nick Fagerlund for requesting this documentation in GH-15.
v2.0.4
Version 2.0.4 (2014-04-26)
Patch:
-
GH-16: Redcarpet 3.1 added a third parameter to its
header()
method.
This raised an ArgumentError on "wrong number of arguments (3 for 2)".Thanks to zimbatm for contributing this patch.
-
GH-17 and GH-18: Escape periods, quotes, and hyphens in code blocks.
This fixes a bug where lines beginning with periods or single quotes
did not appear when md2man-roff(1) output was rendered using man(1).Thanks to zimbatm for reporting this bug and suggesting how to fix it.
v2.0.3
Version 2.0.3 (2014-01-16)
Patch:
-
Use CSS3
-ch
suffix for accurate 80-character width in HTML output.
v2.0.2
Version 2.0.2 (2013-09-08)
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:
- switch from double-quoted strings to single quotes
v2.0.1
Version 2.0.1 (2013-08-29)
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.
v2.0.0
Version 2.0.0 (2013-05-05)
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
toMd2Man::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 document
-
Patch:
- Prevent cross-references from being expanded inside HTML tags.
Other:
- Add md2man(5) manual page detailing md2man's markdown file format.
v1.6.2
v1.6.1
v1.6.0
Version 1.6.0 (2013-03-10)
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 themd2man/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:- don't rely on being emitted into a
man/
directory
- don't rely on being emitted into a
Other:
- add README and VERSION to generated HTML man pages