- Homepage
- Issues
- Documentation
- [Email](mailto:postmodern.mod3 at gmail.com)
A Kramdown convert for converting Markdown files into man pages.
- Converts markdown to roff:
- Supports codespans, emphasis and strong fonts.
- Supports normal, hanging and tagged paragraphs.
- Supports bullet lists.
- Supports multi-paragraph list items and blockquotes.
- Supports horizontal rules.
- Supports converting
[bash](man:bash(1))
links into man page references.
- Provides Rake task for converting
man/*.md
into man pages. - Uses the pure-Ruby Kramdown markdown parser.
- Supports Ruby 1.8.x, 1.9.x, 2.0.x, JRuby, Rubinius.
Render a man page from markdown:
$ kramdown-man <man/myprog.1.md >man/myprog.1
Render a man page from a markdown file:
require 'kramdown/man'
doc = Kramdown::Document.new(File.read('man/kramdown-man.1.md'))
File.write('man/kramdown-man.1',doc.to_man)
system 'man', 'man/kramdown-man.1'
Define a man
and file tasks which render all *.md
files within the
man/
directory:
require 'kramdown/man/task'
Kramdown::Man::Task.new
`code`
code
*emphasis*
emphasis
**strong**
strong
Normal paragraph.
Normal paragraph.
`command` [`--foo`] *FILE*
command
[--foo
] FILE
`--tagged`
Text here.
--tagged
Text here.
[website](http://example.com/)
[bash](man:bash(1))
bash
Email <[email protected]>
Email [email protected]
* one
* two
* three
extra paragraph
-
one
-
two
-
three
extra paragraph
-
one
-
two
-
three
extra paragraph
-
-
one
-
two
-
three
extra paragraph
-------------------------------------------------------------------------------
> Perfection is achieved, not when there is nothing more to add, but when there is nothing left to take away.
>
> --Antoine de Saint-Exupéry
Perfection is achieved, not when there is nothing more to add, but when there is nothing left to take away.
--Antoine de Saint-Exupéry
#include <stdio.h>
int main()
{
printf("hello world\n");
return 0;
}
#include <stdio.h>
int main()
{
printf("hello world\n");
return 0;
}
- kramdown ~> 1.0
$ gem install kramdown-man
Copyright (c) 2013 Hal Brodigan
See {file:LICENSE.txt} for details.