assemble cli command

docs-builder assemble [options]
		

Do a full assembler clone, build, and optional serving of the full documentation in one step.

This command is shorthand for running the following in sequence:

docs-builder assembler clone
docs-builder assembler build
docs-builder assembler serve
		

--[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.

--[no-]fetch-latest

Fetch the HEAD of each branch instead of the pinned link-registry ref.

--[no-]assume-cloned

Skip cloning; assume repositories are already on disk. Useful for iterating on the build.

--[no-]serve

Serve the site on port 4000 after a successful build.

Default: false

-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

Where this command really shines is when you want to create a temporary workspace folder to validate:

• changes to site wide configuration.
• changes to one or more repositories and their effect on the assembler build.

To do that inside an empty folder, call:

docs-builder assembler config init --local
docs-builder assemble --serve
		

This will source the latest configuration from the config folder on the main branch of docs-builder and place them inside the $(pwd)/config folder.

Now when you call docs-builder assemble rather than using the embedded configuration, it will use the local one you just created. You can be explicit about the configuration source to use:

docs-builder assembler config init --local
docs-builder assemble --serve -c local