kramdown-man
- Homepage
- Issues
- Documentation
- [Email](mailto:postmodern.mod3 at gmail.com)
Description
A Kramdown convert for converting Markdown files into man pages.
Features
- 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/*.mdinto man pages. - Uses the pure-Ruby Kramdown markdown parser.
- Supports Ruby 2.0 and JRuby.
Synopsis
Render a man page from markdown:
$ kramdown-man <man/myprog.1.md >man/myprog.1
Examples
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
Syntax
Formatting
`code`
code
*emphasis*
emphasis
**strong**
strong
Paragraphs
Normal paragraph.
Normal paragraph.
`command` [`--foo`] *FILE*
command [--foo] FILE
`--tagged`
Text here.
--tagged
Text here.
Links
[website](http://example.com/)
[bash](man:bash(1))
bash
Email <[email protected]>
Email [email protected]
Lists
* one
* two
* three
extra paragraph
-
one
-
two
-
three
extra paragraph
-
one
-
two
-
three
extra paragraph
-
-
one
-
two
-
three
extra paragraph
Horizontal Rule
-------------------------------------------------------------------------------
Blockquotes
> 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
Code Blocks
#include <stdio.h>
int main()
{
printf("hello world\n");
return 0;
}
#include <stdio.h>
int main()
{
printf("hello world\n");
return 0;
}
Requirements
- kramdown ~> 2.0
Install
$ gem install kramdown-man
Alternatives
Copyright
Copyright (c) 2013-2020 Hal Brodigan
See {file:LICENSE.txt} for details.