docs.site¶

Render the task tree as linked pages: index.md per group, one file per task.

Made for docs sites — point into your docs tree and add the pages to the nav. Regenerate on each docs build so they can't drift.

fm docs.site <out> [--target=VALUE] [--flavor={plain|material}] [--prog=VALUE] [--all]

Parameter	Type	Default	Description
`<out>`	path	required	directory to write the pages into
`--target=VALUE`		`""`	dotted group to scope to; empty = all
`--flavor={plain\|material}`	`plain` \| `material`	`"material"`	material fits zensical/mkdocs; plain is portable
`--prog=VALUE`		`"fm"`	command name in usage and examples
`--all`	flag	`false`	include footman's own mounted tasks

Returns: a list of text

Example

$ fm docs.site <out> --all