docgen

command
v0.18.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 11, 2026 License: MIT Imports: 8 Imported by: 0

Documentation

Overview

Command docgen generates Markdown documentation for every cobra command shipped by posh — both the binary-only commands (init, config, version) and the downstream-only commands that require a Plugin (prompt, execute, brew, require).

Output is one Markdown file per command, suitable for VitePress. The file header is rewritten so each page has a `# posh <subcommand>` title and a short YAML front matter block. Internal links between parent and subcommand pages keep cobra's default `.md` extension — VitePress resolves them.

Usage:

go run ./cmd/docgen --output docs/reference/cli

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL