Loading

build cli command

docs-builder build [options]

Scope: directory.

Build a single documentation set from source.

-p --path string

Root directory of the documentation source. Defaults to cwd/docs.

Constraints: symbolic links not allowed, must exist, supports ~ home expansion

-o --output string

Destination for generated HTML. Defaults to .artifacts/html.

Constraints: symbolic links not allowed, supports ~ home expansion

--path-prefix string
URL path prefix prepended to every generated link.
--[no-]force
Delete and rebuild the output folder even if nothing changed.
--[no-]strict
Treat warnings as errors.
--[no-]allow-indexing
Emit meta robots tags that allow search engine indexing.
--[no-]metadata-only
Write only metadata files; skip HTML generation. Ignored when --exporters is also set.
--exporters string
Comma-separated list of exporters to run.
--canonical-base-url string

Base URL written into <link rel=canonical> tags.

Constraints: must be a http or https URI

--[no-]skip-api
Skip OpenAPI spec generation for faster builds.
Skip fetching cross-doc-set link indexes.
--[no-]in-memory

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

Locates the documentation root by searching for a docset.yml file starting at options .Path. The output directory is wiped and rebuilt on each run unless incremental build detects no changes.