Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
tag: 0.1.0
Fetching contributors…

Cannot retrieve contributors at this time

44 lines (26 sloc) 1.124 kb

mad(1)

mad(1) is a markdown driven manual page viewer, this makes manuals easier to write, reuse, and read.

markdown man page

Usage

Usage: mad <file>

Options:

  -V, --version   output cpm version
  -h, --help      output this help information

Installation

Install mad(1) and its associated mad page.

$ make install

Uninstall both mad(1) and the associated mad page.

$ make uninstall

About

I love man pages, however they are annoying to write by hand, and often converted from markdown anyway. mad(1) is effectively the same idea, but write your manuals in markdown like you would anyway, re-use them in your github readmes, wikis, or use markdown to HTML conversion tools.

mad(1) pipes to less(1) so you get the same paging / searching goodness that you expect from man(1).

Screenshots

Jade manual:

jade manual markdown

Jump to Line
Something went wrong with that request. Please try again.