From 3a27c8017efcea517002207c952486e56d55b492 Mon Sep 17 00:00:00 2001 From: squidfunk Date: Wed, 15 May 2024 17:35:32 +0200 Subject: [PATCH] Documentation --- docs/setup/setting-up-versioning.md | 22 ++++++++++++++++++---- 1 file changed, 18 insertions(+), 4 deletions(-) diff --git a/docs/setup/setting-up-versioning.md b/docs/setup/setting-up-versioning.md index b7e83c02d..c72aad139 100644 --- a/docs/setup/setting-up-versioning.md +++ b/docs/setup/setting-up-versioning.md @@ -61,14 +61,13 @@ When the user chooses a version in the version selector, they usually want to go to the page corresponding to the page they were previously viewing. Material for MkDocs implements this behavior by default, but there are a few caveats: -- the [`site_url`] must be set correctly in `mkdocs.yml`. See the ["Publishing a - new version"](#publishing-a-new-version) section for an example. +- the [`site_url`][mkdocs.site_url] must be set correctly in `mkdocs.yml`. + See the ["Publishing a new version"](#publishing-a-new-version) section for + an example. - you must be viewing the site at that URL (and not locally, for example). - the redirect happens via JavaScript and there is no way to know which page you will be redirected to ahead of time. -[`site_url`]: https://www.mkdocs.org/user-guide/configuration/#site_url - ### Version warning @@ -131,6 +130,21 @@ redirected to. [Version warning preview]: ../assets/screenshots/version-warning.png [default version]: #setting-a-default-version +### Version alias + + + + +If you're using aliases for versioning, and want to show the version alias +besides the version number, you can enable this feature by setting the `alias` +option to `true`: + +``` yaml +extra: + version: + alias: true +``` + ## Usage While this section outlines the basic workflow for publishing new versions,