OnCallReadyStart learning

techdocs-cli: Build, preview and publish Backstage TechDocs sites (@techdocs/cli 1.13)

techdocs-cli <command> [options]

What it does

The TechDocs generator outside Backstage: generate runs MkDocs (in the spotify/techdocs container by default) with the techdocs-core plugin over a repository's mkdocs.yml and docs/, publish uploads the result to the object storage Backstage reads in the recommended setup (CI builds, Backstage only serves). Usually run as npx @techdocs/cli <command>.

Options you will use

-V, --version
Output the version number.
-h, --help
Display help for command.

Examples

$ npx @techdocs/cli generate --source-dir . --output-dir ./site

build in the spotify/techdocs container

$ npx @techdocs/cli publish --publisher-type awsS3 --storage-name techdocs --entity default/Component/orders

upload ./site/ for one entity

Gotchas

Try techdocs-cli in a real terminal Free, in your browser - a real Ubuntu terminal to try it in, with missions that check your work.