Skip to content

Commit cc398dd

Browse files
committed
Added support for displaying version aliases
1 parent 485fa76 commit cc398dd

File tree

12 files changed

+37
-13
lines changed

12 files changed

+37
-13
lines changed

docs/schema/extra.json

+6
Original file line numberDiff line numberDiff line change
@@ -317,6 +317,12 @@
317317
}
318318
],
319319
"default": "stable"
320+
},
321+
"alias": {
322+
"title": "Show alias next to version number",
323+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-the-versioning/#version-alias",
324+
"type": "boolean",
325+
"default": true
320326
}
321327
}
322328
},

material/overrides/assets/javascripts/custom.63a6dff3.min.js renamed to material/overrides/assets/javascripts/custom.b457887c.min.js

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

material/overrides/assets/javascripts/custom.63a6dff3.min.js.map renamed to material/overrides/assets/javascripts/custom.b457887c.min.js.map

+2-2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

material/overrides/main.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,5 +23,5 @@
2323
{% endblock %}
2424
{% block scripts %}
2525
{{ super() }}
26-
<script src="{{ 'assets/javascripts/custom.63a6dff3.min.js' | url }}"></script>
26+
<script src="{{ 'assets/javascripts/custom.b457887c.min.js' | url }}"></script>
2727
{% endblock %}

material/templates/assets/javascripts/bundle.7c1205d0.min.js renamed to material/templates/assets/javascripts/bundle.ebd0bdb7.min.js

+2-2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

material/templates/assets/javascripts/bundle.7c1205d0.min.js.map renamed to material/templates/assets/javascripts/bundle.ebd0bdb7.min.js.map

+3-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

material/templates/assets/stylesheets/main.732c4fb1.min.css renamed to material/templates/assets/stylesheets/main.6543a935.min.css

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

material/templates/assets/stylesheets/main.732c4fb1.min.css.map renamed to material/templates/assets/stylesheets/main.6543a935.min.css.map

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

material/templates/base.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@
4444
{% endif %}
4545
{% endblock %}
4646
{% block styles %}
47-
<link rel="stylesheet" href="{{ 'assets/stylesheets/main.732c4fb1.min.css' | url }}">
47+
<link rel="stylesheet" href="{{ 'assets/stylesheets/main.6543a935.min.css' | url }}">
4848
{% if config.theme.palette %}
4949
{% set palette = config.theme.palette %}
5050
<link rel="stylesheet" href="{{ 'assets/stylesheets/palette.06af60db.min.css' | url }}">
@@ -249,7 +249,7 @@
249249
</script>
250250
{% endblock %}
251251
{% block scripts %}
252-
<script src="{{ 'assets/javascripts/bundle.7c1205d0.min.js' | url }}"></script>
252+
<script src="{{ 'assets/javascripts/bundle.ebd0bdb7.min.js' | url }}"></script>
253253
{% for script in config.extra_javascript %}
254254
{{ script | script_tag }}
255255
{% endfor %}

src/templates/assets/javascripts/_/index.ts

+1
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,7 @@ export type Translations =
8383
export interface Versioning {
8484
provider: "mike" /* Version provider */
8585
default?: string | string[] /* Default version */
86+
alias?: boolean /* Show alias */
8687
}
8788

8889
/**

src/templates/assets/javascripts/templates/version/index.tsx

+11
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,11 @@ function renderVersion(version: Version): HTMLElement {
6464
<li class="md-version__item">
6565
<a href={`${url}`} class="md-version__link">
6666
{version.title}
67+
{config.version?.alias && version.aliases.length && (
68+
<span class="md-version__alias">
69+
{version.aliases[0]}
70+
</span>
71+
)}
6772
</a>
6873
</li>
6974
)
@@ -84,6 +89,7 @@ function renderVersion(version: Version): HTMLElement {
8489
export function renderVersionSelector(
8590
versions: Version[], active: Version
8691
): HTMLElement {
92+
const config = configuration()
8793
versions = versions.filter(version => !version.properties?.hidden)
8894
return (
8995
<div class="md-version">
@@ -92,6 +98,11 @@ export function renderVersionSelector(
9298
aria-label={translation("select.version")}
9399
>
94100
{active.title}
101+
{config.version?.alias && active.aliases.length && (
102+
<span class="md-version__alias">
103+
{active.aliases[0]}
104+
</span>
105+
)}
95106
</button>
96107
<ul class="md-version__list">
97108
{versions.map(renderVersion)}

src/templates/assets/stylesheets/main/components/_version.scss

+6
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,12 @@
7676
}
7777
}
7878

79+
// Version alias
80+
&__alias {
81+
margin-left: px2rem(6px);
82+
opacity: 0.7;
83+
}
84+
7985
// Version selection list
8086
&__list {
8187
position: absolute;

0 commit comments

Comments
 (0)