assembler build cli command

docs-builder assembler build [options]

Idempotent

Note

This command requires that you've previously run docs-builder assembler clone to clone the documentation sets. If you cloned using a certain --environment you must also use that same --environment when building.

Builds all the documentation sets and assembles them into a complete documentation site ready to be deployed.

It uses the site configuration files to direct how the documentation sets should be assembled.

Options

--[no-]strict

Treat warnings as errors.

--environment string

Named deployment target, e.g. dev, staging, production. Determines which configuration branch and index names are used.

--[no-]metadata-only

Write only metadata files; skip HTML generation. Ignored when --exporters is also set.

--[no-]show-hints

Print documentation hints emitted during the build.

--exporters string

Comma-separated list of exporters to run.

--[no-]assume-build

Skip the build step when .artifacts/docs/index.html already exists. Intended for test scenarios only.

-l --log-level enum

Minimum log level.

Values: trace, debug, information, warning, error, critical, none

Default: information

-c --config-source enum

Override the configuration source: local, remote

Values: local, remote, embedded

--[no-]skip-private-repositories

Skip cloning private repositories