Madness - Instant Markdown Server

---

Install

$ bundle install madness

Usage

Go to any directory that contains markdown files and run:

$ madness

For more options, run:

$ madness --help

Directory Conventions

Madness expects to be executed in a documentation directory.

A documentation directory contains only markdown files (*.md) and subfolders that contain more markdown files.

The server will consider the file README.md in any directory as the main file describing this directory.

The navigation sidebar will show all the sub directories and files in the same directory as the viewed file.