Add mike alias name to version selector

[corykinney]

Context

I searched through the documentationa nd previous issues and couldn't find anything, hopefully I didn't miss anything.

Description

Currently the version selector shows the identifiers for the documentation versions deployed with mike. If it's not difficult to implement, I would suggest adding a toggle to allow displaying the alias for a version in parentheses in the version selector. Example:

0.3 (dev)
0.2 (stable)
0.1

Related links

• Requesting a change
• Setting up versioning

Use Cases

This would provide clarity when documentation for the development branch is available, so that the user understands why the default version served is not the highest version number.

Visuals

No response

Before submitting

• I have read and followed the change request guidelines.
• I have verified that my idea is a change request and not a bug report.
• I have ensured that, to the best of my knowledge, my idea will benefit the entire community.
• I have included relevant links to the documentation, related issues, and discussions to underline the need for my idea.

[squidfunk]

Thanks for suggesting. We can investigate this reasonable feature request in the future.

[squidfunk]

Added in cc398dd. There's a new setting in mkdocs.yml which will show the first version alias (according to mike, there can be multiple), if one is given. It can be enabled with the following configuration:

extra:
  version:
    provider: mike
    alias: true

Here's how it looks:

I tried to make the styles as less opinionated as possible. If you wish to customize them, it's easy with some additional CSS. For example, if you want to add ( and ) before and after the alias, you can use:

.md-version__alias::before {
  display: inherit;
  content: "(";
}
.md-version__alias::after {
  display: inherit;
  content: ")";
}

You can also change the style by playing with .md-version__alias.

[squidfunk]

Released as part of 9.5.23.