Docket

Docket is written in Rust and available on Crates.io. To install it globally use cargo:

$ cargo install docket

To convert a folder full of markdown into a static HTML site is as simple as docket. By default the current directory is searched for markdown and the target directory where the site is rendered is ./build. The source and target directory can be overridden with -s and -t:

Docket Documentation Generator

Usage: docket [options]

Options:
  -h --help           Show this screen.
  -w, --watch         Watch for changes and re-generate.
  -s, --source=<in>   Documentation directory, default is current directory.
  -t, --target=<out>  Write the output to <out>, default is `./build/`.

Further configuration is deliberately left impossible. The aim is to provide a simple way to create documentation without any configuration or theming to provide distractions.

Docket aims to replicate the features of d. Although this is built around limitation of configuration there are still a few settings that can be tweaked.

Markdown rendering is based on the CommonMark spec and rendered by Pulldown. There are, however, a few extensions.

This folder contains the design documents outlining the proposed sturcutre of Docket v2. The musings in this folder are by no means a guarantee of anything. It’s more a set of aspriations ossified.