Simple documentation tool
mdPage is a minimal, opinionated, command line utility (and Rust crate) for creating single-page HTML documentation from markdown files.
The mdPage documentation is generated using the mdpage CLI tool from markdown source files. There are additional examples listed in the documentation with sources available in the docs directory.
There are multiple ways to install mdPage.
Binaries
Binaries are available for download here. Make sure to put the
path to the binary into your PATH.
From Crates.io
This requires Rust and Cargo to be installed. Once you have installed Rust, type the following in the terminal:
cargo install mdpage
This will download and compile mdPage for you, the only thing left to do is
to add the Cargo bin directory to your PATH.
mdpage tool takes a singe argument, the root path directory where all the markdown content is located.
```sh $ mdpage --help mdpage 0.1.1 Generate simple documentation
USAGE:
mdpage [FLAGS] [OPTIONS]
FLAGS: --full-page Generate full page documentation -h, --help Prints help information -V, --version Prints version information
OPTIONS: -o, --output