docs.page¶
Render the task tree (or one group/task) as one markdown page.
Without --out the page is the task's stdout, ready to redirect or pipe (into pandoc, say); with --out it is written to the file. The heading level makes the page nest under a host site's own structure, so it drops into zensical/mkdocs via a snippet include.
fm docs.page [--target=VALUE] [--heading=INT] [--flavor={plain|material}] [--out=PATH] [--prog=VALUE] [--all]
| Parameter | Type | Default | Description |
|---|---|---|---|
--target=VALUE |
"" |
dotted task/group to scope to; empty = all | |
--heading=INT |
int | 1 |
top heading level |
--flavor={plain|material} |
plain | material |
"plain" |
plain CommonMark, or material/zensical extras |
--out=PATH |
path | file to write the page into; omitted = stdout | |
--prog=VALUE |
"fm" |
command name in usage and examples | |
--all |
flag | false |
include footman's own mounted tasks |
Returns: a list of text (or null)