Skip to content
Last updated

If you have multiple versions of content, you can organize that content into versioned folders (folder names must start with @) and that content is displayed with a version picker UI element that users can use to select the version. You can also add a versions.yaml file to set the default version and specify which versions should display.

The versionPicker configuration option allows you to hide the version picker or include the version picker even on content that does not have multiple versions.

Options

OptionTypeDescription
hidebooleanSpecifies if the version picker should be hidden. Default: false.
showForUnversionedbooleanSpecifies if the version picker should be shown even for content that does not have multiple versions. Default: false.

Examples

The following configuration hides the version picker:

versionPicker:
  hide: true

The following configuration shows the version picker even for unversioned content.

versionPicker:
  showForUnversioned: true
  • Configure a product picker for multiple products using the products configuration reference documentation.
  • See the options for adding a language picker to your project in the l10n configuration reference documentation.

Resources

  • Add multiple versions - Configure your versions.yaml file to specify the default version and manage multiple documentation versions
  • Products configuration - Organize your project with multiple products and version management for complex documentation structures
  • Configure localization - Add a language picker for content translated into multiple languages alongside version management
  • Front matter configuration - Toggle version picker visibility on individual pages using front matter for custom layouts
  • Configuration options - Explore other project configuration options for comprehensive documentation and platform customization