Skip to content

Commit

Permalink
Version 5.1.0 (2016-02-28)
Browse files Browse the repository at this point in the history
  • Loading branch information
sunaku committed Feb 28, 2016
1 parent b675e57 commit 7f05e82
Show file tree
Hide file tree
Showing 8 changed files with 41 additions and 18 deletions.
10 changes: 5 additions & 5 deletions README.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
# md2man - markdown to manpage

md2man is a Ruby library and a set of command-line programs that convert
[Markdown] into UNIX manual pages (both [roff] and HTML) using [Redcarpet].
[Markdown] into UNIX manpages as well as HTML webpages using [Redcarpet].

## Features

Expand Down Expand Up @@ -188,7 +188,7 @@ engine = Redcarpet::Markdown.new(YourManpageRenderer, your_options_hash)
your_html_output = engine.render(your_markdown_input)
```

### Building man pages
### Building manpages

#### At the command line

Expand All @@ -203,8 +203,8 @@ md2man-rake --help
Add this snippet to your gemspec file:

```ruby
s.files += Dir['man/man?/*.?'] # UNIX man pages
s.files += Dir['man/**/*.{html,css,js}'] # HTML man pages
s.files += Dir['man/man?/*.?'] # UNIX manpages
s.files += Dir['man/**/*.{html,css}'] # HTML manpages
s.add_development_dependency 'md2man', '~> 5.0'
```

Expand All @@ -231,6 +231,6 @@ gem spec pkg/*.gem | fgrep man/
Released under the ISC license. See the LICENSE file for details.

[roff]: http://troff.org
[Markdown]: http://daringfireball.net/projects/markdown/
[Redcarpet]: https://github.com/vmg/redcarpet
[Markdown]: http://daringfireball.net/projects/markdown/
[tables]: http://michelf.com/projects/php-markdown/extra/#table
24 changes: 24 additions & 0 deletions VERSION.markdown
Original file line number Diff line number Diff line change
@@ -1,3 +1,27 @@
## Version 5.1.0 (2016-02-28)

### Minor:

* md2man-html(1): add syntax highlighting to fenced code blocks.

* md2man-rake(1): add directory name to README and "man/index" title.

Fallback to adding directory name for standalone titles, such as "README"
and "man/index", so that users know what project those manuals belong to.

* md2man-rake(1): allow running task names without namespace.

You can now run `md2man-rake man` instead of `md2man-rake md2man:man`,
and similarly `md2man-rake web` instead of `md2man-rake md2man:web`.

### Patch:

* Clarify optionalness of PATTERN in `--help` option.

* md2man(5): paragraph types reflect .PP, .TP, .IP.

* Link to Markdown website instead of markdown(7).

## Version 5.0.3 (2016-02-21)

This release fixes a crash, fixes roff bugs, improves CSS styling for HTML
Expand Down
2 changes: 1 addition & 1 deletion bin/md2man-html
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/usr/bin/env ruby
=begin =======================================================================
# MD2MAN-HTML 1 2016-02-21 5.0.3
# MD2MAN-HTML 1 2016-02-28 5.1.0
## NAME
Expand Down
5 changes: 3 additions & 2 deletions bin/md2man-rake
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/usr/bin/env ruby
=begin =======================================================================
# MD2MAN-RAKE 1 2016-02-21 5.0.3
# MD2MAN-RAKE 1 2016-02-28 5.1.0
## NAME
Expand Down Expand Up @@ -38,7 +38,8 @@ If no *TASK* is specified, then the `md2man` task is run by default.
`-h` [*PATTERN*], `--help` [*PATTERN*]
Show this help manual and optionally search for *PATTERN* regular expression.
Run `rake --help` to see more options.
...
Anything else is passed to rake(1); run `rake --help` for documentation.
## SEE ALSO
Expand Down
2 changes: 1 addition & 1 deletion bin/md2man-roff
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/usr/bin/env ruby
=begin =======================================================================
# MD2MAN-ROFF 1 2016-02-21 5.0.3
# MD2MAN-ROFF 1 2016-02-28 5.1.0
## NAME
Expand Down
2 changes: 1 addition & 1 deletion lib/md2man/version.rb
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
module Md2Man
VERSION = "5.0.3"
VERSION = "5.1.0"
end
6 changes: 2 additions & 4 deletions man/man5/md2man.5.markdown
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# MD2MAN 5 2016-02-21 5.0.3
# MD2MAN 5 2016-02-28 5.1.0

## NAME

md2man - UNIX manual page flavoring for [Markdown]

## DESCRIPTION

[md2man] makes the [Markdown] format more friendly for writing UNIX manual
md2man makes the [Markdown] format more friendly for writing UNIX manual
pages by extending its syntax, semantics, and assumed processing extensions.

### Syntax
Expand Down Expand Up @@ -187,6 +187,4 @@ http://www.schweikhardt.net/man_page_howto.html)

[Markdown], man-pages(7), roff(7), md2man-roff(1), md2man-html(1)

[md2man]: https://github.com/sunaku/md2man
[Redcarpet]: https://github.com/vmg/redcarpet
[Markdown]: http://daringfireball.net/projects/markdown/syntax
8 changes: 4 additions & 4 deletions md2man.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,17 @@ Gem::Specification.new do |s|
s.authors,
s.email = File.read('LICENSE').scan(/Copyright \d+ (.+) <(.+?)>/).transpose
s.license = 'ISC'
s.homepage = 'http://github.com/sunaku/md2man'
s.homepage = 'https://sunaku.github.io/md2man'
s.summary = 'markdown to manpage'
s.description = 'Converts markdown documents into UNIX manual pages.'
s.description = 'Converts markdown into UNIX manpages and HTML webpages.'

s.files = `git ls-files`.split("\n")
s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
s.require_paths = ['lib']

s.files += Dir['man/man?/*.?'] # UNIX man pages
s.files += Dir['man/**/*.{html,css,js}'] # HTML man pages
s.files += Dir['man/man?/*.?'] # UNIX manpages
s.files += Dir['man/**/*.{html,css}'] # HTML manpages

s.required_ruby_version = '>= 1.9.1'
s.add_runtime_dependency 'binman', '~> 5.0'
Expand Down

0 comments on commit 7f05e82

Please sign in to comment.