# MDoc

## Overview

A documentation engine for Lua

MDoc was built after frustrations with
[LDoc](https://stevedonovan.github.io/ldoc/manual/doc.md.html),
the usual and most popular documentation engine for lua. Like LDoc, MDoc users
comments in the source code to generate html files for documentation. Unlike
LDoc, it makes no attempts to be backwards compatible with LuaDoc. This results
in a documentation engine that is free from constraints like "One class per
file" or "one module per file". MDoc is still in it's early stages, expect
frequent code churn in the near future.

MDoc is used to document my homebrew VR platform, [Brok\[en\]gine](https://cogarr.net/source/cgit.cgi/brokengine/),
and you can see an example of mdoc in action in the [Brok\[en\]gine reference].

## Installation

The easiest way to download MDoc is with [luarocks](https://github.com/luarocks/luarocks)