diff options
| author | vmishenev <vad-mishenev@yandex.ru> | 2021-09-01 00:03:13 +0300 |
|---|---|---|
| committer | vmishenev <vad-mishenev@yandex.ru> | 2021-09-20 19:01:44 +0300 |
| commit | fc5496fb8bb888c3a50717260dc05d8fe2d54306 (patch) | |
| tree | 2b61c01babe696065c4b8bafad61cce7479561ad /docs/src/doc | |
| parent | 8efe04e127e3bf0aef395b31f3f3d9f49a0afe26 (diff) | |
| download | dokka-fc5496fb8bb888c3a50717260dc05d8fe2d54306.tar.gz dokka-fc5496fb8bb888c3a50717260dc05d8fe2d54306.tar.bz2 dokka-fc5496fb8bb888c3a50717260dc05d8fe2d54306.zip | |
Improve versioning plugin (#2104)
- support for single module projects
- version navigator is on all pages
- dropdown arrow for version navigator
Diffstat (limited to 'docs/src/doc')
| -rw-r--r-- | docs/src/doc/docs/user_guide/versioning/versioning.md | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/docs/src/doc/docs/user_guide/versioning/versioning.md b/docs/src/doc/docs/user_guide/versioning/versioning.md index 7cb2a783..ad1c8267 100644 --- a/docs/src/doc/docs/user_guide/versioning/versioning.md +++ b/docs/src/doc/docs/user_guide/versioning/versioning.md @@ -3,8 +3,6 @@ Versioning plugin aims to provide users with ability to create a versioned documentation. Therefore, users of the documentation can view different versions of the documentation by going to the main page and change versions. -Versioning plugin is applied by default but not enabled in Dokka so there is no need to apply it manually. - Versioning can be configured using: * version - a string value representing a version that should be displayed in the dropdown. @@ -14,14 +12,16 @@ Versioning can be configured using: (if it's specified). * versionsOrdering - an optional list of strings representing the ordering of versions that should be visible. By default, Dokka will try to use semantic versioning to create such ordering. - +* renderVersionsNavigationOnAllPages - a bool value. + By default, Dokka renders a versions navigation on all pages. + +!!! note + You should enable the plugin in all submodules to render a versions navigation on all pages. + Above configuration should be placed under the `pluginsConfiguration` block specific for your build tool. Configuration object is named `org.jetbrains.dokka.versioning.VersioningConfiguration`. -!!! note - In the current release versioning is available only for the multimodule. Supporting single module is scheduled for next release - ### Directory structure required If you pass previous versions using `olderVersionsDir`, a particular directory structure is required: |