Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add mike alias name to version selector #6436

Open
4 tasks done
corykinney opened this issue Dec 4, 2023 · 1 comment
Open
4 tasks done

Add mike alias name to version selector #6436

corykinney opened this issue Dec 4, 2023 · 1 comment
Labels
change request Issue requests a new feature or improvement needs investigation Issue must be investigated by the maintainers

Comments

@corykinney
Copy link

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

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

@squidfunk squidfunk added the needs investigation Issue must be investigated by the maintainers label Dec 5, 2023
@squidfunk
Copy link
Owner

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
change request Issue requests a new feature or improvement needs investigation Issue must be investigated by the maintainers
Projects
None yet
Development

No branches or pull requests

2 participants