Content variants

You can publish multiple versions of the same documentation as part of a single docs site. These variations will be available to the end users via the space switcher in the top-left corner of the published site.

Why publish multiple spaces on one site?

A site with multiple spaces is useful if you need to group together the content of your spaces — such as if you’re documenting multiple versions of an API (v1, v2, v3, etc.), or documenting your content in different languages.

The spaces you link can contain any content, but it is recommended to use variants as variations of the same content. If the spaces you link are semantically different from each other, consider adding them as site sections instead.

Adding a variant to your docs site

From your docs site’s dashboard, click the Settings button, then scroll down to the Site structure section. Here you can see all the content of your site.

To add a variant, click the Add variant button in the section you'd like to add to, then choose a space to link. The new variant is then added to the list of variants within the chosen section and will be available to visitors in the variant dropdown on your site.

Changing a variant

You can change the name and slug of each of your linked spaces by tapping the Edit button in the table row of the space you'd like to edit. Edit the field(s) you'd like to change, then click the Save button to save.

To replace a linked space with a different space, click on the More menu in the space's table row and then click Replace linked space.

Reordering variants

Your site displays variants in the order that they appear in your Site structure table. Variants can be reordered by grabbing the Drag handle and moving it up or down. Alternatively, you can press the More menu in the table row of the space you'd like to edit and choosing Move up or Move down. The changed order will be reflected on your site immediately.

Setting a default variant

If you have multiple variants within a section, one variant will be marked as the default. This variant is shown when visitors arrive on your site (or when they visit a section). Other variants each have a slug that is appended to the site's URL.

To set a variant as default, click on the More menu in the space's table row and then click Set as default.

Remove a variant from a site

To remove the content of a space from a site, click the Settings button from your docs site dashboard, then scroll down to the Site structure table to find the content you want to remove. Open the More menu next to the linked space you want to remove and select Delete from site. This will remove it from the published site, but will not delete the space or the content within.