Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2026-03-26 04:54:10 +01:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Quick hacky version dropdown

Browse source
This commit is contained in:
David Robertson 2022-06-16 00:51:37 +01:00
parent 2ee2172cf5
commit de3f450286
No known key found for this signature in database
GPG key ID: 903ECE108A39DEDD
4 changed files with 69 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
config.toml
View file

@ -52,6 +52,9 @@ current_version_url = "https://spec.matrix.org/latest"
#major = "1"
#minor = "2"
#release_date = "February 02, 2022"
# Released versions to show in the version dropdown. Th template will also include a "historical" entry,
# and (if the status above is "stable") an "unstable" entry.
history = [ "unstable", "v1.2", "v1.1", "historical" ]
# User interface configuration
[params.ui]

1
layouts/partials/hooks/body-end.html
View file

@ -15,3 +15,4 @@
*/}}
<script defer language="javascript" type="text/javascript" src="{{ "js/toc.js" | urlize | relURL }}"></script>
<script defer language="javascript" type="text/javascript" src="{{ "js/version_selector.js" | urlize | relURL }}"></script>

44
layouts/partials/navbar.html
View file

@ -8,9 +8,10 @@
{{ $cover := .HasShortcode "blocks/cover" }}
<nav class="js-navbar-scroll navbar navbar-expand navbar-light {{ if $cover}} td-navbar-cover {{ end }}flex-column flex-md-row td-navbar">
<a class="navbar-brand" href="{{ .Site.Home.RelPermalink }}">
<span class="navbar-logo">{{ with resources.Get "icons/logo.svg" }}{{ ( . | minify).Content | safeHTML }}{{ end }}</span><span class="font-weight-bold">specification</span><span class="navbar-version"> &mdash; {{ partial "version-string" . }}</span>
</a>
<span class="navbar-brand">
<a href="{{ .Site.Home.RelPermalink }}">
<span class="navbar-logo">{{ with resources.Get "icons/logo.svg" }}{{ ( . | minify).Content | safeHTML }}{{ end }}</span><span class="font-weight-bold">specification</span></a><span class="navbar-version"> &mdash; {{ partial "version-selector" . }}</span>
</span>
<div class="td-navbar-nav-scroll ml-md-auto" id="main_navbar">
<ul class="navbar-nav mt-2 mt-lg-0">
@ -39,17 +40,38 @@
</nav>
{{ define "partials/version-string" }}
{{ $ret := "unstable version"}}
{{ define "partials/version-selector" }}
{{ $version := .Site.Params.version }}
{{ $current := partial "current-version-short" . }}
<noscript>{{ partial "current-version-long" . }}</noscript>
<select id="version-selector">
{{ range $version.history }}
{{ if eq . $current }}
<option selected>{{ . }}</option>
{{ else }}
<option>{{ . }}</option>
{{ end }}
{{ end }}
</select>
{{ end }}
{{ $status := .Site.Params.version.status }}
{{ if ne $status "unstable"}}
{{ $path := path.Join "changelogs" }}
{{ define "partials/current-version-long" }}
{{ if eq .Site.Params.version.status "unstable" }}
unstable version
{{ else }}
version {{ partial "current-version-short" . }}
{{ end }}
{{ end }}
{{/* produces a string similar to "version v1.5" */}}
{{ $ret = delimit (slice "version v" .Site.Params.version.major "." .Site.Params.version.minor) "" }}
{{ end }}
{{ define "partials/current-version-short" }}
{{ $ret := "unstable"}}
{{ if ne .Site.Params.version.status "unstable"}}
{{/* produces a string similar to "version v1.5" */}}
{{ $ret = delimit (slice "v" .Site.Params.version.major "." .Site.Params.version.minor) "" }}
{{ end }}
{{ return $ret }}
{{ end }}

32
static/js/version_selector.js Normal file
View file

@ -0,0 +1,32 @@
window.addEventListener('DOMContentLoaded', () => {
const selector = document.getElementById("version-selector")
// Get the current version number and check that it or "latest" appears in the URL.
let current = selector.querySelector("option[selected]").value
let current_segment
console.log("current", current)
if (window.location.href.includes("/" + current + "/")) {
current_segment = "/" + current + "/"
} else if (window.location.href.includes("/latest/")) {
current_segment = "/latest/"
} else {
// If not, ditch the selector dropdown.
let parent = selector.parentElement
let fallback = parent.querySelector("noscript")
parent.removeChild(fallback)
parent.removeChild(selector)
parent.appendChild(document.createTextNode(fallback.innerText))
return
}
selector.addEventListener("change", event => {
let chosen = event.target.value
if (chosen === "historical") {
// Go to the "historical version" in the current spec's revision.
let parts = window.location.href.split(current_segment, 2)
window.location.href = parts[0] + current_segment + "changelog/#historical-versions"
} else {
window.location.href = window.location.href.replace(current_segment, "/" + chosen + "/")
}
})
});