Publishing is separate from authoring. The create, update, review, test, and preview commands do not publish documentation.
Before you begin
You need:
- documentation that passes
doxloop test; - a Doxbrix account; and
- the selected generator's dependencies installed when the project uses an
external generator.
Sign in
doxloop loginDoxloop starts the device authorization flow. If browser sign-in is not available, it falls back to a token prompt.
Signed in to Doxbrix as <email>. Check or remove the active account with doxloop whoami and doxloop logout.For automation, prefer an environment variable over a command-line token:
export DOXLOOP_TOKEN=dxb_your_token_hereDOXBRIX_TOKEN is also accepted.
Run a dry run
Validate and package the documentation without uploading it:
doxloop deploy --dry-runFor a Doxbrix-native project, the dry run builds the documentation bundle. For another generator, it runs the configured local build and packages the static output. Both paths finish with No data was uploaded.
Publish the result
doxloop deployFor a Doxbrix-native project, Doxloop publishes the manifest, pages, and permitted media. For another generator, Doxloop builds the site locally, packages the contained static output, uploads a checksum-bound artifact, and waits for deployment to finish.
The configured product sources are excluded from both paths.
Override the derived project name or slug when needed:
doxloop deploy --name "My Docs" --slug my-docs