milpa help docs

Displays docs on TOPIC

milpa help docs [options] [TOPIC...]

Shows markdown-formatted documentation from milpa repos. See milpa help docs milpa repo docs for more information on how to write your own.

An HTTP server to browse documentation can be started by running:

milpa help docs --server
# then head to http://localhost:4242

Command and docs are available at their names, replacing spaces with forward slashes /, for example:

• https://milpa.dev/help/docs will show this help page.
• https://milpa.dev/itself/doctor shows documentation for the milpa itself doctor command.
• https://milpa.dev/help/docs/milpa renders the file at .milpa/docs/milpa.md (or .milpa/docs/milpa/index.md).

• milpa

• TOPIC... - The topic to show docs for

• --base (string): A URL base to use for rendering html links. Default: http://localhost:4242.
• --listen (string): The address to listen at when using --server. Default: localhost:4242.
• --server (bool): Starts an http server at the specified address.

• --color (bool): Always print colors to stderr. Default: true.
• --help (bool): Display help for any command.
• --no-color (bool): Disable printing of colors to stderr.
• --silent (bool): Silence non-error logging.
• --skip-validation (bool): Do not validate any arguments or options.
• --verbose (bool): Log verbose output to stderr.