Skip to content

docs.build

Mount every package's docs, assemble the config, and build the site, strict.

Strict is the point: a broken link or an orphan page fails here, on the machine, before CI says the same thing. --package builds a scoped preview of one section instead, into the gitignored .docs-preview/ directory; the preview is not strict, because chrome pages may link into sections it does not carry, and the workspace build owns strictness. A package whose docs did not move keeps its mount; --full rebuilds them all.

fm docs.build [--package=VALUE] [--full]
Parameter Type Default Description
--package=VALUE "" build a scoped preview of this package's section only
--full flag false rebuild every package's mount whole

Example

$ fm docs.build --full