Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
tag: 0.0.1
Fetching contributors…

Octocat-spinner-32-eaf2f5

Cannot retrieve contributors at this time

file 39 lines (23 sloc) 0.982 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 documentation. Also man in my opinion does a poor job of displaying the information, the whitespace makes them difficult to read. mad(1) is effectively the 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.

Something went wrong with that request. Please try again.