docs.notes¶
Render the note kinds as a markdown table.
The rows come from the runner's own kind registry — what the level system resolves against and the config validator refuses unknown kinds by — so a reference page that regenerates this on each docs build can neither list a kind footman lacks nor miss one it has. Without --out the table is the task's stdout; with --out it is written to the file.
| 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)