kramdown-man - generates man pages from markdown files
kramdown-man
[options] MARKDOWN_FILE
A Kramdown plugin for converting Markdown files into man pages.
MARKDOWN_FILE : The input markdown file to convert.
-o
, --output
OUTPUT
: The file to write the man page output to.
-V
, --version
: Prints the kramdown-man
version.
-h
, --help
: Prints the usage for kramdown-man
.
Render a man page from markdown:
$ kramdown-man -o man/myprogram.1 man/myprogram.1.md
Preview the rendered man page:
$ kramdown-man man/myprogram.1.md
require 'kramdown'
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 files 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
*ARG*
: Description here.
ARG : Description here.
`-o`, `--option` *VALUE*
: Description here.
-o
, --option
VALUE
: Description here.
[website](http://example.com/)
Link to other man pages in a project:
[kramdown-man](kramdown-man.1.md)
Link to other system man page:
[bash](man:bash(1))
bash
Note: only works on firefox on Linux.
Email <bob@example.com>
Email bob@example.com
* one
* two
* three
- one
- two
- three
1. one
2. two
3. three
- one
- two
- three
ex·am·ple
: a thing characteristic of its kind or illustrating a general rule.
: a person or thing regarded in terms of their fitness to be imitated or the
likelihood of their being imitated.
ex·am·ple : a thing characteristic of its kind or illustrating a general rule.
: a person or thing regarded in terms of their fitness to be imitated or the likelihood of their being imitated.
> 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;
}
```
puts "hello world"
```
puts "hello world"
Postmodern postmodern.mod3@gmail.com