Optional configuration for scanning existing versions that had been generated by a different tool. This setting is optional and serves two purposes:
-
If older versions of the documentation had been generated by different tools, Laika can use this configuration for indexing the available paths for "smart linking", which is a feature of the Helium version switcher drop down. The result of the scanning operation will be used to populate the file
/laika/versionInfo.json
in the output directory. -
If you are using the preview server (either the
laikaPreview
task in the sbt plugin, or thelaika.preview.ServerBuilder
from the API) and you want to also test the version switcher drop down menu, then Laika needs to know where older versions are located so that it can serve them, too.
The specified root directory is expected to match the structure of versioned documentation as rendered by Laika.
This means that the root directory is expected to have immediate sub-directories with names that correspond
to the pathSegment
property of the configuration for that version.
- Value parameters:
- exclude
paths to be skipped when scanning the output directory for existing versions (e.g. for API docs), interpreted from the root directory of each version.
- rootDirectory
file system path that represents the root of existing versions.
- Companion:
- object