Skip to content

usage generate markdown

Generate markdown documentation from usage specs

Flags

  • -f --file <FILE> — A usage spec taken in as a file, use "-" to read from stdin

  • --view <VIEW> — Render one spec-declared executable view

  • -m --multi — Render each subcommand as a separate markdown file

  • --html-encode — Escape HTML in markdown

  • --out-dir <OUT_DIR> — Output markdown files to this directory (required when using --multi)

    Effect: modifies state

  • --out-file <OUT_FILE> — Output file path for single-file markdown generation, or "-" for stdout (default)

    Effect: modifies state

  • --replace-pre-with-code-fences — Replace <pre> tags with markdown code fences

  • --url-prefix <URL_PREFIX> — Prefix to add to all URLs

  • --template <TEMPLATE> — Override a Tera template with NAME=PATH

  • -h --help — Print help

MIT LicenseCopyright © 2026jdx.dev