mdpage

Simple documentation tool

mdPage is a minimal, opinionated, command line utility (and Rust crate) for creating single-page HTML documentation from markdown files.

Demo

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.

Installation

There are multiple ways to install mdPage.

1. Binaries

   Binaries are available for download here. Make sure to put the path to the binary into your PATH.

2. 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.

Usage

mdpage tool takes a singe argument, the root path directory where all the markdown content is located.

$ mdpage --help
mdpage 0.1.1
Generate simple documentation

USAGE:
    mdpage [FLAGS] [OPTIONS] <path>

FLAGS:
        --full-page    Generate full page documentation
    -h, --help         Prints help information
    -V, --version      Prints version information

OPTIONS:
    -o, --output <output>        The output file
        --subtitle <subtitle>    Subtitle of the document
        --title <title>          Title of the document

ARGS:
    <path>    Path for the directory containing data

The result of running the tool is always an index.html file.

Example workflow:

$ ls ./examples/basic | sort
page1.md
page2.md
readme.md

$ mdpage ./examples/basic

$ ls ./examples/basic | sort
index.html
page1.md
page2.md
readme.md

$ open index.html

License

Apache-2.0