flutter/flame
1
0
Fork 0
mirror of https://github.com/flame-engine/flame.git synced 2025-11-01 10:38:17 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: Upgrade documentation site (#1365)

Browse Source
This commit is contained in:
Pasha Stetsenko
2022-02-12 22:50:13 -08:00
committed by GitHub
parent 3e0589730c
commit 12cf8f7096
47 changed files with 1460 additions and 497 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
doc/_sphinx/scripts/versions.js
View File

@ -10,7 +10,7 @@ function getCurrentDocVersion() {
return parts[1];
}
}
return '--';
return 'local';
}
// Given a list of versions (as plain strings), convert them into HTML <A/>
@ -24,7 +24,11 @@ function convertVersionsToHtmlLinks(versionsList, currentVersion) {
if (version === currentVersion) {
classes += ' selected';
}
out += `<a href="/${version}/"><button class="${classes}">${version}</button></a>`;
out += `<a href="/${version}/">
<button class="${classes}">
<i class="fa fa-code-branch"></i> ${version}
</button>
</a>`;
}
return out;
}
@ -32,15 +36,21 @@ function convertVersionsToHtmlLinks(versionsList, currentVersion) {
function buildVersionsMenu(data) {
const currentVersion = getCurrentDocVersion();
const versionButtons = convertVersionsToHtmlLinks(data.split('\n'), currentVersion);
$('div.topbar-main').append(`
<div class="dropdown-buttons-trigger" id="versions-menu">
<button class="btn btn-secondary topbarbtn">
<span class="tag">version:</span>
$('div.versions-placeholder').append(`
<div id="versions-menu" tabindex="-1">
<div class="btn">
<i class="fa fa-code-branch"></i>
<span class="version-id">${currentVersion}</span>
</button>
<div class="dropdown-buttons">${versionButtons}</div>
</div>
<div class="dropdown-buttons">
<div class="header">View documentation for version:</div>
${versionButtons}
</div>
</div>
`);
$("#versions-menu").on("click blur", function() {
$(this).toggleClass("active");
});
}
// Start loading the versions list as soon as possible, don't wait for DOM
@ -51,5 +61,9 @@ const versionsRequest = $.get(
// Now wait for DOM to finish loading
$(function() {
// Lastly, wait for versions to finish loading too.
versionsRequest.then(buildVersionsMenu);
versionsRequest.then(buildVersionsMenu)
.fail(function() {
console.log("Failed to load versions.txt, using default version list");
buildVersionsMenu("local\nmain\n1.0.0\n");
});
});