Skip to content

docs.config

Render this runner's config keys as a markdown table.

The rows come from the runner's own list of recognised keys, so a reference page that regenerates this on each docs build can neither describe a key the runner lacks nor miss one it has — and it names the table this runner reads ([tool.acme] under a branded CLI), because a runner opens its own table and no other. Without --out the table is the task's stdout; with --out it is written to the file.

fm docs.config [--out=PATH] [--prog=VALUE]
Parameter Type Default Description
--out=PATH path file to write the table into; omitted = stdout
--prog=VALUE "fm" command name in the table

Returns: a list of text (or null)

Example

$ fm docs.config