docs-builder
Loading

Assembler commands

Assembler builds bring together all isolated builds and turn them into the overall documentation that gets published.

If you want to build the latest documentation, you can do so using the following commands

Note

When assembling using the config init --local option, it's advised to create an empty directory to run these commands in. This creates a dedicated workspace for the assembler build and any local changes that you might want to test.

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

The full assembled documentation should now be running at http://localhost:4000.

The assemble command is syntactic sugar over the following commands:

docs-builder assembler config init --local
docs-builder assembler clone
docs-builder assembler build
docs-builder assembler serve
		

Which may be more appropriate to call in isolation depending on the workflow you are going for.

All assembler commans take an --environment <environment> argument that defaults to 'dev' but can be set e.g to 'prod' to build the production documentation. See assembler.yml configuration for which environments are available